3 "users to take into account"
4 string typestr="user_name"
8 This option may be given multiple times in which case all given
9 user names are considered admissible. See also --uid below.
14 "user id(s) to take into account"
15 string typestr="uid_spec"
18 An uid specifier may be a single uid, a range of uids,
19 or a comma-separated list of single uids or ranges.
25 Only consider uids greater or equal than 42:
28 Only consider uids between 23 and 42, inclusively:
31 Consider uids 23-42, 666-777 and 88:
32 --uid 23-42,666-777,88
34 If no --user option is given and also --uid option is not given
35 (the default), all users are taken into account.
45 Only print num lines of output. If negative (the default),
46 print all lines. This option is honored in all select modes
47 except global_summary (which outputs only one single line).
52 "suppress descriptions for listings/summaries"
55 This is mostly useful to feed the output of adu to scripts.
58 option "select-mode" m
59 #~~~~~~~~~~~~~~~~~~~~~
60 "How to print the results of the query"
62 values="user_summary","user_list","global_summary","global_list"
63 default="user_summary"
66 global_list: List of directories, regardless of owner.
67 global_summary: Only print totals.
68 user_list: Print a list for each admissible uid.
69 user_summary Print totals for each admissible uid.
74 "how to sort the user list or the global list"
76 values="size","file_count"
80 This option is ignored if select-mode is neither \"user_list\", nor
86 "file to write output to"
87 string typestr="<path>"
91 If empty, or not given, use stdout.
94 option "user-summary-sort" -
95 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
96 "how to sort the user-summary"
97 enum typestr="col_spec"
98 values="name","uid","dir_count","file_count","size"
102 It is enough to specify the first letter of the column specifier,
103 e.g. \"--user-summary-sort f\" sorts by file count.
106 option "print-base-dir" -
107 #~~~~~~~~~~~~~~~~~~~~~~~~
108 "whether to include the base-dir in the output"
111 If this flag is given, all directories printed are prefixed
112 with the base directory. The default is to print paths relative
118 "How to format the output"
119 string typestr="<format_string>"
123 A string that specifies how the output of the select query is
124 going to be formated. Depending on the chosen select-mode,
125 several conversion specifiers are available and a different
126 default value for this option applies.
128 adu knows four different types of directives: string, id,
129 count and size. These are explained in more detail below.
131 The general syntax for string and id directives is %(name:a:w)
132 where \"name\" is the name of the directive, \"a\" specifies
133 the alignment and \"w\" is the width specifier which allows
134 to give a field width.
136 The alignment specifier is a single character: Either \"l\",
137 \"r\", or \"c\" may be given to specify left, right and
138 centered alignment respectively. The with specifier is a
139 positive integer. Both \"a\" and \"w\" are optional.
141 A string directive supported by adu is \"dirname\" which is
142 substituted by the name of the directory. It is available
143 if either user_list or global_list mode was selected via
147 Print dirname without any padding:
151 Center dirname in a 20 chars wide field:
155 The other two types of directives, count and size, are used
156 for numbers. The syntax for these is %(name:a:w:u). The \"a\"
157 and the \"w\" specifier have the same meaning as for the string
158 and id directives. The additional \"u\" specifier selects a unit
159 in which the number that corresponds to the directive should
160 be formated. All three specifiers are optional.
162 Possible units are the characters of the set \" bkmgtBKMGT\"
163 specifying bytes, kilobytes, megabytes, gigabytes and
164 terabytes respectively. The difference between the lower and
165 the upper case variants is that the lower case specifiers
166 select 1024-based units while the upper case specifiers use
169 The whitespace character is like \"b\", but a space character
170 is printed instead of a unit.
172 Two more characters \"h\" and \"H\" (human-readable) are also
173 available that choose an appropriate unit depending on the
174 size of the number being printed.
176 An asterisk prepended to the unit specifier prevents the
177 unit from being printed. This is useful mainly for feeding
178 the output of adu to scripts that do not expect units.
180 In order to print a percent sign, use \"%%\". Moreover, adu
181 understands \"\\n\" and \"\\t\" and outputs a newline and a
182 tab character for these combinations respectively.
185 Print size in gigabytes right-aligned:
188 As before, but use 5 char wide field:
191 As before, but suppress trailing \"G\":
195 The following list contains all directives known to adu,
196 together with their types, and for which modes each of
199 pw_name (string): user name. Available for user_list
202 uid (id): user id. Available for user_list and
205 files (count): number of files. Available everywhere.
207 dirname (string): name of the directory. Available
208 for user_list and global_list.
210 size (size): total size/ directory size. Available
213 dirs (count): number of directories. Available
214 for user_summary and global_summary.