gui, man: Update docs & translations

2017-01-10 08:41:14 +01:00
parent 1a1e35d998
commit c20c17e3c6
30 changed files with 247 additions and 131 deletions
--- a/man/stdiscosrv.1
+++ b/man/stdiscosrv.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "STDISCOSRV" "1" "December 22, 2016" "v0.14" "Syncthing"
+.TH "STDISCOSRV" "1" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 stdiscosrv \- Syncthing Discovery Server
 .
--- a/man/strelaysrv.1
+++ b/man/strelaysrv.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "STRELAYSRV" "1" "December 22, 2016" "v0.14" "Syncthing"
+.TH "STRELAYSRV" "1" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 strelaysrv \- Syncthing Relay Server
 .
@@ -37,8 +37,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .nf
 .ft C
 strelaysrv [\-debug] [\-ext\-address=<address>] [\-global\-rate=<bytes/s>] [\-keys=<dir>] [\-listen=<listen addr>]
-           [\-message\-timeout=<duration>] [\-network\-timeout=<duration>] [\-per\-session\-rate=<bytes/s>]
-           [\-ping\-interval=<duration>] [\-pools=<pool addresses>] [\-provided\-by=<string>] [\-status\-srv=<listen addr>]
+           [\-message\-timeout=<duration>] [\-nat] [\-nat\-lease=<duration> [\-nat\-renewal=<duration>]
+           [\-nat\-timeout=<duration>] [\-network\-timeout=<duration>] [\-per\-session\-rate=<bytes/s>]
+           [\-ping\-interval=<duration>] [\-pools=<pool addresses>] [\-protocol=<string>] [\-provided\-by=<string>]
+           [\-status\-srv=<listen addr>]
 .ft P
 .fi
 .UNINDENT
@@ -84,6 +86,32 @@ Maximum amount of time we wait for relevant messages to arrive (default 1m0s).
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-nat
+Use UPnP/NAT\-PMP to acquire external port mapping
+.UNINDENT
+.sp
+\&..cmdoption:: \-nat\-lease=<duration>
+.INDENT 0.0
+.INDENT 3.5
+NAT lease length in minutes (default 60)
+.UNINDENT
+.UNINDENT
+.sp
+\&..cmdoption:: \-nat\-renewal=<duration>
+.INDENT 0.0
+.INDENT 3.5
+NAT renewal frequency in minutes (default 30)
+.UNINDENT
+.UNINDENT
+.sp
+\&..cmdoption:: \-nat\-timeout=<duration>
+.INDENT 0.0
+.INDENT 3.5
+NAT discovery timeout in seconds (default 10)
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-network\-timeout=<duration>
 Timeout for network operations between the client and the relay. If no data
 is received between the client and the relay in this period of time, the
@@ -110,6 +138,11 @@ a pool, thereby remaining a private relay.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-protocol=<string>
+Protocol used for listening. \(aqtcp\(aq for IPv4 and IPv6, \(aqtcp4\(aq for IPv4, \(aqtcp6\(aq for IPv6 (default "tcp").
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-provided\-by=<string>
 An optional description about who provides the relay.
 .UNINDENT
@@ -147,6 +180,23 @@ global relay pool, unless a \fB\-pools=""\fP argument is given.
 .sp
 To make the relay server start automatically at boot, use the recommended
 procedure for your operating system.
+.SS Client configuration
+.sp
+Syncthing can be configured to use specific relay servers (exclusively of the public pool) by adding the required servers to the Sync Protocol Listen Address field, under Actions and Settings. The format is as follows:
+.INDENT 0.0
+.INDENT 3.5
+relay://<host name|IP>[:port]/?id=<relay device ID>
+.UNINDENT
+.UNINDENT
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+relay://private\-relay\-1.example.com:443/?id=ITZRNXE\-YNROGBZ\-HXTH5P7\-VK5NYE5\-QHRQGE2\-7JQ6VNJ\-KZUEDIU\-5PPR5AM
+.UNINDENT
+.UNINDENT
+.sp
+The relay\(aqs device ID is output on start\-up.
 .SS Running on port 443 as an unprivileged user
 .sp
 It is recommended that you run the relay on port 443 (or another port which is
--- a/man/syncthing-bep.7
+++ b/man/syncthing-bep.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-BEP" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-BEP" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-bep \- Block Exchange Protocol v1
 .
@@ -748,9 +748,9 @@ directions.
 .fi
 .UNINDENT
 .UNINDENT
-.SS Read Only
+.SS Send Only
 .sp
-In read only mode, a device does not apply any updates from the cluster, but
+In send\-only mode, a device does not apply any updates from the cluster, but
 publishes changes of its local folder to the cluster as usual. The local
 folder can be seen as a "master copy" that is never affected by the actions
 of other cluster devices.
--- a/man/syncthing-config.5
+++ b/man/syncthing-config.5
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-CONFIG" "5" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-CONFIG" "5" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-config \- Syncthing Configuration
 .
@@ -208,7 +208,7 @@ Controls how the folder is handled by Syncthing. Possible values are:
 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
+The folder is in "send\-only" mode \-\- it will not be modified by
 Syncthing on this device.
 .UNINDENT
 .TP
@@ -363,6 +363,15 @@ Disable all compression.
 .B introducer
 Set to true if this device should be trusted as an introducer, i.e. we
 should copy their list of devices per folder when connecting.
+.UNINDENT
+.sp
+\fBSEE ALSO:\fP
+.INDENT 0.0
+.INDENT 3.5
+introducer
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
 .TP
 .B skipIntroductionRemovals
 Set to true if you wish to follow only introductions and not de\-introductions.
@@ -722,14 +731,14 @@ accidentally if you sync your home folder between devices. A common symptom
 of syncing configuration files is two devices ending up with the same Device ID.
 .sp
 If you want to use Syncthing to backup your configuration files, it is recommended
-that the files you are backing up are in a folder\-master to prevent other
+that the files you are backing up are in a folder\-sendonly to prevent other
 devices from overwriting the per device configuration. The folder on the remote
 device(s) should not be used as configuration for the remote devices.
 .sp
-If you\(aqd like to sync your home folder in non\-master mode, you may add the
+If you\(aqd like to sync your home folder in non\-send\-only mode, you may add the
 folder that stores the configuration files to the ignore list\&.
 If you\(aqd also like to backup your configuration files, add another folder in
-master mode for just the configuration folder.
+send\-only mode for just the configuration folder.
 .SH AUTHOR
 The Syncthing Authors
 .SH COPYRIGHT
--- a/man/syncthing-device-ids.7
+++ b/man/syncthing-device-ids.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-DEVICE-IDS" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-DEVICE-IDS" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-device-ids \- Understanding Device IDs
 .
--- a/man/syncthing-event-api.7
+++ b/man/syncthing-event-api.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-EVENT-API" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-EVENT-API" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-event-api \- Event API
 .
--- a/man/syncthing-faq.7
+++ b/man/syncthing-faq.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-FAQ" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-FAQ" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-faq \- Frequently Asked Questions
 .
--- a/man/syncthing-globaldisco.7
+++ b/man/syncthing-globaldisco.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-GLOBALDISCO" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-GLOBALDISCO" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-globaldisco \- Global Discovery Protocol v3
 .
--- a/man/syncthing-localdisco.7
+++ b/man/syncthing-localdisco.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-LOCALDISCO" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-LOCALDISCO" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-localdisco \- Local Discovery Protocol v4
 .
--- a/man/syncthing-networking.7
+++ b/man/syncthing-networking.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-NETWORKING" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-NETWORKING" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-networking \- Firewall Setup
 .
--- a/man/syncthing-relay.7
+++ b/man/syncthing-relay.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-RELAY" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-RELAY" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-relay \- Relay Protocol v1
 .
--- a/man/syncthing-rest-api.7
+++ b/man/syncthing-rest-api.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-REST-API" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-REST-API" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-rest-api \- REST API
 .
@@ -776,7 +776,7 @@ This is an expensive call, increasing CPU and RAM usage on the device. Use spari
 .UNINDENT
 .SS POST /rest/db/override
 .sp
-Request override of a master folder.
+Request override of a send\-only folder.
 Takes the mandatory parameter \fIfolder\fP (folder ID).
 .INDENT 0.0
 .INDENT 3.5
--- a/man/syncthing-security.7
+++ b/man/syncthing-security.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-SECURITY" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-SECURITY" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-security \- Security Principles
 .
--- a/man/syncthing-stignore.5
+++ b/man/syncthing-stignore.5
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-STIGNORE" "5" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-STIGNORE" "5" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-stignore \- Prevent files from being synchronized to other nodes
 .
--- a/man/syncthing-versioning.7
+++ b/man/syncthing-versioning.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-VERSIONING" "7" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING-VERSIONING" "7" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-versioning \- Keep automatic backups of deleted files by other nodes
 .
--- a/man/syncthing.1
+++ b/man/syncthing.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING" "1" "December 22, 2016" "v0.14" "Syncthing"
+.TH "SYNCTHING" "1" "January 07, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing \- Syncthing
 .
@@ -37,9 +37,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .nf
 .ft C
 syncthing [\-audit] [\-browser\-only] [\-generate=<dir>] [\-gui\-address=<address>] [\-gui\-apikey=<key>]
-          [\-home=<dir>] [\-logfile=<filename>] [\-logflags=<flags>] [\-no\-browser]
-          [\-no\-console] [\-no\-restart] [\-paths] [\-paused] [\-reset] [\-upgrade] [\-upgrade\-check]
-          [\-upgrade\-to=<url>] [\-verbose] [\-version]
+          [\-home=<dir>] [\-logfile=<filename>] [\-logflags=<flags>] [\-no\-browser] [\-no\-console]
+          [\-no\-restart] [\-paths] [\-paused] [\-reset\-database] [\-reset\-deltas] [\-upgrade]
+          [\-upgrade\-check] [\-upgrade\-to=<url>] [\-verbose] [\-version]
 .ft P
 .fi
 .UNINDENT
@@ -123,8 +123,13 @@ Print the paths used for configuration, keys, database, GUI overrides, default s
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-reset
-Reset the database.
+.B \-reset\-database
+Reset the database, forcing a full rescan and resync.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-reset\-deltas
+Reset delta index IDs, forcing a full index exchange.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -185,7 +190,7 @@ exit. For example, \fB128 + 9 (SIGKILL) = 137\fP\&.
 .sp
 The following environment variables modify Syncthing\(aqs behavior in ways that
 are mostly useful for developers. Use with care.
-If you start syncthing from within service managers like systemd or supervisor
+If you start Syncthing from within service managers like systemd or supervisor,
 path expansion may not be supported.
 .INDENT 0.0
 .TP
@@ -197,48 +202,87 @@ variable will be ignored anytime after the first run.
 Directory to load GUI assets from. Overrides compiled in assets.
 .TP
 .B STTRACE
-A comma separated string of facilities to trace. The valid facility strings
+Used to increase the debugging verbosity in specific or all facilities, generally mapping to a Go package. Enabling any of these also enables microsecond timestamps, file names plus line numbers. Enter a comma\-separated string of facilities to trace. \fBsyncthing \-help\fP always outputs an up\-to\-date list. The valid facility strings
 are:
 .INDENT 7.0
 .TP
-.B beacon
-the beacon package
+.B Main and operational facilities:
+.INDENT 7.0
 .TP
-.B discover
-the discover package
-.TP
-.B events
-the events package
-.TP
-.B files
-the files package
-.TP
-.B http
-the main package; HTTP requests
-.TP
-.B locks
-the sync package; trace long held locks
-.TP
-.B net
-the main package; connections & network messages
+.B main
+Main package.
 .TP
 .B model
-the model package
+The root hub; the largest chunk of the system. File pulling, index transmission and requests for chunks.
+.TP
+.B config
+Configuration loading and saving.
+.TP
+.B db
+The database layer.
 .TP
 .B scanner
-the scanner package
+File change detection and hashing.
 .TP
-.B stats
-the stats package
+.B versioner
+File versioning.
+.UNINDENT
+.TP
+.B Networking facilities:
+.INDENT 7.0
+.TP
+.B beacon
+Multicast and broadcast discovery packets.
+.TP
+.B connections
+Connection handling.
+.TP
+.B dialer
+Dialing connections.
+.TP
+.B discover
+Remote device discovery requests, replies and registration of devices.
+.TP
+.B relay
+Relay interaction.
+.TP
+.B protocol
+The BEP protocol.
+.TP
+.B nat
+NAT discovery and port mapping.
+.TP
+.B pmp
+NAT\-PMP discovery and port mapping.
 .TP
 .B upnp
-the upnp package
+UPnP discovery and port mapping.
+.UNINDENT
 .TP
-.B xdr
-the xdr package
+.B Other facilities:
+.INDENT 7.0
+.TP
+.B events
+Event generation and logging.
+.TP
+.B http
+REST API.
+.TP
+.B sha256
+SHA256 hashing package (this facility currently unused).
+.TP
+.B stats
+Persistent device and folder statistics.
+.TP
+.B sync
+Mutexes. Used for debugging race conditions and deadlocks.
+.TP
+.B upgrade
+Binary upgrades.
 .TP
 .B all
-all of the above
+All of the above.
+.UNINDENT
 .UNINDENT
 .TP
 .B STPROFILER
@@ -259,9 +303,22 @@ Write block profiles to \fBblock\-$pid\-$timestamp.pprof\fP every 20 seconds.
 Write running performance statistics to \fBperf\-$pid.csv\fP\&. Not supported on
 Windows.
 .TP
+.B STDEADLOCK
+Placeholder
+.TP
+.B STDEADLOCKTIMEOUT
+Placeholder
+.TP
+.B STDEADLOCKTHRESHOLD
+Placeholder
+.TP
 .B STNOUPGRADE
 Disable automatic upgrades.
 .TP
+.B STHASHING
+Specifiy which hashing package to use. Defaults to automatic based on
+peformance. Specify "minio" (compatibility) or "standard" for the default Go implementation.
+.TP
 .B GOMAXPROCS
 Set the maximum number of CPU cores to use. Defaults to all available CPU
 cores.
@@ -269,7 +326,7 @@ cores.
 .B GOGC
 Percentage of heap growth at which to trigger GC. Default is 100. Lower
 numbers keep peak memory usage down, at the price of CPU usage
-(ie. performance).
+(i.e. performance).
 .UNINDENT
 .SH SEE ALSO
 .sp