From b9a09a950135d192ab02cbdab8c65642d60db777 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Wed, 10 Feb 2021 11:28:56 +0100 Subject: [PATCH] docs: add "Configuration Files" appendix --- docs/config/datastore/format.rst | 15 +++++++++++++++ docs/config/datastore/man5.rst | 15 +-------------- docs/configuration-files.rst | 20 ++++++++++++++++++++ docs/index.rst | 1 + 4 files changed, 37 insertions(+), 14 deletions(-) create mode 100644 docs/config/datastore/format.rst create mode 100644 docs/configuration-files.rst diff --git a/docs/config/datastore/format.rst b/docs/config/datastore/format.rst new file mode 100644 index 00000000..66a62836 --- /dev/null +++ b/docs/config/datastore/format.rst @@ -0,0 +1,15 @@ +The file contains a list of datastore configuration sections. Each +section starts with a header ``datastore: ``, followed by the +datastore configuration options. + +:: + + datastore: + path + + ... + + datastore: + path + ... + diff --git a/docs/config/datastore/man5.rst b/docs/config/datastore/man5.rst index a01b6895..038218c4 100644 --- a/docs/config/datastore/man5.rst +++ b/docs/config/datastore/man5.rst @@ -21,22 +21,9 @@ Backup Server. It contains the Datastore configuration. File Format =========== -The file contains a list of datastore configuration sections. Each -section starts with a header ``datastore: ``, followed by the -datastore configuration options. +.. include:: format.rst -:: - - datastore: - path - - ... - datastore: - path - ... - - Options ======= diff --git a/docs/configuration-files.rst b/docs/configuration-files.rst new file mode 100644 index 00000000..243482ce --- /dev/null +++ b/docs/configuration-files.rst @@ -0,0 +1,20 @@ +Configuration Files +=================== + +All Proxmox Backup Server configuration files resides inside directory +``/etc/proxmox-backup/``. + + +``datastore.cfg`` +~~~~~~~~~~~~~~~~~ + +File Format +^^^^^^^^^^^ + +.. include:: config/datastore/format.rst + + +Options +^^^^^^^ + +.. include:: config/datastore/config.rst diff --git a/docs/index.rst b/docs/index.rst index 2c1d05d6..7285ed63 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,6 +45,7 @@ in the section entitled "GNU Free Documentation License". :caption: Appendix command-syntax.rst + configuration-files.rst file-formats.rst backup-protocol.rst calendarevents.rst