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-17 07:45:40 +01:00
parent 3f2b584c4e
commit 1814f4693d
17 changed files with 97 additions and 25 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 09, 2021" "v1" "Syncthing"
.TH "STDISCOSRV" "1" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "STRELAYSRV" "1" "Mar 11, 2021" "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" "Mar 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Mar 11, 2021" "v1" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
man/syncthing-config.5
+13 -6
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "Mar 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Mar 11, 2021" "v1" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
@@ -100,7 +100,16 @@ currently on disk and available from peers.
.UNINDENT
.SH CONFIG FILE FORMAT
.sp
The following shows an example of the default configuration file (IDs will differ):
The following shows an example of a default configuration file (IDs will differ):
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The config examples are present for illustration. Do \fBnot\fP copy them
entirely to use as your config. They are likely out\-of\-date and the values
may no longer correspond to the defaults.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
@@ -148,8 +157,7 @@ The following shows an example of the default configuration file (IDs will diffe
</gui>
<ldap></ldap>
<options>
<listenAddress>tcp://0.0.0.0:8384</listenAddress>
<listenAddress>dynamic+https://relays.syncthing.net/endpoint</listenAddress>
<listenAddress>default</listenAddress>
<globalAnnounceServer>default</globalAnnounceServer>
<globalAnnounceEnabled>true</globalAnnounceEnabled>
<localAnnounceEnabled>true</localAnnounceEnabled>
@@ -820,8 +828,7 @@ Skip verification (true or false).
.nf
.ft C
<options>
<listenAddress>tcp://0.0.0.0:8384</listenAddress>
<listenAddress>dynamic+https://relays.syncthing.net/endpoint</listenAddress>
<listenAddress>default</listenAddress>
<globalAnnounceServer>default</globalAnnounceServer>
<globalAnnounceEnabled>true</globalAnnounceEnabled>
<localAnnounceEnabled>true</localAnnounceEnabled>
man/syncthing-device-ids.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Mar 11, 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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Mar 11, 2021" "v1" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.
man/syncthing-versioning.7
+69 -4
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-VERSIONING" "7" "Mar 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Mar 11, 2021" "v1" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.
@@ -179,7 +179,8 @@ $ /Users/jb/bin/onlylatest.sh /Users/jb/Sync docs/letter.txt
The script will then move the file in question to
\fB~/.trashcan/docs/letter.txt\fP, replacing any previous version of that letter
that may already have been there.
.SS Example for Windows
.SS Examples for Windows
.SS Move to a given folder using the command prompt (CMD)
.sp
On Windows we can use a batch script to perform the same “trash can”\-like
behavior as mentioned above. I created the following script and saved it as
@@ -215,8 +216,72 @@ 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 the command name in Syncthing.
Finally, I set \fB"C:\eUsers\emfrnd\eScripts\eonlylatest.bat" "%FOLDER_PATH%"
"%FILE_PATH%"\fP as the command name in Syncthing.
.SS Move to the Recycle Bin using PowerShell
.sp
We can use PowerShell to send files directly to the Recycle Bin, which
mimics the behaviour of deleting them using the Windows Explorer.
Firstly, create the following script and save it in your preferred
location, e.g. \fBC:\eUsers\eUser\eScripts\eSendToRecycleBin.ps1\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# PowerShell has no native method to recycle files, so we use Visual
# Basic to perform the operation. If succeeded, we also include the
# recycled file in the Syncthing\(aqs DEBUG output.
Add\-Type \-AssemblyName Microsoft.VisualBasic
[Microsoft.VisualBasic.FileIO.FileSystem]::DeleteFile($args,\(aqOnlyErrorDialogs\(aq,\(aqSendToRecycleBin\(aq)
if ($?) {
Write\-Output ("Recycled " + $args + ".")
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively, the script can be expanded to send only deleted files to
the Recycle Bin, and permanently delete modified ones, which makes it
more consistent with how the Explorer works.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# PowerShell has no native method to recycle files, so we use Visual
# Basic to perform the operation.
Add\-Type \-AssemblyName Microsoft.VisualBasic
# We need to test if a Syncthing .tmp file exists. If it does, we assume
# a modification and delete the existing file. If if does not, we assume
# a deletion and recycle the current file. If succeeded, we also include
# the deleted/recycled file in the Syncthing\(aqs DEBUG output.
if (Test\-Path \-LiteralPath ((Split\-Path \-Path $args) + "\e~syncthing~" + (Split\-Path \-Path $args \-Leaf) + ".tmp")) {
[Microsoft.VisualBasic.FileIO.FileSystem]::DeleteFile($args,\(aqOnlyErrorDialogs\(aq,\(aqDeletePermanently\(aq)
if ($?) {
Write\-Output ("Deleted " + $args + ".")
}
} else {
[Microsoft.VisualBasic.FileIO.FileSystem]::DeleteFile($args,\(aqOnlyErrorDialogs\(aq,\(aqSendToRecycleBin\(aq)
if ($?) {
Write\-Output ("Recycled " + $args + ".")
}
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, we set the command name in Syncthing to \fBpowershell.exe
\-ExecutionPolicy Bypass \-File "C:\eUsers\eUser\eScripts\eSendToRecycleBin.ps1"
"%FOLDER_PATH%\e%FILE_PATH%"\fP\&.
.sp
The only caveat that you should be aware of is that if your Syncthing
folder is located on a portable storage, such as a USB stick, or if you
have the Recycle Bin disabled, then the script will end up deleting all
files permanently.
.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 09, 2021" "v1" "Syncthing"
.TH "SYNCTHING" "1" "Mar 11, 2021" "v1" "Syncthing"
.SH NAME
syncthing \- Syncthing
.