Browse Source

Merge pull request #8633 from goebbe/1.4-maint

docs: clarify requirements when using command line options with special characters within a shell #8628
TW 4 months ago
parent
commit
4344e64436
1 changed files with 9 additions and 0 deletions
  1. 9 0
      src/borg/archiver.py

+ 9 - 0
src/borg/archiver.py

@@ -2414,6 +2414,15 @@ class Archiver:
         from within a shell, the patterns should be quoted to protect them from
         expansion.
 
+        Patterns matching special characters, e.g. white space, within a shell may 
+        require adjustments, such as putting quotation marks around the arguments.
+        Example: 
+        Using bash, the following command line option would match and exclude "item name":
+        ``--pattern='-path/item name'``
+        Note that when patterns are used within a pattern file directly read by borg,  
+        e.g. when using ``--exclude-from`` or ``--patterns-from``, there is no shell 
+        involved and thus no quotation marks are required.
+
         The ``--exclude-from`` option permits loading exclusion patterns from a text
         file with one pattern per line. Lines empty or starting with the number sign
         ('#') after removing whitespace on both ends are ignored. The optional style