docs: add user.cfg.5 manual page

debian/proxmox-backup-server.install

@@ -21,6 +21,7 @@ usr/share/man/man1/proxmox-backup-proxy.1
 usr/share/man/man1/pmtx.1
 usr/share/man/man1/pmt.1
 usr/share/man/man5/datastore.cfg.5
+usr/share/man/man5/user.cfg.5
 usr/share/zsh/vendor-completions/_proxmox-backup-manager
 usr/share/zsh/vendor-completions/_pmtx
 usr/share/zsh/vendor-completions/_pmt

docs/Makefile

@@ -9,6 +9,7 @@ GENERATED_SYNOPSIS := 						\
 	pmt/synopsis.rst					\
 	backup-protocol-api.rst					\
 	reader-protocol-api.rst					\
+	config/user/config.rst					\
 	config/datastore/config.rst
 
 MAN1_PAGES := 				\
@@ -20,6 +21,7 @@ MAN1_PAGES := 				\
 	proxmox-backup-manager.1
 
 MAN5_PAGES :=				\
+	user.cfg.5			\
 	datastore.cfg.5
 
 PRUNE_SIMULATOR_FILES := 					\
@@ -95,6 +97,12 @@ config/datastore/config.rst: ${COMPILEDIR}/docgen
 datastore.cfg.5: config/datastore/man5.rst config/datastore/config.rst
 	rst2man $< >$@
 
+config/user/config.rst: ${COMPILEDIR}/docgen
+	${COMPILEDIR}/docgen user.cfg >$@
+
+user.cfg.5: config/user/man5.rst config/user/config.rst
+	rst2man $< >$@
+
 proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
 	${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst
 

docs/config/user/format.rst

@@ -0,0 +1,28 @@
+This file contains the list of API users and API tokens.
+
+Each user configuration section starts with a header ``user: <name>``,
+followed by the user configuration options.
+
+API token configuration starts with a header ``token:
+<userid!token_name>``, followed by the token configuration. The data
+used to authenticate tokens is stored in a separate file
+(``token.shadow``).
+
+
+::
+
+  user: root@pam
+	comment Superuser
+	email test@example.local
+	...
+
+  token: root@pam!token1
+	comment API test token
+	enable true
+	expire 0
+
+  user: ...
+
+
+You can use the ``proxmox-backup-manager user`` command to manipulate
+this file.

docs/config/user/man5.rst

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

docs/configuration-files.rst

@@ -18,3 +18,18 @@ Options
 ^^^^^^^
 
 .. include:: config/datastore/config.rst
+
+
+``user.cfg``
+~~~~~~~~~~~~~~~~~
+
+File Format
+^^^^^^^^^^^
+
+.. include:: config/user/format.rst
+
+
+Options
+^^^^^^^
+
+.. include:: config/user/config.rst