Beyond Linux® From Scratch - Version svn-20091118

Chapter 29. GNOME Core Packages

GNOME Doc Utils-0.18.0

Introduction to GNOME Doc Utils

The GNOME Doc Utils package is a collection of documentation utilities for the GNOME project. Notably, it contains utilities for building documentation and all auxiliary files in your source tree, and it contains the DocBook XSLT stylesheets that were once distributed with Yelp. Starting with GNOME 2.8, Yelp requires GNOME Doc Utils for the XSLT. Starting with GNOME 2.12, many of the core GNOME packages require GNOME Doc Utils.

Package Information

GNOME Doc Utils Dependencies

Required

libxslt-1.1.26, which-2.20, and XML::Parser-2.34

Recommended

Python-2.6.2 and Rarian-0.8.1

The packages are listed as recommended even though GNOME Doc Utils will build fine without them. If you don't install the recommended packages (and you pass the appropriate flags to the configure command so that it will build without them), functionality will be missing that is expected later in other GNOME packages.

Optional

intltool-0.40.6

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/gnome-doc-utils

Installation of GNOME Doc Utils

[Note]

Note

The instructions below are based on installing the package into a GNOME-2 environment. If, for whatever reason, you're installing this package without having ORBit2 and the core GNOME-2 libraries installed, you'll need to modify the --prefix= parameter on the configure script to point to your desired installation path (e.g., --prefix=/usr).

Install GNOME Doc Utils by running the following commands: 

./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --mandir=$(pkg-config \
                --variable=prefix ORBit-2.0)/share/man &&
make

To test the results, issue: make check.

Now, as the root user: 

make install

Command Explanations

--prefix=$(pkg-config --variable=prefix ORBit-2.0): Setting the prefix using this parameter instead of with $GNOME_PREFIX will ensure that the prefix is consistent with the installation environment and the package will be installed in the correct location.

--mandir=$(pkg-config --variable=prefix ORBit-2.0)/share/man: This parameter causes the man.(X) files to be installed in $GNOME_PREFIX/share/man/man(X) instead of $GNOME_PREFIX/man/man(X).

Contents

Installed Programs: gnome-doc-prepare, gnome-doc-tool and xml2po
Installed Libraries: None
Installed Directories: $GNOME_PREFIX/share/{ gnome-doc-utils, gnome/help/gnome-doc-{make,xslt}, omf/gnome-doc-{make,xslt}, xml/gnome, xml2po}
Installed Stylesheets: Custom DocBook XSLT stylesheets

Short Descriptions

gnome-doc-prepare

prepares a package to use gnome-doc-utils.

gnome-doc-tool

is used to convert documents to either HTML or XHTML.

xml2po

is a Python script used to translate XML documents.

Last updated on 2009-10-25 13:02:41 +0000