From a56b010960e5052cf7c380eec78644799cd8ab58 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Fri, 5 Aug 2016 20:26:09 +0200 Subject: [PATCH] ran build_usage --- docs/usage/break-lock.rst.inc | 2 +- docs/usage/create.rst.inc | 2 +- docs/usage/help.rst.inc | 81 +++++++++++++++++++---------------- docs/usage/init.rst.inc | 3 +- docs/usage/mount.rst.inc | 5 +++ 5 files changed, 52 insertions(+), 41 deletions(-) diff --git a/docs/usage/break-lock.rst.inc b/docs/usage/break-lock.rst.inc index 43707040a..b3ba522a7 100644 --- a/docs/usage/break-lock.rst.inc +++ b/docs/usage/break-lock.rst.inc @@ -9,7 +9,7 @@ borg break-lock usage: borg break-lock [-h] [--critical] [--error] [--warning] [--info] [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] - REPOSITORY + [REPOSITORY] Break the repository lock (e.g. in case it was left by a dead borg. diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index fbf531bc6..c2d42f449 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -90,7 +90,7 @@ The archive name needs to be unique. It must not end in '.checkpoint' or checkpoints and treated in special ways. In the archive name, you may use the following format tags: -{now}, {utcnow}, {fqdn}, {hostname}, {user}, {pid} +{now}, {utcnow}, {fqdn}, {hostname}, {user}, {pid}, {borgversion} To speed up pulling backups over sshfs and similar network file systems which do not provide correct inode information the --ignore-inode flag can be used. This 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}-' ... + diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index 798fe6e53..f91021415 100644 --- a/docs/usage/init.rst.inc +++ b/docs/usage/init.rst.inc @@ -8,7 +8,7 @@ borg init usage: borg init [-h] [--critical] [--error] [--warning] [--info] [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] - [--remote-path PATH] [-e {none,keyfile,repokey}] + [--remote-path PATH] [-e {none,keyfile,repokey}] [-a] [REPOSITORY] Initialize an empty repository @@ -32,6 +32,7 @@ borg init --remote-path PATH set remote path to executable (default: "borg") -e {none,keyfile,repokey}, --encryption {none,keyfile,repokey} select encryption key mode (default: "repokey") + -a, --append-only create an append-only mode repository Description ~~~~~~~~~~~ diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index b8d1fb5ac..6deef307b 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -43,6 +43,11 @@ browsing an archive or restoring individual files. Unless the ``--foreground`` option is given the command will run in the background until the filesystem is ``umounted``. +The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users +to tweak the performance. It sets the number of cached data chunks; additional +memory usage can be up to ~8 MiB times this number. The default is the number +of CPU cores. + For mount options, see the fuse(8) manual page. Additional mount options supported by borg: