glfs/gnome/core/yelp.xml
Randy McMurchy 474231bf48 Updated to Yelp-2.6.5; this completes the update of all the core GNOME-2 packages to the 2.10.1 release
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@4132 af4574ff-66df-0310-9fd7-8a98e5e911e0
2005-05-11 14:47:14 +00:00

109 lines
3.2 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY yelp-download-http "http://ftp.gnome.org/pub/GNOME/sources/yelp/2.6/yelp-&yelp-version;.tar.bz2">
<!ENTITY yelp-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/yelp/2.6/yelp-&yelp-version;.tar.bz2">
<!ENTITY yelp-md5sum "9bd94af344ee6a0bf69aa6f9cbd6b7e9">
<!ENTITY yelp-size "654 KB">
<!ENTITY yelp-buildsize "9 MB">
<!ENTITY yelp-time "0.2 SBU">
]>
<sect1 id="yelp" xreflabel="Yelp-&yelp-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="yelp.html"?>
<title>Yelp-&yelp-version;</title>
<sect2>
<title>Introduction to <application>Yelp</application></title>
<para>The <application>Yelp</application> package contains the help browser.
This is useful for viewing help files.</para>
<sect3><title>Package information</title>
<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>
</sect3>
<sect3><title><application>Yelp</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="libgnomeui"/>,
<xref linkend="libgtkhtml"/> and
<xref linkend="scrollkeeper"/></para>
</sect4>
<sect4><title>Recommended</title>
<para><xref linkend="gnome-doc-utils"/> (required for <acronym>XSLT</acronym>
transformations)</para>
</sect4>
</sect3>
</sect2>
<sect2>
<title>Installation of <application>Yelp</application></title>
<para>Install <application>Yelp</application> by running the following
commands:</para>
<screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
--localstatedir=/var/lib &amp;&amp;
make</command></userinput></screen>
<para>This package does not come with a test suite.</para>
<para>Now, as the root user:</para>
<screen><userinput role='root'><command>make install</command></userinput></screen>
</sect2>
<sect2>
<title>Command explanations</title>
<para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
<application>ScrollKeeper</application> files in
<filename class='directory'>/var/lib/scrollkeeper</filename> instead of
<filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>
</sect2>
<sect2>
<title>Contents</title>
<para>The <application>Yelp</application> package contains
<command>gnome-help</command> and <command>yelp</command>.</para>
</sect2>
<sect2><title>Description</title>
<sect3><title>gnome-help</title>
<para><command>gnome-help</command> is a symbolic link to
<command>yelp</command>.</para>
</sect3>
<sect3><title>yelp</title>
<para><command>yelp</command> is the
<application><acronym>GNOME</acronym></application> help browser.</para>
</sect3>
</sect2>
</sect1>