install pmtx binary

This commit is contained in:
Dietmar Maurer
2021-01-27 11:31:26 +01:00
parent 887f1cb90c
commit c972704477
8 changed files with 161 additions and 2 deletions

View File

@ -5,11 +5,13 @@ GENERATED_SYNOPSIS := \
proxmox-backup-client/catalog-shell-synopsis.rst \
proxmox-backup-manager/synopsis.rst \
pxar/synopsis.rst \
pmtx/synopsis.rst \
backup-protocol-api.rst \
reader-protocol-api.rst
MANUAL_PAGES := \
pxar.1 \
pmtx.1 \
proxmox-backup-proxy.1 \
proxmox-backup-client.1 \
proxmox-backup-manager.1
@ -67,6 +69,14 @@ pxar/synopsis.rst: ${COMPILEDIR}/pxar
pxar.1: pxar/man1.rst pxar/description.rst pxar/synopsis.rst
rst2man $< >$@
pmtx/synopsis.rst: ${COMPILEDIR}/pmtx
${COMPILEDIR}/pmtx printdoc > pmtx/synopsis.rst
pmtx.1: pmtx/man1.rst pmtx/description.rst pmtx/synopsis.rst
rst2man $< >$@
proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst

View File

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

122
docs/pmtx/synopsis.rst Normal file
View File

@ -0,0 +1,122 @@
``pmtx help [{<command>}] [OPTIONS]``
Get help about specified command (or sub-command).
:``<command> <array>``: Command. This may be a list in order to spefify nested sub-commands.
Optional parameters:
:``--verbose <boolean>``: Verbose help.
----
``pmtx inquiry [OPTIONS]``
Inquiry
Optional parameters:
:``--changer <string>``: Tape Changer Identifier.
:``--device <string>``: Path to Linux generic SCSI device (e.g. '/dev/sg4')
:``--output-format <string>``: Output format.
----
``pmtx inventory [OPTIONS]``
Inventory
Optional parameters:
:``--changer <string>``: Tape Changer Identifier.
:``--device <string>``: Path to Linux generic SCSI device (e.g. '/dev/sg4')
----
``pmtx load <slot> [OPTIONS]``
Load
:``<slot> <integer>``: Storage slot number (source).
Optional parameters:
:``--changer <string>``: Tape Changer Identifier.
:``--device <string>``: Path to Linux generic SCSI device (e.g. '/dev/sg4')
:``--drivenum <integer>``: Target drive number (defaults to Drive 0)
----
``pmtx status [OPTIONS]``
Changer Status
Optional parameters:
:``--changer <string>``: Tape Changer Identifier.
:``--device <string>``: Path to Linux generic SCSI device (e.g. '/dev/sg4')
:``--output-format <string>``: Output format.
----
``pmtx transfer <from> <to> [OPTIONS]``
Transfer
:``<from> <integer>``: Source storage slot number.
:``<to> <integer>``: Target storage slot number.
Optional parameters:
:``--changer <string>``: Tape Changer Identifier.
:``--device <string>``: Path to Linux generic SCSI device (e.g. '/dev/sg4')
----
``pmtx unload [OPTIONS]``
Unload
Optional parameters:
:``--changer <string>``: Tape Changer Identifier.
:``--device <string>``: Path to Linux generic SCSI device (e.g. '/dev/sg4')
:``--drivenum <integer>``: Target drive number (defaults to Drive 0)
:``--slot <integer>``: Storage slot number (target). If omitted, defaults to the slot that the drive
was loaded from.