diff options
Diffstat (limited to 'docs/usage/help.rst.inc')
-rw-r--r-- | docs/usage/help.rst.inc | 81 |
1 files changed, 43 insertions, 38 deletions
diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc index 4d7c776a7..b079dd2d6 100644 --- a/docs/usage/help.rst.inc +++ b/docs/usage/help.rst.inc @@ -1,43 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. _borg_placeholders: - -borg help placeholders -~~~~~~~~~~~~~~~~~~~~~~ - - -Repository (or Archive) URLs and --prefix values support these placeholders: - -{hostname} - - The (short) hostname of the machine. - -{fqdn} - - The full name of the machine. - -{now} - - The current local date and time. - -{utcnow} - - The current UTC date and time. - -{user} - - The user name (or UID, if no name is available) of the user running borg. - -{pid} - - The current process ID. - -Examples:: - - borg create /path/to/repo::{hostname}-{user}-{utcnow} ... - borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ... - borg prune --prefix '{hostname}-' ... - .. _borg_patterns: borg help patterns @@ -131,3 +93,46 @@ Examples:: EOF $ borg create --exclude-from exclude.txt backup / +.. _borg_placeholders: + +borg help placeholders +~~~~~~~~~~~~~~~~~~~~~~ + + + Repository (or Archive) URLs, --prefix and --remote-path values support these + placeholders: + + {hostname} + + The (short) hostname of the machine. + + {fqdn} + + The full name of the machine. + + {now} + + The current local date and time. + + {utcnow} + + The current UTC date and time. + + {user} + + The user name (or UID, if no name is available) of the user running borg. + + {pid} + + The current process ID. + + {borgversion} + + The version of borg. + +Examples:: + + borg create /path/to/repo::{hostname}-{user}-{utcnow} ... + borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ... + borg prune --prefix '{hostname}-' ... + |