summaryrefslogtreecommitdiffstats
path: root/lineio.scm
diff options
context:
space:
mode:
Diffstat (limited to 'lineio.scm')
-rw-r--r--lineio.scm5
1 files changed, 5 insertions, 0 deletions
diff --git a/lineio.scm b/lineio.scm
index 9b5d641..2b18cf2 100644
--- a/lineio.scm
+++ b/lineio.scm
@@ -75,6 +75,11 @@
;;a temporary file. @0 calls @code{system} with @1 as argument,
;;redirecting stdout to file @2. @0 returns a string containing the
;;first line of output from @2.
+;;
+;;@0 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.
(define (system->line command . tmp)
(require 'filename)
(cond ((null? tmp)