docs: fix usage docs and references for repo-* commands

docs/faq.rst

@@ -33,7 +33,7 @@ Can I back up to multiple, swapped backup targets?
 --------------------------------------------------
 
 It is possible to swap your backup disks if each backup medium is assigned its
-own repository by creating a new one with :ref:`borg_rcreate`.
+own repository by creating a new one with :ref:`borg_repo-create`.
 
 Can I copy or synchronize my repo to another location?
 ------------------------------------------------------

docs/internals/data-structures.rst

@@ -67,7 +67,7 @@ byte-strings of fixed length (256bit, 32 bytes), computed like this::
 
   key = id = id_hash(plaintext_data)  # plain = not encrypted, not compressed, not obfuscated
 
-The id_hash function depends on the :ref:`encryption mode <borg_rcreate>`.
+The id_hash function depends on the :ref:`encryption mode <borg_repo-create>`.
 
 As the id / key is used for deduplication, id_hash must be a cryptographically
 strong hash or MAC.

docs/internals/frontends.rst

@@ -255,7 +255,7 @@ Passphrase prompts should be handled differently. Use the environment variables
 and *BORG_NEW_PASSPHRASE* (see :ref:`env_vars` for reference) to pass passphrases to Borg, don't
 use the interactive passphrase prompts.
 
-When setting a new passphrase (:ref:`borg_rcreate`, :ref:`borg_key_change-passphrase`) normally
+When setting a new passphrase (:ref:`borg_repo-create`, :ref:`borg_key_change-passphrase`) normally
 Borg prompts whether it should display the passphrase. This can be suppressed by setting
 the environment variable *BORG_DISPLAY_PASSPHRASE* to *no*.
 
@@ -299,7 +299,7 @@ last_modified
 The *encryption* key, if present, contains:
 
 mode
-    Textual encryption mode name (same as :ref:`borg_rcreate` ``--encryption`` names)
+    Textual encryption mode name (same as :ref:`borg_repo-create` ``--encryption`` names)
 keyfile
     Path to the local key file used for access. Depending on *mode* this key may be absent.
 

docs/internals/security.rst

@@ -123,7 +123,7 @@ Supported: borg 2.0+
 Encryption with these modes is based on AEAD ciphers (authenticated encryption
 with associated data) and session keys.
 
-Depending on the chosen mode (see :ref:`borg_rcreate`) different AEAD ciphers are used:
+Depending on the chosen mode (see :ref:`borg_repo-create`) different AEAD ciphers are used:
 
 - AES-256-OCB - super fast, single-pass algorithm IF you have hw accelerated AES.
 - chacha20-poly1305 - very fast, purely software based AEAD cipher.

docs/quickstart.rst

@@ -335,7 +335,7 @@ You can choose the repository encryption mode at repository creation time::
     $ borg repo-create --encryption=MODE
 
 For a list of available encryption MODEs and their descriptions, please refer
-to :ref:`borg_rcreate`.
+to :ref:`borg_repo-create`.
 
 If you use encryption, all data is encrypted on the client before being written
 to the repository.

docs/usage.rst

@@ -36,12 +36,12 @@ Usage
 .. toctree::
    usage/general
 
-   usage/rcreate
-   usage/rspace
-   usage/rlist
-   usage/rinfo
-   usage/rcompress
-   usage/rdelete
+   usage/repo-create
+   usage/repo-space
+   usage/repo-list
+   usage/repo-info
+   usage/repo-compress
+   usage/repo-delete
    usage/serve
    usage/version
    usage/compact

docs/usage/general.rst

@@ -7,7 +7,7 @@ The following sections will describe each command in detail.
 
 Commands, options, parameters, paths and such are ``set in fixed-width``.
 Option values are `underlined`. Borg has few options accepting a fixed set
-of values (e.g. ``--encryption`` of :ref:`borg_rcreate`).
+of values (e.g. ``--encryption`` of :ref:`borg_repo-create`).
 
 .. container:: experimental
 

docs/usage/prune.rst.inc

@@ -150,4 +150,4 @@ backup archive in the same second).
 
 You can influence how the ``--list`` output is formatted by using the ``--short``
 option (less wide output) or by giving a custom format using ``--format`` (see
-the ``borg rlist`` description for more details about the format string).
+the ``borg repo-list`` description for more details about the format string).

docs/usage/rcompress.rst → docs/usage/repo-compress.rst

@@ -1,4 +1,4 @@
-.. include:: rcompress.rst.inc
+.. include:: repo-compress.rst.inc
 
 Examples
 ~~~~~~~~

docs/usage/rcompress.rst.inc → docs/usage/repo-compress.rst.inc

@@ -1,12 +1,12 @@
 .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-.. _borg_rcompress:
+.. _borg_repo-compress:
 
-borg rcompress
---------------
+borg repo-compress
+------------------
 .. code-block:: none
 
-    borg [common options] rcompress [options]
+    borg [common options] repo-compress [options]
 
 .. only:: html
 
@@ -60,10 +60,10 @@ type/level - if no compression gives a shorter output, that might be chosen.
 Please note that this command can not work in low (or zero) free disk space
 conditions.
 
-If the ``borg rcompress`` process receives a SIGINT signal (Ctrl-C), the repo
+If the ``borg repo-compress`` process receives a SIGINT signal (Ctrl-C), the repo
 will be committed and compacted and borg will terminate cleanly afterwards.
 
-Both ``--progress`` and ``--stats`` are recommended when ``borg rcompress``
+Both ``--progress`` and ``--stats`` are recommended when ``borg repo-compress``
 is used interactively.
 
-You do **not** need to run ``borg compact`` after ``borg rcompress``.
+You do **not** need to run ``borg compact`` after ``borg repo-compress``.

docs/usage/rcreate.rst → docs/usage/repo-create.rst

@@ -1,6 +1,6 @@
-.. _borg-rcreate:
+.. _borg_repo_create:
 
-.. include:: rcreate.rst.inc
+.. include:: repo-create.rst.inc
 
 Examples
 ~~~~~~~~

docs/usage/rcreate.rst.inc → docs/usage/repo-create.rst.inc

@@ -1,12 +1,12 @@
 .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-.. _borg_rcreate:
+.. _borg_repo-create:
 
-borg rcreate
-------------
+borg repo-create
+----------------
 .. code-block:: none
 
-    borg [common options] rcreate [options]
+    borg [common options] repo-create [options]
 
 .. only:: html
 
@@ -75,7 +75,7 @@ tips will come below):
 
 ::
 
-    borg rcreate --encryption repokey-aes-ocb
+    borg repo-create --encryption repokey-aes-ocb
 
 Borg will:
 
@@ -166,7 +166,7 @@ there is an emergency workaround, see ``BORG_WORKAROUNDS=authenticated_no_key``
 Creating a related repository
 +++++++++++++++++++++++++++++
 
-You can use ``borg rcreate --other-repo ORIG_REPO ...`` to create a related repository
+You can use ``borg repo-create --other-repo ORIG_REPO ...`` to create a related repository
 that uses the same secret key material as the given other/original repository.
 
 By default, only the ID key and chunker secret will be the same (these are important
@@ -181,7 +181,7 @@ Creating related repositories is useful e.g. if you want to use ``borg transfer`
 Creating a related repository for data migration from borg 1.2 or 1.4
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-You can use ``borg rcreate --other-repo ORIG_REPO --from-borg1 ...`` to create a related
+You can use ``borg repo-create --other-repo ORIG_REPO --from-borg1 ...`` to create a related
 repository that uses the same secret key material as the given other/original repository.
 
 Then use ``borg transfer --other-repo ORIG_REPO --from-borg1 ...`` to transfer the archives.

docs/usage/rdelete.rst → docs/usage/repo-delete.rst

@@ -1,4 +1,4 @@
-.. include:: rdelete.rst.inc
+.. include:: repo-delete.rst.inc
 
 Examples
 ~~~~~~~~

docs/usage/rdelete.rst.inc → docs/usage/repo-delete.rst.inc

@@ -1,12 +1,12 @@
 .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-.. _borg_rdelete:
+.. _borg_repo-delete:
 
-borg rdelete
-------------
+borg repo-delete
+----------------
 .. code-block:: none
 
-    borg [common options] rdelete [options]
+    borg [common options] repo-delete [options]
 
 .. only:: html
 

docs/usage/rinfo.rst → docs/usage/repo-info.rst

@@ -1,4 +1,4 @@
-.. include:: rinfo.rst.inc
+.. include:: repo-info.rst.inc
 
 Examples
 ~~~~~~~~

docs/usage/rinfo.rst.inc → docs/usage/repo-info.rst.inc

@@ -1,12 +1,12 @@
 .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-.. _borg_rinfo:
+.. _borg_repo-info:
 
-borg rinfo
-----------
+borg repo-info
+--------------
 .. code-block:: none
 
-    borg [common options] rinfo [options]
+    borg [common options] repo-info [options]
 
 .. only:: html
 

docs/usage/rlist.rst → docs/usage/repo-list.rst

@@ -1,4 +1,4 @@
-.. include:: rlist.rst.inc
+.. include:: repo-list.rst.inc
 
 Examples
 ~~~~~~~~

docs/usage/rlist.rst.inc → docs/usage/repo-list.rst.inc

@@ -1,12 +1,12 @@
 .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-.. _borg_rlist:
+.. _borg_repo-list:
 
-borg rlist
-----------
+borg repo-list
+--------------
 .. code-block:: none
 
-    borg [common options] rlist [options]
+    borg [common options] repo-list [options]
 
 .. only:: html
 
@@ -92,7 +92,7 @@ The ``--format`` option uses python's `format string syntax
 Examples:
 ::
 
-    $ borg rlist --format '{archive}{NL}'
+    $ borg repo-list --format '{archive}{NL}'
     ArchiveFoo
     ArchiveBar
     ...
@@ -100,7 +100,7 @@ Examples:
     # {VAR:NUMBER} - pad to NUMBER columns.
     # Strings are left-aligned, numbers are right-aligned.
     # Note: time columns except ``isomtime``, ``isoctime`` and ``isoatime`` cannot be padded.
-    $ borg rlist --format '{archive:36} {time} [{id}]{NL}' /path/to/repo
+    $ borg repo-list --format '{archive:36} {time} [{id}]{NL}' /path/to/repo
     ArchiveFoo                           Thu, 2021-12-09 10:22:28 [0b8e9...3b274]
     ...
 

docs/usage/repo-space.rst

@@ -0,0 +1 @@
+.. include:: repo-space.rst.inc

docs/usage/rspace.rst.inc → docs/usage/repo-space.rst.inc

@@ -1,12 +1,12 @@
 .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-.. _borg_rspace:
+.. _borg_repo-space:
 
-borg rspace
------------
+borg repo-space
+---------------
 .. code-block:: none
 
-    borg [common options] rspace [options]
+    borg [common options] repo-space [options]
 
 .. only:: html
 
@@ -62,19 +62,19 @@ situation again at a later time.
 Examples::
 
     # Create a new repository:
-    $ borg rcreate ...
+    $ borg repo-create ...
     # Reserve approx. 1GB of space for emergencies:
-    $ borg rspace --reserve 1G
+    $ borg repo-space --reserve 1G
 
     # Check amount of reserved space in the repository:
-    $ borg rspace
+    $ borg repo-space
 
     # EMERGENCY! Free all reserved space to get things back to normal:
-    $ borg rspace --free
+    $ borg repo-space --free
     $ borg prune ...
     $ borg delete ...
     $ borg compact -v  # only this actually frees space of deleted archives
-    $ borg rspace --reserve 1G  # reserve space again for next time
+    $ borg repo-space --reserve 1G  # reserve space again for next time
 
 
 Reserved space is always rounded up to use full reservation blocks of 64MiB.

docs/usage/rspace.rst

@@ -1 +0,0 @@
-.. include:: rspace.rst.inc

docs/usage/transfer.rst.inc

@@ -112,7 +112,7 @@ Transfer borg2 archives into a related other borg2 repository::
 
     # create a related DST_REPO (reusing key material from SRC_REPO), so that
     # chunking and chunk id generation will work in the same way as before.
-    borg --repo=DST_REPO rcreate --encryption=DST_ENC --other-repo=SRC_REPO
+    borg --repo=DST_REPO repo-create --encryption=DST_ENC --other-repo=SRC_REPO
 
     # transfer archives from SRC_REPO to DST_REPO
     borg --repo=DST_REPO transfer --other-repo=SRC_REPO --dry-run  # check what it would do
@@ -126,7 +126,7 @@ Data migration / upgrade from borg 1.x
 To migrate your borg 1.x archives into a related, new borg2 repository, usage is quite similar
 to the above, but you need the ``--from-borg1`` option::
 
-    borg --repo=DST_REPO rcreate --encryption=DST_ENC --other-repo=SRC_REPO --from-borg1
+    borg --repo=DST_REPO repocreate --encryption=DST_ENC --other-repo=SRC_REPO --from-borg1
 
     # to continue using lz4 compression as you did in SRC_REPO:
     borg --repo=DST_REPO transfer --other-repo=SRC_REPO --from-borg1 \