From 0c87ba4693e871b7d668056674f160001f73b460 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Thu, 30 Jun 2011 18:02:36 +0100 Subject: doc: mention the restrictions for stdbuf more prominently * doc/coreutils.texi (stdbuf invocation): List the contraints on the command being controlled, up front. --- doc/coreutils.texi | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'doc') 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: -- cgit v1.2.3-70-g09d2