tape: add tape-job.cfg manual page
This commit is contained in:
parent
42200c405a
commit
7ca0ba4515
1
debian/proxmox-backup-server.install
vendored
1
debian/proxmox-backup-server.install
vendored
@ -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
|
||||
|
@ -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
|
||||
|
||||
|
16
docs/config/tape-job/format.rst
Normal file
16
docs/config/tape-job/format.rst
Normal file
@ -0,0 +1,16 @@
|
||||
Each entry starts with a header ``backup: <name>``, 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.
|
34
docs/config/tape-job/man5.rst
Normal file
34
docs/config/tape-job/man5.rst
Normal file
@ -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
|
@ -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
|
||||
--------------
|
||||
|
||||
|
@ -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),
|
||||
|
Loading…
Reference in New Issue
Block a user