- djm@cvs.openbsd.org 2010/01/13 03:48:13

[openssh.git] / ssh_config.5

diff --git a/ssh_config.5 b/ssh_config.5
index e9414d7266a47b1d6ce8bfafd4a06410485159ec..7d577360dc0b0c41ae424e284d6f4b7e3313c657 100644 (file)
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -34,7 +34,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"

-.\" $OpenBSD: ssh_config.5,v 1.103 2007/09/21 03:05:23 djm Exp $
+.\" $OpenBSD: ssh_config.5,v 1.126 2010/01/09 23:04:13 dtucker Exp $

 .Dd $Mdocdate$
 .Dt SSH_CONFIG 5
 .Os
 .Dd $Mdocdate$
 .Dt SSH_CONFIG 5
 .Os


@@ -103,6 +103,7 @@ Restricts the following declarations (up to the next
 .Cm Host
 keyword) to be only for those hosts that match one of the patterns
 given after the keyword.
 .Cm Host
 keyword) to be only for those hosts that match one of the patterns
 given after the keyword.

+If more than one pattern is provided, they should be separated by whitespace.

 A single
 .Ql *
 as a pattern can be used to provide global
 A single
 .Ql *
 as a pattern can be used to provide global


@@ -203,9 +204,9 @@ and
 .Dq cast128-cbc .
 The default is:
 .Bd -literal -offset 3n
 .Dq cast128-cbc .
 The default is:
 .Bd -literal -offset 3n

-aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
-arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
-aes192-ctr,aes256-ctr
+aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,
+aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,
+aes256-cbc,arcfour

 .Ed
 .It Cm ClearAllForwardings
 Specifies that all local, remote, and dynamic port forwardings
 .Ed
 .It Cm ClearAllForwardings
 Specifies that all local, remote, and dynamic port forwardings


@@ -599,7 +600,29 @@ and
 Specifies a command to execute on the local machine after successfully
 connecting to the server.
 The command string extends to the end of the line, and is executed with
 Specifies a command to execute on the local machine after successfully
 connecting to the server.
 The command string extends to the end of the line, and is executed with

-.Pa /bin/sh .
+the user's shell.
+The following escape character substitutions will be performed:
+.Ql %d
+(local user's home directory),
+.Ql %h
+(remote host name),
+.Ql %l
+(local host name),
+.Ql %n
+(host name as provided on the command line),
+.Ql %p
+(remote port),
+.Ql %r
+(remote user name) or
+.Ql %u
+(local user name).
+.Pp
+The command is run synchronously and does not have access to the
+session of the
+.Xr ssh 1
+that spawned it.
+It should not be used for interactive commands.
+.Pp

 This directive is ignored unless
 .Cm PermitLocalCommand
 has been enabled.
 This directive is ignored unless
 .Cm PermitLocalCommand
 has been enabled.


@@ -714,16 +737,18 @@ The possible values are
 and
 .Sq 2 .
 Multiple versions must be comma-separated.
 and
 .Sq 2 .
 Multiple versions must be comma-separated.

-The default is
-.Dq 2,1 .
-This means that ssh
-tries version 2 and falls back to version 1
+When this option is set to
+.Dq 2,1
+.Nm ssh
+will try version 2 and fall back to version 1

 if version 2 is not available.
 if version 2 is not available.

+The default is
+.Sq 2 .

 .It Cm ProxyCommand
 Specifies the command to use to connect to the server.
 The command
 string extends to the end of the line, and is executed with
 .It Cm ProxyCommand
 Specifies the command to use to connect to the server.
 The command
 string extends to the end of the line, and is executed with

-.Pa /bin/sh .
+the user's shell.

 In the command string,
 .Ql %h
 will be substituted by the host name to
 In the command string,
 .Ql %h
 will be substituted by the host name to


@@ -795,7 +820,15 @@ and
 .Ar host Ns / Ns Ar hostport .
 Multiple forwardings may be specified, and additional
 forwardings can be given on the command line.
 .Ar host Ns / Ns Ar hostport .
 Multiple forwardings may be specified, and additional
 forwardings can be given on the command line.

-Only the superuser can forward privileged ports.
+Privileged ports can be forwarded only when
+logging in as root on the remote machine.
+.Pp
+If the
+.Ar port
+argument is
+.Ql 0 ,
+the listen port will be dynamically allocated on the server and reported
+to the client at run time.

 .Pp
 If the
 .Ar bind_address
 .Pp
 If the
 .Ar bind_address


@@ -1044,6 +1077,18 @@ See also
 .Sx VERIFYING HOST KEYS
 in
 .Xr ssh 1 .
 .Sx VERIFYING HOST KEYS
 in
 .Xr ssh 1 .

+.It Cm VisualHostKey
+If this flag is set to
+.Dq yes ,
+an ASCII art representation of the remote host key fingerprint is
+printed in addition to the hex fingerprint string at login and
+for unknown host keys.
+If this flag is set to
+.Dq no ,
+no fingerprint strings are printed at login and
+only the hex fingerprint string will be printed for unknown host keys.
+The default is
+.Dq no .

 .It Cm XAuthLocation
 Specifies the full pathname of the
 .Xr xauth 1
 .It Cm XAuthLocation
 Specifies the full pathname of the
 .Xr xauth 1