X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=select.ggo;h=d96609536e46865dd6134a918e185103e5c0c6ff;hp=99ed13370180c3abff5bed37f3f7380f06c18ad4;hb=2a506d3256329ead41afe0bb720fdeae4e5ed08c;hpb=63cf7c8fbf05a53b58e1de1116ec2660b9cb7801

diff --git a/select.ggo b/select.ggo
index 99ed133..d966095 100644
--- a/select.ggo
+++ b/select.ggo
@@ -38,7 +38,7 @@ details="
 option "limit" l
 #~~~~~~~~~~~~~~~
 "Limit output"
-int  typestr="num"
+int typestr="num"
 default="-1"
 optional
 details="
@@ -87,6 +87,20 @@ details="
 	output to scripts.
 "
 
+option "trailer" T
+#~~~~~~~~~~~~~~~~~
+"use a customized trailer for listings/summaries"
+string typestr="string"
+optional
+default=""
+details="
+	This option can be used to print any string at the end of
+	the query output.
+
+	In user_list mode the trailer is a format string with the
+	same semantics like the header string.
+"
+
 option "select-mode" m
 #~~~~~~~~~~~~~~~~~~~~~
 "How to print the results of the query"
@@ -116,11 +130,32 @@ details="
 option "output" o
 #~~~~~~~~~~~~~~~~
 "file to write output to"
-string typestr="<path>"
+string typestr="path"
 optional
 default="-"
 details="
-	If empty, or not given, use stdout.
+	If empty, or not given, use stdout. The following conventions
+	cause the output to be written differently:
+
+	An output file name of \"-\" means stdout.
+
+	\"path\" may be prepended by '>' which instructs adu to
+	truncate the output file to length zero.  If \"path\" does
+	not start with '>' and \"path\" already exists, the select
+	query is being aborted. Otherwise, \"path\" is created and
+	output is written to \"path\".
+
+	If the first two characters of \"path\" are '>', the output
+	file (given by removing the leading \">>\" from \"path\")
+	is being opened in append mode. It is no error if the output
+	file does not exist but, as above, the output file name \">>\"
+	is considered invalid.
+
+	If the first character of \"path\" is '|', a pipe is created
+	and the rest of \"path\" is being executed with its standard in
+	redirected to the reading end of the pipe. The output of adu
+	is written to the writing end of the pipe. Again, specifying
+	only \"|\" is considered invalid and causes an error.
 "
 
 option "user-summary-sort" -
@@ -153,12 +188,12 @@ optional
 details="
 
 	A string that specifies how the output of the select query is
-	going 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.
 
 	adu knows four different types of directives: string, id,
-	count and size.  These are explained in more detail below.
+	count and size. These are explained in more detail below.
 
 	The general syntax for string and id directives is %(name:a:w)
 	where \"name\" is the name of the directive, \"a\" specifies
@@ -168,9 +203,9 @@ details="
 	The alignment specifier is a single character: Either \"l\",
 	\"r\", or \"c\" may be given to specify left, right and
 	centered alignment respectively. The with specifier is a
-	positive integer.  Both \"a\" and \"w\" are optional.
+	positive integer. Both \"a\" and \"w\" are optional.
 
-	A string directive supported by adu is \"dirname\" which is
+	One string directive supported by adu is \"dirname\" which is
 	substituted by the name of the directory. It is available
 	if either user_list or global_list mode was selected via
 	--select-mode.
@@ -184,12 +219,12 @@ details="
 
 		\"%(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\"
-	and the \"w\" specifier have the same meaning as for the string
-	and id directives. The additional \"u\" specifier selects a unit
-	in which the number that corresponds to the directive should
-	be formated. All three specifiers are optional.
+	The count and size directives are used for non-negative
+	numbers. The syntax for these is %(name:a:w:u). The \"a\" and
+	the \"w\" specifiers have the same meaning as for the string
+	and id directives. The additional \"u\" specifier selects a
+	unit in which the number that corresponds to the directive
+	should be formated. All three specifiers are optional.
 
 	Possible units are the characters of the set \" bkmgtBKMGT\"
 	specifying bytes, kilobytes, megabytes, gigabytes and