source: x/lib/gtk-vnc.xml@ de930747

<?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 gtk-vnc-download-http "&gnome-download-http;/gtk-vnc/0.5/gtk-vnc-&gtk-vnc-version;.tar.xz">
  <!ENTITY gtk-vnc-download-ftp  "&gnome-download-ftp;/gtk-vnc/0.5/gtk-vnc-&gtk-vnc-version;.tar.xz">
  <!ENTITY gtk-vnc-md5sum        "f45c9649c915af335cff91268e74ab67">
  <!ENTITY gtk-vnc-size          "380 KB">
  <!ENTITY gtk-vnc-buildsize     "8.0 MB">
  <!ENTITY gtk-vnc-time          "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>The <application>gtk-vnc</application> package is a VNC viewer widget
    for <application>GTK</application>. It is built using coroutines allowing it
    to be completely asynchronous while remaining single threaded. It provides a
    core C library and bindings for <application>Python</application>
    (<application>PyGTK</application>)</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk3"/>,
      <xref linkend="gnutls"/> and
      <xref linkend="intltool"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="cyrus-sasl"/>,
      <xref linkend="nspr"/>,
      <xref linkend="pulseaudio"/>,
      <xref linkend="vala"/> and
      <ulink url="https://developer.mozilla.org/en/XULRunner">xulrunner</ulink>.
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --with-gtk=3.0 \
            --without-sasl &amp;&amp;
make</userinput></screen>

    <para>This package's testsuite is only intended to be used by the
    maintainer to check the i18n files.</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><parameter>--with-gtk=3.0</parameter>: This parameter enables
    <application>GTK+3</application> instead of <application>GTK+2</application>.</para>

    <para><option>--without-sasl</option>: This parameter disables the use of 
    <application>Cyrus SASL</application> for authentication. Remove it if you have 
    <application>Cyrus SASL</application> installed and wish to enable it for 
    authentication.</para>

    <para><option>--enable-plugin</option>: This option enables the browser plugin.</para>

    <para><option>--enable-vala</option>: This option enables the vala bindings.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gvnccapture
        </seg>
        <seg>
          libgtk-vnc-2.0.so, libgvnc-1.0.so and libgvncpulse-1.0.so
        </seg>
        <seg>
          /usr/include/{gtk-vnc-2.0,gvnc-1.0,gvncpulse-1.0}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gvnccapture">
        <term><command>gvnccapture</command></term>
        <listitem>
          <para>
            is used to capture image from VNC server.
          </para>
          <indexterm zone="gtk-vnc gvnccapture">
            <primary sortas="b-gvnccapture">gvnccapture</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgtk-vnc-2.0">
        <term><filename class="libraryfile">libgtk-vnc-2.0.so</filename></term>
        <listitem>
          <para>
            contains GTK+3 bindings for GTK VNC.
          </para>
          <indexterm zone="gtk-vnc libgtk-vnc-2.0">
            <primary sortas="c-libgtk-vnc-2.0">libgtk-vnc-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgvnc-1.0">
        <term><filename class="libraryfile">libgvnc-1.0.so</filename></term>
        <listitem>
          <para>
            contains GObject bindings for GTK VNC.
          </para>
          <indexterm zone="gtk-vnc libgvnc-1.0">
            <primary sortas="c-libgvnc-1.0">libgvnc-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgvncpulse-1.0">
        <term><filename class="libraryfile">libgvncpulse-1.0.so</filename></term>
        <listitem>
          <para>
            is Pulseaudio bridge for GTK VNC.
          </para>
          <indexterm zone="gtk-vnc libgvncpulse-1.0">
            <primary sortas="c-libgvncpulse-1.0">libgvncpulse-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>


    </variablelist>

  </sect2>

</sect1>