doc: detail the effect of disabling input buffering with stdbuf
authorPádraig Brady <P@draigBrady.com>
Fri, 1 Jul 2011 08:42:17 +0000 (09:42 +0100)
committerPádraig Brady <P@draigBrady.com>
Fri, 1 Jul 2011 21:47:54 +0000 (22:47 +0100)
* docs/coreutils.texi (stdbuf invocation): Expand on the different
reasons for disabling buffering on input and output.

doc/coreutils.texi

index 4b0917d..c59af2f 100644 (file)
@@ -15448,8 +15448,13 @@ This option is invalid with standard input.
 
 @item 0
 Disable buffering of the selected stream.
-In this mode data is output immediately and only the
+In this mode, data is output immediately and only the
 amount of data requested is read from input.
+Note the difference in function for input and output.
+Disabling buffering for input will not influence the responsiveness
+or blocking behavior of the stream input functions.
+For example @code{fread} will still block until @code{EOF} or error,
+even if the underlying @code{read} returns less data than requested.
 
 @item @var{size}
 Specify the size of the buffer to use in fully buffered mode.