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
2016-11-22 09:32:57 +01:00
parent 462fde5e7d
commit 5bb74ee61c
20 changed files with 65 additions and 40 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" "November 12, 2016" "v0.14" "Syncthing"
.TH "STDISCOSRV" "1" "November 21, 2016" "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" "November 12, 2016" "v0.14" "Syncthing"
.TH "STRELAYSRV" "1" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.

23
man/syncthing-bep.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-BEP" "7" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
@@ -290,14 +290,15 @@ message Folder {
}
message Device {
bytes id = 1;
string name = 2;
repeated string addresses = 3;
Compression compression = 4;
string cert_name = 5;
int64 max_sequence = 6;
bool introducer = 7;
uint64 index_id = 8;
bytes id = 1;
string name = 2;
repeated string addresses = 3;
Compression compression = 4;
string cert_name = 5;
int64 max_sequence = 6;
bool introducer = 7;
uint64 index_id = 8;
bool skip_introduction_removals = 9;
}
enum Compression {
@@ -373,6 +374,10 @@ introducers.
.sp
The \fBindex id\fP field contains the unique identifier for the current set of
index data. See \fI\%Delta Index Exchange\fP for the usage of this field.
.sp
The \fBskip introduction removals\fP field signifies if the remote device has
opted to ignore introduction removals for the given device. This setting is
copied across as we are being introduced to a new device.
.SS Index and Index Update
.sp
The Index and Index Update messages define the contents of the senders

33
man/syncthing-config.5
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
@@ -97,6 +97,7 @@ The following shows an example of the default configuration file (IDs will diffe
<maxConflicts>\-1</maxConflicts>
<disableSparseFiles>false</disableSparseFiles>
<disableTempIndexes>false</disableTempIndexes>
<fsync>false</fsync>
</folder>
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ" name="syno" compression="metadata" introducer="false">
<address>dynamic</address>
@@ -161,7 +162,7 @@ migration from previous formats.
.nf
.ft C
<folder id="zj2AA\-q55a7" label="Default Folder (zj2AA\-q55a7)" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" ignorePerms="false" autoNormalize="true" ro="false">
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ" introducedBy="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR"></device>
<minDiskFreePct>1</minDiskFreePct>
<versioning></versioning>
<copiers>0</copiers>
@@ -175,6 +176,7 @@ migration from previous formats.
<maxConflicts>\-1</maxConflicts>
<disableSparseFiles>false</disableSparseFiles>
<disableTempIndexes>false</disableTempIndexes>
<fsync>false</fsync>
</folder>
.ft P
.fi
@@ -225,10 +227,13 @@ The following child elements may exist:
.INDENT 0.0
.TP
.B device
These must have the \fBid\fP attribute and nothing else. Mentioned devices
are those that will be sharing the folder in question. Each mentioned
device must have a separate \fBdevice\fP element later in the file. It is
customary that the local device ID is included in all repositories.
These must have the \fBid\fP attribute and can have an \fBintroducedBy\fP attribute,
identifying the device that introduced us to share this folder with the given device.
If the original introducer unshares this folder with this device, our device will follow
and unshare the folder (subject to skipIntroductionRemovals being false on the introducer device).
All mentioned devices are those that will be sharing the folder in question.
Each mentioned device must have a separate \fBdevice\fP element later in the file.
It is customary that the local device ID is included in all repositories.
Syncthing will currently add this automatically if it is not present in
the configuration file.
.TP
@@ -301,6 +306,12 @@ sparse files will not be created.
By default, devices exchange information about blocks available in
transfers that are still in progress. When set to true, such information
is not exchanged for this folder.
.INDENT 7.0
.TP
.B fsync
Transfer updated (from other devices) files to permanent storage before
committing the changes to the internal database.
.UNINDENT
.UNINDENT
.SH DEVICE ELEMENT
.INDENT 0.0
@@ -308,7 +319,7 @@ is not exchanged for this folder.
.sp
.nf
.ft C
<device id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU" name="syno" compression="metadata" introducer="false">
<device id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU" name="syno" compression="metadata" introducer="false" introducedBy="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR">
<address>dynamic</address>
</device>
<device id="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR" name="syno local" compression="metadata" introducer="false">
@@ -354,6 +365,14 @@ Disable all compression.
.B introducer
Set to true if this device should be trusted as an introducer, i.e. we
should copy their list of devices per folder when connecting.
.TP
.B skipIntroductionRemovals
Set to true if you wish to follow only introductions and not de\-introductions.
For example, if this is set, we would not remove a device that we were introduced
to even if the original introducer is no longer listing the remote device as known.
.TP
.B introducedBy
Defines which device has introduced us to this device. Used only for following de\-introductions.
.UNINDENT
.sp
In addition, one or more \fBaddress\fP child elements must be present. Each

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

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

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

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-EVENT-API" "7" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.

2
man/syncthing-faq.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-FAQ" "7" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.

2
man/syncthing-globaldisco.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-GLOBALDISCO" "7" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "November 21, 2016" "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" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "November 21, 2016" "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" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "November 21, 2016" "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" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.

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

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
@@ -86,6 +86,7 @@ Returns the current configuration.
"maxConflicts": 10,
"disableSparseFiles": false,
"disableTempIndexes": false,
"fsync": false,
"invalid": ""
}
],

2
man/syncthing-security.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "November 21, 2016" "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" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "November 21, 2016" "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" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "November 21, 2016" "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" "November 12, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING" "1" "November 21, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing \- Syncthing
.