glfs/gnome/core/yelp.xml
Manuel Canales Esparcia f8ad622f7b Completed the list of installed directories by GNOME core packages.
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@4413 af4574ff-66df-0310-9fd7-8a98e5e911e0
2005-05-21 14:40:57 +00:00

143 lines
4.4 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;">
<?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>
<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><xref linkend="libgnomeui"/>,
<xref linkend="libgtkhtml"/> and
<xref linkend="scrollkeeper"/></para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para><xref linkend="gnome-doc-utils"/> (required for XSLT
transformations)</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` \
--localstatedir=/var/lib &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>
<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 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>gnome-help and yelp</seg>
<seg>GNOME_Yelp.server bonobo server</seg>
<seg>$GNOME_PREFIX/share/sgml/docbook/yelp and
$GNOME_PREFIX/share/yelp</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="gnome-help">
<term><command>gnome-help</command></term>
<listitem>
<para>is a symbolic link to <command>yelp</command>.</para>
<indexterm zone="yelp gnome-help">
<primary sortas="b-gnome-help">gnome-help</primary>
</indexterm>
</listitem>
</varlistentry>
<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>