qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] [PATCH v3 12/12] qga: start a man page


From: marcandre . lureau
Subject: [Qemu-devel] [PATCH v3 12/12] qga: start a man page
Date: Wed, 26 Aug 2015 12:05:25 +0200

From: Marc-André Lureau <address@hidden>

Add a simple man page for the qemu agent.

Signed-off-by: Marc-André Lureau <address@hidden>
Reviewed-by: Michael Roth <address@hidden>
---
 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+=-lz $(LIBS_TOOLS)
 HELPERS-$(CONFIG_LINUX) = qemu-bridge-helper$(EXESUF)
 
 ifdef BUILD_DOCS
-DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 qmp-commands.txt
+DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8
+DOCS+=qmp-commands.txt
 ifdef CONFIG_LINUX
 DOCS+=kvm_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=8 --center=" " --release=" " qemu-nbd.pod > $@, \
          "  GEN   $@")
 
+qemu-ga.8: qemu-ga.texi
+       $(call quiet-command, \
+         perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< qemu-ga.pod && \
+         $(POD2MAN) --section=8 --center=" " --release=" " 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 particular 
USB).
 
 @include qemu-nbd.texi
 
address@hidden qemu_ga_invocation
address@hidden @code{qemu-ga} Invocation
+
address@hidden 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 @@
address@hidden
address@hidden man begin SYNOPSIS
+usage: qemu-ga [-m <method> -p <path>] [OPTION]...
address@hidden man end
address@hidden example
+
address@hidden man begin DESCRIPTION
+
+The QEMU Guest Agent is a deamon that allows the host to perform
+various operations in the guest, such as:
+
address@hidden
address@hidden
+get information from the guest
address@hidden
+set the guest's system time
address@hidden
+read/write a file
address@hidden
+sync and freeze the filesystems
address@hidden
+suspend the guest
address@hidden
+reconfigure guest local processors
address@hidden
+set user's password
address@hidden
+...
address@hidden itemize
+
+qemu-ga will read a system configuration file on startup (located at
address@hidden/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).
+
address@hidden man end
+
address@hidden man begin OPTIONS
address@hidden @option
address@hidden -m, address@hidden
+  Transport method: one of @samp{unix-listen}, @samp{virtio-serial}, or
+  @samp{isa-serial} (@samp{virtio-serial} is the default).
+
address@hidden -p, address@hidden
+  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})
+
address@hidden -l, address@hidden
+  Set log file path, logs to stderr by default.
+
address@hidden -f, address@hidden
+  Specify pid file (default is @samp{/var/run/qemu-ga.pid}).
+
address@hidden -F, address@hidden
+  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})
+
address@hidden -t, address@hidden
+  Specify the directory to store state information (absolute paths only,
+  default is @samp{/var/run}).
+
address@hidden -v, --verbose
+  Log extra debugging information.
+
address@hidden -V, --version
+  Print version information and exit.
+
address@hidden -d, --daemon
+  Daemonize after startup (detach from terminal).
+
address@hidden -b, address@hidden
+  Comma-separated list of RPCs to disable (no spaces, @samp{?} to list
+  available RPCs).
+
address@hidden -D, --dump-conf
+  Dump the configuration in a format compatible with @file{qemu-ga.conf}
+  and exit.
+
address@hidden -h, --help
+  Display this help and exit.
address@hidden table
+
address@hidden man end
+
address@hidden 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.
+
address@hidden
+# 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
address@hidden example
+
+The list of keys follows the command line options:
address@hidden @option
address@hidden daemon= boolean
address@hidden method= string
address@hidden path= string
address@hidden logfile= string
address@hidden pidfile= string
address@hidden fsfreeze-hook= string
address@hidden statedir= string
address@hidden verbose= boolean
address@hidden blacklist= string list
address@hidden table
+
address@hidden man end
+
address@hidden
+
address@hidden qemu-ga
address@hidden QEMU Guest Agent
+
address@hidden man begin AUTHOR
+Michael Roth <address@hidden>
address@hidden man end
+
address@hidden man begin SEEALSO
+qemu(1)
address@hidden man end
+
address@hidden ignore
-- 
2.4.3




reply via email to

[Prev in Thread] Current Thread [Next in Thread]