Translation and docs update

2015-06-14 13:52:00 +02:00
parent a162157301
commit 1437952aee
39 changed files with 441 additions and 212 deletions
--- a/man/syncthing-config.5
+++ b/man/syncthing-config.5
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-CONFIG" "5" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-CONFIG" "5" "June 14, 2015" "v0.11" "Syncthing"
 .SH NAME
 syncthing-config \- Syncthing Configuration
 .
--- 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" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-DEVICE-IDS" "7" "June 14, 2015" "v0.11" "Syncthing"
 .SH NAME
 syncthing-device-ids \- Understanding Device IDs
 .
@@ -131,7 +131,7 @@ grouped with dashes, resulting in the final value:
 .sp
 .nf
 .ft C
-MFZWI3D\-BONSGYC\-YLTMRWG\-C43ENR5 \-QXGZDMM\-FZWI3DP\-BONSGYY\-LTMRWAD
+MFZWI3D\-BONSGYC\-YLTMRWG\-C43ENR5\-QXGZDMM\-FZWI3DP\-BONSGYY\-LTMRWAD
 .ft P
 .fi
 .UNINDENT
--- 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" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-EVENT-API" "7" "June 14, 2015" "v0.11" "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" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-FAQ" "7" "June 14, 2015" "v0.11" "Syncthing"
 .SH NAME
 syncthing-faq \- Frequently Asked Questions
 .
@@ -52,12 +52,14 @@ some of the same things, namely syncing files between two or more computers.
 .sp
 BitTorrent Sync by BitTorrent, Inc is a proprietary peer\-to\-peer file
 synchronization tool available for Windows, Mac, Linux, Android, iOS, Windows
-Phone, Amazon Kindle Fire and BSD. \fI\%1\fP <\fBhttp://en.wikipedia.org/wiki/BitTorrent_Sync\fP> Syncthing is an open source
-file synchronization tool.
+Phone, Amazon Kindle Fire and BSD. [1] Syncthing is an open source file
+synchronization tool.
 .sp
 Syncthing uses an open and documented protocol, and likewise the security
 mechanisms in use are well defined and visible in the source code. BitTorrent
 Sync uses an undocumented, closed protocol with unknown security properties.
+.IP [1] 5
+\fI\%http://en.wikipedia.org/wiki/BitTorrent_Sync\fP
 .SH USAGE
 .SS What things are synced?
 .sp
--- a/man/syncthing-networking.7
+++ b/man/syncthing-networking.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-NETWORKING" "7" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-NETWORKING" "7" "June 14, 2015" "v0.11" "Syncthing"
 .SH NAME
 syncthing-networking \- Firewall Setup
 .
--- 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" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-REST-API" "7" "June 14, 2015" "v0.11" "Syncthing"
 .SH NAME
 syncthing-rest-api \- REST API
 .
@@ -197,10 +197,20 @@ Due to being a POST request, this method requires using an API key or CSRF token
 .UNINDENT
 .SS POST /rest/system/reset
 .sp
-Post with empty body to immediately \fIreset\fP Syncthing. This means
-renaming all folder directories to temporary, unique names, wiping all
-indexes and restarting. This should probably not be used during normal
-operations...
+Post with empty body to erase the current index database and restart
+Syncthing. With no query parameters, the entire database is erased from disk.
+By specifying the \fBfolder\fP parameter with a valid folder ID, only
+information for that folder will be erased:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ curl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/system/reset?folder=default
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
 .SS POST /rest/system/restart
 .sp
 Post with empty body to immediately restart Syncthing.
--- a/man/syncthing-security.7
+++ b/man/syncthing-security.7
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-SECURITY" "7" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-SECURITY" "7" "June 14, 2015" "v0.11" "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" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING-STIGNORE" "5" "June 14, 2015" "v0.11" "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 "TODO" "7" "June 07, 2015" "v0.11" "Syncthing"
+.TH "TODO" "7" "June 14, 2015" "v0.11" "Syncthing"
 .SH NAME
 Todo \- Keep automatic backups of deleted files by other nodes
 .
@@ -38,18 +38,26 @@ External versioning needs example for Windows.
 .UNINDENT
 .SH DESCRIPTION
 .sp
-There are 3 types of File Versioning. When you select each in the web interface,
-a short description of each is shown to help you decide.
-.SH NO FILE VERSIONING
+Syncthing supports archiving the old version of a file when it is deleted or
+replaced with a newer version from the cluster. This is called "file
+versioning" and uses one of the available \fIversioning strategies\fP described
+below. File versioning is configured per folder and defaults to "no file
+versioning", i.e. no old copies of files are kept.
+.SH TRASH CAN FILE VERSIONING
 .sp
-This is the default setting. With no file versioning, files that are replaced or
-deleted on one device are deleted on other devices that the directory is shared
-with. (Note: If a folder is marked "Master Folder" on a device, that device will
-not accept changes to the files in the folder, and therefore will not have files
-replaced or deleted.)
+This versioning strategy emulates the common "trash can" approach. When a file
+is deleted or replaced due to a change on a remote device, it is a moved to
+the trash can in the \fB\&.stversions\fP folder. If a file with the same name was
+already in the trash can it is replaced.
+.sp
+A configuration option is available to clean the trash can from files older
+than a specified number of days. If this is set to a positive number of days,
+files will be removed when they have been in the trash can that long. Setting
+this to zero prevents any files from being removed from the trash can
+automatically.
 .SH SIMPLE FILE VERSIONING
 .sp
-With "Simple File Versioning" files are moved to the ".stversions" folder
+With "Simple File Versioning" files are moved to the \fB\&.stversions\fP folder
 (inside your shared folder) when replaced or deleted on a remote device. This
 option also takes a value in an input titled "Keep Versions" which tells
 Syncthing how many old versions of the file it should keep. For example, if
@@ -64,7 +72,7 @@ Versioning"), however, versions are automatically deleted if they are older
 than the maximum age or exceed the number of files allowed in an interval.
 .sp
 With this versioning method it\(aqs possible to specify where the versions are
-stored, with the default being the \fI\&.stversions\fP folder inside the normal
+stored, with the default being the \fB\&.stversions\fP folder inside the normal
 folder path. If you set a custom version path, please ensure that it\(aqs on the
 same partition or filesystem as the regular folder path, as moving files there
 may otherwise fail. You can use an absolute path (this is recommended) or a
--- a/man/syncthing.1
+++ b/man/syncthing.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING" "1" "June 07, 2015" "v0.11" "Syncthing"
+.TH "SYNCTHING" "1" "June 14, 2015" "v0.11" "Syncthing"
 .SH NAME
 syncthing \- Syncthing
 .
@@ -56,26 +56,38 @@ your machines as soon as they are online at the same time.
 .SH OPTIONS
 .INDENT 0.0
 .TP
-.B \fB\-audit\fP
+.B \-audit
 Write events to audit file.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-generate=<dir>\fP
+.B \-generate=<dir>
 Generate key and config in specified dir, then exit.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-gui\-address=<address>\fP
+.B \-gui\-address=<address>
 Override GUI address.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-gui\-apikey=<key>\fP
+.B \-gui\-apikey=<key>
 Override GUI API key.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-gui\-authentication=<username:password>\fP
+.B \-gui\-authentication=<username:password>
 Override GUI authentication; username:password.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-home=<dir>\fP
+.B \-home=<dir>
 Set configuration directory. The default configuration directory is:
 \fB$HOME/.config/syncthing\fP\&.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-logflags=<flags>\fP
+.B \-logflags=<flags>
 Select information in log line prefix, default 2. The \fB\-logflags\fP value is
 a sum of the following:
 .INDENT 7.0
@@ -94,29 +106,45 @@ a sum of the following:
 To prefix each log line with date and time, set \fB\-logflags=3\fP (1 + 2 from
 above). The value 0 is used to disable all of the above. The default is to
 show time only (2).
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-no\-browser\fP
+.B \-no\-browser
 Do not start a browser.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-no\-restart\fP
+.B \-no\-restart
 Do not restart; just exit.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-reset\fP
+.B \-reset
 Reset the database.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-upgrade\fP
+.B \-upgrade
 Perform upgrade.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-upgrade\-check\fP
+.B \-upgrade\-check
 Check for available upgrade.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-upgrade\-to=<url>\fP
+.B \-upgrade\-to=<url>
 Force upgrade directly from specified URL.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-verbose\fP
+.B \-verbose
 Print verbose log output.
+.UNINDENT
+.INDENT 0.0
 .TP
-.B \fB\-version\fP
+.B \-version
 Show version.
 .UNINDENT
 .SH EXIT CODES
@@ -156,32 +184,45 @@ Directory to load GUI assets from. Overrides compiled in assets.
 A comma separated string of facilities to trace. The valid facility strings
 are:
 .INDENT 7.0
-.IP \(bu 2
-\fBbeacon\fP:   the beacon package
-.IP \(bu 2
-\fBdiscover\fP: the discover package
-.IP \(bu 2
-\fBevents\fP:   the events package
-.IP \(bu 2
-\fBfiles\fP:    the files package
-.IP \(bu 2
-\fBhttp\fP:     the main package; HTTP requests
-.IP \(bu 2
-\fBlocks\fP:    the sync package; trace long held locks
-.IP \(bu 2
-\fBnet\fP:      the main package; connections & network messages
-.IP \(bu 2
-\fBmodel\fP:    the model package
-.IP \(bu 2
-\fBscanner\fP:  the scanner package
-.IP \(bu 2
-\fBstats\fP:    the stats package
-.IP \(bu 2
-\fBupnp\fP:     the upnp package
-.IP \(bu 2
-\fBxdr\fP:      the xdr package
-.IP \(bu 2
-\fBall\fP:      all of the above
+.TP
+.B beacon
+the beacon package
+.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
+.TP
+.B model
+the model package
+.TP
+.B scanner
+the scanner package
+.TP
+.B stats
+the stats package
+.TP
+.B upnp
+the upnp package
+.TP
+.B xdr
+the xdr package
+.TP
+.B all
+all of the above
 .UNINDENT
 .TP
 .B STPROFILER