summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.570
1 files changed, 57 insertions, 13 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 50bcae82f..a782d6f41 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -33,8 +33,8 @@
33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35.\" 35.\"
36.\" $OpenBSD: ssh_config.5,v 1.146 2010/12/08 04:02:47 djm Exp $ 36.\" $OpenBSD: ssh_config.5,v 1.153 2011/08/02 01:22:11 djm Exp $
37.Dd $Mdocdate: December 8 2010 $ 37.Dd $Mdocdate: August 2 2011 $
38.Dt SSH_CONFIG 5 38.Dt SSH_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -112,6 +112,15 @@ The host is the
112argument given on the command line (i.e. the name is not converted to 112argument given on the command line (i.e. the name is not converted to
113a canonicalized host name before matching). 113a canonicalized host name before matching).
114.Pp 114.Pp
115A pattern entry may be negated by prefixing it with an exclamation mark
116.Pq Sq !\& .
117If a negated entry is matched, then the
118.Cm Host
119entry is ignored, regardless of whether any other patterns on the line
120match.
121Negated matches are therefore useful to provide exceptions for wildcard
122matches.
123.Pp
115See 124See
116.Sx PATTERNS 125.Sx PATTERNS
117for more information on patterns. 126for more information on patterns.
@@ -305,14 +314,22 @@ section above or the string
305.Dq none 314.Dq none
306to disable connection sharing. 315to disable connection sharing.
307In the path, 316In the path,
317.Ql %L
318will be substituted by the first component of the local host name,
308.Ql %l 319.Ql %l
309will be substituted by the local host name, 320will be substituted by the local host name (including any domain name),
310.Ql %h 321.Ql %h
311will be substituted by the target host name, 322will be substituted by the target host name,
323.Ql %n
324will be substituted by the original target host name
325specified on the command line,
312.Ql %p 326.Ql %p
313the port, and 327the port,
314.Ql %r 328.Ql %r
315by the remote login username. 329by the remote login username, and
330.Ql %u
331by the username of the user running
332.Xr ssh 1 .
316It is recommended that any 333It is recommended that any
317.Cm ControlPath 334.Cm ControlPath
318used for opportunistic connection sharing include 335used for opportunistic connection sharing include
@@ -500,9 +517,11 @@ or
500The default is 517The default is
501.Dq no . 518.Dq no .
502.It Cm GlobalKnownHostsFile 519.It Cm GlobalKnownHostsFile
503Specifies a file to use for the global 520Specifies one or more files to use for the global
504host key database instead of 521host key database, separated by whitespace.
505.Pa /etc/ssh/ssh_known_hosts . 522The default is
523.Pa /etc/ssh/ssh_known_hosts ,
524.Pa /etc/ssh/ssh_known_hosts2 .
506.It Cm GSSAPIAuthentication 525.It Cm GSSAPIAuthentication
507Specifies whether user authentication based on GSSAPI is allowed. 526Specifies whether user authentication based on GSSAPI is allowed.
508The default is 527The default is
@@ -569,7 +588,7 @@ Specifies the real host name to log into.
569This can be used to specify nicknames or abbreviations for hosts. 588This can be used to specify nicknames or abbreviations for hosts.
570If the hostname contains the character sequence 589If the hostname contains the character sequence
571.Ql %h , 590.Ql %h ,
572then this will be replaced with the host name specified on the commandline 591then this will be replaced with the host name specified on the command line
573(this is useful for manipulating unqualified names). 592(this is useful for manipulating unqualified names).
574The default is the name given on the command line. 593The default is the name given on the command line.
575Numeric IP addresses are also permitted (both on the command line and in 594Numeric IP addresses are also permitted (both on the command line and in
@@ -629,6 +648,10 @@ escape characters:
629It is possible to have 648It is possible to have
630multiple identity files specified in configuration files; all these 649multiple identity files specified in configuration files; all these
631identities will be tried in sequence. 650identities will be tried in sequence.
651Multiple
652.Cm IdentityFile
653directives will add to the list of identities tried (this behaviour
654differs from that of other configuration directives).
632.It Cm IPQoS 655.It Cm IPQoS
633Specifies the IPv4 type-of-service or DSCP class for connections. 656Specifies the IPv4 type-of-service or DSCP class for connections.
634Accepted values are 657Accepted values are
@@ -770,7 +793,9 @@ Multiple algorithms must be comma-separated.
770The default is: 793The default is:
771.Bd -literal -offset indent 794.Bd -literal -offset indent
772hmac-md5,hmac-sha1,umac-64@openssh.com, 795hmac-md5,hmac-sha1,umac-64@openssh.com,
773hmac-ripemd160,hmac-sha1-96,hmac-md5-96 796hmac-ripemd160,hmac-sha1-96,hmac-md5-96,
797hmac-sha2-256,hmac-sha2-256-96,hmac-sha2-512,
798hmac-sha2-512-96
774.Ed 799.Ed
775.It Cm NoHostAuthenticationForLocalhost 800.It Cm NoHostAuthenticationForLocalhost
776This option can be used if the home directory is shared across machines. 801This option can be used if the home directory is shared across machines.
@@ -943,6 +968,23 @@ will only succeed if the server's
943.Cm GatewayPorts 968.Cm GatewayPorts
944option is enabled (see 969option is enabled (see
945.Xr sshd_config 5 ) . 970.Xr sshd_config 5 ) .
971.It Cm RequestTTY
972Specifies whether to request a pseudo-tty for the session.
973The argument may be one of:
974.Dq no
975(never request a TTY),
976.Dq yes
977(always request a TTY when standard input is a TTY),
978.Dq force
979(always request a TTY) or
980.Dq auto
981(request a TTY when opening a login session).
982This option mirrors the
983.Fl t
984and
985.Fl T
986flags for
987.Xr ssh 1 .
946.It Cm RhostsRSAAuthentication 988.It Cm RhostsRSAAuthentication
947Specifies whether to try rhosts based authentication with RSA host 989Specifies whether to try rhosts based authentication with RSA host
948authentication. 990authentication.
@@ -1137,9 +1179,11 @@ This can be useful when a different user name is used on different machines.
1137This saves the trouble of 1179This saves the trouble of
1138having to remember to give the user name on the command line. 1180having to remember to give the user name on the command line.
1139.It Cm UserKnownHostsFile 1181.It Cm UserKnownHostsFile
1140Specifies a file to use for the user 1182Specifies one or more files to use for the user
1141host key database instead of 1183host key database, separated by whitespace.
1142.Pa ~/.ssh/known_hosts . 1184The default is
1185.Pa ~/.ssh/known_hosts ,
1186.Pa ~/.ssh/known_hosts2 .
1143.It Cm VerifyHostKeyDNS 1187.It Cm VerifyHostKeyDNS
1144Specifies whether to verify the remote key using DNS and SSHFP resource 1188Specifies whether to verify the remote key using DNS and SSHFP resource
1145records. 1189records.