perso/syncthing-arm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

gui, man: Update docs & translations

Browse Source
This commit is contained in:
Jakob Borg
2018-07-18 07:45:27 +02:00
parent 9f87fd1fcf
commit a4415bce10
19 changed files with 84 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
man/stdiscosrv.1
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STDISCOSRV" "1" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "STDISCOSRV" "1" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.

2
man/strelaysrv.1
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STRELAYSRV" "1" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "STRELAYSRV" "1" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.

2
man/syncthing-bep.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.

14
man/syncthing-config.5
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
@@ -82,7 +82,7 @@ The following shows an example of the default configuration file (IDs will diffe
.nf
.ft C
<configuration version="26">
<folder id="zj2AA\-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<folder id="zj2AA\-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
<filesystemType>basic</filesystemType>
<minDiskFree unit="%">1</minDiskFree>
@@ -210,7 +210,7 @@ logged, but there will be no dialog about it in the web GUI.
.sp
.nf
.ft C
<folder id="zj2AA\-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<folder id="zj2AA\-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
<filesystemType>basic</filesystemType>
<minDiskFree unit="%">1</minDiskFree>
@@ -255,12 +255,16 @@ device; not sent to other devices. (mandatory)
Controls how the folder is handled by Syncthing. Possible values are:
.INDENT 7.0
.TP
.B readwrite
.B sendreceive
The folder is in default mode. Sending local and accepting remote changes.
Note that this type was previously called “readwrite” which is deprecated
but still accepted in incoming configs.
.TP
.B readonly
.B sendonly
The folder is in “send\-only” mode – it will not be modified by
Syncthing on this device.
Note that this type was previously called “readonly” which is deprecated
but still accepted in incoming configs.
.UNINDENT
.TP
.B rescanIntervalS

2
man/syncthing-device-ids.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.

21
man/syncthing-event-api.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-EVENT-API" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.
@@ -94,6 +94,7 @@ itself.
.ft C
{
"id": 50,
"globalID": 50,
"type": "ConfigSaved",
"time": "2014\-12\-13T00:09:13.5166486Z",
"data": {
@@ -118,6 +119,7 @@ Generated each time a connection to a device has been established.
.ft C
{
"id": 2,
"globalID": 2,
"type": "DeviceConnected",
"time": "2014\-07\-13T21:04:33.687836696+02:00",
"data": {
@@ -143,6 +145,7 @@ Generated each time a connection to a device has been terminated.
.ft C
{
"id": 48,
"globalID": 48,
"type": "DeviceDisconnected",
"time": "2014\-07\-13T21:18:52.859929215+02:00",
"data": {
@@ -174,6 +177,7 @@ Emitted when a new device is discovered using local discovery.
.ft C
{
"id": 13,
"globalID": 13,
"type": "DeviceDiscovered",
"time": "2014\-07\-17T13:28:05.043465207+02:00",
"data": {
@@ -197,6 +201,7 @@ Emitted when a device was paused.
.ft C
{
"id": 13,
"globalID": 13,
"type": "DevicePaused",
"time": "2014\-07\-17T13:28:05.043465207+02:00",
"data": {
@@ -218,6 +223,7 @@ to talk to.
.ft C
{
"id": 24,
"globalID": 24,
"type": "DeviceRejected",
"time": "2014\-08\-19T10:43:00.562821045+02:00",
"data": {
@@ -240,6 +246,7 @@ Generated each time a device was resumed.
.ft C
{
"id": 2,
"globalID": 2,
"type": "DeviceResumed",
"time": "2014\-07\-13T21:04:33.687836696+02:00",
"data": {
@@ -262,6 +269,7 @@ configuration can cause multiple files to be shown.
.ft C
{
"id": 221,
"globalID": 221,
"type": "DownloadProgress",
"time": "2014\-12\-13T00:26:12.9876937Z",
"data": {
@@ -357,6 +365,7 @@ device.
.ft C
{
"id": 84,
"globalID": 84,
"type": "FolderCompletion",
"time": "2015\-04\-17T14:14:27.043576583+09:00",
"data": {
@@ -420,6 +429,7 @@ have, or have but do not share with the device in question.
.ft C
{
"id": 27,
"globalID": 27,
"type": "FolderRejected",
"time": "2014\-08\-19T10:41:06.761751399+02:00",
"data": {
@@ -470,6 +480,7 @@ state.
.ft C
{
"id": 16,
"globalID": 16,
"type": "FolderSummary",
"time": "2015\-04\-17T14:12:20.460121585+09:00",
"data": {
@@ -508,6 +519,7 @@ successful operation:
.ft C
{
"id": 93,
"globalID": 93,
"type": "ItemFinished",
"time": "2014\-07\-13T21:22:03.414609034+02:00",
"data": {
@@ -531,6 +543,7 @@ An unsuccessful operation:
.ft C
{
"id": 44,
"globalID": 44,
"type": "ItemFinished",
"time": "2015\-05\-27T11:21:05.711133004+02:00",
"data": {
@@ -560,6 +573,7 @@ Generated when Syncthing begins synchronizing a file to a newer version.
.ft C
{
"id": 93,
"globalID": 93,
"type": "ItemStarted",
"time": "2014\-07\-13T21:22:03.414609034+02:00",
"data": {
@@ -675,6 +689,7 @@ changes during a scan.
.ft C
{
"id": 59,
"globalID": 59,
"type": "LocalIndexUpdated",
"time": "2014\-07\-17T13:27:28.051369434+02:00",
"data": {
@@ -775,6 +790,7 @@ Generated each time new index information is received from a device.
.ft C
{
"id": 44,
"globalID": 44,
"type": "RemoteIndexUpdated",
"time": "2014\-07\-13T21:04:35.394184435+02:00",
"data": {
@@ -798,6 +814,7 @@ configuration etc.
.ft C
{
"id": 1,
"globalID": 1,
"type": "Starting",
"time": "2014\-07\-17T13:13:32.044470055+02:00",
"data": {
@@ -819,6 +836,7 @@ ready to start exchanging data with other devices.
.ft C
{
"id": 1,
"globalID": 1,
"type": "StartupComplete",
"time": "2014\-07\-13T21:03:18.383239179+02:00",
"data": null
@@ -841,6 +859,7 @@ seconds and is now in state \fBidle\fP\&.
.ft C
{
"id": 8,
"globalID": 8,
"type": "StateChanged",
"time": "2014\-07\-17T13:14:28.697493016+02:00",
"data": {

9
man/syncthing-faq.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-FAQ" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.
@@ -223,10 +223,11 @@ you know will always exist in the folder.
.SH I REALLY HATE THE .STFOLDER DIRECTORY, CAN I REMOVE IT?
.sp
See the previous question.
.SH AM I ABLE TO USE NESTED SYNCTHING FOLDERS?
.SH AM I ABLE TO NEST SHARED FOLDERS IN SYNCTHING?
.sp
Do not nest shared folders. This behaviour is in no way supported,
recommended or coded for in any way, and comes with many pitfalls.
Do not share a folder which is inside another shared folder. This behaviour
is in no way supported, recommended or coded for in any way, and comes with
many pitfalls.
.SH HOW DO I RENAME/MOVE A SYNCED FOLDER?
.sp
Syncthing doesn’t have a direct way to do this, as it’s potentially

2
man/syncthing-globaldisco.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-GLOBALDISCO" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.

2
man/syncthing-localdisco.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-LOCALDISCO" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.

2
man/syncthing-networking.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-NETWORKING" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.

2
man/syncthing-relay.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-RELAY" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.

8
man/syncthing-rest-api.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
@@ -103,7 +103,7 @@ Returns the current configuration.
"id": "GXWxf\-3zgnU",
"label": "MyFolder",
"path": "...",
"type": "readwrite",
"type": "sendreceive",
"devices": [
{
"deviceID": "..."
@@ -487,6 +487,8 @@ $ curl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/system/rese
.fi
.UNINDENT
.UNINDENT
.sp
\fBCaution\fP: See \fB\-reset\-database\fP for \fB\&.stfolder\fP creation side\-effect and caution regarding mountpoints.
.SS POST /rest/system/restart
.sp
Post with empty body to immediately restart Syncthing.
@@ -1075,7 +1077,7 @@ Returns the data sent in the anonymous usage report.
"folderUses" : {
"ignorePerms" : 0,
"autoNormalize" : 0,
"readonly" : 0,
"sendonly" : 0,
"ignoreDelete" : 0
},
"memoryUsageMiB" : 13,

2
man/syncthing-security.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.

2
man/syncthing-stignore.5
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-STIGNORE" "5" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.

2
man/syncthing-versioning.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-VERSIONING" "7" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.

2
man/syncthing.1
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING" "1" "Jul 06, 2018" "v0.14" "Syncthing"
.TH "SYNCTHING" "1" "Jul 12, 2018" "v0.14" "Syncthing"
.SH NAME
syncthing \- Syncthing
.