update generated docs
[pve-docs.git] / vzdump.1-synopsis.adoc
index 8f9fce8..39600b2 100644 (file)
 
 Create backup.
 
-`<vmid>` `string` ::
+`<vmid>`: `<string>` ::
 
 The ID of the guest system you want to backup.
 
-`-all` `boolean` (default=`0`)::
+`-all` `<boolean>` ('default =' `0`)::
 
 Backup all known guest systems on this host.
 
-`-bwlimit` `integer (0 - N)` (default=`0`)::
+`-bwlimit` `<integer> (0 - N)` ('default =' `0`)::
 
 Limit I/O bandwidth (KBytes per second).
 
-`-compress` `(0 | 1 | gzip | lzo)` (default=`0`)::
+`-compress` `<0 | 1 | gzip | lzo>` ('default =' `0`)::
 
 Compress dump file.
 
-`-dumpdir` `string` ::
+`-dumpdir` `<string>` ::
 
 Store resulting files to specified directory.
 
-`-exclude` `string` ::
+`-exclude` `<string>` ::
 
 Exclude specified guest systems (assumes --all)
 
-`-exclude-path` `string` ::
+`-exclude-path` `<string>` ::
 
 Exclude certain files/directories (shell globs).
 
-`-ionice` `integer (0 - 8)` (default=`7`)::
+`-ionice` `<integer> (0 - 8)` ('default =' `7`)::
 
 Set CFQ ionice priority.
 
-`-lockwait` `integer (0 - N)` (default=`180`)::
+`-lockwait` `<integer> (0 - N)` ('default =' `180`)::
 
 Maximal time to wait for the global lock (minutes).
 
-`-mailnotification` `(always | failure)` (default=`always`)::
+`-mailnotification` `<always | failure>` ('default =' `always`)::
 
 Specify when to send an email
 
-`-mailto` `string` ::
+`-mailto` `<string>` ::
 
 Comma-separated list of email addresses that should receive email notifications.
 
-`-maxfiles` `integer (1 - N)` (default=`1`)::
+`-maxfiles` `<integer> (1 - N)` ('default =' `1`)::
 
 Maximal number of backup files per guest system.
 
-`-mode` `(snapshot | stop | suspend)` (default=`snapshot`)::
+`-mode` `<snapshot | stop | suspend>` ('default =' `snapshot`)::
 
 Backup mode.
 
-`-node` `string` ::
+`-node` `<string>` ::
 
 Only run if executed on this node.
 
-`-pigz` `integer` (default=`0`)::
+`-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.
 
-`-quiet` `boolean` (default=`0`)::
+`-quiet` `<boolean>` ('default =' `0`)::
 
 Be quiet.
 
-`-remove` `boolean` (default=`1`)::
+`-remove` `<boolean>` ('default =' `1`)::
 
 Remove old backup files if there are more than 'maxfiles' backup files.
 
-`-script` `string` ::
+`-script` `<string>` ::
 
 Use specified hook script.
 
-`-size` `integer (500 - N)` (default=`1024`)::
+`-size` `<integer> (500 - N)` ('default =' `1024`)::
 
 Unused, will be removed in a future release.
 
-`-stdexcludes` `boolean` (default=`1`)::
+`-stdexcludes` `<boolean>` ('default =' `1`)::
 
 Exclude temporary files and logs.
 
-`-stdout` `boolean` ::
+`-stdout` `<boolean>` ::
 
 Write tar to stdout, not to a file.
 
-`-stop` `boolean` (default=`0`)::
+`-stop` `<boolean>` ('default =' `0`)::
 
 Stop runnig backup jobs on this host.
 
-`-stopwait` `integer (0 - N)` (default=`10`)::
+`-stopwait` `<integer> (0 - N)` ('default =' `10`)::
 
 Maximal time to wait until a guest system is stopped (minutes).
 
-`-storage` `string` ::
+`-storage` `<string>` ::
 
 Store resulting file to this storage.
 
-`-tmpdir` `string` ::
+`-tmpdir` `<string>` ::
 
 Store temporary files to specified directory.