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

10.0 10.1 11.0 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since eab496c5 was eab496c5, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Update to pycairo-1.16.2
Tag python modules and dependencies

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

  • Property mode set to 100644
File size: 5.4 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 "b29949e0964762e474b706ce22171602">
10 <!ENTITY gtk-doc-size "704 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 &lfs82_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"/>,
72 <xref linkend="libxslt"/>, and
73 <xref linkend="python2"/>
74 </para>
75
76 <bridgehead renderas="sect4">Recommended</bridgehead>
77 <para role="recommended">
78 <xref linkend="highlight"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
84 <xref linkend="fop"/> (XML PDF support),
85 <xref linkend="glib2"/> (for the test suite),
86 <ulink url="&gnome-download-http;/gnome-doc-utils/">GNOME Doc Utils</ulink> and
87 <xref linkend="which"/> (required for the test suite and gtk-doc documentation), and
88 <xref linkend="six"/> (for some tests)
89 </para>
90
91 <bridgehead renderas="sect4">Required (runtime)</bridgehead>
92 <para role="required">
93 <xref role="runtime" linkend="six"/>
94 </para>
95
96 <para condition="html" role="usernotes">User Notes:
97 <ulink url="&blfs-wiki;/gtk-doc"/></para>
98
99 </sect2>
100
101 <sect2 role="installation">
102 <title>Installation of GTK-Doc</title>
103
104 <para>Install <application>GTK-Doc</application> by running
105 the following commands:</para>
106
107<screen><userinput>./configure --prefix=/usr &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 </sect2>
117
118 <sect2 role="content">
119 <title>Contents</title>
120
121 <segmentedlist>
122 <segtitle>Installed Programs</segtitle>
123 <segtitle>Installed Libraries</segtitle>
124 <segtitle>Installed Directories</segtitle>
125
126 <seglistitem>
127 <seg>gtkdocize,
128 gtkdoc-check,
129 gtkdoc-depscan,
130 gtkdoc-fixxref,
131 gtkdoc-mkdb,
132 gtkdoc-mkhtml,
133 gtkdoc-mkman,
134 gtkdoc-mkpdf,
135 gtkdoc-rebase,
136 gtkdoc-scan, and
137 gtkdoc-scangobj</seg>
138
139 <seg>None</seg>
140
141 <seg>/usr/lib/cmake/GtkDoc,
142 /usr/share/gtk-doc, and
143 /usr/share/help/*/gtk-doc-manual
144 </seg>
145 </seglistitem>
146 </segmentedlist>
147
148 <variablelist>
149 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
150 <?dbfo list-presentation="list"?>
151 <?dbhtml list-presentation="table"?>
152
153 <varlistentry id="gtkdoc">
154 <term><command>gtkdoc*</command></term>
155 <listitem>
156 <para>these are all shell, or
157 <application>Python</application> scripts used by
158 package <filename>Makefile</filename> scripts to generate
159 documentation for the package being built.</para>
160 <indexterm zone="gtk-doc gtkdoc">
161 <primary sortas="b-gtkdoc*">gtkdoc*</primary>
162 </indexterm>
163 </listitem>
164 </varlistentry>
165
166 </variablelist>
167
168 </sect2>
169
170</sect1>
Note: See TracBrowser for help on using the repository browser.