%general-entities; ]> $LastChangedBy$ $Date$ GTK-Doc->k-doc-version; GTK-Doc 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 Download (HTTP): Download (FTP): Download MD5 sum: >k-doc-md5sum; Download size: >k-doc-size; Estimated disk space required: >k-doc-buildsize; Estimated build time: >k-doc-time; GTK-Doc Dependencies Required , , and Recommended Optional , , , , , also (for the testsuite) User Notes: Installation of GTK-Doc Install GTK-Doc by running the following commands: sed -i '/^pkgconfigdir/s/datadir/libdir/' && ./configure --prefix=/usr && make Now, as the root user: make install The test suite requires that the package has been installed first, and in any case it fails because of a missing file, so there is little point in running it. If you insist on seeing the results, as a normal user run: make check. Command Explanations sed -i '/^pkgconfigdir/s/datadir/libdir/': this installs the pkgconfig file in a place which is on PKG_CONFIG_PATH instead of in /usr/share/pkgconfig. Contents Installed Programs Installed Libraries Installed Directories gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-rebase, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj None The following subdirectories of /usr/share/: gnome/help/gtk-doc-manual, gtk-doc/data and {omf,sgml}/gtk-doc Short Descriptions gtkdoc* these are all shell, Perl, or Python scripts used by package Makefile scripts to generate documentation for the package being built. gtkdoc*