tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add manual page for proxmox-backup-manager

This commit is contained in:
Dietmar Maurer 2019-11-11 09:14:18 +01:00
parent 36d74cd633
commit 028bd254ac
7 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
debian/proxmox-backup-server.install vendored
View File

@ -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/lib/x86_64-linux-gnu/proxmox-backup/proxmox-backup-proxy
usr/share/man/man1/proxmox-backup-proxy.1 usr/share/man/man1/proxmox-backup-proxy.1
usr/sbin/proxmox-backup-manager 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/js/proxmox-backup-gui.js
usr/share/javascript/proxmox-backup/images/logo-128.png usr/share/javascript/proxmox-backup/images/logo-128.png
usr/share/javascript/proxmox-backup/images/proxmox_logo.png usr/share/javascript/proxmox-backup/images/proxmox_logo.png

10
docs/Makefile
View File

@ -8,11 +8,13 @@ endif
GENERATED_SYNOPSIS := \ GENERATED_SYNOPSIS := \
proxmox-backup-client/synopsis.rst \ proxmox-backup-client/synopsis.rst \
proxmox-backup-manager/synopsis.rst \
backup-protocol-api.rst backup-protocol-api.rst
MANUAL_PAGES := \ MANUAL_PAGES := \
proxmox-backup-proxy.1 \ proxmox-backup-proxy.1 \
proxmox-backup-client.1 proxmox-backup-client.1 \
proxmox-backup-manager.1
# Sphinx documentation setup # 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 proxmox-backup-client.1: proxmox-backup-client/man1.rst proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst
rst2man $< >$@ 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 proxmox-backup-proxy.1: proxmox-backup-proxy/man1.rst proxmox-backup-proxy/description.rst
rst2man $< >$@ rst2man $< >$@

5
docs/command-line-tools.rst
View File

@ -6,3 +6,8 @@ Command Line Tools
.. include:: proxmox-backup-client/description.rst .. include:: proxmox-backup-client/description.rst
``proxmox-backup-manager``
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: proxmox-backup-manager/description.rst

5
docs/command-syntax.rst
View File

@ -6,3 +6,8 @@ Command Syntax
.. include:: proxmox-backup-client/synopsis.rst .. include:: proxmox-backup-client/synopsis.rst
``proxmox-backup-manager``
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: proxmox-backup-manager/synopsis.rst

1
docs/conf.py
View File

@ -87,6 +87,7 @@ language = None
exclude_patterns = [ exclude_patterns = [
'_build', 'Thumbs.db', '.DS_Store', '_build', 'Thumbs.db', '.DS_Store',
'proxmox-backup-client/man1.rst', 'proxmox-backup-client/man1.rst',
'proxmox-backup-manager/man1.rst',
'proxmox-backup-proxy/man1.rst', 'proxmox-backup-proxy/man1.rst',
'epilog.rst', 'epilog.rst',
'pbs-copyright.rst', 'pbs-copyright.rst',

4
docs/proxmox-backup-manager/description.rst Normal file
View File

@ -0,0 +1,4 @@
This is just a test.
.. NOTE:: No further info.

28
docs/proxmox-backup-manager/man1.rst Normal file
View File

@ -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