[9d2dc4e2] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[9d2dc4e2] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[d0e0395] | 7 | <!ENTITY yelp-download-http "&gnome-download-http;/yelp/3.4/yelp-&yelp-version;.tar.xz">
|
---|
| 8 | <!ENTITY yelp-download-ftp "&gnome-download-ftp;/yelp/3.4/yelp-&yelp-version;.tar.xz">
|
---|
| 9 | <!ENTITY yelp-md5sum "aefc85f4e116ae90d6ea1bc346d955bd">
|
---|
| 10 | <!ENTITY yelp-size "832 KB">
|
---|
| 11 | <!ENTITY yelp-buildsize "15 MB">
|
---|
[957682e] | 12 | <!ENTITY yelp-time "0.3 SBU">
|
---|
[9d2dc4e2] | 13 | ]>
|
---|
| 14 |
|
---|
[9b8404e] | 15 | <sect1 id="yelp" xreflabel="Yelp-&yelp-version;">
|
---|
[ce861f3] | 16 | <?dbhtml filename="yelp.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Yelp-&yelp-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="yelp">
|
---|
| 26 | <primary sortas="a-Yelp">Yelp</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Yelp</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>Yelp</application> package contains the help
|
---|
| 33 | browser. This is useful for viewing help files.</para>
|
---|
| 34 |
|
---|
[f889089] | 35 | &lfs70_checked;
|
---|
[957682e] | 36 |
|
---|
[ce861f3] | 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>Download (HTTP): <ulink url="&yelp-download-http;"/></para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (FTP): <ulink url="&yelp-download-ftp;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download MD5 sum: &yelp-md5sum;</para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download size: &yelp-size;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Estimated disk space required: &yelp-buildsize;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated build time: &yelp-time;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | </itemizedlist>
|
---|
| 58 |
|
---|
| 59 | <bridgehead renderas="sect3">Yelp Dependencies</bridgehead>
|
---|
| 60 |
|
---|
| 61 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[d0e0395] | 62 | <para role="required">
|
---|
| 63 | <xref linkend="gnome-doc-utils"/>,
|
---|
| 64 | <xref linkend="webkitgtk"/> and
|
---|
| 65 | <xref linkend="yelp-xsl"/>
|
---|
| 66 | </para>
|
---|
[a6bee1f] | 67 |
|
---|
| 68 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[d0e0395] | 69 | <para role="optional">
|
---|
| 70 | <xref linkend="gtk-doc"/> and
|
---|
| 71 | <xref linkend="rarian"/>
|
---|
| 72 | </para>
|
---|
[51d7b70] | 73 |
|
---|
| 74 | <note>
|
---|
| 75 | <para>The <application>Yelp</application> package is not required for a
|
---|
| 76 | functional <application>GNOME</application> desktop. Note, however, that
|
---|
| 77 | without <application>Yelp</application> you will not be able to view the
|
---|
| 78 | built-in Help provided by core <application>GNOME</application> and many
|
---|
[f889089] | 79 | of the support applications.</para>
|
---|
[51d7b70] | 80 | </note>
|
---|
[ce861f3] | 81 |
|
---|
[0a7c3921] | 82 | <para condition="html" role="usernotes">User Notes:
|
---|
| 83 | <ulink url="&blfs-wiki;/yelp"/></para>
|
---|
| 84 |
|
---|
[ce861f3] | 85 | </sect2>
|
---|
| 86 |
|
---|
| 87 | <sect2 role="installation">
|
---|
| 88 | <title>Installation of Yelp</title>
|
---|
| 89 |
|
---|
| 90 | <para>Install <application>Yelp</application> by running the following
|
---|
| 91 | commands:</para>
|
---|
| 92 |
|
---|
[d0e0395] | 93 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[ce861f3] | 94 | make</userinput></screen>
|
---|
[474231bf] | 95 |
|
---|
[ce861f3] | 96 | <para>This package does not come with a test suite.</para>
|
---|
[474231bf] | 97 |
|
---|
[ce861f3] | 98 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[474231bf] | 99 |
|
---|
[ce861f3] | 100 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[9d2dc4e2] | 101 |
|
---|
[ce861f3] | 102 | </sect2>
|
---|
[9d2dc4e2] | 103 |
|
---|
[d0e0395] | 104 | <sect2 role="commands">
|
---|
| 105 | <title>Command Explanations</title>
|
---|
| 106 |
|
---|
| 107 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 108 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 109 |
|
---|
| 110 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 111 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 112 |
|
---|
| 113 | </sect2>
|
---|
| 114 |
|
---|
[ce861f3] | 115 | <sect2 role="content">
|
---|
| 116 | <title>Contents</title>
|
---|
[9d2dc4e2] | 117 |
|
---|
[ce861f3] | 118 | <segmentedlist>
|
---|
[f889089] | 119 | <segtitle>Installed Programs</segtitle>
|
---|
[d0e0395] | 120 | <segtitle>Installed Library</segtitle>
|
---|
| 121 | <segtitle>Installed Directories</segtitle>
|
---|
[9d2dc4e2] | 122 |
|
---|
[ce861f3] | 123 | <seglistitem>
|
---|
[d0e0395] | 124 | <seg>
|
---|
| 125 | gnome-help (a symlink to yelp) and yelp
|
---|
| 126 | </seg>
|
---|
| 127 | <seg>
|
---|
| 128 | libyelp.so
|
---|
| 129 | </seg>
|
---|
| 130 | <seg>
|
---|
| 131 | /usr/include/libyelp, /usr/share/yelp and
|
---|
| 132 | /usr/share/gtk-doc/html/libyelp
|
---|
| 133 | </seg>
|
---|
[ce861f3] | 134 | </seglistitem>
|
---|
| 135 | </segmentedlist>
|
---|
[9d2dc4e2] | 136 |
|
---|
[ce861f3] | 137 | <variablelist>
|
---|
| 138 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 139 | <?dbfo list-presentation="list"?>
|
---|
| 140 | <?dbhtml list-presentation="table"?>
|
---|
[9d2dc4e2] | 141 |
|
---|
[ce861f3] | 142 | <varlistentry id="yelp-prog">
|
---|
| 143 | <term><command>yelp</command></term>
|
---|
| 144 | <listitem>
|
---|
| 145 | <para>is the <application>GNOME</application> help browser.</para>
|
---|
| 146 | <indexterm zone="yelp yelp-prog">
|
---|
| 147 | <primary sortas="b-yelp">yelp</primary>
|
---|
| 148 | </indexterm>
|
---|
| 149 | </listitem>
|
---|
| 150 | </varlistentry>
|
---|
[9d2dc4e2] | 151 |
|
---|
[d0e0395] | 152 | <varlistentry id="libyelp">
|
---|
| 153 | <term><filename class="libraryfile">libyelp.so</filename></term>
|
---|
| 154 | <listitem>
|
---|
| 155 | <para>contains Yelp API functions.</para>
|
---|
| 156 | <indexterm zone="yelp libyelp">
|
---|
| 157 | <primary sortas="c-libyelp">libyelp.so</primary>
|
---|
| 158 | </indexterm>
|
---|
| 159 | </listitem>
|
---|
| 160 | </varlistentry>
|
---|
| 161 |
|
---|
[ce861f3] | 162 | </variablelist>
|
---|
[8945b1e] | 163 |
|
---|
[ce861f3] | 164 | </sect2>
|
---|
| 165 |
|
---|
[51d7b70] | 166 | </sect1>
|
---|