qm: improve list of Intel/AMD CPU types in QEMU section

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

diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc
index 7a6ce7e9999644074b4239eb6488ec71af7180df..afed3d7df1048b8a02e3230b547358215608da59 100644 (file)
--- a/vzdump.1-synopsis.adoc
+++ b/vzdump.1-synopsis.adoc
@@ -14,9 +14,9 @@ Backup all known guest systems on this host.
 
 `--bwlimit` `<integer> (0 - N)` ('default =' `0`)::
 
-Limit I/O bandwidth (KBytes per second).
+Limit I/O bandwidth (in KiB/s).
 
-`--compress` `<0 | 1 | gzip | lzo>` ('default =' `0`)::
+`--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`)::
 
 Compress dump file.
 
@@ -28,13 +28,13 @@ Store resulting files to specified directory.
 
 Exclude specified guest systems (assumes --all)
 
-`--exclude-path` `<string>` ::
+`--exclude-path` `<array>` ::
 
-Exclude certain files/directories (shell globs).
+Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root,  other paths match relative to each subdirectory.
 
 `--ionice` `<integer> (0 - 8)` ('default =' `7`)::
 
-Set CFQ ionice priority.
+Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
 
 `--lockwait` `<integer> (0 - N)` ('default =' `180`)::
 
@@ -46,11 +46,11 @@ Specify when to send an email
 
 `--mailto` `<string>` ::
 
-Comma-separated list of email addresses that should receive email notifications.
+Comma-separated list of email addresses or users that should receive email notifications.
 
-`--maxfiles` `<integer> (1 - N)` ('default =' `1`)::
+`--maxfiles` `<integer> (1 - N)` ::
 
-Maximal number of backup files per guest system.
+Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.
 
 `--mode` `<snapshot | stop | suspend>` ('default =' `snapshot`)::
 
@@ -60,26 +60,46 @@ Backup mode.
 
 Only run if executed on this node.
 
+`--notes-template` `<string>` ::
+
+Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are \{\{cluster\}\}, \{\{guestname\}\}, \{\{node\}\}, and \{\{vmid\}\}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.
++
+NOTE: Requires option(s): `storage`
+
+`--performance` `[max-workers=<integer>]` ::
+
+Other performance-related settings.
+
 `--pigz` `<integer>` ('default =' `0`)::
 
 Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
 
+`--pool` `<string>` ::
+
+Backup all known guest systems included in the specified pool.
+
+`--protected` `<boolean>` ::
+
+If true, mark backup(s) as protected.
++
+NOTE: Requires option(s): `storage`
+
+`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ('default =' `keep-all=1`)::
+
+Use these retention options instead of those from the storage configuration.
+
 `--quiet` `<boolean>` ('default =' `0`)::
 
 Be quiet.
 
 `--remove` `<boolean>` ('default =' `1`)::
 
-Remove old backup files if there are more than 'maxfiles' backup files.
+Prune older backups according to 'prune-backups'.
 
 `--script` `<string>` ::
 
 Use specified hook script.
 
-`--size` `<integer> (500 - N)` ('default =' `1024`)::
-
-Unused, will be removed in a future release.
-
 `--stdexcludes` `<boolean>` ('default =' `1`)::
 
 Exclude temporary files and logs.
@@ -104,3 +124,7 @@ Store resulting file to this storage.
 
 Store temporary files to specified directory.
 
+`--zstd` `<integer>` ('default =' `1`)::
+
+Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.
+