Go to file
Christophe Fergeau 782c7508e2 doc: Add virgl documentation
Document how to use virgl with QEMU/libvirt

virt-manager documentation still needs to be added.
2016-03-24 13:56:59 +01:00
build-aux Update git-version-gen to latest version 2013-12-11 16:32:36 +01:00
docs doc: Add virgl documentation 2016-03-24 13:56:59 +01:00
m4 m4: WARN FLAGS: Drop -Wenum-compare 2015-03-15 13:57:12 +02:00
server make some functions static 2016-03-24 12:55:42 +00:00
spice-common@5b6be16b37 use constructor/destructor macros 2016-03-23 16:31:02 +00:00
tests tests/migrate.py: add --vdagent 2011-08-23 17:01:14 +03:00
tools Add casts for compatibility purposes 2012-02-14 10:44:49 +02:00
uncrustify_cfg fresh start 2009-10-14 15:06:41 +02:00
.gitignore Update .gitignore files 2016-02-25 09:12:51 +00:00
.gitmodules Use the spice-common submodule 2012-03-25 18:59:10 +02:00
.mailmap syntax-check: Fix missing AUTHORS 2016-01-08 11:23:44 +00:00
.travis.yml Add travis CI file 2015-11-27 20:21:24 +01:00
AUTHORS syntax-check: Fix missing AUTHORS 2016-01-08 11:23:44 +00:00
autogen.sh build-sys: Pass --enable-python-checks when running autogen.sh 2015-04-23 10:38:24 +02:00
cfg.mk syntax-check: Fix sc_cast_of_argument_to_free 2016-01-08 11:24:17 +00:00
ChangeLog fresh start 2009-10-14 15:06:41 +02:00
configure.ac build-sys: use safer SPICE_CONTAINEROF version 2016-03-23 13:44:22 +00:00
COPYING Relicense everything from GPL to LGPL 2.1+ 2010-04-13 22:22:15 +02:00
GNUmakefile Add a 'syntax-check' make target 2012-01-13 18:12:00 +02:00
maint.mk syntax-check: Ignore .png files in sc_trailing_blank test 2015-10-19 14:25:36 +02:00
Makefile.am build-sys: remove --enable-opengl 2015-11-27 20:19:59 +01:00
NEWS Remove GSlice use 2016-01-14 16:39:36 +00:00
README Revise the spice client and server to use the new snd_codec functions in spice-common. 2014-01-02 12:34:34 +01:00
spice-server.pc.in build-sys: Require a new enough spice-protocol in .pc file 2015-08-26 11:01:09 +02:00
TODO.multiclient Remove trailing whitespace from end of lines 2012-01-13 18:11:59 +02:00

   SPICE: Simple Protocol for Independent Computing Environments
   =============================================================

SPICE is a remote display system built for virtual environments which
allows you to view a computing 'desktop' environment not only on the
machine where it is running, but from anywhere on the Internet and
from a wide variety of machine architectures.

Installation
------------

The SPICE package uses GNU autotools, so the build install process
follows the standard process documented in the INSTALL file. As a
quick start you can do

  ./configure --prefix=/usr --sysconfdir=/etc \
        --localstatedir=/var --libdir=/usr/lib
  make
  sudo make install

Or to install into a private user specific location

  ./configure --prefix=$HOME/spice
  make
  make install

The following mandatory dependancies are required in order to
build SPICE

    Spice protocol >= 0.9.0
    Pixman         >= 0.17.7
    OpenSSL
    libjpeg
    zlib
    Cyrus-SASL

The following optional dependancies increase the available
functionality

    GE Gui         >= 0.6.0,  < 0.7.0   (GUI app support)
    OpenGL                              (GUI app support)
    Alsa                                (Linux support)
    XRandR         >= 1.2               (X11 support)
    Xinerama       >= 1.0               (X11 support)
    libcacard      >= 0.1.2             (Smartcard support)

Communication
-------------

To communicate with the development team, or to post patches
there is a technical mailing list:

   http://lists.freedesktop.org/mailman/listinfo/spice-devel

There is also a mailing list for new release announcements:

   http://lists.freedesktop.org/archives/spice-announce/

To view known bugs, or report new bugs, in SPICE visit

   https://bugs.freedesktop.org/describecomponents.cgi?product=Spice

Bugs found when using an OS distribution's binary packages should
be reported to the OS vendors' own bug tracker first.

The latest SPICE code can be found in GIT at:

   http://cgit.freedesktop.org/spice/

Licensing
---------

SPICE is provided under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

Please see the COPYING file for the complete LGPLv2+ license
terms, or visit <http://www.gnu.org/licenses/>.

Experimental Features
---------------------
To enable multiple client connections, set:
SPICE_DEBUG_ALLOW_MC=1

-- End of readme