[fdca4266] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/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">
|
---|
[64c6acb] | 9 | <!ENTITY gtk-doc-md5sum "b5e268c71fa90aad890cf53715664d0a">
|
---|
| 10 | <!ENTITY gtk-doc-size "443 KB">
|
---|
| 11 | <!ENTITY gtk-doc-buildsize "4.8 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>
|
---|
| 21 | </sect1info>
|
---|
[fc7afd0c] | 22 |
|
---|
[effdc6af] | 23 | <title>GTK-Doc->k-doc-version;</title>
|
---|
[fc7afd0c] | 24 |
|
---|
[effdc6af] | 25 | <indexterm zone="gtk-doc">
|
---|
| 26 | <primary sortas="a-GTK-Doc">GTK-Doc</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to GTK-Doc</title>
|
---|
[fc7afd0c] | 31 |
|
---|
[8d77de6] | 32 | <para>The <application>GTK-Doc</application> package
|
---|
| 33 | contains a code documentor. This is useful for extracting specially formatted
|
---|
| 34 | comments from the code to create API documentation. This
|
---|
| 35 | package is <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
| 36 | not build the documentation. This does not mean that you will not have any
|
---|
| 37 | documentation. If <application>GTK-Doc</application> is not
|
---|
[d9962703] | 38 | available, the install process will copy any pre-built documentation to your
|
---|
[effdc6af] | 39 | system.</para>
|
---|
[fc7afd0c] | 40 |
|
---|
[effdc6af] | 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (HTTP): <ulink url=">k-doc-download-http;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download (FTP): <ulink url=">k-doc-download-ftp;"/></para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download MD5 sum: >k-doc-md5sum;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download size: >k-doc-size;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Estimated disk space required: >k-doc-buildsize;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Estimated build time: >k-doc-time;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | </itemizedlist>
|
---|
[fc7afd0c] | 62 |
|
---|
[effdc6af] | 63 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
[fc7afd0c] | 64 |
|
---|
[effdc6af] | 65 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[25a19d85] | 66 | <para role="required"><xref linkend="libxslt"/>,
|
---|
[2e46c65] | 67 | <xref linkend="DocBook"/>, and
|
---|
[effdc6af] | 68 | <xref linkend="docbook-xsl"/></para>
|
---|
[fc7afd0c] | 69 |
|
---|
[64c6acb] | 70 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 71 | <para role="optional"><xref linkend="python"/></para>
|
---|
| 72 |
|
---|
[effdc6af] | 73 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[25a19d85] | 74 | <para role="optional"><xref linkend="pkgconfig"/>,
|
---|
| 75 | <xref linkend="scrollkeeper"/>,
|
---|
| 76 | <xref linkend="openjade"/>,
|
---|
[64c6acb] | 77 | <xref linkend="sgml-dtd"/>,
|
---|
| 78 | <xref linkend="docbook-dsssl"/>, also
|
---|
| 79 | <xref linkend="glib2"/> (for the testsuite)</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 |
|
---|
[64c6acb] | 92 | <screen><userinput>sed -i '/^pkgconfigdir/s/datadir/libdir/' &&
|
---|
| 93 | ./configure --prefix=/usr &&
|
---|
[2e46c65] | 94 | make</userinput></screen>
|
---|
| 95 |
|
---|
[effdc6af] | 96 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[fc7afd0c] | 97 |
|
---|
[effdc6af] | 98 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[fc7afd0c] | 99 |
|
---|
[64c6acb] | 100 | <para>The test suite requires that the package has been installed first, and
|
---|
| 101 | in any case it fails because of a missing file, so there is little point
|
---|
| 102 | in running it. If you insist on seeing the results, as a normal user run:
|
---|
| 103 | <command>make check</command>.</para>
|
---|
| 104 |
|
---|
[effdc6af] | 105 | </sect2>
|
---|
[fc7afd0c] | 106 |
|
---|
[2e46c65] | 107 | <sect2 role="commands">
|
---|
| 108 | <title>Command Explanations</title>
|
---|
| 109 |
|
---|
[64c6acb] | 110 | <para><command>sed -i '/^pkgconfigdir/s/datadir/libdir/'</command>:
|
---|
| 111 | this installs the pkgconfig file in a place which is on
|
---|
| 112 | <envar>PKG_CONFIG_PATH</envar> instead of in
|
---|
| 113 | <filename class='directory'>/usr/share/pkgconfig</filename>.</para>
|
---|
| 114 |
|
---|
| 115 | <!-- no scrollkeeper files with this version
|
---|
[56ce09e] | 116 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
[64c6acb] | 117 | href="../../xincludes/scrollkeeper-dir.xml"/>-->
|
---|
[2e46c65] | 118 |
|
---|
| 119 | </sect2>
|
---|
| 120 |
|
---|
[effdc6af] | 121 | <sect2 role="content">
|
---|
| 122 | <title>Contents</title>
|
---|
| 123 |
|
---|
| 124 | <segmentedlist>
|
---|
| 125 | <segtitle>Installed Programs</segtitle>
|
---|
| 126 | <segtitle>Installed Libraries</segtitle>
|
---|
| 127 | <segtitle>Installed Directories</segtitle>
|
---|
[fc7afd0c] | 128 |
|
---|
[effdc6af] | 129 | <seglistitem>
|
---|
[64c6acb] | 130 | <seg>gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb,
|
---|
| 131 | gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-rebase, gtkdoc-scan,
|
---|
| 132 | gtkdoc-scangobj, and gtkdoc-scanobj</seg>
|
---|
[effdc6af] | 133 | <seg>None</seg>
|
---|
[25a19d85] | 134 | <seg>The following subdirectories of /usr/share/:
|
---|
[64c6acb] | 135 | <!--doc/gtk-doc->k-doc-version;, -->
|
---|
[25a19d85] | 136 | gnome/help/gtk-doc-manual,
|
---|
| 137 | gtk-doc/data and
|
---|
| 138 | {omf,sgml}/gtk-doc</seg>
|
---|
[effdc6af] | 139 | </seglistitem>
|
---|
| 140 | </segmentedlist>
|
---|
[fc7afd0c] | 141 |
|
---|
[effdc6af] | 142 | <variablelist>
|
---|
| 143 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 144 | <?dbfo list-presentation="list"?>
|
---|
| 145 | <?dbhtml list-presentation="table"?>
|
---|
[fc7afd0c] | 146 |
|
---|
[effdc6af] | 147 | <varlistentry id="gtkdoc">
|
---|
| 148 | <term><command>gtkdoc*</command></term>
|
---|
| 149 | <listitem>
|
---|
[64c6acb] | 150 | <para>these are all shell, <application>Perl</application>, or
|
---|
| 151 | <application>Python</application> scripts used by
|
---|
[8d77de6] | 152 | package <filename>Makefile</filename> scripts to generate
|
---|
[effdc6af] | 153 | documentation for the package being built.</para>
|
---|
| 154 | <indexterm zone="gtk-doc gtkdoc">
|
---|
| 155 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
| 156 | </indexterm>
|
---|
| 157 | </listitem>
|
---|
| 158 | </varlistentry>
|
---|
[fc7afd0c] | 159 |
|
---|
[effdc6af] | 160 | </variablelist>
|
---|
[fc7afd0c] | 161 |
|
---|
[effdc6af] | 162 | </sect2>
|
---|
[fc7afd0c] | 163 |
|
---|
[832650c] | 164 | </sect1>
|
---|