From 028bd254acd24c52dbe3d8d62abf9d9d01287f73 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Mon, 11 Nov 2019 09:14:18 +0100 Subject: [PATCH] add manual page for proxmox-backup-manager --- debian/proxmox-backup-server.install | 1 + docs/Makefile | 10 +++++++- docs/command-line-tools.rst | 5 ++++ docs/command-syntax.rst | 5 ++++ docs/conf.py | 1 + docs/proxmox-backup-manager/description.rst | 4 +++ docs/proxmox-backup-manager/man1.rst | 28 +++++++++++++++++++++ 7 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 docs/proxmox-backup-manager/description.rst create mode 100644 docs/proxmox-backup-manager/man1.rst diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index 3c21ba5c..d8283e7b 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -4,6 +4,7 @@ usr/lib/x86_64-linux-gnu/proxmox-backup/proxmox-backup-api usr/lib/x86_64-linux-gnu/proxmox-backup/proxmox-backup-proxy usr/share/man/man1/proxmox-backup-proxy.1 usr/sbin/proxmox-backup-manager +usr/share/man/man1/proxmox-backup-manager.1 usr/share/javascript/proxmox-backup/js/proxmox-backup-gui.js usr/share/javascript/proxmox-backup/images/logo-128.png usr/share/javascript/proxmox-backup/images/proxmox_logo.png \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile index 327cedad..6039529a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -8,11 +8,13 @@ endif GENERATED_SYNOPSIS := \ proxmox-backup-client/synopsis.rst \ + proxmox-backup-manager/synopsis.rst \ backup-protocol-api.rst MANUAL_PAGES := \ proxmox-backup-proxy.1 \ - proxmox-backup-client.1 + proxmox-backup-client.1 \ + proxmox-backup-manager.1 # Sphinx documentation setup @@ -43,6 +45,12 @@ proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client proxmox-backup-client.1: proxmox-backup-client/man1.rst proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst rst2man $< >$@ +proxmox-backup-manager/synopsis.rst: ${COMPILEDIR}/proxmox-backup-manager + ${COMPILEDIR}/proxmox-backup-manager printdoc > proxmox-backup-manager/synopsis.rst + +proxmox-backup-manager.1: proxmox-backup-manager/man1.rst proxmox-backup-manager/description.rst proxmox-backup-manager/synopsis.rst + rst2man $< >$@ + proxmox-backup-proxy.1: proxmox-backup-proxy/man1.rst proxmox-backup-proxy/description.rst rst2man $< >$@ diff --git a/docs/command-line-tools.rst b/docs/command-line-tools.rst index 7757d00c..9ab5d12d 100644 --- a/docs/command-line-tools.rst +++ b/docs/command-line-tools.rst @@ -6,3 +6,8 @@ Command Line Tools .. include:: proxmox-backup-client/description.rst +``proxmox-backup-manager`` +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: proxmox-backup-manager/description.rst + diff --git a/docs/command-syntax.rst b/docs/command-syntax.rst index a7eb7b5d..35262c87 100644 --- a/docs/command-syntax.rst +++ b/docs/command-syntax.rst @@ -6,3 +6,8 @@ Command Syntax .. include:: proxmox-backup-client/synopsis.rst +``proxmox-backup-manager`` +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: proxmox-backup-manager/synopsis.rst + diff --git a/docs/conf.py b/docs/conf.py index 11f1f00d..026e99fc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -87,6 +87,7 @@ language = None exclude_patterns = [ '_build', 'Thumbs.db', '.DS_Store', 'proxmox-backup-client/man1.rst', + 'proxmox-backup-manager/man1.rst', 'proxmox-backup-proxy/man1.rst', 'epilog.rst', 'pbs-copyright.rst', diff --git a/docs/proxmox-backup-manager/description.rst b/docs/proxmox-backup-manager/description.rst new file mode 100644 index 00000000..34872663 --- /dev/null +++ b/docs/proxmox-backup-manager/description.rst @@ -0,0 +1,4 @@ +This is just a test. + +.. NOTE:: No further info. + diff --git a/docs/proxmox-backup-manager/man1.rst b/docs/proxmox-backup-manager/man1.rst new file mode 100644 index 00000000..fe96e12f --- /dev/null +++ b/docs/proxmox-backup-manager/man1.rst @@ -0,0 +1,28 @@ +========================== +proxmox-backup-manager +========================== + +.. include:: ../epilog.rst + +------------------------------------------------------------- +Command line tool to manage and configure the backup server. +------------------------------------------------------------- + +:Author: |AUTHOR| +:Version: Version |VERSION| +:Manual section: 1 + + +Synopsis +======== + +.. include:: synopsis.rst + +Description +=========== + +.. include:: description.rst + + +.. include:: ../pbs-copyright.rst +