Document tcp4:// tcp6:// prefixes

Documenting https://github.com/syncthing/syncthing/pull/2880
This commit is contained in:
Adam Piggott
2016-03-25 09:46:47 +00:00
parent c0820c8a0c
commit 609a95318e
+3 -3
View File
@@ -270,7 +270,7 @@ introducer
In addition, one or more ``address`` child elements must be present. Each In addition, one or more ``address`` child elements must be present. Each
contains an address or host name to use when attempting to connect to this device and will contains an address or host name to use when attempting to connect to this device and will
be tried in order. Entries other than ``dynamic`` must be prefixed with ``tcp://``. Accepted formats are: be tried in order. Entries other than ``dynamic`` must be prefixed with ``tcp://`` (dual-stack), ``tcp4://`` (IPv4 only) or ``tcp6://` (IPv6 only). Note that IP addresses need not use tcp4/tcp6; these are optional. Accepted formats are:
IPv4 address (``tcp://192.0.2.42``) IPv4 address (``tcp://192.0.2.42``)
The default port (22000) is used. The default port (22000) is used.
@@ -286,8 +286,8 @@ IPv6 address and port (``tcp://[2001:db8::23:42]:12345``)
The address and port is used as given. The address must be enclosed in The address and port is used as given. The address must be enclosed in
square brackets. square brackets.
Host name (``tcp://fileserver``) Host name (``tcp6://fileserver``)
The host name will be used on the default port (22000) and connections will be attempted via both IPv4 and IPv6, depending on name resolution. The host name will be used on the default port (22000) and connections will be attempted only via IPv6.
Host name and port (``tcp://fileserver:12345``) Host name and port (``tcp://fileserver:12345``)
The host name will be used on the given port and connections will be attempted via both IPv4 and IPv6, depending on name resolution. The host name will be used on the given port and connections will be attempted via both IPv4 and IPv6, depending on name resolution.