changeset 98877:1d1a44972ed4

(Synchronous Processes): Document `process-lines'.
author Eli Zaretskii <eliz@gnu.org>
date Sun, 19 Oct 2008 12:27:24 +0000
parents ffb873d09bcd
children 3817189c2e80
files doc/lispref/processes.texi
diffstat 1 files changed, 16 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/lispref/processes.texi	Sun Oct 19 12:02:48 2008 +0000
+++ b/doc/lispref/processes.texi	Sun Oct 19 12:27:24 2008 +0000
@@ -65,7 +65,7 @@
 @node Subprocess Creation
 @section Functions that Create Subprocesses
 
-  There are three functions that create a new subprocess in which to run
+  There are three primitives that create a new subprocess in which to run
 a program.  One of them, @code{start-process}, creates an asynchronous
 process and returns a process object (@pxref{Asynchronous Processes}).
 The other two, @code{call-process} and @code{call-process-region},
@@ -449,6 +449,21 @@
 then returns the command's output as a string.
 @end defun
 
+@defun process-lines program &rest args
+This function runs @var{program} in a separate process, waits for it
+to finish, and returns its output as a list of strings.  Each string
+in the list holds a single line of text output by the program; the
+end-of-line characters are stripped from each line.  The arguments
+beyond @var{program}, @var{args}, are strings that specify
+command-line arguments with which to run the program.
+
+If @var{program} exits with a non-zero exit status, this function
+signals an error.
+
+This function works by calling @code{call-process}, so program output
+is decoded in the same way as for @code{call-process}.
+@end defun
+
 @node Asynchronous Processes
 @section Creating an Asynchronous Process
 @cindex asynchronous subprocess