User handling improvments.

[adu.git] / adu.ggo

diff --git a/adu.ggo b/adu.ggo
index 11a5d009d09a4bc4b50199569f9543fed63f52da..8c23e3611f657ced1fca94635e2d82ff4faba490 100644 (file)
--- a/adu.ggo
+++ b/adu.ggo
@@ -3,7 +3,7 @@
 # Licensed under the GPL v2. For licencing details see COPYING.
 
 package "adu"
-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
@@ -24,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
@@ -69,9 +68,9 @@ section "Modes"
 defgroup "mode"
 #==============
 groupdesc="
-       adu may be 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
@@ -92,7 +91,12 @@ groupoption "interactive" I
 "activate interactive mode"
 group="mode"
 details="
-       In this mode, adu reads commands from stdin.
+       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
@@ -100,8 +104,9 @@ 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.
 "
 
 ##############################
@@ -128,7 +133,7 @@ option "one-file-system" x
 flag off
 dependon="create"
 details="
-       Skip directories that are on different filesystems from the
+       Skip directories that are on different file systems from the
        one that the argument being processed is on.
 "
 
@@ -146,6 +151,10 @@ details="
        users. Decreasing the value causes adu to use slightly less memory.
 "
 
+##############################
+section "Options for --select"
+##############################
+
 option "select-options" s
 #~~~~~~~~~~~~~~~~~~~~~~~~~
 "Options for select mode"
@@ -153,5 +162,9 @@ string typestr="<options>"
 optional
 dependon="select"
 details="
-       Try --select-options \"-h\"
+       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.
 "