diff --git a/docs/changes.rst b/docs/changes.rst index 34b96d83b8..3a415feb71 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -87,6 +87,7 @@ Compatibility notes: - removed --noatime (default now, see also --atime) - removed --save-space option (does not change behaviour) - removed --bypass-lock option +- removed borg config command (only worked locally anyway) - using --list together with --progress is now disallowed (except with --log-json), #7219 - the --glob-archives option was renamed to --match-archives (the short option name -a is unchanged) and extended to support different pattern styles: diff --git a/docs/usage.rst b/docs/usage.rst index 7b6cbbb109..75d0b90de7 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -45,7 +45,6 @@ Usage usage/serve usage/version usage/compact - usage/config usage/lock usage/key diff --git a/docs/usage/config.rst b/docs/usage/config.rst deleted file mode 100644 index f06d752985..0000000000 --- a/docs/usage/config.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. include:: config.rst.inc - -.. note:: - - The repository & cache config files are some of the only directly manipulable - parts of a repository that aren't versioned or backed up, so be careful when - making changes\! - -Examples -~~~~~~~~ -:: - - # find cache directory - $ cd ~/.cache/borg/$(borg config id) - - # reserve some space - $ borg config additional_free_space 2G - - # make a repo append-only - $ borg config append_only 1 - - diff --git a/docs/usage/config.rst.inc b/docs/usage/config.rst.inc deleted file mode 100644 index 6236ba5b3d..0000000000 --- a/docs/usage/config.rst.inc +++ /dev/null @@ -1,75 +0,0 @@ -.. 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] [NAME] [VALUE] - -.. only:: html - - .. class:: borg-options-table - - +-------------------------------------------------------+----------------------+----------------------------------------+ - | **positional arguments** | - +-------------------------------------------------------+----------------------+----------------------------------------+ - | | ``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 | - +-------------------------------------------------------+----------------------+----------------------------------------+ - | | ``-l``, ``--list`` | list the configuration of the repo | - +-------------------------------------------------------+----------------------+----------------------------------------+ - | .. class:: borg-common-opt-ref | - | | - | :ref:`common_options` | - +-------------------------------------------------------+----------------------+----------------------------------------+ - - .. raw:: html - - - -.. only:: latex - - 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 - -l, --list list the configuration of the repo - - - :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 list the values -of the configuration file or the default values, use ``--list``. 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. \ No newline at end of file