summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.548
1 files changed, 45 insertions, 3 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 5c94ffc9c..889def626 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -127,8 +127,15 @@ Valid arguments are
127If set to 127If set to
128.Dq yes , 128.Dq yes ,
129passphrase/password querying will be disabled. 129passphrase/password querying will be disabled.
130In addition, the
131.Cm ServerAliveInterval
132and
133.Cm SetupTimeOut
134options will both be set to 300 seconds by default.
130This option is useful in scripts and other batch jobs where no user 135This option is useful in scripts and other batch jobs where no user
131is present to supply the password. 136is present to supply the password,
137and where it is desirable to detect a
138broken network swiftly.
132The argument must be 139The argument must be
133.Dq yes 140.Dq yes
134or 141or
@@ -435,7 +442,8 @@ token used for the session will be set to expire after 20 minutes.
435Remote clients will be refused access after this time. 442Remote clients will be refused access after this time.
436.Pp 443.Pp
437The default is 444The default is
438.Dq no . 445.Dq yes
446(Debian-specific).
439.Pp 447.Pp
440See the X11 SECURITY extension specification for full details on 448See the X11 SECURITY extension specification for full details on
441the restrictions imposed on untrusted clients. 449the restrictions imposed on untrusted clients.
@@ -838,6 +846,10 @@ If, for example,
838.Cm ServerAliveCountMax 846.Cm ServerAliveCountMax
839is left at the default, if the server becomes unresponsive ssh 847is left at the default, if the server becomes unresponsive ssh
840will disconnect after approximately 45 seconds. 848will disconnect after approximately 45 seconds.
849This option works when using protocol version 2 only; in protocol version
8501 there is no mechanism to request a response from the server to the
851server alive messages, so disconnection is the responsibility of the TCP
852stack.
841.It Cm ServerAliveInterval 853.It Cm ServerAliveInterval
842Sets a timeout interval in seconds after which if no data has been received 854Sets a timeout interval in seconds after which if no data has been received
843from the server, 855from the server,
@@ -845,8 +857,30 @@ from the server,
845will send a message through the encrypted 857will send a message through the encrypted
846channel to request a response from the server. 858channel to request a response from the server.
847The default 859The default
848is 0, indicating that these messages will not be sent to the server. 860is 0, indicating that these messages will not be sent to the server,
861or 300 if the
862.Cm BatchMode
863option is set.
849This option applies to protocol version 2 only. 864This option applies to protocol version 2 only.
865.Cm ProtocolKeepAlives
866is a Debian-specific compatibility alias for this option.
867.It Cm SetupTimeOut
868Normally,
869.Nm ssh
870blocks indefinitely whilst waiting to receive the ssh banner and other
871setup protocol from the server, during the session setup.
872This can cause
873.Nm ssh
874to hang under certain circumstances.
875If this option is set,
876.Nm ssh
877will give up if no data from the server is received for the specified
878number of seconds.
879The argument must be an integer.
880The default is 0 (disabled), or 300 if
881.Cm BatchMode
882is set.
883This is a Debian-specific option.
850.It Cm SmartcardDevice 884.It Cm SmartcardDevice
851Specifies which smartcard device to use. 885Specifies which smartcard device to use.
852The argument to this keyword is the device 886The argument to this keyword is the device
@@ -894,6 +928,12 @@ Specifies whether the system should send TCP keepalive messages to the
894other side. 928other side.
895If they are sent, death of the connection or crash of one 929If they are sent, death of the connection or crash of one
896of the machines will be properly noticed. 930of the machines will be properly noticed.
931This option only uses TCP keepalives (as opposed to using ssh level
932keepalives), so takes a long time to notice when the connection dies.
933As such, you probably want
934the
935.Cm ServerAliveInterval
936option as well.
897However, this means that 937However, this means that
898connections will die if the route is down temporarily, and some people 938connections will die if the route is down temporarily, and some people
899find it annoying. 939find it annoying.
@@ -991,6 +1031,8 @@ This file is used by the
991client. 1031client.
992Because of the potential for abuse, this file must have strict permissions: 1032Because of the potential for abuse, this file must have strict permissions:
993read/write for the user, and not accessible by others. 1033read/write for the user, and not accessible by others.
1034It may be group-writable provided that the group in question contains only
1035the user.
994.It Pa /etc/ssh/ssh_config 1036.It Pa /etc/ssh/ssh_config
995Systemwide configuration file. 1037Systemwide configuration file.
996This file provides defaults for those 1038This file provides defaults for those