From: Andre Noll <maan@systemlinux.org>
Date: Sun, 9 Nov 2008 19:37:41 +0000 (+0100)
Subject: Minor documentation updates/fixes/improvements.
X-Git-Tag: v0.0.5~1^2~7
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=4ab31b4091f396b554b001629a5df61c432c8bbc;p=adu.git

Minor documentation updates/fixes/improvements.
---

diff --git a/README b/README
index 5648ac5..7e19d77 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 adu creates a database containing disk usage statistics of a given
 directory. It allows to query that database to quickly retrieve usage
-patterns of subdirectories and/or files owned by a given user.
+patterns of subdirectories containing files owned by a given user.
 
 Four different output modes are available: global list, global summary,
 user list, user summary. The format of the output may be customized
diff --git a/adu.ggo b/adu.ggo
index 2964558..ec24054 100644
--- a/adu.ggo
+++ b/adu.ggo
@@ -80,10 +80,10 @@ groupoption "create" C
 "Create a new database"
 group="mode"
 details="
-	Traverse the given directory and track disk user on a per-user
-	basis. Results are stored in N + 1 osl tables where N is
-	the number of uids that own at least one regular file in
-	that directory.
+	Traverse the given directory and track disk usage on a
+	per-user basis. Results are stored in N + 1 osl tables where
+	N is the number of uids that own at least one regular file
+	in that directory.
 "
 
 groupoption "interactive" I
@@ -91,7 +91,7 @@ groupoption "interactive" I
 "activate interactive mode"
 group="mode"
 details="
-	In this mode, adu reads commands from stdin.  This makes it
+	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).
 
@@ -105,8 +105,9 @@ groupoption "select" S
 group="mode"
 details="
 	This option prints statistics about matching subdirectories
-	to stdout. The output can be customized by specifying select
-	options, see below.
+	to stdout, to an output file or pipes the output to a given
+	command, depending on the --output option. The output format
+	can be customized by specifying select options, see below.
 "
 
 ##############################
@@ -120,11 +121,10 @@ string typestr="path"
 dependon="create"
 optional
 details="
-	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.
+	The base directory to be traversed recursively. A warning
+	message is printed for each subdirectory that could not be
+	read because of insufficient permissions. These directories
+	will be ignored when computing statistics.
 "
 
 option "one-file-system" x
diff --git a/select.ggo b/select.ggo
index f29cd2f..6384c39 100644
--- a/select.ggo
+++ b/select.ggo
@@ -73,10 +73,10 @@ values="user_summary","user_list","global_summary","global_list"
 default="user_summary"
 optional
 details="
-	global_list: List of directories, regardless of owner.
-	global_summary: Only print totals.
+	user_summary: Print totals for each admissible uid.
 	user_list: Print a list for each admissible uid.
-	user_summary Print totals for each admissible uid.
+	global_summary: Only print totals.
+	global_list: List of directories, regardless of owner.
 "
 
 option "list-sort" s