ed873dc6a4
rst2man is only good for use in projects that don't use sphinx already, as there it can help to avoid bringing in the full sphinx dependencies and be easier to manage (as long as it stay small). But we already use sphinx, so there's no point in managing the manual pages in a separate, semi-related way that is quite restricted as we have no access to sphinx infrastructure like conf.py defined variables and helpers for things like the current version. Besides that, we're rather big, so the complexity of sphinx can shine, e.g., see the diffstat report from switching out rst2man for sphinx: 22 files changed, 74 insertions(+), 347 deletions(-) so 273 lines less in total is rather nice. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
43 lines
890 B
ReStructuredText
43 lines
890 B
ReStructuredText
==========================
|
|
pmtx
|
|
==========================
|
|
|
|
Synopsis
|
|
==========
|
|
|
|
.. include:: synopsis.rst
|
|
|
|
Common Options
|
|
==============
|
|
|
|
All command supports the following parameters to specify the changer device:
|
|
|
|
--device <path> Path to Linux generic SCSI device (e.g. '/dev/sg4')
|
|
|
|
--changer <name> Use changer from Proxmox Backup Server configuration.
|
|
|
|
|
|
Commands generating output supports the ``--output-format``
|
|
parameter. It accepts the following values:
|
|
|
|
:``text``: Text format (default). Human readable.
|
|
|
|
:``json``: JSON (single line).
|
|
|
|
:``json-pretty``: JSON (multiple lines, nicely formatted).
|
|
|
|
Description
|
|
============
|
|
|
|
.. include:: description.rst
|
|
|
|
ENVIRONMENT
|
|
===========
|
|
|
|
:CHANGER: If set, replaces the `--device` option
|
|
|
|
:PROXMOX_TAPE_DRIVE: If set, use the Proxmox Backup Server
|
|
configuration to find the associated changer device.
|
|
|
|
.. include:: ../pbs-copyright.rst
|