installation: reword/expand/reflow and fix login thumbnail

[pmg-docs.git] / pmgbackup.1-synopsis.adoc

diff --git a/pmgbackup.1-synopsis.adoc b/pmgbackup.1-synopsis.adoc
index 8ac4da874d351bcb9997210470ef9972578ac367..631897c3d80f1efc473fcf52145477d7955e1985 100644 (file)
--- a/pmgbackup.1-synopsis.adoc
+++ b/pmgbackup.1-synopsis.adoc
@@ -4,6 +4,10 @@
 
 Backup the system configuration.
 
+`--notify` `<always | error | never>` ('default =' `never`)::
+
+Specify when to notify via e-mail
+
 `--statistic` `<boolean>` ('default =' `1`)::
 
 Backup statistic databases.
@@ -24,7 +28,7 @@ Verbose output format.
 
 List all stored backups (files named proxmox-backup_{DATE}.tgz).
 
-*pmgbackup proxmox-backup backup* `<remote>`
+*pmgbackup proxmox-backup backup* `<remote>` `[OPTIONS]`
 
 Create a new backup and prune the backup group afterwards, if configured.
 
@@ -32,6 +36,14 @@ Create a new backup and prune the backup group afterwards, if configured.
 
 Proxmox Backup Server ID.
 
+`--notify` `<always | error | never>` ('default =' `never`)::
+
+Specify when to notify via e-mail
+
+`--statistic` `<boolean>` ('default =' `1`)::
+
+Backup statistic databases.
+
 *pmgbackup proxmox-backup forget* `<remote> <backup-id> <backup-time>`
 
 Forget a snapshot
@@ -96,7 +108,7 @@ Add Proxmox Backup Server remote instance.
 
 Proxmox Backup Server ID.
 
-`--datastore` `<string>` ::
+`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
 
 Proxmox Backup Server datastore name.
 
@@ -108,6 +120,10 @@ Flag to disable (deactivate) the entry.
 
 Certificate SHA 256 fingerprint.
 
+`--include-statistics` `<boolean>` ::
+
+Include statistics in scheduled backups
+
 `--keep-daily` `<N>` ::
 
 Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
@@ -132,15 +148,27 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
 
 Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
 
+`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
+
+Proxmox Backup Server namespace in the datastore, defaults to the root NS.
+
+`--notify` `<always | error | never>` ::
+
+Specify when to notify via e-mail
+
 `--password` `<password>` ::
 
 Password or API token secret for the user on the Proxmox Backup Server.
 
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+Non-default port for Proxmox Backup Server.
+
 `--server` `<string>` ::
 
 Proxmox Backup Server address.
 
-`--username` `(?:[^\s\/\\@]+\@[^\s\/\\@]+)` ::
+`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
 
 Username or API token ID on the Proxmox Backup Server
 
@@ -164,7 +192,7 @@ Update PBS remote settings.
 
 Proxmox Backup Server ID.
 
-`--datastore` `<string>` ::
+`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
 
 Proxmox Backup Server datastore name.
 
@@ -174,7 +202,7 @@ A list of settings you want to delete.
 
 `--digest` `<string>` ::
 
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
 
 `--disable` `<boolean>` ::
 
@@ -184,6 +212,10 @@ Flag to disable (deactivate) the entry.
 
 Certificate SHA 256 fingerprint.
 
+`--include-statistics` `<boolean>` ::
+
+Include statistics in scheduled backups
+
 `--keep-daily` `<N>` ::
 
 Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
@@ -208,15 +240,27 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
 
 Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
 
+`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
+
+Proxmox Backup Server namespace in the datastore, defaults to the root NS.
+
+`--notify` `<always | error | never>` ::
+
+Specify when to notify via e-mail
+
 `--password` `<password>` ::
 
 Password or API token secret for the user on the Proxmox Backup Server.
 
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+Non-default port for Proxmox Backup Server.
+
 `--server` `<string>` ::
 
 Proxmox Backup Server address.
 
-`--username` `(?:[^\s\/\\@]+\@[^\s\/\\@]+)` ::
+`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
 
 Username or API token ID on the Proxmox Backup Server