manual: Add short option example.

[adu.git] / select.ggo

diff --git a/select.ggo b/select.ggo
index d02fcd39112745d7d9f86f5be48113343ae54b60..d7f8c9388b3ac4d6509cb5e7e0719079b65feba7 100644 (file)
--- a/select.ggo
+++ b/select.ggo
@@ -35,37 +35,84 @@ details="
        (the default), all users are taken into account.
 "
 
        (the default), all users are taken into account.
 "
 

-option "limit" L
+option "limit" l

 #~~~~~~~~~~~~~~~
 "Limit output"
 #~~~~~~~~~~~~~~~
 "Limit output"

-int  typestr="num"
+int typestr="num"

 default="-1"
 optional
 details="
        Only print num lines of output. If negative (the default),
 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 "pattern" p
+#~~~~~~~~~~~~~~~~~
+"only consider matching directories"
+string typestr="regex"
+optional

 details="
 details="

-       This is mostly useful to feed the output of adu to scripts.
+       Regular expression that must match the directory name for
+       the directory to be considered for the output of the query.
+       See regex(7) for details.
+
+       Depending on whether --print-base-dir is given, the absolute
+       directory name or only the part of the directory name below
+       the base directory is matched against \"regex\".
+
+       If this option is not given (the default) all directories
+       are taken into account.
+
+       If \"regex\" starts with '!', directories are matched against
+       the remaining part of \"regex\" and the sense of matching is
+       reversed.
+"
+
+option "header" H
+#~~~~~~~~~~~~~~~~
+"use a customized header for listings/summaries"
+string typestr="string"
+optional
+details="
+       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 "trailer" T
+#~~~~~~~~~~~~~~~~~
+"use a customized trailer for listings/summaries"
+string typestr="string"
+optional
+default=""
+details="
+       This option can be used to print any string at the end of
+       the query output.
+
+       In user_list mode the trailer is a format string with the
+       same semantics like the header string.

 "
 
 option "select-mode" m
 #~~~~~~~~~~~~~~~~~~~~~
 "How to print the results of the query"
 enum typestr="<key>"
 "
 
 option "select-mode" m
 #~~~~~~~~~~~~~~~~~~~~~
 "How to print the results of the query"
 enum typestr="<key>"

-values="global_list","global_summary","user_list","user_summary"
-default="global_list"
+values="user_summary","user_list","global_summary","global_list"
+default="user_summary"

 optional
 details="
 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_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
 "
 
 option "list-sort" s


@@ -87,28 +134,32 @@ string typestr="path"
 optional
 default="-"
 details="
 optional
 default="-"
 details="

-       If empty, or not given, use stdout. The following conventions
-       cause the output to be written differently:
-
-       An output file name of \"-\" means stdout.
-
-       \"path\" may be prepended by '>' which instructs adu to
-       truncate the output file to length zero.  If \"path\" does
-       not start with '>' and \"path\" already exists, the select
-       query is being aborted. Otherwise, \"path\" is created and
-       output is written to \"path\".
-
-       If the first two characters of \"path\" are '>', the output
-       file (given by removing the leading \">>\" from \"path\")
-       is being opened in append mode. It is no error if the output
-       file does not exist but, as above, the output file name \">>\"
-       is considered invalid.
-
-       If the first character of \"path\" is '|', a pipe is created
-       and the rest of \"path\" is being executed with its standard in
-       redirected to the reading end of the pipe. The output of adu
-       is written to the writing end of the pipe. Again, specifying
-       only \"|\" is considered invalid and causes an error.
+       This option is only useful in interactive mode. If stdin is redirected
+       from a script, and the script contains several queries one can use
+       this option to let each query write its output to a different file.
+
+       If the option is not given, or its argument is either \"-\" or the
+       empty string, stdout is assumed. The following conventions cause the
+       output to be written in a different way:
+
+       \"path\" may be prepended by '>' which instructs adu to truncate
+       the output file to length zero. If \"path\" does not start with
+       '>' and \"path\" already exists, the query is aborted. Otherwise,
+       the file is created and truncated. The output file name \">\" is
+       considered invalid.
+
+       If the first two characters of \"path\" are '>', the output file
+       (given by removing the leading \">>\" from \"path\") is opened in
+       append mode. It is no error if the output file does not exist. However,
+       as above the output file name \">>\" is considered invalid.
+
+       If the first character of \"path\" is '|', a pipe is created and the
+       rest of \"path\" is executed with stdin redirected to the reading
+       end of the pipe while the query output is written to the writing end
+       of the pipe. Again, specifying only \"|\" is considered invalid and
+       causes an error.
+
+       See the manual page for examples.

 "
 
 option "user-summary-sort" -
 "
 
 option "user-summary-sort" -


@@ -141,12 +192,12 @@ optional
 details="
 
        A string that specifies how the output of the select query is
 details="
 
        A string that specifies how the output of the select query is

-       going to be formated.  Depending on the chosen select-mode,
+       going to be formated. Depending on the chosen select-mode,

        several conversion specifiers are available and a different
        default value for this option applies.
 
        adu knows four different types of directives: string, id,
        several conversion specifiers are available and a different
        default value for this option applies.
 
        adu knows four different types of directives: string, id,

-       count and size.  These are explained in more detail below.
+       count and size. These are explained in more detail below.

 
        The general syntax for string and id directives is %(name:a:w)
        where \"name\" is the name of the directive, \"a\" specifies
 
        The general syntax for string and id directives is %(name:a:w)
        where \"name\" is the name of the directive, \"a\" specifies


@@ -156,9 +207,9 @@ details="
        The alignment specifier is a single character: Either \"l\",
        \"r\", or \"c\" may be given to specify left, right and
        centered alignment respectively. The with specifier is a
        The alignment specifier is a single character: Either \"l\",
        \"r\", or \"c\" may be given to specify left, right and
        centered alignment respectively. The with specifier is a

-       positive integer.  Both \"a\" and \"w\" are optional.
+       positive integer. Both \"a\" and \"w\" are optional.

 
 

-       A string directive supported by adu is \"dirname\" which is
+       One string directive supported by adu is \"dirname\" which is

        substituted by the name of the directory. It is available
        if either user_list or global_list mode was selected via
        --select-mode.
        substituted by the name of the directory. It is available
        if either user_list or global_list mode was selected via
        --select-mode.


@@ -172,12 +223,12 @@ details="
 
                \"%(dirname:c:20)\"
 
 
                \"%(dirname:c:20)\"
 

-       The other two types of directives, count and size, are used
-       for numbers. The syntax for these is %(name:a:w:u). The \"a\"
-       and the \"w\" specifier have the same meaning as for the string
-       and id directives. The additional \"u\" specifier selects a unit
-       in which the number that corresponds to the directive should
-       be formated. All three specifiers are optional.
+       The count and size directives are used for non-negative
+       numbers. The syntax for these is %(name:a:w:u). The \"a\" and
+       the \"w\" specifiers have the same meaning as for the string
+       and id directives. The additional \"u\" specifier selects a
+       unit in which the number that corresponds to the directive
+       should be formated. All three specifiers are optional.

 
        Possible units are the characters of the set \" bkmgtBKMGT\"
        specifying bytes, kilobytes, megabytes, gigabytes and
 
        Possible units are the characters of the set \" bkmgtBKMGT\"
        specifying bytes, kilobytes, megabytes, gigabytes and


@@ -216,19 +267,20 @@ details="
        together with their types, and for which modes each of
        them may be used.
 
        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
 
                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.
 
                dirs (count): number of directories. Available
                for user_summary and global_summary.