add man pages

2 files changed, 93 insertions, 0 deletions

diff --git a/qemu-gtk-run.man b/qemu-gtk-run.man
new file mode 100644
index 0000000..805b738
--- /dev/null
+++ b/qemu-gtk-run.man
@@ -0,0 +1,36 @@
+.TH qemu-gtk-run 1 "(c) 2009 Gerd Hoffmann"
+.SH NAME
+qemu-gtk-run - launch qemu and qemu-gtk, using libvirt config.
+.SH SYNOPSIS
+.B qemu-gtk-run vm-name
+.SH DESCRIPTION
+.B qemu-gtk-run
+is a perl script which will start qemu and qemu-gtk for you.  It uses
+libvirt (virsh dumpxml $name) to get the virtual machine
+configuration.  It will not use libvirt to start the virtual machine
+though.  Instead it parses the xml config, assembles a command line
+and launches qemu directly.
+.P
+It will not handle all libvirt config options.  It should handle a
+reasonable subset of the syntax though.  Some options are
+intentionally hard-coded, such as VNC setup and monitor location.
+.P
+Network setup is largely hardcoded as well for simplicity.  When
+started as root it will hook the virtual machine into virbr0 using
+a tap interface.  Otherwise slirp (aka -net user) is used.
+.P
+You probably want to set the VIRSH_DEFAULT_CONNECT_URI environment
+variable.  Check
+.B virsh(1)
+for details.
+.SH OPTIONS
+.TP
+.B -d
+Enable debug messages.
+.TP
+.B -m
+Enable monitor access (passed to qemu-gtk).
+.SH SEE ALSO
+qemu-gtk(1), virsh(1)
+.SH AUTHOR
+(c) 2009 Gerd Hoffmann <kraxel@redhat.com>
diff --git a/qemu-gtk.man b/qemu-gtk.man
new file mode 100644
index 0000000..a159cad
--- /dev/null
+++ b/qemu-gtk.man
@@ -0,0 +1,57 @@
+.TH qemu-gtk 1 "(c) 2009 Gerd Hoffmann"
+.SH NAME
+qemu-gtk - user interface for qemu.
+.SH SYNOPSIS
+.B qemu-gtk [ options ] [ monitor spec | vm name ]
+.SH DESCRIPTION
+.B qemu-gtk
+is a user interface for qemu.  It will connect to the qemu monitor and
+provide a fancy user interface for the virtual machine using monitor
+and VNC.  You can close the GUI window, keep the virtual machine
+running, and reconnect later.
+.B qemu-gtk
+will not start qemu itself.  You might find
+.B qemu-gtk-run(1)
+useful for that though.
+.P
+.B qemu-gtk
+expects the monitor location in qemu command line style
+(i.e. unix:/path/to/socket, tcp:host:port, ...) as argument.
+Alternatively you can also specify the name of the virtual machine.
+.B qemu-gtk
+will first try to find it in the config file.  Failing that it will
+try the default monitor location, which is
+"unix:$HOME/.qemu-gtk/$vmname".
+.SH OPTIONS
+.TP
+.B -h
+Display help text.
+.TP
+.B -d
+Raise debug level.
+.TP
+.B -k
+Keep running window open when qemu exits (i.e. GUI window will not
+disappear on VM shutdown).
+.TP
+.B -m
+Enable monitor access in a tab.
+.TP
+.B -s
+Enable serial console in a tab.  Happens automatically in case the
+qemu VNC server is disabled.
+.SH CONFIG FILE
+.B $HOME/.qemu-gtk.rc
+is the personal config file.
+.B qemu-gtk
+will save the UI settings there.  It is also checked to find the
+monitor for a given virtual machine.  It is a usual key file, with
+sections names in brackets and key = value pairs.
+.P
+The [vm] section can have a list of virtual machines, with "name =
+monitor-spec" pairs.  It is most useful for VMs running on other machines
+as for local usage the default mapping should work just fine.
+.SH SEE ALSO
+qemu-gtk-run(1)
+.SH AUTHOR
+(c) 2009 Gerd Hoffmann <kraxel@redhat.com>