simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 11:15:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc(Unix): add example from call_full

Browse source
This commit is contained in:
Fardale 2022-09-21 11:22:02 +02:00
parent 47ff9935dc
commit 46fbc3b82f
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/unix/CCUnix.mli
View file

@ -29,11 +29,17 @@ val call_full :
'a 'a
(** [call_full cmd] wraps the result of [Unix.open_process_full cmd] into an (** [call_full cmd] wraps the result of [Unix.open_process_full cmd] into an
object. It reads the full stdout and stderr of the subprocess before object. It reads the full stdout and stderr of the subprocess before
returning. returning. [cmd] can be a format string as in {!Printf}.
@param stdin if provided, the generator or string is consumed and fed to @param stdin if provided, the generator or string is consumed and fed to
the subprocess input channel, which is then closed. the subprocess input channel, which is then closed.
@param bufsize buffer size used to read stdout and stderr. @param bufsize buffer size used to read stdout and stderr.
@param env environment to run the command in. @param env environment to run the command in.
Example:
{[
# CCUnix.call_full "ls %s" (CCUnix.escape_str "/");;
]}
*) *)
val call : val call :
@ -42,7 +48,7 @@ val call :
?env:string array -> ?env:string array ->
('a, Buffer.t, unit, string * string * int) format4 -> ('a, Buffer.t, unit, string * string * int) format4 ->
'a 'a
(** [call cmd] is similar to [call_full cmd] but returns (** [call cmd] is similar to {!call_full} but returns
a tuple [stdout, stderr, errcode] instead of an object. *) a tuple [stdout, stderr, errcode] instead of an object. *)
val call_stdout : val call_stdout :