Yelp-42.1

Introduction to Yelp

The Yelp package contains a help browser used for viewing help files.

[Note]

Note

Development versions of BLFS may not build or run some packages properly if dependencies have been updated since the most recent stable versions of the book.

Package Information

Yelp Dependencies

Required

gsettings-desktop-schemas-42.0, WebKitGTK-2.36.2 and yelp-xsl-42.0

Recommended

Optional

GTK-Doc-1.33.2

[Note]

Note

The Yelp package is not required for a functional GNOME Desktop. Note, however, that without Yelp you will not be able to view the built-in Help provided by core GNOME and many of the support applications.

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/yelp

Installation of Yelp

Install Yelp by running the following commands:

./configure --prefix=/usr --disable-static --with-webkit2gtk-4-0 &&
make

This package does not come with a test suite.

Now, as the root user:

make install

Still as the root user, ensure that /usr/share/applications/mimeinfo.cache will be updated and therefore the help in gnome applications will work.

update-desktop-database

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

--enable-gtk-doc: Use this parameter if GTK-Doc is installed and you wish to rebuild and install the API documentation.

Contents

Installed Program: gnome-help (symlink) and yelp
Installed Library: libyelp.so
Installed Directories: /usr/include/libyelp, /usr/share/gtk-doc/html/libyelp (optional), and /usr/{lib,share}/yelp

Short Descriptions

yelp

is the GNOME Help Browser

libyelp.so

contains the Yelp API functions