1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY yelp-download-http "&gnome-download-http;/yelp/&gnome-minor-28;/yelp-&yelp-version;.tar.xz">
|
---|
8 | <!ENTITY yelp-download-ftp "&gnome-download-ftp;/yelp/&gnome-minor-28;/yelp-&yelp-version;.tar.xz">
|
---|
9 | <!ENTITY yelp-md5sum "539681058dbb2968f0305fd4b3abc598">
|
---|
10 | <!ENTITY yelp-size "1.3 MB">
|
---|
11 | <!ENTITY yelp-buildsize "22 MB">
|
---|
12 | <!ENTITY yelp-time "0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="yelp" xreflabel="Yelp-&yelp-version;">
|
---|
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>
|
---|
33 | The <application>Yelp</application> package contains a help
|
---|
34 | browser used for viewing help files.
|
---|
35 | </para>
|
---|
36 |
|
---|
37 | &lfs82_checked;
|
---|
38 |
|
---|
39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
40 | <itemizedlist spacing="compact">
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (HTTP): <ulink url="&yelp-download-http;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download (FTP): <ulink url="&yelp-download-ftp;"/>
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download MD5 sum: &yelp-md5sum;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Download size: &yelp-size;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated disk space required: &yelp-buildsize;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | <listitem>
|
---|
67 | <para>
|
---|
68 | Estimated build time: &yelp-time;
|
---|
69 | </para>
|
---|
70 | </listitem>
|
---|
71 | </itemizedlist>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect3">Yelp Dependencies</bridgehead>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
76 | <para role="required">
|
---|
77 | <xref linkend="gsettings-desktop-schemas"/>,
|
---|
78 | <xref linkend="webkitgtk"/> and
|
---|
79 | <xref linkend="yelp-xsl"/>
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
83 | <para role="recommended">
|
---|
84 | <xref linkend="desktop-file-utils"/>
|
---|
85 | </para>
|
---|
86 |
|
---|
87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
88 | <para role="optional">
|
---|
89 | <xref linkend="gtk-doc"/>
|
---|
90 | </para>
|
---|
91 |
|
---|
92 | <note>
|
---|
93 | <para>
|
---|
94 | The <application>Yelp</application> package is not required for a
|
---|
95 | functional <application>GNOME</application> Desktop. Note, however, that
|
---|
96 | without <application>Yelp</application> you will not be able to view the
|
---|
97 | built-in Help provided by core <application>GNOME</application> and many
|
---|
98 | of the support applications.
|
---|
99 | </para>
|
---|
100 | </note>
|
---|
101 |
|
---|
102 | <para condition="html" role="usernotes">User Notes:
|
---|
103 | <ulink url="&blfs-wiki;/yelp"/>
|
---|
104 | </para>
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="installation">
|
---|
108 | <title>Installation of Yelp</title>
|
---|
109 |
|
---|
110 | <para>
|
---|
111 | Install <application>Yelp</application> by running the following
|
---|
112 | commands:
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
116 | make</userinput></screen>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | This package does not come with a test suite.
|
---|
120 | </para>
|
---|
121 |
|
---|
122 | <para>
|
---|
123 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
124 | </para>
|
---|
125 |
|
---|
126 | <screen role="root"><userinput>make install &&
|
---|
127 | update-desktop-database</userinput></screen>
|
---|
128 |
|
---|
129 | </sect2>
|
---|
130 |
|
---|
131 | <sect2 role="commands">
|
---|
132 | <title>Command Explanations</title>
|
---|
133 |
|
---|
134 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
135 | href="../../xincludes/static-libraries.xml"/>
|
---|
136 |
|
---|
137 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
138 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
139 |
|
---|
140 | <para><command>update-desktop-database</command>: This ensures that
|
---|
141 | <filename>/usr/share/applications/mimeinfo.cache</filename> will
|
---|
142 | be updated and therefore the <command>help</command> in gnome
|
---|
143 | applications will work. Some packages run this command during their
|
---|
144 | installation, but yelp and the gnome applications do not.</para>
|
---|
145 |
|
---|
146 | </sect2>
|
---|
147 |
|
---|
148 | <sect2 role="content">
|
---|
149 | <title>Contents</title>
|
---|
150 |
|
---|
151 | <segmentedlist>
|
---|
152 | <segtitle>Installed Program</segtitle>
|
---|
153 | <segtitle>Installed Library</segtitle>
|
---|
154 | <segtitle>Installed Directories</segtitle>
|
---|
155 |
|
---|
156 | <seglistitem>
|
---|
157 | <seg>
|
---|
158 | gnome-help (symlink) and yelp
|
---|
159 | </seg>
|
---|
160 | <seg>
|
---|
161 | libyelp.so
|
---|
162 | </seg>
|
---|
163 | <seg>
|
---|
164 | /usr/{include,share/gtk-doc/html}/libyelp and
|
---|
165 | /usr/{lib,share}/yelp
|
---|
166 | </seg>
|
---|
167 | </seglistitem>
|
---|
168 | </segmentedlist>
|
---|
169 |
|
---|
170 | <variablelist>
|
---|
171 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
172 | <?dbfo list-presentation="list"?>
|
---|
173 | <?dbhtml list-presentation="table"?>
|
---|
174 |
|
---|
175 | <varlistentry id="yelp-prog">
|
---|
176 | <term><command>yelp</command></term>
|
---|
177 | <listitem>
|
---|
178 | <para>
|
---|
179 | is the <application>GNOME</application> Help Browser.
|
---|
180 | </para>
|
---|
181 | <indexterm zone="yelp yelp-prog">
|
---|
182 | <primary sortas="b-yelp">yelp</primary>
|
---|
183 | </indexterm>
|
---|
184 | </listitem>
|
---|
185 | </varlistentry>
|
---|
186 |
|
---|
187 | <varlistentry id="libyelp">
|
---|
188 | <term><filename class="libraryfile">libyelp.so</filename></term>
|
---|
189 | <listitem>
|
---|
190 | <para>
|
---|
191 | contains the <application>Yelp</application> API functions.
|
---|
192 | </para>
|
---|
193 | <indexterm zone="yelp libyelp">
|
---|
194 | <primary sortas="c-libyelp">libyelp.so</primary>
|
---|
195 | </indexterm>
|
---|
196 | </listitem>
|
---|
197 | </varlistentry>
|
---|
198 |
|
---|
199 | </variablelist>
|
---|
200 |
|
---|
201 | </sect2>
|
---|
202 |
|
---|
203 | </sect1>
|
---|