summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.575
1 files changed, 53 insertions, 22 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 410853560..ddb806ec0 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.130 2010/03/26 01:06:13 dtucker Exp $ 37.\" $OpenBSD: ssh_config.5,v 1.138 2010/08/04 05:37:01 djm Exp $
38.Dd $Mdocdate: March 26 2010 $ 38.Dd $Mdocdate: August 4 2010 $
39.Dt SSH_CONFIG 5 39.Dt SSH_CONFIG 5
40.Os 40.Os
41.Sh NAME 41.Sh NAME
@@ -319,6 +319,28 @@ It is recommended that any
319used for opportunistic connection sharing include 319used for opportunistic connection sharing include
320at least %h, %p, and %r. 320at least %h, %p, and %r.
321This ensures that shared connections are uniquely identified. 321This ensures that shared connections are uniquely identified.
322.It Cm ControlPersist
323When used in conjunction with
324.Cm ControlMaster ,
325specifies that the master connection should remain open
326in the background (waiting for future client connections)
327after the initial client connection has been closed.
328If set to
329.Dq no ,
330then the master connection will not be placed into the background,
331and will close as soon as the initial client connection is closed.
332If set to
333.Dq yes ,
334then the master connection will remain in the background indefinitely
335(until killed or closed via a mechanism such as the
336.Xr ssh 1
337.Dq Fl O No exit
338option).
339If set to a time in seconds, or a time in any of the formats documented in
340.Xr sshd_config 5 ,
341then the backgrounded master connection will automatically terminate
342after it has remained idle (with no client connections) for the
343specified time.
322.It Cm DynamicForward 344.It Cm DynamicForward
323Specifies that a TCP port on the local machine be forwarded 345Specifies that a TCP port on the local machine be forwarded
324over the secure channel, and the application 346over the secure channel, and the application
@@ -329,9 +351,7 @@ The argument must be
329.Sm off 351.Sm off
330.Oo Ar bind_address : Oc Ar port . 352.Oo Ar bind_address : Oc Ar port .
331.Sm on 353.Sm on
332IPv6 addresses can be specified by enclosing addresses in square brackets or 354IPv6 addresses can be specified by enclosing addresses in square brackets.
333by using an alternative syntax:
334.Oo Ar bind_address Ns / Oc Ns Ar port .
335By default, the local port is bound in accordance with the 355By default, the local port is bound in accordance with the
336.Cm GatewayPorts 356.Cm GatewayPorts
337setting. 357setting.
@@ -432,6 +452,17 @@ An attacker may then be able to perform activities such as keystroke monitoring
432if the 452if the
433.Cm ForwardX11Trusted 453.Cm ForwardX11Trusted
434option is also enabled. 454option is also enabled.
455.It Cm ForwardX11Timeout
456Specify a timeout for untrusted X11 forwarding
457using the format described in the
458.Sx TIME FORMATS
459section of
460.Xr sshd_config 5 .
461X11 connections received by
462.Xr ssh 1
463after this time will be refused.
464The default is to disable untrusted X11 forwarding after twenty minutes has
465elapsed.
435.It Cm ForwardX11Trusted 466.It Cm ForwardX11Trusted
436If this option is set to 467If this option is set to
437.Dq yes , 468.Dq yes ,
@@ -526,6 +557,10 @@ or for multiple servers running on a single host.
526.It Cm HostName 557.It Cm HostName
527Specifies the real host name to log into. 558Specifies the real host name to log into.
528This can be used to specify nicknames or abbreviations for hosts. 559This can be used to specify nicknames or abbreviations for hosts.
560If the hostname contains the character sequence
561.Ql %h ,
562then this will be replaced with the host name specified on the commandline
563(this is useful for manipulating unqualified names).
529The default is the name given on the command line. 564The default is the name given on the command line.
530Numeric IP addresses are also permitted (both on the command line and in 565Numeric IP addresses are also permitted (both on the command line and in
531.Cm HostName 566.Cm HostName
@@ -641,11 +676,7 @@ The first argument must be
641.Sm on 676.Sm on
642and the second argument must be 677and the second argument must be
643.Ar host : Ns Ar hostport . 678.Ar host : Ns Ar hostport .
644IPv6 addresses can be specified by enclosing addresses in square brackets or 679IPv6 addresses can be specified by enclosing addresses in square brackets.
645by using an alternative syntax:
646.Oo Ar bind_address Ns / Oc Ns Ar port
647and
648.Ar host Ns / Ns Ar hostport .
649Multiple forwardings may be specified, and additional forwardings can be 680Multiple forwardings may be specified, and additional forwardings can be
650given on the command line. 681given on the command line.
651Only the superuser can forward privileged ports. 682Only the superuser can forward privileged ports.
@@ -732,10 +763,12 @@ authentication methods.
732This allows a client to prefer one method (e.g.\& 763This allows a client to prefer one method (e.g.\&
733.Cm keyboard-interactive ) 764.Cm keyboard-interactive )
734over another method (e.g.\& 765over another method (e.g.\&
735.Cm password ) 766.Cm password ) .
736The default for this option is: 767The default is:
737.Do gssapi-with-mic,hostbased,publickey,keyboard-interactive,password 768.Bd -literal -offset indent
738.Dc . 769gssapi-with-mic,hostbased,publickey,
770keyboard-interactive,password
771.Ed
739.It Cm Protocol 772.It Cm Protocol
740Specifies the protocol versions 773Specifies the protocol versions
741.Xr ssh 1 774.Xr ssh 1
@@ -757,12 +790,14 @@ Specifies the command to use to connect to the server.
757The command 790The command
758string extends to the end of the line, and is executed with 791string extends to the end of the line, and is executed with
759the user's shell. 792the user's shell.
760In the command string, 793In the command string, any occurrence of
761.Ql %h 794.Ql %h
762will be substituted by the host name to 795will be substituted by the host name to
763connect and 796connect,
764.Ql %p 797.Ql %p
765by the port. 798by the port, and
799.Ql %r
800by the remote user name.
766The command can be basically anything, 801The command can be basically anything,
767and should read from its standard input and write to its standard output. 802and should read from its standard input and write to its standard output.
768It should eventually connect an 803It should eventually connect an
@@ -821,11 +856,7 @@ The first argument must be
821.Sm on 856.Sm on
822and the second argument must be 857and the second argument must be
823.Ar host : Ns Ar hostport . 858.Ar host : Ns Ar hostport .
824IPv6 addresses can be specified by enclosing addresses in square brackets 859IPv6 addresses can be specified by enclosing addresses in square brackets.
825or by using an alternative syntax:
826.Oo Ar bind_address Ns / Oc Ns Ar port
827and
828.Ar host Ns / Ns Ar hostport .
829Multiple forwardings may be specified, and additional 860Multiple forwardings may be specified, and additional
830forwardings can be given on the command line. 861forwardings can be given on the command line.
831Privileged ports can be forwarded only when 862Privileged ports can be forwarded only when