proxmox-backup/docs
Christian Ebner abad8e25c4 fix #6185: client/docs: explicitly mention archive name restrictions
Mention in the docs and the api parameter description the limitations
for archive name labels. They must contain alphanumerics, hyphens and
underscores only to match the regex pattern.

By setting this in the api parameter description, it will be included
in the man page for proxmox-backup-client.

Fixes: https://bugzilla.proxmox.com/show_bug.cgi?id=6185
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2025-02-21 16:00:17 +01: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 man: verification: Fix config file name 2025-01-28 14:49:23 +01:00
images docs: images: add installer guide screenshots 2024-11-25 15:45:15 +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 fix #6069: prune simulator: allow values specifying both range and step size 2025-02-10 15:34:39 +01:00
pxar docs: avoid orphan warnings for man-page skeletons 2024-03-08 08:08:10 +01:00
backup-client.rst fix #6185: client/docs: explicitly mention archive name restrictions 2025-02-21 16:00:17 +01: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: fix wrong product name in certificate docs 2024-11-21 16:59:22 +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: add synopsis and basic docs for prune job configuration 2025-01-28 14:34:47 +01:00
configuration-files.rst docs: add synopsis and basic docs for prune job configuration 2025-01-28 14:34:47 +01: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 ui: add onlineHelp for consent-banner option 2024-11-26 12:00:08 +01:00
index.rst docs: add documentation for notification system 2024-04-23 23:14:46 +02:00
installation-media.rst docs: installation: several small fixes/improvements 2024-11-27 12:56:00 +01:00
installation.rst docs: installation: several small fixes/improvements 2024-11-27 12:56:00 +01:00
introduction.rst docs: fix typos 2023-11-25 16:14:44 +01:00
local-zfs.rst docs: add installation wizard guide 2024-11-25 15:44:27 +01:00
maintenance.rst docs: Improve GC's cutofftime description 2025-01-27 08:51:02 +01:00
Makefile docs: add synopsis and basic docs for prune job configuration 2025-01-28 14:34:47 +01:00
managing-remotes.rst docs: mention required source audit permission for push sync jobs 2024-11-27 13:20:22 +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: document HTTP-based target's proxy behavior 2024-12-09 13:33:32 +01:00
output-format.rst docs: language fixup: faq and appendix 2021-11-02 07:12:07 +01:00
package-repositories.rst docs: installation: several small fixes/improvements 2024-11-27 12:56:00 +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 fix typos in docs and API descriptions 2025-01-27 08:50:42 +01: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: add installation wizard guide 2024-11-25 15:44:27 +01:00
tape-backup.rst Fix #4408: add 'disaster recovery' section for tapes 2025-02-10 12:09:29 +01:00
technical-overview.rst fix typos in docs and API descriptions 2025-01-27 08:50:42 +01: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
using-the-installer.rst docs: installation: several small fixes/improvements 2024-11-27 12:56:00 +01:00