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 19d13f5c7..91c2cd2c6 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 ,
@@ -553,6 +584,10 @@ or for multiple servers running on a single host.
553.It Cm HostName 584.It Cm HostName
554Specifies the real host name to log into. 585Specifies the real host name to log into.
555This can be used to specify nicknames or abbreviations for hosts. 586This can be used to specify nicknames or abbreviations for hosts.
587If the hostname contains the character sequence
588.Ql %h ,
589then this will be replaced with the host name specified on the commandline
590(this is useful for manipulating unqualified names).
556The default is the name given on the command line. 591The default is the name given on the command line.
557Numeric IP addresses are also permitted (both on the command line and in 592Numeric IP addresses are also permitted (both on the command line and in
558.Cm HostName 593.Cm HostName
@@ -668,11 +703,7 @@ The first argument must be
668.Sm on 703.Sm on
669and the second argument must be 704and the second argument must be
670.Ar host : Ns Ar hostport . 705.Ar host : Ns Ar hostport .
671IPv6 addresses can be specified by enclosing addresses in square brackets or 706IPv6 addresses can be specified by enclosing addresses in square brackets.
672by using an alternative syntax:
673.Oo Ar bind_address Ns / Oc Ns Ar port
674and
675.Ar host Ns / Ns Ar hostport .
676Multiple forwardings may be specified, and additional forwardings can be 707Multiple forwardings may be specified, and additional forwardings can be
677given on the command line. 708given on the command line.
678Only the superuser can forward privileged ports. 709Only the superuser can forward privileged ports.
@@ -759,10 +790,12 @@ authentication methods.
759This allows a client to prefer one method (e.g.\& 790This allows a client to prefer one method (e.g.\&
760.Cm keyboard-interactive ) 791.Cm keyboard-interactive )
761over another method (e.g.\& 792over another method (e.g.\&
762.Cm password ) 793.Cm password ) .
763The default for this option is: 794The default is:
764.Do gssapi-with-mic,hostbased,publickey,keyboard-interactive,password 795.Bd -literal -offset indent
765.Dc . 796gssapi-with-mic,hostbased,publickey,
797keyboard-interactive,password
798.Ed
766.It Cm Protocol 799.It Cm Protocol
767Specifies the protocol versions 800Specifies the protocol versions
768.Xr ssh 1 801.Xr ssh 1
@@ -784,12 +817,14 @@ Specifies the command to use to connect to the server.
784The command 817The command
785string extends to the end of the line, and is executed with 818string extends to the end of the line, and is executed with
786the user's shell. 819the user's shell.
787In the command string, 820In the command string, any occurrence of
788.Ql %h 821.Ql %h
789will be substituted by the host name to 822will be substituted by the host name to
790connect and 823connect,
791.Ql %p 824.Ql %p
792by the port. 825by the port, and
826.Ql %r
827by the remote user name.
793The command can be basically anything, 828The command can be basically anything,
794and should read from its standard input and write to its standard output. 829and should read from its standard input and write to its standard output.
795It should eventually connect an 830It should eventually connect an
@@ -848,11 +883,7 @@ The first argument must be
848.Sm on 883.Sm on
849and the second argument must be 884and the second argument must be
850.Ar host : Ns Ar hostport . 885.Ar host : Ns Ar hostport .
851IPv6 addresses can be specified by enclosing addresses in square brackets 886IPv6 addresses can be specified by enclosing addresses in square brackets.
852or by using an alternative syntax:
853.Oo Ar bind_address Ns / Oc Ns Ar port
854and
855.Ar host Ns / Ns Ar hostport .
856Multiple forwardings may be specified, and additional 887Multiple forwardings may be specified, and additional
857forwardings can be given on the command line. 888forwardings can be given on the command line.
858Privileged ports can be forwarded only when 889Privileged ports can be forwarded only when