gui, man, authors: Update docs, translations, and contributors
This commit is contained in:
+26
-24
@@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-CONFIG" "5" "Jun 11, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-CONFIG" "5" "Jan 02, 2020" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-config \- Syncthing Configuration
|
||||
.
|
||||
@@ -58,7 +58,7 @@ directory the following files are located:
|
||||
The configuration file, in XML format.
|
||||
.TP
|
||||
.B \fBcert.pem\fP, \fBkey.pem\fP
|
||||
The device’s RSA public and private key. These form the basis for the
|
||||
The device’s ECDSA public and private key. These form the basis for the
|
||||
device ID. The key must be kept private.
|
||||
.TP
|
||||
.B \fBhttps\-cert.pem\fP, \fBhttps\-key.pem\fP
|
||||
@@ -145,15 +145,8 @@ The following shows an example of the default configuration file (IDs will diffe
|
||||
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
|
||||
<tempIndexMinBlocks>10</tempIndexMinBlocks>
|
||||
<trafficClass>0</trafficClass>
|
||||
<weakHashSelectionMethod>auto</weakHashSelectionMethod>
|
||||
<stunServer>default</stunServer>
|
||||
<stunKeepaliveSeconds>24</stunKeepaliveSeconds>
|
||||
<kcpNoDelay>false</kcpNoDelay>
|
||||
<kcpUpdateIntervalMs>25</kcpUpdateIntervalMs>
|
||||
<kcpFastResend>false</kcpFastResend>
|
||||
<kcpCongestionControl>true</kcpCongestionControl>
|
||||
<kcpSendWindowSize>128</kcpSendWindowSize>
|
||||
<kcpReceiveWindowSize>128</kcpReceiveWindowSize>
|
||||
<defaultFolderPath>~</defaultFolderPath>
|
||||
<minHomeDiskFreePct>0</minHomeDiskFreePct>
|
||||
<setLowPriority>true</setLowPriority>
|
||||
@@ -417,7 +410,11 @@ what you’re doing.
|
||||
<device id="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR" name="syno local" compression="metadata" introducer="false">
|
||||
<address>tcp://192.0.2.1:22001</address>
|
||||
<paused>true<paused>
|
||||
<allowedNetwork>192.168.0.0/16<allowedNetwork>
|
||||
<allowedNetwork>192.168.0.0/16</allowedNetwork>
|
||||
<autoAcceptFolders>false</autoAcceptFolders>
|
||||
<maxSendKbps>100</maxSendKbps>
|
||||
<maxRecvKbps>100</maxRecvKbps>
|
||||
<maxRequestKiB>65536</maxRequestKiB>
|
||||
</device>
|
||||
.ft P
|
||||
.fi
|
||||
@@ -541,6 +538,18 @@ True if synchronization with this devices is (temporarily) suspended.
|
||||
.B allowedNetwork
|
||||
If given, this restricts connections to this device to only this network
|
||||
(see allowed\-networks).
|
||||
.TP
|
||||
.B maxSendKbps
|
||||
Maximum send rate to use for this device. Unit is kibibytes/second, despite
|
||||
the config name looking like kilobits/second.
|
||||
.TP
|
||||
.B maxRecvKbps
|
||||
Maximum receive rate to use for this device. Unit is kibibytes/second,
|
||||
despite the config name looking like kilobits/second.
|
||||
.TP
|
||||
.B maxRequestKiB
|
||||
Maximum amount of data to have outstanding in requests towards this device.
|
||||
Unit is kibibytes.
|
||||
.UNINDENT
|
||||
.SH GUI ELEMENT
|
||||
.INDENT 0.0
|
||||
@@ -862,12 +871,6 @@ the user acknowledged it (e.g. an transition notice on an upgrade).
|
||||
.B trafficClass
|
||||
Specify a type of service (TOS)/traffic class of outgoing packets.
|
||||
.TP
|
||||
.B weakHashSelectionMethod
|
||||
Specify whether weak hashing is used, possible options are
|
||||
\fBWeakHashAlways\fP, \fBWeakHashNever\fP and \fBWeakHashAuto\fP\&. Deciding
|
||||
automatically means running benchmarks at startup to decide whether the
|
||||
performance impact is acceptable (this is the default).
|
||||
.TP
|
||||
.B stunServer
|
||||
Server to be used for STUN, given as ip:port. The keyword \fBdefault\fP gets
|
||||
expanded to
|
||||
@@ -877,17 +880,13 @@ expanded to
|
||||
\fBstun.schlund.de:3478\fP, \fBstun.sipgate.net:10000\fP,
|
||||
\fBstun.sipgate.net:3478\fP, \fBstun.voip.aebc.com:3478\fP,
|
||||
\fBstun.voiparound.com:3478\fP, \fBstun.voipbuster.com:3478\fP,
|
||||
\fBstun.voipstunt.com:3478\fP, \fBstun.voxgratia.org:3478\fP and
|
||||
\fBstun.xten.com:3478\fP (this is the default).
|
||||
\fBstun.voipstunt.com:3478\fP and \fBstun.xten.com:3478\fP (this is the default).
|
||||
.TP
|
||||
.B stunKeepaliveSeconds
|
||||
Interval in seconds between contacting a STUN server to
|
||||
maintain NAT mapping. Default is \fB24\fP and you can set it to \fB0\fP to
|
||||
disable contacting STUN servers.
|
||||
.TP
|
||||
.B kcpNoDelay, kcpUpdateIntervalMs, kcpFastResend, kcpCongestionControl, kcpSendWindowSize, kcpReceiveWindowSize
|
||||
Various KCP tweaking parameters.
|
||||
.TP
|
||||
.B defaultFolderPath
|
||||
The UI will propose to create new folders at this path. This can be disabled by
|
||||
setting this to an empty string.
|
||||
@@ -905,12 +904,12 @@ as part of launching Syncthing, set this option to \fBfalse\fP\&.
|
||||
.UNINDENT
|
||||
.SS Listen Addresses
|
||||
.sp
|
||||
The following address types are accepted in sync protocol listen addresses:
|
||||
The following address types are accepted in sync protocol listen addresses. If you want Syncthing to listen on multiple addresses, you can have multiple \fB<listenAddress>\fP tags. The same is achieved in the GUI by entering several addresses separated by comma.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B Default listen addresses (\fBdefault\fP)
|
||||
This is equivalent to \fBtcp://0.0.0.0:22000\fP and
|
||||
\fBdynamic+https://relays.syncthing.net/endpoint\fP\&.
|
||||
This is equivalent to \fBtcp://0.0.0.0:22000\fP, \fBquic://0.0.0.0:22000\fP
|
||||
and \fBdynamic+https://relays.syncthing.net/endpoint\fP\&.
|
||||
.TP
|
||||
.B TCP wildcard and port (\fBtcp://0.0.0.0:22000\fP, \fBtcp://:22000\fP)
|
||||
These are equivalent and will result in Syncthing listening on all
|
||||
@@ -932,6 +931,9 @@ interfaces via IPv6 only.
|
||||
This results in Syncthing listening on the specified address and port, IPv6
|
||||
only.
|
||||
.TP
|
||||
.B QUIC address and port (e.g. \fBquic://0.0.0.0:22000\fP)
|
||||
Syntax is the same as for TCP, also \fBquic4\fP and \fBquic6\fP can be used.
|
||||
.TP
|
||||
.B Static relay address (\fBrelay://192.0.2.42:22067?id=abcd123...\fP)
|
||||
Syncthing will connect to and listen for incoming connections via the
|
||||
specified relay address.
|
||||
|
||||
Reference in New Issue
Block a user