diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index 4f0f044e..ddb082fe 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -29,6 +29,7 @@ usr/share/man/man5/sync.cfg.5 usr/share/man/man5/verification.cfg.5 usr/share/man/man5/media-pool.cfg.5 usr/share/man/man5/tape.cfg.5 +usr/share/man/man5/tape-job.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 b033fe98..4dc0019b 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -12,6 +12,7 @@ GENERATED_SYNOPSIS := \ reader-protocol-api.rst \ config/media-pool/config.rst \ config/tape/config.rst \ + config/tape-job/config.rst \ config/user/config.rst \ config/remote/config.rst \ config/sync/config.rst \ @@ -31,6 +32,7 @@ MAN1_PAGES := \ MAN5_PAGES := \ media-pool.cfg.5 \ tape.cfg.5 \ + tape-job.cfg.5 \ acl.cfg.5 \ user.cfg.5 \ remote.cfg.5 \ @@ -153,6 +155,12 @@ config/tape/config.rst: ${COMPILEDIR}/docgen tape.cfg.5: config/tape/man5.rst config/tape/config.rst config/tape/format.rst rst2man $< >$@ +config/tape-job/config.rst: ${COMPILEDIR}/docgen + ${COMPILEDIR}/docgen tape-job.cfg >$@ + +tape-job.cfg.5: config/tape-job/man5.rst config/tape-job/config.rst config/tape-job/format.rst + rst2man $< >$@ + proxmox-tape/synopsis.rst: ${COMPILEDIR}/proxmox-tape ${COMPILEDIR}/proxmox-tape printdoc > proxmox-tape/synopsis.rst diff --git a/docs/config/tape-job/format.rst b/docs/config/tape-job/format.rst new file mode 100644 index 00000000..6eaf60ad --- /dev/null +++ b/docs/config/tape-job/format.rst @@ -0,0 +1,16 @@ +Each entry starts with a header ``backup: ``, followed by the +job configuration options. + +:: + + backup: job1 + drive hh8 + pool p4 + store store3 + schedule daily + + backup: ... + + +You can use the ``proxmox-tape backup-job`` command to manipulate +this file. diff --git a/docs/config/tape-job/man5.rst b/docs/config/tape-job/man5.rst new file mode 100644 index 00000000..493b3915 --- /dev/null +++ b/docs/config/tape-job/man5.rst @@ -0,0 +1,34 @@ +========================== +tape-job.cfg +========================== + +.. include:: ../../epilog.rst + +------------------------------------------------------------- +Tape Job Configuration +------------------------------------------------------------- + +:Author: |AUTHOR| +:Version: Version |VERSION| +:Manual section: 5 + +Description +=========== + +The file ``/etc/proxmox-backup/tape-job.cfg`` is a configuration file for +Proxmox Backup Server. It contains the tape job configuration. + + +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 7ec11f5c..3facc6e5 100644 --- a/docs/tape-backup.rst +++ b/docs/tape-backup.rst @@ -766,6 +766,22 @@ Options .. include:: config/tape/config.rst +``tape-job.cfg`` +~~~~~~~~~~~~~~~~~~ + +File Format +^^^^^^^^^^^ + +.. include:: config/tape-job/format.rst + + +Options +^^^^^^^ + +.. include:: config/tape-job/config.rst + + + Command Syntax -------------- diff --git a/src/bin/docgen.rs b/src/bin/docgen.rs index 1cdade9d..740c700f 100644 --- a/src/bin/docgen.rs +++ b/src/bin/docgen.rs @@ -31,6 +31,7 @@ fn main() -> Result<(), Error> { let text = match arg.as_ref() { "datastore.cfg" => dump_section_config(&config::datastore::CONFIG), "tape.cfg" => dump_section_config(&config::drive::CONFIG), + "tape-job.cfg" => dump_section_config(&config::tape_job::CONFIG), "user.cfg" => dump_section_config(&config::user::CONFIG), "remote.cfg" => dump_section_config(&config::remote::CONFIG), "sync.cfg" => dump_section_config(&config::sync::CONFIG),