summaryrefslogtreecommitdiff
path: root/content/pages/documentation.rst
blob: 83d6f3176dc31c7a1335e5149046cb7233609680 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
Documentation
###############################################################################

:slug: documentation
:part-of: documentation
:modified: 2015-10-13 09:00

.. _Apache 2.0: {filename}/static/docs/Apache_License_2.0.txt
.. _BSD: {filename}/static/docs/BSD_style.txt
.. _GPL: {filename}/static/docs/GPL.txt
.. _LGPL: {filename}/static/docs/LGPL.txt
.. _spice for newbies: {filename}/static/docs/spice_for_newbies.pdf
.. _spice protocol: {filename}/static/docs/spice_protocol.pdf
.. _ODP version: {filename}/static/docs/spice_redhat_summit_2009.odp
.. _PDF version: {filename}/static/docs/spice_redhat_summit_2009.pdf
.. _spice style: {filename}/static/docs/spice_style.pdf
.. _spice user manual: {filename}/static/docs/spice_user_manual.pdf
.. _UsbDk Presentation: {filename}/static/docs/UsbDk_at_a_Glance.pdf
.. _UsbDk Manual: {filename}/static/docs/UsbDk_Software_Development_Manual.pdf
.. _VD Interfaces: {filename}/static/docs/vd_interfaces.pdf

Copyright license templates that must be appended to newlyadded files - GPL_,
LGPL_, `Apache 2.0`_ and BSD_

**Spice Reference Manual**

This describes the various features provided by SPICE, and how to make use of
them when using QEMU/libvirt/virt-manager.

**spice-gtk API documentation**

This describes spice-gtk C API.

Important: The pdf docs were written for spice 0.4 and is thus not wholly up to
date.

**Spice For Newbies**

Contains basic information about Spice's architecture, components, and features
|br|
Download `spice for newbies`_


**Spice User Manual**

Includes all of the information you need to use Spice, such as downloading,
building, installing, and executing |br|
Download `spice user manual`_

**SPICE Protocol**

Outlines the complete definition of the SPICE remote computing protocol |br|
Download `spice protocol`_

Outlines the complete definition of the SPICE client <-> agent protocol |br|

..
  TODO
  `Go to AgentProtocol wiki page`_

**VD Interfaces**

The following is a clip from VD-Interfaces specification paper.

::

    “Virtual Device Interfaces (VDI) provide a standard way to publish interfaces of
    virtual devices by a software component. This enables other software components
    to interact with these devices. Going forward, the first component will be
    called the back-end and the second component will be called the front-end. An
    example for using Virtual Device Interfaces is as part of a virtual machine
    system, where the back-end will be the hardware emulation layer. The back-end
    will expose interfaces like display port, mouse input etc. The front-end will
    plug into the display output and will render its output according to it's
    specific implementation. The front-end will also plug into the mouse input and
    send mouse events to be processed by the back-end. In addition many other
    interface types can be exposed by the back-end. Another example of back-end is a
    remote display system in a physical machine environment. Here, the back-and is
    implemented using known techniques for interacting with the native OS for the
    purpose of receiving display updates and pushing inputs. The back-end exposes
    interfaces like display output, mouse input etc. The front-end can be exactly
    the same as in the previous example.

    By using VDI one back-end can use many types of front-ends without any special
    code modification. It is also possible for the back-end to dynamically switch
    front-ends, and improve back-end usability and flexibility. The use of
    front-ends by many back-ends allows for a better sharing of development,
    maintenance, and overall product quality.”


Spice server is implemented as a VDI front-end and the Spiced-QEMU provides
back-end interfaces. The specification is in draft form and requires some minor
changes. Spice project plans to make an effort to push this specification
forward in order to benefit all. |br|
Download the complete specification of `VD interfaces`_

**Spice style**

Defines Spice project's coding style and coding conventions |br|
Download `spice style`_

**Red Hat Summit 2009**

Spice session presentation at Red Hat Summit 2009 |br|
Download `ODP version`_ or `PDF version`_

**UsbDk**

Download `UsbDk Presentation`_ |br|
Download `UsbDk Manual`_

**License**

Copyright license templates that must be appended to newlyadded files - GPL_,
LGPL_, `Apache 2.0`_ and BSD_

.. |br| raw:: html

   <br />