glfs/gnome/add/vinagre.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 vinagre-download-http "&gnome-download-http;/vinagre/&gnome-version;/vinagre-&vinagre-version;.tar.bz2">
  <!ENTITY vinagre-download-ftp  "&gnome-download-ftp;/vinagre/&gnome-version;/vinagre-&vinagre-version;.tar.bz2">
  <!ENTITY vinagre-md5sum        "2483369947e7914b5ac2aae8200f6452">
  <!ENTITY vinagre-size          "2.3 MB">
  <!ENTITY vinagre-buildsize     "32 MB">
  <!ENTITY vinagre-time          "0.5 SBU">
]>

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

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

  <title>Vinagre-&vinagre-version;</title>

  <indexterm zone="vinagre">
    <primary sortas="a-Vinagre">Vinagre</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Vinagre</title>

    <para>The <application>Vinagre</application> is a VNC client for the
    <application>GNOME Desktop</application>. VNC is a protocol that allows
    remote display of a user's desktop.</para>

    &lfs65_checked;

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

    <bridgehead renderas="sect3">Vinagre Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="GConf"/>,
    <xref linkend="gnome-doc-utils"/>,
    <xref linkend="gtk-vnc"/>, and
    <xref linkend="libgnome-keyring"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="avahi"/>,
    <xref linkend="gnome-panel"/>,
    <xref linkend="rarian"/>,
    <xref linkend="telepathy-glib"/>, and
    <xref linkend="vte"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Vinagre</title>

    <para>Install <application>Vinagre</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --libexecdir=$(pkg-config \
                --variable=prefix ORBit-2.0)/lib/vinagre-1 \
            --disable-applet \
            --disable-avahi \
            --disable-scrollkeeper &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>

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

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

    <para><parameter>--libexecdir=$(pkg-config --variable=prefix
    ORBit-2.0)/lib/vinagre-1</parameter>: This parameter is used so that the
    <application>vinagre</application> internal support programs are installed
    in the preferred location of <filename
    class='directory'>$GNOME_PREFIX/lib/vinagre-1</filename> instead of <filename
    class='directory'>$GNOME_PREFIX/libexec</filename>.</para>

    <para><parameter>--disable-applet</parameter>: This parameter stops the
    build of the panel applet. Remove it if you have <application>GNOME
    Panel</application> installed.</para>

    <para><parameter>--disable-avahi</parameter>: This parameter disables the
    use of <application>avahi</application> for auto-discover machines. Remove
    it if you have <application>avahi</application> installed.</para>

    <para><parameter>--disable-scrollkeeper</parameter>: This parameter disables
    updates to the scrollkeeper database. Remove it if you have
    <application>rarian</application> installed.</para>

    <para><option>--enable-ssh</option>: This option enables the SSH plugin.
    Requires <application>VTE</application>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>vinagre and vinagre-applet</seg>
        <seg>libcloader.so and libvnc.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/vinagre-1.0/vinagre,
        lib/vinagre-1/{plugin-loaders,plugins},share/{doc/vinagre,
        gnome/help/vinagre/*,omf/vinagre,telepathy/clients,
        vinagre-1/plugins/vnc}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="vinagre-prog">
        <term><command>vinagre</command></term>
        <listitem>
          <para>is a remote desktop viewer for the <application>GNOME
          Desktop</application>.</para>
          <indexterm zone="vinagre vinagre-prog">
            <primary sortas="b-vinagre">vinagre</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!--<varlistentry id="vinagre-applet">
        <term><command>vinagre-applet</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="vinagre vinagre-applet">
            <primary sortas="b-vinagre-applet">vinagre-applet</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcloader">
        <term><filename class='libraryfile'>libcloader.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="vinagre libcloader">
            <primary sortas="c-libcloader">libcloader.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libvnc">
        <term><filename class='libraryfile'>libvnc.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="vinagre libvnc">
            <primary sortas="c-libvnc">libvnc.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

    </variablelist>

  </sect2>

</sect1>