qemu-img-cmds.hx 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. HXCOMM Use DEFHEADING() to define headings in both help text and texi
  2. HXCOMM Text between STEXI and ETEXI are copied to texi version and
  3. HXCOMM discarded from C version
  4. HXCOMM DEF(command, callback, arg_string) is used to construct
  5. HXCOMM command structures and help message.
  6. HXCOMM HXCOMM can be used for comments, discarded from both texi and C
  7. STEXI
  8. @table @option
  9. ETEXI
  10. DEF("check", img_check,
  11. "check [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] filename")
  12. STEXI
  13. @item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] @var{filename}
  14. ETEXI
  15. DEF("create", img_create,
  16. "create [-q] [-f fmt] [-o options] filename [size]")
  17. STEXI
  18. @item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
  19. ETEXI
  20. DEF("commit", img_commit,
  21. "commit [-q] [-f fmt] [-t cache] filename")
  22. STEXI
  23. @item commit [-q] [-f @var{fmt}] [-t @var{cache}] @var{filename}
  24. ETEXI
  25. DEF("compare", img_compare,
  26. "compare [-f fmt] [-F fmt] [-p] [-q] [-s] filename1 filename2")
  27. STEXI
  28. @item compare [-f @var{fmt}] [-F @var{fmt}] [-p] [-q] [-s] @var{filename1} @var{filename2}
  29. ETEXI
  30. DEF("convert", img_convert,
  31. "convert [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] filename [filename2 [...]] output_filename")
  32. STEXI
  33. @item convert [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
  34. ETEXI
  35. DEF("info", img_info,
  36. "info [-f fmt] [--output=ofmt] [--backing-chain] filename")
  37. STEXI
  38. @item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
  39. ETEXI
  40. DEF("map", img_map,
  41. "map [-f fmt] [--output=ofmt] filename")
  42. STEXI
  43. @item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
  44. ETEXI
  45. DEF("snapshot", img_snapshot,
  46. "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
  47. STEXI
  48. @item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
  49. ETEXI
  50. DEF("rebase", img_rebase,
  51. "rebase [-q] [-f fmt] [-t cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
  52. STEXI
  53. @item rebase [-q] [-f @var{fmt}] [-t @var{cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
  54. ETEXI
  55. DEF("resize", img_resize,
  56. "resize [-q] filename [+ | -]size")
  57. STEXI
  58. @item resize [-q] @var{filename} [+ | -]@var{size}
  59. ETEXI
  60. DEF("amend", img_amend,
  61. "amend [-q] [-f fmt] -o options filename")
  62. STEXI
  63. @item amend [-q] [-f @var{fmt}] -o @var{options} @var{filename}
  64. @end table
  65. ETEXI