improve package description

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

diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc
index 09147c3b508692b410840a94a851ba482cc68904..8f9fce806ef2dc21038fce9500118cc37523fb6f 100644 (file)
--- a/vzdump.1-synopsis.adoc
+++ b/vzdump.1-synopsis.adoc
@@ -6,17 +6,17 @@ Create backup.
 
 `<vmid>` `string` ::
 
-The ID of the VM you want to backup.
+The ID of the guest system you want to backup.
 
 `-all` `boolean` (default=`0`)::
 
-Backup all known VMs on this host.
+Backup all known guest systems on this host.
 
-`-bwlimit` `integer (0 - N)` ::
+`-bwlimit` `integer (0 - N)` (default=`0`)::
 
 Limit I/O bandwidth (KBytes per second).
 
-`-compress` `(0 | 1 | gzip | lzo)` (default=`lzo`)::
+`-compress` `(0 | 1 | gzip | lzo)` (default=`0`)::
 
 Compress dump file.
 
@@ -26,17 +26,17 @@ Store resulting files to specified directory.
 
 `-exclude` `string` ::
 
-exclude specified VMs (assumes --all)
+Exclude specified guest systems (assumes --all)
 
 `-exclude-path` `string` ::
 
-exclude certain files/directories (shell globs).
+Exclude certain files/directories (shell globs).
 
-`-ionice` `integer (0 - 8)` ::
+`-ionice` `integer (0 - 8)` (default=`7`)::
 
 Set CFQ ionice priority.
 
-`-lockwait` `integer (0 - N)` ::
+`-lockwait` `integer (0 - N)` (default=`180`)::
 
 Maximal time to wait for the global lock (minutes).
 
@@ -46,13 +46,13 @@ Specify when to send an email
 
 `-mailto` `string` ::
 
-no description available
+Comma-separated list of email addresses that should receive email notifications.
 
-`-maxfiles` `integer (1 - N)` ::
+`-maxfiles` `integer (1 - N)` (default=`1`)::
 
-Maximal number of backup files per VM.
+Maximal number of backup files per guest system.
 
-`-mode` `(snapshot | stop | suspend)` (default=`stop`)::
+`-mode` `(snapshot | stop | suspend)` (default=`snapshot`)::
 
 Backup mode.
 
@@ -62,8 +62,7 @@ Only run if executed on this node.
 
 `-pigz` `integer` (default=`0`)::
 
-Uses pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as
-thread count.
+Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
 
 `-quiet` `boolean` (default=`0`)::
 
@@ -77,13 +76,13 @@ Remove old backup files if there are more than 'maxfiles' backup files.
 
 Use specified hook script.
 
-`-size` `integer (500 - N)` ::
+`-size` `integer (500 - N)` (default=`1024`)::
 
-LVM snapshot size in MB.
+Unused, will be removed in a future release.
 
 `-stdexcludes` `boolean` (default=`1`)::
 
-Exclude temorary files and logs.
+Exclude temporary files and logs.
 
 `-stdout` `boolean` ::
 
@@ -93,9 +92,9 @@ Write tar to stdout, not to a file.
 
 Stop runnig backup jobs on this host.
 
-`-stopwait` `integer (0 - N)` ::
+`-stopwait` `integer (0 - N)` (default=`10`)::
 
-Maximal time to wait until a VM is stopped (minutes).
+Maximal time to wait until a guest system is stopped (minutes).
 
 `-storage` `string` ::