start generating manual pages

Depend on docutils-doc
This commit is contained in:
Dietmar Maurer
2019-02-24 09:51:10 +01:00
parent 793b0f4d77
commit bb5c770758
7 changed files with 80 additions and 1 deletions

23
docs/Makefile Normal file
View File

@ -0,0 +1,23 @@
include ../defines.mk
ifeq ($(BUILD_MODE), release)
COMPILEDIR := ../target/release
else
COMPILEDIR := ../target/debug
endif
##UNITS:= proxmox-backup-client
proxmox-backup-client.1: proxmox-backup-client/man1.rst ${COMPILEDIR}/proxmox-backup-client
${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst
rst2man $< >$@
all: proxmox-backup-client.1
clean:
rm -f *.1 */synopsis.rst
install: proxmox-backup-client.1
install -dm755 $(DESTDIR)$(MAN1DIR)
install -m755 proxmox-backup-client.1 $(DESTDIR)$(MAN1DIR)/

18
docs/pbs-copyright.rst Normal file
View File

@ -0,0 +1,18 @@
Copyright and Disclaimer
========================
Copyright (C) 2007-2019 Proxmox Server Solutions GmbH
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public
License along with this program. If not, see
http://www.gnu.org/licenses/

View File

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

View File

@ -0,0 +1,28 @@
==========================
proxmox-backup-client
==========================
.. |VERSION| replace:: 1.0
-------------------------------------------------------------
Command line toot for Backup and Restore
-------------------------------------------------------------
:Author: Proxmox Support Team <support@proxmox.com>
:Version: Version |VERSION|
:Manual section: 1
Synopsis
==========
.. include:: synopsis.rst
Description
============
.. include:: description.rst
.. include:: ../pbs-copyright.rst