Fix prototype of com_create().
[adu.git] / select.ggo
1
2 option "uid" u
3 #~~~~~~~~~~~~~
4 "user id(s) to take into account"
5 string typestr="uid_spec"
6 optional
7 multiple
8 details="
9 An uid specifier may be a single number, or a range of uids.
10 Example:
11
12 --uid 42 # only consider uid 42
13 --uid 42- # only consider uids greater or equal than 42
14 --uid 23-42 # only consider uids between 23 and 42, inclusively.
15
16 This option may be given multiple times. An uid is taken into
17 account if it satisfies at least one --uid option.
18 "
19
20 option "limit" L
21 #~~~~~~~~~~~~~~~
22 "Limit output"
23 int typestr="num"
24 default="-1"
25 optional
26 details="
27 Only print num lines of output. If negative (the default),
28 print all lines.
29 "
30
31 option "no-headers" -
32 #~~~~~~~~~~~~~~~~~~~~
33 "supress descriptions for listings/tables"
34 flag off
35 details="
36 This is mostly useful to feed the output of adu to scripts.
37 "
38
39 option "sort" s
40 #~~~~~~~~~~~~~~~
41 "how to sort the output"
42 enum typestr="<key>"
43 values="sizes","files","unsorted"
44 default="sizes"
45 optional
46 details="
47 Sort by file size, file count or unsorted.
48 "
49
50 option "format" f
51 #~~~~~~~~~~~~~~~~~
52 "how to format the output"
53 string typestr="<format>"
54 optional
55 details="
56 %(basedir) -- the path given to --base-dir during create
57 %(dir) -- the name of the directory
58 %(dir_size) -- the size of the sum of all regular files in this directory
59 %(num_files) -- the number of regular files in this directory
60 %% -- interpolates to %
61 %xx -- interpolates to the character with hex code xx
62 "
63
64 option "output" o
65 #~~~~~~~~~~~~~~~~
66 "file to write output to"
67 string typestr="<path>"
68 optional
69 default="-"
70 details="
71 If empty, or not given, use stdout.
72 "