]> git.ipfire.org Git - thirdparty/coreutils.git/commitdiff
doc: tee: make -p decription more complete
authorPádraig Brady <P@draigBrady.com>
Mon, 28 Nov 2022 22:39:19 +0000 (22:39 +0000)
committerPádraig Brady <P@draigBrady.com>
Tue, 29 Nov 2022 14:52:52 +0000 (14:52 +0000)
* doc/coreutils.texi (tee invocation): Give a more
cohesive description of the -p option, and how
it differs from the default operation.

doc/coreutils.texi

index fca7f6961aff25e2e0237a8409feeab6a3a36897..c801097ee118ccb47c4bdc905e176cfcb4adf297 100644 (file)
@@ -14079,8 +14079,14 @@ Ignore interrupt signals.
 @itemx --output-error[=@var{mode}]
 @opindex -p
 @opindex --output-error
-Adjust the behavior with errors on the outputs,
-with the long form option supporting selection
+Adjust the behavior with errors on the outputs.
+In summary @option{-p} allows @command{tee} to operate in a more
+standard manner with pipes, and to continue to process data
+to any remaining outputs, if any pipe outputs exit early.
+The default operation when @option{--output-error} is @emph{not}
+specified is to exit immediately on error writing to a pipe,
+and diagnose errors writing to a non-pipe.
+The long form @option{--output-error} option supports selection
 between the following @var{mode}s:
 
 @table @samp