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-07-26 10:53:00 +02:00
parent 7aaa1dd8a3
commit 25a7b0a6f8
19 changed files with 208 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
man/syncthing-bep.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-BEP" "7" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
@@ -297,6 +297,7 @@ message Device {
string cert_name = 5;
int64 max_local_version = 6;
bool introducer = 7;
uint64 index_id = 8;
}
enum Compression {
@@ -364,16 +365,15 @@ Compress always. Metadata messages as well as Response messages are compressed.
The \fBcert name\fP field indicates the expected certificate name for this
device. It is commonly blank, indicating to use the implementation default.
.sp
The \fBmax local version\fP field contains the highest local file
version number of the files already known to be in the index sent by
this device. If nothing is known about the index of a given device, this
field MUST be set to zero. When receiving a Cluster Config message with
a non\-zero Max Local Version for the local device ID, a device MAY elect
to send an Index Update message containing only files with higher local
version numbers in place of the initial Index message.
The \fBmax local version\fP field contains the highest local file version
number of the files in the index. See \fI\%Delta Index Exchange\fP for the usage of this
field.
.sp
The \fBintroducer\fP field is set for devices that are trusted as cluster
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.
.SS Index and Index Update
.sp
The Index and Index Update messages define the contents of the senders
@@ -757,6 +757,56 @@ of other cluster devices.
.fi
.UNINDENT
.UNINDENT
.SH DELTA INDEX EXCHANGE
.sp
Index data must be exchanged whenever two devices connect so that one knows
the files available on the other. In the most basic case this happens by way
of sending an \fBIndex\fP message followed by one or more \fBIndex Update\fP
messages. Any previous index data known for a remote device is removed and
replaced with the new index data received in an \fBIndex\fP message, while the
contents of an \fBIndex Update\fP message is simply added to the existing
index data.
.sp
For situations with large indexes or frequent reconnects this can be quite
inefficient. A mechanism can then be used to retain index data between
connections and only transmit any changes since that data on connection
start. This is called "delta indexes". To enable this mechanism the \fBlocal
version\fP and \fBindex ID\fP fields are used.
.INDENT 0.0
.TP
.B Local Version:
Each index item (i.e., file, directory or symlink) has a local version
field. It contains the value of a counter at the time the index item was
updated. The counter increments by one for each change. That is, as files
are scanned and added to the index they get assigned local version numbers
1, 2, 3 and so on. The next file to be changed or detected gets local
version number 4, and future updates continue in the same fashion.
.TP
.B Index ID:
Each folder has an Index ID. This is a 64 bit random identifier set at
index creation time.
.UNINDENT
.sp
Given the above, we know that the tuple {index ID, maximum local version}
uniquely identifies a point in time of a given index. Any further changes
will increase the local version of some item, and thus the maximum local
version for the index itself. Should the index be reset or removed (i.e.,
the local version number reset to zero), a new index ID must be generated.
.sp
By letting a device know the {index ID, maximum local version} we have for
their index data, that device can arrange to only transmit \fBIndex Update\fP
messages for items with a higher local version number. This is the delta
index mechanism.
.sp
The index ID and maximum local version known for each device is transmitted
in the \fBCluster Config\fP message at connection start.
.sp
For this mechanism to be reliable it is essential that outgoing index
information is ordered by increasing local version number. Devices
announcing a non\-zero index ID in the \fBCluster Config\fP message MUST send
all index data ordered by increasing local version number. Devices not
intending to participate in delta index exchange MUST send a zero index ID
or, equivalently, not send the \fBindex_id\fP attribute at all.
.SH MESSAGE LIMITS
.sp
An implementation MAY impose reasonable limits on the length of messages and
@@ -768,7 +818,7 @@ Update messages rather than sending a very large Index message.
.sp
The Syncthing implementation imposes a hard limit of 500,000,000 bytes on
all messages. Attempting to send or receive a larger message will result in
a connection close. This size was chosen to accomodate Index messages
a connection close. This size was chosen to accommodate Index messages
containing a large block list. It\(aqs intended that the limit may be further
reduced in a future protocol update supporting variable block sizes (and
thus shorter block lists for large files).

2
man/syncthing-config.5
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.

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

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "July 24, 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" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "July 24, 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" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "July 24, 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" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "July 24, 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" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "July 24, 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" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "July 24, 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" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.

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

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
@@ -401,6 +401,11 @@ Returns the list of recent log entries.
.fi
.UNINDENT
.UNINDENT
.SS POST /rest/system/pause
.sp
Pause the given device.
.sp
Takes the mandatory \fBdevice\fP parameter and returns status 200 and no content upon success, or status 500 and a plain text error on failure.
.SS GET /rest/system/ping
.sp
Returns a \fB{"ping": "pong"}\fP object.
@@ -438,6 +443,11 @@ $ curl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/system/rese
.SS POST /rest/system/restart
.sp
Post with empty body to immediately restart Syncthing.
.SS POST /rest/system/resume
.sp
Resume the given device.
.sp
Takes the mandatory \fBdevice\fP parameter and returns status 200 and no content upon success, or status 500 and a plain text error on failure.
.SS POST /rest/system/shutdown
.sp
Post with empty body to cause Syncthing to exit and not restart.
@@ -690,7 +700,7 @@ provides a list of strings which represent globbing patterns described by gobwas
.SS POST /rest/db/ignores
.sp
Expects a format similar to the output of \fBGET\fP call, but only
containing the \fBignore\fP field (\fBpatterns\fP field should be omitted).
containing the \fBignore\fP field (\fBexpanded\fP field should be omitted).
It takes one parameter, \fBfolder\fP, and either updates the content of
the \fB\&.stignore\fP echoing it back as a response, or returns an error.
.SS GET /rest/db/need

2
man/syncthing-security.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.

5
man/syncthing-stignore.5
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-STIGNORE" "5" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.
@@ -150,6 +150,7 @@ and an \fB\&.stignore\fP file with the contents:
.sp
.nf
.ft C
(?d).DS_Store
!frobble
!quuz
foo
@@ -168,7 +169,7 @@ all files and directories called "foo", ending in a "2" or starting with
.sp
.nf
.ft C
(?d).DS_Store # ignored, will be deleted if gets in the way of parent directory removal
\&.DS_Store # ignored, will be deleted if gets in the way of parent directory removal
foo # ignored, matches "foo"
foofoo # synced, does not match "foo" but would match "foo*" or "*foo"
bar/ # synced

2
man/syncthing-versioning.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "TODO" "7" "July 17, 2016" "v0.14" "Syncthing"
.TH "TODO" "7" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
Todo \- 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" "July 17, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING" "1" "July 24, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing \- Syncthing
.