tape: add manual page for tape.cfg

debian/proxmox-backup-server.install

@@ -27,6 +27,7 @@ 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/man/man5/tape.cfg.5
 usr/share/zsh/vendor-completions/_proxmox-backup-manager
 usr/share/zsh/vendor-completions/_pmtx
 usr/share/zsh/vendor-completions/_pmt

docs/Makefile

@@ -10,6 +10,7 @@ GENERATED_SYNOPSIS := 						\
 	backup-protocol-api.rst					\
 	reader-protocol-api.rst					\
 	config/madia-pool/config.rst				\
+	config/tape/config.rst					\
 	config/user/config.rst					\
 	config/remote/config.rst				\
 	config/sync/config.rst					\
@@ -27,6 +28,7 @@ MAN1_PAGES := 				\
 
 MAN5_PAGES :=				\
 	media-pool.cfg.5		\
+	tape.cfg.5			\
 	acl.cfg.5			\
 	user.cfg.5			\
 	remote.cfg.5			\
@@ -143,6 +145,12 @@ config/media-pool/config.rst: ${COMPILEDIR}/docgen
 media-pool.cfg.5: config/media-pool/man5.rst config/media-pool/config.rst config/media-pool/format.rst
 	rst2man $< >$@
 
+config/tape/config.rst: ${COMPILEDIR}/docgen
+	${COMPILEDIR}/docgen tape.cfg >$@
+
+tape.cfg.5: config/tape/man5.rst config/tape/config.rst config/tape/format.rst
+	rst2man $< >$@
+
 proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
 	${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst
 

docs/config/tape/format.rst

@@ -0,0 +1,22 @@
+Each drive configuration section starts with a header ``linux: <name>``,
+followed by the drive configuration options.
+
+Tape changer configurations starts with  ``changer: <name>``,
+followed by the changer configuration options.
+
+::
+
+  linux: hh8
+	changer sl3
+	path /dev/tape/by-id/scsi-10WT065325-nst
+
+  changer: sl3
+	export-slots 14,15,16
+	path /dev/tape/by-id/scsi-CJ0JBE0059
+
+
+You can use the ``proxmox-tape drive`` and ``proxmox-tape changer``
+commands to manipulate this file.
+
+.. NOTE:: The ``virtual:`` drive type is experimental and onyl used
+   for debugging.

docs/config/tape/man5.rst

@@ -0,0 +1,33 @@
+==========================
+tape.cfg
+==========================
+
+.. include:: ../../epilog.rst
+
+-------------------------------------------------------------
+Tape Drive and Changer Configuration
+-------------------------------------------------------------
+
+:Author: |AUTHOR|
+:Version: Version |VERSION|
+:Manual section: 5
+
+Description
+===========
+
+The file /etc/proxmox-backup/tape.cfg is a configuration file for Proxmox
+Backup Server. It contains the tape drive and changer configuration.
+
+File Format
+===========
+
+.. include:: format.rst
+
+
+Options
+=======
+
+.. include:: config.rst
+
+
+.. include:: ../../pbs-copyright.rst

docs/tape-backup.rst

@@ -749,3 +749,18 @@ Options
 ^^^^^^^
 
 .. include:: config/media-pool/config.rst
+
+
+``tape.cfg``
+~~~~~~~~~~~~~~~~~~
+
+File Format
+^^^^^^^^^^^
+
+.. include:: config/tape/format.rst
+
+
+Options
+^^^^^^^
+
+.. include:: config/tape/config.rst