mirror of
https://github.com/borgbackup/borg.git
synced 2026-04-27 00:57:11 -04:00
ran build_usage
This commit is contained in:
Marian Beermann
parent
b1747873d9
commit
e869e7dc2f
25 changed files with 1270 additions and 346 deletions
|
|
@ -8,16 +8,42 @@ borg benchmark crud
|
|||
|
||||
borg [common options] benchmark crud [options] REPO PATH
|
||||
|
||||
REPO
|
||||
repo to use for benchmark (must exist)
|
||||
PATH
|
||||
path were to create benchmark input data
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------+------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------+------------------------------------------+
|
||||
| | ``REPO`` | repo to use for benchmark (must exist) |
|
||||
+-------------------------------------------------------+----------+------------------------------------------+
|
||||
| | ``PATH`` | path were to create benchmark input data |
|
||||
+-------------------------------------------------------+----------+------------------------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------+------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------+------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPO
|
||||
repo to use for benchmark (must exist)
|
||||
PATH
|
||||
path were to create benchmark input data
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,14 +8,38 @@ borg break-lock
|
|||
|
||||
borg [common options] break-lock [options] REPOSITORY
|
||||
|
||||
REPOSITORY
|
||||
repository for which to break the locks
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+-----------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+-----------------------------------------+
|
||||
| | ``REPOSITORY`` | repository for which to break the locks |
|
||||
+-------------------------------------------------------+----------------+-----------------------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+-----------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+-----------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY
|
||||
repository for which to break the locks
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,14 +8,38 @@ borg change-passphrase
|
|||
|
||||
borg [common options] change-passphrase [options] REPOSITORY
|
||||
|
||||
REPOSITORY
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| | ``REPOSITORY`` | |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY
|
||||
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,29 +8,75 @@ borg check
|
|||
|
||||
borg [common options] check [options] REPOSITORY_OR_ARCHIVE
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
repository or archive to check consistency of
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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 |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_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
|
||||
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
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,51 +8,131 @@ borg create
|
|||
|
||||
borg [common options] create [options] ARCHIVE PATH
|
||||
|
||||
ARCHIVE
|
||||
name of archive to create (must be also a valid directory name)
|
||||
PATH
|
||||
paths to archive
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``ARCHIVE`` | name of archive to create (must be also a valid directory name) |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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``. |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **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. |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **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. |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
ARCHIVE
|
||||
name of archive to create (must be also a valid directory name)
|
||||
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.
|
||||
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``.
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
: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
|
||||
|
||||
|
||||
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
|
||||
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.
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,28 +8,72 @@ borg delete
|
|||
|
||||
borg [common options] delete [options] TARGET
|
||||
|
||||
TARGET
|
||||
archive or repository to delete
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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 |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_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
|
||||
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
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,33 +8,83 @@ borg diff
|
|||
|
||||
borg [common options] diff [options] REPO_ARCHIVE1 ARCHIVE2 PATH
|
||||
|
||||
REPO_ARCHIVE1
|
||||
repository location and ARCHIVE1 name
|
||||
ARCHIVE2
|
||||
ARCHIVE2 name (no repository location allowed)
|
||||
PATH
|
||||
paths of items inside the archives to compare; patterns are supported
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPO_ARCHIVE1`` | repository location and ARCHIVE1 name |
|
||||
+-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``ARCHIVE2`` | ARCHIVE2 name (no repository location allowed) |
|
||||
+-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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. |
|
||||
+-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPO_ARCHIVE1
|
||||
repository location and ARCHIVE1 name
|
||||
ARCHIVE2
|
||||
ARCHIVE2 name (no repository location allowed)
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
: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
|
||||
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
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,28 +8,70 @@ borg export-tar
|
|||
|
||||
borg [common options] export-tar [options] ARCHIVE FILE PATH
|
||||
|
||||
ARCHIVE
|
||||
archive to export
|
||||
FILE
|
||||
output tar file. "-" to write to stdout instead.
|
||||
PATH
|
||||
paths to extract; patterns are supported
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| | ``ARCHIVE`` | archive to export |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| | ``FILE`` | output tar file. "-" to write to stdout instead. |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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. |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
ARCHIVE
|
||||
archive to export
|
||||
FILE
|
||||
output tar file. "-" to write to stdout instead.
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,29 +8,75 @@ borg extract
|
|||
|
||||
borg [common options] extract [options] ARCHIVE PATH
|
||||
|
||||
ARCHIVE
|
||||
archive to extract
|
||||
PATH
|
||||
paths to extract; patterns are supported
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| | ``ARCHIVE`` | archive to extract |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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 |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
ARCHIVE
|
||||
archive to extract
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ two alphanumeric characters followed by a colon (i.e. `aa:something/*`).
|
|||
separator, a '\*' is appended before matching is attempted.
|
||||
|
||||
Shell-style patterns, selector `sh:`
|
||||
This is the default style for --pattern and --patterns-from.
|
||||
This is the default style for ``--pattern`` and ``--patterns-from``.
|
||||
Like fnmatch patterns these are similar to shell patterns. The difference
|
||||
is that the pattern may include `**/` for matching zero or more directory
|
||||
levels, `*` for matching zero or more arbitrary characters with the
|
||||
|
|
|
|||
|
|
@ -8,25 +8,63 @@ borg info
|
|||
|
||||
borg [common options] info [options] REPOSITORY_OR_ARCHIVE
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
archive or repository to display information about
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY_OR_ARCHIVE`` | archive or repository to display information about |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--json`` | format output as JSON |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
archive or repository to display information about
|
||||
|
||||
|
||||
optional arguments
|
||||
--json format output as JSON
|
||||
optional arguments
|
||||
--json format output as JSON
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_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
|
||||
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
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,20 +8,50 @@ borg init
|
|||
|
||||
borg [common options] init [options] REPOSITORY
|
||||
|
||||
REPOSITORY
|
||||
repository to create
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
|
||||
| | ``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. |
|
||||
+-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,14 +8,38 @@ borg key change-passphrase
|
|||
|
||||
borg [common options] key change-passphrase [options] REPOSITORY
|
||||
|
||||
REPOSITORY
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| | ``REPOSITORY`` | |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY
|
||||
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,21 +8,51 @@ borg key export
|
|||
|
||||
borg [common options] key export [options] REPOSITORY PATH
|
||||
|
||||
REPOSITORY
|
||||
.. only:: html
|
||||
|
||||
PATH
|
||||
where to store the backup
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY`` | |
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
| | ``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 |
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,20 +8,48 @@ borg key import
|
|||
|
||||
borg [common options] key import [options] REPOSITORY PATH
|
||||
|
||||
REPOSITORY
|
||||
.. only:: html
|
||||
|
||||
PATH
|
||||
path to the backup
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| | ``REPOSITORY`` | |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| | ``PATH`` | path to the backup |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| | ``--paper`` | interactively import from a backup done with ``--paper`` |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY
|
||||
|
||||
PATH
|
||||
path to the backup
|
||||
|
||||
|
||||
optional arguments
|
||||
--paper interactively import from a backup done with ``--paper``
|
||||
optional arguments
|
||||
--paper interactively import from a backup done with ``--paper``
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,14 +8,38 @@ borg key migrate-to-repokey
|
|||
|
||||
borg [common options] key migrate-to-repokey [options] REPOSITORY
|
||||
|
||||
REPOSITORY
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| | ``REPOSITORY`` | |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+--+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY
|
||||
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,41 +8,102 @@ borg list
|
|||
|
||||
borg [common options] list [options] REPOSITORY_OR_ARCHIVE PATH
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
repository/archive to list contents of
|
||||
PATH
|
||||
paths to list; patterns are supported
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY_OR_ARCHIVE`` | repository/archive to list contents of |
|
||||
+-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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. |
|
||||
+-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **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 |
|
||||
+-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
repository/archive to list contents of
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_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
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,28 +8,70 @@ borg mount
|
|||
|
||||
borg [common options] mount [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
repository/archive to mount
|
||||
MOUNTPOINT
|
||||
where to mount filesystem
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY_OR_ARCHIVE`` | repository/archive to mount |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``MOUNTPOINT`` | where to mount filesystem |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-f``, ``--foreground`` | stay in foreground, do not daemonize |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-o`` | Extra mount options |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
repository/archive to mount
|
||||
MOUNTPOINT
|
||||
where to mount filesystem
|
||||
|
||||
|
||||
optional arguments
|
||||
-f, --foreground stay in foreground, do not daemonize
|
||||
-o Extra mount options
|
||||
optional arguments
|
||||
-f, --foreground stay in foreground, do not daemonize
|
||||
-o Extra mount options
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_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
|
||||
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
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,34 +8,90 @@ borg prune
|
|||
|
||||
borg [common options] prune [options] REPOSITORY
|
||||
|
||||
REPOSITORY
|
||||
repository to prune
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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 |
|
||||
+-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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. |
|
||||
+-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_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.
|
||||
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.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,42 +8,108 @@ borg recreate
|
|||
|
||||
borg [common options] recreate [options] REPOSITORY_OR_ARCHIVE PATH
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
repository/archive to recreate
|
||||
PATH
|
||||
paths to recreate; patterns are supported
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY_OR_ARCHIVE`` | repository/archive to recreate |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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 |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :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 |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **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 |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY_OR_ARCHIVE
|
||||
repository/archive to recreate
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
: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
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,16 +8,42 @@ borg rename
|
|||
|
||||
borg [common options] rename [options] ARCHIVE NEWNAME
|
||||
|
||||
ARCHIVE
|
||||
archive to rename
|
||||
NEWNAME
|
||||
the new archive name to use
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-------------+-----------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-------------+-----------------------------+
|
||||
| | ``ARCHIVE`` | archive to rename |
|
||||
+-------------------------------------------------------+-------------+-----------------------------+
|
||||
| | ``NEWNAME`` | the new archive name to use |
|
||||
+-------------------------------------------------------+-------------+-----------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+-------------+-----------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+-------------+-----------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
ARCHIVE
|
||||
archive to rename
|
||||
NEWNAME
|
||||
the new archive name to use
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,19 +8,49 @@ borg serve
|
|||
|
||||
borg [common options] serve [options]
|
||||
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **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. |
|
||||
+-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,14 +8,38 @@ borg umount
|
|||
|
||||
borg [common options] umount [options] MOUNTPOINT
|
||||
|
||||
MOUNTPOINT
|
||||
mountpoint of the filesystem to umount
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+----------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------+
|
||||
| | ``MOUNTPOINT`` | mountpoint of the filesystem to umount |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
MOUNTPOINT
|
||||
mountpoint of the filesystem to umount
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,23 +8,58 @@ borg upgrade
|
|||
|
||||
borg [common options] upgrade [options] REPOSITORY
|
||||
|
||||
REPOSITORY
|
||||
path to the repository to be upgraded
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``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) |
|
||||
+-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
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)
|
||||
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)
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -8,18 +8,46 @@ borg with-lock
|
|||
|
||||
borg [common options] with-lock [options] REPOSITORY COMMAND ARGS
|
||||
|
||||
REPOSITORY
|
||||
repository to lock
|
||||
COMMAND
|
||||
command to run
|
||||
ARGS
|
||||
command arguments
|
||||
.. only:: html
|
||||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+----------------+--------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+----------------+--------------------+
|
||||
| | ``REPOSITORY`` | repository to lock |
|
||||
+-------------------------------------------------------+----------------+--------------------+
|
||||
| | ``COMMAND`` | command to run |
|
||||
+-------------------------------------------------------+----------------+--------------------+
|
||||
| | ``ARGS`` | command arguments |
|
||||
+-------------------------------------------------------+----------------+--------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+--------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+----------------+--------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<script type='text/javascript'>
|
||||
$(window).load(function () {
|
||||
$('.borg-options-table colgroup').remove();
|
||||
})
|
||||
</script>
|
||||
|
||||
.. only:: latex
|
||||
|
||||
REPOSITORY
|
||||
repository to lock
|
||||
COMMAND
|
||||
command to run
|
||||
ARGS
|
||||
command arguments
|
||||
|
||||
|
||||
.. class:: borg-common-opt-ref
|
||||
|
||||
:ref:`common_options`
|
||||
|
||||
:ref:`common_options`
|
||||
|
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
|
|
|||
Loading…
Reference in a new issue