GTK-Doc-1.29

#### Beyond Linux® From Scratch - Version 2019-02-27

### Chapter 11. General Utilities

- Prev

  Graphviz-2.40.1

- Next

  Hd2u-1.0.4

- Up
- Home

# GTK-Doc-1.29

## Introduction to GTK-Doc

The GTK-Doc package contains a code documenter. 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.

This package is known to build and work properly using an LFS-8.4 platform.

### Package Information

- Download (HTTP): http://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.29/gtk-doc-1.29.tar.xz

- Download (FTP): ftp://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.29/gtk-doc-1.29.tar.xz

- Download MD5 sum: df26a38c209b3d7358f26268fcbdb9e3

- Download size: 716 KB

- Estimated disk space required: 14 MB (with tests)

- Estimated build time: 0.2 SBU (with tests)

### GTK-Doc Dependencies

#### Required

docbook-xml-4.5, docbook-xsl-1.79.2, itstool-2.0.5, and libxslt-1.1.33

#### Recommended

Highlight-3.49

#### Optional

dblatex or fop-2.3 (XML PDF support), GLib-2.58.3 (for the test suite), GNOME Doc Utils and Which-2.21 (required for the test suite and gtk-doc documentation)

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

## Installation of GTK-Doc

Install GTK-Doc by running the following commands:

    ./configure --prefix=/usr &&
    make

To test the results, issue: make check. On some systems, the tests may either hang indefinitely or fail.

Now, as the `root` user:

    make install

## Contents

Installed Programs: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan, and gtkdoc-scangobj
Installed Libraries: None
Installed Directories: /usr/lib/cmake/GtkDoc, /usr/share/gtk-doc, and /usr/share/help/*/gtk-doc-manual

### Short Descriptions

gtkdoc* | these are all shell, or Python scripts used by package `Makefile` scripts to generate documentation for the package being built.

Last updated on 2019-02-15 15:01:29 -0600

- Prev

  Graphviz-2.40.1

- Next

  Hd2u-1.0.4

- Up
- Home