diff options
| -rw-r--r-- | docs/usage/config.rst.inc | 20 | ||||
| -rw-r--r-- | docs/usage/delete.rst.inc | 3 |
2 files changed, 16 insertions, 7 deletions
diff --git a/docs/usage/config.rst.inc b/docs/usage/config.rst.inc index 2a64c1276..1a204d8a0 100644 --- a/docs/usage/config.rst.inc +++ b/docs/usage/config.rst.inc @@ -6,7 +6,7 @@ borg config ----------- .. code-block:: none - borg [common options] config [options] REPOSITORY NAME [VALUE] + borg [common options] config [options] REPOSITORY [NAME] [VALUE] .. only:: html @@ -27,6 +27,8 @@ borg config +-------------------------------------------------------+----------------------+----------------------------------------+ | | ``-d``, ``--delete`` | delete the key from the config file | +-------------------------------------------------------+----------------------+----------------------------------------+ + | | ``-l``, ``--list`` | list the configuration of the repo | + +-------------------------------------------------------+----------------------+----------------------------------------+ | .. class:: borg-common-opt-ref | | | | :ref:`common_options` | @@ -51,8 +53,9 @@ borg config optional arguments - -c, --cache get and set values from the repo cache - -d, --delete delete the key from the config file + -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 :ref:`common_options` @@ -64,10 +67,13 @@ Description This command gets and sets options in a local repository or cache config file. For security reasons, this command only works on local repositories. -To delete a config value entirely, use ``--delete``. To get an existing key, pass -only the key name. To set a key, pass both the key name and the new value. Keys -can be specified in the format "section.name" or simply "name"; the section will -default to "repository" and "cache" for the repo and cache configs, respectively. +To delete a config value entirely, use ``--delete``. To list the values +of the configuration file or the default values, use ``--list``. To get and existing +key, pass only the key name. To set a key, pass both the key name and +the new value. Keys can be specified in the format "section.name" or +simply "name"; the section will default to "repository" and "cache" for +the repo and cache configs, respectively. + By default, borg config manipulates the repository config file. Using ``--cache`` edits the repository cache's config file instead.
\ No newline at end of file diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index 5951c71a2..4cd934edc 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -21,6 +21,8 @@ borg delete +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | **optional arguments** | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``-n``, ``--dry-run`` | do not change repository | + +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-s``, ``--stats`` | print statistics for the deleted archive | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--cache-only`` | delete only the local cache for the given repository | @@ -63,6 +65,7 @@ borg delete optional arguments + -n, --dry-run do not change repository -s, --stats print statistics for the deleted archive --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. |