From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:55053) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZUNST-0002Y2-8J for qemu-devel@nongnu.org; Tue, 25 Aug 2015 19:16:50 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZUNSP-00037r-VA for qemu-devel@nongnu.org; Tue, 25 Aug 2015 19:16:49 -0400 Received: from e36.co.us.ibm.com ([32.97.110.154]:53860) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZUNSP-00037N-LG for qemu-devel@nongnu.org; Tue, 25 Aug 2015 19:16:45 -0400 Received: from /spool/local by e36.co.us.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Tue, 25 Aug 2015 17:16:44 -0600 Received: from b03cxnp08027.gho.boulder.ibm.com (b03cxnp08027.gho.boulder.ibm.com [9.17.130.19]) by d03dlp01.boulder.ibm.com (Postfix) with ESMTP id 2BAC21FF0045 for ; Tue, 25 Aug 2015 17:07:52 -0600 (MDT) Received: from d03av03.boulder.ibm.com (d03av03.boulder.ibm.com [9.17.195.169]) by b03cxnp08027.gho.boulder.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id t7PNGgtT42795086 for ; Tue, 25 Aug 2015 16:16:42 -0700 Received: from d03av03.boulder.ibm.com (localhost [127.0.0.1]) by d03av03.boulder.ibm.com (8.14.4/8.14.4/NCO v10.0 AVout) with ESMTP id t7PNGgxk002021 for ; Tue, 25 Aug 2015 17:16:42 -0600 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Michael Roth In-Reply-To: <1440540624-7998-13-git-send-email-marcandre.lureau@redhat.com> References: <1440540624-7998-1-git-send-email-marcandre.lureau@redhat.com> <1440540624-7998-13-git-send-email-marcandre.lureau@redhat.com> Message-ID: <20150825231640.11069.19306@loki> Date: Tue, 25 Aug 2015 18:16:40 -0500 Subject: Re: [Qemu-devel] [PATCH v2 12/12] qga: start a man page List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: marcandre.lureau@redhat.com, qemu-devel@nongnu.org Quoting marcandre.lureau@redhat.com (2015-08-25 17:10:24) > From: Marc-Andr=C3=A9 Lureau > = > Add a simple man page for the qemu agent. > = > Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: Michael Roth > --- > Makefile | 14 +++++- > qemu-doc.texi | 6 +++ > qemu-ga.texi | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++++= ++++++ > 3 files changed, 154 insertions(+), 2 deletions(-) > create mode 100644 qemu-ga.texi > = > diff --git a/Makefile b/Makefile > index 340d9c8..67d44b8 100644 > --- a/Makefile > +++ b/Makefile > @@ -88,7 +88,8 @@ LIBS+=3D-lz $(LIBS_TOOLS) > HELPERS-$(CONFIG_LINUX) =3D qemu-bridge-helper$(EXESUF) > = > ifdef BUILD_DOCS > -DOCS=3Dqemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 qmp-com= mands.txt > +DOCS=3Dqemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga= .8 > +DOCS+=3Dqmp-commands.txt > ifdef CONFIG_LINUX > DOCS+=3Dkvm_stat.1 > endif > @@ -400,6 +401,9 @@ ifneq ($(TOOLS),) > $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8" > $(INSTALL_DATA) qemu-nbd.8 "$(DESTDIR)$(mandir)/man8" > endif > +ifneq (,$(findstring qemu-ga,$(TOOLS))) > + $(INSTALL_DATA) qemu-ga.8 "$(DESTDIR)$(mandir)/man8" > +endif > endif > ifdef CONFIG_VIRTFS > $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1" > @@ -538,6 +542,12 @@ qemu-nbd.8: qemu-nbd.texi > $(POD2MAN) --section=3D8 --center=3D" " --release=3D" " qemu-nb= d.pod > $@, \ > " GEN $@") > = > +qemu-ga.8: qemu-ga.texi > + $(call quiet-command, \ > + perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu-ga.pod && \ > + $(POD2MAN) --section=3D8 --center=3D" " --release=3D" " qemu-ga= .pod > $@, \ > + " GEN $@") > + > kvm_stat.1: scripts/kvm/kvm_stat.texi > $(call quiet-command, \ > perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< kvm_stat.pod && \ > @@ -551,7 +561,7 @@ pdf: qemu-doc.pdf qemu-tech.pdf > = > qemu-doc.dvi qemu-doc.html qemu-doc.info qemu-doc.pdf: \ > qemu-img.texi qemu-nbd.texi qemu-options.texi \ > - qemu-monitor.texi qemu-img-cmds.texi > + qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi > = > ifdef CONFIG_WIN32 > = > diff --git a/qemu-doc.texi b/qemu-doc.texi > index 94af8c0..84d17d1 100644 > --- a/qemu-doc.texi > +++ b/qemu-doc.texi > @@ -412,6 +412,7 @@ snapshots. > * vm_snapshots:: VM snapshots > * qemu_img_invocation:: qemu-img Invocation > * qemu_nbd_invocation:: qemu-nbd Invocation > +* qemu_ga_invocation:: qemu-ga Invocation > * disk_images_formats:: Disk image file formats > * host_drives:: Using host drives > * disk_images_fat_images:: Virtual FAT disk images > @@ -505,6 +506,11 @@ state is not saved or restored properly (in particul= ar USB). > = > @include qemu-nbd.texi > = > +@node qemu_ga_invocation > +@subsection @code{qemu-ga} Invocation > + > +@include qemu-ga.texi > + > @node disk_images_formats > @subsection Disk image file formats > = > diff --git a/qemu-ga.texi b/qemu-ga.texi > new file mode 100644 > index 0000000..7d4a628 > --- /dev/null > +++ b/qemu-ga.texi > @@ -0,0 +1,136 @@ > +@example > +@c man begin SYNOPSIS > +usage: qemu-ga [-m -p ] [OPTION]... > +@c man end > +@end example > + > +@c man begin DESCRIPTION > + > +The QEMU Guest Agent is a deamon that allows the 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=3D@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=3D@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=3D@var{path} > + Set log file path, logs to stderr by default. > + > +@item -f, --pidfile=3D@var{path} > + Specify pid file (default is @samp{/var/run/qemu-ga.pid}). > + > +@item -F, --fsfreeze-hook=3D@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=3D@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=3D@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 =3D 0 > +pidfile =3D /var/run/qemu-ga.pid > +verbose =3D 0 > +method =3D virtio-serial > +path =3D /dev/virtio-ports/org.qemu.guest_agent.0 > +statedir =3D /var/run > +@end example > + > +The list of keys follows the command line options: > +@table @option > +@item daemon=3D boolean > +@item method=3D string > +@item path=3D string > +@item logfile=3D string > +@item pidfile=3D string > +@item fsfreeze-hook=3D string > +@item statedir=3D string > +@item verbose=3D boolean > +@item blacklist=3D string list > +@end table > + > +@c man end > + > +@ignore > + > +@setfilename qemu-ga > +@settitle QEMU Guest Agent > + > +@c man begin AUTHOR > +Michael Roth > +@c man end > + > +@c man begin SEEALSO > +qemu(1) > +@c man end > + > +@end ignore > -- = > 2.4.3 >=20