1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-23 08:16:54 +00:00
borg/docs/usage.rst
Milkey Mouse 5b47cf6fa5
Add borg config command (fixes #3304)
This command works similarly to "git config" - it parses repo and
cache configs to get, set, and delete values. It only works on local
repos so a malicious client can't e.g. override their storage quota
or reset the append_only flag.

Add tests for borg config

Add documentation for borg config

Change manual config edits -> borg config

There were a couple places in the documentation where it was advised
to edit the repository or cache config file, a process that is stream-
lined by borg config.
2017-11-23 14:51:54 -08:00

58 lines
1.4 KiB
ReStructuredText

.. include:: global.rst.inc
.. highlight:: none
.. _detailed_usage:
Usage
=====
.. raw:: html
Redirecting...
<script type="text/javascript">
// Fixes old links which were just anchors
var hash = window.location.hash.substring(1);
// usage.html is empty, no content. Purely serves to implement a "correct" toctree
// due to rST/Sphinx limitations. Refer to https://github.com/sphinx-doc/sphinx/pull/3622
// Redirect to general docs
if(hash == "") {
window.location.pathname = window.location.pathname.replace("usage.html", "usage/general.html");
}
// Fixup anchored links from when usage.html contained all the commands
else if(hash.startsWith("borg-key") || hash == "borg-change-passphrase") {
window.location.hash = "";
window.location.pathname = window.location.pathname.replace("usage.html", "usage/key.html");
}
else if(hash.startsWith("borg-")) {
window.location.hash = "";
window.location.pathname = window.location.pathname.replace("usage.html", "usage/") + hash.substr(5) + ".html";
}
</script>
.. toctree::
usage/general
usage/init
usage/create
usage/extract
usage/check
usage/rename
usage/list
usage/diff
usage/delete
usage/prune
usage/info
usage/mount
usage/key
usage/upgrade
usage/recreate
usage/tar
usage/serve
usage/lock
usage/benchmark
usage/config
usage/help
usage/debug
usage/notes