Add documentation of the enhancments to --output.
authorAndre Noll <maan@systemlinux.org>
Mon, 10 Nov 2008 09:23:06 +0000 (10:23 +0100)
committerAndre Noll <maan@systemlinux.org>
Mon, 10 Nov 2008 09:23:06 +0000 (10:23 +0100)
Code for the new features is still missing.

select.ggo

index 5ea4e8e..d02fcd3 100644 (file)
@@ -83,11 +83,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" -