瀏覽代碼

docs: clarify requirements when using command line options with special characters within a shell (#8628)

docs: within a shell, cli options with special characters may require quoting, #8578
goebbe 4 月之前
父節點
當前提交
4832364c1d
共有 1 個文件被更改,包括 9 次插入0 次删除
  1. 9 0
      src/borg/archiver/help_cmd.py

+ 9 - 0
src/borg/archiver/help_cmd.py

@@ -101,6 +101,15 @@ class HelpMixIn:
         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 hash sign
         '#' after removing whitespace on both ends are ignored. The optional style