Fix spelling of member of struct num_format.

[adu.git] / select.ggo

diff --git a/select.ggo b/select.ggo
index f29cd2f8a6ad947f15ce9079135bdcd8dfe63d35..d96609536e46865dd6134a918e185103e5c0c6ff 100644 (file)
--- a/select.ggo
+++ b/select.ggo
@@ -38,7 +38,7 @@ details="
 option "limit" l
 #~~~~~~~~~~~~~~~
 "Limit output"
 option "limit" l
 #~~~~~~~~~~~~~~~
 "Limit output"

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

 default="-1"
 optional
 details="
 default="-1"
 optional
 details="


@@ -47,6 +47,28 @@ details="
        except global_summary (which outputs only one single line).
 "
 
        except global_summary (which outputs only one single line).
 "
 

+option "pattern" p
+#~~~~~~~~~~~~~~~~~
+"only consider matching directories"
+string typestr="regex"
+optional
+details="
+       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"
 option "header" H
 #~~~~~~~~~~~~~~~~
 "use a customized header for listings/summaries"


@@ -65,6 +87,20 @@ details="
        output to scripts.
 "
 
        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"
 option "select-mode" m
 #~~~~~~~~~~~~~~~~~~~~~
 "How to print the results of the query"


@@ -73,10 +109,10 @@ values="user_summary","user_list","global_summary","global_list"
 default="user_summary"
 optional
 details="
 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_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


@@ -94,11 +130,32 @@ details="
 option "output" o
 #~~~~~~~~~~~~~~~~
 "file to write output to"
 option "output" o
 #~~~~~~~~~~~~~~~~
 "file to write output to"

-string typestr="<path>"
+string typestr="path"

 optional
 default="-"
 details="
 optional
 default="-"
 details="

-       If empty, or not given, use stdout.
+       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.

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


@@ -131,12 +188,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


@@ -146,9 +203,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.


@@ -162,12 +219,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