a2a6c03192bf1e615e6cc8ff25eb60e538cc40ad
[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 version "0.0.1"
7 purpose "advanced disk usage
8
9 adu creates a database containing disk usage statistics of a given
10 directory. It allows to query that database to quickly retrieve
11 usage patterns of subdirectories and/or files owned by a given user id.
12 "
13
14 #########################
15 section "General options"
16 #########################
17
18 option "config-file" c
19 #~~~~~~~~~~~~~~~~~~~~~
20 "(default='~/.adurc')"
21 string typestr="filename"
22 optional
23 details="
24 Options may be given at the command line or in the
25 configuration file. As usual, if an option is given both at
26 the command line and in the configuration file, the command
27 line option takes precedence.
28
29 "
30
31 option "database-dir" d
32 #~~~~~~~~~~~~~~~~~~~~~~
33 "directory containing the osl tables"
34 string typestr="path"
35 required
36 details="
37 Full path to the directory containing the osl tables. This
38 directory must exist. It must be writable for the user running
39 adu in --create mode and readable in --select mode.
40
41 "
42 option "loglevel" l
43 #~~~~~~~~~~~~~~~~~~
44 "Set loglevel (0-6)"
45 int typestr="level"
46 default="3"
47 optional
48 details="
49 Log messages are always written to stderr while normal output
50 goes to stdout. Lower values mean more verbose logging.
51 "
52
53 option "uid" u
54 #~~~~~~~~~~~~~
55 "user id(s) to take into account"
56 string typestr="uid_spec"
57 optional
58 multiple
59 details="
60 An uid specifier may be a single number, or a range of uids.
61 Example:
62
63 --uid 42 # only consider uid 42
64 --uid 42- # only consider uids greater or equal than 42
65 --uid 23-42 # only consider uids between 23 and 42, inclusively.
66
67 This option may be given multiple times. An uid is taken into
68 account if it satisfies at least one --uid option.
69 "
70
71
72 option "paths" p
73 #~~~~~~~~~~~~~~~
74 "files to take into account"
75 string typestr="pattern"
76 optional
77 details="
78 Shell wildcard pattern that must match a file in order to be
79 included in the database in --create mode or in the output
80 for --select mode. Only the part of the filename below the
81 base directory is matched against the pattern. The default
82 is to take all files into account. See fnmatch(3) for details.
83 "
84
85 ###############
86 section "Modes"
87 ###############
88
89 defgroup "mode"
90 #==============
91 groupdesc="
92 adu may be started in one of two possible modes, each of which
93 corresponds to a different command line option. Exactly one
94 of these options must be given.
95
96 "
97 required
98
99 groupoption "create" C
100 #~~~~~~~~~~~~~~~~~~~~~
101 "Create a new database"
102 group="mode"
103 details="
104 Traverse the given directory and track disk user on a per-user
105 basis. Results are stored in N + 1 osl tables where N is
106 the number of uids that own at least one regular file in
107 that directory.
108 "
109
110 groupoption "select" S
111 #~~~~~~~~~~~~~~~~~~~~~
112 "query a database previously created with --create"
113 group="mode"
114 details="
115 This option prints statistics about matching subdirectories to
116 stdout. The output depends on the other options, see below.
117 "
118
119 ##############################
120 section "Options for --create"
121 ##############################
122
123 option "base-dir" b
124 #~~~~~~~~~~~~~~~~~~
125 "directory to traverse"
126 string typestr="path"
127 dependon="create"
128 required
129 details="
130 The base directory to be traversed recursively. A warning
131 message is printed for each subdirectory that could not be
132 read because of insufficient permission. These directories
133 will be ignored when computing statistics.
134 "
135
136 option "one-file-system" x
137 #~~~~~~~~~~~~~~~~~~~~~~~~~
138 "do not dive into other file systems"
139 flag off
140 dependon="create"
141 details="
142 Skip directories that are on different filesystems from the
143 one that the argument being processed is on.
144 "
145
146 ##############################
147 section "Options for --select"
148 ##############################
149
150 option "limit" L
151 #~~~~~~~~~~~~~~~
152 "Limit output"
153 int typestr="num"
154 default="-1"
155 optional
156 dependon="select"
157 details="
158 Only print num lines of output. If negative (the default),
159 print all lines.
160 "
161
162 option "size_unit" -
163 #~~~~~~~~~~~~~~~~~~~
164 "select output format for sizes"
165 enum typestr="format"
166 values="h","b","k","m","g","t"
167 default="h"
168 optional
169 details="
170 Print sizes in the given unit: human-readable, bytes,
171 kilobytes (2^10), megabytes (2^20), gigabytes (2^30), terabytes
172 (2^40). The default is \"h\", i.e. human-readable.
173 "
174
175 option "count_unit" -
176 #~~~~~~~~~~~~~~~~~~~~
177 "select output format for counted values"
178 enum typestr="format"
179 values="h","n","k","m","g","t"
180 default="h"
181 optional
182 details="
183 Print the number of files/directories in the given unit:
184 human-readable, number, number/10^3, number/10^6, number/10^12,
185 number/10^15. The default is to print numbers in human-readable
186 format.
187 "