borgbackup/docs/usage/benchmark_cpu.rst.inc
Rohan salunke 179b5cdd92
Regenerate usage docs from current CLI help source
This also fixes #8146 (experimental markings in docs).
2026-02-22 11:50:58 +01:00

53 lines
No EOL
1.8 KiB
HTML

.. 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
+-------------------------------------------------------+------------+-----------------------+
| **options** |
+-------------------------------------------------------+------------+-----------------------+
| | ``--json`` | format output as JSON |
+-------------------------------------------------------+------------+-----------------------+
| .. 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
--json format output as JSON
:ref:`common_options`
|
Description
~~~~~~~~~~~
This command benchmarks miscellaneous 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