aboutsummaryrefslogtreecommitdiff
path: root/qemu-ga.texi
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2015-09-01 19:42:43 +0100
committerPeter Maydell <peter.maydell@linaro.org>2015-09-01 19:42:43 +0100
commitf8b8091d2779d956011a3fb83ff60dbf7465c71d (patch)
tree239eee827c9258cfb41dd00682ed8af72683947c /qemu-ga.texi
parent090d0bfd948343d522cd20bc634105b5cfe2483b (diff)
parent15b19ed85fb5464b736ef0ece1edce194de2194a (diff)
downloadqemu-f8b8091d2779d956011a3fb83ff60dbf7465c71d.zip
qemu-f8b8091d2779d956011a3fb83ff60dbf7465c71d.tar.gz
qemu-f8b8091d2779d956011a3fb83ff60dbf7465c71d.tar.bz2
Merge remote-tracking branch 'remotes/mdroth/tags/qga-pull-2015-09-01-v2-tag' into staging
qemu-ga patch queue * add config file dump/load support for qemu-ga * various w32 build fixes, particularly WRT to msi package creation * fixes for msi installer * w32 support for guest-set-user-password v2: * replaced g_list_free_full with g_list_foreach to maintain glib 2.22 compatibility # gpg: Signature made Tue 01 Sep 2015 19:34:15 BST using RSA key ID F108B584 # gpg: Good signature from "Michael Roth <flukshun@gmail.com>" # gpg: aka "Michael Roth <mdroth@utexas.edu>" # gpg: aka "Michael Roth <mdroth@linux.vnet.ibm.com>" * remotes/mdroth/tags/qga-pull-2015-09-01-v2-tag: (26 commits) Makefile: qemu-ga: fix msi target error message build: qemu-ga: fix VSS dependencies configure: qemu-ga: explicitly enable qemu-ga MSI support when probed configure: qemu-ga: move MSI installer probe after qga probe qemu-ga: implement win32 guest-set-user-password qga: start a man page qga: add --dump-conf option qga: add an optional qemu-ga.conf system configuration qga: free a bit more qga: move agent run in a separate function qga: fill default options in main() qga: move option parsing to separate function qga: copy argument strings qga: rename 'path' to 'channel_path' qga: make split_list() return allocated strings qga: move string split in separate function qga: use exit() when parsing options qga: misc spelling configure: qemu-ga: report MSI install support in summary qemu-ga: Fixed paths issue with MSI build ... Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'qemu-ga.texi')
-rw-r--r--qemu-ga.texi137
1 files changed, 137 insertions, 0 deletions
diff --git a/qemu-ga.texi b/qemu-ga.texi
new file mode 100644
index 0000000..536a9b5
--- /dev/null
+++ b/qemu-ga.texi
@@ -0,0 +1,137 @@
+@example
+@c man begin SYNOPSIS
+usage: qemu-ga [OPTIONS]
+@c man end
+@end example
+
+@c man begin DESCRIPTION
+
+The QEMU Guest Agent is a daemon intended to be run within virtual
+machines. It allows the hypervisor host to perform various operations
+in the guest, such as:
+
+@itemize
+@item
+get information from the guest
+@item
+set the guest's system time
+@item
+read/write a file
+@item
+sync and freeze the filesystems
+@item
+suspend the guest
+@item
+reconfigure guest local processors
+@item
+set user's password
+@item
+...
+@end itemize
+
+qemu-ga will read a system configuration file on startup (located at
+q@file{/etc/qemu/qemu-ga.conf} by default), then parse remaining
+configuration options on the command line. For the same key, the last
+option wins, but the lists accumulate (see below for configuration
+file format).
+
+@c man end
+
+@c man begin OPTIONS
+@table @option
+@item -m, --method=@var{method}
+ Transport method: one of @samp{unix-listen}, @samp{virtio-serial}, or
+ @samp{isa-serial} (@samp{virtio-serial} is the default).
+
+@item -p, --path=@var{path}
+ Device/socket path (the default for virtio-serial is
+ @samp{/dev/virtio-ports/org.qemu.guest_agent.0},
+ the default for isa-serial is @samp{/dev/ttyS0})
+
+@item -l, --logfile=@var{path}
+ Set log file path (default is stderr).
+
+@item -f, --pidfile=@var{path}
+ Specify pid file (default is @samp{/var/run/qemu-ga.pid}).
+
+@item -F, --fsfreeze-hook=@var{path}
+ Enable fsfreeze hook. Accepts an optional argument that specifies
+ script to run on freeze/thaw. Script will be called with
+ 'freeze'/'thaw' arguments accordingly (default is
+ @samp{/etc/qemu/fsfreeze-hook}). If using -F with an argument, do
+ not follow -F with a space (for example:
+ @samp{-F/var/run/fsfreezehook.sh}).
+
+@item -t, --statedir=@var{path}
+ Specify the directory to store state information (absolute paths only,
+ default is @samp{/var/run}).
+
+@item -v, --verbose
+ Log extra debugging information.
+
+@item -V, --version
+ Print version information and exit.
+
+@item -d, --daemon
+ Daemonize after startup (detach from terminal).
+
+@item -b, --blacklist=@var{list}
+ Comma-separated list of RPCs to disable (no spaces, @samp{?} to list
+ available RPCs).
+
+@item -D, --dump-conf
+ Dump the configuration in a format compatible with @file{qemu-ga.conf}
+ and exit.
+
+@item -h, --help
+ Display this help and exit.
+@end table
+
+@c man end
+
+@c man begin FILES
+
+The syntax of the @file{qemu-ga.conf} configuration file follows the
+Desktop Entry Specification, here is a quick summary: it consists of
+groups of key-value pairs, interspersed with comments.
+
+@example
+# qemu-ga configuration sample
+[general]
+daemonize = 0
+pidfile = /var/run/qemu-ga.pid
+verbose = 0
+method = virtio-serial
+path = /dev/virtio-ports/org.qemu.guest_agent.0
+statedir = /var/run
+@end example
+
+The list of keys follows the command line options:
+@table @option
+@item daemon= boolean
+@item method= string
+@item path= string
+@item logfile= string
+@item pidfile= string
+@item fsfreeze-hook= string
+@item statedir= string
+@item verbose= boolean
+@item blacklist= string list
+@end table
+
+@c man end
+
+@ignore
+
+@setfilename qemu-ga
+@settitle QEMU Guest Agent
+
+@c man begin AUTHOR
+Michael Roth <mdroth@linux.vnet.ibm.com>
+@c man end
+
+@c man begin SEEALSO
+qemu(1)
+@c man end
+
+@end ignore