1
0
mirror of git://git.sv.gnu.org/coreutils.git synced 2026-04-21 03:12:48 +02:00

doc: mention the restrictions for stdbuf more prominently

* doc/coreutils.texi (stdbuf invocation): List the contraints
on the command being controlled, up front.
This commit is contained in:
Bruno Haible
2011-06-30 18:02:36 +01:00
committed by Pádraig Brady
parent 10ec91d84a
commit 0c87ba4693

View File

@@ -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: