選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

qemu-ga.texi 3.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. @example
  2. @c man begin SYNOPSIS
  3. @command{qemu-ga} [@var{OPTIONS}]
  4. @c man end
  5. @end example
  6. @c man begin DESCRIPTION
  7. The QEMU Guest Agent is a daemon intended to be run within virtual
  8. machines. It allows the hypervisor host to perform various operations
  9. in the guest, such as:
  10. @itemize
  11. @item
  12. get information from the guest
  13. @item
  14. set the guest's system time
  15. @item
  16. read/write a file
  17. @item
  18. sync and freeze the filesystems
  19. @item
  20. suspend the guest
  21. @item
  22. reconfigure guest local processors
  23. @item
  24. set user's password
  25. @item
  26. ...
  27. @end itemize
  28. qemu-ga will read a system configuration file on startup (located at
  29. @file{@value{CONFDIR}/qemu-ga.conf} by default), then parse remaining
  30. configuration options on the command line. For the same key, the last
  31. option wins, but the lists accumulate (see below for configuration
  32. file format).
  33. @c man end
  34. @c man begin OPTIONS
  35. @table @option
  36. @item -m, --method=@var{method}
  37. Transport method: one of @samp{unix-listen}, @samp{virtio-serial}, or
  38. @samp{isa-serial} (@samp{virtio-serial} is the default).
  39. @item -p, --path=@var{path}
  40. Device/socket path (the default for virtio-serial is
  41. @samp{/dev/virtio-ports/org.qemu.guest_agent.0},
  42. the default for isa-serial is @samp{/dev/ttyS0})
  43. @item -l, --logfile=@var{path}
  44. Set log file path (default is stderr).
  45. @item -f, --pidfile=@var{path}
  46. Specify pid file (default is @samp{/var/run/qemu-ga.pid}).
  47. @item -F, --fsfreeze-hook=@var{path}
  48. Enable fsfreeze hook. Accepts an optional argument that specifies
  49. script to run on freeze/thaw. Script will be called with
  50. 'freeze'/'thaw' arguments accordingly (default is
  51. @samp{@value{CONFDIR}/fsfreeze-hook}). If using -F with an argument, do
  52. not follow -F with a space (for example:
  53. @samp{-F/var/run/fsfreezehook.sh}).
  54. @item -t, --statedir=@var{path}
  55. Specify the directory to store state information (absolute paths only,
  56. default is @samp{/var/run}).
  57. @item -v, --verbose
  58. Log extra debugging information.
  59. @item -V, --version
  60. Print version information and exit.
  61. @item -d, --daemon
  62. Daemonize after startup (detach from terminal).
  63. @item -b, --blacklist=@var{list}
  64. Comma-separated list of RPCs to disable (no spaces, @samp{?} to list
  65. available RPCs).
  66. @item -D, --dump-conf
  67. Dump the configuration in a format compatible with @file{qemu-ga.conf}
  68. and exit.
  69. @item -h, --help
  70. Display this help and exit.
  71. @end table
  72. @c man end
  73. @c man begin FILES
  74. The syntax of the @file{qemu-ga.conf} configuration file follows the
  75. Desktop Entry Specification, here is a quick summary: it consists of
  76. groups of key-value pairs, interspersed with comments.
  77. @example
  78. # qemu-ga configuration sample
  79. [general]
  80. daemonize = 0
  81. pidfile = /var/run/qemu-ga.pid
  82. verbose = 0
  83. method = virtio-serial
  84. path = /dev/virtio-ports/org.qemu.guest_agent.0
  85. statedir = /var/run
  86. @end example
  87. The list of keys follows the command line options:
  88. @table @option
  89. @item daemon= boolean
  90. @item method= string
  91. @item path= string
  92. @item logfile= string
  93. @item pidfile= string
  94. @item fsfreeze-hook= string
  95. @item statedir= string
  96. @item verbose= boolean
  97. @item blacklist= string list
  98. @end table
  99. @c man end
  100. @ignore
  101. @setfilename qemu-ga
  102. @settitle QEMU Guest Agent
  103. @c man begin AUTHOR
  104. Michael Roth <mdroth@linux.vnet.ibm.com>
  105. @c man end
  106. @c man begin SEEALSO
  107. qemu(1)
  108. @c man end
  109. @end ignore