From 9468e94412a11337dc23ab71062bd4d686bc30f9 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Fri, 12 Feb 2021 17:45:55 +0100 Subject: [PATCH] tape: add pmt and pmtx command to tape-backup.rst --- docs/Makefile | 2 +- docs/pmt/man1.rst | 52 +------------------------------------------- docs/pmt/options.rst | 51 +++++++++++++++++++++++++++++++++++++++++++ docs/tape-backup.rst | 19 ++++++++++++++++ 4 files changed, 72 insertions(+), 52 deletions(-) create mode 100644 docs/pmt/options.rst diff --git a/docs/Makefile b/docs/Makefile index 8d4f013a..c17934ff 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -100,7 +100,7 @@ pmtx.1: pmtx/man1.rst pmtx/description.rst pmtx/synopsis.rst pmt/synopsis.rst: ${COMPILEDIR}/pmt ${COMPILEDIR}/pmt printdoc > pmt/synopsis.rst -pmt.1: pmt/man1.rst pmt/description.rst pmt/synopsis.rst +pmt.1: pmt/man1.rst pmt/description.rst pmt/oprtions.rst pmt/synopsis.rst rst2man $< >$@ config/datastore/config.rst: ${COMPILEDIR}/docgen diff --git a/docs/pmt/man1.rst b/docs/pmt/man1.rst index 22ee590b..cce05452 100644 --- a/docs/pmt/man1.rst +++ b/docs/pmt/man1.rst @@ -22,57 +22,7 @@ Synopsis Common Options ============== -All command supports the following parameters to specify the tape device: - ---device Path to the Linux tape device - ---drive Use drive 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). - - -Device driver options can be specified as integer numbers (see -``/usr/include/linux/mtio.h``), or using symbolic names: - -:``buffer-writes``: Enable buffered writes - -:``async-writes``: Enable async writes - -:``read-ahead``: Use read-ahead for fixed block size - -:``debugging``: Enable debugging if compiled into the driver - -:``two-fm``: Write two file marks when closing the file - -:``fast-mteom``: Space directly to eod (and lose file number) - -:``auto-lock``: Automatically lock/unlock drive door - -:``def-writes``: Defaults are meant only for writes - -:``can-bsr``: Indicates that the drive can space backwards - -:``no-blklims``: Drive does not support read block limits - -:``can-partitions``: Drive can handle partitioned tapes - -:``scsi2locical``: Seek and tell use SCSI-2 logical block addresses - -:``sysv``: Enable the System V semantics - -:``nowait``: Do not wait for rewind, etc. to complete - -:``sili``: Enables setting the SILI bit in SCSI commands when reading - in variable block mode to enhance performance when reading blocks - shorter than the byte count +.. include:: options.rst Description diff --git a/docs/pmt/options.rst b/docs/pmt/options.rst new file mode 100644 index 00000000..adf2ff06 --- /dev/null +++ b/docs/pmt/options.rst @@ -0,0 +1,51 @@ +All command supports the following parameters to specify the tape device: + +--device Path to the Linux tape device + +--drive Use drive 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). + + +Device driver options can be specified as integer numbers (see +``/usr/include/linux/mtio.h``), or using symbolic names: + +:``buffer-writes``: Enable buffered writes + +:``async-writes``: Enable async writes + +:``read-ahead``: Use read-ahead for fixed block size + +:``debugging``: Enable debugging if compiled into the driver + +:``two-fm``: Write two file marks when closing the file + +:``fast-mteom``: Space directly to eod (and lose file number) + +:``auto-lock``: Automatically lock/unlock drive door + +:``def-writes``: Defaults are meant only for writes + +:``can-bsr``: Indicates that the drive can space backwards + +:``no-blklims``: Drive does not support read block limits + +:``can-partitions``: Drive can handle partitioned tapes + +:``scsi2locical``: Seek and tell use SCSI-2 logical block addresses + +:``sysv``: Enable the System V semantics + +:``nowait``: Do not wait for rewind, etc. to complete + +:``sili``: Enables setting the SILI bit in SCSI commands when reading + in variable block mode to enhance performance when reading blocks + shorter than the byte count diff --git a/docs/tape-backup.rst b/docs/tape-backup.rst index bb10a88a..b4a1a9d0 100644 --- a/docs/tape-backup.rst +++ b/docs/tape-backup.rst @@ -764,3 +764,22 @@ Options ^^^^^^^ .. include:: config/tape/config.rst + + +Command Syntax +-------------- + +``pmt`` +-------- + +.. include:: pmt/options.rst + +.... + +.. include:: pmt/synopsis.rst + + +``pmtx`` +-------- + +.. include:: pmtx/synopsis.rst