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:
Syncthing Release Automation
2023-09-18 03:45:31 +00:00
parent c9dfd75d8e
commit 58d1f3a471
29 changed files with 1292 additions and 1230 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/stdiscosrv.1
+4 -4
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "STDISCOSRV" "1" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "STDISCOSRV" "1" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.SH SYNOPSIS
@@ -114,7 +114,7 @@ entry from the list.
.SS Description
.sp
This guide assumes that you have already set up Syncthing. If you
haven’t yet, head over to getting\-started first.
haven’t yet, head over to \fI\%Getting Started\fP first.
.SS Installing
.sp
Go to \fI\%releases\fP <\fBhttps://github.com/syncthing/discosrv/releases\fP> and
@@ -398,7 +398,7 @@ server {
ssl_dhparam /path/to/dhparam;
# HSTS (ngx_http_headers_module is required) (63072000 seconds)
add_header Strict\-Transport\-Security "max\-age=63072000" always;
add_header Strict\-Transport\-Security \(dqmax\-age=63072000\(dq always;
location / {
proxy_pass http://discovery.example.com;
@@ -421,7 +421,7 @@ The following lines must be added to the configuration:
.ft C
SSLProxyEngine On
SSLVerifyClient optional_no_ca
RequestHeader set X\-SSL\-Cert "%{SSL_CLIENT_CERT}s"
RequestHeader set X\-SSL\-Cert \(dq%{SSL_CLIENT_CERT}s\(dq
.ft P
.fi
.UNINDENT
man/strelaysrv.1
+3 -3
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "STRELAYSRV" "1" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "STRELAYSRV" "1" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.SH SYNOPSIS
@@ -202,7 +202,7 @@ $ sudo \-u strelaysrv /usr/local/bin/strelaysrv \-keys /etc/strelaysrv
.sp
This creates a user \fBstrelaysrv\fP and a directory \fB/etc/strelaysrv\fP to store
the keys. The keys are generated on first startup. The relay will join the
global relay pool, unless a \fB\-pools=""\fP argument is given.
global relay pool, unless a \fB\-pools=\(dq\(dq\fP argument is given.
.sp
To make the relay server start automatically at boot, use the recommended
procedure for your operating system.
@@ -272,7 +272,7 @@ COMMIT
.UNINDENT
.UNINDENT
.sp
You will need to start \fBstrelaysrv\fP with \fB\-ext\-address ":443"\fP\&. This tells
You will need to start \fBstrelaysrv\fP with \fB\-ext\-address \(dq:443\(dq\fP\&. This tells
\fBstrelaysrv\fP that it can be contacted on port 443, even though it is listening
on port 22067. You will also need to let both port 443 and 22067 through your
firewall.
man/syncthing-bep.7
+2 -2
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-BEP" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.SH INTRODUCTION AND DEFINITIONS
@@ -389,7 +389,7 @@ The \fBencryption_password_token\fP field contains a token derived from the pass
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.
no encryption. See \fI\%Untrusted Device Encryption\fP 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
+65 -65
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-CONFIG" "5" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.SH SYNOPSIS
@@ -115,13 +115,13 @@ may no longer correspond to the defaults.
.sp
.nf
.ft C
<configuration version="37">
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<configuration version=\(dq37\(dq>
<folder id=\(dqdefault\(dq label=\(dqDefault Folder\(dq path=\(dq/Users/jb/Sync/\(dq type=\(dqsendreceive\(dq rescanIntervalS=\(dq3600\(dq fsWatcherEnabled=\(dqtrue\(dq fsWatcherDelayS=\(dq10\(dq ignorePerms=\(dqfalse\(dq autoNormalize=\(dqtrue\(dq>
<filesystemType>basic</filesystemType>
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq introducedBy=\(dq\(dq>
<encryptionPassword></encryptionPassword>
</device>
<minDiskFree unit="%">1</minDiskFree>
<minDiskFree unit=\(dq%\(dq>1</minDiskFree>
<versioning>
<cleanupIntervalS>3600</cleanupIntervalS>
<fsPath></fsPath>
@@ -153,18 +153,18 @@ may no longer correspond to the defaults.
<syncXattrs>false</syncXattrs>
<sendXattrs>false</sendXattrs>
</folder>
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq name=\(dqsyno\(dq compression=\(dqmetadata\(dq introducer=\(dqfalse\(dq skipIntroductionRemovals=\(dqfalse\(dq introducedBy=\(dq\(dq>
<address>dynamic</address>
<paused>false</paused>
<autoAcceptFolders>false</autoAcceptFolders>
<maxSendKbps>0</maxSendKbps>
<maxRecvKbps>0</maxRecvKbps>
<ignoredFolder time="2022\-01\-09T19:09:52Z" id="br63e\-wyhb7" label="Foo"></ignoredFolder>
<ignoredFolder time=\(dq2022\-01\-09T19:09:52Z\(dq id=\(dqbr63e\-wyhb7\(dq label=\(dqFoo\(dq></ignoredFolder>
<maxRequestKiB>0</maxRequestKiB>
<untrusted>false</untrusted>
<remoteGUIPort>0</remoteGUIPort>
</device>
<gui enabled="true" tls="false" debugging="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq debugging=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
<theme>default</theme>
@@ -199,7 +199,7 @@ may no longer correspond to the defaults.
<cacheIgnoredFiles>false</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS>
<limitBandwidthInLan>false</limitBandwidthInLan>
<minHomeDiskFree unit="%">1</minHomeDiskFree>
<minHomeDiskFree unit=\(dq%\(dq>1</minHomeDiskFree>
<releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
<tempIndexMinBlocks>10</tempIndexMinBlocks>
@@ -220,14 +220,14 @@ may no longer correspond to the defaults.
<connectionLimitMax>0</connectionLimitMax>
<insecureAllowOldTLSVersions>false</insecureAllowOldTLSVersions>
</options>
<remoteIgnoredDevice time="2022\-01\-09T20:02:01Z" id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU" name="bugger" address="192.168.0.20:22000"></remoteIgnoredDevice>
<remoteIgnoredDevice time=\(dq2022\-01\-09T20:02:01Z\(dq id=\(dq5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU\(dq name=\(dqbugger\(dq address=\(dq192.168.0.20:22000\(dq></remoteIgnoredDevice>
<defaults>
<folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<folder id=\(dq\(dq label=\(dq\(dq path=\(dq~\(dq type=\(dqsendreceive\(dq rescanIntervalS=\(dq3600\(dq fsWatcherEnabled=\(dqtrue\(dq fsWatcherDelayS=\(dq10\(dq ignorePerms=\(dqfalse\(dq autoNormalize=\(dqtrue\(dq>
<filesystemType>basic</filesystemType>
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq introducedBy=\(dq\(dq>
<encryptionPassword></encryptionPassword>
</device>
<minDiskFree unit="%">1</minDiskFree>
<minDiskFree unit=\(dq%\(dq>1</minDiskFree>
<versioning>
<cleanupIntervalS>3600</cleanupIntervalS>
<fsPath></fsPath>
@@ -259,7 +259,7 @@ may no longer correspond to the defaults.
<syncXattrs>false</syncXattrs>
<sendXattrs>false</sendXattrs>
</folder>
<device id="" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
<device id=\(dq\(dq compression=\(dqmetadata\(dq introducer=\(dqfalse\(dq skipIntroductionRemovals=\(dqfalse\(dq introducedBy=\(dq\(dq>
<address>dynamic</address>
<paused>false</paused>
<autoAcceptFolders>false</autoAcceptFolders>
@@ -281,7 +281,7 @@ may no longer correspond to the defaults.
.sp
.nf
.ft C
<configuration version="37">
<configuration version=\(dq37\(dq>
<folder></folder>
<device></device>
<gui></gui>
@@ -318,12 +318,12 @@ GUI.
.sp
.nf
.ft C
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<folder id=\(dqdefault\(dq label=\(dqDefault Folder\(dq path=\(dq/Users/jb/Sync/\(dq type=\(dqsendreceive\(dq rescanIntervalS=\(dq3600\(dq fsWatcherEnabled=\(dqtrue\(dq fsWatcherDelayS=\(dq10\(dq ignorePerms=\(dqfalse\(dq autoNormalize=\(dqtrue\(dq>
<filesystemType>basic</filesystemType>
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq introducedBy=\(dq\(dq>
<encryptionPassword></encryptionPassword>
</device>
<minDiskFree unit="%">1</minDiskFree>
<minDiskFree unit=\(dq%\(dq>1</minDiskFree>
<versioning>
<cleanupIntervalS>3600</cleanupIntervalS>
<fsPath></fsPath>
@@ -379,7 +379,7 @@ labels. (optional)
.TP
.B filesystemType
The internal file system implementation used to access this folder, detailed
in a separate chapter\&.
in a \fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -410,7 +410,7 @@ changes to other devices.
.TP
.B \fBreceiveencrypted\fP
Must be used on untrusted devices, where the data cannot be decrypted
because no folder password was entered. See untrusted\&.
because no folder password was entered. See \fI\%Untrusted (Encrypted) Devices\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
@@ -443,7 +443,7 @@ as FAT, or environments where changing permissions is impossible.
.TP
.B autoNormalize
Automatically correct UTF\-8 normalization errors found in file names. The
mechanism and how to set it up is described in a separate chapter\&.
mechanism and how to set it up is described in a \fI\%separate chapter\fP\&.
.UNINDENT
.sp
The following child elements may exist:
@@ -465,7 +465,7 @@ the configuration file.
The \fBencryptionPassword\fP sub\-element contains the secret needed to decrypt
this folder’s data on the remote device. If left empty, the data is plainly
accessible (but still protected by the transport encryption). The mechanism
and how to set it up is described in a separate chapter\&.
and how to set it up is described in a \fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -484,7 +484,7 @@ Specifies a versioning configuration.
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
versioning
\fI\%File Versioning\fP
.UNINDENT
.UNINDENT
.UNINDENT
@@ -545,7 +545,7 @@ Enabling this is highly discouraged \- use at your own risk. You have been warne
.sp
When set to \fBtrue\fP, this device will pretend not to see instructions to
delete files from other devices. The mechanism is described in a
separate chapter\&.
\fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -597,7 +597,7 @@ to \fB\-1\fP to always use weak hash. Default is \fB25\fP\&.
.TP
.B markerName
Name of a directory or file in the folder root to be used as
marker\-faq\&. Default is \fB\&.stfolder\fP\&.
\fI\%How do I serve a folder from a read only filesystem?\fP\&. Default is \fB\&.stfolder\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -633,7 +633,7 @@ This is a known insecure option \- use at your own risk.
.sp
Disables committing file operations to disk before recording them in the
database. Disabling fsync can lead to data corruption. The mechanism is
described in a separate chapter\&.
described in a \fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -664,15 +664,15 @@ no improvements to data distribution.
Provides a choice of method for copying data between files. This can be
used to optimise copies on network filesystems, improve speed of large
copies or clone the data using copy\-on\-write functionality if the underlying
filesystem supports it. The mechanism is described in a separate
chapter\&.
filesystem supports it. The mechanism is described in a \fI\%separate
chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B caseSensitiveFS
Affects performance by disabling the extra safety checks for case
insensitive filesystems. The mechanism and how to set it up is described in
a separate chapter\&.
a \fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -684,26 +684,26 @@ to \fBtrue\fP\&.
.TP
.B syncOwnership
File and directory ownership is synced when this is set to \fBtrue\fP\&. See
/advanced/folder\-sync\-ownership for more information.
\fI\%syncOwnership\fP for more information.
.UNINDENT
.INDENT 0.0
.TP
.B sendOwnership
File and directory ownership information is scanned when this is set to
\fBtrue\fP\&. See /advanced/folder\-send\-ownership for more information.
\fBtrue\fP\&. See \fI\%sendOwnership\fP for more information.
.UNINDENT
.INDENT 0.0
.TP
.B syncXattrs
File and directory extended attributes are synced when this is set to
\fBtrue\fP\&. See /advanced/folder\-sync\-xattrs for more information.
\fBtrue\fP\&. See \fI\%syncXattrs\fP for more information.
.UNINDENT
.INDENT 0.0
.TP
.B sendXattrs
File and directory extended attributes are scanned and sent to other
devices when this is set to \fBtrue\fP\&. See
/advanced/folder\-send\-xattrs for more information.
\fI\%sendXattrs\fP for more information.
.UNINDENT
.SH DEVICE ELEMENT
.INDENT 0.0
@@ -711,19 +711,19 @@ devices when this is set to \fBtrue\fP\&. See
.sp
.nf
.ft C
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR">
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq name=\(dqsyno\(dq compression=\(dqmetadata\(dq introducer=\(dqfalse\(dq skipIntroductionRemovals=\(dqfalse\(dq introducedBy=\(dq2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR\(dq>
<address>dynamic</address>
<paused>false</paused>
<autoAcceptFolders>false</autoAcceptFolders>
<maxSendKbps>0</maxSendKbps>
<maxRecvKbps>0</maxRecvKbps>
<ignoredFolder time="2022\-01\-09T19:09:52Z" id="br63e\-wyhb7" label="Foo"></ignoredFolder>
<ignoredFolder time=\(dq2022\-01\-09T19:09:52Z\(dq id=\(dqbr63e\-wyhb7\(dq label=\(dqFoo\(dq></ignoredFolder>
<maxRequestKiB>0</maxRequestKiB>
<untrusted>false</untrusted>
<remoteGUIPort>0</remoteGUIPort>
<numConnections>0</numConnections>
</device>
<device id="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR" name="syno local" compression="metadata" introducer="true" skipIntroductionRemovals="false" introducedBy="">
<device id=\(dq2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR\(dq name=\(dqsyno local\(dq compression=\(dqmetadata\(dq introducer=\(dqtrue\(dq skipIntroductionRemovals=\(dqfalse\(dq introducedBy=\(dq\(dq>
<address>tcp://192.0.2.1:22001</address>
<paused>true</paused>
<allowedNetwork>192.168.0.0/16</allowedNetwork>
@@ -748,7 +748,7 @@ element:
.INDENT 0.0
.TP
.B id (mandatory)
The device ID\&.
The \fI\%device ID\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -784,7 +784,7 @@ should copy their list of devices per folder when connecting.
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
introducer
\fI\%Introducer Configuration\fP
.UNINDENT
.UNINDENT
.UNINDENT
@@ -851,7 +851,7 @@ for example:
.sp
.nf
.ft C
<device id="...">
<device id=\(dq...\(dq>
<address>tcp://192.0.2.1:22001</address>
<address>quic://192.0.1.254:22000</address>
<address>dynamic</address>
@@ -870,7 +870,7 @@ True if synchronization with this devices is (temporarily) suspended.
.TP
.B allowedNetwork
If given, this restricts connections to this device to only this network.
The mechanism is described in detail in a separate chapter).
The mechanism is described in detail in a \fI\%separate chapter\fP).
.UNINDENT
.INDENT 0.0
.TP
@@ -924,13 +924,13 @@ This boolean value marks a particular device as untrusted, which disallows
ever sharing any unencrypted data with it. Every folder shared with that
device then needs an encryption password set, or must already be of the
“receive encrypted” type locally. Refer to the detailed explanation under
untrusted\&.
\fI\%Untrusted (Encrypted) Devices\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B numConnections
The number of connections to this device. See
/advanced/device\-numconnections for more information.
\fI\%numConnections\fP for more information.
.UNINDENT
.SH GUI ELEMENT
.INDENT 0.0
@@ -938,7 +938,7 @@ The number of connections to this device. See
.sp
.nf
.ft C
<gui enabled="true" tls="false" debugging="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq debugging=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
<theme>default</theme>
@@ -949,7 +949,7 @@ The number of connections to this device. See
.UNINDENT
.sp
There must be exactly one \fBgui\fP element. The GUI configuration is also used by
the /dev/rest and the /dev/events\&. The following attributes may be
the \fI\%REST API\fP and the \fI\%Event API\fP\&. The following attributes may be
set on the \fBgui\fP element:
.INDENT 0.0
.TP
@@ -966,8 +966,8 @@ still possible but not required.
.INDENT 0.0
.TP
.B debugging
This enables /users/profiling and additional endpoints in the REST
API, see /rest/debug\&.
This enables \fI\%Profiling\fP and additional endpoints in the REST
API, see \fI\%Debug Endpoints\fP\&.
.UNINDENT
.sp
The following child elements may be present:
@@ -1069,7 +1069,7 @@ LDAP authentication. Requires ldap top level config section to be present.
.UNINDENT
.sp
The \fBldap\fP element contains LDAP configuration options. The mechanism is
described in detail under ldap\&.
described in detail under \fI\%LDAP Authentication\fP\&.
.INDENT 0.0
.TP
.B address (mandatory)
@@ -1154,7 +1154,7 @@ Search filter for user searches.
<cacheIgnoredFiles>false</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS>
<limitBandwidthInLan>false</limitBandwidthInLan>
<minHomeDiskFree unit="%">1</minHomeDiskFree>
<minHomeDiskFree unit=\(dq%\(dq>1</minHomeDiskFree>
<releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
<tempIndexMinBlocks>10</tempIndexMinBlocks>
@@ -1318,7 +1318,7 @@ automatic upgrades.
.TP
.B upgradeToPreReleases
If \fBtrue\fP, automatic upgrades include release candidates (see
releases).
\fI\%Versions & Releases\fP).
.UNINDENT
.INDENT 0.0
.TP
@@ -1432,18 +1432,18 @@ as part of launching Syncthing, set this option to \fBfalse\fP\&.
.B maxFolderConcurrency
This option controls how many folders may concurrently be in I/O\-intensive
operations such as syncing or scanning. The mechanism is described in
detail in a separate chapter\&.
detail in a \fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B crashReportingURL
Server URL where automatic crash reports will be sent if
Server URL where \fI\%automatic crash reports\fP will be sent if
enabled.
.UNINDENT
.INDENT 0.0
.TP
.B crashReportingEnabled
Switch to opt out from the automatic crash reporting
Switch to opt out from the \fI\%automatic crash reporting\fP
feature. Set \fBfalse\fP to keep Syncthing from sending panic logs on serious
troubles. Defaults to \fBtrue\fP, to help the developers troubleshoot.
.UNINDENT
@@ -1452,7 +1452,7 @@ troubles. Defaults to \fBtrue\fP, to help the developers troubleshoot.
.B databaseTuning
Controls how Syncthing uses the backend key\-value database that stores the
index data and other persistent data it needs. The available options and
implications are explained in a separate chapter\&.
implications are explained in a \fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -1470,7 +1470,7 @@ addresses to global discovery.
.TP
.B sendFullIndexOnUpgrade
Controls whether all index data is resent when an upgrade has happened,
equivalent to starting Syncthing with \fB\-\-reset\-deltas\fP\&. This used
equivalent to starting Syncthing with \fI\%\-\-reset\-deltas\fP\&. This used
to be the default behavior in older versions, but is mainly useful as a
troubleshooting step and causes high database churn. The default is now
\fBfalse\fP\&.
@@ -1488,21 +1488,21 @@ so that regular users do not enable it by accident.
.B connectionLimitEnough
The number of connections at which we stop trying to connect to more
devices, zero meaning no limit. Does not affect incoming connections. The
mechanism is described in detail in a separate chapter\&.
mechanism is described in detail in a \fI\%separate chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B connectionLimitMax
The maximum number of connections which we will allow in total, zero meaning
no limit. Affects incoming connections and prevents attempting outgoing
connections. The mechanism is described in detail in a separate
chapter\&.
connections. The mechanism is described in detail in a \fI\%separate
chapter\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B insecureAllowOldTLSVersions
Only for compatibility with old versions of Syncthing on remote devices, as
detailed in /advanced/option\-insecure\-allow\-old\-tls\-versions\&.
detailed in \fI\%insecureAllowOldTLSVersions\fP\&.
.UNINDENT
.SH DEFAULTS ELEMENT
.INDENT 0.0
@@ -1511,12 +1511,12 @@ detailed in /advanced/option\-insecure\-allow\-old\-tls\-versions\&.
.nf
.ft C
<defaults>
<folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
<folder id=\(dq\(dq label=\(dq\(dq path=\(dq~\(dq type=\(dqsendreceive\(dq rescanIntervalS=\(dq3600\(dq fsWatcherEnabled=\(dqtrue\(dq fsWatcherDelayS=\(dq10\(dq ignorePerms=\(dqfalse\(dq autoNormalize=\(dqtrue\(dq>
<filesystemType>basic</filesystemType>
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq introducedBy=\(dq\(dq>
<encryptionPassword></encryptionPassword>
</device>
<minDiskFree unit="%">1</minDiskFree>
<minDiskFree unit=\(dq%\(dq>1</minDiskFree>
<versioning>
<cleanupIntervalS>3600</cleanupIntervalS>
<fsPath></fsPath>
@@ -1544,7 +1544,7 @@ detailed in /advanced/option\-insecure\-allow\-old\-tls\-versions\&.
<caseSensitiveFS>false</caseSensitiveFS>
<junctionsAsDirs>false</junctionsAsDirs>
</folder>
<device id="" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
<device id=\(dq\(dq compression=\(dqmetadata\(dq introducer=\(dqfalse\(dq skipIntroductionRemovals=\(dqfalse\(dq introducedBy=\(dq\(dq>
<address>dynamic</address>
<paused>false</paused>
<autoAcceptFolders>false</autoAcceptFolders>
@@ -1599,7 +1599,7 @@ including the appropriate \fI\%folder.device\fP element underneath.
New in version 1.19.0.
.sp
Template for the ignore patterns applied to new
Template for the \fI\%ignore patterns\fP applied to new
folders. These are copied to the \fB\&.stignore\fP file when a folder is
automatically accepted from a remote device. The GUI uses them to pre\-fill
the respective field when adding a new folder as well. In XML, each pattern
@@ -1671,12 +1671,12 @@ accidentally if you sync your home folder between devices. A common symptom
of syncing configuration files is two devices ending up with the same Device ID.
.sp
If you want to use Syncthing to backup your configuration files, it is recommended
that the files you are backing up are in a folder\-sendonly to prevent other
that the files you are backing up are in a \fI\%Send Only Folder\fP to prevent other
devices from overwriting the per device configuration. The folder on the remote
device(s) should not be used as configuration for the remote devices.
.sp
If you’d like to sync your home folder in non\-send only mode, you may add the
folder that stores the configuration files to the ignore list\&.
folder that stores the configuration files to the \fI\%ignore list\fP\&.
If you’d also like to backup your configuration files, add another folder in
send only mode for just the configuration folder.
.SH AUTHOR
man/syncthing-device-ids.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-DEVICE-IDS" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.sp
man/syncthing-event-api.7
+383 -383
View File
File diff suppressed because it is too large Load Diff
man/syncthing-faq.7
+22 -22
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-FAQ" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.INDENT 0.0
@@ -164,7 +164,7 @@ Directory modification times (not preserved)
Hard links (followed, not preserved)
.IP \(bu 2
Windows junctions (synced as ordinary directories; require enabling in
\fBthe configuration\fP on a per\-folder
\fI\%the configuration\fP on a per\-folder
basis)
.IP \(bu 2
Resource forks (not preserved)
@@ -176,7 +176,7 @@ Devices, FIFOs, and other specials (ignored)
Sparse file sparseness (will become sparse, when supported by the OS & filesystem)
.IP \(bu 2
Syncthing internal files and folders (e.g. \fB\&.stfolder\fP, \fB\&.stignore\fP,
\fB\&.stversions\fP, temporary files, etc.)
\fB\&.stversions\fP, \fI\%temporary files\fP, etc.)
.UNINDENT
.SS Is synchronization fast?
.sp
@@ -191,7 +191,7 @@ manner. This means that renaming a file will not cause a retransmission of
that file. Additionally, appending data to existing files should be handled
efficiently as well.
.sp
Temporary files are used to store partial data
\fI\%Temporary files\fP are used to store partial data
downloaded from other devices. They are automatically removed whenever a file
transfer has been completed or after the configured amount of time which is set
in the configuration file (24 hours by default).
@@ -236,7 +236,7 @@ oyster!)
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
device\-ids
\fI\%Understanding Device IDs\fP
.UNINDENT
.UNINDENT
.SH TROUBLESHOOTING
@@ -262,7 +262,7 @@ Devices” list on the right side of the GUI, double check that you see
.sp
If you are connected via a relay, this is because a direct connection could
not be established. Double check and follow the suggestions in
firewall\-setup to enable direct connections.
\fI\%Firewall Setup\fP to enable direct connections.
.sp
Second, if one of the devices is a very low powered machine (a Raspberry Pi,
or a phone, or a NAS, or similar) you are likely constrained by the CPU on
@@ -295,7 +295,7 @@ causes a certain amount of extra CPU usage to calculate the summary data it
presents. Note however that once things are \fIin sync\fP CPU usage should be
negligible.
.sp
To minimize the impact of this, Syncthing attempts to \fBlower the
To minimize the impact of this, Syncthing attempts to \fI\%lower the
process priority\fP when starting up.
.sp
To further limit the amount of CPU used when syncing and scanning, set the
@@ -328,7 +328,7 @@ protect against unauthorized access. Either:
.IP \(bu 2
Make sure the proxy sets a \fBHost\fP header containing \fBlocalhost\fP, or
.IP \(bu 2
Set \fBgui.insecureSkipHostcheck\fP in the advanced settings, or
Set \fI\%gui.insecureSkipHostcheck\fP in the advanced settings, or
.IP \(bu 2
Bind the GUI/API to a non\-localhost listen port.
.UNINDENT
@@ -338,8 +338,8 @@ In all cases, username/password authentication and HTTPS should be used.
.sp
This is almost always a result of bad RAM, storage device or other hardware.
When the index database is found to be corrupt Syncthing cannot operate and will
note this in the logs and exit. To overcome this delete the database
folder inside Syncthing’s data directory and re\-start
note this in the logs and exit. To overcome this delete the \fI\%database
folder\fP inside Syncthing’s data directory and re\-start
Syncthing. It will then need to perform a full re\-hashing of all shared
folders. You should check your system in case the underlying cause is indeed
faulty hardware which may put the system at risk of further data loss.
@@ -374,7 +374,7 @@ up\-to\-date state with all the neighbours.
.SS Why does Syncthing connect to this unknown/suspicious address?
.sp
If you see outgoing connections to odd and unexpected addresses these are
most likely connections to relay servers\&. Relay servers
most likely connections to \fI\%relay servers\fP\&. Relay servers
are run by volunteers all over the world. They usually listen on ports 443 or
22067, though this is controlled by the user running it. You can compare the
address you are concerned about with \fI\%the current list of active relays\fP <\fBhttps://relays.syncthing.net\fP>\&. Relays do not and can not see the data
@@ -420,7 +420,7 @@ Also see the \fI\%marker FAQ\fP for more information about the folder marker.
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
conflict\-handling
\fI\%Conflicting Changes\fP
.UNINDENT
.UNINDENT
.SS How do I serve a folder from a read only filesystem?
@@ -459,11 +459,11 @@ locally may be overwritten by those on other devices.
.sp
An alternative way is to shut down Syncthing, move the folder on disk (including
the \fB\&.stfolder\fP marker), edit the path directly in \fBconfig.xml\fP in the
configuration folder (see /users/config) and then start Syncthing again.
configuration folder (see \fI\%Syncthing Configuration\fP) and then start Syncthing again.
.SS How do I configure multiple users on a single machine?
.sp
Each user should run their own Syncthing instance. Be aware that you might need
to configure listening ports such that they do not overlap (see /users/config).
to configure listening ports such that they do not overlap (see \fI\%Syncthing Configuration\fP).
.SS Does Syncthing support syncing between folders on the same system?
.sp
No. Syncthing is not designed to sync locally and the overhead involved in
@@ -529,7 +529,7 @@ UI from \fB127.0.0.1:8384\fP to
.sp
.nf
.ft C
<gui enabled="true" tls="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
.ft P
.fi
@@ -542,7 +542,7 @@ to
.sp
.nf
.ft C
<gui enabled="true" tls="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq>
<address>0.0.0.0:8384</address>
.ft P
.fi
@@ -668,7 +668,7 @@ On many Linux distributions you can run the following to fix it:
.sp
.nf
.ft C
echo "fs.inotify.max_user_watches=204800" | sudo tee \-a /etc/sysctl.conf
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.conf
.ft P
.fi
.UNINDENT
@@ -681,7 +681,7 @@ separate file, i.e. you should run:
.sp
.nf
.ft C
echo "fs.inotify.max_user_watches=204800" | sudo tee \-a /etc/sysctl.d/90\-override.conf
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.d/90\-override.conf
.ft P
.fi
.UNINDENT
@@ -701,7 +701,7 @@ echo 204800 | sudo tee /proc/sys/fs/inotify/max_user_watches
.SS How do I reset the GUI password?
.sp
If you’ve forgotten / lost the GUI password, you can reset it using the
\fB\-\-gui\-password\fP (and possibly \fB\-\-gui\-user\fP) options to the
\fI\%\-\-gui\-password\fP (and possibly \fI\%\-\-gui\-user\fP) options to the
\fBsyncthing generate\fP subcommand. This should be done while Syncthing is not
running.
.INDENT 0.0
@@ -713,9 +713,9 @@ Stop Syncthing: \fBsyncthing cli operations shutdown\fP
Restart Syncthing as usual.
.UNINDENT
.sp
\fIAlternatively, in step 2\fP, you can manually delete the \fB<user>\fP and \fB<password>\fP XML tags from the
\fIAlternatively, in step 2\fP, you can manually delete the \fI\%<user>\fP and \fI\%<password>\fP XML tags from the
\fB<gui>\fP block in file \fBconfig.xml\fP\&. The location of the file depends on the
OS and is described in the configuration documentation\&.
OS and is described in the \fI\%configuration documentation\fP\&.
.sp
For example, the two emphasized lines below would be removed from the file.
.INDENT 0.0
@@ -723,7 +723,7 @@ For example, the two emphasized lines below would be removed from the file.
.sp
.nf
.ft C
<gui enabled="true" tls="false" debugging="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq debugging=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
<user>syncguy</user>
<password>$2a$10$s9wWHOQe...Cq7GPye69</password>
man/syncthing-globaldisco.7
+2 -2
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-GLOBALDISCO" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.SH ANNOUNCEMENTS
@@ -42,7 +42,7 @@ listing connection addresses (if any):
.nf
.ft C
{
addresses: ["tcp://192.0.2.45:22000", "tcp://:22202", "relay://192.0.2.99:22028"],
addresses: [\(dqtcp://192.0.2.45:22000\(dq, \(dqtcp://:22202\(dq, \(dqrelay://192.0.2.99:22028\(dq],
}
.ft P
.fi
man/syncthing-localdisco.7
+2 -2
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-LOCALDISCO" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.SH MODE OF OPERATION
@@ -55,7 +55,7 @@ previously unknown device is discovered or a device has restarted (see the
.SH DEVICE ID
.sp
The device ID is the SHA\-256 (32 bytes) of the device X.509 certificate. See
device\-ids in the Syncthing documentation.
\fI\%Understanding Device IDs\fP in the Syncthing documentation.
.SH ANNOUNCEMENT PACKET
.sp
The Announcement packet has the following structure:
man/syncthing-networking.7
+3 -3
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-NETWORKING" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.SH ROUTER SETUP
@@ -57,7 +57,7 @@ Communication in Syncthing works both ways. Therefore if you set up port
forwards for one device, other devices will be able to connect to it even when
they are behind a NAT network or firewall.
.sp
In the absence of port forwarding, relaying may work well enough to get
In the absence of port forwarding, \fI\%Relaying\fP may work well enough to get
devices connected and synced, but will perform poorly in comparison to a
direct connection.
.SS Local Discovery
@@ -171,7 +171,7 @@ port 8384 on the target machine. This still works even if Syncthing is bound to
listen on localhost only.
.SH VIA A PROXY
.sp
Syncthing can use a SOCKS5 proxy for outbound connections. Please see proxying\&.
Syncthing can use a SOCKS5 proxy for outbound connections. Please see \fI\%Using Proxies\fP\&.
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT
man/syncthing-relay.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-RELAY" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.SH WHAT IS A RELAY?
man/syncthing-rest-api.7
+683 -683
View File
File diff suppressed because it is too large Load Diff
man/syncthing-security.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-SECURITY" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.sp
man/syncthing-stignore.5
+9 -9
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-STIGNORE" "5" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.SH SYNOPSIS
@@ -147,7 +147,7 @@ single pair of parentheses (not “(?di)”).
.INDENT 3.5
Include patterns (that begin with \fB!\fP) cause Syncthing to traverse
the entire directory tree regardless of other ignore patterns.
If the watcher is enabled, the entire directory
If the \fI\%watcher\fP is enabled, the entire directory
tree will be watched as well.
.sp
Top\-level include patterns are treated as special cases and will not force Syncthing to
@@ -207,16 +207,16 @@ all files and directories called “foo”, ending in a “2” or starting with
.nf
.ft C
\&.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"
foo # ignored, matches \(dqfoo\(dq
foofoo # synced, does not match \(dqfoo\(dq but would match \(dqfoo*\(dq or \(dq*foo\(dq
bar/ # synced
baz # synced
quux # ignored, matches "qu*"
quuz # synced, matches "qu*" but is excluded by the preceding "!quuz"
bar2/ # synced, despite matching "*2" due to child frobble
quux # ignored, matches \(dqqu*\(dq
quuz # synced, matches \(dqqu*\(dq but is excluded by the preceding \(dq!quuz\(dq
bar2/ # synced, despite matching \(dq*2\(dq due to child frobble
baz # ignored, due to parent being ignored
frobble # synced, due to "!frobble"
My Pictures/ # ignored, matched case insensitive "(?i)my pictures" pattern
frobble # synced, due to \(dq!frobble\(dq
My Pictures/ # ignored, matched case insensitive \(dq(?i)my pictures\(dq pattern
Img15.PNG # ignored, due to parent being ignored
.ft P
.fi
man/syncthing-versioning.7
+26 -26
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-VERSIONING" "7" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.sp
@@ -156,14 +156,14 @@ set \-eu
versionspath=~/.trashcan
# The parameters we get from Syncthing
folderpath="$1"
filepath="$2"
folderpath=\(dq$1\(dq
filepath=\(dq$2\(dq
# First ensure the dir where we need to store the file exists
outpath=$(dirname "$versionspath/$filepath")
mkdir \-p "$outpath"
outpath=$(dirname \(dq$versionspath/$filepath\(dq)
mkdir \-p \(dq$outpath\(dq
# Then move the file there
mv \-f "$folderpath/$filepath" "$versionspath/$filepath"
mv \-f \(dq$folderpath/$filepath\(dq \(dq$versionspath/$filepath\(dq
.ft P
.fi
.UNINDENT
@@ -209,25 +209,25 @@ rem We need command extensions for md to create intermediate folders in one go
setlocal enableextensions
rem Where I want my versions stored
set "versions_path=%USERPROFILE%\e.trashcan"
set \(dqversions_path=%USERPROFILE%\e.trashcan\(dq
rem The parameters we get from Syncthing, \(aq~\(aq removes quotes if any
set "folder_path=%~1"
set "file_path=%~2"
set \(dqfolder_path=%~1\(dq
set \(dqfile_path=%~2\(dq
rem First ensure the dir where we need to store the file exists
for %%f in ("%versions_path%\e%file_path%") do set "output_path=%%~dpf"
if not exist "%output_path%" md "%output_path%" || exit /b
for %%f in (\(dq%versions_path%\e%file_path%\(dq) do set \(dqoutput_path=%%~dpf\(dq
if not exist \(dq%output_path%\(dq md \(dq%output_path%\(dq || exit /b
rem Finally move the file, overwrite existing file if any
move /y "%folder_path%\e%file_path%" "%versions_path%\e%file_path%"
move /y \(dq%folder_path%\e%file_path%\(dq \(dq%versions_path%\e%file_path%\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, I set \fB"C:\eUsers\emfrnd\eScripts\eonlylatest.bat" "%FOLDER_PATH%"
"%FILE_PATH%"\fP as the command name in Syncthing.
Finally, I set \fB\(dqC:\eUsers\emfrnd\eScripts\eonlylatest.bat\(dq \(dq%FOLDER_PATH%\(dq
\(dq%FILE_PATH%\(dq\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
@@ -245,7 +245,7 @@ location, e.g. \fBC:\eUsers\eUser\eScripts\eSendToRecycleBin.ps1\fP\&.
Add\-Type \-AssemblyName Microsoft.VisualBasic
[Microsoft.VisualBasic.FileIO.FileSystem]::DeleteFile($args,\(aqOnlyErrorDialogs\(aq,\(aqSendToRecycleBin\(aq)
if ($?) {
Write\-Output ("Recycled " + $args + ".")
Write\-Output (\(dqRecycled \(dq + $args + \(dq.\(dq)
}
.ft P
.fi
@@ -268,15 +268,15 @@ Add\-Type \-AssemblyName Microsoft.VisualBasic
# 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")) {
if (Test\-Path \-LiteralPath ((Split\-Path \-Path $args) + \(dq\e~syncthing~\(dq + (Split\-Path \-Path $args \-Leaf) + \(dq.tmp\(dq)) {
[Microsoft.VisualBasic.FileIO.FileSystem]::DeleteFile($args,\(aqOnlyErrorDialogs\(aq,\(aqDeletePermanently\(aq)
if ($?) {
Write\-Output ("Deleted " + $args + ".")
Write\-Output (\(dqDeleted \(dq + $args + \(dq.\(dq)
}
} else {
[Microsoft.VisualBasic.FileIO.FileSystem]::DeleteFile($args,\(aqOnlyErrorDialogs\(aq,\(aqSendToRecycleBin\(aq)
if ($?) {
Write\-Output ("Recycled " + $args + ".")
Write\-Output (\(dqRecycled \(dq + $args + \(dq.\(dq)
}
}
.ft P
@@ -285,8 +285,8 @@ if (Test\-Path \-LiteralPath ((Split\-Path \-Path $args) + "\e~syncthing~" + (Sp
.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\&.
\-ExecutionPolicy Bypass \-File \(dqC:\eUsers\eUser\eScripts\eSendToRecycleBin.ps1\(dq
\(dq%FOLDER_PATH%\e%FILE_PATH%\(dq\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
@@ -295,20 +295,20 @@ files permanently.
.SH CONFIGURATION PARAMETER REFERENCE
.sp
The versioning settings are grouped into their own section of each folder in the
\fBconfiguration file\fP\&. The following shows an
\fI\%configuration file\fP\&. The following shows an
example of such a section in the XML:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<folder id="...">
<versioning type="simple">
<folder id=\(dq...\(dq>
<versioning type=\(dqsimple\(dq>
<cleanupIntervalS>3600</cleanupIntervalS>
<fsPath></fsPath>
<fsType>basic</fsType>
<param key="cleanoutDays" val="0"></param>
<param key="keep" val="5"></param>
<param key=\(dqcleanoutDays\(dq val=\(dq0\(dq></param>
<param key=\(dqkeep\(dq val=\(dq5\(dq></param>
</versioning>
</folder>
.ft P
@@ -338,7 +338,7 @@ in the \fI\%params\fP element.
.B versioning.fsType
The internal file system implementation used to access this versions folder.
Only applies if \fI\%fsPath\fP is also set non\-empty,
otherwise the \fBfilesystemType\fP from the folder element is used
otherwise the \fI\%filesystemType\fP from the folder element is used
instead. Refer to that option description for possible values. Ignored for
the \fBexternal\fP versioning strategy.
.sp
man/syncthing.1
+4 -4
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING" "1" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING" "1" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing \- Syncthing
.SH SYNOPSIS
@@ -99,7 +99,7 @@ Write events to timestamped file \fBaudit\-YYYYMMDD\-HHMMSS.log\fP\&.
.INDENT 0.0
.TP
.B \-\-auditfile=<file|\-|\-\->
Use specified file or stream (\fB"\-"\fP for stdout, \fB"\-\-"\fP for stderr) for
Use specified file or stream (\fB\(dq\-\(dq\fP for stdout, \fB\(dq\-\-\(dq\fP for stderr) for
audit events, rather than the timestamped default file name.
.UNINDENT
.INDENT 0.0
@@ -170,7 +170,7 @@ together with \fB\-\-config\fP\&.
.INDENT 0.0
.TP
.B \-\-logfile=<filename>
Set destination filename for logging (use \fB"\-"\fP for stdout, which is the
Set destination filename for logging (use \fB\(dq\-\(dq\fP for stdout, which is the
default option).
.UNINDENT
.INDENT 0.0
@@ -363,7 +363,7 @@ it is validated and updated to the latest configuration schema, including adding
default values for any new options.
.sp
The \fBdecrypt\fP subcommand is used in conjunction with untrusted (encrypted)
devices, see the relevant section on decryption for
devices, see the relevant section on \fI\%decryption\fP for
details. It does not depend on Syncthing to be running, but works on offline
data.
.sp