Commit Graph

44 Commits

Author SHA1 Message Date
Snir Sheriber
9513620f99 docs: add Intel GVTg configuration to manual
Signed-off-by: Snir Sheriber <ssheribe@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2020-04-30 13:33:41 +03:00
Frediano Ziglio
70c71fe487 Remove Celt support
Take from spice-common this changeset:

Victor Toso (1):
      sound: remove celt support

Remove and update reference from CI and documentation.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
2020-03-17 17:15:51 +00:00
Snir Sheriber
4761973bc8 docs: fix manual.txt asciidoctor complaints
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-12-16 08:59:11 +00:00
Kevin Pouget
224a79acd3 manual: document host-side video streaming
Signed-off-by: Kevin Pouget <kpouget@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-07-04 14:33:54 +01:00
Snir Sheriber
0591a09ca5 manual: Typo at Folder sharing section
Reported here:
https://gitlab.freedesktop.org/spice/spice-space-pages/issues/1

Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-07-02 12:15:09 +03:00
Christophe Fergeau
046be756fc doc: Document G_MESSAGES_DEBUG use
Explain how to get more verbose logs out of spice-server

Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-02-08 17:17:00 +01:00
Eduardo Lima (Etrunko)
495d1612c4 Add support for building with meson/ninja
In a comparison with current autotools build system, meson/ninja
provides a huge improvement in build speed, while keeping the same
functionalities currently available and being considered more user
friendly.

The new system coexists within the same repository with the current one,
so we can do more extensive testing of its functionality before deciding
if the old system can be removed, or for some reason, has to stay for
good.

- Meson: https://mesonbuild.com

  This is the equivalent of autogen/configure step in autotools. It
  generates the files that will be used by ninja to actually build the
  source code.

  The project has received lots of traction recently, with many GNOME
  projects willing to move to this new build system. The following wiki
  page has more details of the status of the many projects being ported:

    https://wiki.gnome.org/Initiatives/GnomeGoals/MesonPorting

  Meson has a python-like syntax, easy to read, and the documentation
  on the project is very complete, with a dedicated page on how to port
  from autotools, explaining how most common use cases can be
  implemented using meson.

    http://mesonbuild.com/Porting-from-autotools.html

  Other important sources of information:

    http://mesonbuild.com/howtox.html
    http://mesonbuild.com/Syntax.html
    http://mesonbuild.com/Reference-manual.html

- Ninja: https://ninja-build.org

  Ninja is the equivalent of make in an autotools setup, which actually
  builds the source code. It has being used by large and complex
  projects such as Google Chrome, Android and LLVM. There is not much to
  say about ninja (other than it is much faster than make) because we
  won't interact directly with it as much, as meson does the middle man
  job here. The reasoning for creating ninja in the first place is
  explained on the following post:

    http://neugierig.org/software/chromium/notes/2011/02/ninja.html

  Also its manual provides more in-depth information about the design
  principles:

    https://ninja-build.org/manual.html

- Basic workflow:

  Meson package is available for most if not all distros, so, taking
  Fedora as an example, we only need to run:

    # dnf -y install meson ninja-build.

  With Meson, building in-tree is not possible at all, so we need to
  pass a directory as argument to meson where we want the build to be
  done. This has the advantage of creating builds with different options
  under the same parent directory, e.g.:

    $ meson ./build --prefix=/usr
    $ meson ./build-extra -Dextra-checks=true -Dalignment-checks=true

  After configuration is done, we call ninja to actually do the build.

    $ ninja -C ./build
    $ ninja -C ./build install

  Ninja defaults to parallel builds, and this can be changed with the -j
  flag.

    $ ninja -j 10 -C ./build

- Hacking:

  * meson.build: Mandatory for the project root and usually found under
                 each directory you want something to be built.

  * meson_options.txt: Options that can interfere with the result of the
                       build.

Signed-off-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
2018-08-30 11:10:45 -03:00
Christophe Fergeau
65c018fbbb docs: Add documentation for the streaming device
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
2018-08-17 14:23:48 +02:00
Snir Sheriber
6f19579254 docs: Update links in README and manual
Signed-off-by: Snir Sheriber <ssheribe@redhat.com>
Acked-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
2018-05-10 16:59:35 +03:00
Jonathon Jongsma
8705e3d123 Mention vmport in user manual
For server mode mouse to work properly with spice, vmport must be
disabled in qemu. To do this, we need to pass vmport=off to the -machine
option.
2017-10-04 11:09:15 -05:00
Pavel Grunt
11e04a100d manual: Remove outdated GL acceleration info
No need to reference a copr. Everything has been merged and relevant
component versions are mentioned.

Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2017-04-07 08:55:03 +02:00
Pavel Grunt
609b03e45d manual: Update folder sharing instruction
Link to the folder with latest releases and remove outdate info about
the service registration.

Acked-by: Victor Toso <victortoso@redhat.com>
2017-04-07 08:54:04 +02:00
Jonathon Jongsma
790cf16d32 Manual: add info about QEMU_AUDIO_DRV
hramrach on IRC had an issue with audio not working. He was using
suse and his qemu defaulted to using the pulseaudio audio driver instead
of spice.  Explicitly setting the audio driver to spice using the
QEMU_AUDIO_DRV environment variable solved the problem. Add this tip to
the manual for others having the same issue in the future.
2016-12-05 15:46:33 -06:00
Jonathon Jongsma
4c99109329 Switch example sound device to 'hda'
Recommended sound device for newer operating systems is Intel HD audio
(hda). Use this in the commandline examples.
2016-12-05 15:46:33 -06:00
Uri Lublin
1f800090ef manual: usbredir: remove the note about usbclerk
The usbdk driver is preferred over usbclerk.

Signed-off-by: Uri Lublin <uril@redhat.com>
2016-12-01 12:08:32 +02:00
Uri Lublin
a668da95a4 manual: move usbdk to the client subsection
Also added "clients" to the sentence to make it clear
that usbdk is to be installed on the client machine.

Signed-off-by: Uri Lublin <uril@redhat.com>
2016-12-01 12:08:32 +02:00
Uri Lublin
3f8457febe manual: smartcard: add id=ccid to qemu command line
Add it to "-chardev spicevmc" option.

Without it I get:
qemu-system-x86_64: -chardev spicevmc,name=smartcard: chardev: no id specified

Signed-off-by: Uri Lublin <uril@redhat.com>
2016-12-01 12:08:32 +02:00
Christophe Fergeau
087b914e0a doc: Remove mention that qxl.guestdebug is Windows-only
The Linux QXL KMS driver also uses it.

Acked-by: Frediano Ziglio <fziglio@redhat.com>
2016-10-14 16:39:22 +01:00
snir sheriber
1e467acb2a User-Manual: mention webdav is disabled by default
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-08-02 17:17:46 +02:00
Eduardo Lima (Etrunko)
036cb65a7e Fix make dist
spicec screenshot has been removed since commit b0186fe126

Signed-off-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
2016-04-25 17:10:04 -03:00
Pavel Grunt
b0186fe126 manual: Remove spicec screenshot 2016-04-22 17:07:09 +02:00
Pavel Grunt
be29eb0eea manual: No need to use sudo to run qemu 2016-04-22 17:07:09 +02:00
Pavel Grunt
d3530802b3 manual: Recommend UsbDk instead of USB Clerk 2016-04-22 17:07:09 +02:00
Pavel Grunt
cd5a1d7c09 manual: Recommend enabling monitors using remote-viewer's menu 2016-04-22 17:07:09 +02:00
Christophe Fergeau
b248815119 doc: Be more explicit about virgl requirements
This is an attempt at listing the versions of the various packages which
needs to be up to date for a functional virgl + spice.
2016-04-01 15:16:44 +02:00
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
Christophe Fergeau
1f41c295d9 manual: Document path to vdagent logs on Windows 2015-11-19 18:57:25 +01:00
Christophe Fergeau
0050ab7a4e manual: Small formatting fixes
The XML namespace to use with libvirt when adding custom QEMU arguments
looks better in a monospace font.
asciidoc will also replace the '->' in '<->' with an arrow character,
which looks bad. This commit reformulates the sentence to avoid the use
of <->
2015-11-19 18:57:25 +01:00
Christophe Fergeau
b4932ae646 syntax-check: manual: Remove duplicate word 2015-10-19 14:25:36 +02:00
Christophe Fergeau
2cf810e99e manual: Fix Arnon last name
It's "Gilboa", not "Giloba"
2015-10-01 17:56:43 +02:00
Christophe Fergeau
3d16f8c0f0 manual: Add section about debugging
This details the basics for now, but can be detailed in the future.
2015-10-01 17:56:43 +02:00
Marc-André Lureau
c309e761e8 manual: add smartcard channel section
Add some basic instructions to setup smartcard channel

Signed-off-by: Marc-André Lureau <marcandre.lureau@gmail.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2015-09-15 16:22:14 +02:00
Marc-André Lureau
1b6918f82f manual: add missing space
Signed-off-by: Marc-André Lureau <marcandre.lureau@gmail.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2015-09-15 16:22:11 +02:00
Marc-André Lureau
a9d9d4b448 manual: update webdav virt-manager section
virt-manager can add webdav channel for a while now.

Signed-off-by: Marc-André Lureau <marcandre.lureau@gmail.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2015-09-15 16:22:07 +02:00
Christophe Fergeau
3d83525861 manual: Add missing closure of XML tag
The <model type='qxl'> examples in the reference documentation are
missing a closing tag.
2014-11-17 17:56:08 +01:00
Christophe Fergeau
719764f7ad docs: Fix make distcheck 2014-05-15 15:26:51 +02:00
Christophe Fergeau
37bf7a5163 doc: Generate chunked manual
This commit makes use of a2x in order to generate a chunked manual in
addition to the "all in one page" one.
2014-04-16 16:33:44 +02:00
Marc-André Lureau
b9bf654143 manual: improve text about ~/Public 2014-03-25 15:46:29 +01:00
Marc-André Lureau
fb72d198e3 manual: fix xml highlighting 2014-03-19 17:28:46 +01:00
Marc-André Lureau
06d646352e manual: add folder sharing section 2014-03-19 17:14:44 +01:00
Marc-André Lureau
2e730453bf Translate docbook -> asciidoc
It's much much easier to read and edit, and the end results looks better
as well, see http://elmarco.fedorapeople.org/manual.html
2014-03-19 17:14:44 +01:00
Marc-André Lureau
e044cfca1e build-sys: simplify manual html generation 2014-03-19 14:01:33 +01:00
Marc-André Lureau
f8bc446b76 SpiceUserManual.xml: small clean-ups
Remove some non-conventional/non-freesoftware editor-specific lines.

Remove trailing whitespaces

Get rid of DTD, which is too strict for docbook, see also:
http://docbook.org/tdg5/en/html/ch02.html

This get rids of the following warning/error:

I/O error : Attempt to load network entity
http://docbook.org/xml/5.0/dtd/docbook.dtd
/home/elmarco/src/spice/spice-master/docs/manual/SpiceUserManual.xml:4:
warning: failed to load external entity
"http://docbook.org/xml/5.0/dtd/docbook.dtd"
          "http://docbook.org/xml/5.0/dtd/docbook.dtd">
                                                       ^
2014-03-19 14:01:30 +01:00
Christophe Fergeau
7095563153 Add reference manual
This manual documents how to enable/use various SPICE features when
creating a VM by running QEMU directly, or when using libvirt, or when
using virt-manager.
This is based on work by Lubos Kocman
2014-01-20 12:18:15 +01:00