From bebd4a7ca4552d68efae0aba1d3da6f75e6ac9a2 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Fri, 12 Feb 2021 18:00:01 +0100 Subject: [PATCH] tape: generate proxmox-tape.1 manual page --- docs/Makefile | 10 +++++++++- docs/proxmox-tape/description.rst | 4 ++++ docs/proxmox-tape/man1.rst | 28 ++++++++++++++++++++++++++++ docs/tape-backup.rst | 6 ++++++ 4 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 docs/proxmox-tape/description.rst create mode 100644 docs/proxmox-tape/man1.rst diff --git a/docs/Makefile b/docs/Makefile index c17934ff..b033fe98 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,6 +1,7 @@ include ../defines.mk GENERATED_SYNOPSIS := \ + proxmox-tape/synopsis.rst \ proxmox-backup-client/synopsis.rst \ proxmox-backup-client/catalog-shell-synopsis.rst \ proxmox-backup-manager/synopsis.rst \ @@ -22,6 +23,7 @@ MAN1_PAGES := \ pxar.1 \ pmtx.1 \ pmt.1 \ + proxmox-tape.1 \ proxmox-backup-proxy.1 \ proxmox-backup-client.1 \ proxmox-backup-manager.1 @@ -100,7 +102,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/oprtions.rst pmt/synopsis.rst +pmt.1: pmt/man1.rst pmt/description.rst pmt/options.rst pmt/synopsis.rst rst2man $< >$@ config/datastore/config.rst: ${COMPILEDIR}/docgen @@ -151,6 +153,12 @@ config/tape/config.rst: ${COMPILEDIR}/docgen tape.cfg.5: config/tape/man5.rst config/tape/config.rst config/tape/format.rst rst2man $< >$@ +proxmox-tape/synopsis.rst: ${COMPILEDIR}/proxmox-tape + ${COMPILEDIR}/proxmox-tape printdoc > proxmox-tape/synopsis.rst + +proxmox-tape.1: proxmox-tape/man1.rst proxmox-tape/description.rst proxmox-tape/synopsis.rst + rst2man $< >$@ + proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client ${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst diff --git a/docs/proxmox-tape/description.rst b/docs/proxmox-tape/description.rst new file mode 100644 index 00000000..34872663 --- /dev/null +++ b/docs/proxmox-tape/description.rst @@ -0,0 +1,4 @@ +This is just a test. + +.. NOTE:: No further info. + diff --git a/docs/proxmox-tape/man1.rst b/docs/proxmox-tape/man1.rst new file mode 100644 index 00000000..354ae6d7 --- /dev/null +++ b/docs/proxmox-tape/man1.rst @@ -0,0 +1,28 @@ +========================== +proxmox-tape +========================== + +.. include:: ../epilog.rst + +------------------------------------------------------------- +Proxmox Tape Backup Command Line Tool +------------------------------------------------------------- + +:Author: |AUTHOR| +:Version: Version |VERSION| +:Manual section: 1 + + +Synopsis +======== + +.. include:: synopsis.rst + +Description +=========== + +.. include:: description.rst + + +.. include:: ../pbs-copyright.rst + diff --git a/docs/tape-backup.rst b/docs/tape-backup.rst index b4a1a9d0..7ec11f5c 100644 --- a/docs/tape-backup.rst +++ b/docs/tape-backup.rst @@ -769,6 +769,12 @@ Options Command Syntax -------------- +``proxmox-tape`` +---------------- + +.. include:: proxmox-tape/synopsis.rst + + ``pmt`` --------