asciidoc-pve.in: add code to auto generate online help data

[pve-docs.git] / vzdump.adoc

diff --git a/vzdump.adoc b/vzdump.adoc
index 5341200652823ddc4dc6d3802b577f231e526adb..62b848022000c60e167812889ec7bae1678f6961 100644 (file)
--- a/vzdump.adoc
+++ b/vzdump.adoc
@@ -1,7 +1,9 @@
+[[chapter_vzdump]]
 ifdef::manvolnum[]
-PVE({manvolnum})
-================
+vzdump(1)
+=========
 include::attributes.txt[]
+:pve-toplevel:
 
 NAME
 ----
@@ -9,7 +11,7 @@ NAME
 vzdump - Backup Utility for VMs and Containers 
 
 
-SYNOPSYS
+SYNOPSIS
 --------
 
 include::vzdump.1-synopsis.adoc[]
@@ -18,12 +20,14 @@ include::vzdump.1-synopsis.adoc[]
 DESCRIPTION
 -----------
 endif::manvolnum[]
-
 ifndef::manvolnum[]
 Backup and Restore
 ==================
 include::attributes.txt[]
 endif::manvolnum[]
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
 
 Backups are a requirements for any sensible IT deployment, and {pve}
 provides a fully integrated solution, using the capabilities of each
@@ -80,7 +84,7 @@ This mode provides the lowest operation downtime, at the cost of a
 small inconstancy risk.  It works by performing a Proxmox VE live
 backup, in which data blocks are copied while the VM is running. If the
 guest agent is enabled (`agent: 1`) and running, it calls
-'guest-fsfreeze-freeze' and 'guest-fsfreeze-thaw' to improve
+`guest-fsfreeze-freeze` and `guest-fsfreeze-thaw` to improve
 consistency.
 
 A technical overview of the Proxmox VE live backup for QemuServer can
@@ -106,9 +110,9 @@ a second rsync copies changed files. After that, the container is
 started (resumed) again. This results in minimal downtime, but needs
 additional space to hold the container copy.
 +
-When the container is on a local filesystem and the target storage of
+When the container is on a local file system and the target storage of
 the backup is an NFS server, you should set `--tmpdir` to reside on a
-local filesystem too, as this will result in a many fold performance
+local file system too, as this will result in a many fold performance
 improvement.  Use of a local `tmpdir` is also required if you want to
 backup a local container using ACLs in suspend mode if the backup
 storage is an NFS server.
@@ -122,11 +126,11 @@ snapshot content will be archived in a tar file. Finally, the temporary
 snapshot is deleted again.
 
 NOTE: `snapshot` mode requires that all backed up volumes are on a storage that
-supports snapshots. Using the `backup=no` mountpoint option individual volumes
+supports snapshots. Using the `backup=no` mount point option individual volumes
 can be excluded from the backup (and thus this requirement).
 
-NOTE: bind and device mountpoints are skipped during backup operations, like
-volume mountpoints with the backup option disabled.
+NOTE: bind and device mount points are skipped during backup operations, like
+volume mount points with the backup option disabled.
 
 
 Backup File Names
@@ -156,13 +160,13 @@ For details see the corresponding manual pages.
 Configuration
 -------------
 
-Global configuration is stored in '/etc/vzdump.conf'. The file uses a
+Global configuration is stored in `/etc/vzdump.conf`. The file uses a
 simple colon separated key/value format. Each line has the following
 format:
 
  OPTION: value
 
-Blank lines in the file are ignored, and lines starting with a '#'
+Blank lines in the file are ignored, and lines starting with a `#`
 character are treated as comments and are also ignored. Values from
 this file are used as default, and can be overwritten on the command
 line.
@@ -172,7 +176,7 @@ We currently support the following options:
 include::vzdump.conf.5-opts.adoc[]
 
 
-.Example 'vzdump.conf' Configuration
+.Example `vzdump.conf` Configuration
 ----
 tmpdir: /mnt/fast_local_disk
 storage: my_backup_storage
@@ -186,14 +190,14 @@ Hook Scripts
 You can specify a hook script with option `--script`. This script is
 called at various phases of the backup process, with parameters
 accordingly set. You can find an example in the documentation
-directory ('vzdump-hook-script.pl').
+directory (`vzdump-hook-script.pl`).
 
 File Exclusions
 ---------------
 
 NOTE: this option is only available for container backups.
 
-'vzdump' skips the following files by default (disable with the option
+`vzdump` skips the following files by default (disable with the option
 `--stdexcludes 0`)
 
  /tmp/?*
@@ -214,7 +218,7 @@ Examples
 
 Simply dump guest 777 - no snapshot, just archive the guest private area and
 configuration files to the default dump directory (usually
-'/var/lib/vz/dump/').
+`/var/lib/vz/dump/`).
 
  # vzdump 777