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

add pxar.1 manual page

Browse Source
This commit is contained in:
Dietmar Maurer 2019-11-17 17:12:41 +01:00
parent 85e139b70f
commit e4a5ab8ddb
6 changed files with 46 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,3 +1,4 @@
usr/bin/proxmox-backup-client
usr/share/man/man1/proxmox-backup-client.1
usr/bin/pxar
usr/share/man/man1/pxar.1

8
docs/Makefile
View File

@ -12,6 +12,7 @@ GENERATED_SYNOPSIS := \
backup-protocol-api.rst
MANUAL_PAGES := \
pxar.1 \
proxmox-backup-proxy.1 \
proxmox-backup-client.1 \
proxmox-backup-manager.1
@ -38,10 +39,15 @@ backup-protocol-api.rst: ${COMPILEDIR}/dump-backup-api
# Build manual pages using rst2man
pxar/synopsis.rst: ${COMPILEDIR}/pxar
${COMPILEDIR}/pxar printdoc > pxar/synopsis.rst
pxar.1: pxar/man1.rst pxar/description.rst pxar/synopsis.rst
rst2man $< >$@
proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
${COMPILEDIR}/proxmox-backup-client printdoc > 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 $< >$@

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

@ -11,3 +11,8 @@ Command Line Tools
.. include:: proxmox-backup-manager/description.rst
``pxar``
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. include:: pxar/description.rst

1
docs/conf.py
View File

@ -89,6 +89,7 @@ exclude_patterns = [
'proxmox-backup-client/man1.rst',
'proxmox-backup-manager/man1.rst',
'proxmox-backup-proxy/man1.rst',
'pxar/man1.rst',
'epilog.rst',
'pbs-copyright.rst',
'sysadmin.rst',

4
docs/pxar/description.rst Normal file
View File

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

28
docs/pxar/man1.rst Normal file
View File

@ -0,0 +1,28 @@
==========================
pxar
==========================
.. include:: ../epilog.rst
-------------------------------------------------------------
Proxmox File Archive Command Line Tool
-------------------------------------------------------------
:Author: |AUTHOR|
:Version: Version |VERSION|
:Manual section: 1
Synopsis
==========
.. include:: synopsis.rst
Description
============
.. include:: description.rst
.. include:: ../pbs-copyright.rst