diff options
author | Syncthing Release Automation <release@syncthing.net> | 2023-09-18 03:45:31 +0000 |
---|---|---|
committer | Syncthing Release Automation <release@syncthing.net> | 2023-09-18 03:45:31 +0000 |
commit | 58d1f3a4718ef8f86bfae1b9ed61dda8d7a26a59 (patch) | |
tree | 8e6e429cef1c4c8b5ba4d38fa68a0159b3e90862 /man | |
parent | c9dfd75d8eb2d27a54e6b87fa9032611dc1c0ecb (diff) | |
download | syncthing-58d1f3a4718ef8f86bfae1b9ed61dda8d7a26a59.tar.gz syncthing-58d1f3a4718ef8f86bfae1b9ed61dda8d7a26a59.zip |
gui, man, authors: Update docs, translations, and contributors
Diffstat (limited to 'man')
-rw-r--r-- | man/stdiscosrv.1 | 8 | ||||
-rw-r--r-- | man/strelaysrv.1 | 6 | ||||
-rw-r--r-- | man/syncthing-bep.7 | 4 | ||||
-rw-r--r-- | man/syncthing-config.5 | 130 | ||||
-rw-r--r-- | man/syncthing-device-ids.7 | 2 | ||||
-rw-r--r-- | man/syncthing-event-api.7 | 766 | ||||
-rw-r--r-- | man/syncthing-faq.7 | 44 | ||||
-rw-r--r-- | man/syncthing-globaldisco.7 | 4 | ||||
-rw-r--r-- | man/syncthing-localdisco.7 | 4 | ||||
-rw-r--r-- | man/syncthing-networking.7 | 6 | ||||
-rw-r--r-- | man/syncthing-relay.7 | 2 | ||||
-rw-r--r-- | man/syncthing-rest-api.7 | 1366 | ||||
-rw-r--r-- | man/syncthing-security.7 | 2 | ||||
-rw-r--r-- | man/syncthing-stignore.5 | 18 | ||||
-rw-r--r-- | man/syncthing-versioning.7 | 52 | ||||
-rw-r--r-- | man/syncthing.1 | 8 |
16 files changed, 1211 insertions, 1211 deletions
diff --git a/man/stdiscosrv.1 b/man/stdiscosrv.1 index db42f8c36..48e14e80b 100644 --- a/man/stdiscosrv.1 +++ b/man/stdiscosrv.1 @@ -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 diff --git a/man/strelaysrv.1 b/man/strelaysrv.1 index 9d0faa032..5a4cae3eb 100644 --- a/man/strelaysrv.1 +++ b/man/strelaysrv.1 @@ -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. diff --git a/man/syncthing-bep.7 b/man/syncthing-bep.7 index 03d5042c1..830208514 100644 --- a/man/syncthing-bep.7 +++ b/man/syncthing-bep.7 @@ -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 diff --git a/man/syncthing-config.5 b/man/syncthing-config.5 index 5b1ff0f98..10e196e75 100644 --- a/man/syncthing-config.5 +++ b/man/syncthing-config.5 @@ -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 diff --git a/man/syncthing-device-ids.7 b/man/syncthing-device-ids.7 index 2080435d7..920df1c8b 100644 --- a/man/syncthing-device-ids.7 +++ b/man/syncthing-device-ids.7 @@ -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 diff --git a/man/syncthing-event-api.7 b/man/syncthing-event-api.7 index cdb891fdb..d268ba358 100644 --- a/man/syncthing-event-api.7 +++ b/man/syncthing-event-api.7 @@ -27,13 +27,13 @@ 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-EVENT-API" "7" "Sep 07, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-EVENT-API" "7" "Sep 17, 2023" "v1.24.0" "Syncthing" .SH NAME syncthing-event-api \- Event API .SH DESCRIPTION .sp Syncthing provides a simple long polling interface for exposing events from the -core utility towards a GUI. To receive events, see /rest/events\-get\&. +core utility towards a GUI. To receive events, see \fI\%GET /rest/events\fP\&. .SH EVENT STRUCTURE .sp Each event is represented by an object similar to the following: @@ -43,13 +43,13 @@ Each event is represented by an object similar to the following: .nf .ft C { - "id": 2, - "globalID": 3, - "type": "DeviceConnected", - "time": "2014\-07\-13T21:04:33.687836696+02:00", - "data": { - "addr": "172.16.32.25:22000", - "id": "NFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG" + \(dqid\(dq: 2, + \(dqglobalID\(dq: 3, + \(dqtype\(dq: \(dqDeviceConnected\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:04:33.687836696+02:00\(dq, + \(dqdata\(dq: { + \(dqaddr\(dq: \(dq172.16.32.25:22000\(dq, + \(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq } } .ft P @@ -96,12 +96,12 @@ message received from a remote device. It is mainly used for internal purposes. .nf .ft C { - "id": 84, - "globalID": 84, - "type": "ClusterConfigReceived", - "time": "2022\-04\-27T14:14:27.043576583+09:00", - "data": { - "device": "I6KAH76\-66SLLLB\-5PFXSOA\-UFJCDZC\-YAOMLEK\-CP2GB32\-BV5RQST\-3PSROAU" + \(dqid\(dq: 84, + \(dqglobalID\(dq: 84, + \(dqtype\(dq: \(dqClusterConfigReceived\(dq, + \(dqtime\(dq: \(dq2022\-04\-27T14:14:27.043576583+09:00\(dq, + \(dqdata\(dq: { + \(dqdevice\(dq: \(dqI6KAH76\-66SLLLB\-5PFXSOA\-UFJCDZC\-YAOMLEK\-CP2GB32\-BV5RQST\-3PSROAU\(dq } } .ft P @@ -118,19 +118,19 @@ itself. .nf .ft C { - "id": 50, - "globalID": 50, - "type": "ConfigSaved", - "time": "2014\-12\-13T00:09:13.5166486Z", - "data": { - "version": 7, - "folders": [{"..."}], - "devices": [{"..."}], - "gui": {"..."}, - "ldap": {"..."}, - "options": {"..."}, - "remoteIgnoredDevices": [{"..."}], - "defaults": {"..."} + \(dqid\(dq: 50, + \(dqglobalID\(dq: 50, + \(dqtype\(dq: \(dqConfigSaved\(dq, + \(dqtime\(dq: \(dq2014\-12\-13T00:09:13.5166486Z\(dq, + \(dqdata\(dq: { + \(dqversion\(dq: 7, + \(dqfolders\(dq: [{\(dq...\(dq}], + \(dqdevices\(dq: [{\(dq...\(dq}], + \(dqgui\(dq: {\(dq...\(dq}, + \(dqldap\(dq: {\(dq...\(dq}, + \(dqoptions\(dq: {\(dq...\(dq}, + \(dqremoteIgnoredDevices\(dq: [{\(dq...\(dq}], + \(dqdefaults\(dq: {\(dq...\(dq} } } .ft P @@ -146,17 +146,17 @@ Generated each time a connection to a device has been established. .nf .ft C { - "id": 2, - "globalID": 2, - "type": "DeviceConnected", - "time": "2014\-07\-13T21:04:33.687836696+02:00", - "data": { - "addr": "172.16.32.25:22000", - "id": "NFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG", - "deviceName": "Laptop", - "clientName": "syncthing", - "clientVersion": "v0.13.4", - "type": "TCP (Client)" + \(dqid\(dq: 2, + \(dqglobalID\(dq: 2, + \(dqtype\(dq: \(dqDeviceConnected\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:04:33.687836696+02:00\(dq, + \(dqdata\(dq: { + \(dqaddr\(dq: \(dq172.16.32.25:22000\(dq, + \(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq, + \(dqdeviceName\(dq: \(dqLaptop\(dq, + \(dqclientName\(dq: \(dqsyncthing\(dq, + \(dqclientVersion\(dq: \(dqv0.13.4\(dq, + \(dqtype\(dq: \(dqTCP (Client)\(dq } } .ft P @@ -172,13 +172,13 @@ Generated each time a connection to a device has been terminated. .nf .ft C { - "id": 48, - "globalID": 48, - "type": "DeviceDisconnected", - "time": "2014\-07\-13T21:18:52.859929215+02:00", - "data": { - "error": "unexpected EOF", - "id": "NFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG" + \(dqid\(dq: 48, + \(dqglobalID\(dq: 48, + \(dqtype\(dq: \(dqDeviceDisconnected\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:18:52.859929215+02:00\(dq, + \(dqdata\(dq: { + \(dqerror\(dq: \(dqunexpected EOF\(dq, + \(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq } } .ft P @@ -204,15 +204,15 @@ Emitted when a new device is discovered using local discovery. .nf .ft C { - "id": 13, - "globalID": 13, - "type": "DeviceDiscovered", - "time": "2014\-07\-17T13:28:05.043465207+02:00", - "data": { - "addrs": [ - "172.16.32.25:22000" + \(dqid\(dq: 13, + \(dqglobalID\(dq: 13, + \(dqtype\(dq: \(dqDeviceDiscovered\(dq, + \(dqtime\(dq: \(dq2014\-07\-17T13:28:05.043465207+02:00\(dq, + \(dqdata\(dq: { + \(dqaddrs\(dq: [ + \(dq172.16.32.25:22000\(dq ], - "device": "NFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG" + \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq } } .ft P @@ -228,12 +228,12 @@ Emitted when a device was paused. .nf .ft C { - "id": 13, - "globalID": 13, - "type": "DevicePaused", - "time": "2014\-07\-17T13:28:05.043465207+02:00", - "data": { - "device": "NFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG" + \(dqid\(dq: 13, + \(dqglobalID\(dq: 13, + \(dqtype\(dq: \(dqDevicePaused\(dq, + \(dqtime\(dq: \(dq2014\-07\-17T13:28:05.043465207+02:00\(dq, + \(dqdata\(dq: { + \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq } } .ft P @@ -243,7 +243,7 @@ Emitted when a device was paused. .SS DeviceRejected (DEPRECATED) .sp Deprecated since version v1.13.0: This event is still emitted for compatibility, but deprecated. Use -the replacement pendingdeviceschanged event instead. +the replacement \fI\%PendingDevicesChanged\fP event instead. .sp Emitted when there is a connection from a device we are not configured @@ -254,14 +254,14 @@ to talk to. .nf .ft C { - "id": 24, - "globalID": 24, - "type": "DeviceRejected", - "time": "2014\-08\-19T10:43:00.562821045+02:00", - "data": { - "address": "127.0.0.1:51807", - "name": "My dusty computer", - "device": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK" + \(dqid\(dq: 24, + \(dqglobalID\(dq: 24, + \(dqtype\(dq: \(dqDeviceRejected\(dq, + \(dqtime\(dq: \(dq2014\-08\-19T10:43:00.562821045+02:00\(dq, + \(dqdata\(dq: { + \(dqaddress\(dq: \(dq127.0.0.1:51807\(dq, + \(dqname\(dq: \(dqMy dusty computer\(dq, + \(dqdevice\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq } } .ft P @@ -277,12 +277,12 @@ Generated each time a device was resumed. .nf .ft C { - "id": 2, - "globalID": 2, - "type": "DeviceResumed", - "time": "2014\-07\-13T21:04:33.687836696+02:00", - "data": { - "device": "NFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG" + \(dqid\(dq: 2, + \(dqglobalID\(dq: 2, + \(dqtype\(dq: \(dqDeviceResumed\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:04:33.687836696+02:00\(dq, + \(dqdata\(dq: { + \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq } } .ft P @@ -300,53 +300,53 @@ configuration can cause multiple files to be shown. .nf .ft C { - "id": 221, - "globalID": 221, - "type": "DownloadProgress", - "time": "2014\-12\-13T00:26:12.9876937Z", - "data": { - "folder1": { - "file1": { - "total": 800, - "pulling": 2, - "copiedFromOrigin": 0, - "reused": 633, - "copiedFromElsewhere": 0, - "pulled": 38, - "bytesTotal": 104792064, - "bytesDone": 87883776 + \(dqid\(dq: 221, + \(dqglobalID\(dq: 221, + \(dqtype\(dq: \(dqDownloadProgress\(dq, + \(dqtime\(dq: \(dq2014\-12\-13T00:26:12.9876937Z\(dq, + \(dqdata\(dq: { + \(dqfolder1\(dq: { + \(dqfile1\(dq: { + \(dqtotal\(dq: 800, + \(dqpulling\(dq: 2, + \(dqcopiedFromOrigin\(dq: 0, + \(dqreused\(dq: 633, + \(dqcopiedFromElsewhere\(dq: 0, + \(dqpulled\(dq: 38, + \(dqbytesTotal\(dq: 104792064, + \(dqbytesDone\(dq: 87883776 }, - "dir\e\efile2": { - "total": 80, - "pulling": 2, - "copiedFromOrigin": 0, - "reused": 0, - "copiedFromElsewhere": 0, - "pulled": 32, - "bytesTotal": 10420224, - "bytesDone": 4128768 + \(dqdir\e\efile2\(dq: { + \(dqtotal\(dq: 80, + \(dqpulling\(dq: 2, + \(dqcopiedFromOrigin\(dq: 0, + \(dqreused\(dq: 0, + \(dqcopiedFromElsewhere\(dq: 0, + \(dqpulled\(dq: 32, + \(dqbytesTotal\(dq: 10420224, + \(dqbytesDone\(dq: 4128768 } }, - "folder2": { - "file3": { - "total": 800, - "pulling": 2, - "copiedFromOrigin": 0, - "reused": 633, - "copiedFromElsewhere": 0, - "pulled": 38, - "bytesTotal": 104792064, - "bytesDone": 87883776 + \(dqfolder2\(dq: { + \(dqfile3\(dq: { + \(dqtotal\(dq: 800, + \(dqpulling\(dq: 2, + \(dqcopiedFromOrigin\(dq: 0, + \(dqreused\(dq: 633, + \(dqcopiedFromElsewhere\(dq: 0, + \(dqpulled\(dq: 38, + \(dqbytesTotal\(dq: 104792064, + \(dqbytesDone\(dq: 87883776 }, - "dir\e\efile4": { - "total": 80, - "pulling": 2, - "copiedFromOrigin": 0, - "reused": 0, - "copiedFromElsewhere": 0, - "pulled": 32, - "bytesTotal": 10420224, - "bytesDone": 4128768 + \(dqdir\e\efile4\(dq: { + \(dqtotal\(dq: 80, + \(dqpulling\(dq: 2, + \(dqcopiedFromOrigin\(dq: 0, + \(dqreused\(dq: 0, + \(dqcopiedFromElsewhere\(dq: 0, + \(dqpulled\(dq: 32, + \(dqbytesTotal\(dq: 10420224, + \(dqbytesDone\(dq: 4128768 } } } @@ -396,11 +396,11 @@ The \fBdata\fP field contains a textual error message. .nf .ft C { - "id": 93, - "globalID": 93, - "type": "Failure", - "time": "2021\-06\-07T21:22:03.414609034+02:00", - "data": "index handler got paused while already paused" + \(dqid\(dq: 93, + \(dqglobalID\(dq: 93, + \(dqtype\(dq: \(dqFailure\(dq, + \(dqtime\(dq: \(dq2021\-06\-07T21:22:03.414609034+02:00\(dq, + \(dqdata\(dq: \(dqindex handler got paused while already paused\(dq } .ft P .fi @@ -424,21 +424,21 @@ either \fBpaused\fP, \fBnotSharing\fP, or \fBvalid\fP if the remote is sharing b .nf .ft C { - "id": 84, - "globalID": 84, - "type": "FolderCompletion", - "time": "2022\-04\-27T14:14:27.043576583+09:00", - "data": { - "completion": 100, - "device": "I6KAH76\-66SLLLB\-5PFXSOA\-UFJCDZC\-YAOMLEK\-CP2GB32\-BV5RQST\-3PSROAU", - "folder": "default", - "globalBytes": 17, - "globalItems": 4, - "needBytes": 0, - "needDeletes": 0, - "needItems": 0, - "remoteState": "valid", - "sequence": 12 + \(dqid\(dq: 84, + \(dqglobalID\(dq: 84, + \(dqtype\(dq: \(dqFolderCompletion\(dq, + \(dqtime\(dq: \(dq2022\-04\-27T14:14:27.043576583+09:00\(dq, + \(dqdata\(dq: { + \(dqcompletion\(dq: 100, + \(dqdevice\(dq: \(dqI6KAH76\-66SLLLB\-5PFXSOA\-UFJCDZC\-YAOMLEK\-CP2GB32\-BV5RQST\-3PSROAU\(dq, + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqglobalBytes\(dq: 17, + \(dqglobalItems\(dq: 4, + \(dqneedBytes\(dq: 0, + \(dqneedDeletes\(dq: 0, + \(dqneedItems\(dq: 0, + \(dqremoteState\(dq: \(dqvalid\(dq, + \(dqsequence\(dq: 12 } } .ft P @@ -458,17 +458,17 @@ synchronization attempt, a new \fBFolderErrors\fP event is emitted. .nf .ft C { - "id": 132, - "type": "FolderErrors", - "time": "2015\-06\-26T13:39:24.697401384+02:00", - "data": { - "errors": [ + \(dqid\(dq: 132, + \(dqtype\(dq: \(dqFolderErrors\(dq, + \(dqtime\(dq: \(dq2015\-06\-26T13:39:24.697401384+02:00\(dq, + \(dqdata\(dq: { + \(dqerrors\(dq: [ { - "error": "open /Users/jb/src/github.com/syncthing/syncthing/test/s2/h2j/.syncthing.aslkjd.tmp: permission denied", - "path": "h2j/aslkjd" + \(dqerror\(dq: \(dqopen /Users/jb/src/github.com/syncthing/syncthing/test/s2/h2j/.syncthing.aslkjd.tmp: permission denied\(dq, + \(dqpath\(dq: \(dqh2j/aslkjd\(dq } ], - "folder": "default" + \(dqfolder\(dq: \(dqdefault\(dq } } .ft P @@ -482,7 +482,7 @@ New in version 0.11.12. \fBSEE ALSO:\fP .INDENT 0.0 .INDENT 3.5 -The statechanged event. +The \fI\%StateChanged\fP event. .UNINDENT .UNINDENT .SS FolderPaused @@ -495,13 +495,13 @@ of a folder. Sent repeatedly for each changed folder. .nf .ft C { - "id": 93, - "globalID": 93, - "type": "FolderPaused", - "time": "2021\-06\-07T23:45:03.414609034+02:00", - "data": { - "id": "abcde\-fghij", - "label": "My folder" + \(dqid\(dq: 93, + \(dqglobalID\(dq: 93, + \(dqtype\(dq: \(dqFolderPaused\(dq, + \(dqtime\(dq: \(dq2021\-06\-07T23:45:03.414609034+02:00\(dq, + \(dqdata\(dq: { + \(dqid\(dq: \(dqabcde\-fghij\(dq, + \(dqlabel\(dq: \(dqMy folder\(dq } } .ft P @@ -511,7 +511,7 @@ of a folder. Sent repeatedly for each changed folder. .SS FolderRejected (DEPRECATED) .sp Deprecated since version v1.13.0: This event is still emitted for compatibility, but deprecated. Use -the replacement pendingfolderschanged event instead. +the replacement \fI\%PendingFoldersChanged\fP event instead. .sp Emitted when a device sends index information for a folder we do not @@ -522,14 +522,14 @@ have, or have but do not share with the device in question. .nf .ft C { - "id": 27, - "globalID": 27, - "type": "FolderRejected", - "time": "2014\-08\-19T10:41:06.761751399+02:00", - "data": { - "device": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK", - "folder": "GXWxf\-3zgnU", - "folderLabel": "My Pictures" + \(dqid\(dq: 27, + \(dqglobalID\(dq: 27, + \(dqtype\(dq: \(dqFolderRejected\(dq, + \(dqtime\(dq: \(dq2014\-08\-19T10:41:06.761751399+02:00\(dq, + \(dqdata\(dq: { + \(dqdevice\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq, + \(dqfolder\(dq: \(dqGXWxf\-3zgnU\(dq, + \(dqfolderLabel\(dq: \(dqMy Pictures\(dq } } .ft P @@ -546,13 +546,13 @@ of a folder. Sent repeatedly for each changed folder. .nf .ft C { - "id": 93, - "globalID": 93, - "type": "FolderResumed", - "time": "2021\-06\-07T23:45:03.414609034+02:00", - "data": { - "id": "abcde\-fghij", - "label": "My folder" + \(dqid\(dq: 93, + \(dqglobalID\(dq: 93, + \(dqtype\(dq: \(dqFolderResumed\(dq, + \(dqtime\(dq: \(dq2021\-06\-07T23:45:03.414609034+02:00\(dq, + \(dqdata\(dq: { + \(dqid\(dq: \(dqabcde\-fghij\(dq, + \(dqlabel\(dq: \(dqMy folder\(dq } } .ft P @@ -570,16 +570,16 @@ total , as well as the current scanning rates in bytes per second. .nf .ft C { - "data" : { - "total" : 1, - "rate" : 0, - "current" : 0, - "folder" : "bd7q3\-zskm5" + \(dqdata\(dq : { + \(dqtotal\(dq : 1, + \(dqrate\(dq : 0, + \(dqcurrent\(dq : 0, + \(dqfolder\(dq : \(dqbd7q3\-zskm5\(dq }, - "globalID" : 29, - "type" : "FolderScanProgress", - "time" : "2017\-03\-06T15:00:58.072004209+01:00", - "id" : 29 + \(dqglobalID\(dq : 29, + \(dqtype\(dq : \(dqFolderScanProgress\(dq, + \(dqtime\(dq : \(dq2017\-03\-06T15:00:58.072004209+01:00\(dq, + \(dqid\(dq : 29 } .ft P .fi @@ -596,28 +596,28 @@ state. .nf .ft C { - "id": 16, - "globalID": 16, - "type": "FolderSummary", - "time": "2015\-04\-17T14:12:20.460121585+09:00", - "data": { - "folder": "default", - "summary": { - "globalBytes": 0, - "globalDeleted": 0, - "globalFiles": 0, - "ignorePatterns": false, - "inSyncBytes": 0, - "inSyncFiles": 0, - "invalid": "", - "localBytes": 0, - "localDeleted": 0, - "localFiles": 0, - "needBytes": 0, - "needFiles": 0, - "state": "idle", - "stateChanged": "2015\-04\-17T14:12:12.455224687+09:00", - "version": 0 + \(dqid\(dq: 16, + \(dqglobalID\(dq: 16, + \(dqtype\(dq: \(dqFolderSummary\(dq, + \(dqtime\(dq: \(dq2015\-04\-17T14:12:20.460121585+09:00\(dq, + \(dqdata\(dq: { + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqsummary\(dq: { + \(dqglobalBytes\(dq: 0, + \(dqglobalDeleted\(dq: 0, + \(dqglobalFiles\(dq: 0, + \(dqignorePatterns\(dq: false, + \(dqinSyncBytes\(dq: 0, + \(dqinSyncFiles\(dq: 0, + \(dqinvalid\(dq: \(dq\(dq, + \(dqlocalBytes\(dq: 0, + \(dqlocalDeleted\(dq: 0, + \(dqlocalFiles\(dq: 0, + \(dqneedBytes\(dq: 0, + \(dqneedFiles\(dq: 0, + \(dqstate\(dq: \(dqidle\(dq, + \(dqstateChanged\(dq: \(dq2015\-04\-17T14:12:12.455224687+09:00\(dq, + \(dqversion\(dq: 0 } } } @@ -638,13 +638,13 @@ If there was no error in either of these, the respective field is omitted. .nf .ft C { - "id": 123, - "type": "FolderWatchStateChanged", - "time": "2022\-03\-14T12:34:56.890000000+01:00", - "data": { - "folder": "default", - "from": "Something bad happened.", - "to": "Something worse happened." + \(dqid\(dq: 123, + \(dqtype\(dq: \(dqFolderWatchStateChanged\(dq, + \(dqtime\(dq: \(dq2022\-03\-14T12:34:56.890000000+01:00\(dq, + \(dqdata\(dq: { + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqfrom\(dq: \(dqSomething bad happened.\(dq, + \(dqto\(dq: \(dqSomething worse happened.\(dq } } .ft P @@ -661,16 +661,16 @@ successful operation: .nf .ft C { - "id": 93, - "globalID": 93, - "type": "ItemFinished", - "time": "2014\-07\-13T21:22:03.414609034+02:00", - "data": { - "item": "test.txt", - "folder": "default", - "error": null, - "type": "file", - "action": "update" + \(dqid\(dq: 93, + \(dqglobalID\(dq: 93, + \(dqtype\(dq: \(dqItemFinished\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:22:03.414609034+02:00\(dq, + \(dqdata\(dq: { + \(dqitem\(dq: \(dqtest.txt\(dq, + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqerror\(dq: null, + \(dqtype\(dq: \(dqfile\(dq, + \(dqaction\(dq: \(dqupdate\(dq } } .ft P @@ -685,16 +685,16 @@ An unsuccessful operation: .nf .ft C { - "id": 44, - "globalID": 44, - "type": "ItemFinished", - "time": "2015\-05\-27T11:21:05.711133004+02:00", - "data": { - "action": "update", - "error": "open /Users/jb/src/github.com/syncthing/syncthing/test/s2/foo/.syncthing.hej.tmp: permission denied", - "folder": "default", - "item": "foo/hej", - "type": "file" + \(dqid\(dq: 44, + \(dqglobalID\(dq: 44, + \(dqtype\(dq: \(dqItemFinished\(dq, + \(dqtime\(dq: \(dq2015\-05\-27T11:21:05.711133004+02:00\(dq, + \(dqdata\(dq: { + \(dqaction\(dq: \(dqupdate\(dq, + \(dqerror\(dq: \(dqopen /Users/jb/src/github.com/syncthing/syncthing/test/s2/foo/.syncthing.hej.tmp: permission denied\(dq, + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqitem\(dq: \(dqfoo/hej\(dq, + \(dqtype\(dq: \(dqfile\(dq } } .ft P @@ -715,15 +715,15 @@ Generated when Syncthing begins synchronizing a file to a newer version. .nf .ft C { - "id": 93, - "globalID": 93, - "type": "ItemStarted", - "time": "2014\-07\-13T21:22:03.414609034+02:00", - "data": { - "item": "test.txt", - "folder": "default", - "type": "file", - "action": "update" + \(dqid\(dq: 93, + \(dqglobalID\(dq: 93, + \(dqtype\(dq: \(dqItemStarted\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:22:03.414609034+02:00\(dq, + \(dqdata\(dq: { + \(dqitem\(dq: \(dqtest.txt\(dq, + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqtype\(dq: \(dqfile\(dq, + \(dqaction\(dq: \(dqupdate\(dq } } .ft P @@ -737,53 +737,53 @@ New in version 0.11.10: The \fBmetadata\fP action. .SS ListenAddressesChanged .sp -This event is emitted when a listen address changes. +This event is emitted when a \fI\%listen address\fP changes. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { - "type" : "ListenAddressesChanged", - "id" : 70, - "time" : "2017\-03\-06T15:01:24.88340663+01:00", - "globalID" : 70, - "data" : { - "address" : { - "Fragment" : "", - "RawQuery" : "", - "Scheme" : "dynamic+https", - "Path" : "/endpoint", - "RawPath" : "", - "User" : null, - "ForceQuery" : false, - "Host" : "relays.syncthing.net", - "Opaque" : "" + \(dqtype\(dq : \(dqListenAddressesChanged\(dq, + \(dqid\(dq : 70, + \(dqtime\(dq : \(dq2017\-03\-06T15:01:24.88340663+01:00\(dq, + \(dqglobalID\(dq : 70, + \(dqdata\(dq : { + \(dqaddress\(dq : { + \(dqFragment\(dq : \(dq\(dq, + \(dqRawQuery\(dq : \(dq\(dq, + \(dqScheme\(dq : \(dqdynamic+https\(dq, + \(dqPath\(dq : \(dq/endpoint\(dq, + \(dqRawPath\(dq : \(dq\(dq, + \(dqUser\(dq : null, + \(dqForceQuery\(dq : false, + \(dqHost\(dq : \(dqrelays.syncthing.net\(dq, + \(dqOpaque\(dq : \(dq\(dq }, - "wan" : [ + \(dqwan\(dq : [ { - "ForceQuery" : false, - "User" : null, - "Host" : "31.15.66.212:443", - "Opaque" : "", - "Path" : "/", - "RawPath" : "", - "RawQuery" : "id=F4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=", - "Scheme" : "relay", - "Fragment" : "" + \(dqForceQuery\(dq : false, + \(dqUser\(dq : null, + \(dqHost\(dq : \(dq31.15.66.212:443\(dq, + \(dqOpaque\(dq : \(dq\(dq, + \(dqPath\(dq : \(dq/\(dq, + \(dqRawPath\(dq : \(dq\(dq, + \(dqRawQuery\(dq : \(dqid=F4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=\(dq, + \(dqScheme\(dq : \(dqrelay\(dq, + \(dqFragment\(dq : \(dq\(dq } ], - "lan" : [ + \(dqlan\(dq : [ { - "RawQuery" : "id=F4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=", - "Scheme" : "relay", - "Fragment" : "", - "RawPath" : "", - "Path" : "/", - "Host" : "31.15.66.212:443", - "Opaque" : "", - "ForceQuery" : false, - "User" : null + \(dqRawQuery\(dq : \(dqid=F4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=\(dq, + \(dqScheme\(dq : \(dqrelay\(dq, + \(dqFragment\(dq : \(dq\(dq, + \(dqRawPath\(dq : \(dq\(dq, + \(dqPath\(dq : \(dq/\(dq, + \(dqHost\(dq : \(dq31.15.66.212:443\(dq, + \(dqOpaque\(dq : \(dq\(dq, + \(dqForceQuery\(dq : false, + \(dqUser\(dq : null } ] } @@ -796,13 +796,13 @@ This event is emitted when a listen address changes. .sp Generated upon scan whenever the local disk has discovered an updated file from the previous scan. This does \fInot\fP include events that are discovered and copied from -other devices (remotechangedetected), only files that were changed on the +other devices (\fI\%RemoteChangeDetected\fP), only files that were changed on the local filesystem. .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 -This event is not included in /rest/events\-get endpoint without +This event is not included in \fI\%GET /rest/events\fP endpoint without a mask specified, but needs to be selected explicitly. .UNINDENT .UNINDENT @@ -812,17 +812,17 @@ a mask specified, but needs to be selected explicitly. .nf .ft C { - "id": 7, - "globalID": 59, - "time": "2016\-09\-26T22:07:10.7189141\-04:00", - "type": "LocalChangeDetected", - "data": { - "action": "deleted", - "folder": "vitwy\-zjxqt", - "folderID": "vitwy\-zjxqt", - "label": "TestSync", - "path": "test file.rtf", - "type": "file" + \(dqid\(dq: 7, + \(dqglobalID\(dq: 59, + \(dqtime\(dq: \(dq2016\-09\-26T22:07:10.7189141\-04:00\(dq, + \(dqtype\(dq: \(dqLocalChangeDetected\(dq, + \(dqdata\(dq: { + \(dqaction\(dq: \(dqdeleted\(dq, + \(dqfolder\(dq: \(dqvitwy\-zjxqt\(dq, + \(dqfolderID\(dq: \(dqvitwy\-zjxqt\(dq, + \(dqlabel\(dq: \(dqTestSync\(dq, + \(dqpath\(dq: \(dqtest file.rtf\(dq, + \(dqtype\(dq: \(dqfile\(dq } } .ft P @@ -844,20 +844,20 @@ changes during a scan. .nf .ft C { - "id": 59, - "globalID": 59, - "type": "LocalIndexUpdated", - "time": "2014\-07\-17T13:27:28.051369434+02:00", - "data": { - "folder": "default", - "items": 1000, - "filenames": [ - "foo", - "bar", - "baz" + \(dqid\(dq: 59, + \(dqglobalID\(dq: 59, + \(dqtype\(dq: \(dqLocalIndexUpdated\(dq, + \(dqtime\(dq: \(dq2014\-07\-17T13:27:28.051369434+02:00\(dq, + \(dqdata\(dq: { + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqitems\(dq: 1000, + \(dqfilenames\(dq: [ + \(dqfoo\(dq, + \(dqbar\(dq, + \(dqbaz\(dq ], - "sequence": 12345, - "version": 12345 + \(dqsequence\(dq: 12345, + \(dqversion\(dq: 12345 } } .ft P @@ -881,15 +881,15 @@ origin of the request, but e.g. a reverse proxy. .nf .ft C { - "id" : 187, - "time" : "2017\-03\-07T00:19:24.420386143+01:00", - "data" : { - "remoteAddress" : "127.0.0.1:55530", - "username" : "somename", - "success" : false + \(dqid\(dq : 187, + \(dqtime\(dq : \(dq2017\-03\-07T00:19:24.420386143+01:00\(dq, + \(dqdata\(dq : { + \(dqremoteAddress\(dq : \(dq127.0.0.1:55530\(dq, + \(dqusername\(dq : \(dqsomename\(dq, + \(dqsuccess\(dq : false }, - "type" : "LoginAttempt", - "globalID" : 195 + \(dqtype\(dq : \(dqLoginAttempt\(dq, + \(dqglobalID\(dq : 195 } .ft P .fi @@ -908,20 +908,20 @@ unknown ID) or removed (device is ignored, dismissed or added). .nf .ft C { - "id": 87, - "type": "PendingDevicesChanged", - "time": "2020\-12\-22T22:24:37.578586718+01:00", - "data": { - "added": [ + \(dqid\(dq: 87, + \(dqtype\(dq: \(dqPendingDevicesChanged\(dq, + \(dqtime\(dq: \(dq2020\-12\-22T22:24:37.578586718+01:00\(dq, + \(dqdata\(dq: { + \(dqadded\(dq: [ { - "address": "127.0.0.1:51807", - "deviceID": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK", - "name": "My dusty computer" + \(dqaddress\(dq: \(dq127.0.0.1:51807\(dq, + \(dqdeviceID\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq, + \(dqname\(dq: \(dqMy dusty computer\(dq } ], - "removed": [ + \(dqremoved\(dq: [ { - "deviceID": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2" + \(dqdeviceID\(dq: \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq } ] } @@ -946,26 +946,26 @@ longer pending for any device. .nf .ft C { - "id": 101, - "type": "PendingFoldersChanged", - "time": "2020\-12\-22T22:36:55.66744317+01:00", - "data": { - "added": [ + \(dqid\(dq: 101, + \(dqtype\(dq: \(dqPendingFoldersChanged\(dq, + \(dqtime\(dq: \(dq2020\-12\-22T22:36:55.66744317+01:00\(dq, + \(dqdata\(dq: { + \(dqadded\(dq: [ { - "deviceID": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK", - "folderID": "GXWxf\-3zgnU", - "folderLabel": "My Pictures" - "receiveEncrypted": "false" - "remoteEncrypted": "false" + \(dqdeviceID\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq, + \(dqfolderID\(dq: \(dqGXWxf\-3zgnU\(dq, + \(dqfolderLabel\(dq: \(dqMy Pictures\(dq + \(dqreceiveEncrypted\(dq: \(dqfalse\(dq + \(dqremoteEncrypted\(dq: \(dqfalse\(dq } ], - "removed": [ + \(dqremoved\(dq: [ { - "deviceID": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2", - "folderID": "neyfh\-sa2nu" + \(dqdeviceID\(dq: \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq, + \(dqfolderID\(dq: \(dqneyfh\-sa2nu\(dq }, { - "folderID": "abcde\-fghij" + \(dqfolderID\(dq: \(dqabcde\-fghij\(dq } ] } @@ -977,12 +977,12 @@ longer pending for any device. .SS RemoteChangeDetected .sp Generated upon scan whenever a file is locally updated due to a remote change. -Files that are updated locally produce a localchangedetected event. +Files that are updated locally produce a \fI\%LocalChangeDetected\fP event. .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 -This event is not included in /rest/events\-get endpoint without +This event is not included in \fI\%GET /rest/events\fP endpoint without a mask specified, but needs to be selected explicitly. .UNINDENT .UNINDENT @@ -992,19 +992,19 @@ a mask specified, but needs to be selected explicitly. .nf .ft C { - "time" : "2017\-03\-06T23:58:21.844739891+01:00", - "globalID" : 123, - "data" : { - "type" : "file", - "action" : "deleted", - "folder": "Dokumente", - "folderID" : "Dokumente", - "path" : "testfile", - "label" : "Dokumente", - "modifiedBy" : "BPDFDTU" + \(dqtime\(dq : \(dq2017\-03\-06T23:58:21.844739891+01:00\(dq, + \(dqglobalID\(dq : 123, + \(dqdata\(dq : { + \(dqtype\(dq : \(dqfile\(dq, + \(dqaction\(dq : \(dqdeleted\(dq, + \(dqfolder\(dq: \(dqDokumente\(dq, + \(dqfolderID\(dq : \(dqDokumente\(dq, + \(dqpath\(dq : \(dqtestfile\(dq, + \(dqlabel\(dq : \(dqDokumente\(dq, + \(dqmodifiedBy\(dq : \(dqBPDFDTU\(dq }, - "type" : "RemoteChangeDetected", - "id" : 2 + \(dqtype\(dq : \(dqRemoteChangeDetected\(dq, + \(dqid\(dq : 2 } .ft P .fi @@ -1016,7 +1016,7 @@ Deprecated since version v1.1.2: The \fBfolderID\fP field is a legacy name kept .SS RemoteDownloadProgress .sp -This event is emitted when a download\-progress message is +This event is emitted when a \fI\%DownloadProgress\fP message is received. It returns a map \fBdata\fP of filenames with a count of downloaded blocks. The files in questions are currently being downloaded on the remote \fBdevice\fP and belong to \fBfolder\fP\&. @@ -1026,17 +1026,17 @@ downloaded on the remote \fBdevice\fP and belong to \fBfolder\fP\&. .nf .ft C { - "time" : "2017\-03\-07T00:11:37.65838955+01:00", - "globalID" : 170, - "data" : { - "state" : { - "tahr64\-6.0.5.iso" : 1784 + \(dqtime\(dq : \(dq2017\-03\-07T00:11:37.65838955+01:00\(dq, + \(dqglobalID\(dq : 170, + \(dqdata\(dq : { + \(dqstate\(dq : { + \(dqtahr64\-6.0.5.iso\(dq : 1784 }, - "device" : "F4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A", - "folder" : "Dokumente" + \(dqdevice\(dq : \(dqF4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A\(dq, + \(dqfolder\(dq : \(dqDokumente\(dq }, - "type" : "RemoteDownloadProgress", - "id" : 163 + \(dqtype\(dq : \(dqRemoteDownloadProgress\(dq, + \(dqid\(dq : 163 } .ft P .fi @@ -1051,14 +1051,14 @@ Generated each time new index information is received from a device. .nf .ft C { - "id": 44, - "globalID": 44, - "type": "RemoteIndexUpdated", - "time": "2014\-07\-13T21:04:35.394184435+02:00", - "data": { - "device": "NFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG", - "folder": "lightroom", - "items": 1000 + \(dqid\(dq: 44, + \(dqglobalID\(dq: 44, + \(dqtype\(dq: \(dqRemoteIndexUpdated\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:04:35.394184435+02:00\(dq, + \(dqdata\(dq: { + \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq, + \(dqfolder\(dq: \(dqlightroom\(dq, + \(dqitems\(dq: 1000 } } .ft P @@ -1075,12 +1075,12 @@ configuration etc. .nf .ft C { - "id": 1, - "globalID": 1, - "type": "Starting", - "time": "2014\-07\-17T13:13:32.044470055+02:00", - "data": { - "home": "/home/jb/.config/syncthing" + \(dqid\(dq: 1, + \(dqglobalID\(dq: 1, + \(dqtype\(dq: \(dqStarting\(dq, + \(dqtime\(dq: \(dq2014\-07\-17T13:13:32.044470055+02:00\(dq, + \(dqdata\(dq: { + \(dqhome\(dq: \(dq/home/jb/.config/syncthing\(dq } } .ft P @@ -1097,11 +1097,11 @@ ready to start exchanging data with other devices. .nf .ft C { - "id": 1, - "globalID": 1, - "type": "StartupComplete", - "time": "2014\-07\-13T21:03:18.383239179+02:00", - "data": null + \(dqid\(dq: 1, + \(dqglobalID\(dq: 1, + \(dqtype\(dq: \(dqStartupComplete\(dq, + \(dqtime\(dq: \(dq2014\-07\-13T21:03:18.383239179+02:00\(dq, + \(dqdata\(dq: null } .ft P .fi @@ -1120,15 +1120,15 @@ seconds and is now in state \fBidle\fP\&. .nf .ft C { - "id": 8, - "globalID": 8, - "type": "StateChanged", - "time": "2014\-07\-17T13:14:28.697493016+02:00", - "data": { - "folder": "default", - "from": "scanning", - "duration": 0.19782869900000002, - "to": "idle" + \(dqid\(dq: 8, + \(dqglobalID\(dq: 8, + \(dqtype\(dq: \(dqStateChanged\(dq, + \(dqtime\(dq: \(dq2014\-07\-17T13:14:28.697493016+02:00\(dq, + \(dqdata\(dq: { + \(dqfolder\(dq: \(dqdefault\(dq, + \(dqfrom\(dq: \(dqscanning\(dq, + \(dqduration\(dq: 0.19782869900000002, + \(dqto\(dq: \(dqidle\(dq } } .ft P diff --git a/man/syncthing-faq.7 b/man/syncthing-faq.7 index 612d2c234..96e00f338 100644 --- a/man/syncthing-faq.7 +++ b/man/syncthing-faq.7 @@ -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> diff --git a/man/syncthing-globaldisco.7 b/man/syncthing-globaldisco.7 index 9357c7708..5469e6b37 100644 --- a/man/syncthing-globaldisco.7 +++ b/man/syncthing-globaldisco.7 @@ -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 diff --git a/man/syncthing-localdisco.7 b/man/syncthing-localdisco.7 index 4fef4d4b0..c0164f6be 100644 --- a/man/syncthing-localdisco.7 +++ b/man/syncthing-localdisco.7 @@ -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: diff --git a/man/syncthing-networking.7 b/man/syncthing-networking.7 index c7bde03e0..a01b8a6c3 100644 --- a/man/syncthing-networking.7 +++ b/man/syncthing-networking.7 @@ -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 diff --git a/man/syncthing-relay.7 b/man/syncthing-relay.7 index ae91be73e..82e694b14 100644 --- a/man/syncthing-relay.7 +++ b/man/syncthing-relay.7 @@ -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? diff --git a/man/syncthing-rest-api.7 b/man/syncthing-rest-api.7 index 295ba1990..2b1a475fb 100644 --- a/man/syncthing-rest-api.7 +++ b/man/syncthing-rest-api.7 @@ -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-REST-API" "7" "Sep 07, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-REST-API" "7" "Sep 17, 2023" "v1.24.0" "Syncthing" .SH NAME syncthing-rest-api \- REST API .sp @@ -41,9 +41,9 @@ To use the REST API an API key must be set and used. The API key can be generated in the GUI, or set in the \fBconfiguration/gui/apikey\fP element in the configuration file. To use an API key, set the request header \fBX\-API\-Key\fP to the API key value, or set it as a \fBBearer\fP token in the -\fBAuthorization\fP header. For example, \fBcurl \-X POST \-H "X\-API\-Key: abc123" -http://localhost:8384/rest/...\fP or \fBcurl \-X POST \-H "Authorization: Bearer -abc123" http://localhost:8384/rest/...\fP can be used to invoke with \fBcurl\fP +\fBAuthorization\fP header. For example, \fBcurl \-X POST \-H \(dqX\-API\-Key: abc123\(dq +http://localhost:8384/rest/...\fP or \fBcurl \-X POST \-H \(dqAuthorization: Bearer +abc123\(dq http://localhost:8384/rest/...\fP can be used to invoke with \fBcurl\fP (add \fB\-k\fP flag when using HTTPS with a Syncthing generated or self signed certificate). .sp @@ -70,33 +70,33 @@ to the given path (e.g. \fB/tmp/\fP matches all its subdirectories). If the opti .sp .nf .ft C -$ curl \-H "X\-API\-Key: yourkey" localhost:8384/rest/system/browse | json_pp +$ curl \-H \(dqX\-API\-Key: yourkey\(dq localhost:8384/rest/system/browse | json_pp [ - "/" + \(dq/\(dq ] -$ curl \-H "X\-API\-Key: yourkey" localhost:8384/rest/system/browse?current=/var/ | json_pp +$ curl \-H \(dqX\-API\-Key: yourkey\(dq localhost:8384/rest/system/browse?current=/var/ | json_pp [ - "/var/backups/", - "/var/cache/", - "/var/lib/", - "/var/local/", - "/var/lock/", - "/var/log/", - "/var/mail/", - "/var/opt/", - "/var/run/", - "/var/spool/", - "/var/tmp/" + \(dq/var/backups/\(dq, + \(dq/var/cache/\(dq, + \(dq/var/lib/\(dq, + \(dq/var/local/\(dq, + \(dq/var/lock/\(dq, + \(dq/var/log/\(dq, + \(dq/var/mail/\(dq, + \(dq/var/opt/\(dq, + \(dq/var/run/\(dq, + \(dq/var/spool/\(dq, + \(dq/var/tmp/\(dq ] -$ curl \-H "X\-API\-Key: yourkey" localhost:8384/rest/system/browse?current=/var/*o | json_pp +$ curl \-H \(dqX\-API\-Key: yourkey\(dq localhost:8384/rest/system/browse?current=/var/*o | json_pp [ - "/var/local/", - "/var/lock/", - "/var/log/", - "/var/opt/", - "/var/spool/" + \(dq/var/local/\(dq, + \(dq/var/lock/\(dq, + \(dq/var/log/\(dq, + \(dq/var/opt/\(dq, + \(dq/var/spool/\(dq ] .ft P .fi @@ -104,7 +104,7 @@ $ curl \-H "X\-API\-Key: yourkey" localhost:8384/rest/system/browse?current=/var .UNINDENT .SS GET /rest/system/config (DEPRECATED) .sp -Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use rest\-config +Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use \fI\%/rest/config\fP instead. .sp @@ -115,256 +115,256 @@ Returns the current configuration. .nf .ft C { - "version": 35, - "folders": [ + \(dqversion\(dq: 35, + \(dqfolders\(dq: [ { - "id": "default", - "label": "Default Folder", - "filesystemType": "basic", - "path": "...", - "type": "sendreceive", - "devices": [ + \(dqid\(dq: \(dqdefault\(dq, + \(dqlabel\(dq: \(dqDefault Folder\(dq, + \(dqfilesystemType\(dq: \(dqbasic\(dq, + \(dqpath\(dq: \(dq...\(dq, + \(dqtype\(dq: \(dqsendreceive\(dq, + \(dqdevices\(dq: [ { - "deviceID": "...", - "introducedBy": "", - "encryptionPassword": "" + \(dqdeviceID\(dq: \(dq...\(dq, + \(dqintroducedBy\(dq: \(dq\(dq, + \(dqencryptionPassword\(dq: \(dq\(dq } ], - "rescanIntervalS": 3600, - "fsWatcherEnabled": true, - "fsWatcherDelayS": 10, - "ignorePerms": false, - "autoNormalize": true, - "minDiskFree": { - "value": 1, - "unit": "%" + \(dqrescanIntervalS\(dq: 3600, + \(dqfsWatcherEnabled\(dq: true, + \(dqfsWatcherDelayS\(dq: 10, + \(dqignorePerms\(dq: false, + \(dqautoNormalize\(dq: true, + \(dqminDiskFree\(dq: { + \(dqvalue\(dq: 1, + \(dqunit\(dq: \(dq%\(dq }, - "versioning": { - "type": "", - "params": {}, - "cleanupIntervalS": 3600, - "fsPath": "", - "fsType": "basic" + \(dqversioning\(dq: { + \(dqtype\(dq: \(dq\(dq, + \(dqparams\(dq: {}, + \(dqcleanupIntervalS\(dq: 3600, + \(dqfsPath\(dq: \(dq\(dq, + \(dqfsType\(dq: \(dqbasic\(dq }, - "copiers": 0, - "pullerMaxPendingKiB": 0, - "hashers": 0, - "order": "random", - "ignoreDelete": false, - "scanProgressIntervalS": 0, - "pullerPauseS": 0, - "maxConflicts": \-1, - "disableSparseFiles": false, - "disableTempIndexes": false, - "paused": false, - "weakHashThresholdPct": 25, - "markerName": ".stfolder", - "copyOwnershipFromParent": false, - "modTimeWindowS": 0, - "maxConcurrentWrites": 2, - "disableFsync": false, - "blockPullOrder": "standard", - "copyRangeMethod": "standard", - "caseSensitiveFS": false, - "junctionsAsDirs": true + \(dqcopiers\(dq: 0, + \(dqpullerMaxPendingKiB\(dq: 0, + \(dqhashers\(dq: 0, + \(dqorder\(dq: \(dqrandom\(dq, + \(dqignoreDelete\(dq: false, + \(dqscanProgressIntervalS\(dq: 0, + \(dqpullerPauseS\(dq: 0, + \(dqmaxConflicts\(dq: \-1, + \(dqdisableSparseFiles\(dq: false, + \(dqdisableTempIndexes\(dq: false, + \(dqpaused\(dq: false, + \(dqweakHashThresholdPct\(dq: 25, + \(dqmarkerName\(dq: \(dq.stfolder\(dq, + \(dqcopyOwnershipFromParent\(dq: false, + \(dqmodTimeWindowS\(dq: 0, + \(dqmaxConcurrentWrites\(dq: 2, + \(dqdisableFsync\(dq: false, + \(dqblockPullOrder\(dq: \(dqstandard\(dq, + \(dqcopyRangeMethod\(dq: \(dqstandard\(dq, + \(dqcaseSensitiveFS\(dq: false, + \(dqjunctionsAsDirs\(dq: true } ], - "devices": [ + \(dqdevices\(dq: [ { - "deviceID": "...", - "name": "Laptop", - "addresses": [ - "dynamic", - "tcp://192.168.1.2:22000" + \(dqdeviceID\(dq: \(dq...\(dq, + \(dqname\(dq: \(dqLaptop\(dq, + \(dqaddresses\(dq: [ + \(dqdynamic\(dq, + \(dqtcp://192.168.1.2:22000\(dq ], - "compression": "metadata", - "certName": "", - "introducer": false, - "skipIntroductionRemovals": false, - "introducedBy": "", - "paused": false, - "allowedNetworks": [], - "autoAcceptFolders": false, - "maxSendKbps": 0, - "maxRecvKbps": 0, - "ignoredFolders": [ + \(dqcompression\(dq: \(dqmetadata\(dq, + \(dqcertName\(dq: \(dq\(dq, + \(dqintroducer\(dq: false, + \(dqskipIntroductionRemovals\(dq: false, + \(dqintroducedBy\(dq: \(dq\(dq, + \(dqpaused\(dq: false, + \(dqallowedNetworks\(dq: [], + \(dqautoAcceptFolders\(dq: false, + \(dqmaxSendKbps\(dq: 0, + \(dqmaxRecvKbps\(dq: 0, + \(dqignoredFolders\(dq: [ { - "time": "2022\-01\-09T19:09:52Z", - "id": "br63e\-wyhb7", - "label": "Foo" + \(dqtime\(dq: \(dq2022\-01\-09T19:09:52Z\(dq, + \(dqid\(dq: \(dqbr63e\-wyhb7\(dq, + \(dqlabel\(dq: \(dqFoo\(dq } ], - "maxRequestKiB": 0, - "untrusted": false, - "remoteGUIPort": 0 + \(dqmaxRequestKiB\(dq: 0, + \(dquntrusted\(dq: false, + \(dqremoteGUIPort\(dq: 0 } ], - "gui": { - "enabled": true, - "address": "127.0.0.1:8384", - "unixSocketPermissions": "", - "user": "Username", - "password": "$2a$10$ZFws69T4FlvWwsqeIwL.TOo5zOYqsa/.TxlUnsGYS.j3JvjFTmxo6", - "authMode": "static", - "useTLS": false, - "apiKey": "k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1", - "insecureAdminAccess": false, - "theme": "default", - "debugging": false, - "insecureSkipHostcheck": false, - "insecureAllowFrameLoading": false + \(dqgui\(dq: { + \(dqenabled\(dq: true, + \(dqaddress\(dq: \(dq127.0.0.1:8384\(dq, + \(dqunixSocketPermissions\(dq: \(dq\(dq, + \(dquser\(dq: \(dqUsername\(dq, + \(dqpassword\(dq: \(dq$2a$10$ZFws69T4FlvWwsqeIwL.TOo5zOYqsa/.TxlUnsGYS.j3JvjFTmxo6\(dq, + \(dqauthMode\(dq: \(dqstatic\(dq, + \(dquseTLS\(dq: false, + \(dqapiKey\(dq: \(dqk1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1\(dq, + \(dqinsecureAdminAccess\(dq: false, + \(dqtheme\(dq: \(dqdefault\(dq, + \(dqdebugging\(dq: false, + \(dqinsecureSkipHostcheck\(dq: false, + \(dqinsecureAllowFrameLoading\(dq: false }, - "ldap": { - "address": "", - "bindDN": "", - "transport": "plain", - "insecureSkipVerify": false, - "searchBaseDN": "", - "searchFilter": "" + \(dqldap\(dq: { + \(dqaddress\(dq: \(dq\(dq, + \(dqbindDN\(dq: \(dq\(dq, + \(dqtransport\(dq: \(dqplain\(dq, + \(dqinsecureSkipVerify\(dq: false, + \(dqsearchBaseDN\(dq: \(dq\(dq, + \(dqsearchFilter\(dq: \(dq\(dq }, - "options": { - "listenAddresses": [ - "default" + \(dqoptions\(dq: { + \(dqlistenAddresses\(dq: [ + \(dqdefault\(dq ], - "globalAnnounceServers": [ - "default" + \(dqglobalAnnounceServers\(dq: [ + \(dqdefault\(dq ], - "globalAnnounceEnabled": true, - "localAnnounceEnabled": true, - "localAnnouncePort": 21027, - "localAnnounceMCAddr": "[ff12::8384]:21027", - "maxSendKbps": 0, - "maxRecvKbps": 0, - "reconnectionIntervalS": 60, - "relaysEnabled": true, - "relayReconnectIntervalM": 10, - "startBrowser": true, - "natEnabled": true, - "natLeaseMinutes": 60, - "natRenewalMinutes": 30, - "natTimeoutSeconds": 10, - "urAccepted": 0, - "urSeen": 0, - "urUniqueId": "...", - "urURL": "https://data.syncthing.net/newdata", - "urPostInsecurely": false, - "urInitialDelayS": 1800, - "autoUpgradeIntervalH": 12, - "upgradeToPreReleases": false, - "keepTemporariesH": 24, - "cacheIgnoredFiles": false, - "progressUpdateIntervalS": 5, - "limitBandwidthInLan": false, - "minHomeDiskFree": { - "value": 1, - "unit": "%" + \(dqglobalAnnounceEnabled\(dq: true, + \(dqlocalAnnounceEnabled\(dq: true, + \(dqlocalAnnouncePort\(dq: 21027, + \(dqlocalAnnounceMCAddr\(dq: \(dq[ff12::8384]:21027\(dq, + \(dqmaxSendKbps\(dq: 0, + \(dqmaxRecvKbps\(dq: 0, + \(dqreconnectionIntervalS\(dq: 60, + \(dqrelaysEnabled\(dq: true, + \(dqrelayReconnectIntervalM\(dq: 10, + \(dqstartBrowser\(dq: true, + \(dqnatEnabled\(dq: true, + \(dqnatLeaseMinutes\(dq: 60, + \(dqnatRenewalMinutes\(dq: 30, + \(dqnatTimeoutSeconds\(dq: 10, + \(dqurAccepted\(dq: 0, + \(dqurSeen\(dq: 0, + \(dqurUniqueId\(dq: \(dq...\(dq, + \(dqurURL\(dq: \(dqhttps://data.syncthing.net/newdata\(dq, + \(dqurPostInsecurely\(dq: false, + \(dqurInitialDelayS\(dq: 1800, + \(dqautoUpgradeIntervalH\(dq: 12, + \(dqupgradeToPreReleases\(dq: false, + \(dqkeepTemporariesH\(dq: 24, + \(dqcacheIgnoredFiles\(dq: false, + \(dqprogressUpdateIntervalS\(dq: 5, + \(dqlimitBandwidthInLan\(dq: false, + \(dqminHomeDiskFree\(dq: { + \(dqvalue\(dq: 1, + \(dqunit\(dq: \(dq%\(dq }, - "releasesURL": "https://upgrades.syncthing.net/meta.json", - "alwaysLocalNets": [], - "overwriteRemoteDeviceNamesOnConnect": false, - "tempIndexMinBlocks": 10, - "unackedNotificationIDs": [ - "authenticationUserAndPassword" + \(dqreleasesURL\(dq: \(dqhttps://upgrades.syncthing.net/meta.json\(dq, + \(dqalwaysLocalNets\(dq: [], + \(dqoverwriteRemoteDeviceNamesOnConnect\(dq: false, + \(dqtempIndexMinBlocks\(dq: 10, + \(dqunackedNotificationIDs\(dq: [ + \(dqauthenticationUserAndPassword\(dq ], - "trafficClass": 0, - "setLowPriority": true, - "maxFolderConcurrency": 0, - "crURL": "https://crash.syncthing.net/newcrash", - "crashReportingEnabled": true, - "stunKeepaliveStartS": 180, - "stunKeepaliveMinS": 20, - "stunServers": [ - "default" + \(dqtrafficClass\(dq: 0, + \(dqsetLowPriority\(dq: true, + \(dqmaxFolderConcurrency\(dq: 0, + \(dqcrURL\(dq: \(dqhttps://crash.syncthing.net/newcrash\(dq, + \(dqcrashReportingEnabled\(dq: true, + \(dqstunKeepaliveStartS\(dq: 180, + \(dqstunKeepaliveMinS\(dq: 20, + \(dqstunServers\(dq: [ + \(dqdefault\(dq ], - "databaseTuning": "auto", - "maxConcurrentIncomingRequestKiB": 0, - "announceLANAddresses": true, - "sendFullIndexOnUpgrade": false, - "featureFlags": [], - "connectionLimitEnough": 0, - "connectionLimitMax": 0, - "insecureAllowOldTLSVersions": false + \(dqdatabaseTuning\(dq: \(dqauto\(dq, + \(dqmaxConcurrentIncomingRequestKiB\(dq: 0, + \(dqannounceLANAddresses\(dq: true, + \(dqsendFullIndexOnUpgrade\(dq: false, + \(dqfeatureFlags\(dq: [], + \(dqconnectionLimitEnough\(dq: 0, + \(dqconnectionLimitMax\(dq: 0, + \(dqinsecureAllowOldTLSVersions\(dq: false }, - "remoteIgnoredDevices": [ + \(dqremoteIgnoredDevices\(dq: [ { - "time": "2022\-01\-09T20:02:01Z", - "deviceID": "...", - "name": "...", - "address": "192.168.0.20:22000" + \(dqtime\(dq: \(dq2022\-01\-09T20:02:01Z\(dq, + \(dqdeviceID\(dq: \(dq...\(dq, + \(dqname\(dq: \(dq...\(dq, + \(dqaddress\(dq: \(dq192.168.0.20:22000\(dq } ], - "defaults": { - "folder": { - "id": "", - "label": "", - "filesystemType": "basic", - "path": "~", - "type": "sendreceive", - "devices": [ + \(dqdefaults\(dq: { + \(dqfolder\(dq: { + \(dqid\(dq: \(dq\(dq, + \(dqlabel\(dq: \(dq\(dq, + \(dqfilesystemType\(dq: \(dqbasic\(dq, + \(dqpath\(dq: \(dq~\(dq, + \(dqtype\(dq: \(dqsendreceive\(dq, + \(dqdevices\(dq: [ { - "deviceID": "...", - "introducedBy": "", - "encryptionPassword": "" + \(dqdeviceID\(dq: \(dq...\(dq, + \(dqintroducedBy\(dq: \(dq\(dq, + \(dqencryptionPassword\(dq: \(dq\(dq } ], - "rescanIntervalS": 3600, - "fsWatcherEnabled": true, - "fsWatcherDelayS": 10, - "ignorePerms": false, - "autoNormalize": true, - "minDiskFree": { - "value": 1, - "unit": "%" + \(dqrescanIntervalS\(dq: 3600, + \(dqfsWatcherEnabled\(dq: true, + \(dqfsWatcherDelayS\(dq: 10, + \(dqignorePerms\(dq: false, + \(dqautoNormalize\(dq: true, + \(dqminDiskFree\(dq: { + \(dqvalue\(dq: 1, + \(dqunit\(dq: \(dq%\(dq }, - "versioning": { - "type": "", - "params": {}, - "cleanupIntervalS": 3600, - "fsPath": "", - "fsType": "basic" + \(dqversioning\(dq: { + \(dqtype\(dq: \(dq\(dq, + \(dqparams\(dq: {}, + \(dqcleanupIntervalS\(dq: 3600, + \(dqfsPath\(dq: \(dq\(dq, + \(dqfsType\(dq: \(dqbasic\(dq }, - "copiers": 0, - "pullerMaxPendingKiB": 0, - "hashers": 0, - "order": "random", - "ignoreDelete": false, - "scanProgressIntervalS": 0, - "pullerPauseS": 0, - "maxConflicts": 10, - "disableSparseFiles": false, - "disableTempIndexes": false, - "paused": false, - "weakHashThresholdPct": 25, - "markerName": ".stfolder", - "copyOwnershipFromParent": false, - "modTimeWindowS": 0, - "maxConcurrentWrites": 2, - "disableFsync": false, - "blockPullOrder": "standard", - "copyRangeMethod": "standard", - "caseSensitiveFS": false, - "junctionsAsDirs": false + \(dqcopiers\(dq: 0, + \(dqpullerMaxPendingKiB\(dq: 0, + \(dqhashers\(dq: 0, + \(dqorder\(dq: \(dqrandom\(dq, + \(dqignoreDelete\(dq: false, + \(dqscanProgressIntervalS\(dq: 0, + \(dqpullerPauseS\(dq: 0, + \(dqmaxConflicts\(dq: 10, + \(dqdisableSparseFiles\(dq: false, + \(dqdisableTempIndexes\(dq: false, + \(dqpaused\(dq: false, + \(dqweakHashThresholdPct\(dq: 25, + \(dqmarkerName\(dq: \(dq.stfolder\(dq, + \(dqcopyOwnershipFromParent\(dq: false, + \(dqmodTimeWindowS\(dq: 0, + \(dqmaxConcurrentWrites\(dq: 2, + \(dqdisableFsync\(dq: false, + \(dqblockPullOrder\(dq: \(dqstandard\(dq, + \(dqcopyRangeMethod\(dq: \(dqstandard\(dq, + \(dqcaseSensitiveFS\(dq: false, + \(dqjunctionsAsDirs\(dq: false }, - "device": { - "deviceID": "", - "name": "", - "addresses": [ - "dynamic" + \(dqdevice\(dq: { + \(dqdeviceID\(dq: \(dq\(dq, + \(dqname\(dq: \(dq\(dq, + \(dqaddresses\(dq: [ + \(dqdynamic\(dq ], - "compression": "metadata", - "certName": "", - "introducer": false, - "skipIntroductionRemovals": false, - "introducedBy": "", - "paused": false, - "allowedNetworks": [], - "autoAcceptFolders": false, - "maxSendKbps": 0, - "maxRecvKbps": 0, - "ignoredFolders": [], - "maxRequestKiB": 0, - "untrusted": false, - "remoteGUIPort": 0 + \(dqcompression\(dq: \(dqmetadata\(dq, + \(dqcertName\(dq: \(dq\(dq, + \(dqintroducer\(dq: false, + \(dqskipIntroductionRemovals\(dq: false, + \(dqintroducedBy\(dq: \(dq\(dq, + \(dqpaused\(dq: false, + \(dqallowedNetworks\(dq: [], + \(dqautoAcceptFolders\(dq: false, + \(dqmaxSendKbps\(dq: 0, + \(dqmaxRecvKbps\(dq: 0, + \(dqignoredFolders\(dq: [], + \(dqmaxRequestKiB\(dq: 0, + \(dquntrusted\(dq: false, + \(dqremoteGUIPort\(dq: 0 } } } @@ -375,7 +375,7 @@ Returns the current configuration. .SS GET /rest/system/config/insync (DEPRECATED) .sp Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use -rest\-config\-insync instead. +\fI\%/rest/config/restart\-required\fP instead. .sp Returns whether the config is in sync, i.e. whether the running @@ -386,7 +386,7 @@ configuration is the same as that on disk. .nf .ft C { - "configInSync": true + \(dqconfigInSync\(dq: true } .ft P .fi @@ -394,14 +394,14 @@ configuration is the same as that on disk. .UNINDENT .SS POST /rest/system/config (DEPRECATED) .sp -Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use config +Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use \fI\%Config Endpoints\fP instead. .sp Post the full contents of the configuration, in the same format as returned by the corresponding GET request. When posting the configuration succeeds, the posted configuration is immediately applied, except for changes that require a restart. Query -rest\-config\-insync to check if a restart is required. +\fI\%/rest/config/restart\-required\fP to check if a restart is required. .sp This endpoint is the main point to control Syncthing, even if the change only concerns a very small part of the config: The usual workflow is to get the @@ -425,48 +425,48 @@ The connection types are \fBTCP (Client)\fP, \fBTCP (Server)\fP, \fBRelay (Clien .nf .ft C { - "connections": { - "DOVII4U\-SQEEESM\-VZ2CVTC\-CJM4YN5\-QNV7DCU\-5U3ASRL\-YVFG6TH\-W5DV5AA": { - "address": "", - "at": "0001\-01\-01T00:00:00Z", - "clientVersion": "", - "connected": false, - "inBytesTotal": 0, - "isLocal": false, - "outBytesTotal": 0, - "paused": false, - "startedAt": "0001\-01\-01T00:00:00Z", - "type": "" + \(dqconnections\(dq: { + \(dqDOVII4U\-SQEEESM\-VZ2CVTC\-CJM4YN5\-QNV7DCU\-5U3ASRL\-YVFG6TH\-W5DV5AA\(dq: { + \(dqaddress\(dq: \(dq\(dq, + \(dqat\(dq: \(dq0001\-01\-01T00:00:00Z\(dq, + \(dqclientVersion\(dq: \(dq\(dq, + \(dqconnected\(dq: false, + \(dqinBytesTotal\(dq: 0, + \(dqisLocal\(dq: false, + \(dqoutBytesTotal\(dq: 0, + \(dqpaused\(dq: false, + \(dqstartedAt\(dq: \(dq0001\-01\-01T00:00:00Z\(dq, + \(dqtype\(dq: \(dq\(dq }, - "UYGDMA4\-TPHOFO5\-2VQYDCC\-7CWX7XW\-INZINQT\-LE4B42N\-4JUZTSM\-IWCSXA4": { - "address": "", - "at": "0001\-01\-01T00:00:00Z", - "clientVersion": "", - "connected": false, - "inBytesTotal": 0, - "isLocal": false, - "outBytesTotal": 0, - "paused": false, - "startedAt": "0001\-01\-01T00:00:00Z", - "type": "" + \(dqUYGDMA4\-TPHOFO5\-2VQYDCC\-7CWX7XW\-INZINQT\-LE4B42N\-4JUZTSM\-IWCSXA4\(dq: { + \(dqaddress\(dq: \(dq\(dq, + \(dqat\(dq: \(dq0001\-01\-01T00:00:00Z\(dq, + \(dqclientVersion\(dq: \(dq\(dq, + \(dqconnected\(dq: false, + \(dqinBytesTotal\(dq: 0, + \(dqisLocal\(dq: false, + \(dqoutBytesTotal\(dq: 0, + \(dqpaused\(dq: false, + \(dqstartedAt\(dq: \(dq0001\-01\-01T00:00:00Z\(dq, + \(dqtype\(dq: \(dq\(dq }, - "YZJBJFX\-RDBL7WY\-6ZGKJ2D\-4MJB4E7\-ZATSDUY\-LD6Y3L3\-MLFUYWE\-AEMXJAC": { - "address": "127.0.0.1:22002", - "at": "2015\-11\-07T17:29:47.691548971+01:00", - "clientVersion": "v0.12.1", - "connected": true, - "inBytesTotal": 556, - "isLocal": true, - "outBytesTotal": 550, - "paused": false, - "startedAt": "2015\-11\-07T00:09:47Z", - "type": "TCP (Client)" + \(dqYZJBJFX\-RDBL7WY\-6ZGKJ2D\-4MJB4E7\-ZATSDUY\-LD6Y3L3\-MLFUYWE\-AEMXJAC\(dq: { + \(dqaddress\(dq: \(dq127.0.0.1:22002\(dq, + \(dqat\(dq: \(dq2015\-11\-07T17:29:47.691548971+01:00\(dq, + \(dqclientVersion\(dq: \(dqv0.12.1\(dq, + \(dqconnected\(dq: true, + \(dqinBytesTotal\(dq: 556, + \(dqisLocal\(dq: true, + \(dqoutBytesTotal\(dq: 550, + \(dqpaused\(dq: false, + \(dqstartedAt\(dq: \(dq2015\-11\-07T00:09:47Z\(dq, + \(dqtype\(dq: \(dqTCP (Client)\(dq } }, - "total": { - "at": "2015\-11\-07T17:29:47.691637262+01:00", - "inBytesTotal": 1479, - "outBytesTotal": 1318 + \(dqtotal\(dq: { + \(dqat\(dq: \(dq2015\-11\-07T17:29:47.691637262+01:00\(dq, + \(dqinBytesTotal\(dq: 1479, + \(dqoutBytesTotal\(dq: 1318 } } .ft P @@ -485,28 +485,28 @@ Returns the set of debug facilities and which of them are currently enabled. .nf .ft C { - "enabled": [ - "beacon" + \(dqenabled\(dq: [ + \(dqbeacon\(dq ], - "facilities": { - "beacon": "Multicast and broadcast discovery", - "config": "Configuration loading and saving", - "connections": "Connection handling", - "db": "The database layer", - "dialer": "Dialing connections", - "discover": "Remote device discovery", - "events": "Event generation and logging", - "http": "REST API", - "main": "Main package", - "model": "The root hub", - "protocol": "The BEP protocol", - "relay": "Relay connection handling", - "scanner": "File change detection and hashing", - "stats": "Persistent device and folder statistics", - "sync": "Mutexes", - "upgrade": "Binary upgrades", - "upnp": "UPnP discovery and port mapping", - "versioner": "File versioning" + \(dqfacilities\(dq: { + \(dqbeacon\(dq: \(dqMulticast and broadcast discovery\(dq, + \(dqconfig\(dq: \(dqConfiguration loading and saving\(dq, + \(dqconnections\(dq: \(dqConnection handling\(dq, + \(dqdb\(dq: \(dqThe database layer\(dq, + \(dqdialer\(dq: \(dqDialing connections\(dq, + \(dqdiscover\(dq: \(dqRemote device discovery\(dq, + \(dqevents\(dq: \(dqEvent generation and logging\(dq, + \(dqhttp\(dq: \(dqREST API\(dq, + \(dqmain\(dq: \(dqMain package\(dq, + \(dqmodel\(dq: \(dqThe root hub\(dq, + \(dqprotocol\(dq: \(dqThe BEP protocol\(dq, + \(dqrelay\(dq: \(dqRelay connection handling\(dq, + \(dqscanner\(dq: \(dqFile change detection and hashing\(dq, + \(dqstats\(dq: \(dqPersistent device and folder statistics\(dq, + \(dqsync\(dq: \(dqMutexes\(dq, + \(dqupgrade\(dq: \(dqBinary upgrades\(dq, + \(dqupnp\(dq: \(dqUPnP discovery and port mapping\(dq, + \(dqversioner\(dq: \(dqFile versioning\(dq } } .ft P @@ -541,8 +541,8 @@ Returns the contents of the local discovery cache. .nf .ft C { - "LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q": [ - "192.162.129.11:22000" + \(dqLGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\(dq: [ + \(dq192.162.129.11:22000\(dq ] } .ft P @@ -567,7 +567,7 @@ the discovery cache. .ft C curl \-X POST http://127.0.0.1:8384/rest/system/discovery?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\e&addr=192.162.129.11:22000 # Or with the X\-API\-Key header: -curl \-X POST \-\-header "X\-API\-Key: TcE28kVPdtJ8COws1JdM0b2nodj77WeQ" http://127.0.0.1:8384/rest/system/discovery?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\e&addr=192.162.129.11:22000 +curl \-X POST \-\-header \(dqX\-API\-Key: TcE28kVPdtJ8COws1JdM0b2nodj77WeQ\(dq http://127.0.0.1:8384/rest/system/discovery?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\e&addr=192.162.129.11:22000 .ft P .fi .UNINDENT @@ -591,10 +591,10 @@ Returns the list of recent errors. .nf .ft C { - "errors": [ + \(dqerrors\(dq: [ { - "when": "2014\-09\-18T12:59:26.549953186+02:00", - "message": "This is an error string" + \(dqwhen\(dq: \(dq2014\-09\-18T12:59:26.549953186+02:00\(dq, + \(dqmessage\(dq: \(dqThis is an error string\(dq } ] } @@ -619,10 +619,10 @@ the results to message newer than the given timestamp in \fI\%RFC 3339\fP <\fBht .nf .ft C { - "messages": [ + \(dqmessages\(dq: [ { - "when": "2014\-09\-18T12:59:26.549953186+02:00", - "message": "This is a log entry" + \(dqwhen\(dq: \(dq2014\-09\-18T12:59:26.549953186+02:00\(dq, + \(dqmessage\(dq: \(dqThis is a log entry\(dq } ] } @@ -646,21 +646,21 @@ and others. .nf .ft C { - "auditLog": "/home/user/.local/share/syncthing/audit\-${timestamp}.log", - "baseDir\-config": "/home/user/.config/syncthing", - "baseDir\-data": "/home/user/.local/share/syncthing", - "baseDir\-userHome": "/home/user", - "certFile": "/home/user/.config/syncthing/cert.pem", - "config": "/home/user/.config/syncthing/config.xml", - "csrfTokens": "/home/user/.config/syncthing/csrftokens.txt", - "database": "/home/user/.local/share/syncthing/index\-v0.14.0.db", - "defFolder": "/home/user/Sync", - "guiAssets": "/home/user/src/syncthing/gui", - "httpsCertFile": "/home/user/.config/syncthing/https\-cert.pem", - "httpsKeyFile": "/home/user/.config/syncthing/https\-key.pem", - "keyFile": "/home/user/.config/syncthing/key.pem", - "logFile": "\-", - "panicLog": "/home/user/.local/share/syncthing/panic\-${timestamp}.log" + \(dqauditLog\(dq: \(dq/home/user/.local/share/syncthing/audit\-${timestamp}.log\(dq, + \(dqbaseDir\-config\(dq: \(dq/home/user/.config/syncthing\(dq, + \(dqbaseDir\-data\(dq: \(dq/home/user/.local/share/syncthing\(dq, + \(dqbaseDir\-userHome\(dq: \(dq/home/user\(dq, + \(dqcertFile\(dq: \(dq/home/user/.config/syncthing/cert.pem\(dq, + \(dqconfig\(dq: \(dq/home/user/.config/syncthing/config.xml\(dq, + \(dqcsrfTokens\(dq: \(dq/home/user/.config/syncthing/csrftokens.txt\(dq, + \(dqdatabase\(dq: \(dq/home/user/.local/share/syncthing/index\-v0.14.0.db\(dq, + \(dqdefFolder\(dq: \(dq/home/user/Sync\(dq, + \(dqguiAssets\(dq: \(dq/home/user/src/syncthing/gui\(dq, + \(dqhttpsCertFile\(dq: \(dq/home/user/.config/syncthing/https\-cert.pem\(dq, + \(dqhttpsKeyFile\(dq: \(dq/home/user/.config/syncthing/https\-key.pem\(dq, + \(dqkeyFile\(dq: \(dq/home/user/.config/syncthing/key.pem\(dq, + \(dqlogFile\(dq: \(dq\-\(dq, + \(dqpanicLog\(dq: \(dq/home/user/.local/share/syncthing/panic\-${timestamp}.log\(dq } .ft P .fi @@ -675,14 +675,14 @@ pauses all devices. 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. +Returns a \fB{\(dqping\(dq: \(dqpong\(dq}\fP object. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { - "ping": "pong" + \(dqping\(dq: \(dqpong\(dq } .ft P .fi @@ -690,7 +690,7 @@ Returns a \fB{"ping": "pong"}\fP object. .UNINDENT .SS POST /rest/system/ping .sp -Returns a \fB{"ping": "pong"}\fP object. +Returns a \fB{\(dqping\(dq: \(dqpong\(dq}\fP object. .SS POST /rest/system/reset .sp Post with empty body to erase the current index database and restart @@ -702,13 +702,13 @@ information for that folder will be erased: .sp .nf .ft C -curl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/system/reset?folder=ab1c2\-def3g +curl \-X POST \-H \(dqX\-API\-Key: abc123\(dq http://localhost:8384/rest/system/reset?folder=ab1c2\-def3g .ft P .fi .UNINDENT .UNINDENT .sp -\fBCaution\fP: See \fB\-\-reset\-database\fP for \fB\&.stfolder\fP creation +\fBCaution\fP: See \fI\%\-\-reset\-database\fP for \fB\&.stfolder\fP creation side\-effect and caution regarding mountpoints. .SS POST /rest/system/restart .sp @@ -732,89 +732,89 @@ Returns information about current system status and resource usage. The CPU perc .nf .ft C { - "alloc": 30618136, - "connectionServiceStatus": { - "dynamic+https://relays.syncthing.net/endpoint": { - "error": null, - "lanAddresses": [ - "relay://23.92.71.120:443/?id=53STGR7\-YBM6FCX\-PAZ2RHM\-YPY6OEJ\-WYHVZO7\-PCKQRCK\-PZLTP7T\-434XCAD&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=canton7" + \(dqalloc\(dq: 30618136, + \(dqconnectionServiceStatus\(dq: { + \(dqdynamic+https://relays.syncthing.net/endpoint\(dq: { + \(dqerror\(dq: null, + \(dqlanAddresses\(dq: [ + \(dqrelay://23.92.71.120:443/?id=53STGR7\-YBM6FCX\-PAZ2RHM\-YPY6OEJ\-WYHVZO7\-PCKQRCK\-PZLTP7T\-434XCAD&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=canton7\(dq ], - "wanAddresses": [ - "relay://23.92.71.120:443/?id=53STGR7\-YBM6FCX\-PAZ2RHM\-YPY6OEJ\-WYHVZO7\-PCKQRCK\-PZLTP7T\-434XCAD&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=canton7" + \(dqwanAddresses\(dq: [ + \(dqrelay://23.92.71.120:443/?id=53STGR7\-YBM6FCX\-PAZ2RHM\-YPY6OEJ\-WYHVZO7\-PCKQRCK\-PZLTP7T\-434XCAD&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=canton7\(dq ] }, - "tcp://0.0.0.0:22000": { - "error": null, - "lanAddresses": [ - "tcp://0.0.0.0:22000" + \(dqtcp://0.0.0.0:22000\(dq: { + \(dqerror\(dq: null, + \(dqlanAddresses\(dq: [ + \(dqtcp://0.0.0.0:22000\(dq ], - "wanAddresses": [ - "tcp://0.0.0.0:22000" + \(dqwanAddresses\(dq: [ + \(dqtcp://0.0.0.0:22000\(dq ] } }, - "cpuPercent": 0, - "discoveryEnabled": true, - "discoveryErrors": { - "global@https://discovery\-v4\-1.syncthing.net/v2/": "500 Internal Server Error", - "global@https://discovery\-v4\-2.syncthing.net/v2/": "Post https://discovery\-v4\-2.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)", - "global@https://discovery\-v4\-3.syncthing.net/v2/": "Post https://discovery\-v4\-3.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)", - "global@https://discovery\-v6\-1.syncthing.net/v2/": "Post https://discovery\-v6\-1.syncthing.net/v2/: dial tcp [2001:470:28:4d6::5]:443: connect: no route to host", - "global@https://discovery\-v6\-2.syncthing.net/v2/": "Post https://discovery\-v6\-2.syncthing.net/v2/: dial tcp [2604:a880:800:10::182:a001]:443: connect: no route to host", - "global@https://discovery\-v6\-3.syncthing.net/v2/": "Post https://discovery\-v6\-3.syncthing.net/v2/: dial tcp [2400:6180:0:d0::d9:d001]:443: connect: no route to host" + \(dqcpuPercent\(dq: 0, + \(dqdiscoveryEnabled\(dq: true, + \(dqdiscoveryErrors\(dq: { + \(dqglobal@https://discovery\-v4\-1.syncthing.net/v2/\(dq: \(dq500 Internal Server Error\(dq, + \(dqglobal@https://discovery\-v4\-2.syncthing.net/v2/\(dq: \(dqPost https://discovery\-v4\-2.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)\(dq, + \(dqglobal@https://discovery\-v4\-3.syncthing.net/v2/\(dq: \(dqPost https://discovery\-v4\-3.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)\(dq, + \(dqglobal@https://discovery\-v6\-1.syncthing.net/v2/\(dq: \(dqPost https://discovery\-v6\-1.syncthing.net/v2/: dial tcp [2001:470:28:4d6::5]:443: connect: no route to host\(dq, + \(dqglobal@https://discovery\-v6\-2.syncthing.net/v2/\(dq: \(dqPost https://discovery\-v6\-2.syncthing.net/v2/: dial tcp [2604:a880:800:10::182:a001]:443: connect: no route to host\(dq, + \(dqglobal@https://discovery\-v6\-3.syncthing.net/v2/\(dq: \(dqPost https://discovery\-v6\-3.syncthing.net/v2/: dial tcp [2400:6180:0:d0::d9:d001]:443: connect: no route to host\(dq }, - "discoveryStatus": { - "IPv4 local": { - "error": null + \(dqdiscoveryStatus\(dq: { + \(dqIPv4 local\(dq: { + \(dqerror\(dq: null }, - "IPv6 local": { - "error": null + \(dqIPv6 local\(dq: { + \(dqerror\(dq: null }, - "global@https://discovery\-v4\-1.syncthing.net/v2/": { - "error": "500 Internal Server Error" + \(dqglobal@https://discovery\-v4\-1.syncthing.net/v2/\(dq: { + \(dqerror\(dq: \(dq500 Internal Server Error\(dq }, - "global@https://discovery\-v4\-2.syncthing.net/v2/": { - "error": "Post https://discovery\-v4\-2.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)" + \(dqglobal@https://discovery\-v4\-2.syncthing.net/v2/\(dq: { + \(dqerror\(dq: \(dqPost https://discovery\-v4\-2.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)\(dq }, - "global@https://discovery\-v4\-3.syncthing.net/v2/": { - "error": "Post https://discovery\-v4\-3.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)" + \(dqglobal@https://discovery\-v4\-3.syncthing.net/v2/\(dq: { + \(dqerror\(dq: \(dqPost https://discovery\-v4\-3.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)\(dq }, - "global@https://discovery\-v6\-1.syncthing.net/v2/": { - "error": "Post https://discovery\-v6\-1.syncthing.net/v2/: dial tcp [2001:470:28:4d6::5]:443: connect: no route to host" + \(dqglobal@https://discovery\-v6\-1.syncthing.net/v2/\(dq: { + \(dqerror\(dq: \(dqPost https://discovery\-v6\-1.syncthing.net/v2/: dial tcp [2001:470:28:4d6::5]:443: connect: no route to host\(dq }, - "global@https://discovery\-v6\-2.syncthing.net/v2/": { - "error": "Post https://discovery\-v6\-2.syncthing.net/v2/: dial tcp [2604:a880:800:10::182:a001]:443: connect: no route to host" + \(dqglobal@https://discovery\-v6\-2.syncthing.net/v2/\(dq: { + \(dqerror\(dq: \(dqPost https://discovery\-v6\-2.syncthing.net/v2/: dial tcp [2604:a880:800:10::182:a001]:443: connect: no route to host\(dq }, - "global@https://discovery\-v6\-3.syncthing.net/v2/": { - "error": "Post https://discovery\-v6\-3.syncthing.net/v2/: dial tcp [2400:6180:0:d0::d9:d001]:443: connect: no route to host" + \(dqglobal@https://discovery\-v6\-3.syncthing.net/v2/\(dq: { + \(dqerror\(dq: \(dqPost https://discovery\-v6\-3.syncthing.net/v2/: dial tcp [2400:6180:0:d0::d9:d001]:443: connect: no route to host\(dq } }, - "discoveryMethods": 8, - "goroutines": 49, - "lastDialStatus": { - "tcp://10.20.30.40": { - "when": "2019\-05\-16T07:41:23Z", - "error": "dial tcp 10.20.30.40:22000: i/o timeout" + \(dqdiscoveryMethods\(dq: 8, + \(dqgoroutines\(dq: 49, + \(dqlastDialStatus\(dq: { + \(dqtcp://10.20.30.40\(dq: { + \(dqwhen\(dq: \(dq2019\-05\-16T07:41:23Z\(dq, + \(dqerror\(dq: \(dqdial tcp 10.20.30.40:22000: i/o timeout\(dq }, - "tcp://172.16.33.3:22000": { - "when": "2019\-05\-16T07:40:43Z", - "ok": true + \(dqtcp://172.16.33.3:22000\(dq: { + \(dqwhen\(dq: \(dq2019\-05\-16T07:40:43Z\(dq, + \(dqok\(dq: true }, - "tcp://83.233.120.221:22000": { - "when": "2019\-05\-16T07:41:13Z", - "error": "dial tcp 83.233.120.221:22000: connect: connection refused" + \(dqtcp://83.233.120.221:22000\(dq: { + \(dqwhen\(dq: \(dq2019\-05\-16T07:41:13Z\(dq, + \(dqerror\(dq: \(dqdial tcp 83.233.120.221:22000: connect: connection refused\(dq } }, - "myID": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2", - "pathSeparator": "/", - "startTime": "2016\-06\-06T19:41:43.039284753+02:00", - "sys": 42092792, - "themes": [ - "default", - "dark" + \(dqmyID\(dq: \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq, + \(dqpathSeparator\(dq: \(dq/\(dq, + \(dqstartTime\(dq: \(dq2016\-06\-06T19:41:43.039284753+02:00\(dq, + \(dqsys\(dq: 42092792, + \(dqthemes\(dq: [ + \(dqdefault\(dq, + \(dqdark\(dq ], - "tilde": "/Users/jb", - "uptime": 2635 + \(dqtilde\(dq: \(dq/Users/jb\(dq, + \(dquptime\(dq: 2635 } .ft P .fi @@ -823,7 +823,7 @@ Returns information about current system status and resource usage. The CPU perc .sp New in version 1.2.0: The \fBlastDialStatus\fP dictionary contains the last error (or \fBnull\fP for success) for each peer address that Syncthing has attempted to contact. -The \fBconnectionServiceStatus\fP entries gained \fB"error": null\fP +The \fBconnectionServiceStatus\fP entries gained \fB\(dqerror\(dq: null\fP attributes where previously there would be no \fBerror\fP attribute at all in the success case. @@ -845,10 +845,10 @@ newest version and upgrade possibility. .nf .ft C { - "latest": "v0.14.47", - "majorNewer": false, - "newer": true, - "running": "v0.14.46" + \(dqlatest\(dq: \(dqv0.14.47\(dq, + \(dqmajorNewer\(dq: false, + \(dqnewer\(dq: true, + \(dqrunning\(dq: \(dqv0.14.46\(dq } .ft P .fi @@ -867,10 +867,10 @@ Returns the current Syncthing version information. .nf .ft C { - "arch": "amd64", - "longVersion": "syncthing v0.10.27+3\-gea8c3de (go1.4 darwin\-amd64 default) jb@syno 2015\-03\-16 11:01:29 UTC", - "os": "darwin", - "version": "v0.10.27+3\-gea8c3de" + \(dqarch\(dq: \(dqamd64\(dq, + \(dqlongVersion\(dq: \(dqsyncthing v0.10.27+3\-gea8c3de (go1.4 darwin\-amd64 default) jb@syno 2015\-03\-16 11:01:29 UTC\(dq, + \(dqos\(dq: \(dqdarwin\(dq, + \(dqversion\(dq: \(dqv0.10.27+3\-gea8c3de\(dq } .ft P .fi @@ -882,7 +882,7 @@ Returns the current Syncthing version information. New in version 1.12.0. .sp -These endpoints facilitate access and modification of the configuration in a granular way. Config sent to the endpoints must be in the +These endpoints facilitate access and modification of the \fI\%configuration\fP in a granular way. Config sent to the endpoints must be in the same format as returned by the corresponding GET request. When posting the configuration succeeds, the posted configuration is immediately applied, except for changes that require a restart. Query \fI\%/rest/config/restart\-required\fP to check if @@ -892,7 +892,7 @@ For all endpoints supporting \fBPATCH\fP, it takes the existing config and unmarshals the given JSON object on top of it. This means all child objects will replace the existing objects, not extend them. For example for \fBRawListenAddresses\fP in options, which is an array of strings, sending -\fB{RawListenAddresses: ["tcp://10.0.0.2"]}\fP will replace all existing listen +\fB{RawListenAddresses: [\(dqtcp://10.0.0.2\(dq]}\fP will replace all existing listen addresses. .SS /rest/config .sp @@ -940,24 +940,24 @@ New in version 1.18.0. .sp Remove records about a pending remote device which tried to connect. Valid values for the \fBdevice\fP parameter are those from the corresponding -cluster\-pending\-devices\-get endpoint. +\fI\%GET /rest/cluster/pending/devices\fP endpoint. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -$ curl \-X DELETE \-H "X\-API\-Key: abc123" http://localhost:8384/rest/cluster/pending/devices?device=P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2 +$ curl \-X DELETE \-H \(dqX\-API\-Key: abc123\(dq http://localhost:8384/rest/cluster/pending/devices?device=P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2 .ft P .fi .UNINDENT .UNINDENT .sp Returns status 200 and no content upon success, or status 500 and a -plain text error on failure. A /events/pendingdeviceschanged +plain text error on failure. A \fI\%PendingDevicesChanged\fP event will be generated in response. .sp For a more permanent effect, also for future connections from the same -device ID, the device should be ignored in the configuration instead. +device ID, the device should be ignored in the \fI\%configuration\fP instead. .SS GET /rest/cluster/pending/devices .sp New in version 1.13.0. @@ -971,10 +971,10 @@ configured in our instance. .nf .ft C { - "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2": { - "time": "2020\-03\-18T11:43:07Z", - "name": "Friend Joe", - "address": "192.168.1.2:22000" + \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq: { + \(dqtime\(dq: \(dq2020\-03\-18T11:43:07Z\(dq, + \(dqname\(dq: \(dqFriend Joe\(dq, + \(dqaddress\(dq: \(dq192.168.1.2:22000\(dq } } .ft P @@ -988,7 +988,7 @@ New in version 1.18.0. .sp Remove records about a pending folder announced from a remote device. Valid values for the \fBfolder\fP and \fBdevice\fP parameters are those from the -corresponding cluster\-pending\-folders\-get endpoint. The \fBdevice\fP +corresponding \fI\%GET /rest/cluster/pending/folders\fP endpoint. The \fBdevice\fP parameter is optional and affects announcements of this folder from the given device, or from \fIany\fP device if omitted. .INDENT 0.0 @@ -996,18 +996,18 @@ device, or from \fIany\fP device if omitted. .sp .nf .ft C -$ curl \-X DELETE \-H "X\-API\-Key: abc123" http://localhost:8384/rest/cluster/pending/folders?folder=cpkn4\-57ysy&device=P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2 +$ curl \-X DELETE \-H \(dqX\-API\-Key: abc123\(dq http://localhost:8384/rest/cluster/pending/folders?folder=cpkn4\-57ysy&device=P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2 .ft P .fi .UNINDENT .UNINDENT .sp Returns status 200 and no content upon success, or status 500 and a plain text -error on failure. A /events/pendingfolderschanged event will be +error on failure. A \fI\%PendingFoldersChanged\fP event will be generated in response. .sp For a more permanent effect, also for future announcements of the same folder -ID, the folder should be ignored in the configuration +ID, the folder should be ignored in the \fI\%configuration\fP instead. .SS GET /rest/cluster/pending/folders .sp @@ -1024,29 +1024,29 @@ Other offering devices are also omitted from the result. .nf .ft C { - "cpkn4\-57ysy": { - "offeredBy": { - "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2": { - "time": "2020\-03\-18T11:43:07Z", - "label": "Joe\(aqs folder", - "receiveEncrypted": true, - "remoteEncrypted": false + \(dqcpkn4\-57ysy\(dq: { + \(dqofferedBy\(dq: { + \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq: { + \(dqtime\(dq: \(dq2020\-03\-18T11:43:07Z\(dq, + \(dqlabel\(dq: \(dqJoe\(aqs folder\(dq, + \(dqreceiveEncrypted\(dq: true, + \(dqremoteEncrypted\(dq: false }, - "DOVII4U\-SQEEESM\-VZ2CVTC\-CJM4YN5\-QNV7DCU\-5U3ASRL\-YVFG6TH\-W5DV5AA": { - "time": "2020\-03\-01T10:12:13Z", - "label": "Jane\(aqs and Joe\(aqs folder", - "receiveEncrypted": false, - "remoteEncrypted": false + \(dqDOVII4U\-SQEEESM\-VZ2CVTC\-CJM4YN5\-QNV7DCU\-5U3ASRL\-YVFG6TH\-W5DV5AA\(dq: { + \(dqtime\(dq: \(dq2020\-03\-01T10:12:13Z\(dq, + \(dqlabel\(dq: \(dqJane\(aqs and Joe\(aqs folder\(dq, + \(dqreceiveEncrypted\(dq: false, + \(dqremoteEncrypted\(dq: false } } }, - "abcde\-fghij": { - "offeredBy": { - "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2": { - "time": "2020\-03\-18T11:43:07Z", - "label": "MyPics", - "receiveEncrypted": false, - "remoteEncrypted": false + \(dqabcde\-fghij\(dq: { + \(dqofferedBy\(dq: { + \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq: { + \(dqtime\(dq: \(dq2020\-03\-18T11:43:07Z\(dq, + \(dqlabel\(dq: \(dqMyPics\(dq, + \(dqreceiveEncrypted\(dq: false, + \(dqremoteEncrypted\(dq: false } } } @@ -1066,22 +1066,22 @@ New in version 0.14.53. Takes one mandatory parameter, \fBfolder\fP, and returns the list of errors encountered during scanning or pulling. .sp -The results can be paginated using the common pagination parameters\&. +The results can be paginated using the \fI\%common pagination parameters\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { - "folder": "nnhic\-sxuae", - "errors": [ + \(dqfolder\(dq: \(dqnnhic\-sxuae\(dq, + \(dqerrors\(dq: [ { - "path": "noperm.txt", - "error": "hashing: open /path/to/folder/noperm.txt: permission denied" + \(dqpath\(dq: \(dqnoperm.txt\(dq, + \(dqerror\(dq: \(dqhashing: open /path/to/folder/noperm.txt: permission denied\(dq } ], - "page": 1, - "perpage": 100 + \(dqpage\(dq: 1, + \(dqperpage\(dq: 100 } .ft P .fi @@ -1090,7 +1090,7 @@ The results can be paginated using the common pagination parameters\&. .SS GET /rest/folder/pullerrors (DEPRECATED) .sp Deprecated since version v0.14.53: This endpoint still works as before but is deprecated. Use -folder\-errors\-get instead, which returns the same information. +\fI\%GET /rest/folder/errors\fP instead, which returns the same information. .sp See \fI\%https://github.com/syncthing/syncthing/commit/d510e3cca3d5caae42121fa206b3decc981ae59e\fP @@ -1101,7 +1101,7 @@ New in version 0.14.44. .sp Takes one mandatory parameter, \fBfolder\fP, and returns the list of archived files that could be recovered. How many versions are available depends on the -/users/versioning configuration. Each entry specifies when the file +\fI\%File Versioning\fP configuration. Each entry specifies when the file version was archived as the \fBversionTime\fP, the \fBmodTime\fP when it was last modified before being archived, and the size in bytes. .INDENT 0.0 @@ -1110,30 +1110,30 @@ modified before being archived, and the size in bytes. .nf .ft C { - "dir1/dir2/bar": [ + \(dqdir1/dir2/bar\(dq: [ { - "versionTime": "2022\-02\-06T20:44:12+01:00", - "modTime": "2021\-01\-14T13:21:22+01:00", - "size": 4 + \(dqversionTime\(dq: \(dq2022\-02\-06T20:44:12+01:00\(dq, + \(dqmodTime\(dq: \(dq2021\-01\-14T13:21:22+01:00\(dq, + \(dqsize\(dq: 4 } ], - "baz": [ + \(dqbaz\(dq: [ { - "versionTime": "2022\-02\-06T20:44:20+01:00", - "modTime": "2021\-01\-14T13:23:49+01:00", - "size": 4 + \(dqversionTime\(dq: \(dq2022\-02\-06T20:44:20+01:00\(dq, + \(dqmodTime\(dq: \(dq2021\-01\-14T13:23:49+01:00\(dq, + \(dqsize\(dq: 4 } ], - "foo": [ + \(dqfoo\(dq: [ { - "versionTime": "2022\-02\-06T20:55:31+01:00", - "modTime": "2022\-02\-06T20:44:13+01:00", - "size": 4 + \(dqversionTime\(dq: \(dq2022\-02\-06T20:55:31+01:00\(dq, + \(dqmodTime\(dq: \(dq2022\-02\-06T20:44:13+01:00\(dq, + \(dqsize\(dq: 4 }, { - "versionTime": "2022\-02\-06T20:44:20+01:00", - "modTime": "2021\-01\-14T13:21:16+01:00", - "size": 4 + \(dqversionTime\(dq: \(dq2022\-02\-06T20:44:20+01:00\(dq, + \(dqmodTime\(dq: \(dq2021\-01\-14T13:21:16+01:00\(dq, + \(dqsize\(dq: 4 } ] } @@ -1146,7 +1146,7 @@ modified before being archived, and the size in bytes. Restore archived versions of a given set of files. Expects an object with attributes named after the relative file paths, with timestamps as values matching valid \fBversionTime\fP entries in the corresponding -folder\-versions\-get response object. +\fI\%GET /rest/folder/versions\fP response object. .sp Takes the mandatory parameter \fBfolder\fP (folder ID). Returns an object containing any error messages that occurred during restoration of the file, with @@ -1157,8 +1157,8 @@ the file path as attribute name. .nf .ft C curl \-X POST \-H X\-API\-key:... http://127.0.0.1:8384/rest/folder/versions?folder=default \-d \(aq{ - "dir1/dir2/bar": "2022\-02\-06T20:44:12+01:00", - "baz": "2022\-02\-06T20:44:20+01:00" + \(dqdir1/dir2/bar\(dq: \(dq2022\-02\-06T20:44:12+01:00\(dq, + \(dqbaz\(dq: \(dq2022\-02\-06T20:44:20+01:00\(dq }\(aq .ft P .fi @@ -1185,48 +1185,48 @@ start building the structure. $ curl \-s http://localhost:8384/rest/db/browse?folder=j663y\-3ct3e&prefix=DCIM&levels=2 [ { - "modTime" : "2020\-10\-02T23:48:52.076996974+02:00", - "name" : "100ANDRO", - "size" : 128, - "type" : "FILE_INFO_TYPE_DIRECTORY" + \(dqmodTime\(dq : \(dq2020\-10\-02T23:48:52.076996974+02:00\(dq, + \(dqname\(dq : \(dq100ANDRO\(dq, + \(dqsize\(dq : 128, + \(dqtype\(dq : \(dqFILE_INFO_TYPE_DIRECTORY\(dq }, { - "children" : [ + \(dqchildren\(dq : [ { - "modTime" : "2020\-12\-16T23:31:34.5009668+01:00", - "name" : "IMG_20201114_124821.jpg", - "size" : 10682189, - "type" : "FILE_INFO_TYPE_FILE" + \(dqmodTime\(dq : \(dq2020\-12\-16T23:31:34.5009668+01:00\(dq, + \(dqname\(dq : \(dqIMG_20201114_124821.jpg\(dq, + \(dqsize\(dq : 10682189, + \(dqtype\(dq : \(dqFILE_INFO_TYPE_FILE\(dq }, { - "modTime" : "2020\-12\-16T23:31:35.0106367+01:00", - "name" : "IMG_20201213_122451.jpg", - "size" : 7936351, - "type" : "FILE_INFO_TYPE_FILE" + \(dqmodTime\(dq : \(dq2020\-12\-16T23:31:35.0106367+01:00\(dq, + \(dqname\(dq : \(dqIMG_20201213_122451.jpg\(dq, + \(dqsize\(dq : 7936351, + \(dqtype\(dq : \(dqFILE_INFO_TYPE_FILE\(dq }, { - "modTime" : "2020\-12\-13T12:25:05.017097469+01:00", - "name" : "IMG_20201213_122504.jpg", - "size" : 8406507, - "type" : "FILE_INFO_TYPE_FILE" + \(dqmodTime\(dq : \(dq2020\-12\-13T12:25:05.017097469+01:00\(dq, + \(dqname\(dq : \(dqIMG_20201213_122504.jpg\(dq, + \(dqsize\(dq : 8406507, + \(dqtype\(dq : \(dqFILE_INFO_TYPE_FILE\(dq }, { - "modTime" : "2020\-12\-13T12:25:06.127097469+01:00", - "name" : "IMG_20201213_122505.jpg", - "size" : 8381931, - "type" : "FILE_INFO_TYPE_FILE" + \(dqmodTime\(dq : \(dq2020\-12\-13T12:25:06.127097469+01:00\(dq, + \(dqname\(dq : \(dqIMG_20201213_122505.jpg\(dq, + \(dqsize\(dq : 8381931, + \(dqtype\(dq : \(dqFILE_INFO_TYPE_FILE\(dq }, { - "modTime" : "2020\-12\-13T12:53:29.707298401+01:00", - "name" : "IMG_20201213_125329.jpg", - "size" : 4388331, - "type" : "FILE_INFO_TYPE_FILE" + \(dqmodTime\(dq : \(dq2020\-12\-13T12:53:29.707298401+01:00\(dq, + \(dqname\(dq : \(dqIMG_20201213_125329.jpg\(dq, + \(dqsize\(dq : 4388331, + \(dqtype\(dq : \(dqFILE_INFO_TYPE_FILE\(dq }, ], - "modTime" : "2020\-10\-09T13:04:42.4410738+02:00", - "name" : "Camera", - "size" : 128, - "type" : "FILE_INFO_TYPE_DIRECTORY" + \(dqmodTime\(dq : \(dq2020\-10\-09T13:04:42.4410738+02:00\(dq, + \(dqname\(dq : \(dqCamera\(dq, + \(dqsize\(dq : 128, + \(dqtype\(dq : \(dqFILE_INFO_TYPE_DIRECTORY\(dq }, ] .ft P @@ -1311,14 +1311,14 @@ Aggregated completion status for all folders on the local device: .nf .ft C { - "completion": 99.9937565835, - "globalBytes": 156793013575, - "needBytes": 9789241, - "globalItems": 7823, - "needItems": 412, - "needDeletes": 0, - "remoteState": "valid", - "sequence": 12 + \(dqcompletion\(dq: 99.9937565835, + \(dqglobalBytes\(dq: 156793013575, + \(dqneedBytes\(dq: 9789241, + \(dqglobalItems\(dq: 7823, + \(dqneedItems\(dq: 412, + \(dqneedDeletes\(dq: 0, + \(dqremoteState\(dq: \(dqvalid\(dq, + \(dqsequence\(dq: 12 } .ft P .fi @@ -1348,14 +1348,14 @@ respectively. .nf .ft C { - "availability": [ + \(dqavailability\(dq: [ { - "id": "ITZRNXE\-YNROGBZ\-HXTH5P7\-VK5NYE5\-QHRQGE2\-7JQ6VNJ\-KZUEDIU\-5PPR5AM", - "fromTemporary": false + \(dqid\(dq: \(dqITZRNXE\-YNROGBZ\-HXTH5P7\-VK5NYE5\-QHRQGE2\-7JQ6VNJ\-KZUEDIU\-5PPR5AM\(dq, + \(dqfromTemporary\(dq: false } ], - "global": { /* a file entry */ }, - "local": { /* a file entry */ } + \(dqglobal\(dq: { /* a file entry */ }, + \(dqlocal\(dq: { /* a file entry */ } } .ft P .fi @@ -1370,31 +1370,31 @@ A file entry looks like this: .ft C { { - "deleted": false, - "ignored": false, - "inodeChange": "1970\-01\-01T01:00:00+01:00", - "invalid": false, - "localFlags": 0, - "modified": "2022\-09\-28T08:07:19.979723+02:00", - "modifiedBy": "523ITIE", - "mustRescan": false, - "name": "img", - "noPermissions": false, - "numBlocks": 0, - "permissions": "0755", - "platform": { /* platform specific data */ }, - "sequence": 914, - "size": 128, - "type": "FILE_INFO_TYPE_DIRECTORY", - "version": [ - "523ITIE:1664345275" + \(dqdeleted\(dq: false, + \(dqignored\(dq: false, + \(dqinodeChange\(dq: \(dq1970\-01\-01T01:00:00+01:00\(dq, + \(dqinvalid\(dq: false, + \(dqlocalFlags\(dq: 0, + \(dqmodified\(dq: \(dq2022\-09\-28T08:07:19.979723+02:00\(dq, + \(dqmodifiedBy\(dq: \(dq523ITIE\(dq, + \(dqmustRescan\(dq: false, + \(dqname\(dq: \(dqimg\(dq, + \(dqnoPermissions\(dq: false, + \(dqnumBlocks\(dq: 0, + \(dqpermissions\(dq: \(dq0755\(dq, + \(dqplatform\(dq: { /* platform specific data */ }, + \(dqsequence\(dq: 914, + \(dqsize\(dq: 128, + \(dqtype\(dq: \(dqFILE_INFO_TYPE_DIRECTORY\(dq, + \(dqversion\(dq: [ + \(dq523ITIE:1664345275\(dq ] }, - "mtime": { - "err": null, - "value": { - "real": "0001\-01\-01T00:00:00Z", - "virtual": "0001\-01\-01T00:00:00Z" + \(dqmtime\(dq: { + \(dqerr\(dq: null, + \(dqvalue\(dq: { + \(dqreal\(dq: \(dq0001\-01\-01T00:00:00Z\(dq, + \(dqvirtual\(dq: \(dq0001\-01\-01T00:00:00Z\(dq } } } @@ -1413,24 +1413,24 @@ attribute for macOS (“darwin”) looks as follows: .nf .ft C { - "darwin": { - "xattrs": [ + \(dqdarwin\(dq: { + \(dqxattrs\(dq: [ { - "name": "net.kastelo.xattrtest", - "value": "aGVsbG8=" + \(dqname\(dq: \(dqnet.kastelo.xattrtest\(dq, + \(dqvalue\(dq: \(dqaGVsbG8=\(dq } ] }, - "freebsd": null, - "linux": null, - "netbsd": null, - "unix": { - "gid": 20, - "groupName": "staff", - "ownerName": "jb", - "uid": 501 + \(dqfreebsd\(dq: null, + \(dqlinux\(dq: null, + \(dqnetbsd\(dq: null, + \(dqunix\(dq: { + \(dqgid\(dq: 20, + \(dqgroupName\(dq: \(dqstaff\(dq, + \(dqownerName\(dq: \(dqjb\(dq, + \(dquid\(dq: 501 }, - "windows": null + \(dqwindows\(dq: null } .ft P .fi @@ -1447,12 +1447,12 @@ provides a list of strings which represent globbing patterns described by gobwas .nf .ft C { - "ignore": [ - "(?i)/Backups" + \(dqignore\(dq: [ + \(dq(?i)/Backups\(dq ], - "expanded": [ - "(?i)Backups", - "(?i)Backups/**" + \(dqexpanded\(dq: [ + \(dq(?i)Backups\(dq, + \(dq(?i)Backups/**\(dq ] } .ft P @@ -1461,7 +1461,7 @@ provides a list of strings which represent globbing patterns described by gobwas .UNINDENT .SS POST /rest/db/ignores .sp -Expects a format similar to the output of db\-ignores\-get call, but only +Expects a format similar to the output of \fI\%GET /rest/db/ignores\fP call, but only 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. @@ -1473,29 +1473,29 @@ New in version 0.14.55. Takes one mandatory parameter, \fBfolder\fP, and returns the list of files which were changed locally in a receive\-only folder. Thus they differ from the global state and could be reverted by pulling from remote devices again, see -db\-revert\-post\&. +\fI\%POST /rest/db/revert\fP\&. .sp -The results can be paginated using the common pagination parameters\&. +The results can be paginated using the \fI\%common pagination parameters\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { - "files": [ + \(dqfiles\(dq: [ { - "flags": "0755", - "sequence": 6, - "modified": "2015\-04\-20T23:06:12+09:00", - "name": "ls", - "size": 34640, - "version": [ - "5157751870738175669:1" + \(dqflags\(dq: \(dq0755\(dq, + \(dqsequence\(dq: 6, + \(dqmodified\(dq: \(dq2015\-04\-20T23:06:12+09:00\(dq, + \(dqname\(dq: \(dqls\(dq, + \(dqsize\(dq: 34640, + \(dqversion\(dq: [ + \(dq5157751870738175669:1\(dq ] } ], - "page": 1, - "perpage": 100 + \(dqpage\(dq: 1, + \(dqperpage\(dq: 100 } .ft P .fi @@ -1514,7 +1514,7 @@ Use sparingly. Takes one mandatory parameter, \fBfolder\fP, and returns lists of files which are needed by this device in order for it to become in sync. .sp -The results can be paginated using the common pagination parameters\&. Pagination happens, across the union of all needed files, +The results can be paginated using the \fI\%common pagination parameters\fP\&. Pagination happens, across the union of all needed files, that is \- across all 3 sections of the response. For example, given the current need state is as follows: .INDENT 0.0 @@ -1547,29 +1547,29 @@ attribute. .ft C { # Files currently being downloaded - "progress": [ + \(dqprogress\(dq: [ { - "flags": "0755", - "sequence": 6, - "modified": "2015\-04\-20T23:06:12+09:00", - "name": "ls", - "size": 34640, - "version": [ - "5157751870738175669:1" + \(dqflags\(dq: \(dq0755\(dq, + \(dqsequence\(dq: 6, + \(dqmodified\(dq: \(dq2015\-04\-20T23:06:12+09:00\(dq, + \(dqname\(dq: \(dqls\(dq, + \(dqsize\(dq: 34640, + \(dqversion\(dq: [ + \(dq5157751870738175669:1\(dq ] } ], # Files queued to be downloaded next (as per array order) - "queued": [ + \(dqqueued\(dq: [ ... ], # Files to be downloaded after all queued files will be downloaded. # This happens when we start downloading files, and new files get added while we are downloading. - "rest": [ + \(dqrest\(dq: [ ... ], - "page": 1, - "perpage": 100 + \(dqpage\(dq: 1, + \(dqperpage\(dq: 100 } .ft P .fi @@ -1614,7 +1614,7 @@ curl \-X POST http://127.0.0.1:8384/rest/db/prio?folder=default&file=foo/bar .UNINDENT .UNINDENT .sp -Response contains the same output as db\-need\-get\&. +Response contains the same output as \fI\%GET /rest/db/need\fP\&. .SS GET /rest/db/remoteneed .sp New in version 0.14.43. @@ -1624,27 +1624,27 @@ Takes the mandatory parameters \fBfolder\fP and \fBdevice\fP, and returns the li of files which are needed by that remote device in order for it to become in sync with the shared folder. .sp -The results can be paginated using the common pagination parameters\&. +The results can be paginated using the \fI\%common pagination parameters\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { - "files": [ + \(dqfiles\(dq: [ { - "flags": "0755", - "sequence": 6, - "modified": "2015\-04\-20T23:06:12+09:00", - "name": "ls", - "size": 34640, - "version": [ - "5157751870738175669:1" + \(dqflags\(dq: \(dq0755\(dq, + \(dqsequence\(dq: 6, + \(dqmodified\(dq: \(dq2015\-04\-20T23:06:12+09:00\(dq, + \(dqname\(dq: \(dqls\(dq, + \(dqsize\(dq: 34640, + \(dqversion\(dq: [ + \(dq5157751870738175669:1\(dq ] } ], - "page": 1, - "perpage": 100 + \(dqpage\(dq: 1, + \(dqperpage\(dq: 100 } .ft P .fi @@ -1714,39 +1714,39 @@ Parameters: \fBfolder\fP, the ID of a folder. .nf .ft C { - "globalBytes": 0, - "globalDeleted": 0, - "globalDirectories": 0, - "globalFiles": 0, - "globalSymlinks": 0, - "globalTotalItems": 0, - "ignorePatterns": false, - "inSyncBytes": 0, - "inSyncFiles": 0, - "invalid": "", - "localBytes": 0, - "localDeleted": 0, - "localDirectories": 0, - "localFiles": 0, - "localSymlinks": 0, - "localTotalItems": 0, - "needBytes": 0, - "needDeletes": 0, - "needDirectories": 0, - "needFiles": 0, - "needSymlinks": 0, - "needTotalItems": 0, - "pullErrors": 0, - "receiveOnlyChangedBytes": 0, - "receiveOnlyChangedDeletes": 0, - "receiveOnlyChangedDirectories": 0, - "receiveOnlyChangedFiles": 0, - "receiveOnlyChangedSymlinks": 0, - "receiveOnlyTotalItems": 0, - "sequence": 0, - "state": "idle", - "stateChanged": "2018\-08\-08T07:04:57.301064781+02:00", - "version": 0 + \(dqglobalBytes\(dq: 0, + \(dqglobalDeleted\(dq: 0, + \(dqglobalDirectories\(dq: 0, + \(dqglobalFiles\(dq: 0, + \(dqglobalSymlinks\(dq: 0, + \(dqglobalTotalItems\(dq: 0, + \(dqignorePatterns\(dq: false, + \(dqinSyncBytes\(dq: 0, + \(dqinSyncFiles\(dq: 0, + \(dqinvalid\(dq: \(dq\(dq, + \(dqlocalBytes\(dq: 0, + \(dqlocalDeleted\(dq: 0, + \(dqlocalDirectories\(dq: 0, + \(dqlocalFiles\(dq: 0, + \(dqlocalSymlinks\(dq: 0, + \(dqlocalTotalItems\(dq: 0, + \(dqneedBytes\(dq: 0, + \(dqneedDeletes\(dq: 0, + \(dqneedDirectories\(dq: 0, + \(dqneedFiles\(dq: 0, + \(dqneedSymlinks\(dq: 0, + \(dqneedTotalItems\(dq: 0, + \(dqpullErrors\(dq: 0, + \(dqreceiveOnlyChangedBytes\(dq: 0, + \(dqreceiveOnlyChangedDeletes\(dq: 0, + \(dqreceiveOnlyChangedDirectories\(dq: 0, + \(dqreceiveOnlyChangedFiles\(dq: 0, + \(dqreceiveOnlyChangedSymlinks\(dq: 0, + \(dqreceiveOnlyTotalItems\(dq: 0, + \(dqsequence\(dq: 0, + \(dqstate\(dq: \(dqidle\(dq, + \(dqstateChanged\(dq: \(dq2018\-08\-08T07:04:57.301064781+02:00\(dq, + \(dqversion\(dq: 0 } .ft P .fi @@ -1803,9 +1803,9 @@ To receive events, perform a HTTP GET of \fB/rest/events\fP\&. .sp To filter the event list, in effect creating a specific subscription for only the desired event types, add a parameter \fBevents=EventTypeA,EventTypeB,...\fP -where the event types are any of the event\-types\&. If no filter is -specified, all events \fIexcept\fP /events/localchangedetected and -/events/remotechangedetected are included. +where the event types are any of the \fI\%Event Types\fP\&. If no filter is +specified, all events \fIexcept\fP \fI\%LocalChangeDetected\fP and +\fI\%RemoteChangeDetected\fP are included. .sp The optional parameter \fBsince=<lastSeenID>\fP sets the ID of the last event you’ve already seen. Syncthing returns a JSON encoded array of event objects, @@ -1827,7 +1827,7 @@ example: \fB/rest/events?since=0&limit=1\fP\&. .SS GET /rest/events/disk .sp This convenience endpoint provides the same event stream, but pre\-filtered to show -only /events/localchangedetected and /events/remotechangedetected +only \fI\%LocalChangeDetected\fP and \fI\%RemoteChangeDetected\fP event types. The \fBevents\fP parameter is not used. .SH STATISTICS ENDPOINTS .SS GET /rest/stats/device @@ -1841,9 +1841,9 @@ time the device was last seen and the last connection duration. .ft C $ curl \-s http://localhost:8384/rest/stats/device | json { - "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2": { - "lastSeen" : "2015\-04\-18T11:21:31.3256277+01:00" - "lastConnectionDurationS": 556335.421708141 + \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq: { + \(dqlastSeen\(dq : \(dq2015\-04\-18T11:21:31.3256277+01:00\(dq + \(dqlastConnectionDurationS\(dq: 556335.421708141 } } .ft P @@ -1860,11 +1860,11 @@ last scan time and the last synced file. .nf .ft C { - "folderid": { - "lastScan": "2016\-06\-02T13:28:01.288181412\-04:00", - "lastFile": { - "filename": "file/name", - "at": "2015\-04\-16T22:04:18.3066971+01:00" + \(dqfolderid\(dq: { + \(dqlastScan\(dq: \(dq2016\-06\-02T13:28:01.288181412\-04:00\(dq, + \(dqlastFile\(dq: { + \(dqfilename\(dq: \(dqfile/name\(dq, + \(dqat\(dq: \(dq2015\-04\-16T22:04:18.3066971+01:00\(dq } } } @@ -1886,12 +1886,12 @@ either a valid device ID in modern format, or an error. .ft C $ curl \-s http://localhost:8384/rest/svc/deviceid?id=1234 | json { - "error": "device ID invalid: incorrect length" + \(dqerror\(dq: \(dqdevice ID invalid: incorrect length\(dq } $ curl \-s http://localhost:8384/rest/svc/deviceid?id=p56ioi7m\-\-zjnu2iq\-gdr\-eydm\-2mgtmgl3bxnpq6w5btbbz4tjxzwicq | json { - "id": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2" + \(dqid\(dq: \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq } .ft P .fi @@ -1906,7 +1906,7 @@ the \fBAccept\-Language\fP header sent by the browser. .sp .nf .ft C -["sv_sv","sv","en_us","en"] +[\(dqsv_sv\(dq,\(dqsv\(dq,\(dqen_us\(dq,\(dqen\(dq] .ft P .fi .UNINDENT @@ -1920,7 +1920,7 @@ Returns a strong random generated string (alphanumeric) of the specified length. .nf .ft C { - "random": "FdPaEaZQ56sXEKYNxpgF" + \(dqrandom\(dq: \(dqFdPaEaZQ56sXEKYNxpgF\(dq } .ft P .fi @@ -1935,55 +1935,55 @@ Returns the data sent in the anonymous usage report. .nf .ft C { - "folderMaxMiB" : 0, - "platform" : "linux\-amd64", - "totMiB" : 0, - "longVersion" : "syncthing v0.12.2 \e"Beryllium Bedbug\e" (go1.4.3 linux\-amd64 default) unknown\-user@build2.syncthing.net 2015\-11\-09 13:23:26 UTC", - "upgradeAllowedManual" : true, - "totFiles" : 3, - "folderUses" : { - "ignorePerms" : 0, - "autoNormalize" : 0, - "sendonly" : 0, - "ignoreDelete" : 0 + \(dqfolderMaxMiB\(dq : 0, + \(dqplatform\(dq : \(dqlinux\-amd64\(dq, + \(dqtotMiB\(dq : 0, + \(dqlongVersion\(dq : \(dqsyncthing v0.12.2 \e\(dqBeryllium Bedbug\e\(dq (go1.4.3 linux\-amd64 default) unknown\-user@build2.syncthing.net 2015\-11\-09 13:23:26 UTC\(dq, + \(dqupgradeAllowedManual\(dq : true, + \(dqtotFiles\(dq : 3, + \(dqfolderUses\(dq : { + \(dqignorePerms\(dq : 0, + \(dqautoNormalize\(dq : 0, + \(dqsendonly\(dq : 0, + \(dqignoreDelete\(dq : 0 }, - "memoryUsageMiB" : 13, - "version" : "v0.12.2", - "sha256Perf" : 27.28, - "numFolders" : 2, - "memorySize" : 1992, - "announce" : { - "defaultServersIP" : 0, - "otherServers" : 0, - "globalEnabled" : false, - "defaultServersDNS" : 1, - "localEnabled" : false + \(dqmemoryUsageMiB\(dq : 13, + \(dqversion\(dq : \(dqv0.12.2\(dq, + \(dqsha256Perf\(dq : 27.28, + \(dqnumFolders\(dq : 2, + \(dqmemorySize\(dq : 1992, + \(dqannounce\(dq : { + \(dqdefaultServersIP\(dq : 0, + \(dqotherServers\(dq : 0, + \(dqglobalEnabled\(dq : false, + \(dqdefaultServersDNS\(dq : 1, + \(dqlocalEnabled\(dq : false }, - "usesRateLimit" : false, - "numCPU" : 2, - "uniqueID" : "", - "urVersion" : 2, - "rescanIntvs" : [ + \(dqusesRateLimit\(dq : false, + \(dqnumCPU\(dq : 2, + \(dquniqueID\(dq : \(dq\(dq, + \(dqurVersion\(dq : 2, + \(dqrescanIntvs\(dq : [ 60, 60 ], - "numDevices" : 2, - "folderMaxFiles" : 3, - "relays" : { - "defaultServers" : 1, - "enabled" : true, - "otherServers" : 0 + \(dqnumDevices\(dq : 2, + \(dqfolderMaxFiles\(dq : 3, + \(dqrelays\(dq : { + \(dqdefaultServers\(dq : 1, + \(dqenabled\(dq : true, + \(dqotherServers\(dq : 0 }, - "deviceUses" : { - "compressMetadata" : 1, - "customCertName" : 0, - "staticAddr" : 1, - "compressAlways" : 0, - "compressNever" : 1, - "introducer" : 0, - "dynamicAddr" : 1 + \(dqdeviceUses\(dq : { + \(dqcompressMetadata\(dq : 1, + \(dqcustomCertName\(dq : 0, + \(dqstaticAddr\(dq : 1, + \(dqcompressAlways\(dq : 0, + \(dqcompressNever\(dq : 1, + \(dqintroducer\(dq : 0, + \(dqdynamicAddr\(dq : 1 }, - "upgradeAllowedAuto" : false + \(dqupgradeAllowedAuto\(dq : false } .ft P .fi @@ -1992,7 +1992,7 @@ Returns the data sent in the anonymous usage report. .SH DEBUG ENDPOINTS .SS Debug Endpoints .sp -These endpoints require the \fBgui.debugging\fP configuration option to +These endpoints require the \fI\%gui.debugging\fP configuration option to be enabled and yield an access denied error code otherwise. .SS GET /rest/debug/peerCompletion .sp @@ -2005,11 +2005,11 @@ time was spent generating the responses. .SS GET /rest/debug/cpuprof .sp Used to capture a profile of what Syncthing is doing on the CPU. See -/users/profiling\&. +\fI\%Profiling\fP\&. .SS GET /rest/debug/heapprof .sp Used to capture a profile of what Syncthing is doing with the heap memory. See -/users/profiling\&. +\fI\%Profiling\fP\&. .SS GET /rest/debug/support .sp Collects information about the running instance for troubleshooting purposes. @@ -2025,27 +2025,27 @@ Shows diagnostics about a certain file in a shared folder. Takes the \fBfolder\ .sp .nf .ft C -$ curl \-H X\-API\-Key:... "http://localhost:8384/rest/debug/file?folder=default&file=foo/bar" +$ curl \-H X\-API\-Key:... \(dqhttp://localhost:8384/rest/debug/file?folder=default&file=foo/bar\(dq .ft P .fi .UNINDENT .UNINDENT .sp -The returned object contains the same info as db\-file\-get, plus a summary +The returned object contains the same info as \fI\%GET /rest/db/file\fP, plus a summary of \fBglobalVersions\fP\&. .SH NOAUTH ENDPOINTS .sp Calls that do not require authentication. .SS GET /rest/noauth/health .sp -Returns a \fB{"status": "OK"}\fP object. +Returns a \fB{\(dqstatus\(dq: \(dqOK\(dq}\fP object. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { - "status": "OK" + \(dqstatus\(dq: \(dqOK\(dq } .ft P .fi diff --git a/man/syncthing-security.7 b/man/syncthing-security.7 index 7dff50b75..b5bb59a55 100644 --- a/man/syncthing-security.7 +++ b/man/syncthing-security.7 @@ -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 diff --git a/man/syncthing-stignore.5 b/man/syncthing-stignore.5 index c01823cba..e77f78067 100644 --- a/man/syncthing-stignore.5 +++ b/man/syncthing-stignore.5 @@ -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 diff --git a/man/syncthing-versioning.7 b/man/syncthing-versioning.7 index c43077372..44b2b0788 100644 --- a/man/syncthing-versioning.7 +++ b/man/syncthing-versioning.7 @@ -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 diff --git a/man/syncthing.1 b/man/syncthing.1 index fc8e1abef..f25722cf0 100644 --- a/man/syncthing.1 +++ b/man/syncthing.1 @@ -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 |