summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.577
1 files changed, 75 insertions, 2 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index caf13a62d..7630e7bcb 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -33,8 +33,8 @@
33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35.\" 35.\"
36.\" $OpenBSD: ssh_config.5,v 1.228 2016/02/20 23:01:46 sobrado Exp $ 36.\" $OpenBSD: ssh_config.5,v 1.236 2016/07/22 07:00:46 djm Exp $
37.Dd $Mdocdate: February 20 2016 $ 37.Dd $Mdocdate: July 22 2016 $
38.Dt SSH_CONFIG 5 38.Dt SSH_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -952,6 +952,36 @@ This option is intended for situations where ssh-agent
952offers many different identities. 952offers many different identities.
953The default is 953The default is
954.Dq no . 954.Dq no .
955.It Cm IdentityAgent
956Specifies the
957.Ux Ns -domain
958socket used to communicate with the authentication agent.
959.Pp
960This option overrides the
961.Dq SSH_AUTH_SOCK
962environment variable and can be used to select a specific agent.
963Setting the socket name to
964.Dq none
965disables the use of an authentication agent.
966If the string
967.Dq SSH_AUTH_SOCK
968is specified, the location of the socket will be read from the
969.Ev SSH_AUTH_SOCK
970environment variable.
971.Pp
972The socket name may use the tilde
973syntax to refer to a user's home directory or one of the following
974escape characters:
975.Ql %d
976(local user's home directory),
977.Ql %u
978(local user name),
979.Ql %l
980(local host name),
981.Ql %h
982(remote host name) or
983.Ql %r
984(remote user name).
955.It Cm IdentityFile 985.It Cm IdentityFile
956Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication 986Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication
957identity is read. 987identity is read.
@@ -1019,6 +1049,25 @@ It is recommended that
1019.Cm IgnoreUnknown 1049.Cm IgnoreUnknown
1020be listed early in the configuration file as it will not be applied 1050be listed early in the configuration file as it will not be applied
1021to unknown options that appear before it. 1051to unknown options that appear before it.
1052.It Cm Include
1053Include the specified configuration file(s).
1054Multiple pathnames may be specified and each pathname may contain
1055.Xr glob 3
1056wildcards and, for user configurations, shell-like
1057.Dq ~
1058references to user home directories.
1059Files without absolute paths are assumed to be in
1060.Pa ~/.ssh
1061if included in a user configuration file or
1062.Pa /etc/ssh
1063if included from the system configuration file.
1064.Cm Include
1065directive may appear inside a
1066.Cm Match
1067or
1068.Cm Host
1069block
1070to perform conditional inclusion.
1022.It Cm IPQoS 1071.It Cm IPQoS
1023Specifies the IPv4 type-of-service or DSCP class for connections. 1072Specifies the IPv4 type-of-service or DSCP class for connections.
1024Accepted values are 1073Accepted values are
@@ -1309,6 +1358,30 @@ For example, the following directive would connect via an HTTP proxy at
1309.Bd -literal -offset 3n 1358.Bd -literal -offset 3n
1310ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p 1359ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1311.Ed 1360.Ed
1361.It Cm ProxyJump
1362Specifies one or more jump proxies as
1363.Xo
1364.Sm off
1365.Op Ar user No @
1366.Ar host
1367.Op : Ns Ar port
1368.Sm on
1369.Xc .
1370Multiple proxies may be separated by comma characters and will be visited
1371sequentially.
1372Setting this option will cause
1373.Xr ssh 1
1374to connect to the target host by first making a
1375.Xr ssh 1
1376connection to the specified
1377.Cm ProxyJump
1378host and then establishing a
1379TCP forwarding to the ultimate target from there.
1380.Pp
1381Note that this option will compete with the
1382.Cm ProxyCommand
1383option - whichever is specified first will prevent later instances of the
1384other from taking effect.
1312.It Cm ProxyUseFdpass 1385.It Cm ProxyUseFdpass
1313Specifies that 1386Specifies that
1314.Cm ProxyCommand 1387.Cm ProxyCommand