chore: update man pages for 2.0

This commit is contained in:
Jakob Borg
2025-08-11 19:33:32 +02:00
parent 3da84804b6
commit c74d2a9872
16 changed files with 300 additions and 459 deletions
+34 -8
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" "Aug 01, 2025" "v1.29.7" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Aug 11, 2025" "v2.0.0" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.SH SYNOPSIS
@@ -92,12 +92,32 @@ and does not denote a set of alternatives as above.
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
Escaped characters are not supported on Windows, where \fB\e\fP is the
path separator. If you still need to match files that have square or
curly brackets in their names, one possible workaround is to replace
them with \fB?\fP, which will then match any character. For example,
you can type \fB?banana?\fP to match both \fB[banana]\fP and
\fB{banana}\fP, and so on.
On Windows, \fB\e\fP is the path separator, so use \fB|\fP to escape special
characters. For example, \fB|{banana|}\fP matches
\fB{banana}\fP\&.
.sp
To use \fB\e\fP to escape special characters (and use \fB/\fP as the path separator),
insert a \fB#escape=\e\fP at the top of the file. Heres a short example:
.INDENT 0.0
.INDENT 3.5
.nf
\fB#escape=\e\fP
\fB/foo\fP
\fB/path/bar/\e{banana\e}\fP
\fB/path/baz\e[2\e]/ex\e[3\e].txt\fP
.fi
.sp
.UNINDENT
.UNINDENT
.sp
\fB#escape=\e\fP must be placed at the top of the file, before any patterns,
but leading comments, and blank lines are OK.
.sp
Any files included using \fB#include\fP (see below) will each need their
own \fB#escape=\e\fP\&.
.sp
Using \fB#escape=\e\fP allows the same file to be synced and used on any
operating system.
.UNINDENT
.UNINDENT
.IP \(bu 2
@@ -259,9 +279,15 @@ accepting a folder from a remote device. The GUI suggests the same patterns
when adding a folder manually. In either case, the \fB\&.stignore\fP file is
created with these defaults if none is present yet.
.sp
Added in version 2.0.0: Windows users can now use the pipe character (\fB|\fP) to escape
metacharacters in the \fB\&.stignore\fP file. Additionally, adding
\fB#escape=X\fP to the top of the file, allows users to define \fBX\fP
as the escape character for that particular file.
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT
2014-2019, The Syncthing Authors
2014-2025, The Syncthing Authors
.\" Generated by docutils manpage writer.
.