source: general/genutils/gtk-doc.xml@ cf3ddc0c

10.0 10.1 11.0 11.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since cf3ddc0c was cf3ddc0c, checked in by Bruce Dubbs <bdubbs@…>, 11 years ago

Updated to gtk-doc-1.18

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

  • Property mode set to 100644
File size: 6.8 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.bz2">
8 <!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
9 <!ENTITY gtk-doc-md5sum "3927bed60fdd0fc9093a1d00018e746a">
10 <!ENTITY gtk-doc-size "628 KB">
11 <!ENTITY gtk-doc-buildsize "10 MB">
12 <!ENTITY gtk-doc-time "0.2 SBU">
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 &lfs70_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"><xref linkend="DocBook"/>,
69 <xref linkend="docbook-xsl"/>, and
70 <xref linkend="libxslt"/></para>
71
72 <bridgehead renderas="sect4">Optional</bridgehead>
73 <para role="optional"><xref linkend="glib2"/> (for the testsuite),
74 <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
75 <xref linkend="fop"/> (XML PDF support),
76 <xref linkend="gnome-doc-utils"/> and
77 <xref linkend="which"/> (builds gtk-doc documentation),
78 <xref linkend="openjade"/> with
79 <xref linkend="sgml-dtd"/> and
80 <xref linkend="docbook-dsssl"/>
81 (SGML support, not actively maintained any more),
82 <xref linkend="python"/> (builds gtkdoc-depscan), and
83 <xref linkend="rarian"/></para>
84
85 <para condition="html" role="usernotes">User Notes:
86 <ulink url="&blfs-wiki;/gtk-doc"/></para>
87
88 </sect2>
89
90 <sect2 role="installation">
91 <title>Installation of GTK-Doc</title>
92
93 <!-- Does not apply to this version? <note>
94 <para>If you installed the <xref linkend="scrollkeeper"/> package and
95 then followed it with <xref linkend="rarian"/> package, there will be
96 Scrollkeeper files missing (Rarian removed them) and the build will
97 fail. In this instance you should add the paramater
98 <option>\-\-disable-scrollkeeper</option> to the
99 <command>./configure</command> command shown below.</para>
100 </note> -->
101
102 <para>Install <application>GTK-Doc</application> by running
103 the following commands:</para>
104
105<screen><userinput>sed -i 's/wa!/w! $temp_source_file.html/' gtkdoc-fixxref.in \
106./configure --prefix=/usr \
107 --disable-scrollkeeper &amp;&amp;
108make</userinput></screen>
109
110 <para>To test the results, issue: <command>make check</command>.</para>
111
112 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
113
114<screen role="root"><userinput>make install</userinput></screen>
115
116 <!-- <para>The test suite requires that the package has been installed first, but
117 there's no reason to run it as there is a missing file which causes the test
118 suite to fail. If you insist on seeing the results, an an unprivileged user
119 run: <command>make check</command>.</para> -->
120
121 </sect2>
122
123<!-- <sect2 role="commands">
124 <title>Command Explanations</title>
125
126 \<\!\-\- no scrollkeeper files with this version
127 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
128 href="../../xincludes/scrollkeeper-dir.xml"/> \-\-\>
129
130 </sect2> -->
131
132 <sect2 role="commands">
133 <title>Command Explanations</title>
134
135 <para><parameter>--disable-scrollkeeper</parameter>: Do not make updates to
136 the <application>scrollkeeper</application> database. Remove it if you have
137 <application>rarian</application> installed.</para>
138
139 <para><command>sed -i '...' gtkdoc-fixxref.in</command>: This command fixes
140 an issue where invocations of the <application>Vim</application> editor
141 does not behave as expected. See upstream bug at
142 <ulink url="https://bugzilla.gnome.org/show_bug.cgi?id=627223"/>.</para>
143
144 </sect2>
145
146 <sect2 role="content">
147 <title>Contents</title>
148
149 <segmentedlist>
150 <segtitle>Installed Programs</segtitle>
151 <segtitle>Installed Libraries</segtitle>
152 <segtitle>Installed Directories</segtitle>
153
154 <seglistitem>
155 <seg>gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdocize,
156 gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-mktmpl,
157 gtkdoc-rebase, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj</seg>
158 <seg>None</seg>
159 <seg>/usr/share/{gnome/help/gtk-doc-manual/*,gtk-doc/data,omf/gtk-doc-manual,sgml/gtk-doc}</seg>
160 </seglistitem>
161 </segmentedlist>
162
163 <variablelist>
164 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
165 <?dbfo list-presentation="list"?>
166 <?dbhtml list-presentation="table"?>
167
168 <varlistentry id="gtkdoc">
169 <term><command>gtkdoc*</command></term>
170 <listitem>
171 <para>these are all shell, <application>Perl</application>, or
172 <application>Python</application> scripts used by
173 package <filename>Makefile</filename> scripts to generate
174 documentation for the package being built.</para>
175 <indexterm zone="gtk-doc gtkdoc">
176 <primary sortas="b-gtkdoc*">gtkdoc*</primary>
177 </indexterm>
178 </listitem>
179 </varlistentry>
180
181 </variablelist>
182
183 </sect2>
184
185</sect1>
Note: See TracBrowser for help on using the repository browser.