gui, man: Update docs & translations

GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/3101
This commit is contained in:
Jakob Borg 2016-05-17 12:02:44 +00:00
parent 2c1323ece6
commit 2ea22b1850
16 changed files with 155 additions and 72 deletions

View File

@ -152,7 +152,7 @@
"Reused": "Réutilisé", "Reused": "Réutilisé",
"Save": "Sauver", "Save": "Sauver",
"Scan Time Remaining": "Intervalle entre chaque analyse", "Scan Time Remaining": "Intervalle entre chaque analyse",
"Scanning": "En cours d'analyse", "Scanning": "Analyse en cours",
"Select the devices to share this folder with.": "Sélectionner les machines avec qui partager ce dossier.", "Select the devices to share this folder with.": "Sélectionner les machines avec qui partager ce dossier.",
"Select the folders to share with this device.": "Sélectionner les dossiers à partager avec cette machine.", "Select the folders to share with this device.": "Sélectionner les dossiers à partager avec cette machine.",
"Settings": "Configuration", "Settings": "Configuration",
@ -179,7 +179,7 @@
"Stopped": "Arrêté", "Stopped": "Arrêté",
"Support": "Aide", "Support": "Aide",
"Sync Protocol Listen Addresses": "Adresse d'écoute du protocole de synchronisation", "Sync Protocol Listen Addresses": "Adresse d'écoute du protocole de synchronisation",
"Syncing": "En cours de synchronisation", "Syncing": "Synchronisation en cours",
"Syncthing has been shut down.": "Syncthing a été éteint.", "Syncthing has been shut down.": "Syncthing a été éteint.",
"Syncthing includes the following software or portions thereof:": "Syncthing intègre les logiciels suivants (ou des éléments provenant de ces logiciels) :", "Syncthing includes the following software or portions thereof:": "Syncthing intègre les logiciels suivants (ou des éléments provenant de ces logiciels) :",
"Syncthing is restarting.": "Syncthing est cours de redémarrage.", "Syncthing is restarting.": "Syncthing est cours de redémarrage.",

View File

@ -55,7 +55,7 @@
"Edit Device": "Apparaat bewurkje", "Edit Device": "Apparaat bewurkje",
"Edit Folder": "Map bewurkje", "Edit Folder": "Map bewurkje",
"Editing": "Bewurkjen", "Editing": "Bewurkjen",
"Enable NAT traversal": "Enable NAT traversal", "Enable NAT traversal": "NAT-trochkruse ynskeakelje",
"Enable Relaying": "Trochjaan tastean", "Enable Relaying": "Trochjaan tastean",
"Enable UPnP": "UPnP oansette", "Enable UPnP": "UPnP oansette",
"Enter comma separated (\"tcp://ip:port\", \"tcp://host:port\") addresses or \"dynamic\" to perform automatic discovery of the address.": "Fier troch komma's skieden (\"tcp://ip:port\", \"tcp://host:port\") adressen yn of \"dynamic\" om automatyske ûntdekking fan it adres út te fieren.", "Enter comma separated (\"tcp://ip:port\", \"tcp://host:port\") addresses or \"dynamic\" to perform automatic discovery of the address.": "Fier troch komma's skieden (\"tcp://ip:port\", \"tcp://host:port\") adressen yn of \"dynamic\" om automatyske ûntdekking fan it adres út te fieren.",

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-BEP" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-BEP" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-bep \- Block Exchange Protocol v1 syncthing-bep \- Block Exchange Protocol v1
. .
@ -232,7 +232,7 @@ For C=1:
The Length field contains the length, in bytes, of the compressed The Length field contains the length, in bytes, of the compressed
message data plus a four byte uncompressed length field. message data plus a four byte uncompressed length field.
.IP \(bu 2 .IP \(bu 2
The compressed message data is preceeded by a 32 bit field denoting The compressed message data is preceded by a 32 bit field denoting
the length of the uncompressed message. the length of the uncompressed message.
.IP \(bu 2 .IP \(bu 2
The message data is compressed using the LZ4 format and algorithm The message data is compressed using the LZ4 format and algorithm
@ -1149,7 +1149,7 @@ is no longer available, therefore the list of block indexes should be truncated.
Messages with \fBForget\fP bit set MUST NOT have any block indexes. Messages with \fBForget\fP bit set MUST NOT have any block indexes.
.sp .sp
Any update message which is being sent for a different \fBVersion\fP of the same Any update message which is being sent for a different \fBVersion\fP of the same
file name must be preceeded with an update message for the old version of that file name must be preceded with an update message for the old version of that
file with the \fBForget\fP bit set. file with the \fBForget\fP bit set.
.sp .sp
As a safeguard on the receiving side, value of \fBVersion\fP changing between As a safeguard on the receiving side, value of \fBVersion\fP changing between

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-CONFIG" "5" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-CONFIG" "5" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-config \- Syncthing Configuration syncthing-config \- Syncthing Configuration
. .
@ -81,8 +81,8 @@ The following shows the default configuration file:
.sp .sp
.nf .nf
.ft C .ft C
<configuration version="12"> <configuration version="14">
<folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true"> <folder id="zj2AA\-q55a7" label="Default Folder (zj2AA\-q55a7)" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device> <device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
<minDiskFreePct>1</minDiskFreePct> <minDiskFreePct>1</minDiskFreePct>
<versioning></versioning> <versioning></versioning>
@ -94,34 +94,35 @@ The following shows the default configuration file:
<scanProgressIntervalS>0</scanProgressIntervalS> <scanProgressIntervalS>0</scanProgressIntervalS>
<pullerSleepS>0</pullerSleepS> <pullerSleepS>0</pullerSleepS>
<pullerPauseS>0</pullerPauseS> <pullerPauseS>0</pullerPauseS>
<maxConflicts>0</maxConflicts> <maxConflicts>\-1</maxConflicts>
<disableSparseFiles>false</disableSparseFiles>
<disableTempIndexes>false</disableTempIndexes>
</folder> </folder>
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ" name="syno" compression="metadata" introducer="false"> <device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ" name="syno" compression="metadata" introducer="false">
<address>dynamic</address> <address>dynamic</address>
</device> </device>
<gui enabled="true" tls="false"> <gui enabled="true" tls="false">
<address>127.0.0.1:52620</address> <address>127.0.0.1:8384</address>
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey> <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
<theme>default</theme>
</gui> </gui>
<options> <options>
<listenAddress>tcp://0.0.0.0:22000</listenAddress> <listenAddress>default</listenAddress>
<globalAnnounceServer>default</globalAnnounceServer> <globalAnnounceServer>default</globalAnnounceServer>
<globalAnnounceEnabled>true</globalAnnounceEnabled> <globalAnnounceEnabled>true</globalAnnounceEnabled>
<localAnnounceEnabled>true</localAnnounceEnabled> <localAnnounceEnabled>true</localAnnounceEnabled>
<localAnnouncePort>21027</localAnnouncePort> <localAnnouncePort>21027</localAnnouncePort>
<localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr> <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
<relayServer>dynamic+https://relays.syncthing.net/endpoint</relayServer>
<maxSendKbps>0</maxSendKbps> <maxSendKbps>0</maxSendKbps>
<maxRecvKbps>0</maxRecvKbps> <maxRecvKbps>0</maxRecvKbps>
<reconnectionIntervalS>60</reconnectionIntervalS> <reconnectionIntervalS>60</reconnectionIntervalS>
<relaysEnabled>true</relaysEnabled> <relaysEnabled>true</relaysEnabled>
<relayReconnectIntervalM>10</relayReconnectIntervalM> <relayReconnectIntervalM>10</relayReconnectIntervalM>
<relayWithoutGlobalAnn>false</relayWithoutGlobalAnn>
<startBrowser>true</startBrowser> <startBrowser>true</startBrowser>
<upnpEnabled>true</upnpEnabled> <natEnabled>true</natEnabled>
<upnpLeaseMinutes>60</upnpLeaseMinutes> <natLeaseMinutes>60</natLeaseMinutes>
<upnpRenewalMinutes>30</upnpRenewalMinutes> <natRenewalMinutes>30</natRenewalMinutes>
<upnpTimeoutSeconds>10</upnpTimeoutSeconds> <natTimeoutSeconds>10</natTimeoutSeconds>
<urAccepted>0</urAccepted> <urAccepted>0</urAccepted>
<urUniqueID></urUniqueID> <urUniqueID></urUniqueID>
<urURL>https://data.syncthing.net/newdata</urURL> <urURL>https://data.syncthing.net/newdata</urURL>
@ -130,13 +131,14 @@ The following shows the default configuration file:
<restartOnWakeup>true</restartOnWakeup> <restartOnWakeup>true</restartOnWakeup>
<autoUpgradeIntervalH>12</autoUpgradeIntervalH> <autoUpgradeIntervalH>12</autoUpgradeIntervalH>
<keepTemporariesH>24</keepTemporariesH> <keepTemporariesH>24</keepTemporariesH>
<cacheIgnoredFiles>true</cacheIgnoredFiles> <cacheIgnoredFiles>false</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS> <progressUpdateIntervalS>5</progressUpdateIntervalS>
<symlinksEnabled>true</symlinksEnabled> <symlinksEnabled>true</symlinksEnabled>
<limitBandwidthInLan>false</limitBandwidthInLan> <limitBandwidthInLan>false</limitBandwidthInLan>
<databaseBlockCacheMiB>0</databaseBlockCacheMiB>
<minHomeDiskFreePct>1</minHomeDiskFreePct> <minHomeDiskFreePct>1</minHomeDiskFreePct>
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL> <releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
<tempIndexMinBlocks>10</tempIndexMinBlocks>
</options> </options>
</configuration> </configuration>
.ft P .ft P
@ -158,7 +160,7 @@ migration from previous formats.
.sp .sp
.nf .nf
.ft C .ft C
<folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true"> <folder id="zj2AA\-q55a7" label="Default Folder (zj2AA\-q55a7)" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" ignorePerms="false" autoNormalize="true" ro="false">
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device> <device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
<minDiskFreePct>1</minDiskFreePct> <minDiskFreePct>1</minDiskFreePct>
<versioning></versioning> <versioning></versioning>
@ -170,7 +172,9 @@ migration from previous formats.
<scanProgressIntervalS>0</scanProgressIntervalS> <scanProgressIntervalS>0</scanProgressIntervalS>
<pullerSleepS>0</pullerSleepS> <pullerSleepS>0</pullerSleepS>
<pullerPauseS>0</pullerPauseS> <pullerPauseS>0</pullerPauseS>
<maxConflicts>0</maxConflicts> <maxConflicts>\-1</maxConflicts>
<disableSparseFiles>false</disableSparseFiles>
<disableTempIndexes>false</disableTempIndexes>
</folder> </folder>
.ft P .ft P
.fi .fi
@ -185,13 +189,25 @@ element:
.B id .B id
The folder ID, must be unique. (mandatory) The folder ID, must be unique. (mandatory)
.TP .TP
.B label
The label of a folder is a human readable and descriptive local name.
Can be different on each device. (optional)
.TP
.B path .B path
The path to the directory where the folder is stored on this The path to the directory where the folder is stored on this
device; not sent to other devices. (mandatory) device; not sent to other devices. (mandatory)
.TP .TP
.B ro .B type
True if the folder is read only (Master mode; will not be modified by Controls how the folder is handled by Syncthing. Possible values are:
Syncthing) on this device. .INDENT 7.0
.TP
.B readwrite
The folder is in default mode. Sending local and accepting remote changes.
.TP
.B readonly
The folder is in "master" mode \-\- it will not be modified by
syncthing on this device.
.UNINDENT
.TP .TP
.B rescanIntervalS .B rescanIntervalS
The rescan interval, in seconds. Can be set to zero to disable when external The rescan interval, in seconds. Can be set to zero to disable when external
@ -274,6 +290,16 @@ what you\(aqre doing.
The maximum number of conflict copies to keep around for any given file. The maximum number of conflict copies to keep around for any given file.
The default, \-1, means an unlimited number. Setting this to zero disables The default, \-1, means an unlimited number. Setting this to zero disables
conflict copies altogether. conflict copies altogether.
.TP
.B disableSparseFiles
By default, blocks containing all zeroes are not written, causing files
to be sparse on filesystems that support the concept. When set to true,
sparse files will not be created.
.TP
.B disableTempIndexes
By default, devices exchange information about blocks available in
transfers that are still in progress. When set to true, such information
is not exchanged for this folder.
.UNINDENT .UNINDENT
.SH DEVICE ELEMENT .SH DEVICE ELEMENT
.INDENT 0.0 .INDENT 0.0
@ -384,6 +410,7 @@ This optional element lists device IDs that have been specifically ignored. One
<gui enabled="true" tls="false"> <gui enabled="true" tls="false">
<address>127.0.0.1:8384</address> <address>127.0.0.1:8384</address>
<apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey> <apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
<theme>default</theme>
</gui> </gui>
.ft P .ft P
.fi .fi
@ -402,6 +429,9 @@ If not \fBtrue\fP, the GUI and API will not be started.
If set to \fBtrue\fP, TLS (HTTPS) will be enforced. Non\-HTTPS requests will If set to \fBtrue\fP, TLS (HTTPS) will be enforced. Non\-HTTPS requests will
be redirected to HTTPS. When this is set to \fBfalse\fP, TLS connections are be redirected to HTTPS. When this is set to \fBfalse\fP, TLS connections are
still possible but it is not mandatory. still possible but it is not mandatory.
.TP
.B theme
The name of the theme to use.
.UNINDENT .UNINDENT
.sp .sp
The following child elements may be present: The following child elements may be present:
@ -415,16 +445,10 @@ Allowed address formats are:
.B IPv4 address and port (\fB127.0.0.1:8384\fP) .B IPv4 address and port (\fB127.0.0.1:8384\fP)
The address and port is used as given. The address and port is used as given.
.TP .TP
.B IPv4 wildcard and port (\fBtcp4://0.0.0.0\fP, \fBtcp4://:8384\fP)
These are equivalent and will result in Syncthing listening on all interfaces via IPv4 only.
.TP
.B IPv6 address and port (\fB[::1]:8384\fP) .B IPv6 address and port (\fB[::1]:8384\fP)
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.
.TP .TP
.B IPv6 wildcard and port (\fBtcp6://[::]:8384\fP, \fBtcp6://:8384\fP)
These are equivalent and will result in Syncthing listening on all interfaces via IPv6 only.
.TP
.B Wildcard and port (\fB0.0.0.0:12345\fP, \fB[::]:12345\fP, \fB:12345\fP) .B Wildcard and port (\fB0.0.0.0:12345\fP, \fB[::]:12345\fP, \fB:12345\fP)
These are equivalent and will result in Syncthing listening on all These are equivalent and will result in Syncthing listening on all
interfaces via both IPv4 and IPv6. interfaces via both IPv4 and IPv6.
@ -446,24 +470,22 @@ If set, this is the API key that enables usage of the REST interface.
.nf .nf
.ft C .ft C
<options> <options>
<listenAddress>tcp://0.0.0.0:22000</listenAddress> <listenAddress>default</listenAddress>
<globalAnnounceServer>default</globalAnnounceServer> <globalAnnounceServer>default</globalAnnounceServer>
<globalAnnounceEnabled>true</globalAnnounceEnabled> <globalAnnounceEnabled>true</globalAnnounceEnabled>
<localAnnounceEnabled>true</localAnnounceEnabled> <localAnnounceEnabled>true</localAnnounceEnabled>
<localAnnouncePort>21027</localAnnouncePort> <localAnnouncePort>21027</localAnnouncePort>
<localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr> <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
<relayServer>dynamic+https://relays.syncthing.net/endpoint</relayServer>
<maxSendKbps>0</maxSendKbps> <maxSendKbps>0</maxSendKbps>
<maxRecvKbps>0</maxRecvKbps> <maxRecvKbps>0</maxRecvKbps>
<reconnectionIntervalS>60</reconnectionIntervalS> <reconnectionIntervalS>60</reconnectionIntervalS>
<relaysEnabled>true</relaysEnabled> <relaysEnabled>true</relaysEnabled>
<relayReconnectIntervalM>10</relayReconnectIntervalM> <relayReconnectIntervalM>10</relayReconnectIntervalM>
<relayWithoutGlobalAnn>false</relayWithoutGlobalAnn>
<startBrowser>true</startBrowser> <startBrowser>true</startBrowser>
<upnpEnabled>true</upnpEnabled> <natEnabled>true</natEnabled>
<upnpLeaseMinutes>60</upnpLeaseMinutes> <natLeaseMinutes>60</natLeaseMinutes>
<upnpRenewalMinutes>30</upnpRenewalMinutes> <natRenewalMinutes>30</natRenewalMinutes>
<upnpTimeoutSeconds>10</upnpTimeoutSeconds> <natTimeoutSeconds>10</natTimeoutSeconds>
<urAccepted>0</urAccepted> <urAccepted>0</urAccepted>
<urUniqueID></urUniqueID> <urUniqueID></urUniqueID>
<urURL>https://data.syncthing.net/newdata</urURL> <urURL>https://data.syncthing.net/newdata</urURL>
@ -472,13 +494,14 @@ If set, this is the API key that enables usage of the REST interface.
<restartOnWakeup>true</restartOnWakeup> <restartOnWakeup>true</restartOnWakeup>
<autoUpgradeIntervalH>12</autoUpgradeIntervalH> <autoUpgradeIntervalH>12</autoUpgradeIntervalH>
<keepTemporariesH>24</keepTemporariesH> <keepTemporariesH>24</keepTemporariesH>
<cacheIgnoredFiles>true</cacheIgnoredFiles> <cacheIgnoredFiles>false</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS> <progressUpdateIntervalS>5</progressUpdateIntervalS>
<symlinksEnabled>true</symlinksEnabled> <symlinksEnabled>true</symlinksEnabled>
<limitBandwidthInLan>false</limitBandwidthInLan> <limitBandwidthInLan>false</limitBandwidthInLan>
<databaseBlockCacheMiB>0</databaseBlockCacheMiB>
<minHomeDiskFreePct>1</minHomeDiskFreePct> <minHomeDiskFreePct>1</minHomeDiskFreePct>
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL> <releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
<tempIndexMinBlocks>10</tempIndexMinBlocks>
</options> </options>
.ft P .ft P
.fi .fi
@ -489,10 +512,8 @@ The \fBoptions\fP element contains all other global configuration options.
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B listenAddress .B listenAddress
The listen address for incoming sync connections. See the \fBaddress\fP The listen address for incoming sync connections. See
element under the \fI\%GUI Element\fP for allowed syntax, with the addition \fI\%Listen Addresses\fP for allowed syntax.
that the address must have a protocol scheme prefix. Currently \fBtcp://\fP
is the only supported protocol scheme.
.TP .TP
.B globalAnnounceServer .B globalAnnounceServer
A URI to a global announce (discovery) server, or the word \fBdefault\fP to A URI to a global announce (discovery) server, or the word \fBdefault\fP to
@ -539,25 +560,20 @@ When true, relays will be connected to and potentially used for device to device
.B relayReconnectIntervalM .B relayReconnectIntervalM
Sets the interval, in minutes, between relay reconnect attempts. Sets the interval, in minutes, between relay reconnect attempts.
.TP .TP
.B relayWithoutGlobalAnn
When set to true, relay connections will be attempted even when global
discovery is disabled. This is useful only in the case where devices are
known to be connected to the same relays. The default is \fBfalse\fP\&.
.TP
.B startBrowser .B startBrowser
Whether to attempt to start a browser to show the GUI when Syncthing starts. Whether to attempt to start a browser to show the GUI when Syncthing starts.
.TP .TP
.B upnpEnabled .B natEnabled
Whether to attempt to perform an UPnP port mapping for incoming sync Whether to attempt to perform an UPnP and NAT\-PMP port mapping for
connections. incoming sync connections.
.TP .TP
.B upnpLeaseMinutes .B natLeaseMinutes
Request a lease for this many minutes; zero to request a permanent lease. Request a lease for this many minutes; zero to request a permanent lease.
.TP .TP
.B upnpRenewalMinutes .B natRenewalMinutes
Attempt to renew the lease after this many minutes. Attempt to renew the lease after this many minutes.
.TP .TP
.B upnpTimeoutSeconds .B natTimeoutSeconds
When scanning for UPnP devices, wait this long for responses. When scanning for UPnP devices, wait this long for responses.
.TP .TP
.B urAccepted .B urAccepted
@ -594,8 +610,9 @@ Keep temporary failed transfers for this many hours. While the temporaries
are kept, the data they contain need not be transferred again. are kept, the data they contain need not be transferred again.
.TP .TP
.B cacheIgnoredFiles .B cacheIgnoredFiles
Whether to cache the results of ignore pattern evaluation. Performance at Whether to cache the results of ignore pattern evaluation. Performance
the price of memory. at the price of memory. Defaults to \fBfalse\fP as the cost for evaluating
ignores is usually not significant.
.TP .TP
.B progressUpdateIntervalS .B progressUpdateIntervalS
How often in seconds the progress of ongoing downloads is made available to How often in seconds the progress of ongoing downloads is made available to
@ -626,6 +643,63 @@ the configuration and index.
.TP .TP
.B releasesURL .B releasesURL
The URL from which release information is loaded, for automatic upgrades. The URL from which release information is loaded, for automatic upgrades.
.TP
.B overwriteRemoteDeviceNamesOnConnect
If set, device names will always be overwritten with the name given by
remote on each connection. By default, the name that the remote device
announces will only be adopted when a name has not already been set.
.TP
.B tempIndexMinBlocks
When exchanging index information for incomplete transfers, only take
into account files that have at least this many blocks.
.UNINDENT
.SS Listen Addresses
.sp
The following address types are accepted in sync protocol listen addresses:
.INDENT 0.0
.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
interfaces, IPv4 and IPv6, on the specified port.
.TP
.B TCP IPv4 wildcard and port (\fBtcp4://0.0.0.0:22000\fP, \fBtcp4://:22000\fP)
These are equivalent and will result in Syncthing listening on all
interfaces via IPv4 only.
.TP
.B TCP IPv4 address and port (\fBtcp4://192.0.2.1:22000\fP)
These are equivalent and will result in Syncthing listening on the
specified address and port only.
.TP
.B TCP IPv6 wildcard and port (\fBtcp6://[::]:22000\fP, \fBtcp6://:22000\fP)
These are equivalent and will result in Syncthing listening on all
interfaces via IPv6 only.
.TP
.B TCP IPv6 address and port (\fBtcp6://[2001:db8::42]:22000\fP)
These are equivalent and will result in Syncthing listening on the
specified address and port only.
.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.
.INDENT 7.0
.INDENT 3.5
.SS Todo
.sp
Document available URL parameters.
.UNINDENT
.UNINDENT
.TP
.B Dynamic relay pool (\fBdynamic+https://192.0.2.42/relays\fP)
Syncthing will fetch the specified HTTPS URL, parse it for a JSON payload
describing relays, select a relay from the available ones and listen via
that as if specified as a static relay above.
.INDENT 7.0
.INDENT 3.5
.SS Todo
.sp
Document available URL parameters.
.UNINDENT
.UNINDENT
.UNINDENT .UNINDENT
.SH SYNCING CONFIGURATION FILES .SH SYNCING CONFIGURATION FILES
.sp .sp

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-DEVICE-IDS" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-DEVICE-IDS" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-device-ids \- Understanding Device IDs syncthing-device-ids \- Understanding Device IDs
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-EVENT-API" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-EVENT-API" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-event-api \- Event API syncthing-event-api \- Event API
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-FAQ" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-FAQ" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-faq \- Frequently Asked Questions syncthing-faq \- Frequently Asked Questions
. .
@ -152,6 +152,11 @@ encrypted using AES\-128. When receiving data, it must be decrypted.
.IP 3. 3 .IP 3. 3
There is a certain amount of housekeeping that must be done to track the There is a certain amount of housekeeping that must be done to track the
current and available versions of each file in the index database. current and available versions of each file in the index database.
.IP 4. 3
By default Syncthing uses periodic scanning every 60 seconds to detect
file changes. This means checking every file\(aqs modification time and
comparing it to the database. This can cause spikes of CPU usage for large
folders.
.UNINDENT .UNINDENT
.sp .sp
Hashing, compression and encryption cost CPU time. Also, using the GUI Hashing, compression and encryption cost CPU time. Also, using the GUI
@ -164,6 +169,10 @@ environment variable \fBGOMAXPROCS\fP to the maximum number of CPU cores
Syncthing should use at any given moment. For example, \fBGOMAXPROCS=2\fP on a Syncthing should use at any given moment. For example, \fBGOMAXPROCS=2\fP on a
machine with four cores will limit Syncthing to no more than half the machine with four cores will limit Syncthing to no more than half the
system\(aqs CPU power. system\(aqs CPU power.
.sp
To reduce CPU spikes from scanning activity, use a filesystem notifications
plugin. This is delivered by default via Synctrayzor, Syncthing\-GTK and on
Android. For other setups, consider using \fI\%syncthing\-inotify\fP <\fBhttps://github.com/syncthing/syncthing-inotify\fP>\&.
.SS Should I keep my device IDs secret? .SS Should I keep my device IDs secret?
.sp .sp
No. The IDs are not sensitive. Given a device ID it\(aqs possible to find the IP No. The IDs are not sensitive. Given a device ID it\(aqs possible to find the IP

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-GLOBALDISCO" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-GLOBALDISCO" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3 syncthing-globaldisco \- Global Discovery Protocol v3
. .
@ -67,7 +67,7 @@ certificate was presented, status \fB403\fP (Forbidden) is returned. If the
posted data doesn\(aqt conform to the expected format, \fB400\fP (Bad Request) is posted data doesn\(aqt conform to the expected format, \fB400\fP (Bad Request) is
returned. returned.
.sp .sp
In successfull responses, the server may return a \fBReannounce\-After\fP header In successful responses, the server may return a \fBReannounce\-After\fP header
containing the number of seconds after which the client should perform a new containing the number of seconds after which the client should perform a new
announcement. announcement.
.sp .sp
@ -84,7 +84,7 @@ Queries are performed as HTTPS GET requests to the announce server URL. The
requested device ID is passed as the query parameter "device", in canonical requested device ID is passed as the query parameter "device", in canonical
string form, i.e. \fBhttps://announce.syncthing.net/?device=ABC12345\-....\fP string form, i.e. \fBhttps://announce.syncthing.net/?device=ABC12345\-....\fP
.sp .sp
Successfull responses will have status code \fB200\fP (OK) and carry a JSON payload Successful responses will have status code \fB200\fP (OK) and carry a JSON payload
of the same format as the announcement above. The response will not contain of the same format as the announcement above. The response will not contain
empty or unspecified addresses. empty or unspecified addresses.
.sp .sp

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-LOCALDISCO" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-LOCALDISCO" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-localdisco \- Local Discovery Protocol v3 syncthing-localdisco \- Local Discovery Protocol v3
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-NETWORKING" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-NETWORKING" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-networking \- Firewall Setup syncthing-networking \- Firewall Setup
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-RELAY" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-RELAY" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-relay \- Relay Protocol v1 syncthing-relay \- Relay Protocol v1
. .
@ -337,7 +337,7 @@ _
.TE .TE
.SH MESSAGES .SH MESSAGES
.sp .sp
All messages are preceeded by a header message. Header message contains the All messages are preceded by a header message. Header message contains the
magic value 0x9E79BC40, message type integer, and message length. magic value 0x9E79BC40, message type integer, and message length.
.sp .sp
\fBWARNING:\fP \fBWARNING:\fP

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-REST-API" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-REST-API" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-rest-api \- REST API syncthing-rest-api \- REST API
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-SECURITY" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-SECURITY" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-security \- Security Principles syncthing-security \- Security Principles
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING-STIGNORE" "5" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING-STIGNORE" "5" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes syncthing-stignore \- Prevent files from being synchronized to other nodes
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "TODO" "7" "May 01, 2016" "v0.12" "Syncthing" .TH "TODO" "7" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
Todo \- Keep automatic backups of deleted files by other nodes Todo \- Keep automatic backups of deleted files by other nodes
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "SYNCTHING" "1" "May 01, 2016" "v0.12" "Syncthing" .TH "SYNCTHING" "1" "May 17, 2016" "v0.12" "Syncthing"
.SH NAME .SH NAME
syncthing \- Syncthing syncthing \- Syncthing
. .