summaryrefslogtreecommitdiffstats
path: root/lineio.txi
diff options
context:
space:
mode:
Diffstat (limited to 'lineio.txi')
-rw-r--r--lineio.txi5
1 files changed, 5 insertions, 0 deletions
diff --git a/lineio.txi b/lineio.txi
index 52d17b8..9fbe92f 100644
--- a/lineio.txi
+++ b/lineio.txi
@@ -46,5 +46,10 @@ which case it defaults to the value returned by
a temporary file. @code{system->line} calls @code{system} with @var{command} as argument,
redirecting stdout to file @var{tmp}. @code{system->line} returns a string containing the
first line of output from @var{tmp}.
+
+@code{system->line} is intended to be a portable method for getting one-line results
+from programs like @code{pwd}, @code{whoami}, @code{hostname},
+@code{which}, @code{identify}, and @code{cksum}. Its behavior when
+called with programs which generate lots of output is unspecified.
@end defun