1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
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">
|
---|
9 | <!ENTITY gtk-doc-md5sum "b5e268c71fa90aad890cf53715664d0a">
|
---|
10 | <!ENTITY gtk-doc-size "443 KB">
|
---|
11 | <!ENTITY gtk-doc-buildsize "4.8 MB">
|
---|
12 | <!ENTITY gtk-doc-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
---|
16 | <?dbhtml filename="gtk-doc.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>GTK-Doc->k-doc-version;</title>
|
---|
24 |
|
---|
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>
|
---|
31 |
|
---|
32 | <para>The <application>GTK-Doc</application> package
|
---|
33 | contains a code documenter. 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
|
---|
38 | available, the install process will copy any pre-built documentation to your
|
---|
39 | system.</para>
|
---|
40 |
|
---|
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>
|
---|
62 |
|
---|
63 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
64 |
|
---|
65 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
66 | <para role="required"><xref linkend="gnome-doc-utils"/>,
|
---|
67 | <xref linkend="DocBook"/>, and
|
---|
68 | <xref linkend="docbook-xsl"/></para>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
71 | <para role="optional"><xref linkend="python"/></para>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
74 | <para role="optional"><!-- <xref linkend="pkgconfig"/>, -->
|
---|
75 | <xref linkend="scrollkeeper"/>,
|
---|
76 | <xref linkend="openjade"/>,
|
---|
77 | <xref linkend="sgml-dtd"/>,
|
---|
78 | <xref linkend="docbook-dsssl"/>, also
|
---|
79 | <xref linkend="glib2"/> (for the testsuite)</para>
|
---|
80 |
|
---|
81 | <para condition="html" role="usernotes">User Notes:
|
---|
82 | <ulink url="&blfs-wiki;/gtk-doc"/></para>
|
---|
83 |
|
---|
84 | </sect2>
|
---|
85 |
|
---|
86 | <sect2 role="installation">
|
---|
87 | <title>Installation of GTK-Doc</title>
|
---|
88 |
|
---|
89 | <para>Install <application>GTK-Doc</application> by running
|
---|
90 | the following commands:</para>
|
---|
91 |
|
---|
92 | <screen><userinput>./configure --prefix=/usr &&
|
---|
93 | make</userinput></screen>
|
---|
94 |
|
---|
95 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
96 |
|
---|
97 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
98 |
|
---|
99 | <para>The test suite requires that the package has been installed first, but
|
---|
100 | there's no reason to run it as there is a missing file which causes the test
|
---|
101 | suite to fail. If you insist on seeing the results, an an unprivileged user
|
---|
102 | run: <command>make check</command>.</para>
|
---|
103 |
|
---|
104 | </sect2>
|
---|
105 |
|
---|
106 | <!-- <sect2 role="commands">
|
---|
107 | <title>Command Explanations</title>
|
---|
108 |
|
---|
109 | \<\!\-\- no scrollkeeper files with this version
|
---|
110 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
111 | href="../../xincludes/scrollkeeper-dir.xml"/> \-\-\>
|
---|
112 |
|
---|
113 | </sect2> -->
|
---|
114 |
|
---|
115 | <sect2 role="content">
|
---|
116 | <title>Contents</title>
|
---|
117 |
|
---|
118 | <segmentedlist>
|
---|
119 | <segtitle>Installed Programs</segtitle>
|
---|
120 | <segtitle>Installed Libraries</segtitle>
|
---|
121 | <segtitle>Installed Directories</segtitle>
|
---|
122 |
|
---|
123 | <seglistitem>
|
---|
124 | <seg>gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb,
|
---|
125 | gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-rebase, gtkdoc-scan,
|
---|
126 | gtkdoc-scangobj, and gtkdoc-scanobj</seg>
|
---|
127 | <seg>None</seg>
|
---|
128 | <seg>The following subdirectories of /usr/share/:
|
---|
129 | <!--doc/gtk-doc->k-doc-version;, -->
|
---|
130 | gnome/help/gtk-doc-manual,
|
---|
131 | gtk-doc/data and
|
---|
132 | {omf,sgml}/gtk-doc</seg>
|
---|
133 | </seglistitem>
|
---|
134 | </segmentedlist>
|
---|
135 |
|
---|
136 | <variablelist>
|
---|
137 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
138 | <?dbfo list-presentation="list"?>
|
---|
139 | <?dbhtml list-presentation="table"?>
|
---|
140 |
|
---|
141 | <varlistentry id="gtkdoc">
|
---|
142 | <term><command>gtkdoc*</command></term>
|
---|
143 | <listitem>
|
---|
144 | <para>these are all shell, <application>Perl</application>, or
|
---|
145 | <application>Python</application> scripts used by
|
---|
146 | package <filename>Makefile</filename> scripts to generate
|
---|
147 | documentation for the package being built.</para>
|
---|
148 | <indexterm zone="gtk-doc gtkdoc">
|
---|
149 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
150 | </indexterm>
|
---|
151 | </listitem>
|
---|
152 | </varlistentry>
|
---|
153 |
|
---|
154 | </variablelist>
|
---|
155 |
|
---|
156 | </sect2>
|
---|
157 |
|
---|
158 | </sect1>
|
---|