From ab1a38bb2e47b0987597a54604de287d2bfa27d6 Mon Sep 17 00:00:00 2001 From: Collin Funk Date: Tue, 12 Mar 2024 06:30:52 -0700 Subject: [PATCH] doc: add basic documentation for 'pinky' * doc/coreutils.texi: Add 'pinky' under 'who'. --- doc/coreutils.texi | 65 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/doc/coreutils.texi b/doc/coreutils.texi index 9e3aa6c1c..d07ed7e76 100644 --- a/doc/coreutils.texi +++ b/doc/coreutils.texi @@ -96,6 +96,7 @@ * od: (coreutils)od invocation. Dump files in octal, etc. * paste: (coreutils)paste invocation. Merge lines of files. * pathchk: (coreutils)pathchk invocation. Check file name portability. +* pinky: (coreutils)pinky invocation. Print information about users. * pr: (coreutils)pr invocation. Paginate or columnate files. * printenv: (coreutils)printenv invocation. Print environment variables. * printf: (coreutils)printf invocation. Format and print data. @@ -421,6 +422,7 @@ User information * groups invocation:: Print group names a user is in * users invocation:: Print login names of users currently logged in * who invocation:: Print who is currently logged in +* pinky invocation:: Print information about users System context @@ -15934,6 +15936,7 @@ logins, groups, and so forth. * groups invocation:: Print group names a user is in. * users invocation:: Print login names of users currently logged in. * who invocation:: Print who is currently logged in. +* pinky invocation:: Print information about users. @end menu @@ -16295,6 +16298,68 @@ should not rely on its existence on non-POSIX platforms. @exitstatus +@node pinky invocation +@section @command{pinky}: Print information about users + +@command{pinky} is a lightweight implementation of the @command{finger} command. +Synopsis: + +@example +@command{pinky} [@var{option}] [@var{username}]@dots{} +@end example + +The program accepts the following options. Also see @ref{Common options}. + +@table @samp + +@item -l +@opindex -l +Produce long format output. + +When producing long output at least one @var{username} must be given. +If @var{username} cannot be found, the real name is printed as +@samp{???} and the home directory and shell are omitted. + +@item -b +@opindex -b +Omit the user's home directory and shell when printing in long format. + +@item -h +@opindex -h +Omit the user's project file when printing in long format. + +@item -p +@opindex -p +Omit the user's plan file when printing in long format. + +@item -s +@opindex -s +Produce short format output. This is the default behavior when no +options are given. + +@item -f +@opindex -f +Omit the column headings when printing in short format. + +@item -w +@opindex -w +Omit the user's full name when printing in short format. + +@item -i +@opindex -i +Omit the user's full name and remote host when printing in short +format. + +@item -q +@opindex -q +Omit the user's full name, remote host, and idle time when printing in +short format. + +@end table + +@exitstatus + + @node System context @chapter System context -- 2.44.0