diff options
Diffstat (limited to 'ssh_config.5')
-rw-r--r-- | ssh_config.5 | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/ssh_config.5 b/ssh_config.5 index 7a435a90e..2ca7ce02f 100644 --- a/ssh_config.5 +++ b/ssh_config.5 | |||
@@ -127,8 +127,15 @@ Valid arguments are | |||
127 | If set to | 127 | If set to |
128 | .Dq yes , | 128 | .Dq yes , |
129 | passphrase/password querying will be disabled. | 129 | passphrase/password querying will be disabled. |
130 | In addition, the | ||
131 | .Cm ProtocolKeepAlives | ||
132 | and | ||
133 | .Cm SetupTimeOut | ||
134 | options will both be set to 300 seconds by default. | ||
130 | This option is useful in scripts and other batch jobs where no user | 135 | This option is useful in scripts and other batch jobs where no user |
131 | is present to supply the password. | 136 | is present to supply the password, |
137 | and where it is desirable to detect a | ||
138 | broken network swiftly. | ||
132 | The argument must be | 139 | The argument must be |
133 | .Dq yes | 140 | .Dq yes |
134 | or | 141 | or |
@@ -395,6 +402,12 @@ Specifies whether the system should send TCP keepalive messages to the | |||
395 | other side. | 402 | other side. |
396 | If they are sent, death of the connection or crash of one | 403 | If they are sent, death of the connection or crash of one |
397 | of the machines will be properly noticed. | 404 | of the machines will be properly noticed. |
405 | This option only uses TCP keepalives (as opposed to using ssh level | ||
406 | keepalives), so takes a long time to notice when the connection dies. | ||
407 | As such, you probably want | ||
408 | the | ||
409 | .Cm ProtocolKeepAlives | ||
410 | option as well. | ||
398 | However, this means that | 411 | However, this means that |
399 | connections will die if the route is down temporarily, and some people | 412 | connections will die if the route is down temporarily, and some people |
400 | find it annoying. | 413 | find it annoying. |
@@ -482,6 +495,14 @@ This means that | |||
482 | .Nm ssh | 495 | .Nm ssh |
483 | tries version 2 and falls back to version 1 | 496 | tries version 2 and falls back to version 1 |
484 | if version 2 is not available. | 497 | if version 2 is not available. |
498 | .It Cm ProtocolKeepAlives | ||
499 | Specifies the interval in seconds at which IGNORE packets will be sent to | ||
500 | the server during idle periods. | ||
501 | Use this option in scripts to detect when the network fails. | ||
502 | The argument must be an integer. | ||
503 | The default is 0 (disabled), or 300 if the | ||
504 | .Cm BatchMode | ||
505 | option is set. | ||
485 | .It Cm ProxyCommand | 506 | .It Cm ProxyCommand |
486 | Specifies the command to use to connect to the server. | 507 | Specifies the command to use to connect to the server. |
487 | The command | 508 | The command |
@@ -553,6 +574,22 @@ running. | |||
553 | The default is | 574 | The default is |
554 | .Dq yes . | 575 | .Dq yes . |
555 | Note that this option applies to protocol version 1 only. | 576 | Note that this option applies to protocol version 1 only. |
577 | .It Cm SetupTimeOut | ||
578 | Normally, | ||
579 | .Nm ssh | ||
580 | blocks indefinitely whilst waiting to receive the ssh banner and other | ||
581 | setup protocol from the server, during the session setup. | ||
582 | This can cause | ||
583 | .Nm ssh | ||
584 | to hang under certain circumstances. | ||
585 | If this option is set, | ||
586 | .Nm ssh | ||
587 | will give up if no data from the server is received for the specified | ||
588 | number of seconds. | ||
589 | The argument must be an integer. | ||
590 | The default is 0 (disabled), or 300 if | ||
591 | .Cm BatchMode | ||
592 | is set. | ||
556 | .It Cm SmartcardDevice | 593 | .It Cm SmartcardDevice |
557 | Specifies which smartcard device to use. | 594 | Specifies which smartcard device to use. |
558 | The argument to this keyword is the device | 595 | The argument to this keyword is the device |