Merge pull request #9913 from marjune163/doc-improve
add missing section separator for config.ssh part
This commit is contained in:
commit
4efec92643
|
@ -155,18 +155,26 @@ is:
|
||||||
config.ssh.export_command_template = 'export %ENV_KEY%="%ENV_VALUE%"'
|
config.ssh.export_command_template = 'export %ENV_KEY%="%ENV_VALUE%"'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
`config.ssh.sudo_command` - The command to use when executing a command
|
`config.ssh.sudo_command` - The command to use when executing a command
|
||||||
with `sudo`. This defaults to `sudo -E -H %c`. The `%c` will be replaced by
|
with `sudo`. This defaults to `sudo -E -H %c`. The `%c` will be replaced by
|
||||||
the command that is being executed.
|
the command that is being executed.
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
`config.ssh.compression` - If `false`, this setting will not include the
|
`config.ssh.compression` - If `false`, this setting will not include the
|
||||||
compression setting when ssh'ing into a machine. If this is not set, it will
|
compression setting when ssh'ing into a machine. If this is not set, it will
|
||||||
default to `true` and `Compression=yes` will be enabled with ssh.
|
default to `true` and `Compression=yes` will be enabled with ssh.
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
`config.ssh.dsa_authentication` - If `false`, this setting will not include
|
`config.ssh.dsa_authentication` - If `false`, this setting will not include
|
||||||
`DSAAuthentication` when ssh'ing into a machine. If this is not set, it will
|
`DSAAuthentication` when ssh'ing into a machine. If this is not set, it will
|
||||||
default to `true` and `DSAAuthentication=yes` will be used with ssh.
|
default to `true` and `DSAAuthentication=yes` will be used with ssh.
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
`config.ssh.extra_args` - This settings value is passed directly into the
|
`config.ssh.extra_args` - This settings value is passed directly into the
|
||||||
ssh executable. This allows you to pass any arbitrary commands to do things such
|
ssh executable. This allows you to pass any arbitrary commands to do things such
|
||||||
as reverse tunneling down into the ssh program. These options can either be
|
as reverse tunneling down into the ssh program. These options can either be
|
||||||
|
|
Loading…
Reference in New Issue