Merge pull request #6499 from ThomasWaldmann/usage-fixes

docs: usage: add benchmark cpu and key change-location

docs/usage/benchmark.rst

@@ -1 +1,3 @@
 .. include:: benchmark_crud.rst.inc
+
+.. include:: benchmark_cpu.rst.inc

docs/usage/benchmark_cpu.rst.inc

@@ -0,0 +1,44 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
+.. _borg_benchmark_cpu:
+
+borg benchmark cpu
+------------------
+.. code-block:: none
+
+    borg [common options] benchmark cpu [options]
+
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+
+    | .. 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
+
+
+
+    :ref:`common_options`
+        |
+
+Description
+~~~~~~~~~~~
+
+This command benchmarks misc. CPU bound borg operations.
+
+It creates input data in memory, runs the operation and then displays throughput.
+To reduce outside influence on the timings, please make sure to run this with:
+- an otherwise as idle as possible machine
+- enough free memory so there will be no slow down due to paging activity

docs/usage/key.rst

@@ -2,6 +2,8 @@
 
 .. include:: key_change-passphrase.rst.inc
 
+.. include:: key_change-location.rst.inc
+
 Examples
 ~~~~~~~~
 ::

docs/usage/key_change-location.rst.inc

@@ -0,0 +1,63 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
+.. _borg_key_change-location:
+
+borg key change-location
+------------------------
+.. code-block:: none
+
+    borg [common options] key change-location [options] [REPOSITORY] KEY_LOCATION
+
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+------------------+----------------------------------------------------------------+
+    | **positional arguments**                                                                                                                  |
+    +-------------------------------------------------------+------------------+----------------------------------------------------------------+
+    |                                                       | ``REPOSITORY``   |                                                                |
+    +-------------------------------------------------------+------------------+----------------------------------------------------------------+
+    |                                                       | ``KEY_LOCATION`` | select key location                                            |
+    +-------------------------------------------------------+------------------+----------------------------------------------------------------+
+    | **optional arguments**                                                                                                                    |
+    +-------------------------------------------------------+------------------+----------------------------------------------------------------+
+    |                                                       | ``--keep``       | keep the key also at the current location (default: remove it) |
+    +-------------------------------------------------------+------------------+----------------------------------------------------------------+
+    | .. 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
+
+    KEY_LOCATION
+        select key location
+
+
+    optional arguments
+        --keep     keep the key also at the current location (default: remove it)
+
+
+    :ref:`common_options`
+        |
+
+Description
+~~~~~~~~~~~
+
+Change the location of a borg key. The key can be stored at different locations:
+
+keyfile: locally, usually in the home directory
+repokey: inside the repo (in the repo config)
+
+Note: this command does NOT change the crypto algorithms, just the key location,
+      thus you must ONLY give the key location (keyfile or repokey).