mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-31 12:32:13 +08:00
25a19d856e
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6058 af4574ff-66df-0310-9fd7-8a98e5e911e0
156 lines
5.3 KiB
XML
156 lines
5.3 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.4/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.bz2">
|
|
<!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
|
<!ENTITY gtk-doc-md5sum "09c7a89efff2e0bbaba02a12bff58dfd">
|
|
<!ENTITY gtk-doc-size "177 KB">
|
|
<!ENTITY gtk-doc-buildsize "2.0 MB">
|
|
<!ENTITY gtk-doc-time "less than 0.1 SBU">
|
|
]>
|
|
|
|
<sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
|
<?dbhtml filename="gtk-doc.html"?>
|
|
|
|
<sect1info>
|
|
<othername>$LastChangedBy$</othername>
|
|
<date>$Date$</date>
|
|
<keywordset>
|
|
<keyword role="package">gtk-doc->k-doc-version;.tar</keyword>
|
|
<keyword role="ftpdir">gtk-doc</keyword>
|
|
</keywordset>
|
|
</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 documentor. 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>
|
|
|
|
<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="libxslt"/>,
|
|
<xref linkend="DocBook"/>, and
|
|
<xref linkend="docbook-xsl"/></para>
|
|
|
|
<bridgehead renderas="sect4">Optional</bridgehead>
|
|
<para role="optional"><xref linkend="pkgconfig"/>,
|
|
<xref linkend="scrollkeeper"/>,
|
|
<xref linkend="openjade"/>,
|
|
<xref linkend="sgml-dtd"/>, and
|
|
<xref linkend="docbook-dsssl"/></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 --localstatedir=/var/lib &&
|
|
make</userinput></screen>
|
|
|
|
<para>This package does not come with a test suite.</para>
|
|
|
|
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|
|
|
<screen role="root"><userinput>make install</userinput></screen>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="commands">
|
|
<title>Command Explanations</title>
|
|
|
|
<para><parameter>--localstatedir=/var/lib</parameter>: This parameter is
|
|
used so that ScrollKeeper files are installed in the system ScrollKeeper
|
|
database directory
|
|
(<filename class='directory'>/var/lib/scrollkeeper</filename>) instead of
|
|
<filename class='directory'>/usr/var/scrollkeeper</filename>.</para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Libraries</segtitle>
|
|
<segtitle>Installed Directories</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman,
|
|
gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj</seg>
|
|
<seg>None</seg>
|
|
<seg>The following subdirectories of /usr/share/:
|
|
doc/gtk-doc->k-doc-version;,
|
|
gnome/help/gtk-doc-manual,
|
|
gtk-doc/data and
|
|
{omf,sgml}/gtk-doc</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 <application>Perl</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>
|