source: gnome/add/vinagre.xml@ af9466b

<?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.xz">
  <!ENTITY vinagre-download-ftp  "&gnome-download-ftp;/vinagre/&gnome-version;/vinagre-&vinagre-version;.tar.xz">
  <!ENTITY vinagre-md5sum        "5becc82f021e5c97d6ef174d601ce7a8">
  <!ENTITY vinagre-size          "2.5 MB">
  <!ENTITY vinagre-buildsize     "26 MB">
  <!ENTITY vinagre-time          "0.4 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>

    &lfs70_built;

    <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">Recommended</bridgehead>
    <para role="optional"><xref linkend="rarian"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="avahi"/>,
    <!--<xref linkend="gnome-panel"/>,-->
    <ulink url="http://www.spice-space.org/">spice-client-gtk3</ulink>,
    <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=$GNOME_PREFIX &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"/>

    <para><option>--without-avahi</option>: This parameter prevents
    <command>configure</command> making use of <application>avahi</application>
    if it is present.</para>

    <para><option>--without-telepathy</option>: This parameter prevents
    <command>configure</command> making use of <application>telepathy-glib</application>
    if it is present.</para>

    <!-- enabled by default
    <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</seg>
        <seg>librdp.so, libssh.so, and libvnc.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{lib/vinagre-3.0/plugins,share/{doc/vinagre,
        gnome/help/vinagre/*,omf/vinagre,telepathy/clients,
        vinagre}}</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>