Browse Source

gui, man: Update docs & translations

Jakob Borg 8 years ago
parent
commit
b99e92bad7

+ 2 - 2
gui/default/assets/lang/lang-de.json

@@ -188,8 +188,8 @@
     "Scan Time Remaining": "Zeit für Scan verbleibend",
     "Scanning": "Scannen",
     "See external versioner help for supported templated command line parameters.": "Siehe externe Versionshilfe für unterstützte Befehlszeilenparameter.",
-    "See external versioning help for supported templated command line parameters.": "Siehe externe Versionshilfe für unterstützte Befehlszeilenparameter.",
-    "Select a version": "Version auswählen",
+    "See external versioning help for supported templated command line parameters.": "Siehe Hilfe zur externen Versionierung für unterstützte Befehlszeilenparameter.",
+    "Select a version": "Wähle eine Version",
     "Select the devices to share this folder with.": "Wähle die Geräte aus, mit denen Du diesen Ordner teilen willst.",
     "Select the folders to share with this device.": "Wähle die Ordner aus, die Du mit diesem Gerät teilen möchtest",
     "Send & Receive": "Senden & empfangen",

+ 2 - 2
gui/default/assets/lang/lang-fr.json

@@ -189,7 +189,7 @@
     "Scanning": "Analyse en cours",
     "See external versioner help for supported templated command line parameters.": "Voir l'aide sur la préservation externe des fichiers pour les paramètres supportés en lignes de commande dans les modèles.",
     "See external versioning help for supported templated command line parameters.": "Consulter l'aide à la gestion externe des versions pour voir les paramètres de ligne de commande supportés.",
-    "Select a version": "Sélectionnez une version",
+    "Select a version": "Choisissez une version",
     "Select the devices to share this folder with.": "Synchroniser avec :",
     "Select the folders to share with this device.": "Sélectionner les partages auxquels cet appareil doit participer :",
     "Send & Receive": "Envoi & réception",
@@ -259,7 +259,7 @@
     "Time": "Heure",
     "Trash Can File Versioning": "Style poubelle",
     "Type": "Type",
-    "Undecided (will prompt)": "Choix différé (Une question sera affichée)",
+    "Undecided (will prompt)": "Choix différé (Une question sera affichée plus tard)",
     "Unknown": "Inconnu",
     "Unshared": "Non partagé",
     "Unused": "Non utilisé",

+ 1 - 1
man/stdiscosrv.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "STDISCOSRV" "1" "September 08, 2017" "v0.14" "Syncthing"
+.TH "STDISCOSRV" "1" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 stdiscosrv \- Syncthing Discovery Server
 .

+ 1 - 1
man/strelaysrv.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "STRELAYSRV" "1" "September 08, 2017" "v0.14" "Syncthing"
+.TH "STRELAYSRV" "1" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 strelaysrv \- Syncthing Relay Server
 .

+ 1 - 1
man/syncthing-bep.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-BEP" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-BEP" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-bep \- Block Exchange Protocol v1
 .

+ 1 - 1
man/syncthing-config.5

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-CONFIG" "5" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-CONFIG" "5" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-config \- Syncthing Configuration
 .

+ 1 - 1
man/syncthing-device-ids.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-DEVICE-IDS" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-DEVICE-IDS" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-device-ids \- Understanding Device IDs
 .

+ 7 - 2
man/syncthing-event-api.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-EVENT-API" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-EVENT-API" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-event-api \- Event API
 .
@@ -37,7 +37,12 @@ core utility towards a GUI.
 .sp
 To receive events, perform a HTTP GET of \fB/rest/events\fP or
 \fB/rest/events/disk\fP\&. The latter returns only local\-change\-detected and
-remote\-change\-detected events, the former all other events.
+remote\-change\-detected events, the former all other events unless filtered.
+.sp
+To filter the event list, in effect creating a specific subscription for
+only the desired event types, add a parameter
+\fBevents=EventTypeA,EventTypeB,...\fP where the event types are any from the
+list below.
 .sp
 The optional parameter \fBsince=<lastSeenID>\fP sets the ID of the last event
 you\(aqve already seen. Syncthing returns a JSON encoded array of event objects,

+ 12 - 1
man/syncthing-faq.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-FAQ" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-FAQ" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-faq \- Frequently Asked Questions
 .
@@ -211,6 +211,17 @@ everywhere else and we don\(aqt know which of the conflicting files is the "best
 from the user point of view. Moreover, if there\(aqs something that automatically
 causes a conflict on change you\(aqll end up with \fBsync\-conflict\-...sync\-conflict
 \-...\-sync\-conflict\fP files.
+.SS How do I serve a folder from a read only filesystem?
+.sp
+Syncthing requires a "folder marker" to indicate that the folder is present
+and healthy. By default this is a directory called \fB\&.stfolder\fP that is
+created by Syncthing when the folder is added. If this folder can\(aqt be
+created (you are serving files from a CD or something) you can instead set
+the advanced config \fBMarker Name\fP to the name of some file or folder that
+you know will always exist in the folder.
+.SS I really hate the \fB\&.stfolder\fP directory, can I remove it?
+.sp
+See the previous question.
 .SS Am I able to use nested Syncthing folders?
 .sp
 Do not nest shared folders. This behaviour is in no way supported,

+ 1 - 1
man/syncthing-globaldisco.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-GLOBALDISCO" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-GLOBALDISCO" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-globaldisco \- Global Discovery Protocol v3
 .

+ 1 - 1
man/syncthing-localdisco.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-LOCALDISCO" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-LOCALDISCO" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-localdisco \- Local Discovery Protocol v4
 .

+ 1 - 1
man/syncthing-networking.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-NETWORKING" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-NETWORKING" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-networking \- Firewall Setup
 .

+ 1 - 1
man/syncthing-relay.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-RELAY" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-RELAY" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-relay \- Relay Protocol v1
 .

+ 11 - 3
man/syncthing-rest-api.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-REST-API" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-REST-API" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-rest-api \- REST API
 .
@@ -670,7 +670,10 @@ folder. Takes \fBdevice\fP and \fBfolder\fP parameters.
 .nf
 .ft C
 {
-  "completion": 0
+  "completion": 100,
+  "globalBytes": 156793013575,
+  "needBytes": 0,
+  "needDeletes": 0
 }
 .ft P
 .fi
@@ -928,7 +931,12 @@ core utility towards a GUI.
 .sp
 To receive events, perform a HTTP GET of \fB/rest/events\fP or
 \fB/rest/events/disk\fP\&. The latter returns only local\-change\-detected and
-remote\-change\-detected events, the former all other events.
+remote\-change\-detected events, the former all other events unless filtered.
+.sp
+To filter the event list, in effect creating a specific subscription for
+only the desired event types, add a parameter
+\fBevents=EventTypeA,EventTypeB,...\fP where the event types are any from the
+list below.
 .sp
 The optional parameter \fBsince=<lastSeenID>\fP sets the ID of the last event
 you\(aqve already seen. Syncthing returns a JSON encoded array of event objects,

+ 1 - 1
man/syncthing-security.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-SECURITY" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-SECURITY" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-security \- Security Principles
 .

+ 1 - 1
man/syncthing-stignore.5

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-STIGNORE" "5" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-STIGNORE" "5" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-stignore \- Prevent files from being synchronized to other nodes
 .

+ 1 - 1
man/syncthing-versioning.7

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING-VERSIONING" "7" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING-VERSIONING" "7" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing-versioning \- Keep automatic backups of deleted files by other nodes
 .

+ 29 - 6
man/syncthing.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SYNCTHING" "1" "September 08, 2017" "v0.14" "Syncthing"
+.TH "SYNCTHING" "1" "November 18, 2017" "v0.14" "Syncthing"
 .SH NAME
 syncthing \- Syncthing
 .
@@ -36,11 +36,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .sp
 .nf
 .ft C
-syncthing [\-audit] [\-auditfile=<file|\-|\-\->] [\-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\-database] [\-reset\-deltas] [\-upgrade] [\-upgrade\-check] [\-upgrade\-to=<url>]
-          [\-verbose] [\-version]
+syncthing [\-audit] [\-auditfile=<file|\-|\-\->] [\-browser\-only] [device\-id]
+          [\-generate=<dir>] [\-gui\-address=<address>] [\-gui\-apikey=<key>]
+          [\-home=<dir>] [\-logfile=<filename>] [\-logflags=<flags>]
+          [\-no\-browser] [\-no\-console] [\-no\-restart] [\-paths] [\-paused]
+          [\-reset\-database] [\-reset\-deltas] [\-unpaused] [\-upgrade]
+          [\-upgrade\-check] [\-upgrade\-to=<url>] [\-verbose] [\-version]
 .ft P
 .fi
 .UNINDENT
@@ -66,6 +67,16 @@ Use specified file or stream (\fB"\-"\fP for stdout, \fB"\-\-"\fP for stderr) fo
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-browser\-only
+Open the web UI in a browser for an already running Syncthing instance.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-device\-id
+Print device ID to command line.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-generate=<dir>
 Generate key and config in specified dir, then exit.
 .UNINDENT
@@ -129,8 +140,15 @@ Print the paths used for configuration, keys, database, GUI overrides, default s
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-paused
+Start with all devices and folders paused.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-reset\-database
 Reset the database, forcing a full rescan and resync.
+Create \fI\&.stfolder\fP folders in each sync folder if they do not already exist.
+\fBCaution\fP: Ensure that all sync folders which are mountpoints are already mounted. Inconsistent versions may result if the mountpoint is later mounted and contains older versions.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -139,6 +157,11 @@ Reset delta index IDs, forcing a full index exchange.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-unpaused
+Start with all devices and folders unpaused.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-upgrade
 Perform upgrade.
 .UNINDENT