Beyond Linux From Scratch - Version 6.1

Chapter 10. General Utilities

GTK-Doc-1.3

Introduction to GTK-Doc

The GTK-Doc package contains a code documentor. This is useful for extracting specially formatted comments from the code to create API documentation. This package is optional; if it is not installed, packages will not build the documentation. This does not mean that you will not have any documentation. If GTK-Doc is not available, the install process will copy any pre-built documentation to your system.

Package Information

GTK-Doc Dependencies

Required

OpenJade-1.3.2, libxslt-1.1.14, DocBook XML DTD-4.4 and DocBook XSL Stylesheets-1.68.1

Optional

DocBook SGML DTD-4.4 and DocBook DSSSL Stylesheets-1.79

Installation of GTK-Doc

Install GTK-Doc by running the following commands: 

./configure --prefix=/usr

Now, as the root user: 

make install

Contents

Installed Programs: gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj
Installed Libraries: None
Installed Directories: /usr/share/gtk-doc and /usr/share/sgml/gtk-doc

Short Descriptions

gtkdoc*

these are all Perl scripts used by package Makefile scripts to generate documentation for the package being built.

Last updated on 2005-08-01 13:29:19 -0600