source: gnome/platform/yelp.xml@ 3387a84

<?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 yelp-download-http "&gnome-download-http;/yelp/&gnome-minor-32;/yelp-&yelp-version;.tar.xz">
  <!ENTITY yelp-download-ftp  "&gnome-download-ftp;/yelp/&gnome-minor-32;/yelp-&yelp-version;.tar.xz">
  <!ENTITY yelp-md5sum        "177a57015986b6152e5f1b36af625f5a">
  <!ENTITY yelp-size          "1.5 MB">
  <!ENTITY yelp-buildsize     "17 MB">
  <!ENTITY yelp-time          "0.1 SBU">
]>

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

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

  <title>Yelp-&yelp-version;</title>

  <indexterm zone="yelp">
    <primary sortas="a-Yelp">Yelp</primary>
  </indexterm>

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

    <para>
      The <application>Yelp</application> package contains a help
      browser used for viewing help files.
    </para>

    &lfs84_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gsettings-desktop-schemas"/>,
      <xref linkend="webkitgtk"/> and
      <xref linkend="yelp-xsl"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="desktop-file-utils"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

    <note>
      <para>
        The <application>Yelp</application> package is not required for a
        functional <application>GNOME</application> Desktop. Note, however, that
        without <application>Yelp</application> you will not be able to view the
        built-in Help provided by core <application>GNOME</application> and many
        of the support applications.
      </para>
    </note>

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

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &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>

    <para>
      Still as the <systemitem class="username">root</systemitem> user, ensure
      that <filename>/usr/share/applications/mimeinfo.cache</filename> will
      be updated and therefore the <command>help</command> in gnome
      applications will work.
    </para>

<screen role="root"><userinput>update-desktop-database</userinput></screen>

  </sect2>

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

    <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 Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          gnome-help (symlink) and yelp
        </seg>
        <seg>
          libyelp.so
        </seg>
        <seg>
          /usr/{include,share/gtk-doc/html}/libyelp and
          /usr/{lib,share}/yelp
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="yelp-prog">
        <term><command>yelp</command></term>
        <listitem>
          <para>
            is the <application>GNOME</application> Help Browser.
          </para>
          <indexterm zone="yelp yelp-prog">
            <primary sortas="b-yelp">yelp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libyelp">
        <term><filename class="libraryfile">libyelp.so</filename></term>
        <listitem>
          <para>
            contains the <application>Yelp</application> API functions.
          </para>
          <indexterm zone="yelp libyelp">
            <primary sortas="c-libyelp">libyelp.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>