mirror of
https://github.com/borgbackup/borg.git
synced 2025-01-22 07:19:02 +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:
parent
3a43b58aee
commit
4832364c1d
1 changed files with 9 additions and 0 deletions
|
@ -101,6 +101,15 @@ class HelpMixIn:
|
||||||
from within a shell, the patterns should be quoted to protect them from
|
from within a shell, the patterns should be quoted to protect them from
|
||||||
expansion.
|
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
|
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
|
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
|
'#' after removing whitespace on both ends are ignored. The optional style
|
||||||
|
|
Loading…
Reference in a new issue