Document (?d) prefix

GitHub-Pull-Request: https://github.com/syncthing/docs/pull/160
This commit is contained in:
Audrius Butkevicius
2016-04-30 18:51:14 +00:00
committed by Jakob Borg
parent 8d245533a7
commit 69cdae0149
+16 -5
View File
@@ -20,6 +20,11 @@ If some files should not be synchronized to other nodes, a file called
``#include`` files that *are* synchronized between nodes. All patterns are ``#include`` files that *are* synchronized between nodes. All patterns are
relative to the repository root. relative to the repository root.
.. note::
Note that ignored files can block removal of an otherwise empty directory.
See below for the (?d) prefix to allow deletion of ignored files.
Patterns Patterns
-------- --------
@@ -54,25 +59,31 @@ The ``.stignore`` file contains a list of file or path patterns. The
still relative to the repository *root*. Example: still relative to the repository *root*. Example:
``#include more-patterns.txt``. ``#include more-patterns.txt``.
- A pattern beginning with ``!`` negates the pattern: matching files - A pattern beginning with a ``!`` prefix negates the pattern: matching files
are *included* (that is, *not* ignored). This can be used to override are *included* (that is, *not* ignored). This can be used to override
more general patterns that follow. Note that files in ignored more general patterns that follow. Note that files in ignored
directories can not be re-included this way. This is due to the fact directories can not be re-included this way. This is due to the fact
that Syncthing stops scanning when it reaches an ignored directory, that Syncthing stops scanning when it reaches an ignored directory,
so doesn't know what files it might contain. so doesn't know what files it might contain.
- A pattern beginning with ``(?i)`` enables case-insensitive pattern - A pattern beginning with a ``(?i)`` prefix enables case-insensitive pattern
matching. ``(?i)test`` matches ``test``, ``TEST`` and ``tEsT``. The matching. ``(?i)test`` matches ``test``, ``TEST`` and ``tEsT``. The
``(?i)`` prefix can be combined with other patterns, for example the ``(?i)`` prefix can be combined with other patterns, for example the
pattern ``(?i)!picture*.png`` indicates that ``Picture1.PNG`` should pattern ``(?i)!picture*.png`` indicates that ``Picture1.PNG`` should
be synchronized. Note that case-insensitive patterns must start with be synchronized. On Mac OS and Windows, patterns are always case-insensitive.
``(?i)`` when combined with other flags. On Mac OS and Windows,
patterns are always case-insensitive. - A pattern beginning with a ``(?d)`` prefix enables removal of these files if
they are preventing directory deletion. This prefix should be used by any OS
generated files which you are happy to be removed.
- A line beginning with ``//`` is a comment and has no effect. - A line beginning with ``//`` is a comment and has no effect.
- Windows does not support escaping ``\[foo - bar\]``. - Windows does not support escaping ``\[foo - bar\]``.
.. note::
Prefixes can be specified in any order.
Example Example
------- -------