gui, man: Update docs & translations

This commit is contained in:
Jakob Borg
2017-01-10 08:41:14 +01:00
parent 1a1e35d998
commit c20c17e3c6
30 changed files with 247 additions and 131 deletions

View File

@@ -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