felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

gui, man, authors: Update docs, translations, and contributors

Browse Source
This commit is contained in:
Syncthing Release Automation
2022-03-21 03:47:47 +00:00
parent 26eaedc491
commit 5f383923df
21 changed files with 86 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/stdiscosrv.1
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "STDISCOSRV" "1" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "STDISCOSRV" "1" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.SH SYNOPSIS
man/strelaysrv.1
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "STRELAYSRV" "1" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "STRELAYSRV" "1" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.SH SYNOPSIS
man/syncthing-bep.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-BEP" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.SH INTRODUCTION AND DEFINITIONS
man/syncthing-config.5
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-CONFIG" "5" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.SH SYNOPSIS
man/syncthing-device-ids.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.sp
man/syncthing-event-api.7
+45 -3
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-EVENT-API" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.SH DESCRIPTION
@@ -593,6 +593,32 @@ state.
.fi
.UNINDENT
.UNINDENT
.SS FolderWatchStateChanged
.sp
The \fBFolderWatchStateChanged\fP event is emitted when a folder’s watcher routine
encounters a new error, or when a previous error disappeared after retrying.
The event contains the ID of the affected folder and textual error messages
describing the previous (\fBfrom\fP) and the updated (\fBto\fP) error conditions.
If there was no error in either of these, the respective field is omitted.
.INDENT 0.0
.INDENT 3.5
.sp
.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."
}
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS ItemFinished
.sp
Generated when Syncthing ends synchronizing a file to a newer version. A
@@ -738,8 +764,16 @@ 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 (remote\-change\-detected), only files that were changed on the
other devices (remotechangedetected), 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
a mask specified, but needs to be selected explicitly.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
@@ -895,7 +929,15 @@ 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 local\-change\-detected event.
Files that are updated locally produce a localchangedetected event.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This event is not included in /rest/events\-get endpoint without
a mask specified, but needs to be selected explicitly.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
man/syncthing-faq.7
+17 -2
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-FAQ" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.INDENT 0.0
@@ -655,7 +655,22 @@ echo 204800 | sudo tee /proc/sys/fs/inotify/max_user_watches
.UNINDENT
.SS How do I reset the GUI password?
.sp
If you’ve forgotten/lost the GUI password, you can remove it by deleting the \fB<user>\fP and \fB<password>\fP XML tags from the \fB<gui>\fP block in file \fBconfig.xml\fP\&. This should be done while Syncthing is not running. The location of the file depends on the OS and is described in the configuration documentation.
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
\fBsyncthing generate\fP subcommand. This should be done while Syncthing is not
running.
.INDENT 0.0
.IP 1. 3
Stop Syncthing: \fBsyncthing cli operations shutdown\fP
.IP 2. 3
\fBsyncthing generate \-\-gui\-password=myNewPassword \-\-gui\-user=newUserName\fP
.IP 3. 3
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
\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\&.
.sp
For example, the two emphasized lines below would be removed from the file.
.INDENT 0.0
man/syncthing-globaldisco.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-GLOBALDISCO" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.SH ANNOUNCEMENTS
man/syncthing-localdisco.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-LOCALDISCO" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.SH MODE OF OPERATION
man/syncthing-networking.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-NETWORKING" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.SH ROUTER SETUP
man/syncthing-relay.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-RELAY" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.SH WHAT IS A RELAY?
man/syncthing-rest-api.7
+6 -4
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-REST-API" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.sp
@@ -1709,9 +1709,11 @@ This is an expensive call, increasing CPU and RAM usage on the device. Use spari
.sp
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\&.
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.
.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,
man/syncthing-security.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-SECURITY" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.sp
man/syncthing-stignore.5
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-STIGNORE" "5" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.SH SYNOPSIS
man/syncthing-versioning.7
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-VERSIONING" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.sp
man/syncthing.1
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING" "1" "Mar 13, 2022" "v1.19.1" "Syncthing"
.TH "SYNCTHING" "1" "Mar 20, 2022" "v1.19.1" "Syncthing"
.SH NAME
syncthing \- Syncthing
.SH SYNOPSIS