From 4d2eb06ed340b2f998478e4316ac1d96b1603d66 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sat, 26 Nov 2022 22:23:17 +0100 Subject: [PATCH] build_usage --- docs/usage/check.rst.inc | 4 ++-- docs/usage/compact.rst.inc | 4 ++-- docs/usage/config.rst.inc | 4 ++-- docs/usage/create.rst.inc | 8 ++++---- docs/usage/delete.rst.inc | 4 ++-- docs/usage/diff.rst.inc | 4 ++-- docs/usage/export-tar.rst.inc | 6 +++--- docs/usage/extract.rst.inc | 4 ++-- docs/usage/import-tar.rst.inc | 6 +++--- docs/usage/info.rst.inc | 4 ++-- docs/usage/key_change-location.rst.inc | 4 ++-- docs/usage/key_export.rst.inc | 4 ++-- docs/usage/key_import.rst.inc | 4 ++-- docs/usage/list.rst.inc | 4 ++-- docs/usage/mount.rst.inc | 4 ++-- docs/usage/prune.rst.inc | 4 ++-- docs/usage/rcompress.rst.inc | 4 ++-- docs/usage/rcreate.rst.inc | 4 ++-- docs/usage/rdelete.rst.inc | 4 ++-- docs/usage/recreate.rst.inc | 4 ++-- docs/usage/rinfo.rst.inc | 4 ++-- docs/usage/rlist.rst.inc | 4 ++-- docs/usage/serve.rst.inc | 4 ++-- docs/usage/transfer.rst.inc | 4 ++-- 24 files changed, 52 insertions(+), 52 deletions(-) diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index d64e0112..beb9dc36 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -13,7 +13,7 @@ borg check .. class:: borg-options-table +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ | | ``--repository-only`` | only perform repository checks | +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -54,7 +54,7 @@ borg check - optional arguments + options --repository-only only perform repository checks --archives-only only perform archives checks --verify-data perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) diff --git a/docs/usage/compact.rst.inc b/docs/usage/compact.rst.inc index 946b376f..3bac1db8 100644 --- a/docs/usage/compact.rst.inc +++ b/docs/usage/compact.rst.inc @@ -13,7 +13,7 @@ borg compact .. class:: borg-options-table +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ | | ``--threshold PERCENT`` | set minimum threshold for saved space in PERCENT (Default: 10) | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ @@ -34,7 +34,7 @@ borg compact - optional arguments + options --threshold PERCENT set minimum threshold for saved space in PERCENT (Default: 10) diff --git a/docs/usage/config.rst.inc b/docs/usage/config.rst.inc index d0d2e9e7..521a91d3 100644 --- a/docs/usage/config.rst.inc +++ b/docs/usage/config.rst.inc @@ -19,7 +19,7 @@ borg config +-------------------------------------------------------+----------------------+----------------------------------------+ | | ``VALUE`` | new value for key | +-------------------------------------------------------+----------------------+----------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+----------------------+----------------------------------------+ | | ``-c``, ``--cache`` | get and set values from the repo cache | +-------------------------------------------------------+----------------------+----------------------------------------+ @@ -48,7 +48,7 @@ borg config new value for key - optional arguments + options -c, --cache get and set values from the repo cache -d, --delete delete the key from the config file -l, --list list the configuration of the repo diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index 39f31a97..74b0aef6 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -19,7 +19,7 @@ borg create +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to archive | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not create a backup archive | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,7 +37,7 @@ borg create +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--stdin-user USER`` | set user USER in archive for stdin data (default: 'root') | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | ``--stdin-group GROUP`` | set group GROUP in archive for stdin data (default: 'root') | + | | ``--stdin-group GROUP`` | set group GROUP in archive for stdin data (default: 'wheel') | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--stdin-mode M`` | set mode to M in archive for stdin data (default: 0660) | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -124,7 +124,7 @@ borg create paths to archive - optional arguments + options -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, ...) @@ -133,7 +133,7 @@ borg create --no-cache-sync experimental: do not synchronize the cache. Implies not using the files cache. --stdin-name NAME use NAME in archive for stdin data (default: 'stdin') --stdin-user USER set user USER in archive for stdin data (default: 'root') - --stdin-group GROUP set group GROUP in archive for stdin data (default: 'root') + --stdin-group GROUP set group GROUP in archive for stdin data (default: 'wheel') --stdin-mode M set mode to M in archive for stdin data (default: 0660) --content-from-command interpret PATH as command and store its stdout. See also section Reading from stdin below. --paths-from-stdin read DELIM-separated list of paths to backup from stdin. Will not recurse into directories. diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index b3dde149..63413584 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -13,7 +13,7 @@ borg delete .. class:: borg-options-table +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -58,7 +58,7 @@ borg delete - optional arguments + options -n, --dry-run do not change repository --list output verbose list of archives --consider-checkpoints consider checkpoint archives for deletion (default: not considered). diff --git a/docs/usage/diff.rst.inc b/docs/usage/diff.rst.inc index b759b96e..b3bd6797 100644 --- a/docs/usage/diff.rst.inc +++ b/docs/usage/diff.rst.inc @@ -21,7 +21,7 @@ borg diff +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ | | ``PATH`` | paths of items inside the archives to compare; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ | | ``--numeric-ids`` | only consider numeric user and group identifiers | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ @@ -64,7 +64,7 @@ borg diff paths of items inside the archives to compare; patterns are supported - optional arguments + options --numeric-ids only consider numeric user and group identifiers --same-chunker-params Override check of chunker parameters. --sort Sort the output lines by file path. diff --git a/docs/usage/export-tar.rst.inc b/docs/usage/export-tar.rst.inc index 5839bb2f..1da3bc41 100644 --- a/docs/usage/export-tar.rst.inc +++ b/docs/usage/export-tar.rst.inc @@ -21,7 +21,7 @@ borg export-tar +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--tar-filter`` | filter program to pipe data through | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -64,7 +64,7 @@ borg export-tar paths to extract; patterns are supported - optional arguments + options --tar-filter filter program to pipe data through --list output verbose list of items (files, dirs, ...) --tar-format FMT select tar format: BORG, PAX or GNU @@ -95,7 +95,7 @@ before writing it to FILE: - .tar.gz or .tgz: gzip - .tar.bz2 or .tbz: bzip2 - .tar.xz or .txz: xz -- .tar.zstd: zstd +- .tar.zstd or .tar.zst: zstd - .tar.lz4: lz4 Alternatively, a ``--tar-filter`` program may be explicitly specified. It should diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index 38bd6f78..bb0eb035 100644 --- a/docs/usage/extract.rst.inc +++ b/docs/usage/extract.rst.inc @@ -19,7 +19,7 @@ borg extract +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--list`` | output verbose list of items (files, dirs, ...) | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -70,7 +70,7 @@ borg extract paths to extract; patterns are supported - optional arguments + options --list output verbose list of items (files, dirs, ...) -n, --dry-run do not actually change any files --numeric-ids only obey numeric user and group identifiers diff --git a/docs/usage/import-tar.rst.inc b/docs/usage/import-tar.rst.inc index 3821b178..66afdb66 100644 --- a/docs/usage/import-tar.rst.inc +++ b/docs/usage/import-tar.rst.inc @@ -19,7 +19,7 @@ borg import-tar +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``TARFILE`` | input tar file. "-" to read from stdin instead. | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--tar-filter`` | filter program to pipe data through | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -64,7 +64,7 @@ borg import-tar input tar file. "-" to read from stdin instead. - optional arguments + options --tar-filter filter program to pipe data through -s, --stats print statistics for the created archive --list output verbose list of items (files, dirs, ...) @@ -96,7 +96,7 @@ based on its file extension and pipe the file through an appropriate filter: - .tar.gz or .tgz: gzip -d - .tar.bz2 or .tbz: bzip2 -d - .tar.xz or .txz: xz -d -- .tar.zstd: zstd -d +- .tar.zstd or .tar.zst: zstd -d - .tar.lz4: lz4 -d Alternatively, a --tar-filter program may be explicitly specified. It should diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index e5abdff6..f712f650 100644 --- a/docs/usage/info.rst.inc +++ b/docs/usage/info.rst.inc @@ -13,7 +13,7 @@ borg info .. class:: borg-options-table +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ | | ``--json`` | format output as JSON | +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -44,7 +44,7 @@ borg info - optional arguments + options --json format output as JSON diff --git a/docs/usage/key_change-location.rst.inc b/docs/usage/key_change-location.rst.inc index 4480e7d2..956c5cb2 100644 --- a/docs/usage/key_change-location.rst.inc +++ b/docs/usage/key_change-location.rst.inc @@ -17,7 +17,7 @@ borg key change-location +-------------------------------------------------------+------------------+----------------------------------------------------------------+ | | ``KEY_LOCATION`` | select key location | +-------------------------------------------------------+------------------+----------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+------------------+----------------------------------------------------------------+ | | ``--keep`` | keep the key also at the current location (default: remove it) | +-------------------------------------------------------+------------------+----------------------------------------------------------------+ @@ -40,7 +40,7 @@ borg key change-location select key location - optional arguments + options --keep keep the key also at the current location (default: remove it) diff --git a/docs/usage/key_export.rst.inc b/docs/usage/key_export.rst.inc index 536c520c..871355dc 100644 --- a/docs/usage/key_export.rst.inc +++ b/docs/usage/key_export.rst.inc @@ -17,7 +17,7 @@ borg key export +-------------------------------------------------------+---------------+------------------------------------------------------------------------+ | | ``PATH`` | where to store the backup | +-------------------------------------------------------+---------------+------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------+------------------------------------------------------------------------+ | | ``--paper`` | Create an export suitable for printing and later type-in | +-------------------------------------------------------+---------------+------------------------------------------------------------------------+ @@ -42,7 +42,7 @@ borg key export where to store the backup - optional arguments + options --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 diff --git a/docs/usage/key_import.rst.inc b/docs/usage/key_import.rst.inc index 54492033..cd778b1a 100644 --- a/docs/usage/key_import.rst.inc +++ b/docs/usage/key_import.rst.inc @@ -17,7 +17,7 @@ borg key import +-------------------------------------------------------+-------------+----------------------------------------------------------+ | | ``PATH`` | path to the backup ('-' to read from stdin) | +-------------------------------------------------------+-------------+----------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+-------------+----------------------------------------------------------+ | | ``--paper`` | interactively import from a backup done with ``--paper`` | +-------------------------------------------------------+-------------+----------------------------------------------------------+ @@ -40,7 +40,7 @@ borg key import path to the backup ('-' to read from stdin) - optional arguments + options --paper interactively import from a backup done with ``--paper`` diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index 995e2431..422d9520 100644 --- a/docs/usage/list.rst.inc +++ b/docs/usage/list.rst.inc @@ -19,7 +19,7 @@ borg list +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to list; patterns are supported | +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--short`` | only print file/directory names, nothing else | +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,7 +58,7 @@ borg list paths to list; patterns are supported - optional arguments + options --short only print file/directory names, nothing else --format FORMAT specify format for file listing (default: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}") --json-lines 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. diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index 7992170c..d8b4bfa6 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -19,7 +19,7 @@ borg mount +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). | +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ borg mount paths to extract; patterns are supported - optional arguments + options --consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden). -f, --foreground stay in foreground, do not daemonize -o Extra mount options diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index 434c755e..b56d3e9f 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -13,7 +13,7 @@ borg prune .. class:: borg-options-table +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------+ @@ -64,7 +64,7 @@ borg prune - optional arguments + options -n, --dry-run do not change repository --force force pruning of corrupted archives, use ``--force --force`` in case ``--force`` does not work. -s, --stats print statistics for the deleted archive diff --git a/docs/usage/rcompress.rst.inc b/docs/usage/rcompress.rst.inc index 97d19c24..ed048583 100644 --- a/docs/usage/rcompress.rst.inc +++ b/docs/usage/rcompress.rst.inc @@ -13,7 +13,7 @@ borg rcompress .. class:: borg-options-table +-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+ | | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details. | +-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -38,7 +38,7 @@ borg rcompress - optional arguments + options -C COMPRESSION, --compression COMPRESSION select compression algorithm, see the output of the "borg help compression" command for details. -s, --stats print statistics -c SECONDS, --checkpoint-interval SECONDS write checkpoint every SECONDS seconds (Default: 1800) diff --git a/docs/usage/rcreate.rst.inc b/docs/usage/rcreate.rst.inc index 3ca47213..65d8b0bd 100644 --- a/docs/usage/rcreate.rst.inc +++ b/docs/usage/rcreate.rst.inc @@ -13,7 +13,7 @@ borg rcreate .. class:: borg-options-table +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--other-repo SRC_REPOSITORY`` | reuse the key material from the other repository | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -44,7 +44,7 @@ borg rcreate - optional arguments + options --other-repo SRC_REPOSITORY reuse the key material from the other repository -e MODE, --encryption MODE select encryption key mode **(required)** --append-only create an append-only mode repository. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details. diff --git a/docs/usage/rdelete.rst.inc b/docs/usage/rdelete.rst.inc index 18d9bbc0..a0bb0ab2 100644 --- a/docs/usage/rdelete.rst.inc +++ b/docs/usage/rdelete.rst.inc @@ -13,7 +13,7 @@ borg rdelete .. class:: borg-options-table +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+ @@ -42,7 +42,7 @@ borg rdelete - optional arguments + options -n, --dry-run do not change repository --list output verbose list of archives --force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work. diff --git a/docs/usage/recreate.rst.inc b/docs/usage/recreate.rst.inc index 5842c957..e7c98816 100644 --- a/docs/usage/recreate.rst.inc +++ b/docs/usage/recreate.rst.inc @@ -17,7 +17,7 @@ borg recreate +-----------------------------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to recreate; patterns are supported | +-----------------------------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--list`` | output verbose list of items (files, dirs, ...) | +-----------------------------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -86,7 +86,7 @@ borg recreate paths to recreate; patterns are supported - optional arguments + options --list output verbose list of items (files, dirs, ...) --filter STATUSCHARS only display items with the given status characters (listed in borg create --help) -n, --dry-run do not change anything diff --git a/docs/usage/rinfo.rst.inc b/docs/usage/rinfo.rst.inc index fa57cdeb..3e125a94 100644 --- a/docs/usage/rinfo.rst.inc +++ b/docs/usage/rinfo.rst.inc @@ -13,7 +13,7 @@ borg rinfo .. class:: borg-options-table +-------------------------------------------------------+------------+-----------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+------------+-----------------------+ | | ``--json`` | format output as JSON | +-------------------------------------------------------+------------+-----------------------+ @@ -34,7 +34,7 @@ borg rinfo - optional arguments + options --json format output as JSON diff --git a/docs/usage/rlist.rst.inc b/docs/usage/rlist.rst.inc index d3b7afce..9ded180d 100644 --- a/docs/usage/rlist.rst.inc +++ b/docs/usage/rlist.rst.inc @@ -13,7 +13,7 @@ borg rlist .. class:: borg-options-table +-----------------------------------------------------------------------------+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). | +-----------------------------------------------------------------------------+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -50,7 +50,7 @@ borg rlist - optional arguments + options --consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden). --short only print the archive names, nothing else --format FORMAT specify format for archive listing (default: "{archive:<36} {time} [{id}]{NL}") diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc index 1c93098c..e40692b5 100644 --- a/docs/usage/serve.rst.inc +++ b/docs/usage/serve.rst.inc @@ -13,7 +13,7 @@ borg serve .. class:: borg-options-table +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--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. | +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -40,7 +40,7 @@ borg serve - optional arguments + options --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. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details. diff --git a/docs/usage/transfer.rst.inc b/docs/usage/transfer.rst.inc index 5a379910..346d0824 100644 --- a/docs/usage/transfer.rst.inc +++ b/docs/usage/transfer.rst.inc @@ -13,7 +13,7 @@ borg transfer .. class:: borg-options-table +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ - | **optional arguments** | + | **options** | +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository, just check | +-----------------------------------------------------------------------------+----------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -48,7 +48,7 @@ borg transfer - optional arguments + options -n, --dry-run do not change repository, just check --other-repo SRC_REPOSITORY transfer archives from the other repository --upgrader UPGRADER use the upgrader to convert transferred data (default: no conversion)