summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.585
1 files changed, 69 insertions, 16 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index dc010ccbd..6be1f1aa2 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.325 2020/04/11 20:20:09 jmc Exp $ 36.\" $OpenBSD: ssh_config.5,v 1.332 2020/08/11 09:49:57 djm Exp $
37.Dd $Mdocdate: April 11 2020 $ 37.Dd $Mdocdate: August 11 2020 $
38.Dt SSH_CONFIG 5 38.Dt SSH_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -245,13 +245,22 @@ option was specified to
245If this option is set to 245If this option is set to
246.Cm no , 246.Cm no ,
247no keys are added to the agent. 247no keys are added to the agent.
248Alternately, this option may be specified as a time interval
249using the format described in the
250.Sx TIME FORMATS
251section of
252.Xr sshd_config 5
253to specify the key's lifetime in
254.Xr ssh-agent 1 ,
255after which it will automatically be removed.
248The argument must be 256The argument must be
249.Cm yes ,
250.Cm confirm ,
251.Cm ask ,
252or
253.Cm no 257.Cm no
254(the default). 258(the default),
259.Cm yes ,
260.Cm confirm
261(optionally followed by a time interval),
262.Cm ask
263or a time interval.
255.It Cm AddressFamily 264.It Cm AddressFamily
256Specifies which address family to use when connecting. 265Specifies which address family to use when connecting.
257Valid arguments are 266Valid arguments are
@@ -389,9 +398,11 @@ or
389.Pp 398.Pp
390Arguments to 399Arguments to
391.Cm CertificateFile 400.Cm CertificateFile
392may use the tilde syntax to refer to a user's home directory 401may use the tilde syntax to refer to a user's home directory,
393or the tokens described in the 402the tokens described in the
394.Sx TOKENS 403.Sx TOKENS
404section and environment variables as described in the
405.Sx ENVIRONMENT VARIABLES
395section. 406section.
396.Pp 407.Pp
397It is possible to have multiple certificate files specified in 408It is possible to have multiple certificate files specified in
@@ -551,9 +562,11 @@ section above or the string
551to disable connection sharing. 562to disable connection sharing.
552Arguments to 563Arguments to
553.Cm ControlPath 564.Cm ControlPath
554may use the tilde syntax to refer to a user's home directory 565may use the tilde syntax to refer to a user's home directory,
555or the tokens described in the 566the tokens described in the
556.Sx TOKENS 567.Sx TOKENS
568section and environment variables as described in the
569.Sx ENVIRONMENT VARIABLES
557section. 570section.
558It is recommended that any 571It is recommended that any
559.Cm ControlPath 572.Cm ControlPath
@@ -934,9 +947,11 @@ the location of the socket.
934.Pp 947.Pp
935Arguments to 948Arguments to
936.Cm IdentityAgent 949.Cm IdentityAgent
937may use the tilde syntax to refer to a user's home directory 950may use the tilde syntax to refer to a user's home directory,
938or the tokens described in the 951the tokens described in the
939.Sx TOKENS 952.Sx TOKENS
953section and environment variables as described in the
954.Sx ENVIRONMENT VARIABLES
940section. 955section.
941.It Cm IdentityFile 956.It Cm IdentityFile
942Specifies a file from which the user's DSA, ECDSA, authenticator-hosted ECDSA, 957Specifies a file from which the user's DSA, ECDSA, authenticator-hosted ECDSA,
@@ -1004,6 +1019,7 @@ Multiple pathnames may be specified and each pathname may contain
1004wildcards and, for user configurations, shell-like 1019wildcards and, for user configurations, shell-like
1005.Sq ~ 1020.Sq ~
1006references to user home directories. 1021references to user home directories.
1022Wildcards will be expanded and processed in lexical order.
1007Files without absolute paths are assumed to be in 1023Files without absolute paths are assumed to be in
1008.Pa ~/.ssh 1024.Pa ~/.ssh
1009if included in a user configuration file or 1025if included in a user configuration file or
@@ -1152,8 +1168,10 @@ indicates that the listening port be bound for local use only, while an
1152empty address or 1168empty address or
1153.Sq * 1169.Sq *
1154indicates that the port should be available from all interfaces. 1170indicates that the port should be available from all interfaces.
1155Unix domain socket paths accept the tokens described in the 1171Unix domain socket paths may use the tokens described in the
1156.Sx TOKENS 1172.Sx TOKENS
1173section and environment variables as described in the
1174.Sx ENVIRONMENT VARIABLES
1157section. 1175section.
1158.It Cm LogLevel 1176.It Cm LogLevel
1159Gives the verbosity level that is used when logging messages from 1177Gives the verbosity level that is used when logging messages from
@@ -1423,8 +1441,10 @@ Multiple forwardings may be specified, and additional
1423forwardings can be given on the command line. 1441forwardings can be given on the command line.
1424Privileged ports can be forwarded only when 1442Privileged ports can be forwarded only when
1425logging in as root on the remote machine. 1443logging in as root on the remote machine.
1426Unix domain socket paths accept the tokens described in the 1444Unix domain socket paths may use the tokens described in the
1427.Sx TOKENS 1445.Sx TOKENS
1446section and environment variables as described in the
1447.Sx ENVIRONMENT VARIABLES
1428section. 1448section.
1429.Pp 1449.Pp
1430If the 1450If the
@@ -1727,6 +1747,12 @@ having to remember to give the user name on the command line.
1727.It Cm UserKnownHostsFile 1747.It Cm UserKnownHostsFile
1728Specifies one or more files to use for the user 1748Specifies one or more files to use for the user
1729host key database, separated by whitespace. 1749host key database, separated by whitespace.
1750Each filename may use tilde notation to refer to the user's home directory,
1751the tokens described in the
1752.Sx TOKENS
1753section and environment variables as described in the
1754.Sx ENVIRONMENT VARIABLES
1755section.
1730The default is 1756The default is
1731.Pa ~/.ssh/known_hosts , 1757.Pa ~/.ssh/known_hosts ,
1732.Pa ~/.ssh/known_hosts2 . 1758.Pa ~/.ssh/known_hosts2 .
@@ -1833,6 +1859,9 @@ Local user's home directory.
1833The remote hostname. 1859The remote hostname.
1834.It %i 1860.It %i
1835The local user ID. 1861The local user ID.
1862.It %k
1863The host key alias if specified, otherwise the orignal remote hostname given
1864on the command line.
1836.It %L 1865.It %L
1837The local hostname. 1866The local hostname.
1838.It %l 1867.It %l
@@ -1863,8 +1892,9 @@ The local username.
1863.Cm LocalForward , 1892.Cm LocalForward ,
1864.Cm Match exec , 1893.Cm Match exec ,
1865.Cm RemoteCommand , 1894.Cm RemoteCommand ,
1895.Cm RemoteForward ,
1866and 1896and
1867.Cm RemoteForward 1897.Cm UserKnownHostsFile
1868accept the tokens %%, %C, %d, %h, %i, %L, %l, %n, %p, %r, and %u. 1898accept the tokens %%, %C, %d, %h, %i, %L, %l, %n, %p, %r, and %u.
1869.Pp 1899.Pp
1870.Cm Hostname 1900.Cm Hostname
@@ -1875,6 +1905,29 @@ accepts all tokens.
1875.Pp 1905.Pp
1876.Cm ProxyCommand 1906.Cm ProxyCommand
1877accepts the tokens %%, %h, %n, %p, and %r. 1907accepts the tokens %%, %h, %n, %p, and %r.
1908.Sh ENVIRONMENT VARIABLES
1909Arguments to some keywords can be expanded at runtime from environment
1910variables on the client by enclosing them in
1911.Ic ${} ,
1912for example
1913.Ic ${HOME}/.ssh
1914would refer to the user's .ssh directory.
1915If a specified environment variable does not exist then an error will be
1916returned and the setting for that keyword will be ignored.
1917.Pp
1918The keywords
1919.Cm CertificateFile ,
1920.Cm ControlPath ,
1921.Cm IdentityAgent ,
1922.Cm IdentityFile
1923and
1924.Cm UserKnownHostsFile
1925support environment variables.
1926The keywords
1927.Cm LocalForward
1928and
1929.Cm RemoteForward
1930support environment variables only for Unix domain socket paths.
1878.Sh FILES 1931.Sh FILES
1879.Bl -tag -width Ds 1932.Bl -tag -width Ds
1880.It Pa ~/.ssh/config 1933.It Pa ~/.ssh/config