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-old-version;/yelp-&yelp-version;.tar.bz2">
|
---|
8 | <!ENTITY yelp-download-ftp "&gnome-download-ftp;/yelp/&gnome-old-version;/yelp-&yelp-version;.tar.bz2">
|
---|
9 | <!ENTITY yelp-md5sum "84abbfe7e042706cbf21752957e29bf3">
|
---|
10 | <!ENTITY yelp-size "900 KB">
|
---|
11 | <!ENTITY yelp-buildsize "18 MB">
|
---|
12 | <!ENTITY yelp-time "0.3 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>The <application>Yelp</application> package contains the help
|
---|
33 | browser. This is useful for viewing help files.</para>
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>Download (HTTP): <ulink url="&yelp-download-http;"/></para>
|
---|
39 | </listitem>
|
---|
40 | <listitem>
|
---|
41 | <para>Download (FTP): <ulink url="&yelp-download-ftp;"/></para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>Download MD5 sum: &yelp-md5sum;</para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>Download size: &yelp-size;</para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>Estimated disk space required: &yelp-buildsize;</para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>Estimated build time: &yelp-time;</para>
|
---|
54 | </listitem>
|
---|
55 | </itemizedlist>
|
---|
56 |
|
---|
57 | <bridgehead renderas="sect3">Yelp Dependencies</bridgehead>
|
---|
58 |
|
---|
59 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
60 | <para role="required"><xref linkend="libgnomeui"/>,
|
---|
61 | <xref linkend="startup-notification"/>,
|
---|
62 | <xref linkend="gnome-doc-utils"/>, and
|
---|
63 | a mozilla.org Gecko layout engine
|
---|
64 | (<xref linkend="seamonkey"/> or
|
---|
65 | <xref linkend="firefox"/> or
|
---|
66 | <xref linkend="thunderbird"/> or
|
---|
67 | <ulink url="http://www.mozilla.org/products/mozilla1.x/">Mozilla</ulink>)</para>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
70 | <para role="optional">
|
---|
71 | <ulink url="http://beaglewiki.org/Main_Page">Beagle</ulink></para>
|
---|
72 |
|
---|
73 | <note>
|
---|
74 | <para>The <application>Yelp</application> package is not required for a
|
---|
75 | functional <application>GNOME</application> desktop. Note, however, that
|
---|
76 | without <application>Yelp</application> you will not be able to view the
|
---|
77 | built-in Help provided by core <application>GNOME</application> and many
|
---|
78 | of the support applications. This is mentioned here because you may not
|
---|
79 | wish to install a Gecko layout engine. Without a Gecko layout engine you
|
---|
80 | will have no graphical browser capability as the default GNOME browser,
|
---|
81 | <xref linkend="epiphany"/>, also requires a Gecko layout engine.</para>
|
---|
82 | </note>
|
---|
83 |
|
---|
84 | <para condition="html" role="usernotes">User Notes:
|
---|
85 | <ulink url="&blfs-wiki;/yelp"/></para>
|
---|
86 |
|
---|
87 | </sect2>
|
---|
88 |
|
---|
89 | <sect2 role="installation">
|
---|
90 | <title>Installation of Yelp</title>
|
---|
91 |
|
---|
92 | <para>Install <application>Yelp</application> by running the following
|
---|
93 | commands:</para>
|
---|
94 |
|
---|
95 | <screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
|
---|
96 | --sysconfdir=&gnome-etc-dir; \
|
---|
97 | --localstatedir=/var/lib \
|
---|
98 | --enable-cpp-rtti &&
|
---|
99 | make</userinput></screen>
|
---|
100 |
|
---|
101 | <para>This package does not come with a test suite.</para>
|
---|
102 |
|
---|
103 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
104 |
|
---|
105 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
106 |
|
---|
107 | </sect2>
|
---|
108 |
|
---|
109 | <sect2 role="commands">
|
---|
110 | <title>Command Explanations</title>
|
---|
111 |
|
---|
112 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
113 | href="../../xincludes/gnome-prefix.xml"/>
|
---|
114 |
|
---|
115 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
116 | href="../../xincludes/gnome-sysconfdir.xml"/>
|
---|
117 |
|
---|
118 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
119 | href="../../xincludes/scrollkeeper-dir.xml"/>
|
---|
120 |
|
---|
121 | </sect2>
|
---|
122 |
|
---|
123 | <sect2 role="content">
|
---|
124 | <title>Contents</title>
|
---|
125 |
|
---|
126 | <segmentedlist>
|
---|
127 | <segtitle>Installed Programs</segtitle>
|
---|
128 | <segtitle>Installed Libraries</segtitle>
|
---|
129 | <segtitle>Installed Directory</segtitle>
|
---|
130 |
|
---|
131 | <seglistitem>
|
---|
132 | <seg>gnome-help and yelp</seg>
|
---|
133 | <seg>None</seg>
|
---|
134 | <seg><envar>$GNOME_PREFIX</envar>/share/yelp</seg>
|
---|
135 | </seglistitem>
|
---|
136 | </segmentedlist>
|
---|
137 |
|
---|
138 | <variablelist>
|
---|
139 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
140 | <?dbfo list-presentation="list"?>
|
---|
141 | <?dbhtml list-presentation="table"?>
|
---|
142 |
|
---|
143 | <varlistentry id="gnome-help">
|
---|
144 | <term><command>gnome-help</command></term>
|
---|
145 | <listitem>
|
---|
146 | <para>is a symbolic link to <command>yelp</command>.</para>
|
---|
147 | <indexterm zone="yelp gnome-help">
|
---|
148 | <primary sortas="g-gnome-help">gnome-help</primary>
|
---|
149 | </indexterm>
|
---|
150 | </listitem>
|
---|
151 | </varlistentry>
|
---|
152 |
|
---|
153 | <varlistentry id="yelp-prog">
|
---|
154 | <term><command>yelp</command></term>
|
---|
155 | <listitem>
|
---|
156 | <para>is the <application>GNOME</application> help browser.</para>
|
---|
157 | <indexterm zone="yelp yelp-prog">
|
---|
158 | <primary sortas="b-yelp">yelp</primary>
|
---|
159 | </indexterm>
|
---|
160 | </listitem>
|
---|
161 | </varlistentry>
|
---|
162 |
|
---|
163 | </variablelist>
|
---|
164 |
|
---|
165 | </sect2>
|
---|
166 |
|
---|
167 | </sect1>
|
---|