mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

ran build_usage

This commit is contained in:
Marian Beermann 2017-06-20 11:49:26 +02:00
parent 6290b73863
commit e5012b11ca
25 changed files with 292 additions and 426 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/usage/benchmark_crud.rst.inc
View File

@ -8,12 +8,12 @@ borg benchmark crud
borg [common options] benchmark crud [options] REPO PATH
positional arguments
REPO
REPO
repo to use for benchmark (must exist)
PATH
PATH
path were to create benchmark input data
:ref:`common_options`
|

4
docs/usage/break-lock.rst.inc
View File

@ -8,10 +8,10 @@ borg break-lock
borg [common options] break-lock [options] REPOSITORY
positional arguments
REPOSITORY
REPOSITORY
repository for which to break the locks
:ref:`common_options`
|

4
docs/usage/change-passphrase.rst.inc
View File

@ -8,8 +8,8 @@ borg change-passphrase
borg [common options] change-passphrase [options] REPOSITORY
positional arguments
REPOSITORY
REPOSITORY
:ref:`common_options`

36
docs/usage/check.rst.inc
View File

@ -8,36 +8,28 @@ borg check
borg [common options] check [options] REPOSITORY_OR_ARCHIVE
positional arguments
REPOSITORY_OR_ARCHIVE
REPOSITORY_OR_ARCHIVE
repository or archive to check consistency of
optional arguments
``--repository-only``
| only perform repository checks
``--archives-only``
| only perform archives checks
``--verify-data``
| perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)
``--repair``
| attempt to repair any inconsistencies found
``--save-space``
| work slower, but using less space
--repository-only only perform repository checks
--archives-only only perform archives checks
--verify-data perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)
--repair attempt to repair any inconsistencies found
--save-space work slower, but using less space
:ref:`common_options`
|
filters
``-P``, ``--prefix``
| only consider archive names starting with this prefix.
``-a``, ``--glob-archives``
| only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
``--sort-by``
| Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
``--first N``
| consider first N archives after other filters were applied
``--last N``
| consider last N archives after other filters were applied
-P, --prefix only consider archive names starting with this prefix.
-a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
--sort-by Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
Description
~~~~~~~~~~~

54
docs/usage/common-options.rst.inc
View File

@ -1,36 +1,18 @@
``-h``, ``--help``
| show this help message and exit
``--critical``
| work on log level CRITICAL
``--error``
| work on log level ERROR
``--warning``
| work on log level WARNING (default)
``--info``, ``-v``, ``--verbose``
| work on log level INFO
``--debug``
| enable debug output, work on log level DEBUG
``--debug-topic TOPIC``
| enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
``-p``, ``--progress``
| show progress information
``--log-json``
| Output one JSON object per log line instead of formatted text.
``--lock-wait N``
| wait for the lock, but max. N seconds (default: 1).
``--show-version``
| show/log the borg version
``--show-rc``
| show/log the return code (rc)
``--no-files-cache``
| do not load/update the file metadata cache used to detect unchanged files
``--umask M``
| set umask to M (local and remote, default: 0077)
``--remote-path PATH``
| use PATH as borg executable on the remote (default: "borg")
``--remote-ratelimit rate``
| set remote network upload rate limit in kiByte/s (default: 0=unlimited)
``--consider-part-files``
| treat part files like normal files (e.g. to list/extract them)
``--debug-profile FILE``
| Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof".
-h, --help show this help message and exit
--critical work on log level CRITICAL
--error work on log level ERROR
--warning work on log level WARNING (default)
--info, -v, --verbose work on log level INFO
--debug enable debug output, work on log level DEBUG
--debug-topic TOPIC enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
-p, --progress show progress information
--log-json Output one JSON object per log line instead of formatted text.
--lock-wait N wait for the lock, but max. N seconds (default: 1).
--show-version show/log the borg version
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to detect unchanged files
--umask M set umask to M (local and remote, default: 0077)
--remote-path PATH use PATH as borg executable on the remote (default: "borg")
--remote-ratelimit rate set remote network upload rate limit in kiByte/s (default: 0=unlimited)
--consider-part-files treat part files like normal files (e.g. to list/extract them)
--debug-profile FILE Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof".

82
docs/usage/create.rst.inc
View File

@ -8,70 +8,50 @@ borg create
borg [common options] create [options] ARCHIVE PATH
positional arguments
ARCHIVE
ARCHIVE
name of archive to create (must be also a valid directory name)
PATH
PATH
paths to archive
optional arguments
``-n``, ``--dry-run``
| do not create a backup archive
``-s``, ``--stats``
| print statistics for the created archive
``--list``
| output verbose list of items (files, dirs, ...)
``--filter STATUSCHARS``
| only display items with the given status characters
``--json``
| output stats as JSON (implies --stats)
``--no-cache-sync``
| experimental: do not synchronize the cache. Implies --no-files-cache.
-n, --dry-run do not create a backup archive
-s, --stats print statistics for the created archive
--list output verbose list of items (files, dirs, ...)
--filter STATUSCHARS only display items with the given status characters
--json output stats as JSON (implies --stats)
--no-cache-sync experimental: do not synchronize the cache. Implies --no-files-cache.
:ref:`common_options`
|
Exclusion options
``-e PATTERN``, ``--exclude PATTERN``
| exclude paths matching PATTERN
``--exclude-from EXCLUDEFILE``
| read exclude patterns from EXCLUDEFILE, one per line
``--exclude-caches``
| exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
``--exclude-if-present NAME``
| exclude directories that are tagged by containing a filesystem object with the given NAME
``--keep-exclude-tags``, ``--keep-tag-files``
| if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
``--pattern PATTERN``
| experimental: include/exclude paths matching PATTERN
``--patterns-from PATTERNFILE``
| experimental: read include/exclude patterns from PATTERNFILE, one per line
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN
--exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line
--exclude-caches exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
--exclude-if-present NAME exclude directories that are tagged by containing a filesystem object with the given NAME
--keep-exclude-tags, --keep-tag-files if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
--pattern PATTERN experimental: include/exclude paths matching PATTERN
--patterns-from PATTERNFILE experimental: read include/exclude patterns from PATTERNFILE, one per line
Filesystem options
``-x``, ``--one-file-system``
| stay in the same file system and do not store mount points of other file systems
``--numeric-owner``
| only store numeric user and group identifiers
``--noatime``
| do not store atime into archive
``--noctime``
| do not store ctime into archive
``--ignore-inode``
| ignore inode data in the file metadata cache used to detect unchanged files.
``--read-special``
| open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files.
-x, --one-file-system stay in the same file system and do not store mount points of other file systems
--numeric-owner only store numeric user and group identifiers
--noatime do not store atime into archive
--noctime do not store ctime into archive
--ignore-inode ignore inode data in the file metadata cache used to detect unchanged files.
--read-special open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files.
Archive options
``--comment COMMENT``
| add a comment text to the archive
``--timestamp TIMESTAMP``
| manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
``-c SECONDS``, ``--checkpoint-interval SECONDS``
| write checkpoint every SECONDS seconds (Default: 1800)
``--chunker-params PARAMS``
| specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: 19,23,21,4095
``-C COMPRESSION``, ``--compression COMPRESSION``
| select compression algorithm, see the output of the "borg help compression" command for details.
--comment COMMENT add a comment text to the archive
--timestamp TIMESTAMP manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
-c SECONDS, --checkpoint-interval SECONDS write checkpoint every SECONDS seconds (Default: 1800)
--chunker-params PARAMS specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: 19,23,21,4095
-C COMPRESSION, --compression COMPRESSION select compression algorithm, see the output of the "borg help compression" command for details.
Description
~~~~~~~~~~~

33
docs/usage/delete.rst.inc
View File

@ -8,34 +8,27 @@ borg delete
borg [common options] delete [options] TARGET
positional arguments
TARGET
TARGET
archive or repository to delete
optional arguments
``-s``, ``--stats``
| print statistics for the deleted archive
``-c``, ``--cache-only``
| delete only the local cache for the given repository
``--force``
| force deletion of corrupted archives, use --force --force in case --force does not work.
``--save-space``
| work slower, but using less space
-s, --stats print statistics for the deleted archive
-c, --cache-only delete only the local cache for the given repository
--force force deletion of corrupted archives, use --force --force in case --force does not work.
--save-space work slower, but using less space
:ref:`common_options`
|
filters
``-P``, ``--prefix``
| only consider archive names starting with this prefix.
``-a``, ``--glob-archives``
| only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
``--sort-by``
| Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
``--first N``
| consider first N archives after other filters were applied
``--last N``
| consider last N archives after other filters were applied
-P, --prefix only consider archive names starting with this prefix.
-a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
--sort-by Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
Description
~~~~~~~~~~~

40
docs/usage/diff.rst.inc
View File

@ -8,40 +8,32 @@ borg diff
borg [common options] diff [options] REPO_ARCHIVE1 ARCHIVE2 PATH
positional arguments
REPO_ARCHIVE1
REPO_ARCHIVE1
repository location and ARCHIVE1 name
ARCHIVE2
ARCHIVE2
ARCHIVE2 name (no repository location allowed)
PATH
PATH
paths of items inside the archives to compare; patterns are supported
optional arguments
``--numeric-owner``
| only consider numeric user and group identifiers
``--same-chunker-params``
| Override check of chunker parameters.
``--sort``
| Sort the output lines by file path.
--numeric-owner only consider numeric user and group identifiers
--same-chunker-params Override check of chunker parameters.
--sort Sort the output lines by file path.
:ref:`common_options`
|
Exclusion options
``-e PATTERN``, ``--exclude PATTERN``
| exclude paths matching PATTERN
``--exclude-from EXCLUDEFILE``
| read exclude patterns from EXCLUDEFILE, one per line
``--exclude-caches``
| exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
``--exclude-if-present NAME``
| exclude directories that are tagged by containing a filesystem object with the given NAME
``--keep-exclude-tags``, ``--keep-tag-files``
| if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
``--pattern PATTERN``
| experimental: include/exclude paths matching PATTERN
``--patterns-from PATTERNFILE``
| experimental: read include/exclude patterns from PATTERNFILE, one per line
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN
--exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line
--exclude-caches exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
--exclude-if-present NAME exclude directories that are tagged by containing a filesystem object with the given NAME
--keep-exclude-tags, --keep-tag-files if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
--pattern PATTERN experimental: include/exclude paths matching PATTERN
--patterns-from PATTERNFILE experimental: read include/exclude patterns from PATTERNFILE, one per line
Description
~~~~~~~~~~~

30
docs/usage/export-tar.rst.inc
View File

@ -8,29 +8,23 @@ borg export-tar
borg [common options] export-tar [options] ARCHIVE FILE PATH
positional arguments
ARCHIVE
ARCHIVE
archive to export
FILE
FILE
output tar file. "-" to write to stdout instead.
PATH
PATH
paths to extract; patterns are supported
optional arguments
``--tar-filter``
| filter program to pipe data through
``--list``
| output verbose list of items (files, dirs, ...)
``-e PATTERN``, ``--exclude PATTERN``
| exclude paths matching PATTERN
``--exclude-from EXCLUDEFILE``
| read exclude patterns from EXCLUDEFILE, one per line
``--pattern PATTERN``
| experimental: include/exclude paths matching PATTERN
``--patterns-from PATTERNFILE``
| experimental: read include/exclude patterns from PATTERNFILE, one per line
``--strip-components NUMBER``
| Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
--tar-filter filter program to pipe data through
--list output verbose list of items (files, dirs, ...)
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN
--exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line
--pattern PATTERN experimental: include/exclude paths matching PATTERN
--patterns-from PATTERNFILE experimental: read include/exclude patterns from PATTERNFILE, one per line
--strip-components NUMBER Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
:ref:`common_options`
|

37
docs/usage/extract.rst.inc
View File

@ -8,33 +8,24 @@ borg extract
borg [common options] extract [options] ARCHIVE PATH
positional arguments
ARCHIVE
ARCHIVE
archive to extract
PATH
PATH
paths to extract; patterns are supported
optional arguments
``--list``
| output verbose list of items (files, dirs, ...)
``-n``, ``--dry-run``
| do not actually change any files
``-e PATTERN``, ``--exclude PATTERN``
| exclude paths matching PATTERN
``--exclude-from EXCLUDEFILE``
| read exclude patterns from EXCLUDEFILE, one per line
``--pattern PATTERN``
| experimental: include/exclude paths matching PATTERN
``--patterns-from PATTERNFILE``
| experimental: read include/exclude patterns from PATTERNFILE, one per line
``--numeric-owner``
| only obey numeric user and group identifiers
``--strip-components NUMBER``
| Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
``--stdout``
| write all extracted data to stdout
``--sparse``
| create holes in output sparse file from all-zero chunks
--list output verbose list of items (files, dirs, ...)
-n, --dry-run do not actually change any files
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN
--exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line
--pattern PATTERN experimental: include/exclude paths matching PATTERN
--patterns-from PATTERNFILE experimental: read include/exclude patterns from PATTERNFILE, one per line
--numeric-owner only obey numeric user and group identifiers
--strip-components NUMBER Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
--stdout write all extracted data to stdout
--sparse create holes in output sparse file from all-zero chunks
:ref:`common_options`
|

24
docs/usage/info.rst.inc
View File

@ -8,28 +8,24 @@ borg info
borg [common options] info [options] REPOSITORY_OR_ARCHIVE
positional arguments
REPOSITORY_OR_ARCHIVE
REPOSITORY_OR_ARCHIVE
archive or repository to display information about
optional arguments
``--json``
| format output as JSON
--json format output as JSON
:ref:`common_options`
|
filters
``-P``, ``--prefix``
| only consider archive names starting with this prefix.
``-a``, ``--glob-archives``
| only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
``--sort-by``
| Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
``--first N``
| consider first N archives after other filters were applied
``--last N``
| consider last N archives after other filters were applied
-P, --prefix only consider archive names starting with this prefix.
-a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
--sort-by Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
Description
~~~~~~~~~~~

14
docs/usage/init.rst.inc
View File

@ -8,17 +8,15 @@ borg init
borg [common options] init [options] REPOSITORY
positional arguments
REPOSITORY
REPOSITORY
repository to create
optional arguments
``-e``, ``--encryption``
| select encryption key mode **(required)**
``--append-only``
| create an append-only mode repository
``--storage-quota``
| Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
-e, --encryption select encryption key mode **(required)**
--append-only create an append-only mode repository
--storage-quota Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
:ref:`common_options`
|

4
docs/usage/key_change-passphrase.rst.inc
View File

@ -8,8 +8,8 @@ borg key change-passphrase
borg [common options] key change-passphrase [options] REPOSITORY
positional arguments
REPOSITORY
REPOSITORY
:ref:`common_options`

13
docs/usage/key_export.rst.inc
View File

@ -8,17 +8,16 @@ borg key export
borg [common options] key export [options] REPOSITORY PATH
positional arguments
REPOSITORY
REPOSITORY
PATH
PATH
where to store the backup
optional arguments
``--paper``
| Create an export suitable for printing and later type-in
``--qr-html``
| Create an html file suitable for printing and later type-in or qr scan
--paper Create an export suitable for printing and later type-in
--qr-html Create an html file suitable for printing and later type-in or qr scan
:ref:`common_options`
|

10
docs/usage/key_import.rst.inc
View File

@ -8,15 +8,15 @@ borg key import
borg [common options] key import [options] REPOSITORY PATH
positional arguments
REPOSITORY
REPOSITORY
PATH
PATH
path to the backup
optional arguments
``--paper``
| interactively import from a backup done with ``--paper``
--paper interactively import from a backup done with ``--paper``
:ref:`common_options`
|

4
docs/usage/key_migrate-to-repokey.rst.inc
View File

@ -8,8 +8,8 @@ borg key migrate-to-repokey
borg [common options] key migrate-to-repokey [options] REPOSITORY
positional arguments
REPOSITORY
REPOSITORY
:ref:`common_options`

59
docs/usage/list.rst.inc
View File

@ -8,53 +8,40 @@ borg list
borg [common options] list [options] REPOSITORY_OR_ARCHIVE PATH
positional arguments
REPOSITORY_OR_ARCHIVE
REPOSITORY_OR_ARCHIVE
repository/archive to list contents of
PATH
PATH
paths to list; patterns are supported
optional arguments
``--short``
| only print file/directory names, nothing else
``--format``, ``--list-format``
| specify format for file listing
| (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}")
``--json``
| Only valid for listing repository contents. Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available.
``--json-lines``
| Only valid for listing archive contents. Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
--short only print file/directory names, nothing else
--format, --list-format specify format for file listing
(default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}")
--json Only valid for listing repository contents. Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available.
--json-lines Only valid for listing archive contents. Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
:ref:`common_options`
|
filters
``-P``, ``--prefix``
| only consider archive names starting with this prefix.
``-a``, ``--glob-archives``
| only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
``--sort-by``
| Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
``--first N``
| consider first N archives after other filters were applied
``--last N``
| consider last N archives after other filters were applied
-P, --prefix only consider archive names starting with this prefix.
-a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
--sort-by Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
Exclusion options
``-e PATTERN``, ``--exclude PATTERN``
| exclude paths matching PATTERN
``--exclude-from EXCLUDEFILE``
| read exclude patterns from EXCLUDEFILE, one per line
``--exclude-caches``
| exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
``--exclude-if-present NAME``
| exclude directories that are tagged by containing a filesystem object with the given NAME
``--keep-exclude-tags``, ``--keep-tag-files``
| if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
``--pattern PATTERN``
| experimental: include/exclude paths matching PATTERN
``--patterns-from PATTERNFILE``
| experimental: read include/exclude patterns from PATTERNFILE, one per line
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN
--exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line
--exclude-caches exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
--exclude-if-present NAME exclude directories that are tagged by containing a filesystem object with the given NAME
--keep-exclude-tags, --keep-tag-files if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
--pattern PATTERN experimental: include/exclude paths matching PATTERN
--patterns-from PATTERNFILE experimental: read include/exclude patterns from PATTERNFILE, one per line
Description
~~~~~~~~~~~

29
docs/usage/mount.rst.inc
View File

@ -8,32 +8,27 @@ borg mount
borg [common options] mount [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT
positional arguments
REPOSITORY_OR_ARCHIVE
REPOSITORY_OR_ARCHIVE
repository/archive to mount
MOUNTPOINT
MOUNTPOINT
where to mount filesystem
optional arguments
``-f``, ``--foreground``
| stay in foreground, do not daemonize
``-o``
| Extra mount options
-f, --foreground stay in foreground, do not daemonize
-o Extra mount options
:ref:`common_options`
|
filters
``-P``, ``--prefix``
| only consider archive names starting with this prefix.
``-a``, ``--glob-archives``
| only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
``--sort-by``
| Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
``--first N``
| consider first N archives after other filters were applied
``--last N``
| consider last N archives after other filters were applied
-P, --prefix only consider archive names starting with this prefix.
-a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
--sort-by Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
Description
~~~~~~~~~~~

51
docs/usage/prune.rst.inc
View File

@ -8,46 +8,33 @@ borg prune
borg [common options] prune [options] REPOSITORY
positional arguments
REPOSITORY
REPOSITORY
repository to prune
optional arguments
``-n``, ``--dry-run``
| do not change repository
``--force``
| force pruning of corrupted archives
``-s``, ``--stats``
| print statistics for the deleted archive
``--list``
| output verbose list of archives it keeps/prunes
``--keep-within WITHIN``
| keep all archives within this time interval
``--keep-last``, ``--keep-secondly``
| number of secondly archives to keep
``--keep-minutely``
| number of minutely archives to keep
``-H``, ``--keep-hourly``
| number of hourly archives to keep
``-d``, ``--keep-daily``
| number of daily archives to keep
``-w``, ``--keep-weekly``
| number of weekly archives to keep
``-m``, ``--keep-monthly``
| number of monthly archives to keep
``-y``, ``--keep-yearly``
| number of yearly archives to keep
``--save-space``
| work slower, but using less space
-n, --dry-run do not change repository
--force force pruning of corrupted archives
-s, --stats print statistics for the deleted archive
--list output verbose list of archives it keeps/prunes
--keep-within WITHIN keep all archives within this time interval
--keep-last, --keep-secondly number of secondly archives to keep
--keep-minutely number of minutely archives to keep
-H, --keep-hourly number of hourly archives to keep
-d, --keep-daily number of daily archives to keep
-w, --keep-weekly number of weekly archives to keep
-m, --keep-monthly number of monthly archives to keep
-y, --keep-yearly number of yearly archives to keep
--save-space work slower, but using less space
:ref:`common_options`
|
filters
``-P``, ``--prefix``
| only consider archive names starting with this prefix.
``-a``, ``--glob-archives``
| only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
-P, --prefix only consider archive names starting with this prefix.
-a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
Description
~~~~~~~~~~~

63
docs/usage/recreate.rst.inc
View File

@ -8,56 +8,41 @@ borg recreate
borg [common options] recreate [options] REPOSITORY_OR_ARCHIVE PATH
positional arguments
REPOSITORY_OR_ARCHIVE
REPOSITORY_OR_ARCHIVE
repository/archive to recreate
PATH
PATH
paths to recreate; patterns are supported
optional arguments
``--list``
| output verbose list of items (files, dirs, ...)
``--filter STATUSCHARS``
| only display items with the given status characters
``-n``, ``--dry-run``
| do not change anything
``-s``, ``--stats``
| print statistics at end
--list output verbose list of items (files, dirs, ...)
--filter STATUSCHARS only display items with the given status characters
-n, --dry-run do not change anything
-s, --stats print statistics at end
:ref:`common_options`
|
Exclusion options
``-e PATTERN``, ``--exclude PATTERN``
| exclude paths matching PATTERN
``--exclude-from EXCLUDEFILE``
| read exclude patterns from EXCLUDEFILE, one per line
``--exclude-caches``
| exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
``--exclude-if-present NAME``
| exclude directories that are tagged by containing a filesystem object with the given NAME
``--keep-exclude-tags``, ``--keep-tag-files``
| if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
``--pattern PATTERN``
| experimental: include/exclude paths matching PATTERN
``--patterns-from PATTERNFILE``
| experimental: read include/exclude patterns from PATTERNFILE, one per line
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN
--exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line
--exclude-caches exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
--exclude-if-present NAME exclude directories that are tagged by containing a filesystem object with the given NAME
--keep-exclude-tags, --keep-tag-files if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
--pattern PATTERN experimental: include/exclude paths matching PATTERN
--patterns-from PATTERNFILE experimental: read include/exclude patterns from PATTERNFILE, one per line
Archive options
``--target TARGET``
| create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
``-c SECONDS``, ``--checkpoint-interval SECONDS``
| write checkpoint every SECONDS seconds (Default: 1800)
``--comment COMMENT``
| add a comment text to the archive
``--timestamp TIMESTAMP``
| manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
``-C COMPRESSION``, ``--compression COMPRESSION``
| select compression algorithm, see the output of the "borg help compression" command for details.
``--recompress``
| recompress data chunks according to ``--compression`` if `if-different`. When `always`, chunks that are already compressed that way are not skipped, but compressed again. Only the algorithm is considered for `if-different`, not the compression level (if any).
``--chunker-params PARAMS``
| specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: 19,23,21,4095
--target TARGET create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
-c SECONDS, --checkpoint-interval SECONDS write checkpoint every SECONDS seconds (Default: 1800)
--comment COMMENT add a comment text to the archive
--timestamp TIMESTAMP manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
-C COMPRESSION, --compression COMPRESSION select compression algorithm, see the output of the "borg help compression" command for details.
--recompress recompress data chunks according to ``--compression`` if `if-different`. When `always`, chunks that are already compressed that way are not skipped, but compressed again. Only the algorithm is considered for `if-different`, not the compression level (if any).
--chunker-params PARAMS specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: 19,23,21,4095
Description
~~~~~~~~~~~

6
docs/usage/rename.rst.inc
View File

@ -8,12 +8,12 @@ borg rename
borg [common options] rename [options] ARCHIVE NEWNAME
positional arguments
ARCHIVE
ARCHIVE
archive to rename
NEWNAME
NEWNAME
the new archive name to use
:ref:`common_options`
|

15
docs/usage/serve.rst.inc
View File

@ -8,15 +8,14 @@ borg serve
borg [common options] serve [options]
optional arguments
``--restrict-to-path PATH``
| restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
``--restrict-to-repository PATH``
| restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike --restrict-to-path sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.
``--append-only``
| only allow appending to repository segment files
``--storage-quota``
| Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.
--restrict-to-path PATH restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
--restrict-to-repository PATH restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike --restrict-to-path sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.
--append-only only allow appending to repository segment files
--storage-quota Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.
:ref:`common_options`
|

4
docs/usage/umount.rst.inc
View File

@ -8,10 +8,10 @@ borg umount
borg [common options] umount [options] MOUNTPOINT
positional arguments
MOUNTPOINT
MOUNTPOINT
mountpoint of the filesystem to umount
:ref:`common_options`
|

22
docs/usage/upgrade.rst.inc
View File

@ -8,22 +8,18 @@ borg upgrade
borg [common options] upgrade [options] REPOSITORY
positional arguments
REPOSITORY
REPOSITORY
path to the repository to be upgraded
optional arguments
``-n``, ``--dry-run``
| do not change repository
``--inplace``
| rewrite repository in place, with no chance of going back to older
| versions of the repository.
``--force``
| Force upgrade
``--tam``
| Enable manifest authentication (in key and cache) (Borg 1.0.9 and later)
``--disable-tam``
| Disable manifest authentication (in key and cache)
-n, --dry-run do not change repository
--inplace rewrite repository in place, with no chance of going back to older
versions of the repository.
--force Force upgrade
--tam Enable manifest authentication (in key and cache) (Borg 1.0.9 and later)
--disable-tam Disable manifest authentication (in key and cache)
:ref:`common_options`
|

8
docs/usage/with-lock.rst.inc
View File

@ -8,14 +8,14 @@ borg with-lock
borg [common options] with-lock [options] REPOSITORY COMMAND ARGS
positional arguments
REPOSITORY
REPOSITORY
repository to lock
COMMAND
COMMAND
command to run
ARGS
ARGS
command arguments
:ref:`common_options`
|