tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: split out output-format.rst

Browse Source
This commit is contained in:
Dietmar Maurer 2021-02-13 08:54:23 +01:00
parent 80bf9ae99b
commit f458e97fda
3 changed files with 31 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/backup-client.rst
View File

@ -60,30 +60,7 @@ Environment Variables
Output Format
-------------
Most commands support the ``--output-format`` parameter. It accepts
the following values:
:``text``: Text format (default). Structured data is rendered as a table.
:``json``: JSON (single line).
:``json-pretty``: JSON (multiple lines, nicely formatted).
Please use the following environment variables to modify output behavior:
``PROXMOX_OUTPUT_FORMAT``
Defines the default output format.
``PROXMOX_OUTPUT_NO_BORDER``
If set (to any value), do not render table borders.
``PROXMOX_OUTPUT_NO_HEADER``
If set (to any value), do not render table headers.
.. note:: The ``text`` format is designed to be human readable, and
not meant to be parsed by automation tools. Please use the ``json``
format if you need to process the output.
.. include:: output-format.rst
.. _client_creating_backups:
@ -748,5 +725,3 @@ benchmark using the ``benchmark`` subcommand of ``proxmox-backup-client``:
You can also pass the ``--output-format`` parameter to output stats in ``json``,
rather than the default table format.

24
docs/output-format.rst Normal file
View File

@ -0,0 +1,24 @@
Most commands producing output supports the ``--output-format``
parameter. It accepts the following values:
:``text``: Text format (default). Structured data is rendered as a table.
:``json``: JSON (single line).
:``json-pretty``: JSON (multiple lines, nicely formatted).
Also, the following environment variables can modify output behavior:
``PROXMOX_OUTPUT_FORMAT``
Defines the default output format.
``PROXMOX_OUTPUT_NO_BORDER``
If set (to any value), do not render table borders.
``PROXMOX_OUTPUT_NO_HEADER``
If set (to any value), do not render table headers.
.. note:: The ``text`` format is designed to be human readable, and
not meant to be parsed by automation tools. Please use the ``json``
format if you need to process the output.

6
docs/proxmox-backup-client/man1.rst
View File

@ -31,6 +31,12 @@ Those command are available when you start an intercative restore shell:
.. include:: catalog-shell-synopsis.rst
Common Options
==============
.. include:: ../output-format.rst
Description
============