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