1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY yelp-download-http "http://ftp.gnome.org/pub/GNOME/sources/yelp/&gnome-version;/yelp-&yelp-version;.tar.bz2">
|
---|
8 | <!ENTITY yelp-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/yelp/&gnome-version;/yelp-&yelp-version;.tar.bz2">
|
---|
9 | <!ENTITY yelp-md5sum "d6a9c142ca367447f06cee003b6d8a5d">
|
---|
10 | <!ENTITY yelp-size "815 KB">
|
---|
11 | <!ENTITY yelp-buildsize "12.5 MB">
|
---|
12 | <!ENTITY yelp-time "0.2 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 | <keywordset>
|
---|
22 | <keyword role="package">yelp-&yelp-version;.tar</keyword>
|
---|
23 | <keyword role="ftpdir">yelp</keyword>
|
---|
24 | </keywordset>
|
---|
25 | </sect1info>
|
---|
26 |
|
---|
27 | <title>Yelp-&yelp-version;</title>
|
---|
28 |
|
---|
29 | <indexterm zone="yelp">
|
---|
30 | <primary sortas="a-Yelp">Yelp</primary>
|
---|
31 | </indexterm>
|
---|
32 |
|
---|
33 | <sect2 role="package">
|
---|
34 | <title>Introduction to Yelp</title>
|
---|
35 |
|
---|
36 | <para>The <application>Yelp</application> package contains the help
|
---|
37 | browser. This is useful for viewing help files.</para>
|
---|
38 |
|
---|
39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
40 | <itemizedlist spacing="compact">
|
---|
41 | <listitem>
|
---|
42 | <para>Download (HTTP): <ulink url="&yelp-download-http;"/></para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>Download (FTP): <ulink url="&yelp-download-ftp;"/></para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>Download MD5 sum: &yelp-md5sum;</para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download size: &yelp-size;</para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Estimated disk space required: &yelp-buildsize;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Estimated build time: &yelp-time;</para>
|
---|
58 | </listitem>
|
---|
59 | </itemizedlist>
|
---|
60 |
|
---|
61 | <bridgehead renderas="sect3">Yelp Dependencies</bridgehead>
|
---|
62 |
|
---|
63 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
64 | <para role="required"><xref linkend="libgnomeui"/>,
|
---|
65 | <xref linkend="gnome-doc-utils"/> and
|
---|
66 | a Gecko HTML rendering engine (<xref linkend="mozilla"/> or
|
---|
67 | <xref linkend="firefox"/> or
|
---|
68 | <xref linkend="thunderbird"/>)</para>
|
---|
69 |
|
---|
70 | <note>
|
---|
71 | <para>The <application>Yelp</application> package is not required for a
|
---|
72 | functional <application>GNOME</application> desktop. Note, however, that
|
---|
73 | without <application>Yelp</application> you will not be able to view the
|
---|
74 | built-in Help provided by core <application>GNOME</application> and many
|
---|
75 | of the support applications. This is mentioned here because you may not
|
---|
76 | wish to install a Gecko rendering engine. Without a Gecko rendering
|
---|
77 | engine you will have no graphical browser capability as the default
|
---|
78 | <application>GNOME</application> browser, <xref linkend="epiphany"/>,
|
---|
79 | also requires a Gecko rendering engine.</para>
|
---|
80 | </note>
|
---|
81 |
|
---|
82 | </sect2>
|
---|
83 |
|
---|
84 | <sect2 role="installation">
|
---|
85 | <title>Installation of Yelp</title>
|
---|
86 |
|
---|
87 | <para>Install <application>Yelp</application> by running the following
|
---|
88 | commands:</para>
|
---|
89 |
|
---|
90 | <screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
|
---|
91 | --localstatedir=/var/lib --sysconfdir=/etc/gnome &&
|
---|
92 | make</userinput></screen>
|
---|
93 |
|
---|
94 | <para>This package does not come with a test suite.</para>
|
---|
95 |
|
---|
96 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
97 |
|
---|
98 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
99 |
|
---|
100 | </sect2>
|
---|
101 |
|
---|
102 | <sect2 role="commands">
|
---|
103 | <title>Command Explanations</title>
|
---|
104 |
|
---|
105 | <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
|
---|
106 | <application>ScrollKeeper</application> files in
|
---|
107 | <filename class='directory'>/var/lib/scrollkeeper</filename> instead of
|
---|
108 | <filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>
|
---|
109 |
|
---|
110 | </sect2>
|
---|
111 |
|
---|
112 | <sect2 role="content">
|
---|
113 | <title>Contents</title>
|
---|
114 |
|
---|
115 | <segmentedlist>
|
---|
116 | <segtitle>Installed Programs</segtitle>
|
---|
117 | <segtitle>Installed Libraries</segtitle>
|
---|
118 | <segtitle>Installed Directories</segtitle>
|
---|
119 |
|
---|
120 | <seglistitem>
|
---|
121 | <seg>gnome-help and yelp</seg>
|
---|
122 | <seg>None</seg>
|
---|
123 | <seg>/etc/gnome/gconf/gconf.xml.defaults/apps/yelp,
|
---|
124 | /etc/gnome/gconf/gconf.xml.defaults/schemas/apps/yelp,
|
---|
125 | $GNOME_PREFIX/share/icons/hicolor/192x192 and
|
---|
126 | $GNOME_PREFIX/share/yelp</seg>
|
---|
127 | </seglistitem>
|
---|
128 | </segmentedlist>
|
---|
129 |
|
---|
130 | <variablelist>
|
---|
131 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
132 | <?dbfo list-presentation="list"?>
|
---|
133 | <?dbhtml list-presentation="table"?>
|
---|
134 |
|
---|
135 | <varlistentry id="gnome-help">
|
---|
136 | <term><command>gnome-help</command></term>
|
---|
137 | <listitem>
|
---|
138 | <para>is a symbolic link to <command>yelp</command>.</para>
|
---|
139 | <indexterm zone="yelp gnome-help">
|
---|
140 | <primary sortas="b-gnome-help">gnome-help</primary>
|
---|
141 | </indexterm>
|
---|
142 | </listitem>
|
---|
143 | </varlistentry>
|
---|
144 |
|
---|
145 | <varlistentry id="yelp-prog">
|
---|
146 | <term><command>yelp</command></term>
|
---|
147 | <listitem>
|
---|
148 | <para>is the <application>GNOME</application> help browser.</para>
|
---|
149 | <indexterm zone="yelp yelp-prog">
|
---|
150 | <primary sortas="b-yelp">yelp</primary>
|
---|
151 | </indexterm>
|
---|
152 | </listitem>
|
---|
153 | </varlistentry>
|
---|
154 |
|
---|
155 | </variablelist>
|
---|
156 |
|
---|
157 | </sect2>
|
---|
158 |
|
---|
159 | </sect1>
|
---|