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

diff --git a/select.ggo b/select.ggo
index 99ed133..c4e1ec0 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="
@@ -116,11 +116,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 +174,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,7 +189,7 @@ 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
 	substituted by the name of the directory. It is available