docs: add manual page for proxmox-backup-proxy
This commit is contained in:
parent
b246b2a635
commit
b933ed7f80
@ -10,6 +10,7 @@ GENERATED_SYNOPSIS := \
|
||||
proxmox-backup-client/synopsis.rst
|
||||
|
||||
MANUAL_PAGES := \
|
||||
proxmox-backup-proxy.1 \
|
||||
proxmox-backup-client.1
|
||||
|
||||
|
||||
@ -37,6 +38,9 @@ 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-proxy.1: proxmox-backup-proxy/man1.rst proxmox-backup-proxy/description.rst
|
||||
rst2man $< >$@
|
||||
|
||||
.PHONY: html
|
||||
html: ${GENERATED_SYNOPSIS}
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@ -61,4 +65,4 @@ clean:
|
||||
|
||||
install: ${MANUAL_PAGES}
|
||||
install -dm755 $(DESTDIR)$(MAN1DIR)
|
||||
install -m755 proxmox-backup-client.1 $(DESTDIR)$(MAN1DIR)/
|
||||
for i in ${MANUAL_PAGES}; do install -m755 $$i $(DESTDIR)$(MAN1DIR)/ ; done
|
||||
|
@ -5,4 +5,6 @@ The administration guide.
|
||||
|
||||
|
||||
.. include:: command-line-tools.rst
|
||||
|
||||
|
||||
.. include:: services.rst
|
||||
|
||||
|
@ -87,6 +87,7 @@ language = None
|
||||
exclude_patterns = [
|
||||
'_build', 'Thumbs.db', '.DS_Store',
|
||||
'proxmox-backup-client/man1.rst',
|
||||
'proxmox-backup-proxy/man1.rst',
|
||||
'epilog.rst',
|
||||
'pbs-copyright.rst',
|
||||
]
|
||||
|
4
docs/proxmox-backup-proxy/description.rst
Normal file
4
docs/proxmox-backup-proxy/description.rst
Normal file
@ -0,0 +1,4 @@
|
||||
This is just a test.
|
||||
|
||||
.. NOTE:: No further info.
|
||||
|
41
docs/proxmox-backup-proxy/man1.rst
Normal file
41
docs/proxmox-backup-proxy/man1.rst
Normal file
@ -0,0 +1,41 @@
|
||||
==========================
|
||||
proxmox-backup-proxy
|
||||
==========================
|
||||
|
||||
.. include:: ../epilog.rst
|
||||
|
||||
-------------------------------------------------------------
|
||||
Proxmox Backup Public API Server
|
||||
-------------------------------------------------------------
|
||||
|
||||
:Author: |AUTHOR|
|
||||
:Version: Version |VERSION|
|
||||
:Manual section: 1
|
||||
|
||||
|
||||
Synopsis
|
||||
==========
|
||||
|
||||
This daemon is normally started and managed as ``systemd`` service::
|
||||
|
||||
systemctl start proxmox-backup-proxy
|
||||
|
||||
systemctl stop proxmox-backup-proxy
|
||||
|
||||
systemctl status proxmox-backup-proxy
|
||||
|
||||
For debugging, you can start the daemon in forground using::
|
||||
|
||||
proxmox-backup-proxy
|
||||
|
||||
.. NOTE:: You need to stop the service before starting the daemon in
|
||||
foreground.
|
||||
|
||||
Description
|
||||
============
|
||||
|
||||
.. include:: description.rst
|
||||
|
||||
|
||||
.. include:: ../pbs-copyright.rst
|
||||
|
8
docs/services.rst
Normal file
8
docs/services.rst
Normal file
@ -0,0 +1,8 @@
|
||||
Service Daemons
|
||||
---------------
|
||||
|
||||
``proxmox-backup-proxy``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. include:: proxmox-backup-proxy/description.rst
|
||||
|
Loading…
Reference in New Issue
Block a user