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

build_usage

This commit is contained in:
Thomas Waldmann 2018-06-11 01:55:37 +02:00
parent 795387c3c3
commit 7b6e5009b3
2 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/usage/config.rst.inc
View File

@ -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` |
@ -53,6 +55,7 @@ borg config
optional arguments
-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.

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

@ -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.