Arguments

-A

Download files listed in label export paths to the local _archive directory in the format ‘hostname:basename(filename)’. Absolute paths are permitted, or paths relative to the staging directory.

-E environment

Set one or more environment variables using the format ‘name="value" ...’.

-F sshconfig_file

Specify a config file for ssh(1) to use.

-f routes_file

Specify a routes_file. This file is composed of labels which correspond to hostnames or IP addresses which are matched against hostname. The default is routes.pln.

-o log_directory

Log directory to use for background workers. Each log file is created for each worker using the format ‘YYYY-MM-DD_HHMMSS.n’.

-n

Do not connect to remote hosts. May be combined with -x to highlight label names that match. Special text defined between { and } is still executed locally.

-p workers

Parallel execution distributed across the specified number of workers. The log directory must also be specified using -o. A summary of results is displayed using the rexec-summary script located in the search path.

-R

Send files listed in label export paths from the local _archive directory. This is the reverse of -A.

-t

Allow TTY input by copying the content of each label to the remote host instead of opening a pipe to the interpreter.

-x label_pattern

Execute labels matching the specified regex. By default only labels beginning with [0-9a-z] are evaluated.

Commands

shell-env

Print environment used by parallel execution. Provides a configuration template for custom status messages.

Status Format

Status messages for each stage of execution may be customized by setting RSET_HOST_CONNECT, RSET_HOST_CONNECT_ERROR, RSET_LABEL_EXEC_BEGIN, RSET_LABEL_EXEC_END, RSET_LABEL_EXEC_ERROR, and RSET_HOST_DISCONNECT.

Setting RSET_HOST_CONNECT disables the default status messages and is the only required variable. These have no effect in conjunction with the -n flag. The following variables are interpolated:

%e

exit code

%l

label name

%h

hostname

%s

session identifier

%T

rfc-3339 timestamp

%%

literal ‘%’

Diagnostics

HTTP_TRACE

If defined, print log messages from miniquark(1).

SSH_TRACE

If defined, print commands used for remote execution.

Remote Execution

The following environment variables are set on the remote host:

INSTALL_URL

Used by rinstall(1) for fetching content from _sources.

SD

Staging directory where rset unpacks utilities and configuration files.

State may set for the duration of the ssh session using renv(1) using ‘name=value’ as the first argument.