diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index 2189f8d9..fdc0944a 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -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 diff --git a/docs/Makefile b/docs/Makefile index 10824da4..99d2426f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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 diff --git a/docs/config/media-pool/format.rst b/docs/config/media-pool/format.rst new file mode 100644 index 00000000..5c7a08d9 --- /dev/null +++ b/docs/config/media-pool/format.rst @@ -0,0 +1,13 @@ +Each entry starts with a header ``pool: ``, 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. diff --git a/docs/config/media-pool/man5.rst b/docs/config/media-pool/man5.rst new file mode 100644 index 00000000..910f6ff6 --- /dev/null +++ b/docs/config/media-pool/man5.rst @@ -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 diff --git a/docs/tape-backup.rst b/docs/tape-backup.rst index c54eeed6..38f9be50 100644 --- a/docs/tape-backup.rst +++ b/docs/tape-backup.rst @@ -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