mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-25 07:42:13 +08:00
d6c65628af
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19032 af4574ff-66df-0310-9fd7-8a98e5e911e0
162 lines
5.2 KiB
XML
162 lines
5.2 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../../general.ent">
|
|
%general-entities;
|
|
|
|
<!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.xz">
|
|
<!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.xz">
|
|
<!ENTITY gtk-doc-md5sum "1ad4a1dbf804889fdc85f8eec45e8696">
|
|
<!ENTITY gtk-doc-size "692 KB">
|
|
<!ENTITY gtk-doc-buildsize "16 MB (with tests)">
|
|
<!ENTITY gtk-doc-time "0.2 SBU (with tests)">
|
|
]>
|
|
|
|
<sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
|
<?dbhtml filename="gtk-doc.html"?>
|
|
|
|
<sect1info>
|
|
<othername>$LastChangedBy$</othername>
|
|
<date>$Date$</date>
|
|
</sect1info>
|
|
|
|
<title>GTK-Doc->k-doc-version;</title>
|
|
|
|
<indexterm zone="gtk-doc">
|
|
<primary sortas="a-GTK-Doc">GTK-Doc</primary>
|
|
</indexterm>
|
|
|
|
<sect2 role="package">
|
|
<title>Introduction to GTK-Doc</title>
|
|
|
|
<para>The <application>GTK-Doc</application> package
|
|
contains a code documenter. This is useful for extracting specially formatted
|
|
comments from the code to create API documentation. This
|
|
package is <emphasis>optional</emphasis>; if it is not installed, packages will
|
|
not build the documentation. This does not mean that you will not have any
|
|
documentation. If <application>GTK-Doc</application> is not
|
|
available, the install process will copy any pre-built documentation to your
|
|
system.</para>
|
|
|
|
&lfs80_checked;
|
|
|
|
<bridgehead renderas="sect3">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>Download (HTTP): <ulink url=">k-doc-download-http;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download (FTP): <ulink url=">k-doc-download-ftp;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download MD5 sum: >k-doc-md5sum;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download size: >k-doc-size;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated disk space required: >k-doc-buildsize;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated build time: >k-doc-time;</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect4">Required</bridgehead>
|
|
<para role="required">
|
|
<xref linkend="DocBook"/>,
|
|
<xref linkend="docbook-xsl"/>,
|
|
<xref linkend="itstool"/>,
|
|
<xref linkend="libxslt"/>, and
|
|
<xref linkend="python2"/>
|
|
</para>
|
|
|
|
<bridgehead renderas="sect4">Optional</bridgehead>
|
|
<para role="optional">
|
|
<ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
|
|
<xref linkend="fop"/> (XML PDF support),
|
|
<xref linkend="highlight"/>,
|
|
<xref linkend="glib2"/> (for the test suite),
|
|
<ulink url="&gnome-download-http;/gnome-doc-utils/">GNOME Doc Utils</ulink> and
|
|
<xref linkend="which"/> (required for the test suite and gtk-doc documentation), and
|
|
<ulink url="https://pypi.python.org/pypi/six">six</ulink>(for some tests)
|
|
</para>
|
|
|
|
<para condition="html" role="usernotes">User Notes:
|
|
<ulink url="&blfs-wiki;/gtk-doc"/></para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of GTK-Doc</title>
|
|
|
|
<para>Install <application>GTK-Doc</application> by running
|
|
the following commands:</para>
|
|
|
|
<screen><userinput>./configure --prefix=/usr &&
|
|
make</userinput></screen>
|
|
|
|
<para>To test the results, issue: <command>make check</command>.</para>
|
|
|
|
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|
|
|
<screen role="root"><userinput>make install</userinput></screen>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Libraries</segtitle>
|
|
<segtitle>Installed Directories</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>gtkdocize,
|
|
gtkdoc-check,
|
|
gtkdoc-depscan,
|
|
gtkdoc-fixxref,
|
|
gtkdoc-mkdb,
|
|
gtkdoc-mkhtml,
|
|
gtkdoc-mkman,
|
|
gtkdoc-mkpdf,
|
|
gtkdoc-rebase,
|
|
gtkdoc-scan, and
|
|
gtkdoc-scangobj</seg>
|
|
|
|
<seg>None</seg>
|
|
|
|
<seg>/usr/lib/cmake/GtkDoc,
|
|
/usr/share/gtk-doc, and
|
|
/usr/share/help/*/gtk-doc-manual
|
|
</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="gtkdoc">
|
|
<term><command>gtkdoc*</command></term>
|
|
<listitem>
|
|
<para>these are all shell, or
|
|
<application>Python</application> scripts used by
|
|
package <filename>Makefile</filename> scripts to generate
|
|
documentation for the package being built.</para>
|
|
<indexterm zone="gtk-doc gtkdoc">
|
|
<primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|