diff options
author | Syncthing Release Automation <release@syncthing.net> | 2023-07-31 03:45:37 +0000 |
---|---|---|
committer | Syncthing Release Automation <release@syncthing.net> | 2023-07-31 03:45:37 +0000 |
commit | 97625ccc26d0919f709acc8e4b1211b485e722aa (patch) | |
tree | b78eba9259cc50107659ff1f5077a4aee57fa849 /man | |
parent | 4fe746d9aa5b140ebe3775fe35598dd823d1c54b (diff) | |
download | syncthing-97625ccc26d0919f709acc8e4b1211b485e722aa.tar.gz syncthing-97625ccc26d0919f709acc8e4b1211b485e722aa.zip |
gui, man, authors: Update docs, translations, and contributorsv1.23.7-rc.2v1.23.7
Diffstat (limited to 'man')
-rw-r--r-- | man/stdiscosrv.1 | 2 | ||||
-rw-r--r-- | man/strelaysrv.1 | 2 | ||||
-rw-r--r-- | man/syncthing-bep.7 | 28 | ||||
-rw-r--r-- | man/syncthing-config.5 | 6 | ||||
-rw-r--r-- | man/syncthing-device-ids.7 | 2 | ||||
-rw-r--r-- | man/syncthing-event-api.7 | 2 | ||||
-rw-r--r-- | man/syncthing-faq.7 | 2 | ||||
-rw-r--r-- | man/syncthing-globaldisco.7 | 2 | ||||
-rw-r--r-- | man/syncthing-localdisco.7 | 2 | ||||
-rw-r--r-- | man/syncthing-networking.7 | 2 | ||||
-rw-r--r-- | man/syncthing-relay.7 | 2 | ||||
-rw-r--r-- | man/syncthing-rest-api.7 | 11 | ||||
-rw-r--r-- | man/syncthing-security.7 | 2 | ||||
-rw-r--r-- | man/syncthing-stignore.5 | 2 | ||||
-rw-r--r-- | man/syncthing-versioning.7 | 2 | ||||
-rw-r--r-- | man/syncthing.1 | 2 |
16 files changed, 38 insertions, 33 deletions
diff --git a/man/stdiscosrv.1 b/man/stdiscosrv.1 index de5741471..ee321e67b 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "STDISCOSRV" "1" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME stdiscosrv \- Syncthing Discovery Server .SH SYNOPSIS diff --git a/man/strelaysrv.1 b/man/strelaysrv.1 index 7188be1fa..37c24813c 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "STRELAYSRV" "1" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME strelaysrv \- Syncthing Relay Server .SH SYNOPSIS diff --git a/man/syncthing-bep.7 b/man/syncthing-bep.7 index d3fd9ce23..1da863054 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-BEP" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-bep \- Block Exchange Protocol v1 .SH INTRODUCTION AND DEFINITIONS @@ -326,16 +326,16 @@ the folder. The \fBlabel\fP field contains the folder label, the human readable name of the folder. .sp -The \fBread only\fP field is set for folders that the device will accept no +The \fBread_only\fP field is set for folders that the device will accept no updates from the network for. .sp -The \fBignore permissions\fP field is set for folders that the device will not +The \fBignore_permissions\fP field is set for folders that the device will not accept or announce file permissions for. .sp -The \fBignore delete\fP field is set for folders that the device will ignore +The \fBignore_delete\fP field is set for folders that the device will ignore deletes for. .sp -The \fBdisable temp indexes\fP field is set for folders that will not dispatch +The \fBdisable_temp_indexes\fP field is set for folders that will not dispatch and do not wish to receive progress updates about partially downloaded files via Download Progress messages. .sp @@ -369,23 +369,23 @@ Compression disabled. No compression is used on any message. Compress always. Metadata messages as well as Response messages are compressed. .UNINDENT .sp -The \fBcert name\fP field indicates the expected certificate name for this +The \fBcert_name\fP field indicates the expected certificate name for this device. It is commonly blank, indicating to use the implementation default. .sp -The \fBmax sequence\fP field contains the highest sequence number of the files +The \fBmax_sequence\fP field contains the highest sequence number of the files in the index. See \fI\%Delta Index Exchange\fP for the usage of this field. .sp The \fBintroducer\fP field is set for devices that are trusted as cluster introducers. .sp -The \fBindex id\fP field contains the unique identifier for the current set of +The \fBindex_id\fP field contains the unique identifier for the current set of index data. See \fI\%Delta Index Exchange\fP for the usage of this field. .sp -The \fBskip introduction removals\fP field signifies if the remote device has +The \fBskip_introduction_removals\fP field signifies if the remote device has opted to ignore introduction removals for the given device. This setting is copied across as we are being introduced to a new device. .sp -The \fBenc pw token\fP field contains a token derived from the password, that is +The \fBencryption_password_token\fP field contains a token derived from the password, that is used to encrypt data sent to this device. If the device is the same as the device sending the message, it signifies that the device itself has encrypted data that was encrypted with the given token. It is empty or missing if there is @@ -506,7 +506,7 @@ The \fBinvalid\fP field is set when the file is invalid and unavailable for synchronization. A peer MAY set this bit to indicate that it can temporarily not serve data for the file. .sp -The \fBno permissions\fP field is set when there is no permission information +The \fBno_permissions\fP field is set when there is no permission information for the file. This is the case when it originates on a file system which does not support permissions. Changes to only permission bits SHOULD be disregarded on files with this bit set. The permissions bits MUST be set to @@ -575,7 +575,7 @@ the other device SHOULD ensure that the transmitted block matches the requested hash. The other device MAY reuse a block from a different file and offset having the same size and hash, if one exists. .sp -The \fBfrom temporary\fP field is set to indicate that the read should be +The \fBfrom_temporary\fP field is set to indicate that the read should be performed from the temporary file (converting name to it’s temporary form) and falling back to the non temporary file if any error occurs. Knowledge of contents of temporary files comes from DownloadProgress messages. @@ -672,7 +672,7 @@ being provided. The \fBupdates\fP field is a list of progress update messages. .SS Fields (FileDownloadProgressUpdate Message) .sp -The \fBupdate type\fP indicates whether the update is of type \fBappend (0)\fP +The \fBupdate_type\fP indicates whether the update is of type \fBappend (0)\fP (new blocks are available) or \fBforget (1)\fP (the file transfer has completed or failed). .sp @@ -682,7 +682,7 @@ this update is being sent. The \fBversion\fP message defines the version of the file for which this update is being sent. .sp -The \fBblock indexes\fP field is a list of positive integers, where each +The \fBblock_indexes\fP field is a list of positive integers, where each integer represents the index of the block in the FileInfo message Blocks array that has become available for download. .sp diff --git a/man/syncthing-config.5 b/man/syncthing-config.5 index 1ddc132a3..801ecb962 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-CONFIG" "5" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-config \- Syncthing Configuration .SH SYNOPSIS @@ -1337,7 +1337,9 @@ ignores is usually not significant. .TP .B progressUpdateIntervalS How often in seconds the progress of ongoing downloads is made available to -the GUI. +the GUI. Set to \fB\-1\fP to disable. Note that when disabled, the detailed +sync progress for Out of Sync Items which shows how much of each file has +been reused, copied, and downloaded will not work. .UNINDENT .INDENT 0.0 .TP diff --git a/man/syncthing-device-ids.7 b/man/syncthing-device-ids.7 index 8bc06e6f5..2a1a0f03e 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-DEVICE-IDS" "7" "Jul 30, 2023" "v1.23.6" "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 08cfb0a73..c53192e8a 100644 --- a/man/syncthing-event-api.7 +++ b/man/syncthing-event-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-EVENT-API" "7" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-EVENT-API" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-event-api \- Event API .SH DESCRIPTION diff --git a/man/syncthing-faq.7 b/man/syncthing-faq.7 index 764d18f9d..1a4a0dfef 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-FAQ" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-faq \- Frequently Asked Questions .INDENT 0.0 diff --git a/man/syncthing-globaldisco.7 b/man/syncthing-globaldisco.7 index 66c4e99da..a375e8adc 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-GLOBALDISCO" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-globaldisco \- Global Discovery Protocol v3 .SH ANNOUNCEMENTS diff --git a/man/syncthing-localdisco.7 b/man/syncthing-localdisco.7 index d399f5b7d..bb3f4090f 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-LOCALDISCO" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-localdisco \- Local Discovery Protocol v4 .SH MODE OF OPERATION diff --git a/man/syncthing-networking.7 b/man/syncthing-networking.7 index 90710f44b..c3368a62c 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-NETWORKING" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-networking \- Firewall Setup .SH ROUTER SETUP diff --git a/man/syncthing-relay.7 b/man/syncthing-relay.7 index 15fdb996f..e4ffe87ac 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-RELAY" "7" "Jul 30, 2023" "v1.23.6" "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 5b524196b..a5b960852 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-REST-API" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-rest-api \- REST API .sp @@ -40,9 +40,12 @@ interface is subject to change. 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. For example, \fBcurl \-X POST \-H -"X\-API\-Key: abc123" 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). +\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 +(add \fB\-k\fP flag when using HTTPS with a Syncthing generated or self signed +certificate). .sp One exception to this requirement is \fB/rest/noauth\fP, you do not need an API key to use those endpoints. This way third\-party devices and services can do diff --git a/man/syncthing-security.7 b/man/syncthing-security.7 index 9f2629efd..41d4d9b71 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-SECURITY" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-security \- Security Principles .sp diff --git a/man/syncthing-stignore.5 b/man/syncthing-stignore.5 index febc1b279..7cf0c5277 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-STIGNORE" "5" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-stignore \- Prevent files from being synchronized to other nodes .SH SYNOPSIS diff --git a/man/syncthing-versioning.7 b/man/syncthing-versioning.7 index d6a71e5de..8cd1d1389 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING-VERSIONING" "7" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing-versioning \- Keep automatic backups of deleted files by other nodes .sp diff --git a/man/syncthing.1 b/man/syncthing.1 index 7a0199121..9510dc327 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" "Jul 08, 2023" "v1.23.6" "Syncthing" +.TH "SYNCTHING" "1" "Jul 30, 2023" "v1.23.6" "Syncthing" .SH NAME syncthing \- Syncthing .SH SYNOPSIS |