diff --git a/docs/Makefile b/docs/Makefile index ee92cba..81931a6 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,7 +10,7 @@ MAN1_PAGES := \ proxmox-apt-repo.1 MAN5_PAGES := \ - mirror.cfg.5 + proxmox-offline-mirror.cfg.5 # Sphinx documentation setup SPHINXOPTS = diff --git a/docs/conf.py b/docs/conf.py index bcb004f..82a54a0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -95,7 +95,7 @@ man_pages = [ ('proxmox-offline-mirror/man1', 'proxmox-offline-mirror', 'Command line tool for Backup and Restore', [author], 1), ('proxmox-apt-repo/man1', 'proxmox-apt-repo', 'Command line tool to manage and configure the backup server.', [author], 1), # configs - ('config/mirror/man5', 'mirror.cfg', 'Mirror Configuration', [author], 5), + ('config/mirror/man5', 'proxmox-offline-mirror.cfg', 'Proxmox Offline Mirror Configuration', [author], 5), ] diff --git a/docs/config/mirror/man5.rst b/docs/config/mirror/man5.rst index 913b40c..6d67d68 100644 --- a/docs/config/mirror/man5.rst +++ b/docs/config/mirror/man5.rst @@ -1,12 +1,14 @@ -========== -mirror.cfg -========== +========================== +proxmox-offline-mirror.cfg +========================== Description =========== -The file /etc/proxmox-offline-mirror.cfg is a configuration file for Proxmox -Offline Mirror. It contains definitions for mirrors, media and subscription keys. +The file ``/etc/proxmox-offline-mirror.cfg`` is a configuration file for Proxmox Offline Mirror. It +contains definitions for mirrors, media and subscription keys. + +Note that you can use the ``--config `` switch on most commands or the ``PROXMOX_OFFLINE_MIRROR_CONFIG`` environment variable to override the default config location. Options ======= diff --git a/docs/configuration-files.rst b/docs/configuration-files.rst index fe8cfb4..cb86aa8 100644 --- a/docs/configuration-files.rst +++ b/docs/configuration-files.rst @@ -3,9 +3,11 @@ Configuration Files The Proxmox Offline Mirror configuration file is stored at ``/etc/proxmox-offline-mirror.cfg`` by default. Its location can be overriden for any given command using the `--config` parameter. +Note that you can use the ``--config `` switch on most commands or the ``PROXMOX_OFFLINE_MIRROR_CONFIG`` environment variable to override the default config location. -``mirror.cfg`` -~~~~~~~~~~~~~~ + +``proxmox-offline-mirror.cfg`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Options