tape: add manual page for media-pool.cfg

This commit is contained in:
Dietmar Maurer 2021-02-12 11:50:56 +01:00
parent 7b1bf4c098
commit bb71e3a023
5 changed files with 76 additions and 0 deletions

View File

@ -26,6 +26,7 @@ usr/share/man/man5/user.cfg.5
usr/share/man/man5/remote.cfg.5
usr/share/man/man5/sync.cfg.5
usr/share/man/man5/verification.cfg.5
usr/share/man/man5/media-pool.cfg.5
usr/share/zsh/vendor-completions/_proxmox-backup-manager
usr/share/zsh/vendor-completions/_pmtx
usr/share/zsh/vendor-completions/_pmt

View File

@ -9,6 +9,7 @@ GENERATED_SYNOPSIS := \
pmt/synopsis.rst \
backup-protocol-api.rst \
reader-protocol-api.rst \
config/madia-pool/config.rst \
config/user/config.rst \
config/remote/config.rst \
config/sync/config.rst \
@ -25,6 +26,7 @@ MAN1_PAGES := \
proxmox-backup-manager.1
MAN5_PAGES := \
media-pool.cfg.5 \
acl.cfg.5 \
user.cfg.5 \
remote.cfg.5 \
@ -135,6 +137,12 @@ config/acl/roles.rst: ${COMPILEDIR}/docgen
acl.cfg.5: config/acl/man5.rst config/acl/roles.rst config/acl/format.rst
rst2man $< >$@
config/media-pool/config.rst: ${COMPILEDIR}/docgen
${COMPILEDIR}/docgen media-pool.cfg >$@
media-pool.cfg.5: config/media-pool/man5.rst config/media-pool/config.rst config/media-pool/format.rst
rst2man $< >$@
proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst

View File

@ -0,0 +1,13 @@
Each entry starts with a header ``pool: <name>``, followed by the
media pool configuration options.
::
pool: company1
allocation always
retention overwrite
pool: ...
You can use the ``proxmox-tape pool`` command to manipulate this file.

View File

@ -0,0 +1,35 @@
==========================
media-pool.cfg
==========================
.. include:: ../../epilog.rst
-------------------------------------------------------------
Media Pool Configuration
-------------------------------------------------------------
:Author: |AUTHOR|
:Version: Version |VERSION|
:Manual section: 5
Description
===========
The file /etc/proxmox-backup/media-pool.cfg is a configuration file
for Proxmox Backup Server. It contains the medila pool configuration
for tape backups.
File Format
===========
.. include:: format.rst
Options
=======
.. include:: config.rst
.. include:: ../../pbs-copyright.rst

View File

@ -730,3 +730,22 @@ This command does the following:
- run drive cleaning operation
- unload the cleaning tape (to slot 3)
Configuration Files
-------------------
``media-pool.cfg``
~~~~~~~~~~~~~~~~~~
File Format
^^^^^^^^^^^
.. include:: config/media-pool/format.rst
Options
^^^^^^^
.. include:: config/media-pool/config.rst