* [pmg-devel] [PATCH pmg-docs 2/2] update generated cli synopsis files
2025-08-13 10:06 [pmg-devel] [PATCH pmg-docs 0/2] fix #6656: asciidoc: add anchor links for paragraphs with ids Christoph Heiss
2025-08-13 10:06 ` [pmg-devel] [PATCH pmg-docs 1/2] " Christoph Heiss
@ 2025-08-13 10:06 ` Christoph Heiss
1 sibling, 0 replies; 3+ messages in thread
From: Christoph Heiss @ 2025-08-13 10:06 UTC (permalink / raw)
To: pmg-devel
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
pmgbackup.1-synopsis.adoc | 16 ++++++++++++++++
pmgcm.1-synopsis.adoc | 11 +++++++++++
pmgconfig.1-synopsis.adoc | 26 ++++++++++++++++++++++++++
pmgdaemon.8-synopsis.adoc | 6 ++++++
pmgdb.1-synopsis.adoc | 7 +++++++
pmgmirror.8-synopsis.adoc | 5 +++++
pmgperf.1-synopsis.adoc | 2 ++
pmgproxy.8-synopsis.adoc | 6 ++++++
pmgqm.1-synopsis.adoc | 5 +++++
pmgreport.1-synopsis.adoc | 2 ++
pmgsubscription.1-synopsis.adoc | 7 +++++++
pmgtunnel.8-synopsis.adoc | 6 ++++++
pmgupgrade.1-synopsis.adoc | 2 ++
pmgversion.1-synopsis.adoc | 2 ++
14 files changed, 103 insertions(+)
diff --git a/pmgbackup.1-synopsis.adoc b/pmgbackup.1-synopsis.adoc
index 631897c..d2f71ad 100644
--- a/pmgbackup.1-synopsis.adoc
+++ b/pmgbackup.1-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgbackup]]
*pmgbackup* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgbackup_backup]]
*pmgbackup backup* `[OPTIONS]`
Backup the system configuration.
@@ -12,6 +14,7 @@ Specify when to notify via e-mail
Backup statistic databases.
+[[cli_pmgbackup_help]]
*pmgbackup help* `[OPTIONS]`
Get help about specified command.
@@ -24,10 +27,12 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgbackup_list]]
*pmgbackup list*
List all stored backups (files named proxmox-backup_{DATE}.tgz).
+[[cli_pmgbackup_proxmox-backup_backup]]
*pmgbackup proxmox-backup backup* `<remote>` `[OPTIONS]`
Create a new backup and prune the backup group afterwards, if configured.
@@ -44,6 +49,7 @@ Specify when to notify via e-mail
Backup statistic databases.
+[[cli_pmgbackup_proxmox-backup_forget]]
*pmgbackup proxmox-backup forget* `<remote> <backup-id> <backup-time>`
Forget a snapshot
@@ -60,6 +66,7 @@ ID (hostname) of backup snapshot
Backup time in RFC 3339 format
+[[cli_pmgbackup_proxmox-backup_job_create]]
*pmgbackup proxmox-backup job create* `<remote>` `[OPTIONS]`
Create backup schedule
@@ -76,6 +83,7 @@ Randomized delay to add to the starttime (RandomizedDelaySec setting of the syst
Schedule for the backup (OnCalendar setting of the systemd.timer)
+[[cli_pmgbackup_proxmox-backup_job_delete]]
*pmgbackup proxmox-backup job delete* `<remote>`
Delete backup schedule
@@ -84,6 +92,7 @@ Delete backup schedule
Proxmox Backup Server ID.
+[[cli_pmgbackup_proxmox-backup_job_show]]
*pmgbackup proxmox-backup job show* `<remote>` `[FORMAT_OPTIONS]`
Get timer specification
@@ -92,6 +101,7 @@ Get timer specification
Proxmox Backup Server ID.
+[[cli_pmgbackup_proxmox-backup_list]]
*pmgbackup proxmox-backup list* `<remote>` `[FORMAT_OPTIONS]`
Get snapshots stored on remote.
@@ -100,6 +110,7 @@ Get snapshots stored on remote.
Proxmox Backup Server ID.
+[[cli_pmgbackup_proxmox-backup_remote_add]]
*pmgbackup proxmox-backup remote add* `<remote> --datastore <string> --server <string>` `[OPTIONS]`
Add Proxmox Backup Server remote instance.
@@ -172,10 +183,12 @@ Proxmox Backup Server address.
Username or API token ID on the Proxmox Backup Server
+[[cli_pmgbackup_proxmox-backup_remote_list]]
*pmgbackup proxmox-backup remote list* `[FORMAT_OPTIONS]`
List all configured Proxmox Backup Server instances.
+[[cli_pmgbackup_proxmox-backup_remote_remove]]
*pmgbackup proxmox-backup remote remove* `<remote>`
Delete an PBS remote
@@ -184,6 +197,7 @@ Delete an PBS remote
Profile ID.
+[[cli_pmgbackup_proxmox-backup_remote_set]]
*pmgbackup proxmox-backup remote set* `<remote>` `[OPTIONS]`
Update PBS remote settings.
@@ -264,6 +278,7 @@ Proxmox Backup Server address.
Username or API token ID on the Proxmox Backup Server
+[[cli_pmgbackup_proxmox-backup_restore]]
*pmgbackup proxmox-backup restore* `<remote> <backup-id> <backup-time>` `[OPTIONS]`
Restore the system configuration.
@@ -292,6 +307,7 @@ Restore the rule database. This is the default.
Restore statistic databases. Only considered when you restore the 'database'.
+[[cli_pmgbackup_restore]]
*pmgbackup restore* `--filename <string>` `[OPTIONS]`
Restore the system configuration.
diff --git a/pmgcm.1-synopsis.adoc b/pmgcm.1-synopsis.adoc
index 7a11d1b..488ad76 100644
--- a/pmgcm.1-synopsis.adoc
+++ b/pmgcm.1-synopsis.adoc
@@ -1,9 +1,12 @@
+[[cli_pmgcm]]
*pmgcm* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgcm_create]]
*pmgcm create*
Create initial cluster config with current node as master.
+[[cli_pmgcm_delete]]
*pmgcm delete* `<cid>`
Remove a node from the cluster.
@@ -12,6 +15,7 @@ Remove a node from the cluster.
Cluster Node ID.
+[[cli_pmgcm_help]]
*pmgcm help* `[OPTIONS]`
Get help about specified command.
@@ -24,6 +28,7 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgcm_join]]
*pmgcm join* `<master_ip>` `[OPTIONS]`
Join a new node to an existing cluster.
@@ -36,19 +41,23 @@ IP address.
SSL certificate fingerprint.
+[[cli_pmgcm_join-cmd]]
*pmgcm join-cmd*
Prints the command for joining an new node to the cluster. You need to
execute the command on the new node.
+[[cli_pmgcm_join_cmd]]
*pmgcm join_cmd*
An alias for 'pmgcm join-cmd'.
+[[cli_pmgcm_promote]]
*pmgcm promote*
Promote current node to become the new master.
+[[cli_pmgcm_status]]
*pmgcm status* `[OPTIONS]`
Cluster node status.
@@ -57,6 +66,7 @@ Cluster node status.
List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case.
+[[cli_pmgcm_sync]]
*pmgcm sync* `[OPTIONS]`
Synchronize cluster configuration.
@@ -65,6 +75,7 @@ Synchronize cluster configuration.
Optional IP address for master node.
+[[cli_pmgcm_update-fingerprints]]
*pmgcm update-fingerprints*
Notify master to refresh all certificate fingerprints
diff --git a/pmgconfig.1-synopsis.adoc b/pmgconfig.1-synopsis.adoc
index 02f4b30..298bbd3 100644
--- a/pmgconfig.1-synopsis.adoc
+++ b/pmgconfig.1-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgconfig]]
*pmgconfig* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgconfig_acme_account_deactivate]]
*pmgconfig acme account deactivate* `[<name>]` `[OPTIONS]`
Deactivate existing ACME account at CA.
@@ -12,6 +14,7 @@ ACME account config file name.
Delete account data even if the server refuses to deactivate the account.
+[[cli_pmgconfig_acme_account_info]]
*pmgconfig acme account info* `[<name>]` `[FORMAT_OPTIONS]`
Return existing ACME account information.
@@ -20,10 +23,12 @@ Return existing ACME account information.
ACME account config file name.
+[[cli_pmgconfig_acme_account_list]]
*pmgconfig acme account list*
ACME account index.
+[[cli_pmgconfig_acme_account_register]]
*pmgconfig acme account register* `[<name>] {<contact>}` `[OPTIONS]`
Register a new ACME account with a compatible CA.
@@ -40,6 +45,7 @@ Contact email addresses.
URL of ACME CA directory endpoint.
+[[cli_pmgconfig_acme_account_update]]
*pmgconfig acme account update* `[<name>]` `[OPTIONS]`
Update existing ACME account information with CA. Note: not specifying any
@@ -53,6 +59,7 @@ ACME account config file name.
Contact email addresses.
+[[cli_pmgconfig_acme_cert_order]]
*pmgconfig acme cert order* `<type>` `[OPTIONS]`
Order a new certificate from ACME-compatible CA.
@@ -65,6 +72,7 @@ The TLS certificate type (API or SMTP certificate).
Overwrite existing custom certificate.
+[[cli_pmgconfig_acme_cert_renew]]
*pmgconfig acme cert renew* `<type>` `[OPTIONS]`
Renew existing certificate from CA.
@@ -77,6 +85,7 @@ The TLS certificate type (API or SMTP certificate).
Force renewal even if expiry is more than 30 days away.
+[[cli_pmgconfig_acme_cert_revoke]]
*pmgconfig acme cert revoke* `<type>`
Revoke existing certificate from CA.
@@ -85,6 +94,7 @@ Revoke existing certificate from CA.
The TLS certificate type (API or SMTP certificate).
+[[cli_pmgconfig_acme_plugin_add]]
*pmgconfig acme plugin add* `<type> <id>` `[OPTIONS]`
Add ACME plugin configuration.
@@ -117,6 +127,7 @@ List of cluster node names.
Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
+[[cli_pmgconfig_acme_plugin_config]]
*pmgconfig acme plugin config* `<id>` `[FORMAT_OPTIONS]`
Get ACME plugin configuration.
@@ -125,6 +136,7 @@ Get ACME plugin configuration.
Unique identifier for ACME plugin instance.
+[[cli_pmgconfig_acme_plugin_list]]
*pmgconfig acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]`
ACME plugin index.
@@ -133,6 +145,7 @@ ACME plugin index.
Only list ACME plugins of a specific type
+[[cli_pmgconfig_acme_plugin_remove]]
*pmgconfig acme plugin remove* `<id>`
Delete ACME plugin configuration.
@@ -141,6 +154,7 @@ Delete ACME plugin configuration.
Unique identifier for ACME plugin instance.
+[[cli_pmgconfig_acme_plugin_set]]
*pmgconfig acme plugin set* `<id>` `[OPTIONS]`
Update ACME plugin configuration.
@@ -177,6 +191,7 @@ List of cluster node names.
Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
+[[cli_pmgconfig_apicert]]
*pmgconfig apicert* `[OPTIONS]`
Generate /etc/pmg/pmg-api.pem (self signed certificate for GUI and REST
@@ -186,6 +201,7 @@ API).
Overwrite existing certificate.
+[[cli_pmgconfig_cert_delete]]
*pmgconfig cert delete* `<type> [<restart>]`
DELETE custom certificate chain and key.
@@ -198,10 +214,12 @@ The TLS certificate type (API or SMTP certificate).
Restart pmgproxy.
+[[cli_pmgconfig_cert_info]]
*pmgconfig cert info* `[FORMAT_OPTIONS]`
Get information about the node's certificates.
+[[cli_pmgconfig_cert_set]]
*pmgconfig cert set* `<type> <certificates> <key>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Upload or update custom certificate chain and key.
@@ -226,10 +244,12 @@ Overwrite existing custom or ACME certificate files.
Restart services.
+[[cli_pmgconfig_dkim_record]]
*pmgconfig dkim_record*
Get the public key for the configured selector, prepared as DKIM TXT record
+[[cli_pmgconfig_dkim_set]]
*pmgconfig dkim_set* `--keysize <integer> --selector <string>` `[OPTIONS]`
Generate a new private key for selector. All future mail will be signed
@@ -247,10 +267,12 @@ Number of bits for the RSA-Key
DKIM Selector
+[[cli_pmgconfig_dump]]
*pmgconfig dump*
Print configuration setting which can be used in templates.
+[[cli_pmgconfig_help]]
*pmgconfig help* `[OPTIONS]`
Get help about specified command.
@@ -263,14 +285,17 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgconfig_init]]
*pmgconfig init*
Generate required files in /etc/pmg/
+[[cli_pmgconfig_ldapsync]]
*pmgconfig ldapsync*
Synchronize the LDAP database.
+[[cli_pmgconfig_sync]]
*pmgconfig sync* `[OPTIONS]`
Synchronize Proxmox Mail Gateway configurations with system configuration.
@@ -279,6 +304,7 @@ Synchronize Proxmox Mail Gateway configurations with system configuration.
Restart services if necessary.
+[[cli_pmgconfig_tlscert]]
*pmgconfig tlscert* `[OPTIONS]`
Generate /etc/pmg/pmg-tls.pem (self signed certificate for encrypted SMTP
diff --git a/pmgdaemon.8-synopsis.adoc b/pmgdaemon.8-synopsis.adoc
index 99d08e3..d8fd1f9 100644
--- a/pmgdaemon.8-synopsis.adoc
+++ b/pmgdaemon.8-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgdaemon]]
*pmgdaemon* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgdaemon_help]]
*pmgdaemon help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgdaemon_restart]]
*pmgdaemon restart*
Restart the daemon (or start if not running).
+[[cli_pmgdaemon_start]]
*pmgdaemon start* `[OPTIONS]`
Start the daemon.
@@ -24,10 +28,12 @@ Start the daemon.
Debug mode - stay in foreground
+[[cli_pmgdaemon_status]]
*pmgdaemon status*
Get daemon status.
+[[cli_pmgdaemon_stop]]
*pmgdaemon stop*
Stop the daemon.
diff --git a/pmgdb.1-synopsis.adoc b/pmgdb.1-synopsis.adoc
index ea658fb..4cda2bd 100644
--- a/pmgdb.1-synopsis.adoc
+++ b/pmgdb.1-synopsis.adoc
@@ -1,9 +1,12 @@
+[[cli_pmgdb]]
*pmgdb* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgdb_delete]]
*pmgdb delete*
Delete PMG rule database.
+[[cli_pmgdb_dump]]
*pmgdb dump* `[OPTIONS]`
Print the PMG rule database.
@@ -12,6 +15,7 @@ Print the PMG rule database.
Which rules should be printed
+[[cli_pmgdb_help]]
*pmgdb help* `[OPTIONS]`
Get help about specified command.
@@ -24,6 +28,7 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgdb_init]]
*pmgdb init* `[OPTIONS]`
Initialize/Upgrade the PMG rule database.
@@ -36,10 +41,12 @@ Delete existing database.
Reset and update statistic database.
+[[cli_pmgdb_reset]]
*pmgdb reset*
Reset PMG rule database back to factory defaults.
+[[cli_pmgdb_update]]
*pmgdb update*
Update the PMG statistic database.
diff --git a/pmgmirror.8-synopsis.adoc b/pmgmirror.8-synopsis.adoc
index d559e05..2185bb3 100644
--- a/pmgmirror.8-synopsis.adoc
+++ b/pmgmirror.8-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgmirror]]
*pmgmirror* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgmirror_help]]
*pmgmirror help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgmirror_restart]]
*pmgmirror restart*
Restart the Database Mirror Daemon
+[[cli_pmgmirror_start]]
*pmgmirror start* `[OPTIONS]`
Start the Database Mirror Daemon
@@ -24,6 +28,7 @@ Start the Database Mirror Daemon
Debug mode - stay in foreground
+[[cli_pmgmirror_stop]]
*pmgmirror stop*
Stop the Database Mirror Daemon
diff --git a/pmgperf.1-synopsis.adoc b/pmgperf.1-synopsis.adoc
index 80ecfca..af47d1d 100644
--- a/pmgperf.1-synopsis.adoc
+++ b/pmgperf.1-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgperf_help]]
*pmgperf* `help`
+[[cli_pmgperf]]
*pmgperf* `[<path>]`
Proxmox benchmark.
diff --git a/pmgproxy.8-synopsis.adoc b/pmgproxy.8-synopsis.adoc
index 8515291..93d9869 100644
--- a/pmgproxy.8-synopsis.adoc
+++ b/pmgproxy.8-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgproxy]]
*pmgproxy* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgproxy_help]]
*pmgproxy help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgproxy_restart]]
*pmgproxy restart*
Restart the daemon (or start if not running).
+[[cli_pmgproxy_start]]
*pmgproxy start* `[OPTIONS]`
Start the daemon.
@@ -24,10 +28,12 @@ Start the daemon.
Debug mode - stay in foreground
+[[cli_pmgproxy_status]]
*pmgproxy status*
Get daemon status.
+[[cli_pmgproxy_stop]]
*pmgproxy stop*
Stop the daemon.
diff --git a/pmgqm.1-synopsis.adoc b/pmgqm.1-synopsis.adoc
index 373b55b..3b8853b 100644
--- a/pmgqm.1-synopsis.adoc
+++ b/pmgqm.1-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgqm]]
*pmgqm* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgqm_help]]
*pmgqm help* `[OPTIONS]`
Get help about specified command.
@@ -12,6 +14,7 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgqm_purge]]
*pmgqm purge* `[OPTIONS]`
Cleanup Quarantine database. Remove entries older than configured
@@ -21,6 +24,7 @@ quarantine lifetime.
Only search for quarantine files older than configured quarantine lifetime. Just print found files, but do not remove them.
+[[cli_pmgqm_send]]
*pmgqm send* `[OPTIONS]`
Generate and send spam report emails.
@@ -45,6 +49,7 @@ Spam report style. Default value is read from spam quarantine configuration.
Select time span.
+[[cli_pmgqm_status]]
*pmgqm status* `[OPTIONS]`
Print quarantine status (mails per user) for specified time span.
diff --git a/pmgreport.1-synopsis.adoc b/pmgreport.1-synopsis.adoc
index d2d99bf..28fbe58 100644
--- a/pmgreport.1-synopsis.adoc
+++ b/pmgreport.1-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgreport_help]]
*pmgreport* `help`
+[[cli_pmgreport]]
*pmgreport* `[OPTIONS]`
Generate and send daily system report email.
diff --git a/pmgsubscription.1-synopsis.adoc b/pmgsubscription.1-synopsis.adoc
index ba84134..e5b2f81 100644
--- a/pmgsubscription.1-synopsis.adoc
+++ b/pmgsubscription.1-synopsis.adoc
@@ -1,13 +1,17 @@
+[[cli_pmgsubscription]]
*pmgsubscription* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgsubscription_delete]]
*pmgsubscription delete*
Delete subscription key.
+[[cli_pmgsubscription_get]]
*pmgsubscription get*
Read subscription info.
+[[cli_pmgsubscription_help]]
*pmgsubscription help* `[OPTIONS]`
Get help about specified command.
@@ -20,6 +24,7 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgsubscription_set]]
*pmgsubscription set* `<key>`
Set subscription key.
@@ -28,6 +33,7 @@ Set subscription key.
Proxmox Mail Gateway subscription key
+[[cli_pmgsubscription_set-offline-key]]
*pmgsubscription set-offline-key* `<data>`
(Internal use only!) Set a signed subscription info blob as offline key
@@ -36,6 +42,7 @@ Proxmox Mail Gateway subscription key
no description available
+[[cli_pmgsubscription_update]]
*pmgsubscription update* `[OPTIONS]`
Update subscription info.
diff --git a/pmgtunnel.8-synopsis.adoc b/pmgtunnel.8-synopsis.adoc
index cd058a4..f33a2e5 100644
--- a/pmgtunnel.8-synopsis.adoc
+++ b/pmgtunnel.8-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgtunnel]]
*pmgtunnel* `<COMMAND> [ARGS] [OPTIONS]`
+[[cli_pmgtunnel_help]]
*pmgtunnel help* `[OPTIONS]`
Get help about specified command.
@@ -12,10 +14,12 @@ Shows help for a specific command
Verbose output format.
+[[cli_pmgtunnel_restart]]
*pmgtunnel restart*
Restart the Cluster Tunnel Daemon
+[[cli_pmgtunnel_start]]
*pmgtunnel start* `[OPTIONS]`
Start the Cluster Tunnel Daemon
@@ -24,10 +28,12 @@ Start the Cluster Tunnel Daemon
Debug mode - stay in foreground
+[[cli_pmgtunnel_status]]
*pmgtunnel status*
Print cluster tunnel status.
+[[cli_pmgtunnel_stop]]
*pmgtunnel stop*
Stop the Cluster Tunnel Daemon
diff --git a/pmgupgrade.1-synopsis.adoc b/pmgupgrade.1-synopsis.adoc
index 0891546..2245393 100644
--- a/pmgupgrade.1-synopsis.adoc
+++ b/pmgupgrade.1-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgupgrade_help]]
*pmgupgrade* `help`
+[[cli_pmgupgrade]]
*pmgupgrade* `[OPTIONS]`
Upgrade Proxmox Mail Gateway
diff --git a/pmgversion.1-synopsis.adoc b/pmgversion.1-synopsis.adoc
index f6bea9d..124d19d 100644
--- a/pmgversion.1-synopsis.adoc
+++ b/pmgversion.1-synopsis.adoc
@@ -1,5 +1,7 @@
+[[cli_pmgversion_help]]
*pmgversion* `help`
+[[cli_pmgversion]]
*pmgversion* `[OPTIONS]`
Print version information for Proxmox Mail Gateway packages.
--
2.50.1
_______________________________________________
pmg-devel mailing list
pmg-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel
^ permalink raw reply [flat|nested] 3+ messages in thread