aboutsummaryrefslogtreecommitdiff
path: root/qemu-img-cmds.hx
diff options
context:
space:
mode:
authorStuart Brady <sdbrady@ntlworld.com>2009-06-07 00:42:17 +0100
committerBlue Swirl <blauwirbel@gmail.com>2009-06-07 09:59:47 +0300
commit153859be1a0928d07ec2dc2b18847e32e180ff43 (patch)
tree6b9930fd56402c253a663d55b65c1ef368e218ef /qemu-img-cmds.hx
parent3a2eeac0c9033e30b19d88465c9561f982e9e6d0 (diff)
Use hxtool for qemu-img command list
Use hxtool to generate the 'command syntax' section of qemu-img's help message, and the corresponding section of the texinfo documentation. This has the side-effect of adding 'check' to this list of commands in the texinfo documentation. Signed-off-by: Stuart Brady <stuart.brady@gmail.com>
Diffstat (limited to 'qemu-img-cmds.hx')
-rw-r--r--qemu-img-cmds.hx47
1 files changed, 47 insertions, 0 deletions
diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
new file mode 100644
index 0000000000..ddb86f0487
--- /dev/null
+++ b/qemu-img-cmds.hx
@@ -0,0 +1,47 @@
+HXCOMM Use DEFHEADING() to define headings in both help text and texi
+HXCOMM Text between STEXI and ETEXI are copied to texi version and
+HXCOMM discarded from C version
+HXCOMM DEF(command, callback, arg_string) is used to construct
+HXCOMM command structures and help message.
+HXCOMM HXCOMM can be used for comments, discarded from both texi and C
+
+STEXI
+@table @option
+STEXI
+
+DEF("check", img_check,
+ "check [-f fmt] filename")
+STEXI
+@item check [-f @var{fmt}] @var{filename}
+ETEXI
+
+DEF("create", img_create,
+ "create [-F fmt] [-b base_image] [-f fmt] [-o options] filename [size]")
+STEXI
+@item create [-F @var{base_fmt}] [-b @var{base_image}] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
+ETEXI
+
+DEF("commit", img_commit,
+ "commit [-f fmt] filename")
+STEXI
+@item commit [-f @var{fmt}] @var{filename}
+ETEXI
+
+DEF("convert", img_convert,
+ "convert [-c] [-f fmt] [-O output_fmt] [-o options] [-B output_base_image] filename [filename2 [...]] output_filename")
+STEXI
+@item convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] [-B @var{output_base_image}] @var{filename} [@var{filename2} [...]] @var{output_filename}
+ETEXI
+
+DEF("info", img_info,
+ "info [-f fmt] filename")
+STEXI
+@item info [-f @var{fmt}] @var{filename}
+ETEXI
+
+DEF("snapshot", img_snapshot,
+ "snapshot [-l | -a snapshot | -c snapshot | -d snapshot] filename")
+STEXI
+@item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
+@end table
+ETEXI