aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorEli Zaretskii2018-10-30 13:08:28 +0200
committerEli Zaretskii2018-10-30 13:08:28 +0200
commitced58d3e15ae4c085b8246bbf0ef9f1a9b39c456 (patch)
treeec80a85eabdda4a5ce534c8468d3174741824a82 /src
parent38f88a7f00c654a1710b1156150e93e298a0e217 (diff)
downloademacs-ced58d3e15ae4c085b8246bbf0ef9f1a9b39c456.tar.gz
emacs-ced58d3e15ae4c085b8246bbf0ef9f1a9b39c456.zip
Improve doc string of 'call-process'
* src/callproc.c (Fcall_process): Clarify DESTINATION in the doc string.
Diffstat (limited to 'src')
-rw-r--r--src/callproc.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/src/callproc.c b/src/callproc.c
index 973f324139c..8f1da2fd7a5 100644
--- a/src/callproc.c
+++ b/src/callproc.c
@@ -221,15 +221,20 @@ DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
221 doc: /* Call PROGRAM synchronously in separate process. 221 doc: /* Call PROGRAM synchronously in separate process.
222The remaining arguments are optional. 222The remaining arguments are optional.
223The program's input comes from file INFILE (nil means `/dev/null'). 223The program's input comes from file INFILE (nil means `/dev/null').
224Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION 224
225 means discard it; 0 means discard and don't wait; and `(:file FILE)', where 225Third argument DESTINATION specifies how to handle program's output.
226 FILE is a file name string, means that it should be written to that file 226If DESTINATION is a buffer, or t that stands for the current buffer,
227 (if the file already exists it is overwritten). 227 it means insert output in that buffer before point.
228If DESTINATION is nil, it means discard output; 0 means discard
229 and don't wait for the program to terminate.
230If DESTINATION is `(:file FILE)', where FILE is a file name string,
231 it means that output should be written to that file (if the file
232 already exists it is overwritten).
228DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case, 233DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
229REAL-BUFFER says what to do with standard output, as above, 234 REAL-BUFFER says what to do with standard output, as above,
230while STDERR-FILE says what to do with standard error in the child. 235 while STDERR-FILE says what to do with standard error in the child.
231STDERR-FILE may be nil (discard standard error output), 236 STDERR-FILE may be nil (discard standard error output),
232t (mix it with ordinary output), or a file name string. 237 t (mix it with ordinary output), or a file name string.
233 238
234Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. 239Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
235Remaining arguments are strings passed as command arguments to PROGRAM. 240Remaining arguments are strings passed as command arguments to PROGRAM.