Skip to content

Commit

Permalink
Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nojb committed Dec 20, 2020
1 parent 228a0c2 commit f77966f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
24 changes: 12 additions & 12 deletions otherlibs/unix/unix.mli
Original file line number Diff line number Diff line change
Expand Up @@ -876,40 +876,40 @@ val open_process_full :

val open_process_args_in : string -> string array -> in_channel
(** High-level pipe and process management. The first argument specifies the
command to run, and the second argument specifies the argument array passed
to the command. This function runs the command in parallel with the program.
The standard output of the command is redirected to a pipe, which can be read
program to run, and the second argument specifies the argument array passed
to it. This function runs the program in parallel with the calling process.
The standard output of the program is redirected to a pipe, which can be read
via the returned input channel.
The program is looked up in the [PATH] (this behaviour changed in 4.12;
previously the program was interpreted relative to the current directory).
previously the program was looked up only in the current directory).
@since 4.08.0 *)

val open_process_args_out : string -> string array -> out_channel
(** Same as {!open_process_args_in}, but redirect the standard input of the
command to a pipe. Data written to the returned output channel is sent to
the standard input of the command. Warning: writes on output channels are
program to a pipe. Data written to the returned output channel is sent to
the standard input of the program. Warning: writes on output channels are
buffered, hence be careful to call {!Stdlib.flush} at the right times to
ensure correct synchronization.
@since 4.08.0 *)

val open_process_args : string -> string array -> in_channel * out_channel
(** Same as {!open_process_args_out}, but redirects both the standard input
and standard output of the command to pipes connected to the two returned
channels. The input channel is connected to the output of the command, and
the output channel to the input of the command.
(** Same as {!open_process_args_out}, but redirects both the standard input and
standard output of the program to pipes connected to the two returned
channels. The input channel is connected to the output of the program, and
the output channel to the input of the program.
@since 4.08.0 *)

val open_process_args_full :
string -> string array -> string array ->
in_channel * out_channel * in_channel
(** Similar to {!open_process_args}, but the third argument specifies the
environment passed to the command. The result is a triple of channels
environment passed to the program. The result is a triple of channels
connected respectively to the standard output, standard input, and standard
error of the command.
error of the program.
@since 4.08.0 *)

Expand Down
24 changes: 12 additions & 12 deletions otherlibs/unix/unixLabels.mli
Original file line number Diff line number Diff line change
Expand Up @@ -876,40 +876,40 @@ val open_process_full :

val open_process_args_in : string -> string array -> in_channel
(** High-level pipe and process management. The first argument specifies the
command to run, and the second argument specifies the argument array passed
to the command. This function runs the command in parallel with the program.
The standard output of the command is redirected to a pipe, which can be read
program to run, and the second argument specifies the argument array passed
to it. This function runs the program in parallel with the calling process.
The standard output of the program is redirected to a pipe, which can be read
via the returned input channel.
The program is looked up in the [PATH] (this behaviour changed in 4.12;
previously the program was interpreted relative to the current directory).
previously the program was looked up only in the current directory).
@since 4.08.0 *)

val open_process_args_out : string -> string array -> out_channel
(** Same as {!open_process_args_in}, but redirect the standard input of the
command to a pipe. Data written to the returned output channel is sent to
the standard input of the command. Warning: writes on output channels are
program to a pipe. Data written to the returned output channel is sent to
the standard input of the program. Warning: writes on output channels are
buffered, hence be careful to call {!Stdlib.flush} at the right times to
ensure correct synchronization.
@since 4.08.0 *)

val open_process_args : string -> string array -> in_channel * out_channel
(** Same as {!open_process_args_out}, but redirects both the standard input
and standard output of the command to pipes connected to the two returned
channels. The input channel is connected to the output of the command, and
the output channel to the input of the command.
(** Same as {!open_process_args_out}, but redirects both the standard input and
standard output of the program to pipes connected to the two returned
channels. The input channel is connected to the output of the program, and
the output channel to the input of the program.
@since 4.08.0 *)

val open_process_args_full :
string -> string array -> string array ->
in_channel * out_channel * in_channel
(** Similar to {!open_process_args}, but the third argument specifies the
environment passed to the command. The result is a triple of channels
environment passed to the program. The result is a triple of channels
connected respectively to the standard output, standard input, and standard
error of the command.
error of the program.
@since 4.08.0 *)

Expand Down

0 comments on commit f77966f

Please sign in to comment.