X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=adu.ggo;h=dae8737a4036d5ee19fcc2f2fb39425bb47e5c7c;hb=afc8a4212e37abd7467b21da543167285ae0c9c5;hp=2a6af089b4af101cb56aecb9750077128ded50e5;hpb=62b002ae08225cb53be301ad10808f2e6e69ffbc;p=adu.git

diff --git a/adu.ggo b/adu.ggo
index 2a6af08..dae8737 100644
--- a/adu.ggo
+++ b/adu.ggo
@@ -3,7 +3,6 @@
 # Licensed under the GPL v2. For licencing details see COPYING.
 
 package "adu"
-version "0.0.1"
 purpose "advanced disk usage
 
 adu creates a database containing disk usage statistics of a given
@@ -50,25 +49,6 @@ details="
 	goes to stdout. Lower values mean more verbose logging.
 "
 
-option "uid" u
-#~~~~~~~~~~~~~
-"user id(s) to take into account"
-string typestr="uid_spec"
-optional
-multiple
-details="
-	An uid specifier may be a single number, or a range of uids.
-	Example:
-
-	--uid 42    # only consider uid 42
-	--uid 42-   # only consider uids greater or equal than 42
-	--uid 23-42 # only consider uids between 23 and 42, inclusively.
-
-	This option may be given multiple times. An uid is taken into
-	account if it satisfies at least one --uid option.
-"
-
-
 option "paths" p
 #~~~~~~~~~~~~~~~
 "files to take into account"
@@ -107,6 +87,14 @@ details="
 	that directory.
 "
 
+groupoption "interactive" I
+#~~~~~~~~~~~~~~~~~~~~~~~~~~
+"activate interactive mode"
+group="mode"
+details="
+	In this mode, adu reads commands from stdin.
+"
+
 groupoption "select" S
 #~~~~~~~~~~~~~~~~~~~~~
 "query a database previously created with --create"
@@ -158,58 +146,78 @@ details="
 	users. Decreasing the value causes adu to use slightly less memory.
 "
 
-
 ##############################
 section "Options for --select"
 ##############################
 
-option "limit" L
-#~~~~~~~~~~~~~~~
-"Limit output"
-int  typestr="num"
-default="-1"
+option "select-options" s
+#~~~~~~~~~~~~~~~~~~~~~~~~~
+"options for select mode"
+string typestr="<options>"
 optional
 dependon="select"
 details="
-	Only print num lines of output. If negative (the default),
-	print all lines.
+	Try --select-options \"-h\"
 "
 
-option "size-unit" -
-#~~~~~~~~~~~~~~~~~~~
-"select output format for sizes"
-enum typestr="format"
-values="h","b","k","m","g","t"
-default="h"
-optional
+option "print-base-dir" -
+#~~~~~~~~~~~~~~~~~~~~~~~~
+"whether to include the base-dir in the output"
+flag off
 details="
-	Print sizes in the given unit: human-readable, bytes,
-	kilobytes (2^10), megabytes (2^20), gigabytes (2^30), terabytes
-	(2^40). The default is \"h\", i.e. human-readable.
+	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.
 "
 
-option "count-unit" -
+option "no-headers" -
 #~~~~~~~~~~~~~~~~~~~~
-"select output format for counted values"
-enum typestr="format"
-values="h","n","k","m","g","t"
-default="h"
+"supress descriptions for listings/tables"
+flag off
+dependon="select"
+details="
+	This is mostly useful to feed the output of adu to scripts.
+"
+
+option "global-list" -
+#~~~~~~~~~~~~~~~~~~~~~
+"how to print global directory listings"
+enum typestr="which"
+values="size","file_count","both","none"
+default="both"
 optional
+dependon="select"
 details="
-	Print the number of files/directories in the given unit:
-	human-readable, number, number/10^3, number/10^6, number/10^12,
-	number/10^15. The default is to print numbers in human-readable
-	format.
+	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 "user-summary-sort" -
+option "no-global-summary" -
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
-"how to sort the user-summary"
-enum typestr="col_spec"
-values="name","uid","dir_count","file_count","size"
-default="size"
+"do not print the summary line"
+flag off
+dependon="select"
+
+option "user-list" -
+#~~~~~~~~~~~~~~~~~~~
+"how to print per-user directory listings"
+enum typestr="which"
+values="size","file_count","both","none"
+default="both"
 optional
+dependon="select"
 details="
-	It is enough to specify the first letter of the column specifier,
-	e.g. \"--user-summary-sort f\" sorts by file count.
+	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-user-summary" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"do not print the user summary table"
+flag off
+dependon="select"
+