summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLubos Kocman <lkocman@redhat.com>2011-02-28 22:39:35 +0100
committerLubos Kocman <lkocman@redhat.com>2011-02-28 22:39:35 +0100
commitea0183f4488aada96e1d7df22c662c8f7dbee5e2 (patch)
tree96f2fbd2ae463cff042cffa95ee0fd4ab753396c
parent9f562c3bef30ab0517b03cee692bcc7ff0a6d960 (diff)
docbook compliant
-rw-r--r--books/docbook/user_guide.sgm56
-rw-r--r--makefile15
2 files changed, 54 insertions, 17 deletions
diff --git a/books/docbook/user_guide.sgm b/books/docbook/user_guide.sgm
index e4787c3..07a4fa8 100644
--- a/books/docbook/user_guide.sgm
+++ b/books/docbook/user_guide.sgm
@@ -14,7 +14,7 @@
<author>
<firstname>Arnon</firstname>
-<surname>Gilboa</firstname>
+<surname>Gilboa</surname>
</author>
</authorgroup>
@@ -41,13 +41,20 @@ Licensed under a Creative Commons Attribution-Share Alike 3.0 United States Lice
Spice is an open remote computing solution, providing client access to remote displays and devices (e.g. keyboard, mouse, audio). Spice provides a desktop like user experience, while trying to offload most of the intensive CPU and GPU tasks to the client.
The basic building blocks of Spice are:
+</para>
<orderedlist>
-<listitem>Spice protocol</listitem>
-<listitem>Spice server</listitem>
-<listitem>Spice client</listitem>
+<listitem>
+<para>Spice protocol</para>
+</listitem>
+<listitem>
+<para>Spice server</para>
+</listitem>
+<listitem><para>Spice client</para>
+</listitem>
</orderedlist>
+<para>
The following sections provide basic iformation on Spice components and features, obtaining, building installing and using Spice.
</para>
@@ -70,7 +77,9 @@ Spice server is implemented in libspice, a VDI pluggable library. Virtual Device
<section>
<title>QXL Device and Drivers</title>
+<para>
Spice server supports QXL VDI interface. When libspice is used with QEMU, a specific QEMU QXL PCI device can be used for improving remote display performance and enhancing the graphic capabilities of the guest graphic system. QXL device requires guest QXL drivers for full functionality. However, standard VGA is supported when no driver exists.
+</para>
</section>
<section>
@@ -79,6 +88,7 @@ Spice server supports QXL VDI interface. When libspice is used with QEMU, a spec
<para>
Spice protocol supports a communication channel between the client and the agent on the server side. When using QEMU, Spice agent resides on the guest. VDI port is a QEMU PCI device used for communication with the agent.
</para>
+</section>
<section>
<title>Spice Agent</title>
@@ -97,17 +107,29 @@ The Spice agent is an optional component for enhancing user experience and perfo
<para>
The server and client communicate via channels. Each channel is dedicated to a specific type of data. The available channels are:
+</para>
<orderedlist>
-<listitem><emphasis role="bold">Main</emphasis> - control and configuration</listitem>
-<listitem><emphasis role="bold">Display</emphasis> - graphics commands images and video streams</listitem>
-<listitem><emphasis role="bold">Inputs</emphasis> - keyboard and mouse inputs</listitem>
-<listitem><emphasis role="bold">Cursor</emphasis> - pointer device position and cursor shape</listitem>
-<listitem><emphasis role="bold">Playback</emphasis> - audio received from the server to be played by the client</listitem>
-<listitem><emphasis role="bold">Record</emphasis> - audio capture on the client side</listitem>
+<listitem>
+<para>Main - control and configuration</para>
+</listitem>
+<listitem>
+<para>Display - graphics commands images and video streams</para>
+</listitem>
+<listitem>
+<para>Inputs - keyboard and mouse inputs</para>
+</listitem>
+<listitem>
+<para>Cursor - pointer device position and cursor shape</para>
+</listitem>
+<listitem>
+<para>Playback - audio received from the server to be played by the client</para>
+</listitem>
+<listitem>
+<para>Record - audio capture on the client side</para>
+</listitem>
</orderedlist>
-</para>
</section>
<section>
@@ -131,7 +153,7 @@ Spice uses loss-less compression for images sent to the client. However, video s
<para>
Spice supports two mouse modes: server and client. The mode can be changed dynamically and is negotiated between the client and the server.
-
+</para>
<orderedlist>
<listitem>
<para>
@@ -146,12 +168,10 @@ Spice supports two mouse modes: server and client. The mode can be changed dynam
</listitem>
</orderedlist>
-</para>
</section>
<section>
<title>Other Features</title>
-<para>
<orderedlist>
<listitem>
@@ -187,7 +207,6 @@ Spice supports two mouse modes: server and client. The mode can be changed dynam
</orderedlist>
-</para>
</section>
</section>
</chapter>
@@ -197,11 +216,14 @@ Spice supports two mouse modes: server and client. The mode can be changed dynam
<section>
<title>Prerequisites</title>
-
+<para>
+</para>
</section>
</chapter>
<chapter id="running_spice">
-
+<title>Running Spice</title>
+<para>
+</para>
</chapter>
</book>
diff --git a/makefile b/makefile
new file mode 100644
index 0000000..1c249d4
--- /dev/null
+++ b/makefile
@@ -0,0 +1,15 @@
+# Simple makefile for generating spice-space.org documentation
+# Author: Lubos Kocman
+
+all: user_guide
+
+user_guide:
+ @mkdir -p books/html/
+ @db2html -o books/html books/docbook/user_guide.sgm
+ @db2pdf -o books/pdf books/docbook/user_guide.sgm
+ @db2ps -o books/ps books/docbook/user_guide.sgm
+
+clean:
+ rm -rf books/html
+ rm -rf books/pdf
+ rm -rf books/ps