proxmox-mirrors/proxmox-offline-mirror
1
0
Fork 0
mirror of https://git.proxmox.com/git/proxmox-offline-mirror synced 2025-04-28 21:31:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: ship config manpage as proxmox-offline-mirror.cfg.5

Browse Source 
as `mirror.cfg.5` is rather overly generic

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2022-09-08 13:36:49 +02:00
parent f03a1f2b84
commit 3d44b696bd
4 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@ -10,7 +10,7 @@ MAN1_PAGES := \
proxmox-apt-repo.1 proxmox-apt-repo.1
MAN5_PAGES := \ MAN5_PAGES := \
mirror.cfg.5 proxmox-offline-mirror.cfg.5
# Sphinx documentation setup # Sphinx documentation setup
SPHINXOPTS = SPHINXOPTS =

2
docs/conf.py
View File

@ -95,7 +95,7 @@ man_pages = [
('proxmox-offline-mirror/man1', 'proxmox-offline-mirror', 'Command line tool for Backup and Restore', [author], 1), ('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), ('proxmox-apt-repo/man1', 'proxmox-apt-repo', 'Command line tool to manage and configure the backup server.', [author], 1),
# configs # configs
('config/mirror/man5', 'mirror.cfg', 'Mirror Configuration', [author], 5), ('config/mirror/man5', 'proxmox-offline-mirror.cfg', 'Proxmox Offline Mirror Configuration', [author], 5),
] ]

12
docs/config/mirror/man5.rst
View File

@ -1,12 +1,14 @@
========== ==========================
mirror.cfg proxmox-offline-mirror.cfg
========== ==========================
Description Description
=========== ===========
The file /etc/proxmox-offline-mirror.cfg is a configuration file for Proxmox The file ``/etc/proxmox-offline-mirror.cfg`` is a configuration file for Proxmox Offline Mirror. It
Offline Mirror. It contains definitions for mirrors, media and subscription keys. contains definitions for mirrors, media and subscription keys.
Note that you can use the ``--config <file>`` switch on most commands or the ``PROXMOX_OFFLINE_MIRROR_CONFIG`` environment variable to override the default config location.
Options Options
======= =======

6
docs/configuration-files.rst
View File

@ -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. 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 <file>`` 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 Options