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

[pve-docs.git] / pve-storage-dir.adoc

diff --git a/pve-storage-dir.adoc b/pve-storage-dir.adoc
index acfe7c66811b57a78d5f277315d9a8a64815168d..a5084f88cff70851bb1513648986c586be62f5e6 100644 (file)
--- a/pve-storage-dir.adoc
+++ b/pve-storage-dir.adoc
@@ -1,5 +1,10 @@
 Directory Backend
 -----------------
+include::attributes.txt[]
+ifdef::wiki[]
+:pve-toplevel:
+:title: Storage: Directory
+endif::wiki[]
 
 Storage pool type: `dir`
 
@@ -8,34 +13,35 @@ storage. A directory is a file level storage, so you can store any
 content type like virtual disk images, containers, templates, ISO images
 or backup files.
 
-NOTE: You can mount additional storages via standard linux '/etc/fstab',
+NOTE: You can mount additional storages via standard linux `/etc/fstab`,
 and then define a directory storage for that mount point. This way you
 can use any file system supported by Linux.
 
 This backend assumes that the underlying directory is POSIX
 compatible, but nothing else. This implies that you cannot create
-snapshots at the storage level. But there exists a woraround for VM
+snapshots at the storage level. But there exists a workaround for VM
 images using the `qcow2` file format, because that format supports
 snapshots internally.
 
-TIP: Some storage types does not support `O_DIRECT`, so you can't use
+TIP: Some storage types do not support `O_DIRECT`, so you can't use
 cache mode `none` with such storages. Simply use cache mode
 `writeback` instead.
 
 We use a predefined directory layout to store different content types
-into different sub-directories. This layout is use by all file level
+into different sub-directories. This layout is used by all file level
 storage backends.
 
 .Directory layout
 [width="100%",cols="d,m",options="header"]
 |===========================================================
 |Content type        |Subdir
-|VM images           |images/<VMID>/
-|ISO images          |template/iso/
-|Container templates |template/cache
-|Backup files        |dump/
+|VM images           |`images/<VMID>/`
+|ISO images          |`template/iso/`
+|Container templates |`template/cache/`
+|Backup files        |`dump/`
 |===========================================================
 
+
 Configuration
 ~~~~~~~~~~~~~
 
@@ -43,7 +49,7 @@ This backend supports all common storage properties, and adds an
 additional property called `path` to specify the directory. This
 needs to be an absolute file system path.
 
-.Configuration Example ('/etc/pve/storage.cfg')
+.Configuration Example (`/etc/pve/storage.cfg`)
 ----
 dir: backup
         path /mnt/backup
@@ -53,7 +59,7 @@ dir: backup
 
 Above configuration defines a storage pool called `backup`. That pool
 can be used to store up to 7 backups (`maxfiles 7`) per VM. The real
-path for the backup files is '/mnt/backup/dump/...'.
+path for the backup files is `/mnt/backup/dump/...`.
 
 
 File naming conventions
@@ -69,28 +75,29 @@ This specifies the owner VM.
 
 `<NAME>`::
 
-This scan be an arbitrary name (`ascii`) without white spaces. The
-backend uses `disk[N]` as default, where `[N]` is replaced by an
+This can be an arbitrary name (`ascii`) without white space. The
+backend uses `disk-[N]` as default, where `[N]` is replaced by an
 integer to make the name unique.
 
 `<FORMAT>`::
 
-Species the image format (`raw|qcow2|vmdk`).
+Specifies the image format (`raw|qcow2|vmdk`).
 
 When you create a VM template, all VM images are renamed to indicate
-that they are now read-only, and can be uses as base image for clones:
+that they are now read-only, and can be used as a base image for clones:
 
  base-<VMID>-<NAME>.<FORMAT>
 
 NOTE: Such base images are used to generate cloned images. So it is
-important that those files are read-only, and never gets modified. The
-backend changes access mode to `0444`, and sets the immutable flag
+important that those files are read-only, and never get modified. The
+backend changes the access mode to `0444`, and sets the immutable flag
 (`chattr +i`) if the storage supports that.
 
+
 Storage Features
 ~~~~~~~~~~~~~~~~
 
-As mentioned above, most file systems does not support snapshots out
+As mentioned above, most file systems do not support snapshots out
 of the box. To workaround that problem, this backend is able to use
 `qcow2` internal snapshot capabilities.
 
@@ -112,7 +119,7 @@ Please use the following command to allocate a 4GB image on storage `local`:
 
  # pvesm alloc local 100 vm-100-disk10.raw 4G
  Formatting '/var/lib/vz/images/100/vm-100-disk10.raw', fmt=raw size=4294967296
- sucessfuly created 'local:100/vm-100-disk10.raw'
+ successfully created 'local:100/vm-100-disk10.raw'
 
 NOTE: The image name must conform to above naming conventions.
 
@@ -125,3 +132,14 @@ And you can remove the image with:
 
  # pvesm free local:100/vm-100-disk10.raw
 
+
+ifdef::wiki[]
+
+See Also
+~~~~~~~~
+
+* link:/wiki/Storage[Storage]
+
+endif::wiki[]
+
+