mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-26 01:37:20 +00:00
Code Issues Releases Wiki Activity

Merge pull request #3421 from ThomasWaldmann/add-config-docs-master

Browse source 
add auto-generated docs for borg config
This commit is contained in:
TW 2017-12-09 22:23:57 +01:00 committed by GitHub
commit e838b48b60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 74 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/usage.rst
View file

@ -49,9 +49,9 @@ Usage
usage/recreate usage/recreate
usage/tar usage/tar
usage/serve usage/serve
usage/config
usage/lock usage/lock
usage/benchmark usage/benchmark
usage/config
usage/help usage/help
usage/debug usage/debug

73
docs/usage/config.rst.inc Normal file
View file

@ -0,0 +1,73 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_config:
borg config
-----------
.. code-block:: none
borg [common options] config [options] REPOSITORY NAME [VALUE]
.. only:: html
.. class:: borg-options-table
+-------------------------------------------------------+----------------------+----------------------------------------+
| **positional arguments** |
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``REPOSITORY`` | repository to configure |
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``NAME`` | name of config key |
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``VALUE`` | new value for key |
+-------------------------------------------------------+----------------------+----------------------------------------+
| **optional arguments** |
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``-c``, ``--cache`` | get and set values from the repo cache |
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``-d``, ``--delete`` | delete the key from the config file |
+-------------------------------------------------------+----------------------+----------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-------------------------------------------------------+----------------------+----------------------------------------+
.. raw:: html
<script type='text/javascript'>
$(document).ready(function () {
$('.borg-options-table colgroup').remove();
})
</script>
.. only:: latex
REPOSITORY
repository to configure
NAME
name of config key
VALUE
new value for key
optional arguments
-c, --cache get and set values from the repo cache
-d, --delete delete the key from the config file
:ref:`common_options`
|
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.
By default, borg config manipulates the repository config file. Using ``--cache``
edits the repository cache's config file instead.