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

<?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/1.3/gtk-vnc-&gtk-vnc-version;.tar.xz">
  <!ENTITY gtk-vnc-download-ftp  " ">
  <!ENTITY gtk-vnc-md5sum        "27f0dc7f33cbfdaa6c9eb7cf169f4866">
  <!ENTITY gtk-vnc-size          "220 KB">
  <!ENTITY gtk-vnc-buildsize     "5.2 MB">
  <!ENTITY gtk-vnc-time          "0.1 SBU">
]>

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


  <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 contains a VNC viewer widget
      for <application>GTK+</application>. It is built using coroutines allowing
      it to be completely asynchronous while remaining single threaded.
    </para>

    &lfs120_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="gnutls"/>,
      <xref linkend="gtk3"/>, and
      <xref linkend="libgcrypt"/>
    </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">
      <xref linkend="cyrus-sasl"/> and
      <xref linkend="pulseaudio"/>
      <!-- <ulink url="https://view.sourceforge.net/">libview</ulink> -->
    </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>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</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>ninja install</userinput></screen>

  </sect2>

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

<!--
    <para>
      <parameter>- -with-gtk=3.0</parameter>: This switch enables
      building of the <application>GTK+ 3</application> library
      instead of the <application>GTK+ 2</application> one.
    </para>
-->

    <para>
      <option>-Dwith-vala=false</option>: This switch disables
      building of the Vala bindings. Add this if you decide to build gtk-vnc
      without vala installed.
    </para>

<!--
    <para>
      <parameter>- -without-sasl</parameter>: This switch disables the
      use of <application>Cyrus SASL</application> for authentication.
      Remove it if you have installed
      <application>Cyrus SASL</application> and wish to enable it for
      authentication.
    </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,
          /usr/include/gvnc-1.0 and
          /usr/include/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">
        <term><filename class="libraryfile">libgtk-vnc-2.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>GTK+ 3</application> bindings for
            <application>Gtk VNC</application>
          </para>
          <indexterm zone="gtk-vnc libgtk-vnc-2">
            <primary sortas="c-libgtk-vnc-2.0">libgtk-vnc-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

    </variablelist>

  </sect2>

</sect1>