Minor documentation updates/fixes/improvements.

[adu.git] / select.ggo

diff --git a/select.ggo b/select.ggo
index f6fce018ef05dfc0b5560051bde77a770e72cb14..6384c39f3cd97f3ad63347d4d16aecaac3746dad 100644 (file)
--- a/select.ggo
+++ b/select.ggo
@@ -35,7 +35,7 @@ details="
        (the default), all users are taken into account.
 "
 
-option "limit" L
+option "limit" l
 #~~~~~~~~~~~~~~~
 "Limit output"
 int  typestr="num"
@@ -43,15 +43,26 @@ default="-1"
 optional
 details="
        Only print num lines of output. If negative (the default),
-       print all lines.
+       print all lines. This option is honored in all select modes
+       except global_summary (which outputs only one single line).
 "
 
-option "no-headers" -
-#~~~~~~~~~~~~~~~~~~~~
-"suppress descriptions for listings/summaries"
-flag off
+option "header" H
+#~~~~~~~~~~~~~~~~
+"use a customized header for listings/summaries"
+string typestr="string"
+optional
 details="
-       This is mostly useful to feed the output of adu to scripts.
+       This option can be used to print any string instead of the
+       default header line (which depends on the selected mode).
+
+       In user_list mode the header is a format string which allows
+       to include the uid and the user name in the header. See the
+       --format option for more details.
+
+       It is possible to set this to the empty string to suppress
+       the header completely. This is mostly useful to feed the
+       output to scripts.
 "
 
 option "select-mode" m
@@ -62,10 +73,10 @@ values="user_summary","user_list","global_summary","global_list"
 default="user_summary"
 optional
 details="
-       global_list: List of directories, regardless of owner.
-       global_summary: Only print totals.
+       user_summary: Print totals for each admissible uid.
        user_list: Print a list for each admissible uid.
-       user_summary Print totals for each admissible uid.
+       global_summary: Only print totals.
+       global_list: List of directories, regardless of owner.
 "
 
 option "list-sort" s
@@ -195,19 +206,20 @@ details="
        together with their types, and for which modes each of
        them may be used.
 
-               pw_name (string): user name. Available for user_list
-               and user_summary
+               pw_name (string): user name. Available for user_list,
+               user_summary and for the header in user_list mode.
 
-               uid (id): user id. Available for user_list and
-               user_summary.
+               uid (id): user id. Available for user_list,
+               user_summary and for the header in user_list mode.
 
-               files (count): number of files. Available everywhere.
+               files (count): number of files. Available for all
+               modes.
 
                dirname (string): name of the directory. Available
                for user_list and global_list.
 
                size (size): total size/ directory size. Available
-               everywhere.
+               for all modes.
 
                dirs (count): number of directories. Available
                for user_summary and global_summary.