diff --git a/man/stdiscosrv.1 b/man/stdiscosrv.1 index c4bd0630b..f16f4897b 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "STDISCOSRV" "1" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME stdiscosrv \- Syncthing Discovery Server .SH SYNOPSIS diff --git a/man/strelaysrv.1 b/man/strelaysrv.1 index 58ec7d585..05c4e67a4 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "STRELAYSRV" "1" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME strelaysrv \- Syncthing Relay Server .SH SYNOPSIS diff --git a/man/syncthing-bep.7 b/man/syncthing-bep.7 index 96e362aa6..d93195fc9 100644 --- a/man/syncthing-bep.7 +++ b/man/syncthing-bep.7 @@ -28,7 +28,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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-BEP" "7" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-bep \- Block Exchange Protocol v1 .SH INTRODUCTION AND DEFINITIONS diff --git a/man/syncthing-config.5 b/man/syncthing-config.5 index ba243a96d..05f641ee5 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-CONFIG" "5" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-config \- Syncthing Configuration .SH SYNOPSIS @@ -861,6 +861,8 @@ for example: .EE .UNINDENT .UNINDENT +.sp +In the GUI, multiple values are separated by commas. .UNINDENT .INDENT 0.0 .TP @@ -871,7 +873,9 @@ 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 \fI\%separate chapter\fP). +The mechanism is described in detail in a \fI\%separate chapter\fP). To configure multiple networks, you +can either: repeat \fB\fP tags in the configuration file or +enter several networks separated by commas in the GUI. .UNINDENT .INDENT 0.0 .TP @@ -902,6 +906,8 @@ despite the config name looking like kilobits/second. Contains the ID of the folder that should be ignored. This folder will always be skipped when advertised from the containing remote device, i.e. this will be logged, but there will be no dialog shown in the web GUI. +Multiple ignored folders are represented by repeated \fB\fP +tags in the configuration file. .UNINDENT .INDENT 0.0 .TP @@ -1201,7 +1207,10 @@ The \fBoptions\fP element contains all other global configuration options. .TP .B listenAddress The listen address for incoming sync connections. See -\fI\%Listen Addresses\fP for the allowed syntax. +\fI\%Listen Addresses\fP for the allowed syntax. To configure multiple +addresses, you can either: repeat \fB\fP tags in the +configuration file or enter several addresses separated by commas in the +GUI. .UNINDENT .INDENT 0.0 .TP @@ -1212,7 +1221,10 @@ may be present. The syntax for non\-default entries is that of an HTTP or HTTPS URL. A number of options may be added as query options to the URL: \fBinsecure\fP to prevent certificate validation (required for HTTP URLs) and \fBid=\fP to perform certificate pinning. The device ID to -use is printed by the discovery server on startup. +use is printed by the discovery server on startup. To configure multiple +servers, you can either: repeat \fB\fP tags in the +configuration file or enter several servers separated by commas in the +GUI. .UNINDENT .INDENT 0.0 .TP @@ -1380,7 +1392,10 @@ The URL from which release information is loaded, for automatic upgrades. .INDENT 0.0 .TP .B alwaysLocalNet -Network that should be considered as local given in CIDR notation. +Network that should be considered as local given in CIDR notation. To +configure multiple networks, you can either: repeat \fB\fP +tags in the configuration file or enter several networks separated by +commas in the GUI. .UNINDENT .INDENT 0.0 .TP @@ -1399,7 +1414,9 @@ into account files that have at least this many blocks. .TP .B unackedNotificationID ID of a notification to be displayed in the web GUI. Will be removed once -the user acknowledged it (e.g. an transition notice on an upgrade). +the user acknowledged it (e.g. a transition notice on an upgrade). Multiple +IDs are represented by repeated \fB\fP tags in the +configuration file. .UNINDENT .INDENT 0.0 .TP @@ -1422,6 +1439,10 @@ expanded to \fBstun.sipgate.net:3478\fP, \fBstun.voip.aebc.com:3478\fP, \fBstun.voiparound.com:3478\fP, \fBstun.voipbuster.com:3478\fP, \fBstun.voipstunt.com:3478\fP and \fBstun.xten.com:3478\fP (this is the default). +.sp +To configure multiple servers, you can either: repeat \fB\fP tags +in the configuration file or enter several servers separated by commas in +the GUI. .UNINDENT .INDENT 0.0 .TP @@ -1501,7 +1522,9 @@ troubleshooting step and causes high database churn. The default is now Feature flags are simple strings that, when added to the configuration, may unleash unfinished or still\-in\-development features to allow early user testing. Any supported value will be separately announced with the feature, -so that regular users do not enable it by accident. +so that regular users do not enable it by accident. To configure multiple +flags, you can either: repeat \fB\fP tags in the configuration +file or enter several flags separated by commas in the GUI. .UNINDENT .INDENT 0.0 .TP @@ -1626,9 +1649,9 @@ line is represented as by a \fB\fP element. .SS Listen Addresses .sp The following address types are accepted in sync protocol listen addresses. -If you want Syncthing to listen on multiple addresses, you can either: add -multiple \fB\fP tags in the configuration file or enter several -addresses separated by commas in the GUI. +If you want Syncthing to listen on multiple addresses, you can either: repeat +\fB\fP tags in the configuration file or enter several addresses +separated by commas in the GUI. .INDENT 0.0 .TP .B Default listen addresses (\fBdefault\fP) diff --git a/man/syncthing-device-ids.7 b/man/syncthing-device-ids.7 index 6c000f5a0..ea7e08f67 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-DEVICE-IDS" "7" "Jan 11, 2025" "v1.29.1" "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 2e4bb8d03..205ebdbb8 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-EVENT-API" "7" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-event-api \- Event API .SH DESCRIPTION diff --git a/man/syncthing-faq.7 b/man/syncthing-faq.7 index b707ed71b..fb920cad9 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-FAQ" "7" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-faq \- Frequently Asked Questions .INDENT 0.0 diff --git a/man/syncthing-globaldisco.7 b/man/syncthing-globaldisco.7 index 0998a7920..10d7f4e12 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-GLOBALDISCO" "7" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-globaldisco \- Global Discovery Protocol v3 .SH ANNOUNCEMENTS diff --git a/man/syncthing-localdisco.7 b/man/syncthing-localdisco.7 index f6f3d8737..40c6c1f0a 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-LOCALDISCO" "7" "Jan 11, 2025" "v1.29.1" "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 c3fa7986e..813b3c257 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-NETWORKING" "7" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-networking \- Firewall Setup .SH ROUTER SETUP diff --git a/man/syncthing-relay.7 b/man/syncthing-relay.7 index d079ab087..daf570d75 100644 --- a/man/syncthing-relay.7 +++ b/man/syncthing-relay.7 @@ -28,7 +28,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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-RELAY" "7" "Jan 11, 2025" "v1.29.1" "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 1ded2d6f1..b2194d2b3 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-REST-API" "7" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-rest-api \- REST API .sp @@ -1289,10 +1289,29 @@ not connected. Otherwise it can be either \fBpaused\fP, \fBnotSharing\fP, or .SS GET /rest/db/file .sp -Returns most data available about a given file, including version and -availability. Takes \fBfolder\fP and \fBfile\fP parameters. \fBlocal\fP and -\fBglobal\fP refer to the current file on disk and the globally newest file, -respectively. +Returns most data about a given file, including version and availability. +.SS Request +.sp +The call requires parameters for \fBfolder\fP and \fBfile\fP in the query string: +.INDENT 0.0 +.IP \(bu 2 +\fBfolder\fP is the folder ID which you can find in the Syncthing Web GUI, +e.g. \fB5camp\-slpa8\fP\&. +.IP \(bu 2 +\fBfile\fP is the relative path of the file starting from the folder root to the +file you are interested in. The path and filename must be correctly +URL\-encoded. +.UNINDENT +.SS Example Request +.INDENT 0.0 +.INDENT 3.5 +.sp +.EX +$ curl \-s \-H X\-API\-KEY:... \(dqhttp://localhost:8384/rest/db/file?folder=YOUR_FOLDER_ID\(dq \-\-url\-query \(dqfile=path/to/file.pdf\(dq +.EE +.UNINDENT +.UNINDENT +.SS Response .INDENT 0.0 .INDENT 3.5 .sp @@ -1305,55 +1324,53 @@ respectively. } ], \(dqglobal\(dq: { /* a file entry */ }, - \(dqlocal\(dq: { /* a file entry */ } -} -.EE -.UNINDENT -.UNINDENT -.sp -A file entry looks like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.EX -{ - { - \(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 - ] - }, + \(dqlocal\(dq: { /* a file entry */ }, \(dqmtime\(dq: { \(dqerr\(dq: null, \(dqvalue\(dq: { \(dqreal\(dq: \(dq0001\-01\-01T00:00:00Z\(dq, \(dqvirtual\(dq: \(dq0001\-01\-01T00:00:00Z\(dq - } } } .EE .UNINDENT .UNINDENT .sp +\fBlocal\fP and \fBglobal\fP refer to the current file on the local device and the +globally newest file, respectively. A file entry looks like this: +.INDENT 0.0 +.INDENT 3.5 +.sp +.EX +{ + \(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 + ] +} +.EE +.UNINDENT +.UNINDENT +.sp Platform specific data may be ownership, extended attributes, etc. and is -divided into entries per operating system / platform. An example platform -entry containing ownership information for Unix systems and an extended -attribute for macOS (“darwin”) looks as follows: +divided into entries per operating system / platform. An example platform entry +containing ownership information for Unix systems and an extended attribute for +macOS (“darwin”) looks as follows: .INDENT 0.0 .INDENT 3.5 .sp diff --git a/man/syncthing-security.7 b/man/syncthing-security.7 index 015e966c6..d5d3eba42 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-SECURITY" "7" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing-security \- Security Principles .sp diff --git a/man/syncthing-stignore.5 b/man/syncthing-stignore.5 index 322b4897b..354efcd70 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-STIGNORE" "5" "Jan 11, 2025" "v1.29.1" "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 0df3de07e..883a8c3dd 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING-VERSIONING" "7" "Jan 11, 2025" "v1.29.1" "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 0c865c875..1fbac1138 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" "Jan 06, 2025" "v1.28.1" "Syncthing" +.TH "SYNCTHING" "1" "Jan 11, 2025" "v1.29.1" "Syncthing" .SH NAME syncthing \- Syncthing .SH SYNOPSIS