source: gnome/platform/yelp.xml@ 45ab6c7

trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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