a1de3a910d7cb6dc045d76011417861a3c02a128
[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 details="
8 An uid specifier may be a single number, or a range of uids.
9 Example:
10
11 --uid 42 # only consider uid 42
12 --uid 42- # only consider uids greater or equal than 42
13 --uid 23-42 # only consider uids between 23 and 42, inclusively.
14 --uid 23-42,666-777,88 # consider uids 23-42, 666-777 and 88.
15 "
16
17 option "limit" L
18 #~~~~~~~~~~~~~~~
19 "Limit output"
20 int typestr="num"
21 default="-1"
22 optional
23 details="
24 Only print num lines of output. If negative (the default),
25 print all lines.
26 "
27
28 option "no-headers" -
29 #~~~~~~~~~~~~~~~~~~~~
30 "supress descriptions for listings/tables"
31 flag off
32 details="
33 This is mostly useful to feed the output of adu to scripts.
34 "
35
36 option "sort" s
37 #~~~~~~~~~~~~~~~
38 "how to sort the output"
39 enum typestr="<key>"
40 values="sizes","files","unsorted"
41 default="sizes"
42 optional
43 details="
44 Sort by file size, file count or unsorted.
45 "
46
47 option "format" f
48 #~~~~~~~~~~~~~~~~~
49 "how to format the output"
50 string typestr="<format>"
51 optional
52 details="
53 %(basedir) -- the path given to --base-dir during create
54 %(dir) -- the name of the directory
55 %(dir_size) -- the size of the sum of all regular files in this directory
56 %(num_files) -- the number of regular files in this directory
57 %% -- interpolates to %
58 %xx -- interpolates to the character with hex code xx
59 "
60
61 option "output" o
62 #~~~~~~~~~~~~~~~~
63 "file to write output to"
64 string typestr="<path>"
65 optional
66 default="-"
67 details="
68 If empty, or not given, use stdout.
69 "
70
71 option "size-unit" -
72 #~~~~~~~~~~~~~~~~~~~
73 "select output format for sizes"
74 enum typestr="format"
75 values="h","b","k","m","g","t"
76 default="h"
77 optional
78 details="
79 Print sizes in the given unit: human-readable, bytes,
80 kilobytes (2^10), megabytes (2^20), gigabytes (2^30), terabytes
81 (2^40). The default is \"h\", i.e. human-readable.
82 "
83
84 option "count-unit" -
85 #~~~~~~~~~~~~~~~~~~~~
86 "select output format for counted values"
87 enum typestr="format"
88 values="h","n","k","m","g","t"
89 default="h"
90 optional
91 details="
92 Print the number of files/directories in the given unit:
93 human-readable, number, number/10^3, number/10^6, number/10^12,
94 number/10^15. The default is to print numbers in human-readable
95 format.
96 "
97