pveproxy: followup wording/typo stuff

[pve-docs.git] / pvesm.1-synopsis.adoc

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index ebfd6761552ebd8b812b9f50f8bf15c8db7c3c8f..d231c485c85aaf02ccafc8e67e49ce8a082276b7 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -44,7 +44,7 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 `--datastore` `<string>` ::
 
-Proxmox backup server datastore name.
+Proxmox Backup Server datastore name.
 
 `--disable` `<boolean>` ::
 
@@ -54,7 +54,7 @@ Flag to disable the storage.
 
 CIFS domain.
 
-`--encryption-key` `<filepath>` ::
+`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
 
 Encryption key. Use 'autogen' to generate one automatically without passphrase.
 
@@ -130,10 +130,18 @@ File system path.
 
 Pool.
 
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+For non default port.
+
 `--portal` `<string>` ::
 
 iSCSI portal (IP or DNS name with optional port).
 
+`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+
+The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
+
 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
@@ -378,6 +386,56 @@ Get filesystem path for specified volume
 
 Volume identifier
 
+*pvesm prune-backups* `<storage>` `[OPTIONS]`
+
+Prune backups. Only those using the standard naming scheme are considered.
+If no keep options are specified, those from the storage configuration are
+used.
+
+`<storage>`: `<string>` ::
+
+The storage identifier.
+
+`--dry-run` `<boolean>` ::
+
+Only show what would be pruned, don't delete anything.
+
+`--keep-all` `<boolean>` ::
+
+Keep all backups. Conflicts with the other options when true.
+
+`--keep-daily` `<N>` ::
+
+Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
+
+`--keep-hourly` `<N>` ::
+
+Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
+
+`--keep-last` `<N>` ::
+
+Keep the last <N> backups.
+
+`--keep-monthly` `<N>` ::
+
+Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
+
+`--keep-weekly` `<N>` ::
+
+Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
+
+`--keep-yearly` `<N>` ::
+
+Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
+
+`--type` `<lxc | qemu>` ::
+
+Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
+
+`--vmid` `<integer> (1 - N)` ::
+
+Only consider backups for this guest.
+
 *pvesm remove* `<storage>`
 
 Delete storage configuration.
@@ -492,7 +550,7 @@ Flag to disable the storage.
 
 CIFS domain.
 
-`--encryption-key` `<filepath>` ::
+`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
 
 Encryption key. Use 'autogen' to generate one automatically without passphrase.
 
@@ -556,6 +614,14 @@ Password for accessing the share/datastore.
 
 Pool.
 
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+For non default port.
+
+`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+
+The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
+
 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.