felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

gui, man, authors: Update docs, translations, and contributors

Browse Source
This commit is contained in:
Jakob Borg
2020-10-28 07:45:27 +01:00
parent bc012d750d
commit deafe4ca53
22 changed files with 480 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/stdiscosrv.1
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STDISCOSRV" "1" "Oct 19, 2020" "v1" "Syncthing"
.TH "STDISCOSRV" "1" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.
man/strelaysrv.1
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STRELAYSRV" "1" "Oct 19, 2020" "v1" "Syncthing"
.TH "STRELAYSRV" "1" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.
man/syncthing-bep.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
man/syncthing-config.5
+3 -4
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
@@ -504,8 +504,7 @@ element:
.INDENT 0.0
.TP
.B id
The device ID. This must be written in canonical form, that is without any
spaces or dashes. (mandatory)
The device ID\&. (mandatory)
.TP
.B name
A friendly name for the device. (optional)
@@ -995,7 +994,7 @@ as part of launching Syncthing, set this option to \fBfalse\fP\&.
.UNINDENT
.SS Listen Addresses
.sp
The following address types are accepted in sync protocol listen addresses. If you want Syncthing to listen on multiple addresses, you can have multiple \fB<listenAddress>\fP tags. The same is achieved in the GUI by entering several addresses separated by comma.
The following address types are accepted in sync protocol listen addresses. If you want Syncthing to listen on multiple addresses, you can either: add multiple \fB<listenAddress>\fP tags in the configuration file or enter several addresses separated by commas in the GUI.
.INDENT 0.0
.TP
.B Default listen addresses (\fBdefault\fP)
man/syncthing-device-ids.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.
man/syncthing-event-api.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-EVENT-API" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.
man/syncthing-faq.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-FAQ" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.
man/syncthing-globaldisco.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-GLOBALDISCO" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.
man/syncthing-localdisco.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-LOCALDISCO" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.
man/syncthing-networking.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-NETWORKING" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.
man/syncthing-relay.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-RELAY" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.
man/syncthing-rest-api.7
+52 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
@@ -88,6 +88,10 @@ $ curl \-H "X\-API\-Key: yourkey" localhost:8384/rest/system/browse?current=/var
.UNINDENT
.UNINDENT
.SS GET /rest/system/config
.sp
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use rest\-config
instead.
.sp
Returns the current configuration.
.INDENT 0.0
@@ -256,6 +260,10 @@ Returns the current configuration.
.UNINDENT
.UNINDENT
.SS GET /rest/system/config/insync
.sp
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use
rest\-config\-insync instead.
.sp
Returns whether the config is in sync, i.e. whether the running
configuration is the same as that on disk.
@@ -272,6 +280,10 @@ configuration is the same as that on disk.
.UNINDENT
.UNINDENT
.SS POST /rest/system/config
.sp
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use rest\-config
instead.
.sp
Post the full contents of the configuration, in the same format as returned by
the corresponding GET request. When posting the configuration succeeds,
@@ -678,6 +690,45 @@ Returns the current Syncthing version information.
.fi
.UNINDENT
.UNINDENT
.SH CONFIG ENDPOINTS
.SS Config Endpoints
.sp
New in version 1.12.0.
.sp
These endpoints facilitate access and modification of the configuration in a granular way. Config sent to the endpoints must be in the same
format as returned by the corresponding GET request. When posting the
configuration succeeds, the posted configuration is immediately applied, except
for changes that require a restart. Query \fI\%/rest/system/config/insync\fP to check if
a restart is required.
.sp
For all endpoints supporting \fBPATCH\fP, it takes the existing config and
unmarshals the given JSON object on top of it. This means all child objects will
replace the existing objects, not extend them. For example for
\fBRawListenAddresses\(ga in options, which is an array of strings, sending
\(ga\(ga{RawListenAddresses: ["tcp://10.0.0.2"]\fP will replace all existing listen
addresses.
.SS /rest/config
.sp
\fBGET\fP returns the entire config and \fBPUT\fP replaces it.
.SS /rest/system/config/insync
.sp
\fBGET\fP returns whether the config is in sync, i.e. whether the running configuration is
the same as that on disk or if a restart is required.
.SS /rest/config/folders, /rest/config/devices
.sp
\fBGET\fP returns all folders respectively devices as an array. \fBPUT\fP takes an array and
\fBPOST\fP a single object. In both cases if a given folder/device already exists,
it’s replaced, otherwise a new one is added.
.SS /rest/config/folders/*id*, /rest/config/devices/*id*
.sp
Put the desired folder\- respectively device\-ID in place of *id*. \fBGET\fP
returns the folder/device for the given ID, \fBPUT\fP replaces the entire config
and \fBPATCH\fP replaces only the given child objects.
.SS /rest/config/options, /rest/config/ldap, /rest/config/gui
.sp
\fBGET\fP returns the respective object, \fBPUT\fP replaces the entire object and
\fBPATCH\fP replaces only the given child objects.
.SH DATABASE ENDPOINTS
.SS GET /rest/db/browse
.sp
man/syncthing-security.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.
man/syncthing-stignore.5
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-STIGNORE" "5" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.
man/syncthing-versioning.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-VERSIONING" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.
man/syncthing.1
+13 -13
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING" "1" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING" "1" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing \- Syncthing
.
@@ -64,7 +64,8 @@ Write events to timestamped file \fBaudit\-YYYYMMDD\-HHMMSS.log\fP\&.
.INDENT 0.0
.TP
.B \-auditfile=<file|\-|\-\->
Use specified file or stream (\fB"\-"\fP for stdout, \fB"\-\-"\fP for stderr) for audit events, rather than the timestamped default file name.
Use specified file or stream (\fB"\-"\fP for stdout, \fB"\-\-"\fP for stderr) for
audit events, rather than the timestamped default file name.
.UNINDENT
.INDENT 0.0
.TP
@@ -110,7 +111,8 @@ together with \fB\-config\fP\&.
.INDENT 0.0
.TP
.B \-logfile=<filename>
Set destination filename for logging (use \fB"\-"\fP for stdout, which is the default option).
Set destination filename for logging (use \fB"\-"\fP for stdout, which is the
default option).
.UNINDENT
.INDENT 0.0
.TP
@@ -147,12 +149,14 @@ Hide the console window. (On Windows only)
.INDENT 0.0
.TP
.B \-no\-restart
Disable the Syncthing monitor process which handles restarts for some configuration changes, upgrades, crashes and also log file writing (stdout is still written).
Do not restart Syncthing when it exits. The monitor process will still run
to handle crashes and writing to logfiles (if configured to).
.UNINDENT
.INDENT 0.0
.TP
.B \-paths
Print the paths used for configuration, keys, database, GUI overrides, default sync folder and the log file.
Print the paths used for configuration, keys, database, GUI overrides,
default sync folder and the log file.
.UNINDENT
.INDENT 0.0
.TP
@@ -222,11 +226,9 @@ Restarting
Upgrading
.UNINDENT
.sp
Some of these exit codes are only returned when running without a monitor
process (with environment variable \fBSTNORESTART\fP set). Exit codes over 125 are
usually returned by the shell/binary loader/default signal handler. Exit codes
over 128+N on Unix usually represent the signal which caused the process to
exit. For example, \fB128 + 9 (SIGKILL) = 137\fP\&.
Exit codes over 125 are usually returned by the shell/binary loader/default
signal handler. Exit codes over 128+N on Unix usually represent the signal which
caused the process to exit. For example, \fB128 + 9 (SIGKILL) = 137\fP\&.
.SH PROXIES
.sp
Syncthing can use a SOCKS, HTTP, or HTTPS proxy to talk to the outside
@@ -381,9 +383,7 @@ Don’t create a default folder when starting for the first time. This
variable will be ignored anytime after the first run.
.TP
.B STNORESTART
Equivalent to the \fB\-no\-restart\fP flag. Disable the Syncthing monitor
process which handles restarts for some configuration changes, upgrades,
crashes and also log file writing (stdout is still written).
Equivalent to the \fB\-no\-restart\fP flag
.TP
.B STNOUPGRADE
Disable automatic upgrades.