Commit b80b8825 authored by Paul John King's avatar Paul John King

Generate README from new documentation

parent 231e5daa
......@@ -14,16 +14,23 @@ The command call
kvm_tool create pool [-x] «name» «path»
creates a directory-type storage pool with the name `«name»` under the path
`«path»`. The `-x` option outputs to standard output the `libvirt` XML
that would be used to create the pool, but does not create it.
tries to create a directory-type storage pool with the name `«name»` under
the path `«path»`. The `-x` option outputs to standard output the
`libvirt` XML that would be used to create the pool, but does not create it.
The command call
kvm_tool examine pool «name»
outputs the path of the storage pool with the name `«name»` as a Bourne-shell
variable assignment (suitable for shell evaluation) and returns
tries to output
POOL_PATH='«path»'
to standard output, where
* `«path»` is the path of the storage pool with the name `«name»`,
and returns
* 0 if the pool exists, and
......@@ -47,7 +54,7 @@ The command call
kvm_tool destroy pool «name»
destroys the storage pool with the name `«name»`.
tries to destroy the storage pool with the name `«name»`.
Volume Commands
---------------
......@@ -56,8 +63,8 @@ The command call
kvm_tool create volume [-x] «name» «pool» «path»
creates a qcow2 storage volume with the name `«name»` in the storage pool
`«pool»` and the qcow2 file-system image at the path `«path»` as its
tries to create a qcow2 storage volume with the name `«name»` in the storage
pool `«pool»` and the qcow2 file-system image at the path `«path»` as its
backing storage volume. The `-x` option outputs to standard output the
`libvirt` XML that would be used to create the volume, but does not create
it.
......@@ -66,9 +73,16 @@ The command call
kvm_tool examine volume «name» «pool»
outputs the path of the backing storage volume of the storage volume with the
name `«name»` in the storage pool `«pool»` as a Bourne-shell variable
assignment (suitable for shell evaluation) and returns
tries to output
VOLUME_PATH='«path»'
to standard output, where
* `«path»` is the path of the backing storage volume of the storage volume
with the name `«name»` in the storage pool `«pool»`,
and returns
* 0 if the volume exists in the pool, and
......@@ -93,20 +107,22 @@ The command call
kvm_tool destroy volume «name» «pool»
destroys the storage volume with the name `«name»` in the storage pool
`«pool»`.
tries to destroy the storage volume with the name `«name»` in the storage
pool `«pool»`.
Domain Commands
---------------
The command call
kvm_tool create domain [-c «connection_1»] ... [-c «connection_n»] [-s] [-a] [-x] «name» «socket_count» «core_count» «thread_count» «ram» «path»
kvm_tool create domain [-c «connection_1»] ... [-c «connection_n»] [-s] [-a] [-x] «name» «socket_count» «core_count» «thread_count» «ram»[«unit»] «path»
creates a KVM domain with the name `«name»`, `«socket_count»` CPU sockets,
`«core_count»` cores per CPU socket, `«thread_count»` threads per core,
`«ram»` MiB of RAM, and the file-system image at the path `«path»`. The
option
`«ram»[«unit»]` RAM, and the file-system image at the path `«path»`, where
`«ram»` is a non-zero natural number and the optional `«unit»` can be any
of `KiB`, `MiB`, `GiB` or `TiB` (defaults to the libvirt default,
currently `KiB`, if not given). The option
-c «bridge»[,«mac_address»]
......@@ -157,13 +173,16 @@ Machine Commands
The command call
kvm_tool create machine [-c «connection_1»] ... [-c «connection_n»] [-s] [-a] [-x] «name» «socket_count» «core_count» «thread_count» «ram» «pool» «path»
kvm_tool create machine [-c «connection_1»] ... [-c «connection_n»] [-s] [-a] [-x] «name» «socket_count» «core_count» «thread_count» «ram»[«unit»] «pool» «path»
creates a KVM domain with the name `«name»`, `«socket_count»` CPU sockets,
`«core_count»` cores per CPU socket, `«thread_count»` threads per core,
`«ram»` MiB of RAM, and a qcow2 storage volume with the name `«name»` in
`«ram»[«unit»]` RAM, and a qcow2 storage volume with the name `«name»` in
the storage pool `«pool»` and the qcow2 file-system image at the path
`«path»` as its backing storage volume. The option
`«path»` as its backing storage volume, where `«ram»` is a non-zero natural
number and the optional `«unit»` can be any of `KiB`, `MiB`, `GiB` or
`TiB` (defaults to the libvirt default, currently `KiB`, if not given).
The option
-c «bridge»[,«ipv4_address»]
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment