glfs/gnome/core/yelp.xml

156 lines
5.0 KiB
XML
Raw Normal View History

<?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-version;/yelp-&yelp-version;.tar.bz2">
<!ENTITY yelp-download-ftp "&gnome-download-ftp;/yelp/&gnome-version;/yelp-&yelp-version;.tar.bz2">
<!ENTITY yelp-md5sum "afd638cdaea1fcb9821ece88b819a022">
<!ENTITY yelp-size "1.1 MB">
<!ENTITY yelp-buildsize "21 MB">
<!ENTITY yelp-time "0.3 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 the help
browser. This is useful for viewing help files.</para>
&lfs65_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="GConf"/>,
<xref linkend="gnome-doc-utils"/>,
<xref linkend="startup-notification"/>, and
<xref linkend="xulrunner"/></para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="rarian"/>, and
<ulink url="http://beagle-project.org/Main_Page">libbeagle</ulink></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. This is mentioned here because you may not
wish to install a Gecko layout engine. Without a Gecko layout engine you
will have no graphical browser capability as the default GNOME browser,
<xref linkend="epiphany"/>, also requires a Gecko layout engine.</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=$(pkg-config --variable=prefix ORBit-2.0) \
--sysconfdir=&gnome-etc-dir; \
--localstatedir=/var/lib \
--enable-cpp-rtti &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"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/scrollkeeper-dir.xml"/>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Program</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>yelp</seg>
<seg>None</seg>
<seg><envar>$GNOME_PREFIX</envar>/share/yelp{icons,ui,xslt}</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>
</variablelist>
</sect2>
</sect1>