aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 36 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2f3b266
--- /dev/null
+++ b/README
@@ -0,0 +1,36 @@
+
+about qemu-gtk
+==============
+
+This is a simple gtk-based gui for qemu. It is designed to run
+independant from the qemu process, so you can stop and restart the gui
+without disturbing your virtual machines.
+
+qemu-gtk doesn't (yet?) support starting and stopping virtual
+machines. It can only connect to a already running qemu process.
+
+
+using qemu-gtk
+--------------
+
+qemu-gtk connects to the qemu monitor using tcp or unix sockets and to
+the built-in vnc server. Thus you must enable the monitor and vnc
+when starting qemu. The monitor should be in non-blocking server mode.
+
+i.e. you'll start qemu like this:
+
+ "qemu -monitor unix:/tmp/monitor,server,nowait -vnc :1 <more-args>"
+
+then the gui like this:
+
+ "qemu-gtk unix:/tmp/monitor"
+
+qemu-gtk will figure automatically where the vnc display is, using the
+monitor.
+
+
+Have fun,
+ Gerd
+
+--
+Gerd Hoffmann <kraxel@redhat.com>