source: gnome/core/yelp.xml@ 551b9389

10.0 10.1 11.0 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 551b9389 was 551b9389, checked in by Randy McMurchy <randy@…>, 15 years ago

Minor fixes and clean-up to the core GNOME-2 package instructions including standardizing the text in the 'Command Explanations' section by using xinclude files and changing the creation of symbolic links to using PYTHONPATH so Python can find modules installed in non-standard locations

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6211 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.5 KB
Line 
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 "&gnome-download-http;/yelp/&gnome-version;/yelp-&yelp-version;.tar.bz2">
8 <!ENTITY yelp-download-ftp "&gnome-download-ftp;/yelp/&gnome-version;/yelp-&yelp-version;.tar.bz2">
9 <!ENTITY yelp-md5sum "4294fe3b01824675bd8be9d7936dcaa7">
10 <!ENTITY yelp-size "774 KB">
11 <!ENTITY yelp-buildsize "15.6 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="libgnomeprintui"/>,
62 <xref linkend="startup-notification"/>,
63 <xref linkend="gnome-doc-utils"/>, and
64 a mozilla.org Gecko layout engine
65 (<xref linkend="seamonkey"/> or
66 <xref linkend="firefox"/> or
67 <xref linkend="thunderbird"/> or
68 <ulink url="http://www.mozilla.org/products/mozilla1.x/">Mozilla</ulink>)</para>
69
70 <bridgehead renderas="sect4">Optional</bridgehead>
71 <para role="optional">
72 <ulink url="http://beaglewiki.org/Main_Page">Beagle</ulink></para>
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
79 of the support applications. This is mentioned here because you may not
80 wish to install a Gecko layout engine. Without a Gecko layout engine you
81 will have no graphical browser capability as the default GNOME browser,
82 <xref linkend="epiphany"/>, also requires a Gecko layout engine.</para>
83 </note>
84
85 <para condition="html" role="usernotes">User Notes:
86 <ulink url="&blfs-wiki;/yelp"/></para>
87
88 </sect2>
89
90 <sect2 role="installation">
91 <title>Installation of Yelp</title>
92
93 <para>Install <application>Yelp</application> by running the following
94 commands:</para>
95
96<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
97 --sysconfdir=&gnome-etc-dir; \
98 --localstatedir=/var/lib &amp;&amp;
99make</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="../gnome-prefix.xml"/>
114
115 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
116 href="../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>
Note: See TracBrowser for help on using the repository browser.