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
2021-03-10 07:45:45 +01:00
parent 727df34aa1
commit 5548a8eb7a
18 changed files with 65 additions and 49 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" "Mar 01, 2021" "v1" "Syncthing"
.TH "STDISCOSRV" "1" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "STRELAYSRV" "1" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.
man/syncthing-bep.7
+8 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
@@ -302,6 +302,7 @@ message Device {
bool introducer = 7;
uint64 index_id = 8;
bool skip_introduction_removals = 9;
bytes encryption_password_token = 10;
}
enum Compression {
@@ -383,6 +384,12 @@ index data. See \fI\%Delta Index Exchange\fP for the usage of this field.
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.
.sp
The \fBenc pw token\fP field contains a token derived from the password, that is
used to encrypt data sent to this device. If the device is the same as the
device sending the message, it signifies that the device itself has encrypted
data that was encrypted with the given token. It is empty or missing if there is
no encryption. See untrusted for details on the encryption scheme.
.SS Index and Index Update
.sp
The Index and Index Update messages define the contents of the senders
man/syncthing-config.5
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
man/syncthing-device-ids.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.
man/syncthing-rest-api.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
man/syncthing-security.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Mar 09, 2021" "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" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.
man/syncthing-versioning.7
+19 -10
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-VERSIONING" "7" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.
@@ -107,10 +107,12 @@ only for 10 days, use 10.
.UNINDENT
.SH EXTERNAL FILE VERSIONING
.sp
This versioning method delegates the decision on what to do to an external
command (program or script).
Just prior to a file being replaced, the command will be run.
The command should be specified as an absolute path, and can use the following templated arguments:
This versioning method delegates the decision on what to do to an
external command (e.g. a program or a command line script). Just prior
to a file being replaced, the command will be executed. The file needs
to be removed from the folder in the process, or otherwise Syncthing
will report an error. The command can use the following templated
arguments:
.INDENT 0.0
.TP
.B %FOLDER_PATH%
@@ -119,9 +121,16 @@ Path to the folder
.B %FILE_PATH%
Path to the file within the folder
.UNINDENT
.sp
Note that the former expands to the path of the actual Syncthing folder,
and the latter to the path inside that folder. For instance, if you use
the default \fBSync\fP folder in Windows, and the full path to the file is
\fBC:\eUsers\eUser\eSync\eFamily photos\eIMG_2021\-03\-01.jpg\fP, then the
\fB%FOLDER_PATH%\fP will be \fBC:\eUsers\eUser\eSync\fP, and the
\fB%FILE_PATH%\fP will be \fBFamily photos\eIMG_2021\-03\-01.jpg\fP\&.
.SS Example for Unixes
.sp
Lets say I want to keep the latest version of each file as they are replaced
Let’s say I want to keep the latest version of each file as they are replaced
or removed; essentially I want a “trash can”\-like behavior. For this, I create
the following script and store it as \fB/Users/jb/bin/onlylatest.sh\fP (i.e. the
\fBbin\fP directory in my home directory):
@@ -141,7 +150,7 @@ folderpath="$1"
filepath="$2"
# First ensure the dir where we need to store the file exists
outpath=\(gadirname "$versionspath/$filepath"\(ga
outpath=$(dirname "$versionspath/$filepath")
mkdir \-p "$outpath"
# Then move the file there
mv \-f "$folderpath/$filepath" "$versionspath/$filepath"
@@ -153,7 +162,7 @@ mv \-f "$folderpath/$filepath" "$versionspath/$filepath"
I must ensure that the script has execute permissions (\fBchmod 755
onlylatest.sh\fP), then configure Syncthing with command \fB/Users/jb/bin/onlylatest.sh %FOLDER_PATH% %FILE_PATH%\fP
.sp
Lets assume I have a folder “default” in ~/Sync, and that within that folder
Let’s assume I have a folder “default” in ~/Sync, and that within that folder
there is a file \fBdocs/letter.txt\fP that is being replaced or deleted. The
script will be called as if I ran this from the command line:
.INDENT 0.0
@@ -206,8 +215,8 @@ move /Y "%FOLDER_PATH%\e%FILE_PATH%" "%VERSIONS_PATH%\e%FILE_PATH%"
.UNINDENT
.UNINDENT
.sp
Finally, I set \fBC:\eUsers\emfrnd\eScripts\eonlylatest.bat %FOLDER_PATH% %FILE_PATH%\fP as command name in
Syncthing.
Finally, I set \fBC:\eUsers\emfrnd\eScripts\eonlylatest.bat %FOLDER_PATH% %FILE_PATH%\fP
as the command name in Syncthing.
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT
man/syncthing.1
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING" "1" "Mar 01, 2021" "v1" "Syncthing"
.TH "SYNCTHING" "1" "Mar 09, 2021" "v1" "Syncthing"
.SH NAME
syncthing \- Syncthing
.