mirror of
https://github.com/borgbackup/borg.git
synced 2026-07-10 02:31:22 -04:00
d5cd72b179
The multi-key feature (#9743) added the "borg key add", "borg key list" and "borg key remove" subcommands but never wired up their docs: - scripts/make.py: map key_add/key_list/key_remove to the "key" usage group, so build_man can locate their examples (it previously aborted with FileNotFoundError: docs/usage/key_add.rst). - docs/usage/key.rst: include the three new generated snippets so they show up on the HTML key page. - regenerate the affected docs: new key_{add,list,remove}.rst.inc usage snippets, new borg-key-{add,list,remove}.1 man pages, and borg-key.1 (SYNOPSIS + SEE ALSO now reference the new subcommands). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
60 lines
No EOL
3 KiB
PHP
60 lines
No EOL
3 KiB
PHP
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
.. _borg_key_remove:
|
|
|
|
borg key remove
|
|
---------------
|
|
.. code-block:: none
|
|
|
|
borg [common options] key remove [options]
|
|
|
|
.. only:: html
|
|
|
|
.. class:: borg-options-table
|
|
|
|
+-------------------------------------------------------+-------------------+------------------------------------------------------------+
|
|
| **options** |
|
|
+-------------------------------------------------------+-------------------+------------------------------------------------------------+
|
|
| | ``--label LABEL`` | remove the borg key with this label |
|
|
+-------------------------------------------------------+-------------------+------------------------------------------------------------+
|
|
| | ``--key ID`` | remove the borg key with this id (or unique id prefix) |
|
|
+-------------------------------------------------------+-------------------+------------------------------------------------------------+
|
|
| | ``--passphrase`` | remove the borg key that was used to unlock the repository |
|
|
+-------------------------------------------------------+-------------------+------------------------------------------------------------+
|
|
| .. 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
|
|
|
|
|
|
|
|
options
|
|
--label LABEL remove the borg key with this label
|
|
--key ID remove the borg key with this id (or unique id prefix)
|
|
--passphrase remove the borg key that was used to unlock the repository
|
|
|
|
|
|
:ref:`common_options`
|
|
|
|
|
|
|
Description
|
|
~~~~~~~~~~~
|
|
|
|
Remove a borg key from the repository.
|
|
|
|
The borg key to remove is selected by exactly one of: ``--label`` (its label),
|
|
``--key`` (its key id or a unique prefix, see ``borg key list``), or
|
|
``--passphrase`` (remove the borg key that was used to unlock the repository now).
|
|
|
|
The ``admin`` borg key is protected and cannot be removed, and the last remaining
|
|
borg key of a repository cannot be removed either. |