Skip to contents

Search for SSH clients on the current system

Usage

find_rshcmd(which = NULL, first = FALSE, must_work = TRUE)

Arguments

which

A character vector specifying which types of SSH clients to search for, e.g. "ssh", "putty-plink", and "rstudio-ssh". It may also specify an HPC job-scheduler command, i.e. "srun", "qrsh", and "pjrsh", or "hpc", which infers which of these three to use from the job environment of the current R process. If NULL, a default set of clients supported by the current platform is searched for.

first

If TRUE, the first client found is returned, otherwise all located clients are returned.

must_work

If TRUE and no clients was found, then an error is produced, otherwise only a warning.

Value

A named list of pathnames to all located SSH clients. The pathnames may be followed by zero or more command-line options, i.e. the elements of the returned list are character vectors of length one or more. If first = TRUE, only the first one is returned. Attribute version contains the output from querying the executable for its version (via command-line option -V).