summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLubos Kocman <lkocman@redhat.com>2011-02-25 12:05:39 +0100
committerLubos Kocman <lkocman@redhat.com>2011-02-25 12:05:39 +0100
commite8f707ce418803562f3471bb872ad86a077647ca (patch)
tree3a8547735215c3ddf87a7d2429ee070331edccd4
parent91862f25e517077ab9f9754deaa80b5ac26c797e (diff)
Beginning with docbook
-rw-r--r--books/user_manual/docbook/user_guide.sgm80
1 files changed, 80 insertions, 0 deletions
diff --git a/books/user_manual/docbook/user_guide.sgm b/books/user_manual/docbook/user_guide.sgm
new file mode 100644
index 0000000..cf5cbe7
--- /dev/null
+++ b/books/user_manual/docbook/user_guide.sgm
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN">
+
+<bookinfo>
+<title>Spice User Manual</title>
+
+<authorgroup>
+
+<author>
+<firstname>Lubos</firstname>
+<surname>Kocman</surname>
+</author>
+
+<author>
+<firstname>Arnon</firstname>
+<surname>Gilboa</firstname>
+</author>
+
+</authorgroup>
+</bookinfo>
+
+<book>
+<chapter id="introduction">
+<title>Introduction</title>
+<para>
+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:
+
+<orderedlist>
+<listitem>Spice protocol</listitem>
+<listitem>Spice server</listitem>
+<listitem>Spice client</listitem>
+</orderedlist>
+
+The following sections provide basic iformation on Spice components and features, obtaining, building installing and using Spice.
+</para>
+
+<section>
+<title>Spice and Spice-related Compoments</title>
+
+<section>
+<title>Spice Server</title>
+
+<para>
+Spice server is implemented in libspice, a VDI pluggable library. Virtual Device Interface (VDI) defines a set of interfaces that provide a standard way to publish virtual devices (e.g. display device, keyboard, mouse) and enables different Spice components to interact with those devices. For more information, refer to [2]. On one side, the server communicates with the remote client using the Spice protocol and on the other side, it interacts with the VDI host application (e.g QEMU).
+</para>
+</section>
+</section>
+</chapter>
+
+<chapter>
+<title>Installation</title>
+</chapter>
+
+<chapter>
+<title>Running spice</title>
+</chapter>
+
+<chapter>
+<title>Spice server</title>
+</chapter>
+
+<chapter>
+<title>Spice client</title>
+</chapter>
+
+<chapter>
+<title>Guest</title>
+</chapter>
+
+<chapter>
+<title>Logging and debugging</title>
+</chapter>
+
+<chapter>
+<title>References</title>
+</chapter>
+
+</book>