summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Eggert <eggert@cs.ucla.edu>2004-08-10 22:07:31 +0000
committerPaul Eggert <eggert@cs.ucla.edu>2004-08-10 22:07:31 +0000
commit4eafd1b11f51a337ef348c849ad32c8cb6cf9b70 (patch)
treeb200d578e571e6e13b560ae368a5ca3e1d058ed8
parent6e48f7ed86c4b3c5f2212976646f4a83c8c76d24 (diff)
downloadcoreutils-4eafd1b11f51a337ef348c849ad32c8cb6cf9b70.tar.xz
(Common options): Clarify that "-" means
stdin/stdout only when it is an operand, not when it is an option-argument. (shred invocation): "shred -- -" is equivalent to "shred -", not to "shred ./-". (tee invocation): "tee -" means to copy (again) to stdout.
-rw-r--r--doc/coreutils.texi59
1 files changed, 28 insertions, 31 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index ef9767cf3..c8bc74872 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -626,13 +626,13 @@ operands even if they begin with @samp{-}. For example, @samp{sort --
@cindex standard input
@cindex standard output
-A single @samp{-} is not really an option, though it looks like one. It
+A single @samp{-} operand is not really an option, though it looks like one. It
stands for standard input, or for standard output if that is clear from
-the context, and it can be used either as an operand or as an
-option-argument. For example, @samp{sort -o - -} outputs to standard
-output and reads from standard input, and is equivalent to plain
-@samp{sort}. Unless otherwise specified, @samp{-} can appear in any
-context that requires a file name.
+the context. For example, @samp{sort -} reads from standard input,
+and is equivalent to plain @samp{sort}, and @samp{tee -} writes an
+extra copy of its input to standard output. Unless otherwise
+specified, @samp{-} can appear as any operand that requires a file
+name.
@menu
* Exit status:: Indicating program success or failure.
@@ -7309,31 +7309,6 @@ it's tidier, the @option{--zero} option adds an additional overwrite pass with
all zero bits. This is in addition to the number of passes specified
by the @option{--iterations} option.
-@item -
-@opindex -
-Shred standard output.
-
-This argument is considered an option. If the common @samp{--} option has
-been used to indicate the end of options on the command line, then @samp{-}
-will be interpreted as an ordinary file name.
-
-The intended use of this is to shred a removed temporary file.
-For example
-
-@example
-i=`tempfile -m 0600`
-exec 3<>"$i"
-rm -- "$i"
-echo "Hello, world" >&3
-shred - >&3
-exec 3>-
-@end example
-
-Note that the shell command @samp{shred - >file} does not shred the
-contents of @var{file}, since it truncates @var{file} before invoking
-@command{shred}. Use the command @samp{shred file} or (if using a
-Bourne-compatible shell) the command @samp{shred - 1<>file} instead.
-
@end table
You might use the following command to erase all trace of the
@@ -7352,6 +7327,24 @@ your hard disk, you could give a command like this:
shred --verbose /dev/sda5
@end example
+A @var{file} of @samp{-} denotes standard output.
+The intended use of this is to shred a removed temporary file.
+For example:
+
+@example
+i=`tempfile -m 0600`
+exec 3<>"$i"
+rm -- "$i"
+echo "Hello, world" >&3
+shred - >&3
+exec 3>-
+@end example
+
+However, the command @samp{shred - >file} does not shred the contents
+of @var{file}, since the shell truncates @var{file} before invoking
+@command{shred}. Use the command @samp{shred file} or (if using a
+Bourne-compatible shell) the command @samp{shred - 1<>file} instead.
+
@exitstatus
@@ -9895,6 +9888,10 @@ If a file being written to does not already exist, it is created. If a
file being written to already exists, the data it previously contained
is overwritten unless the @option{-a} option is used.
+A @var{file} of @samp{-} causes @command{tee} to send another copy of
+input to standard output, but this is typically not that useful as the
+copies are interleaved.
+
The program accepts the following options. Also see @ref{Common options}.
@table @samp