X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.ggo;h=8c23e3611f657ced1fca94635e2d82ff4faba490;hp=ab6e025a4ea2679f6dd75b4e1134df43a328569a;hb=e584cd6d5a3782ddeb6640f69534ab1664da2605;hpb=2cfa8c8aaa4662f44bc7e7cd4d3591ed6e1326bd

diff --git a/adu.ggo b/adu.ggo
index ab6e025..8c23e36 100644
--- a/adu.ggo
+++ b/adu.ggo
@@ -3,8 +3,7 @@
 # Licensed under the GPL v2. For licencing details see COPYING.
 
 package "adu"
-version "0.0.1"
-purpose "advanced disk usage
+purpose "
 
 adu creates a database containing disk usage statistics of a given
 directory. It allows to query that database to quickly retrieve
@@ -25,7 +24,6 @@ details="
 	configuration file. As usual, if an option is given both at
 	the command line and in the configuration file, the command
 	line option takes precedence.
-
 "
 
 option "database-dir" d
@@ -50,25 +48,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"
@@ -89,9 +68,9 @@ section "Modes"
 defgroup "mode"
 #==============
 groupdesc="
-	adu may started in one of two possible modes, each of which
-	corresponds to a different command line option. Exactly one
-	of these options must be given.
+	adu may be started in one of three possible modes, each of
+	which corresponds to a different command line option. Exactly
+	one of these options must be given.
 
 "
 required
@@ -107,13 +86,27 @@ details="
 	that directory.
 "
 
+groupoption "interactive" I
+#~~~~~~~~~~~~~~~~~~~~~~~~~~
+"activate interactive mode"
+group="mode"
+details="
+	In this mode, adu reads commands from stdin.  This makes it
+	possible to run different select queries without opening the
+	underlying osl database for each query (which is expensive).
+
+	In interactive mode, several subcommands are available, see
+	the end of this document.
+"
+
 groupoption "select" S
 #~~~~~~~~~~~~~~~~~~~~~
 "query a database previously created with --create"
 group="mode"
 details="
-	This option prints statistics about matching subdirectories to
-	stdout. The output depends on the other options, see below.
+	This option prints statistics about matching subdirectories
+	to stdout. The output can be customized by specifying select
+	options, see below.
 "
 
 ##############################
@@ -125,39 +118,53 @@ option "base-dir" b
 "directory to traverse"
 string typestr="path"
 dependon="create"
-required
+optional
 details="
-	The base directory to be traversed recursively. A warning
-	message is printed for each subdirectory that could not be
-	read because of insufficient permission. These directories
-	will be ignored when computing statistics.
+	The base directory to be traversed recursively. Must be
+	given if --create mode was selected. A warning message is
+	printed for each subdirectory that could not be read because
+	of insufficient permission. These directories will be ignored
+	when computing statistics.
 "
 
+option "one-file-system" x
+#~~~~~~~~~~~~~~~~~~~~~~~~~
+"do not dive into other file systems"
+flag off
+dependon="create"
+details="
+	Skip directories that are on different file systems from the
+	one that the argument being processed is on.
+"
+
+option "hash-table-bits" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~
+"specify the size of the uid hash table"
+int typestr="num"
+dependon="create"
+default="10"
+optional
+details="
+	Use a hash table of size 2^num for the uid entries. If more than
+	2^num different uids own at least one regular file under base-dir,
+	the command fails. Increase this value if you have more than 1024
+	users. Decreasing the value causes adu to use slightly less memory.
+"
 
 ##############################
 section "Options for --select"
 ##############################
 
-option "limit" L
-#~~~~~~~~~~~~~~~
-"Limit output"
-int  typestr="num"
-required
-dependon="select"
-details="
-	Only print num lines of output.
-"
-
-option "units" U
-#~~~~~~~~~~~~~~~
-"select numerical output format"
-string typestr="format"
+option "select-options" s
+#~~~~~~~~~~~~~~~~~~~~~~~~~
+"Options for select mode"
+string typestr="<options>"
 optional
+dependon="select"
 details="
-	Print the number of files/directories and the sizes in
-	the given format.  All	sizes  are output in these units:
-	(h)uman-readable, (b)ytes, (k)ilobytes, (m)egabytes,
-	(g)igabytes, (t)erabytes.  Capitalise to use multiples
-	of 1000 (S.I.) instead of 1024. The default is \"h\",
-	i.e. human-readable.
+	This option takes a string whose content is another set of
+	options as described below.  Select options may be specified
+	either directly in select mode, in which case you have use
+	quotes to prevent the select options from being interpreted
+	as adu options, or via the \"set\" command in interactive mode.
 "