1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
---|
8 | <!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
---|
9 | <!ENTITY gtk-doc-md5sum "d105d5b28e7e023ab1b7e85fb65e45c3">
|
---|
10 | <!ENTITY gtk-doc-size "145 KB">
|
---|
11 | <!ENTITY gtk-doc-buildsize "1.6 MB">
|
---|
12 | <!ENTITY gtk-doc-time "0.01 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
---|
16 | <sect1info>
|
---|
17 | <othername>$LastChangedBy$</othername>
|
---|
18 | <date>$Date$</date>
|
---|
19 | </sect1info>
|
---|
20 | <?dbhtml filename="gtk-doc.html"?>
|
---|
21 | <title>GTK-Doc->k-doc-version;</title>
|
---|
22 | <indexterm zone="gtk-doc">
|
---|
23 | <primary sortas="a-GTK-Doc">GTK-Doc</primary></indexterm>
|
---|
24 |
|
---|
25 | <sect2>
|
---|
26 | <title>Introduction to <application><acronym>GTK</acronym>-Doc</application>
|
---|
27 | </title>
|
---|
28 |
|
---|
29 | <para>The <application><acronym>GTK</acronym>-Doc</application> package
|
---|
30 | contains a code documentor. This is useful for extracting specially formatted
|
---|
31 | comments from the code to create <acronym>API</acronym> documentation. This
|
---|
32 | package is <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
33 | not build the documentation. This does not mean that you will not have any
|
---|
34 | documentation. If <application><acronym>GTK</acronym>-Doc</application> is not
|
---|
35 | available, the install process will copy pre-built documentation to your
|
---|
36 | system.</para>
|
---|
37 |
|
---|
38 | <sect3><title>Package information</title>
|
---|
39 | <itemizedlist spacing='compact'>
|
---|
40 | <listitem><para>Download (HTTP): <ulink
|
---|
41 | url=">k-doc-download-http;"/></para></listitem>
|
---|
42 | <listitem><para>Download (FTP): <ulink
|
---|
43 | url=">k-doc-download-ftp;"/></para></listitem>
|
---|
44 | <listitem><para>Download MD5 sum: >k-doc-md5sum;</para></listitem>
|
---|
45 | <listitem><para>Download size: >k-doc-size;</para></listitem>
|
---|
46 | <listitem><para>Estimated disk space required:
|
---|
47 | >k-doc-buildsize;</para></listitem>
|
---|
48 | <listitem><para>Estimated build time:
|
---|
49 | >k-doc-time;</para></listitem></itemizedlist>
|
---|
50 | </sect3>
|
---|
51 |
|
---|
52 | <sect3><title><application><acronym>GTK</acronym>-Doc</application>
|
---|
53 | dependencies</title>
|
---|
54 | <sect4><title>Required</title>
|
---|
55 | <para><xref linkend="openjade"/>,
|
---|
56 | <xref linkend="libxslt"/>,
|
---|
57 | <xref linkend="DocBook"/> and
|
---|
58 | <xref linkend="docbook-xsl"/></para>
|
---|
59 | </sect4>
|
---|
60 |
|
---|
61 | <sect4><title>Optional</title>
|
---|
62 | <para><xref linkend="sgml-dtd"/> and <xref linkend="docbook-dsssl"/></para>
|
---|
63 | </sect4>
|
---|
64 |
|
---|
65 | </sect3>
|
---|
66 |
|
---|
67 | </sect2>
|
---|
68 |
|
---|
69 | <sect2>
|
---|
70 | <title>Installation of <application><acronym>GTK</acronym>-Doc</application>
|
---|
71 | </title>
|
---|
72 |
|
---|
73 | <para>Install <application><acronym>GTK</acronym>-Doc</application> by running
|
---|
74 | the following commands:</para>
|
---|
75 |
|
---|
76 | <screen><userinput><command>./configure --prefix=/usr</command></userinput></screen>
|
---|
77 |
|
---|
78 | <para>Now, as the root user:</para>
|
---|
79 |
|
---|
80 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
81 |
|
---|
82 | </sect2>
|
---|
83 |
|
---|
84 | <sect2>
|
---|
85 | <title>Contents</title>
|
---|
86 |
|
---|
87 | <segmentedlist>
|
---|
88 | <segtitle>Installed Programs</segtitle>
|
---|
89 | <segtitle>Installed Libraries</segtitle>
|
---|
90 | <segtitle>Installed Directories</segtitle>
|
---|
91 |
|
---|
92 | <seglistitem>
|
---|
93 | <seg>gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman,
|
---|
94 | gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj and gtkdoc-scanobj</seg>
|
---|
95 | <seg>None</seg>
|
---|
96 | <seg>/usr/share/gtk-doc and /usr/share/sgml/gtk-doc</seg>
|
---|
97 | </seglistitem>
|
---|
98 | </segmentedlist>
|
---|
99 |
|
---|
100 | <sect3><title> Short description</title>
|
---|
101 | <para>These are all <application>Perl</application> scripts used by
|
---|
102 | package <filename>Makefile</filename> scripts to generate documentation for
|
---|
103 | the package being built.</para>
|
---|
104 | </sect3>
|
---|
105 |
|
---|
106 | </sect2>
|
---|
107 |
|
---|
108 | </sect1>
|
---|
109 |
|
---|