doc: improve pmt/pmtx manual pages

This commit is contained in:
Dietmar Maurer 2021-02-06 16:50:56 +01:00
parent 3231c35fb8
commit fbf8779388
5 changed files with 41 additions and 9 deletions

View File

@ -1,5 +1,2 @@
Description
^^^^^^^^^^^
The ``pmt`` command controls Linux tape devices.

View File

@ -29,8 +29,8 @@ All command supports the following parameters to specify the tape device:
--drive <name> Use drive from Proxmox Backup Server configuration.
Commands generation output supports the ``--output-format`` parameter. It accepts
the following values:
Commands generating output supports the ``--output-format``
parameter. It accepts the following values:
:``text``: Text format (default). Human readable.
@ -45,4 +45,12 @@ Description
.. include:: description.rst
ENVIRONMENT
===========
:TAPE: If set, replaces the `--device` option.
:PROXMOX_TAPE_DRIVE: If set, replaces the `--drive` option.
.. include:: ../pbs-copyright.rst

View File

@ -1,6 +1,3 @@
Description
^^^^^^^^^^^
The ``pmtx`` command controls SCSI media changer devices (tape
autoloader).

View File

@ -18,11 +18,40 @@ 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
.. include:: ../pbs-copyright.rst
ENVIRONMENT
===========
:CHANGER: If set, replaces the `--device` option
:PROXMOX_TAPE_DRIVE: If set, use the Proxmox Backup Server
configuration to find the associcated changer device.
.. include:: ../pbs-copyright.rst

View File

@ -436,6 +436,7 @@ fn main() -> Result<(), Error> {
let cmd_def = CliCommandMap::new()
.usage_skip_options(&["device", "changer", "output-format"])
.insert(
"inquiry",
CliCommand::new(&API_METHOD_INQUIRY)