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 51765c99e..c96725862 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
@@ -1008,6 +1008,36 @@ This option is intended for situations where ssh-agent
1008offers many different identities. 1008offers many different identities.
1009The default is 1009The default is
1010.Dq no . 1010.Dq no .
1011.It Cm IdentityAgent
1012Specifies the
1013.Ux Ns -domain
1014socket used to communicate with the authentication agent.
1015.Pp
1016This option overrides the
1017.Dq SSH_AUTH_SOCK
1018environment variable and can be used to select a specific agent.
1019Setting the socket name to
1020.Dq none
1021disables the use of an authentication agent.
1022If the string
1023.Dq SSH_AUTH_SOCK
1024is specified, the location of the socket will be read from the
1025.Ev SSH_AUTH_SOCK
1026environment variable.
1027.Pp
1028The socket name may use the tilde
1029syntax to refer to a user's home directory or one of the following
1030escape characters:
1031.Ql %d
1032(local user's home directory),
1033.Ql %u
1034(local user name),
1035.Ql %l
1036(local host name),
1037.Ql %h
1038(remote host name) or
1039.Ql %r
1040(remote user name).
1011.It Cm IdentityFile 1041.It Cm IdentityFile
1012Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication 1042Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication
1013identity is read. 1043identity is read.
@@ -1075,6 +1105,25 @@ It is recommended that
1075.Cm IgnoreUnknown 1105.Cm IgnoreUnknown
1076be listed early in the configuration file as it will not be applied 1106be listed early in the configuration file as it will not be applied
1077to unknown options that appear before it. 1107to unknown options that appear before it.
1108.It Cm Include
1109Include the specified configuration file(s).
1110Multiple pathnames may be specified and each pathname may contain
1111.Xr glob 3
1112wildcards and, for user configurations, shell-like
1113.Dq ~
1114references to user home directories.
1115Files without absolute paths are assumed to be in
1116.Pa ~/.ssh
1117if included in a user configuration file or
1118.Pa /etc/ssh
1119if included from the system configuration file.
1120.Cm Include
1121directive may appear inside a
1122.Cm Match
1123or
1124.Cm Host
1125block
1126to perform conditional inclusion.
1078.It Cm IPQoS 1127.It Cm IPQoS
1079Specifies the IPv4 type-of-service or DSCP class for connections. 1128Specifies the IPv4 type-of-service or DSCP class for connections.
1080Accepted values are 1129Accepted values are
@@ -1365,6 +1414,30 @@ For example, the following directive would connect via an HTTP proxy at
1365.Bd -literal -offset 3n 1414.Bd -literal -offset 3n
1366ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p 1415ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1367.Ed 1416.Ed
1417.It Cm ProxyJump
1418Specifies one or more jump proxies as
1419.Xo
1420.Sm off
1421.Op Ar user No @
1422.Ar host
1423.Op : Ns Ar port
1424.Sm on
1425.Xc .
1426Multiple proxies may be separated by comma characters and will be visited
1427sequentially.
1428Setting this option will cause
1429.Xr ssh 1
1430to connect to the target host by first making a
1431.Xr ssh 1
1432connection to the specified
1433.Cm ProxyJump
1434host and then establishing a
1435TCP forwarding to the ultimate target from there.
1436.Pp
1437Note that this option will compete with the
1438.Cm ProxyCommand
1439option - whichever is specified first will prevent later instances of the
1440other from taking effect.
1368.It Cm ProxyUseFdpass 1441.It Cm ProxyUseFdpass
1369Specifies that 1442Specifies that
1370.Cm ProxyCommand 1443.Cm ProxyCommand