summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.567
1 files changed, 42 insertions, 25 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 411e9fd34..1b8b8da5d 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -34,8 +34,8 @@
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36.\" 36.\"
37.\" $OpenBSD: ssh_config.5,v 1.102 2007/08/15 12:13:41 stevesk Exp $ 37.\" $OpenBSD: ssh_config.5,v 1.111 2008/06/26 11:46:31 grunk Exp $
38.Dd $Mdocdate: August 15 2007 $ 38.Dd $Mdocdate: June 26 2008 $
39.Dt SSH_CONFIG 5 39.Dt SSH_CONFIG 5
40.Os 40.Os
41.Sh NAME 41.Sh NAME
@@ -119,6 +119,7 @@ Restricts the following declarations (up to the next
119.Cm Host 119.Cm Host
120keyword) to be only for those hosts that match one of the patterns 120keyword) to be only for those hosts that match one of the patterns
121given after the keyword. 121given after the keyword.
122If more than one pattern is provided, they should be separated by whitepsace.
122A single 123A single
123.Ql * 124.Ql *
124as a pattern can be used to provide global 125as a pattern can be used to provide global
@@ -145,9 +146,7 @@ If set to
145passphrase/password querying will be disabled. 146passphrase/password querying will be disabled.
146In addition, the 147In addition, the
147.Cm ServerAliveInterval 148.Cm ServerAliveInterval
148and 149option will be set to 300 seconds by default.
149.Cm SetupTimeOut
150options will both be set to 300 seconds by default.
151This option is useful in scripts and other batch jobs where no user 150This option is useful in scripts and other batch jobs where no user
152is present to supply the password, 151is present to supply the password,
153and where it is desirable to detect a broken network swiftly. 152and where it is desirable to detect a broken network swiftly.
@@ -619,6 +618,14 @@ escape characters:
619It is possible to have 618It is possible to have
620multiple identity files specified in configuration files; all these 619multiple identity files specified in configuration files; all these
621identities will be tried in sequence. 620identities will be tried in sequence.
621.It Cm KbdInteractiveAuthentication
622Specifies whether to use keyboard-interactive authentication.
623The argument to this keyword must be
624.Dq yes
625or
626.Dq no .
627The default is
628.Dq yes .
622.It Cm KbdInteractiveDevices 629.It Cm KbdInteractiveDevices
623Specifies the list of methods to use in keyboard-interactive authentication. 630Specifies the list of methods to use in keyboard-interactive authentication.
624Multiple method names must be comma-separated. 631Multiple method names must be comma-separated.
@@ -634,7 +641,22 @@ and
634Specifies a command to execute on the local machine after successfully 641Specifies a command to execute on the local machine after successfully
635connecting to the server. 642connecting to the server.
636The command string extends to the end of the line, and is executed with 643The command string extends to the end of the line, and is executed with
637.Pa /bin/sh . 644the user's shell.
645The following escape character substitutions will be performed:
646.Ql %d
647(local user's home directory),
648.Ql %h
649(remote host name),
650.Ql %l
651(local host name),
652.Ql %n
653(host name as provided on the command line),
654.Ql %p
655(remote port),
656.Ql %r
657(remote user name) or
658.Ql %u
659(local user name).
638This directive is ignored unless 660This directive is ignored unless
639.Cm PermitLocalCommand 661.Cm PermitLocalCommand
640has been enabled. 662has been enabled.
@@ -758,7 +780,7 @@ if version 2 is not available.
758Specifies the command to use to connect to the server. 780Specifies the command to use to connect to the server.
759The command 781The command
760string extends to the end of the line, and is executed with 782string extends to the end of the line, and is executed with
761.Pa /bin/sh . 783the user's shell.
762In the command string, 784In the command string,
763.Ql %h 785.Ql %h
764will be substituted by the host name to 786will be substituted by the host name to
@@ -936,24 +958,9 @@ or 300 if the
936option is set. 958option is set.
937This option applies to protocol version 2 only. 959This option applies to protocol version 2 only.
938.Cm ProtocolKeepAlives 960.Cm ProtocolKeepAlives
939is a Debian-specific compatibility alias for this option. 961and
940.It Cm SetupTimeOut 962.Cm SetupTimeOut
941Normally, 963are Debian-specific compatibility aliases for this option.
942.Nm ssh
943blocks indefinitely whilst waiting to receive the ssh banner and other
944setup protocol from the server, during the session setup.
945This can cause
946.Nm ssh
947to hang under certain circumstances.
948If this option is set,
949.Nm ssh
950will give up if no data from the server is received for the specified
951number of seconds.
952The argument must be an integer.
953The default is 0 (disabled), or 300 if
954.Cm BatchMode
955is set.
956This is a Debian-specific option.
957.It Cm SmartcardDevice 964.It Cm SmartcardDevice
958Specifies which smartcard device to use. 965Specifies which smartcard device to use.
959The argument to this keyword is the device 966The argument to this keyword is the device
@@ -1127,6 +1134,16 @@ See also
1127.Sx VERIFYING HOST KEYS 1134.Sx VERIFYING HOST KEYS
1128in 1135in
1129.Xr ssh 1 . 1136.Xr ssh 1 .
1137.It Cm VisualHostKey
1138If this flag is set to
1139.Dq yes ,
1140an ASCII art representation of the remote host key fingerprint is
1141printed additionally to the hex fingerprint string.
1142If this flag is set to
1143.Dq no ,
1144only the hex fingerprint string will be printed.
1145The default is
1146.Dq no .
1130.It Cm XAuthLocation 1147.It Cm XAuthLocation
1131Specifies the full pathname of the 1148Specifies the full pathname of the
1132.Xr xauth 1 1149.Xr xauth 1