package shell

You can search for identifiers within the package.

in-package search v0.2.0

package shell

shell
- Shell
  - Process
shell.filename_extended
- Filename_extended
shell.low_level_process
- Low_level_process
  - Command_result
  - Status
shell.shell_internal
- Shell_internal
shell.string_extended
- String_extended
shell.unix_extended
- Unix_extended
  - Extended_passwd
  - Inet_port
    
    Map
    
    Diff
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Diff
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Stable
    
    V1
    
    Map
    
    Diff
    
    Set
    
    Diff
  - Mount_entry
  - Quota

Legend:
Library
Module
Module type
Parameter
Class
Class type

Low-level process handling

This is low-level enough that you should probably be using Shell instead to dispatch processes.

module Status : sig ... end

module Command_result : sig ... end

val kill : 
  ?is_child:bool ->
  ?wait_for:Core.Time_float.Span.t ->
  ?signal:Core.Signal.t ->
  Core.Pid.t ->
  unit

kills a process by sending signal; waiting for wait_for and then sending a sigkill. You need to set is_child to true when killing child processes or run waitpid on them in another.

raises Failure
if the target program hangs for more that wait_for after receiving the sigkill.
caveat: is_child:false (the default) is racy: it can both send signals to wrong processes and it can also fail to notice that the target died.

val run : 
  ?timeout:Core.Time_float.Span.t ->
  ?use_extra_path:bool ->
  ?working_dir:string ->
  ?setuid:int ->
  ?setgid:int ->
  ?env:
    [ `Extend of (string * string) list | `Replace of (string * string) list ] ->
  ?input:string ->
  ?keep_open:bool ->
  ?stdoutf:(Core.Bytes.t -> int -> unit) ->
  ?stderrf:(Core.Bytes.t -> int -> unit) ->
  ?tail_len:int ->
  prog:string ->
  args:string list ->
  unit ->
  Command_result.t

Runs the process.

stdoutf s len and stderrf s len should only inspect the String.subo s ~len component of s.