Next: Defining a shell, Up: Remote programming customization

##### 16.5.19.1 Defining a remote connection tool

Several remote access tools are already defined in GPS: ssh, rsh, telnet and plink. It is possible to add other tools, using the node `remote_connection_config`.

The attributes for this node are:

`name (string) (mandatory)`
  The name of the tool. This name does not necessarilly correspond to the command used to launch the tool.

The following children are defined:

`start_command (mandatory)`
  The command used to launch the tool. This tag supports the `use_pipes` attribute. This attribute selects on Windows the way GPS will launch the remote tools, and can take the following values:
  `true`
    use pipes to launch the tool.
  `false (default)`
    use a tty emulation, which is a bit slower but allow password prompts retrieval with some tools.
  Note that this argument has effects only on Windows platforms.
`start_command_common_args (optional)`
  The arguments that are provided to the tool. This string can contain the following replacement macros:
  `%C`
    is replaced by the command executed on the remote host (e.g. the shell command)
  `%h`
    is replaced by the remote host name
  `%U`
    is replaced by the start_command_user_args, if a user is specified
  `%u`
    is replaced by the user name

  Note that if neither %u nor %U is found, and a user is specified in the remote connection configuration, then the start_command_user_args is placed at the beginning of the arguments.

`start_command_user_args (optional)`
  The arguments used to define a specific user during connection. %u is replaced by the user name
`send_interrupt (optional)`
  The characters sequence to send to the remote tool to interrupt the remote application. If unset, then an Interrupt signal is sent directly to the remote tool.
`user_prompt_ptrn (optional)`
  A regular expression, used to catch user name prompts from the connection tool. If undefined, a default regular expression is used.
`password_prompt_ptrn (optional)`
  A regular expression, used to catch password prompts from the connection tool. If undefined, a default regular expression is used.
`passphrase_prompt_ptrn (optional)`
  A regular expression, used to catch passphrase prompts from the connection tool. If undefined, a default regular expression is used.
`extra_ptrn (optional)`
  Complex child. Used to catch extra prompts from the connection tool, other than password, passphrase or usename prompts. This tag has an attribute `auto_answer` telling if GPS automatically answers to this prompt, or ask the user. If auto_answer is `true`, then this tag needs an `answer` child, whose value is used for the answer. If auto_answer is `false`, then this tag needs a `question` child, whose value is used as question to the end user.