Move --size-unit and --count-unit from adu.ggo to select.ggo.
[adu.git] / adu.ggo
1 # Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
2 #
3 # Licensed under the GPL v2. For licencing details see COPYING.
4
5 package "adu"
6 purpose "advanced disk usage
7
8 adu creates a database containing disk usage statistics of a given
9 directory. It allows to query that database to quickly retrieve
10 usage patterns of subdirectories and/or files owned by a given user id.
11 "
12
13 #########################
14 section "General options"
15 #########################
16
17 option "config-file" c
18 #~~~~~~~~~~~~~~~~~~~~~
19 "(default='~/.adurc')"
20 string typestr="filename"
21 optional
22 details="
23 Options may be given at the command line or in the
24 configuration file. As usual, if an option is given both at
25 the command line and in the configuration file, the command
26 line option takes precedence.
27
28 "
29
30 option "database-dir" d
31 #~~~~~~~~~~~~~~~~~~~~~~
32 "directory containing the osl tables"
33 string typestr="path"
34 required
35 details="
36 Full path to the directory containing the osl tables. This
37 directory must exist. It must be writable for the user running
38 adu in --create mode and readable in --select mode.
39
40 "
41 option "loglevel" l
42 #~~~~~~~~~~~~~~~~~~
43 "Set loglevel (0-6)"
44 int typestr="level"
45 default="3"
46 optional
47 details="
48 Log messages are always written to stderr while normal output
49 goes to stdout. Lower values mean more verbose logging.
50 "
51
52 option "paths" p
53 #~~~~~~~~~~~~~~~
54 "files to take into account"
55 string typestr="pattern"
56 optional
57 details="
58 Shell wildcard pattern that must match a file in order to be
59 included in the database in --create mode or in the output
60 for --select mode. Only the part of the filename below the
61 base directory is matched against the pattern. The default
62 is to take all files into account. See fnmatch(3) for details.
63 "
64
65 ###############
66 section "Modes"
67 ###############
68
69 defgroup "mode"
70 #==============
71 groupdesc="
72 adu may be started in one of two possible modes, each of which
73 corresponds to a different command line option. Exactly one
74 of these options must be given.
75
76 "
77 required
78
79 groupoption "create" C
80 #~~~~~~~~~~~~~~~~~~~~~
81 "Create a new database"
82 group="mode"
83 details="
84 Traverse the given directory and track disk user on a per-user
85 basis. Results are stored in N + 1 osl tables where N is
86 the number of uids that own at least one regular file in
87 that directory.
88 "
89
90 groupoption "interactive" I
91 #~~~~~~~~~~~~~~~~~~~~~~~~~~
92 "activate interactive mode"
93 group="mode"
94 details="
95 In this mode, adu reads commands from stdin.
96 "
97
98 groupoption "select" S
99 #~~~~~~~~~~~~~~~~~~~~~
100 "query a database previously created with --create"
101 group="mode"
102 details="
103 This option prints statistics about matching subdirectories to
104 stdout. The output depends on the other options, see below.
105 "
106
107 ##############################
108 section "Options for --create"
109 ##############################
110
111 option "base-dir" b
112 #~~~~~~~~~~~~~~~~~~
113 "directory to traverse"
114 string typestr="path"
115 dependon="create"
116 optional
117 details="
118 The base directory to be traversed recursively. Must be
119 given if --create mode was selected. A warning message is
120 printed for each subdirectory that could not be read because
121 of insufficient permission. These directories will be ignored
122 when computing statistics.
123 "
124
125 option "one-file-system" x
126 #~~~~~~~~~~~~~~~~~~~~~~~~~
127 "do not dive into other file systems"
128 flag off
129 dependon="create"
130 details="
131 Skip directories that are on different filesystems from the
132 one that the argument being processed is on.
133 "
134
135 option "hash-table-bits" -
136 #~~~~~~~~~~~~~~~~~~~~~~~~~
137 "specify the size of the uid hash table"
138 int typestr="num"
139 dependon="create"
140 default="10"
141 optional
142 details="
143 Use a hash table of size 2^num for the uid entries. If more than
144 2^num different uids own at least one regular file under base-dir,
145 the command fails. Increase this value if you have more than 1024
146 users. Decreasing the value causes adu to use slightly less memory.
147 "
148
149 ##############################
150 section "Options for --select"
151 ##############################
152
153 option "select-options" s
154 #~~~~~~~~~~~~~~~~~~~~~~~~~
155 "options for select mode"
156 string typestr="<options>"
157 optional
158 dependon="select"
159 details="
160 Try --select-options \"-h\"
161 "
162
163 option "print-base-dir" -
164 #~~~~~~~~~~~~~~~~~~~~~~~~
165 "whether to include the base-dir in the output"
166 flag off
167 details="
168 If this flag is given, all directories printed are prefixed
169 with the base directory. The default is to print paths relative
170 to the base dir.
171 "
172
173 option "no-headers" -
174 #~~~~~~~~~~~~~~~~~~~~
175 "supress descriptions for listings/tables"
176 flag off
177 dependon="select"
178 details="
179 This is mostly useful to feed the output of adu to scripts.
180 "
181
182 option "global-list" -
183 #~~~~~~~~~~~~~~~~~~~~~
184 "how to print global directory listings"
185 enum typestr="which"
186 values="size","file_count","both","none"
187 default="both"
188 optional
189 dependon="select"
190 details="
191 By default adu prints two global directory listings: The
192 first prints the directory names ordered by the sum of the
193 sizes of the contained files while the second listing prints
194 them sorted by the number of files. This option can be used
195 to print only one or neither of these two listings.
196 "
197
198 option "no-global-summary" -
199 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
200 "do not print the summary line"
201 flag off
202 dependon="select"
203
204 option "user-list" -
205 #~~~~~~~~~~~~~~~~~~~
206 "how to print per-user directory listings"
207 enum typestr="which"
208 values="size","file_count","both","none"
209 default="both"
210 optional
211 dependon="select"
212 details="
213 Similar to the global directory listings mentioned above,
214 adu can print two directory listings per user. This option
215 controls which of the these should be printed.
216 "
217
218 option "no-user-summary" -
219 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
220 "do not print the user summary table"
221 flag off
222 dependon="select"
223
224
225 option "user-summary-sort" -
226 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
227 "how to sort the user-summary"
228 enum typestr="col_spec"
229 values="name","uid","dir_count","file_count","size"
230 default="size"
231 optional
232 dependon="select"
233 details="
234 It is enough to specify the first letter of the column specifier,
235 e.g. \"--user-summary-sort f\" sorts by file count.
236 "