[fdca4266] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[fdca4266] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[5600683] | 7 | <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
---|
| 8 | <!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
---|
[25a19d85] | 9 | <!ENTITY gtk-doc-md5sum "09c7a89efff2e0bbaba02a12bff58dfd">
|
---|
| 10 | <!ENTITY gtk-doc-size "177 KB">
|
---|
[2e46c65] | 11 | <!ENTITY gtk-doc-buildsize "2.0 MB">
|
---|
[5600683] | 12 | <!ENTITY gtk-doc-time "less than 0.1 SBU">
|
---|
[fdca4266] | 13 | ]>
|
---|
| 14 |
|
---|
[a294e133] | 15 | <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
---|
[effdc6af] | 16 | <?dbhtml filename="gtk-doc.html"?>
|
---|
[fc7afd0c] | 17 |
|
---|
[effdc6af] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[52d50d5] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">gtk-doc->k-doc-version;.tar</keyword>
|
---|
[22ac237] | 23 | <keyword role="ftpdir">gtk-doc</keyword>
|
---|
[52d50d5] | 24 | </keywordset>
|
---|
[effdc6af] | 25 | </sect1info>
|
---|
[fc7afd0c] | 26 |
|
---|
[effdc6af] | 27 | <title>GTK-Doc->k-doc-version;</title>
|
---|
[fc7afd0c] | 28 |
|
---|
[effdc6af] | 29 | <indexterm zone="gtk-doc">
|
---|
| 30 | <primary sortas="a-GTK-Doc">GTK-Doc</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to GTK-Doc</title>
|
---|
[fc7afd0c] | 35 |
|
---|
[8d77de6] | 36 | <para>The <application>GTK-Doc</application> package
|
---|
| 37 | contains a code documentor. This is useful for extracting specially formatted
|
---|
| 38 | comments from the code to create API documentation. This
|
---|
| 39 | package is <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
| 40 | not build the documentation. This does not mean that you will not have any
|
---|
| 41 | documentation. If <application>GTK-Doc</application> is not
|
---|
[d9962703] | 42 | available, the install process will copy any pre-built documentation to your
|
---|
[effdc6af] | 43 | system.</para>
|
---|
[fc7afd0c] | 44 |
|
---|
[effdc6af] | 45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 46 | <itemizedlist spacing="compact">
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download (HTTP): <ulink url=">k-doc-download-http;"/></para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download (FTP): <ulink url=">k-doc-download-ftp;"/></para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Download MD5 sum: >k-doc-md5sum;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Download size: >k-doc-size;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>Estimated disk space required: >k-doc-buildsize;</para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>Estimated build time: >k-doc-time;</para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
[fc7afd0c] | 66 |
|
---|
[effdc6af] | 67 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
[fc7afd0c] | 68 |
|
---|
[effdc6af] | 69 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[25a19d85] | 70 | <para role="required"><xref linkend="libxslt"/>,
|
---|
[2e46c65] | 71 | <xref linkend="DocBook"/>, and
|
---|
[effdc6af] | 72 | <xref linkend="docbook-xsl"/></para>
|
---|
[fc7afd0c] | 73 |
|
---|
[effdc6af] | 74 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[25a19d85] | 75 | <para role="optional"><xref linkend="pkgconfig"/>,
|
---|
| 76 | <xref linkend="scrollkeeper"/>,
|
---|
| 77 | <xref linkend="openjade"/>,
|
---|
| 78 | <xref linkend="sgml-dtd"/>, and
|
---|
[2e46c65] | 79 | <xref linkend="docbook-dsssl"/></para>
|
---|
[fc7afd0c] | 80 |
|
---|
[1039de3] | 81 | <para condition="html" role="usernotes">User Notes:
|
---|
| 82 | <ulink url="&blfs-wiki;/gtk-doc"/></para>
|
---|
| 83 |
|
---|
[effdc6af] | 84 | </sect2>
|
---|
[fc7afd0c] | 85 |
|
---|
[effdc6af] | 86 | <sect2 role="installation">
|
---|
| 87 | <title>Installation of GTK-Doc</title>
|
---|
| 88 |
|
---|
[8d77de6] | 89 | <para>Install <application>GTK-Doc</application> by running
|
---|
[effdc6af] | 90 | the following commands:</para>
|
---|
| 91 |
|
---|
[2e46c65] | 92 | <screen><userinput>./configure --prefix=/usr --localstatedir=/var/lib &&
|
---|
| 93 | make</userinput></screen>
|
---|
| 94 |
|
---|
| 95 | <para>This package does not come with a test suite.</para>
|
---|
[fc7afd0c] | 96 |
|
---|
[effdc6af] | 97 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[fc7afd0c] | 98 |
|
---|
[effdc6af] | 99 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[fc7afd0c] | 100 |
|
---|
[effdc6af] | 101 | </sect2>
|
---|
[fc7afd0c] | 102 |
|
---|
[2e46c65] | 103 | <sect2 role="commands">
|
---|
| 104 | <title>Command Explanations</title>
|
---|
| 105 |
|
---|
| 106 | <para><parameter>--localstatedir=/var/lib</parameter>: This parameter is
|
---|
| 107 | used so that ScrollKeeper files are installed in the system ScrollKeeper
|
---|
| 108 | database directory
|
---|
| 109 | (<filename class='directory'>/var/lib/scrollkeeper</filename>) instead of
|
---|
| 110 | <filename class='directory'>/usr/var/scrollkeeper</filename>.</para>
|
---|
| 111 |
|
---|
| 112 | </sect2>
|
---|
| 113 |
|
---|
[effdc6af] | 114 | <sect2 role="content">
|
---|
| 115 | <title>Contents</title>
|
---|
| 116 |
|
---|
| 117 | <segmentedlist>
|
---|
| 118 | <segtitle>Installed Programs</segtitle>
|
---|
| 119 | <segtitle>Installed Libraries</segtitle>
|
---|
| 120 | <segtitle>Installed Directories</segtitle>
|
---|
[fc7afd0c] | 121 |
|
---|
[effdc6af] | 122 | <seglistitem>
|
---|
[8d77de6] | 123 | <seg>gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman,
|
---|
[effdc6af] | 124 | gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj</seg>
|
---|
| 125 | <seg>None</seg>
|
---|
[25a19d85] | 126 | <seg>The following subdirectories of /usr/share/:
|
---|
| 127 | doc/gtk-doc->k-doc-version;,
|
---|
| 128 | gnome/help/gtk-doc-manual,
|
---|
| 129 | gtk-doc/data and
|
---|
| 130 | {omf,sgml}/gtk-doc</seg>
|
---|
[effdc6af] | 131 | </seglistitem>
|
---|
| 132 | </segmentedlist>
|
---|
[fc7afd0c] | 133 |
|
---|
[effdc6af] | 134 | <variablelist>
|
---|
| 135 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 136 | <?dbfo list-presentation="list"?>
|
---|
| 137 | <?dbhtml list-presentation="table"?>
|
---|
[fc7afd0c] | 138 |
|
---|
[effdc6af] | 139 | <varlistentry id="gtkdoc">
|
---|
| 140 | <term><command>gtkdoc*</command></term>
|
---|
| 141 | <listitem>
|
---|
[8d77de6] | 142 | <para>these are all <application>Perl</application> scripts used by
|
---|
| 143 | package <filename>Makefile</filename> scripts to generate
|
---|
[effdc6af] | 144 | documentation for the package being built.</para>
|
---|
| 145 | <indexterm zone="gtk-doc gtkdoc">
|
---|
| 146 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
| 147 | </indexterm>
|
---|
| 148 | </listitem>
|
---|
| 149 | </varlistentry>
|
---|
[fc7afd0c] | 150 |
|
---|
[effdc6af] | 151 | </variablelist>
|
---|
[fc7afd0c] | 152 |
|
---|
[effdc6af] | 153 | </sect2>
|
---|
[fc7afd0c] | 154 |
|
---|
[832650c] | 155 | </sect1>
|
---|