summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2011-06-30 18:02:36 +0100
committerPádraig Brady <P@draigBrady.com>2011-07-01 22:44:19 +0100
commit0c87ba4693e871b7d668056674f160001f73b460 (patch)
tree45f3a8f12f01892a10da09212d55693a8bb0c646
parent10ec91d84a53b3acae630864c2e82f2a74fa9c38 (diff)
downloadcoreutils-0c87ba4693e871b7d668056674f160001f73b460.tar.xz
doc: mention the restrictions for stdbuf more prominently
* doc/coreutils.texi (stdbuf invocation): List the contraints on the command being controlled, up front.
-rw-r--r--doc/coreutils.texi17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index f74dd1c34..4b0917d3f 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -15398,6 +15398,17 @@ three standard I/O streams associated with a program. Synopsis:
stdbuf @var{option}@dots{} @var{command}
@end example
+@var{command} must start with the name of a program that
+@enumerate
+@item
+uses the ISO C @code{FILE} streams for input/output (note the
+programs @command{dd} and @command{cat} don't do that),
+
+@item
+does not adjust the buffering of its standard streams (note the
+program @command{tee} is not in this category).
+@end enumerate
+
Any additional @var{arg}s are passed as additional arguments to the
@var{command}.
@@ -15446,12 +15457,6 @@ Specify the size of the buffer to use in fully buffered mode.
@end table
-NOTE: If @var{command} adjusts the buffering of its standard streams
-(@command{tee} does for e.g.) then that will override corresponding settings
-changed by @command{stdbuf}. Also some filters (like @command{dd} and
-@command{cat} etc.) don't use streams for I/O, and are thus unaffected
-by @command{stdbuf} settings.
-
@cindex exit status of @command{stdbuf}
Exit status: