1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-21 23:09:40 +00:00

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
This commit is contained in:
goebbe 2025-01-11 14:37:21 +01:00 committed by GitHub
parent 3a43b58aee
commit 4832364c1d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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