From 55522ff6077072d41b5da7bb3cea17b85f8176f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Kochma=C5=84ski?= Date: Fri, 24 Mar 2017 00:43:08 +0100 Subject: [PATCH] newdoc: osi: improve documentation --- src/doc/new-doc/extensions/osi.txi | 54 +++++++++++++++++++----------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/src/doc/new-doc/extensions/osi.txi b/src/doc/new-doc/extensions/osi.txi index a2ee473d3..f0848a864 100644 --- a/src/doc/new-doc/extensions/osi.txi +++ b/src/doc/new-doc/extensions/osi.txi @@ -18,6 +18,21 @@ External process is a structure created with garbage collection object will be finalized. @defun ext:external-process-pid process +Process PID. +@end defun + +@defun ext:external-process-status process +Updates process status. Returns two values: + +@code{status} - member of @code{(:abort :error :exited :signalled +:stopped :resumed :running)} + +@code{code} - if process exited it is a returned value, if terminated +it is a signal code. Otherwise NIL. +@end defun + +@defun ext:terminate-process process &optional force +Terminates external process. @end defun @defun ext:external-process-input process @@ -26,12 +41,6 @@ garbage collection object will be finalized. Process stream accessors (read-only). @end defun -@defun ext:external-process-input process -@end defun - -@node Operating System Interface Reference -@subsection Operating System Interface Reference - @lspindex ext:run-program @defun ext:run-program command argv @ &key input output error wait environ @ @@ -124,6 +133,9 @@ Controls escaping of the arguments passed to CreateProcess. @end defvr @end defun +@node Operating System Interface Reference +@subsection Operating System Interface Reference + @c environment routines @defun ext:command-args @@ -139,26 +151,28 @@ the ECL program itself. @c @defun ext:argv @c @end defun -@defun ext:quit &optional code kill-all-threads -@end defun - -@defun ext:getenv variable -@end defun - -@defun ext:setenv variable value -@end defun - -@defun ext:environ -@end defun - -@c UNIX shell interface - @defun ext:system command +Run shell command ignoring its output. Uses fork. @end defun @defun ext:make-pipe +Creates a pipe and wraps it in a two way stream. @end defun + +@defun ext:quit &optional code kill-all-threads +Routine used to exit ECL in graceful manner. +@end defun + +@defun ext:environ +@defunx ext:getenv variable +@defunx ext:setenv variable value +Environment accessors. +@end defun + + +@c UNIX shell interface + @defun ext:getpid @defunx ext:getuid @defunx ext:getcwd