From: Pádraig Brady <P@draigBrady.com>
Date: Mon, 28 Nov 2022 22:39:19 +0000 (+0000)
Subject: doc: tee: make -p decription more complete
X-Git-Tag: v9.2~110
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=aaa306ad76d48b27efd75101d57b6ec5bf90362c;p=thirdparty%2Fcoreutils.git

doc: tee: make -p decription more complete

* doc/coreutils.texi (tee invocation): Give a more
cohesive description of the -p option, and how
it differs from the default operation.
---

diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index fca7f6961a..c801097ee1 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -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