source:
gnome/desktop/yelp.xml@
27be51f
Last change on this file since 27be51f was c8ef170, checked in by , 10 years ago | |
---|---|
|
|
File size: 5.1 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-minor14;/yelp-&yelp-version;.tar.xz"> |
8 | <!ENTITY yelp-download-ftp "&gnome-download-ftp;/yelp/&gnome-minor14;/yelp-&yelp-version;.tar.xz"> |
9 | <!ENTITY yelp-md5sum "1e2c282183761904c507c7efa6be7037"> |
10 | <!ENTITY yelp-size "1.3 MB"> |
11 | <!ENTITY yelp-buildsize "19.8 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> |
33 | The <application>Yelp</application> package contains the help |
34 | browser used for viewing help files. |
35 | </para> |
36 | |
37 | &lfs76_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="webkitgtk2"/> and |
78 | <xref linkend="yelp-xsl"/> |
79 | </para> |
80 | |
81 | <bridgehead renderas="sect4">Optional</bridgehead> |
82 | <para role="optional"> |
83 | <xref linkend="gtk-doc"/> |
84 | </para> |
85 | |
86 | <note> |
87 | <para> |
88 | The <application>Yelp</application> package is not required for a |
89 | functional <application>GNOME</application> Desktop. Note, however, that |
90 | without <application>Yelp</application> you will not be able to view the |
91 | built-in Help provided by core <application>GNOME</application> and many |
92 | of the support applications. |
93 | </para> |
94 | </note> |
95 | |
96 | <para condition="html" role="usernotes">User Notes: |
97 | <ulink url="&blfs-wiki;/yelp"/> |
98 | </para> |
99 | </sect2> |
100 | |
101 | <sect2 role="installation"> |
102 | <title>Installation of Yelp</title> |
103 | |
104 | <para> |
105 | Install <application>Yelp</application> by running the following |
106 | commands: |
107 | </para> |
108 | |
109 | <screen><userinput>./configure --prefix=/usr --disable-static && |
110 | make</userinput></screen> |
111 | |
112 | <para> |
113 | To test the results, issue <command>make check</command>. |
114 | </para> |
115 | |
116 | <para> |
117 | Now, as the <systemitem class="username">root</systemitem> user: |
118 | </para> |
119 | |
120 | <screen role="root"><userinput>make install</userinput></screen> |
121 | |
122 | </sect2> |
123 | |
124 | <sect2 role="commands"> |
125 | <title>Command Explanations</title> |
126 | |
127 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" |
128 | href="../../xincludes/static-libraries.xml"/> |
129 | |
130 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" |
131 | href="../../xincludes/gtk-doc-rebuild.xml"/> |
132 | |
133 | </sect2> |
134 | |
135 | <sect2 role="content"> |
136 | <title>Contents</title> |
137 | |
138 | <segmentedlist> |
139 | <segtitle>Installed Programs</segtitle> |
140 | <segtitle>Installed Libraries</segtitle> |
141 | <segtitle>Installed Directories</segtitle> |
142 | |
143 | <seglistitem> |
144 | <seg> |
145 | gnome-help and yelp |
146 | </seg> |
147 | <seg> |
148 | libyelp.so |
149 | </seg> |
150 | <seg> |
151 | /usr/include/libyelp, |
152 | /usr/share/gtk-doc/html/libyelp, |
153 | /usr/share/yelp-xsl, and |
154 | /usr/share/yelp |
155 | </seg> |
156 | </seglistitem> |
157 | </segmentedlist> |
158 | |
159 | <variablelist> |
160 | <bridgehead renderas="sect3">Short Descriptions</bridgehead> |
161 | <?dbfo list-presentation="list"?> |
162 | <?dbhtml list-presentation="table"?> |
163 | |
164 | <varlistentry id="yelp-prog"> |
165 | <term><command>yelp</command></term> |
166 | <listitem> |
167 | <para> |
168 | is the <application>GNOME</application> Help Browser. |
169 | </para> |
170 | <indexterm zone="yelp yelp-prog"> |
171 | <primary sortas="b-yelp">yelp</primary> |
172 | </indexterm> |
173 | </listitem> |
174 | </varlistentry> |
175 | |
176 | <varlistentry id="libyelp"> |
177 | <term><filename class="libraryfile">libyelp.so</filename></term> |
178 | <listitem> |
179 | <para> |
180 | contains the <application>Yelp</application> API functions. |
181 | </para> |
182 | <indexterm zone="yelp libyelp"> |
183 | <primary sortas="c-libyelp">libyelp.so</primary> |
184 | </indexterm> |
185 | </listitem> |
186 | </varlistentry> |
187 | |
188 | </variablelist> |
189 | |
190 | </sect2> |
191 | |
192 | </sect1> |
Note:
See TracBrowser
for help on using the repository browser.