proxmox-backup/docs
Thomas Lamprecht 1836c135bc docs: prefix node.cfg man page with proxmox-backup
As node.cfg is a rather general name that could clash with manual
pages from other packages, or at least be a bit confusing if there's
another tool providing a node.cfg.

In the long term we should rename all existing manual pages from
section 5 and 7, i.e. all those that are not directly named after an
executable. As those normally talk about product-specific configs and
topics where just the filename is not specific enough for a system
wide manual page.

Note that there was some off-list discussion with proposal of using
"section suffixes" that man supports and can be used to differ between
manual pages with the same name (and in the same section), for example
`man 3pm Git`, but to me this seems a bit more obscure and potentially
less discoverable, but can be a great way to provide an link alias for
convenience.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-10-21 14:19:51 +02:00
..
_ext docs/scanrefs: fix handling if ref is same as headline 2021-02-06 07:49:21 +01:00
_static docs: move custom.js and custom.css into _static folder 2024-04-18 14:15:44 +02:00
_templates docs: make logo path and index link absolute 2023-04-06 08:47:27 +02:00
api-viewer docs: fix api viewer dark theme path 2023-05-17 11:39:54 +02:00
config docs: add node.cfg man page 2024-10-18 17:56:17 +02:00
images docs: add section for prune jobs 2022-11-28 14:42:45 +01:00
lto-barcode fix typos in strings 2024-08-07 16:49:31 +02:00
pbs2to3 docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
pmt docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
pmtx docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
proxmox-backup docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
proxmox-backup-client docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
proxmox-backup-debug docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
proxmox-backup-manager docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
proxmox-backup-proxy docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
proxmox-file-restore docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
proxmox-tape docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
prune-simulator docs: clarify prune settings slightly more 2024-02-22 08:59:30 +01:00
pxar docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
backup-client.rst docs: add table listing possible change detection modes 2024-06-10 10:30:10 +02:00
backup-protocol.rst docs: improve the occurrence of product website hyperlinks 2023-11-25 16:14:44 +01:00
calendarevents.rst docs: improve the occurrence of product website hyperlinks 2023-11-25 16:14:44 +01:00
certificate-management.rst docs: improve the occurrence of product website hyperlinks 2023-11-25 16:14:44 +01:00
command-line-tools.rst fix spelling of command line/command-line 2023-06-27 15:43:43 +02:00
command-syntax.rst fix spelling of command line/command-line 2023-06-27 15:43:43 +02:00
conf.py docs: prefix node.cfg man page with proxmox-backup 2024-10-21 14:19:51 +02:00
configuration-files.rst docs: add node.cfg man page 2024-10-18 17:56:17 +02:00
epilog.rst docs: fix typos 2023-11-25 16:14:44 +01:00
external-metric-server.rst docs: fix warnings in external-metric-server page 2024-10-18 17:56:46 +02:00
faq-release-support-table.csv docs: faq: move support table to CSV 2023-11-10 15:59:52 +01:00
faq.rst tree-wide: fix various typos 2023-11-29 18:32:07 +01:00
file-formats.rst docs: file formats: describe split pxar archive file layout 2024-06-05 16:39:42 +02:00
GFDL.rst add license for docs (GFDL) 2019-11-11 19:45:44 +01:00
glossary.rst docs: language fixup: faq and appendix 2021-11-02 07:12:07 +01:00
gui.rst docs: improve the occurrence of product website hyperlinks 2023-11-25 16:14:44 +01:00
index.rst docs: add documentation for notification system 2024-04-23 23:14:46 +02:00
installation.rst docs: installation: fix wrong product reference 2024-10-17 05:43:25 +02:00
introduction.rst docs: fix typos 2023-11-25 16:14:44 +01:00
local-zfs.rst docs: clarify difference between zfs cache and log 2024-03-25 16:15:22 +01:00
maintenance.rst docs: document notification-mode and merge old notification section 2024-05-22 17:50:03 +02:00
Makefile docs: prefix node.cfg man page with proxmox-backup 2024-10-21 14:19:51 +02:00
managing-remotes.rst docs: remotes: fix missing newline between list and admonition-note 2024-01-22 16:11:46 +01:00
markdown-primer.rst docs: fix typos 2023-11-25 16:14:44 +01:00
meta-format-overview.dot docs: file formats: describe split pxar archive file layout 2024-06-05 16:39:42 +02:00
network-management.rst docs: improve the occurrence of product website hyperlinks 2023-11-25 16:14:44 +01:00
notifications.rst docs: notifications: rewrite overview for more clarity 2024-05-22 17:50:03 +02:00
output-format.rst docs: language fixup: faq and appendix 2021-11-02 07:12:07 +01:00
package-repositories.rst docs: fix typos 2023-11-25 16:14:44 +01:00
pbs-copyright.rst docs: replace copyright years statement with single source of truth from conf 2022-07-14 16:54:56 +02:00
pve-integration.rst docs: improve the occurrence of product website hyperlinks 2023-11-25 16:14:44 +01:00
pxar-format-overview.dot start file format docu 2019-03-16 16:44:45 +01:00
pxar-tool.rst fix spelling of command line/command-line 2023-06-27 15:43:43 +02:00
services.rst docs: add proxmox-backup service description 2021-02-13 09:48:21 +01:00
storage.rst docs: document notification-mode and merge old notification section 2024-05-22 17:50:03 +02:00
sysadmin.rst docs: fix warnings in external-metric-server page 2024-10-18 17:56:46 +02:00
system-booting.rst docs: add further secure boot information, as in pve-docs 2023-11-29 14:07:49 +01:00
system-requirements.rst docs: drop blanket statement recommending against remote storage 2024-06-17 17:52:03 +02:00
tape-backup.rst docs: tape: drop redefinition of systemd.time manpage link 2024-01-22 16:11:46 +01:00
technical-overview.rst docs: Fix typo for chunk directory naming and rewording 2024-10-17 05:43:25 +02:00
terminology.rst docs: improve the occurrence of product website hyperlinks 2023-11-25 16:14:44 +01:00
todos.rst docs: add missing todos 2020-07-08 18:14:17 +02:00
traffic-control.rst docs: link all screenshots to their image file 2022-11-28 17:15:42 +01:00
user-management.rst fix typos in docs an manual pages 2024-08-07 16:49:31 +02:00