[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">
|
---|
[7ded7e3] | 9 | <!ENTITY yelp-md5sum "6b6583e04f34a0194a894d2342d1d6f9">
|
---|
| 10 | <!ENTITY yelp-size "828 KB">
|
---|
| 11 | <!ENTITY yelp-buildsize "18 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 |
|
---|
[7ded7e3] | 32 | <para>
|
---|
| 33 | The <application>Yelp</application> package contains the help
|
---|
| 34 | browser used for viewing help files.
|
---|
| 35 | </para>
|
---|
[ce861f3] | 36 |
|
---|
[f889089] | 37 | &lfs70_checked;
|
---|
[957682e] | 38 |
|
---|
[ce861f3] | 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[7ded7e3] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&yelp-download-http;"/>
|
---|
| 44 | </para>
|
---|
[ce861f3] | 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
[7ded7e3] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&yelp-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[ce861f3] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[7ded7e3] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &yelp-md5sum;
|
---|
| 54 | </para>
|
---|
[ce861f3] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[7ded7e3] | 57 | <para>
|
---|
| 58 | Download size: &yelp-size;
|
---|
| 59 | </para>
|
---|
[ce861f3] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[7ded7e3] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &yelp-buildsize;
|
---|
| 64 | </para>
|
---|
[ce861f3] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[7ded7e3] | 67 | <para>
|
---|
| 68 | Estimated build time: &yelp-time;
|
---|
| 69 | </para>
|
---|
[ce861f3] | 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">Yelp Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[d0e0395] | 76 | <para role="required">
|
---|
| 77 | <xref linkend="gnome-doc-utils"/>,
|
---|
| 78 | <xref linkend="webkitgtk"/> and
|
---|
| 79 | <xref linkend="yelp-xsl"/>
|
---|
| 80 | </para>
|
---|
[a6bee1f] | 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[d0e0395] | 83 | <para role="optional">
|
---|
[ef6d249] | 84 | <xref linkend="gtk-doc"/>
|
---|
[d0e0395] | 85 | </para>
|
---|
[51d7b70] | 86 |
|
---|
| 87 | <note>
|
---|
[7ded7e3] | 88 | <para>
|
---|
| 89 | The <application>Yelp</application> package is not required for a
|
---|
| 90 | functional <application>GNOME</application> Desktop. Note, however, that
|
---|
| 91 | without <application>Yelp</application> you will not be able to view the
|
---|
| 92 | built-in Help provided by core <application>GNOME</application> and many
|
---|
| 93 | of the support applications.
|
---|
| 94 | </para>
|
---|
[51d7b70] | 95 | </note>
|
---|
[ce861f3] | 96 |
|
---|
[0a7c3921] | 97 | <para condition="html" role="usernotes">User Notes:
|
---|
[7ded7e3] | 98 | <ulink url="&blfs-wiki;/yelp"/>
|
---|
| 99 | </para>
|
---|
[ce861f3] | 100 | </sect2>
|
---|
| 101 |
|
---|
| 102 | <sect2 role="installation">
|
---|
| 103 | <title>Installation of Yelp</title>
|
---|
| 104 |
|
---|
[7ded7e3] | 105 | <para>
|
---|
| 106 | Install <application>Yelp</application> by running the following
|
---|
| 107 | commands:
|
---|
| 108 | </para>
|
---|
[ce861f3] | 109 |
|
---|
[d0e0395] | 110 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[ce861f3] | 111 | make</userinput></screen>
|
---|
[474231bf] | 112 |
|
---|
[7ded7e3] | 113 | <para>
|
---|
| 114 | This package does not come with a test suite.
|
---|
| 115 | </para>
|
---|
[474231bf] | 116 |
|
---|
[7ded7e3] | 117 | <para>
|
---|
| 118 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 119 | </para>
|
---|
[474231bf] | 120 |
|
---|
[ce861f3] | 121 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[9d2dc4e2] | 122 |
|
---|
[ce861f3] | 123 | </sect2>
|
---|
[9d2dc4e2] | 124 |
|
---|
[d0e0395] | 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
| 127 |
|
---|
| 128 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[7ded7e3] | 129 | href="../../xincludes/static-libraries.xml"/>
|
---|
[d0e0395] | 130 |
|
---|
| 131 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[7ded7e3] | 132 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[d0e0395] | 133 |
|
---|
| 134 | </sect2>
|
---|
| 135 |
|
---|
[ce861f3] | 136 | <sect2 role="content">
|
---|
| 137 | <title>Contents</title>
|
---|
[9d2dc4e2] | 138 |
|
---|
[ce861f3] | 139 | <segmentedlist>
|
---|
[7ded7e3] | 140 | <segtitle>Installed Program</segtitle>
|
---|
[d0e0395] | 141 | <segtitle>Installed Library</segtitle>
|
---|
| 142 | <segtitle>Installed Directories</segtitle>
|
---|
[9d2dc4e2] | 143 |
|
---|
[ce861f3] | 144 | <seglistitem>
|
---|
[d0e0395] | 145 | <seg>
|
---|
[7ded7e3] | 146 | yelp
|
---|
[d0e0395] | 147 | </seg>
|
---|
| 148 | <seg>
|
---|
| 149 | libyelp.so
|
---|
| 150 | </seg>
|
---|
| 151 | <seg>
|
---|
[7ded7e3] | 152 | /usr/include/libyelp,
|
---|
| 153 | /usr/share/yelp and
|
---|
[d0e0395] | 154 | /usr/share/gtk-doc/html/libyelp
|
---|
| 155 | </seg>
|
---|
[ce861f3] | 156 | </seglistitem>
|
---|
| 157 | </segmentedlist>
|
---|
[9d2dc4e2] | 158 |
|
---|
[ce861f3] | 159 | <variablelist>
|
---|
| 160 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 161 | <?dbfo list-presentation="list"?>
|
---|
| 162 | <?dbhtml list-presentation="table"?>
|
---|
[9d2dc4e2] | 163 |
|
---|
[ce861f3] | 164 | <varlistentry id="yelp-prog">
|
---|
| 165 | <term><command>yelp</command></term>
|
---|
| 166 | <listitem>
|
---|
[7ded7e3] | 167 | <para>
|
---|
| 168 | is the <application>GNOME</application> Help Browser.
|
---|
| 169 | </para>
|
---|
[ce861f3] | 170 | <indexterm zone="yelp yelp-prog">
|
---|
| 171 | <primary sortas="b-yelp">yelp</primary>
|
---|
| 172 | </indexterm>
|
---|
| 173 | </listitem>
|
---|
| 174 | </varlistentry>
|
---|
[9d2dc4e2] | 175 |
|
---|
[d0e0395] | 176 | <varlistentry id="libyelp">
|
---|
| 177 | <term><filename class="libraryfile">libyelp.so</filename></term>
|
---|
| 178 | <listitem>
|
---|
[7ded7e3] | 179 | <para>
|
---|
| 180 | contains the <application>Yelp</application> API functions.
|
---|
| 181 | </para>
|
---|
[d0e0395] | 182 | <indexterm zone="yelp libyelp">
|
---|
| 183 | <primary sortas="c-libyelp">libyelp.so</primary>
|
---|
| 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
[ce861f3] | 188 | </variablelist>
|
---|
[8945b1e] | 189 |
|
---|
[ce861f3] | 190 | </sect2>
|
---|
| 191 |
|
---|
[51d7b70] | 192 | </sect1>
|
---|