source: general/genutils/gtk-doc.xml@ 38489aa0

10.0 10.1 11.0 8.4 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 38489aa0 was 38489aa0, checked in by Pierre Labastie <pieere@…>, 3 years ago

Tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21156 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.3 KB
Line 
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/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.xz">
8 <!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.xz">
9 <!ENTITY gtk-doc-md5sum "df26a38c209b3d7358f26268fcbdb9e3">
10 <!ENTITY gtk-doc-size "716 KB">
11 <!ENTITY gtk-doc-buildsize "14 MB (with tests)">
12 <!ENTITY gtk-doc-time "0.2 SBU (with tests)">
13]>
14
15<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-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-&gtk-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 &lfs84_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>Download (HTTP): <ulink url="&gtk-doc-download-http;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download (FTP): <ulink url="&gtk-doc-download-ftp;"/></para>
50 </listitem>
51 <listitem>
52 <para>Download MD5 sum: &gtk-doc-md5sum;</para>
53 </listitem>
54 <listitem>
55 <para>Download size: &gtk-doc-size;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated disk space required: &gtk-doc-buildsize;</para>
59 </listitem>
60 <listitem>
61 <para>Estimated build time: &gtk-doc-time;</para>
62 </listitem>
63 </itemizedlist>
64
65 <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
66
67 <bridgehead renderas="sect4">Required</bridgehead>
68 <para role="required">
69 <xref linkend="DocBook"/>,
70 <xref linkend="docbook-xsl"/>,
71 <xref linkend="itstool"/>, and
72 <xref linkend="libxslt"/>
73 </para>
74
75 <bridgehead renderas="sect4">Recommended</bridgehead>
76 <para role="recommended">
77 <xref linkend="highlight"/>
78 </para>
79
80 <bridgehead renderas="sect4">Optional</bridgehead>
81 <para role="optional">
82 <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
83 <xref linkend="fop"/> (XML PDF support),
84 <xref linkend="glib2"/> (for the test suite),
85 <ulink url="&gnome-download-http;/gnome-doc-utils/">GNOME Doc Utils</ulink> and
86 <xref linkend="which"/> (required for the test suite and gtk-doc documentation)
87 </para>
88
89 <para condition="html" role="usernotes">User Notes:
90 <ulink url="&blfs-wiki;/gtk-doc"/></para>
91
92 </sect2>
93
94 <sect2 role="installation">
95 <title>Installation of GTK-Doc</title>
96
97 <para>Install <application>GTK-Doc</application> by running
98 the following commands:</para>
99
100<screen><userinput>./configure --prefix=/usr &amp;&amp;
101make</userinput></screen>
102
103 <para>To test the results, issue: <command>make check</command>. On some systems, the tests
104 may either hang indefinitely or fail.</para>
105
106 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
107
108<screen role="root"><userinput>make install</userinput></screen>
109
110 </sect2>
111
112 <sect2 role="content">
113 <title>Contents</title>
114
115 <segmentedlist>
116 <segtitle>Installed Programs</segtitle>
117 <segtitle>Installed Libraries</segtitle>
118 <segtitle>Installed Directories</segtitle>
119
120 <seglistitem>
121 <seg>gtkdocize,
122 gtkdoc-check,
123 gtkdoc-depscan,
124 gtkdoc-fixxref,
125 gtkdoc-mkdb,
126 gtkdoc-mkhtml,
127 gtkdoc-mkman,
128 gtkdoc-mkpdf,
129 gtkdoc-rebase,
130 gtkdoc-scan, and
131 gtkdoc-scangobj</seg>
132
133 <seg>None</seg>
134
135 <seg>/usr/lib/cmake/GtkDoc,
136 /usr/share/gtk-doc, and
137 /usr/share/help/*/gtk-doc-manual
138 </seg>
139 </seglistitem>
140 </segmentedlist>
141
142 <variablelist>
143 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
144 <?dbfo list-presentation="list"?>
145 <?dbhtml list-presentation="table"?>
146
147 <varlistentry id="gtkdoc">
148 <term><command>gtkdoc*</command></term>
149 <listitem>
150 <para>these are all shell, or
151 <application>Python</application> scripts used by
152 package <filename>Makefile</filename> scripts to generate
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>
159
160 </variablelist>
161
162 </sect2>
163
164</sect1>
Note: See TracBrowser for help on using the repository browser.