X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;ds=sidebyside;f=select.ggo;h=5ea4e8e80825ef0193c0e69e02c9341f07683fd7;hb=26ace9b8c1dc872e5da1b1122b45f01419761aab;hp=78d6d75b12afadf6b830c852993efdffd25925fa;hpb=a56b058b5c6531571b77f9e899eb8b6557693112;p=adu.git

diff --git a/select.ggo b/select.ggo
index 78d6d75..5ea4e8e 100644
--- a/select.ggo
+++ b/select.ggo
@@ -1,17 +1,38 @@
+option "user" u
+#~~~~~~~~~~~~~~
+"users to take into account"
+string typestr="user_name"
+optional
+multiple
+details="
+	This option may be given multiple times in which case all given
+	user names are considered admissible. See also --uid below.
+"
 
-option "uid" u
+option "uid" U
 #~~~~~~~~~~~~~
 "user id(s) to take into account"
 string typestr="uid_spec"
 optional
 details="
-	An uid specifier may be a single number, or a range of uids.
+	An uid specifier may be a single uid, a range of uids,
+	or a comma-separated list of single uids or ranges.
 	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.
-	--uid 23-42,666-777,88 # consider uids 23-42, 666-777 and 88.
+	Only consider uid 42:
+		--uid 42
+
+	Only consider uids greater or equal than 42:
+		--uid 42-
+
+	Only consider uids between 23 and 42, inclusively:
+		--uid 23-42
+
+	Consider uids 23-42, 666-777 and 88:
+		--uid 23-42,666-777,88
+
+	If no --user option is given and also --uid option is not given
+	(the default), all users are taken into account.
 "
 
 option "limit" L
@@ -27,7 +48,7 @@ details="
 
 option "no-headers" -
 #~~~~~~~~~~~~~~~~~~~~
-"supress descriptions for listings/summaries"
+"suppress descriptions for listings/summaries"
 flag off
 details="
 	This is mostly useful to feed the output of adu to scripts.
@@ -97,8 +118,9 @@ option "format" f
 string typestr="<format_string>"
 optional
 details="
+
 	A string that specifies how the output of the select query is
-	goint to be formated.  Depending on the chosen select-mode,
+	going to be formated.  Depending on the chosen select-mode,
 	several conversion specifiers are available and a different
 	default value for this option applies.
 
@@ -116,14 +138,18 @@ details="
 	positive integer.  Both \"a\" and \"w\" are optional.
 
 	A string directive supported by adu is \"dirname\" which is
-	subsitituted by the name of the directory. It is available
+	substituted by the name of the directory. It is available
 	if either user_list or global_list mode was selected via
 	--select-mode.
 
 	Examples:
+		Print dirname without any padding:
+
+		\"%(diname)\"
+
+		Center dirname in a 20 chars wide field:
 
-		\"%(diname)\" # print dirname without any padding
-		\"%(dirname:c:20)\" # center dirname in a 20 chars wide field
+		\"%(dirname:c:20)\"
 
 	The other two types of directives, count and size, are used
 	for numbers. The syntax for these is %(name:a:w:u). The \"a\"
@@ -155,30 +181,34 @@ details="
 	tab character for these combinations respectively.
 
 	Examples:
+		Print size in gigabytes right-aligned:
+			\"%(size:r::G)\"
+
+		As before, but use 5 char wide field:
+			\"%(size:r5::G)\"
+
+		As before, but suppress trailing \"G\":
+			\"%(size:r5::*G)\"
+
+
+	The following list contains all directives known to adu,
+	together with their types, and for which modes each of
+	them may be used.
+
+		pw_name (string): user name. Available for user_list
+		and user_summary
+
+		uid (id): user id. Available for user_list and
+		user_summary.
+
+		files (count): number of files. Available everywhere.
+
+		dirname (string): name of the directory. Available
+		for user_list and global_list.
+
+		size (size): total size/ directory size. Available
+		everywhere.
 
-		\"%(size:r::G)\" # print size in gigabytes right-aligned
-		\"%(size:r5::G)\" # as before, but use 5 char wide field
-		\"%(size:r5::*G)\" # as before, but supress trailing \"G\"
-
-	List of directives and types known to adu, together with their types:
-
-		name		type		meaning
-		~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-		pw_name		string		user name
-		uid		id		user id
-		files		count		number of files
-		dirname		string		name of the directory
-		size		size		total size/ directory size
-		dirs		count		number of directories
-
-	Not all directives are available for each mode:
-
-		name		available in directives
-		~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-		pw_name		user_list, user_summary
-		uid		user_list, user_summary
-		files		everywhere
-		dirname		user_list, global_list
-		size		everywhere
-		dirs		suer_summary, global_summary
+		dirs (count): number of directories. Available
+		for user_summary and global_summary.
 "