path: root/archive/spice-gtk.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY spice-gtk-download-http "http://spice-space.org/download/gtk/spice-gtk-&spice-gtk-version;.tar.bz2">
  <!ENTITY spice-gtk-download-ftp  " ">
  <!ENTITY spice-gtk-md5sum        "c8f2c274ab81e0ac273be5c6490b8603">
  <!ENTITY spice-gtk-size          "852 KB">
  <!ENTITY spice-gtk-buildsize     "25 MB">
  <!ENTITY spice-gtk-time          "0.8 SBU">
]>

<sect1 id="spice-gtk" xreflabel="spice-gtk-&spice-gtk-version;">
  <?dbhtml filename="spice-gtk.html"?>

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>spice-gtk-&spice-gtk-version;</title>

  <indexterm zone="spice-gtk">
    <primary sortas="a-spice-gtk">spice-gtk</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to spice-gtk</title>

    <para>
      The <application>spice-gtk</application> package contains
      a Gtk client and libraries for SPICE remote desktop servers.
    </para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&spice-gtk-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&spice-gtk-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &spice-gtk-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &spice-gtk-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &spice-gtk-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &spice-gtk-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">spice-gtk Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="celt051"/>,
      <xref linkend="cyrus-sasl"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="polkit"/> and
      <xref linkend="pulseaudio"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://spice-space.org/download/libcacard/">libcacard</ulink> and
      <xref linkend="gtk-doc"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/spice-gtk"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of spice-gtk</title>

    <para>
      Install <application>spice-gtk</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr \
            --enable-vala \
            --disable-static \
            --disable-smartcard &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>


  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>--enable-vala</option>: This option enables
      building of the Vala bindings. Remove if you don't have
      <xref linkend="vala"/> installed.
    </para>

    <para>
      <option>--disable-smartcard</option>: This option disables use of
      libcacard. Remove if you have libcacard installed.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          snappy, spicy and spicy-stats
        </seg>
        <seg>
          libspice-client-glib-2.0.so, libspice-client-gtk-3.0.so
          and libspice-controller.so
        </seg>
        <seg>
          /usr/include/{spice-client-glib-2.0,spice-client-gtk-3.0,spice-controller} and
          /usr/share/gtk-doc/spice-gtk
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="snappy">
        <term><command>snappy</command></term>
        <listitem>
          <para>
            is program which connects to Spice server
            and takes a screenshot.
          </para>
          <indexterm zone="spice-gtk snappy">
            <primary sortas="b-snappy">snappy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="spicy">
        <term><command>spicy</command></term>
        <listitem>
          <para>
            is Gtk based Spice client application.
          </para>
          <indexterm zone="spice-gtk spicy">
            <primary sortas="b-spicy">spicy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="spicy-stats">
        <term><command>spicy-stats</command></term>
        <listitem>
          <para>
            is program which connects to Spice server
            and writes out a summary of connection details,
            amount of bytes transferred, etc.
          </para>
          <indexterm zone="spice-gtk spicy-stats">
            <primary sortas="b-spicy-stats">spicy-stats</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libspice-client-glib-2.0">
        <term><filename class="libraryfile">libspice-client-glib-2.0.so</filename></term>
        <listitem>
          <para>
            provides GLib objects for Spice protocol decoding and surface rendering.
          </para>
          <indexterm zone="spice-gtk libspice-client-glib-2.0">
            <primary sortas="c-libspice-client-glib-2.0">libspice-client-glib-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libspice-client-gtk-3.0">
        <term><filename class="libraryfile">libspice-client-gtk-3.0.so</filename></term>
        <listitem>
          <para>
            provides Gtk widget to show Spice display and accept user input.
          </para>
          <indexterm zone="spice-gtk libspice-client-gtk-3.0">
            <primary sortas="c-libspice-client-gtk-3.0">libspice-client-gtk-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>