X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=select.ggo;h=b0b1daa6f007c5e13958ca799a7d6e32dec8b206;hp=a1de3a910d7cb6dc045d76011417861a3c02a128;hb=1231699dcaf1e96aabe33ef621aedecec83a5ccd;hpb=063c3ce425c76cc938b21de99a6e24086fc4b20a

diff --git a/select.ggo b/select.ggo
index a1de3a9..b0b1daa 100644
--- a/select.ggo
+++ b/select.ggo
@@ -33,6 +33,20 @@ details="
 	This is mostly useful to feed the output of adu to scripts.
 "
 
+option "select-mode" m
+#~~~~~~~~~~~~~~~~~~~~~
+"How to print the results of the query"
+enum typestr="<key>"
+values="global_list","global_summary","user_list","user_summary"
+default="global_list"
+optional
+details="
+	global_list: List of directories, regardless of owner.
+	global_summary: Only print totals.
+	user_list: Print a list for each admissible uid.
+	user_summary Print totals for each admissible uid.
+"
+
 option "sort" s
 #~~~~~~~~~~~~~~~
 "how to sort the output"
@@ -44,20 +58,6 @@ details="
 	Sort by file size, file count or unsorted.
 "
 
-option "format" f
-#~~~~~~~~~~~~~~~~~
-"how to format the output"
-string typestr="<format>"
-optional
-details="
-	%(basedir) 	-- the path given to --base-dir during create
-	%(dir)		-- the name of the directory
-	%(dir_size)	-- the size of the sum of all regular files in this directory
-	%(num_files)	-- the number of regular files in this directory
-	%%		-- interpolates to %
-	%xx		-- interpolates to the character with hex code xx
-"
-
 option "output" o
 #~~~~~~~~~~~~~~~~
 "file to write output to"
@@ -95,3 +95,104 @@ details="
 	format.
 "
 
+
+option "user-summary-sort" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"how to sort the user-summary"
+enum typestr="col_spec"
+values="name","uid","dir_count","file_count","size"
+default="size"
+optional
+details="
+	It is enough to specify the first letter of the column specifier,
+	e.g. \"--user-summary-sort f\" sorts by file count.
+"
+
+option "no-user-summary" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"do not print the user summary table"
+flag off
+
+
+option "user-list" -
+#~~~~~~~~~~~~~~~~~~~
+"how to print per-user directory listings"
+enum typestr="which"
+values="size","file_count","both","none"
+default="both"
+optional
+details="
+	Similar to the global directory listings mentioned above,
+	adu can print two directory listings per user. This option
+	controls which of the these should be printed.
+"
+option "no-global-summary" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"do not print the summary line"
+flag off
+
+option "global-list" -
+#~~~~~~~~~~~~~~~~~~~~~
+"how to print global directory listings"
+enum typestr="which"
+values="size","file_count","both","none"
+default="both"
+optional
+details="
+	By default adu prints two global directory listings: The
+	first prints the directory names ordered by the sum of the
+	sizes of the contained files while the second listing prints
+	them sorted by the number of files. This option can be used
+	to print only one or neither of these two listings.
+"
+option "print-base-dir" -
+#~~~~~~~~~~~~~~~~~~~~~~~~
+"whether to include the base-dir in the output"
+flag off
+details="
+	If this flag is given, all directories printed are prefixed
+	with the base directory. The default is to print paths relative
+	to the base dir.
+"
+
+########################
+section "Format strings"
+########################
+
+option "global-list-format" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"How to format the global list"
+string typestr="<format>"
+default="%(size:r:8) %(files:r:8) %(dirname)\n"
+details="
+	size: Total size of all files
+	files: The number of files
+	dirname: The name of the directory
+"
+
+optional
+option "global-summary-format" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"How to format the global summary"
+string typestr="<format>"
+default="#directories: %(dirs), #files: %(files), size: %(size)\n\n"
+details="
+	dirs: The number of directories
+	files: The number of files
+	size: Total size of all files
+"
+optional
+
+option "user-summary-format" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"How to format the user summary"
+string typestr="<format>"
+default="%(pw_name:l:16) %(uid:r:5) %(dirs:r:5) %(files:r:5) %(size:r:5)\n"
+details="
+	pw_name: The user name
+	uid: The user id
+	dirs: The number of directories
+	files: The number of files
+	size: Total size of all files
+"
+optional