Remove unused option --config-file.
[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 "
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 "database-dir" d
18 #~~~~~~~~~~~~~~~~~~~~~~
19 "directory containing the osl tables"
20 string typestr="path"
21 required
22 details="
23 Full path to the directory containing the osl tables. This
24 directory must exist. It must be writable for the user running
25 adu in --create mode and readable in --select mode.
26
27 "
28 option "loglevel" l
29 #~~~~~~~~~~~~~~~~~~
30 "Set loglevel (0-6)"
31 int typestr="level"
32 default="4"
33 optional
34 details="
35 Log messages are always written to stderr while normal output
36 goes to stdout. Lower values mean more verbose logging.
37 "
38
39 ###############
40 section "Modes"
41 ###############
42
43 defgroup "mode"
44 #==============
45 groupdesc="
46 adu may be started in one of three possible modes, each of
47 which corresponds to a different command line option. Exactly
48 one of these options must be given.
49
50 "
51 required
52
53 groupoption "create" C
54 #~~~~~~~~~~~~~~~~~~~~~
55 "Create a new database"
56 group="mode"
57 details="
58 Traverse the given directory and track disk usage on a
59 per-user basis. Results are stored in N + 1 osl tables where
60 N is the number of uids that own at least one regular file
61 in that directory.
62 "
63
64 groupoption "interactive" I
65 #~~~~~~~~~~~~~~~~~~~~~~~~~~
66 "activate interactive mode"
67 group="mode"
68 details="
69 In this mode, adu reads commands from stdin. This makes it
70 possible to run different select queries without opening the
71 underlying osl database for each query (which is expensive).
72
73 In interactive mode, several subcommands are available, see
74 the end of this document.
75 "
76
77 groupoption "select" S
78 #~~~~~~~~~~~~~~~~~~~~~
79 "query a database previously created with --create"
80 group="mode"
81 details="
82 This option prints statistics about matching subdirectories
83 to stdout, to an output file or pipes the output to a given
84 command, depending on the --output option. The output format
85 can be customized by specifying select options, see below.
86 "
87
88 ##############################
89 section "Options for --create"
90 ##############################
91
92 option "base-dir" b
93 #~~~~~~~~~~~~~~~~~~
94 "directory to traverse"
95 string typestr="path"
96 dependon="create"
97 optional
98 details="
99 The base directory to be traversed recursively. A warning
100 message is printed for each subdirectory that could not be
101 read because of insufficient permissions. These directories
102 will be ignored when computing statistics.
103 "
104
105 option "one-file-system" x
106 #~~~~~~~~~~~~~~~~~~~~~~~~~
107 "do not dive into other file systems"
108 flag off
109 dependon="create"
110 details="
111 Skip directories that are on different file systems from the
112 one that the argument being processed is on.
113 "
114
115 option "hash-table-bits" -
116 #~~~~~~~~~~~~~~~~~~~~~~~~~
117 "specify the size of the uid hash table"
118 int typestr="num"
119 dependon="create"
120 default="10"
121 optional
122 details="
123 Use a hash table of size 2^num for the uid entries. If more than
124 2^num different uids own at least one regular file under base-dir,
125 the command fails. Increase this value if you have more than 1024
126 users. Decreasing the value causes adu to use slightly less memory.
127 "
128
129 ##############################
130 section "Options for --select"
131 ##############################
132
133 option "select-options" s
134 #~~~~~~~~~~~~~~~~~~~~~~~~~
135 "Options for select mode"
136 string typestr="<options>"
137 optional
138 dependon="select"
139 details="
140 This option takes a string whose content is another set of
141 options as described below. Select options may be specified
142 either directly in select mode, in which case you have use
143 quotes to prevent the select options from being interpreted
144 as adu options, or via the \"set\" command in interactive mode.
145 "