[9d2dc4e2] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[9d2dc4e2] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[937425f] | 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 "e229529aa1dacfd269024511e2c12ad2">
|
---|
[51d7b70] | 10 | <!ENTITY yelp-size "815 KB">
|
---|
[937425f] | 11 | <!ENTITY yelp-buildsize "12.2 MB">
|
---|
[51d7b70] | 12 | <!ENTITY yelp-time "0.2 SBU">
|
---|
[9d2dc4e2] | 13 | ]>
|
---|
| 14 |
|
---|
[9b8404e] | 15 | <sect1 id="yelp" xreflabel="Yelp-&yelp-version;">
|
---|
[ce861f3] | 16 | <?dbhtml filename="yelp.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[b22e19bf] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">yelp-&yelp-version;.tar</keyword>
|
---|
[e7307aa1] | 23 | <keyword role="ftpdir">yelp</keyword>
|
---|
[b22e19bf] | 24 | </keywordset>
|
---|
[ce861f3] | 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>
|
---|
[b22e19bf] | 64 | <para role="required"><xref linkend="libgnomeui"/>,
|
---|
[937425f] | 65 | <xref linkend="gnome-doc-utils"/>, and
|
---|
[51d7b70] | 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>
|
---|
[ce861f3] | 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` \
|
---|
[e62f701] | 91 | --localstatedir=/var/lib \
|
---|
| 92 | --sysconfdir=&gnome-etc-dir; &&
|
---|
[ce861f3] | 93 | make</userinput></screen>
|
---|
[474231bf] | 94 |
|
---|
[ce861f3] | 95 | <para>This package does not come with a test suite.</para>
|
---|
[474231bf] | 96 |
|
---|
[ce861f3] | 97 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[474231bf] | 98 |
|
---|
[ce861f3] | 99 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[9d2dc4e2] | 100 |
|
---|
[ce861f3] | 101 | </sect2>
|
---|
[9d2dc4e2] | 102 |
|
---|
[ce861f3] | 103 | <sect2 role="commands">
|
---|
| 104 | <title>Command Explanations</title>
|
---|
[9d2dc4e2] | 105 |
|
---|
[ce861f3] | 106 | <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
|
---|
| 107 | <application>ScrollKeeper</application> files in
|
---|
| 108 | <filename class='directory'>/var/lib/scrollkeeper</filename> instead of
|
---|
| 109 | <filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>
|
---|
[36a6231] | 110 |
|
---|
[ce861f3] | 111 | </sect2>
|
---|
[9d2dc4e2] | 112 |
|
---|
[ce861f3] | 113 | <sect2 role="content">
|
---|
| 114 | <title>Contents</title>
|
---|
[9d2dc4e2] | 115 |
|
---|
[ce861f3] | 116 | <segmentedlist>
|
---|
| 117 | <segtitle>Installed Programs</segtitle>
|
---|
[51d7b70] | 118 | <segtitle>Installed Libraries</segtitle>
|
---|
[f8ad622] | 119 | <segtitle>Installed Directories</segtitle>
|
---|
[9d2dc4e2] | 120 |
|
---|
[ce861f3] | 121 | <seglistitem>
|
---|
| 122 | <seg>gnome-help and yelp</seg>
|
---|
[51d7b70] | 123 | <seg>None</seg>
|
---|
[e62f701] | 124 | <seg>&gnome-etc-dir;/gconf/gconf.xml.defaults/[,schemas/]apps/yelp and
|
---|
[f8ad622] | 125 | $GNOME_PREFIX/share/yelp</seg>
|
---|
[ce861f3] | 126 | </seglistitem>
|
---|
| 127 | </segmentedlist>
|
---|
[9d2dc4e2] | 128 |
|
---|
[ce861f3] | 129 | <variablelist>
|
---|
| 130 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 131 | <?dbfo list-presentation="list"?>
|
---|
| 132 | <?dbhtml list-presentation="table"?>
|
---|
[9d2dc4e2] | 133 |
|
---|
[ce861f3] | 134 | <varlistentry id="gnome-help">
|
---|
| 135 | <term><command>gnome-help</command></term>
|
---|
| 136 | <listitem>
|
---|
| 137 | <para>is a symbolic link to <command>yelp</command>.</para>
|
---|
| 138 | <indexterm zone="yelp gnome-help">
|
---|
| 139 | <primary sortas="b-gnome-help">gnome-help</primary>
|
---|
| 140 | </indexterm>
|
---|
| 141 | </listitem>
|
---|
| 142 | </varlistentry>
|
---|
[474231bf] | 143 |
|
---|
[ce861f3] | 144 | <varlistentry id="yelp-prog">
|
---|
| 145 | <term><command>yelp</command></term>
|
---|
| 146 | <listitem>
|
---|
| 147 | <para>is the <application>GNOME</application> help browser.</para>
|
---|
| 148 | <indexterm zone="yelp yelp-prog">
|
---|
| 149 | <primary sortas="b-yelp">yelp</primary>
|
---|
| 150 | </indexterm>
|
---|
| 151 | </listitem>
|
---|
| 152 | </varlistentry>
|
---|
[9d2dc4e2] | 153 |
|
---|
[ce861f3] | 154 | </variablelist>
|
---|
[8945b1e] | 155 |
|
---|
[ce861f3] | 156 | </sect2>
|
---|
| 157 |
|
---|
[51d7b70] | 158 | </sect1>
|
---|