diff options
author | Syncthing Release Automation <release@syncthing.net> | 2023-11-20 08:49:38 +0000 |
---|---|---|
committer | Syncthing Release Automation <release@syncthing.net> | 2023-11-20 08:49:38 +0000 |
commit | 8e9ee3fbe87e0a437d83db934a18d0a107cad467 (patch) | |
tree | 08c0e0242cc5f996c3c2f372e1a52ccbfa994a18 /man | |
parent | 35b0afc1319d9b6af1b449195bbc1661e435efeb (diff) | |
download | syncthing-8e9ee3fbe87e0a437d83db934a18d0a107cad467.tar.gz syncthing-8e9ee3fbe87e0a437d83db934a18d0a107cad467.zip |
gui, man, authors: Update docs, translations, and contributors
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 | 2 | ||||
-rw-r--r-- | man/syncthing-config.5 | 64 | ||||
-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 | 6 | ||||
-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 | 2 | ||||
-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 | 5 |
16 files changed, 54 insertions, 47 deletions
diff --git a/man/stdiscosrv.1 b/man/stdiscosrv.1 index 518e6f32b..4939f87a2 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "STDISCOSRV" "1" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME stdiscosrv \- Syncthing Discovery Server .SH SYNOPSIS diff --git a/man/strelaysrv.1 b/man/strelaysrv.1 index 88899b88e..68d988de9 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "STRELAYSRV" "1" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME strelaysrv \- Syncthing Relay Server .SH SYNOPSIS diff --git a/man/syncthing-bep.7 b/man/syncthing-bep.7 index 9a81cd59f..a0a5d20be 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-BEP" "7" "Nov 15, 2023" "v1.26.0" "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 adec2440d..18c829ae7 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-CONFIG" "5" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing-config \- Syncthing Configuration .SH SYNOPSIS @@ -36,7 +36,8 @@ syncthing-config \- Syncthing Configuration .sp .nf .ft C -$HOME/.config/syncthing +$XDG_STATE_HOME/syncthing +$HOME/.local/state/syncthing $HOME/Library/Application Support/Syncthing %LOCALAPPDATA%\eSyncthing .ft P @@ -45,17 +46,30 @@ $HOME/Library/Application Support/Syncthing .UNINDENT .SH DESCRIPTION .sp +Changed in version 1.27.0: The default location of the configuration and database directory on +Unix\-like systems was changed to \fB$XDG_STATE_HOME/syncthing\fP or +\fB$HOME/.local/state/syncthing\fP\&. Previously the default config location +was \fB$XDG_CONFIG_HOME/syncthing\fP or \fB$HOME/.config/syncthing\fP\&. The +database directory was previously \fB$HOME/.config/syncthing\fP or, if the +environment variable was set, \fB$XDG_DATA_HOME/syncthing\fP\&. Existing +installations may still use these directories instead of the newer +defaults. + +.sp New in version 1.5.0: Database and config can now be set separately. Previously the database was always located in the same directory as the config. .sp Syncthing uses a single directory to store configuration and crypto keys. -Syncthing also has a database, which is often stored in this directory too. -The config location defaults to \fB$HOME/.config/syncthing\fP -(Unix\-like), \fB$HOME/Library/Application Support/Syncthing\fP (Mac), -or \fB%LOCALAPPDATA%\eSyncthing\fP (Windows). It can be changed at runtime -using the \fB\-\-config\fP flag. In this directory the following files are -located: +Syncthing also keeps an index database with file metadata which is by +default stored in the same directory, though this can be overridden. +.sp +The location defaults to \fB$XDG_STATE_HOME/syncthing\fP or +\fB$HOME/.local/state/syncthing\fP (Unix\-like), \fB$HOME/Library/Application +Support/Syncthing\fP (Mac), or \fB%LOCALAPPDATA%\eSyncthing\fP (Windows). It can +be changed at runtime using the \fB\-\-config\fP or \fB\-\-home\fP flags or the +corresponding environment varibles (\fB$STCONFDIR\fP or \fBSTHOMEDIR\fP). The +following files are located in this directory: .INDENT 0.0 .TP .B \fBconfig.xml\fP @@ -68,35 +82,27 @@ device ID. The key must be kept private. .B \fBhttps\-cert.pem\fP, \fBhttps\-key.pem\fP The certificate and key for HTTPS GUI connections. These may be replaced with a custom certificate for HTTPS as desired. -.TP -.B \fBcsrftokens.txt\fP -A list of recently issued CSRF tokens (for protection against browser cross -site request forgery). .UNINDENT .sp -The database is stored either in the same directory as the config (usually the -default), but may also be located in one of the following directories (Unix\-like -platforms only): -.INDENT 0.0 -.IP \(bu 2 -If a database exists in the old default location, that location is -still used. -.IP \(bu 2 -If \fB$XDG_DATA_HOME\fP is set, use \fB$XDG_DATA_HOME/syncthing\fP\&. -.IP \(bu 2 -If \fB~/.local/share/syncthing\fP exists, use that location. -.IP \(bu 2 -Use the old default location (same as config). -.UNINDENT +The database is by default stored in the same directory as the config, but +the location may be overridden by the \fB\-\-data\fP or \fB\-\-home\fP flags or the +corresponding environment varibles (\fB$STDATADIR\fP or \fBSTHOMEDIR\fP). .sp -The location of the database can be changed using the \fB\-\-data\fP flag. The -\fB\-\-home\fP flag sets both config and database locations at the same time. -The database contains the following files: +The database directory contains the following files, among others: .INDENT 0.0 .TP .B \fBindex\-\fP\fI*\fP\fB\&.db\fP A directory holding the database with metadata and hashes of the files currently on disk and available from peers. +.TP +.B \fBsyncthing.log\fP +Log output, on some systems. +.TP +.B \fBaudit\-\fP\fI*\fP\fB\&.log\fP +Audit log data, when enabled. +.TP +.B \fBpanic\-\fP\fI*\fP\fB\&.log\fP +Crash log data, when required. .UNINDENT .SH CONFIG FILE FORMAT .sp diff --git a/man/syncthing-device-ids.7 b/man/syncthing-device-ids.7 index 960966c85..56ea39694 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-DEVICE-IDS" "7" "Nov 15, 2023" "v1.26.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 fa2cd1604..cdc2cae02 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-EVENT-API" "7" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing-event-api \- Event API .SH DESCRIPTION diff --git a/man/syncthing-faq.7 b/man/syncthing-faq.7 index 862b692ca..13b8da48e 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-FAQ" "7" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing-faq \- Frequently Asked Questions .INDENT 0.0 @@ -354,8 +354,8 @@ crashes and other bugs. The web GUI contains a \fBRecent Changes\fP button under the device list which displays changes since the last (re)start of Syncthing. With the \fB\-\-audit\fP option you can enable a persistent, detailed log of changes and most -activities, which contains a \fBJSON\fP formatted sequence of events in the -\fB~/.config/syncthing/audit\-_date_\-_time_.log\fP file. +activities, which contains a JSON\-formatted sequence of events in the +\fB~/.local/state/syncthing/audit\-_date_\-_time_.log\fP file. .SS Does the audit log contain every change? .sp The audit log (and the \fBRecent Changes\fP window) sees the changes that your diff --git a/man/syncthing-globaldisco.7 b/man/syncthing-globaldisco.7 index e734a18ca..861b4b49b 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-GLOBALDISCO" "7" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing-globaldisco \- Global Discovery Protocol v3 .SH ANNOUNCEMENTS diff --git a/man/syncthing-localdisco.7 b/man/syncthing-localdisco.7 index a245d6afb..687adc60e 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-LOCALDISCO" "7" "Nov 15, 2023" "v1.26.0" "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 64bb30c50..7a6bba24e 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-NETWORKING" "7" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing-networking \- Firewall Setup .SH ROUTER SETUP diff --git a/man/syncthing-relay.7 b/man/syncthing-relay.7 index 0e9e5e7d0..b4c17ec37 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-RELAY" "7" "Nov 15, 2023" "v1.26.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 e0ac84a83..a6c143b3f 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-REST-API" "7" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing-rest-api \- REST API .sp diff --git a/man/syncthing-security.7 b/man/syncthing-security.7 index b68df1169..68bc6e092 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-SECURITY" "7" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing-security \- Security Principles .sp diff --git a/man/syncthing-stignore.5 b/man/syncthing-stignore.5 index 28b58c6a9..c2281d926 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-STIGNORE" "5" "Nov 15, 2023" "v1.26.0" "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 3083e34ad..17ae0a994 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING-VERSIONING" "7" "Nov 15, 2023" "v1.26.0" "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 71dcb9e88..354e5268f 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" "Nov 08, 2023" "v1.26.0" "Syncthing" +.TH "SYNCTHING" "1" "Nov 15, 2023" "v1.26.0" "Syncthing" .SH NAME syncthing \- Syncthing .SH SYNOPSIS @@ -156,7 +156,8 @@ given subcommand. .TP .B \-\-home=<dir> Set common configuration and data directory. The default configuration -directory is \fB$HOME/.config/syncthing\fP (Unix\-like), +directory is \fB$XDG_STATE_HOME/syncthing\fP or +\fB$HOME/.local/state/syncthing\fP (Unix\-like), \fB$HOME/Library/Application Support/Syncthing\fP (Mac) and \fB%LOCALAPPDATA%\eSyncthing\fP (Windows). .UNINDENT |