option "limit" l
#~~~~~~~~~~~~~~~
"Limit output"
-int typestr="num"
+int typestr="num"
default="-1"
optional
details="
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"
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"
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
option "output" o
#~~~~~~~~~~~~~~~~
"file to write output to"
-string typestr="<path>"
+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" -
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,
- 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 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.
\"%(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
projects / adu.git / blobdiff