X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=select.ggo;h=d7f8c9388b3ac4d6509cb5e7e0719079b65feba7;hb=493e7cff4e7d6518ea323a49fba90476e80649a8;hp=140311b8349cf3c91f23d5026d9a5e8bfcd58b03;hpb=433f65b09b44e9b19987deaba15088da498d4a61;p=adu.git diff --git a/select.ggo b/select.ggo index 140311b..d7f8c93 100644 --- a/select.ggo +++ b/select.ggo @@ -87,6 +87,20 @@ details=" 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" @@ -116,11 +130,36 @@ details=" option "output" o #~~~~~~~~~~~~~~~~ "file to write output to" -string typestr="" +string typestr="path" optional default="-" details=" - If empty, or not given, use stdout. + 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" - @@ -170,7 +209,7 @@ details=" centered alignment respectively. The with specifier is a 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. @@ -184,12 +223,12 @@ details=" \"%(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