$ipc_run_version = IPC::Cmd->can_use_ipc_run( [VERBOSE] )

$ipc_open3_version = IPC::Cmd->can_use_ipc_open3( [VERBOSE] )

$bool = IPC::Cmd->can_capture_buffer

$bool = IPC::Cmd->can_use_run_forked

$path = can_run( PROGRAM );

Unlike "which" and "type", this function is platform independent and will also work on, for example, Win32.

If called in a scalar context it will return the full path to the binary you asked for if it was found, or "undef" if it was not.

If called in a list context and the global variable $INSTANCES is a true value, it will return a list of the full paths to instances of the binary where found in "PATH", or an empty list if it was not found.

$ok | ($ok, $err, $full_buf, $stdout_buff, $stderr_buff) = run( command => COMMAND, [verbose => BOOL, buffer => \$SCALAR, timeout => DIGIT] );

command

This is the command to execute. It may be either a string or an array reference. This is a required argument.

See "Caveats" for remarks on how commands are parsed and their limitations.

verbose

This controls whether all output of a command should also be printed to STDOUT/STDERR or should only be trapped in buffers (NOTE: buffers require IPC::Run to be installed, or your system able to work with IPC::Open3).

It will default to the global setting of $IPC::Cmd::VERBOSE, which by default is 0.

buffer

This will hold all the output of a command. It needs to be a reference to a scalar. Note that this will hold both the STDOUT and STDERR messages, and you have no way of telling which is which. If you require this distinction, run the "run" command in list context and inspect the individual buffers.

Of course, this requires that the underlying call supports buffers. See the note on buffers above.

timeout

Sets the maximum time the command is allowed to run before aborting, using the built-in "alarm()" call. If the timeout is triggered, the "errorcode" in the return value will be set to an object of the "IPC::Cmd::TimeOut" class. See the "error message" section below for details.

Defaults to 0, meaning no timeout is set.

"run" will return a simple "true" or "false" when called in scalar context. In list context, you will be returned a list of the following items:

success

A simple boolean indicating if the command executed without errors or not.

error message

If the first element of the return value ("success") was 0, then some error occurred. This second element is the error message the command you requested exited with, if available. This is generally a pretty printed value of $? or $@. See "perldoc perlvar" for details on what they can contain. If the error was a timeout, the "error message" will be prefixed with the string "IPC::Cmd::TimeOut", the timeout class.

full_buffer

This is an array reference containing all the output the command generated. Note that buffers are only available if you have IPC::Run installed, or if your system is able to work with IPC::Open3 -- see below). Otherwise, this element will be "undef".

out_buffer

This is an array reference containing all the output sent to STDOUT the command generated. The notes from "full_buffer" apply.

error_buffer

This is an arrayreference containing all the output sent to STDERR the command generated. The notes from "full_buffer" apply.

See the "HOW IT WORKS" section below to see how "IPC::Cmd" decides what modules or function calls to use when issuing a command.

$hashref = run_forked( COMMAND, { child_stdin => SCALAR, timeout => DIGIT, stdout_handler => CODEREF, stderr_handler => CODEREF} );

The important and distinguishing feature of run_forked is execution timeout which at first seems to be quite a simple task but if you think that the program which you're spawning might spawn some children itself (which in their turn could do the same and so on) it turns out to be not a simple issue.

"run_forked" is designed to survive and successfully terminate almost any long running task, even a fork bomb in case your system has the resources to survive during given timeout.

This is achieved by creating separate watchdog process which spawns the specified program in a separate process session and supervises it: optionally feeds it with input, stores its exit code, stdout and stderr, terminates it in case it runs longer than specified.

Invocation requires the command to be executed or a coderef and optionally a hashref of options:

"timeout"

Specify in seconds how long to run the command before it is killed with SIG_KILL (9), which effectively terminates it and all of its children (direct or indirect).

"child_stdin"

Specify some text that will be passed into the "STDIN" of the executed program.

"stdout_handler"

Coderef of a subroutine to call when a portion of data is received on STDOUT from the executing program.

"stderr_handler"

Coderef of a subroutine to call when a portion of data is received on STDERR from the executing program.

"wait_loop_callback"

Coderef of a subroutine to call inside of the main waiting loop (while "run_forked" waits for the external to finish or fail). It is useful to stop running external process before it ends by itself, e.g.

  my $r = run_forked("some external command", {
          'wait_loop_callback' => sub {
          if (condition) {
              kill(1, $$);
          }
          },
          'terminate_on_signal' => 'HUP',
          });
    

Combined with "stdout_handler" and "stderr_handler" allows terminating external command based on its output. Could also be used as a timer without engaging with alarm (signals).

Remember that this code could be called every millisecond (depending on the output which external command generates), so try to make it as lightweight as possible.

"discard_output"

Discards the buffering of the standard output and standard errors for return by run_forked(). With this option you have to use the std*_handlers to read what the command outputs. Useful for commands that send a lot of output.

"terminate_on_parent_sudden_death"

Enable this option if you wish all spawned processes to be killed if the initially spawned process (the parent) is killed or dies without waiting for child processes.

"run_forked" will return a HASHREF with the following keys:

"exit_code"

The exit code of the executed program.

"timeout"

The number of seconds the program ran for before being terminated, or 0 if no timeout occurred.

"stdout"

Holds the standard output of the executed command (or empty string if there was no STDOUT output or if "discard_output" was used; it's always defined!)

"stderr"

Holds the standard error of the executed command (or empty string if there was no STDERR output or if "discard_output" was used; it's always defined!)

"merged"

Holds the standard output and error of the executed command merged into one stream (or empty string if there was no output at all or if "discard_output" was used; it's always defined!)

"err_msg"

Holds some explanation in the case of an error.

$q = QUOTE

You can use it as follows:

  use IPC::Cmd qw[run QUOTE];
  my $cmd = q[echo ] . QUOTE . q[foo bar] . QUOTE;

This makes sure that "foo bar" is treated as a string, rather than two separate arguments to the "echo" function.

$IPC::Cmd::VERBOSE

$IPC::Cmd::USE_IPC_RUN

$IPC::Cmd::USE_IPC_OPEN3

$IPC::Cmd::WARN

Defaults to true. Turn this off at your own risk.

$IPC::Cmd::INSTANCES

Defaults to false, set to true to enable the described behaviour.

$IPC::Cmd::ALLOW_NULL_ARGS

Defaults to false, so it will remove null arguments. Set to true to allow them.