Remove unused --format select option.
[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 "output" o
48 #~~~~~~~~~~~~~~~~
49 "file to write output to"
50 string typestr="<path>"
51 optional
52 default="-"
53 details="
54 If empty, or not given, use stdout.
55 "
56
57 option "size-unit" -
58 #~~~~~~~~~~~~~~~~~~~
59 "select output format for sizes"
60 enum typestr="format"
61 values="h","b","k","m","g","t"
62 default="h"
63 optional
64 details="
65 Print sizes in the given unit: human-readable, bytes,
66 kilobytes (2^10), megabytes (2^20), gigabytes (2^30), terabytes
67 (2^40). The default is \"h\", i.e. human-readable.
68 "
69
70 option "count-unit" -
71 #~~~~~~~~~~~~~~~~~~~~
72 "select output format for counted values"
73 enum typestr="format"
74 values="h","n","k","m","g","t"
75 default="h"
76 optional
77 details="
78 Print the number of files/directories in the given unit:
79 human-readable, number, number/10^3, number/10^6, number/10^12,
80 number/10^15. The default is to print numbers in human-readable
81 format.
82 "
83
84
85 option "user-summary-sort" -
86 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 "how to sort the user-summary"
88 enum typestr="col_spec"
89 values="name","uid","dir_count","file_count","size"
90 default="size"
91 optional
92 details="
93 It is enough to specify the first letter of the column specifier,
94 e.g. \"--user-summary-sort f\" sorts by file count.
95 "
96
97 option "no-user-summary" -
98 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
99 "do not print the user summary table"
100 flag off
101
102
103 option "user-list" -
104 #~~~~~~~~~~~~~~~~~~~
105 "how to print per-user directory listings"
106 enum typestr="which"
107 values="size","file_count","both","none"
108 default="both"
109 optional
110 details="
111 Similar to the global directory listings mentioned above,
112 adu can print two directory listings per user. This option
113 controls which of the these should be printed.
114 "
115 option "no-global-summary" -
116 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
117 "do not print the summary line"
118 flag off
119
120 option "global-list" -
121 #~~~~~~~~~~~~~~~~~~~~~
122 "how to print global directory listings"
123 enum typestr="which"
124 values="size","file_count","both","none"
125 default="both"
126 optional
127 details="
128 By default adu prints two global directory listings: The
129 first prints the directory names ordered by the sum of the
130 sizes of the contained files while the second listing prints
131 them sorted by the number of files. This option can be used
132 to print only one or neither of these two listings.
133 "
134 option "print-base-dir" -
135 #~~~~~~~~~~~~~~~~~~~~~~~~
136 "whether to include the base-dir in the output"
137 flag off
138 details="
139 If this flag is given, all directories printed are prefixed
140 with the base directory. The default is to print paths relative
141 to the base dir.
142 "
143
144 ########################
145 section "Format strings"
146 ########################
147
148 option "global-summary-format" -
149 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150 "How to format the global summary"
151 string typestr="<format>"
152 default="#directories: %(dirs), #files: %(files), size: %(size)\n\n"
153 details="
154 dirs: The number of directories
155 files: The number of files
156 size: Total size of all files
157 "
158 optional
159
160 option "user-summary-format" -
161 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162 "How to format the user summary"
163 string typestr="<format>"
164 default="%(pw_name:l:16) %(uid:r:5) %(dirs:r:5) %(files:r:5) %(size:r:5)\n"
165 details="
166 pw_name: The user name
167 uid: The user id
168 dirs: The number of directories
169 files: The number of files
170 size: Total size of all files
171 "
172 optional