mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-02-03 14:47:17 +08:00
Tagged gtk-doc.xml
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3929 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Manuel Canales Esparcia
parent
ab29575a3b
commit
effdc6af02
@ -4,106 +4,124 @@
|
||||
<!ENTITY % general-entities SYSTEM "../../general.ent">
|
||||
%general-entities;
|
||||
|
||||
<!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
||||
<!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
||||
<!ENTITY gtk-doc-md5sum "d105d5b28e7e023ab1b7e85fb65e45c3">
|
||||
<!ENTITY gtk-doc-size "145 KB">
|
||||
<!ENTITY gtk-doc-buildsize "1.6 MB">
|
||||
<!ENTITY gtk-doc-time "0.01 SBU">
|
||||
<!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
||||
<!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.bz2">
|
||||
<!ENTITY gtk-doc-md5sum "d105d5b28e7e023ab1b7e85fb65e45c3">
|
||||
<!ENTITY gtk-doc-size "145 KB">
|
||||
<!ENTITY gtk-doc-buildsize "1.6 MB">
|
||||
<!ENTITY gtk-doc-time "0.01 SBU">
|
||||
]>
|
||||
|
||||
<sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
||||
<sect1info>
|
||||
<othername>$LastChangedBy$</othername>
|
||||
<date>$Date$</date>
|
||||
</sect1info>
|
||||
<?dbhtml filename="gtk-doc.html"?>
|
||||
<title>GTK-Doc->k-doc-version;</title>
|
||||
<indexterm zone="gtk-doc">
|
||||
<primary sortas="a-GTK-Doc">GTK-Doc</primary></indexterm>
|
||||
<?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>
|
||||
<title>Introduction to <application><acronym>GTK</acronym>-Doc</application>
|
||||
</title>
|
||||
<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 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><xref linkend="openjade"/>,
|
||||
<xref linkend="libxslt"/>,
|
||||
<xref linkend="DocBook"/> and
|
||||
<xref linkend="docbook-xsl"/></para>
|
||||
|
||||
<bridgehead renderas="sect4">Optional</bridgehead>
|
||||
<para><xref linkend="sgml-dtd"/> and <xref linkend="docbook-dsssl"/></para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2 role="installation">
|
||||
<title>Installation of GTK-Doc</title>
|
||||
|
||||
<para>The <application><acronym>GTK</acronym>-Doc</application> package
|
||||
contains a code documentor. This is useful for extracting specially formatted
|
||||
comments from the code to create <acronym>API</acronym> 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><acronym>GTK</acronym>-Doc</application> is not
|
||||
available, the install process will copy pre-built documentation to your
|
||||
system.</para>
|
||||
<para>Install <application>GTK-Doc</application> by running
|
||||
the following commands:</para>
|
||||
|
||||
<sect3><title>Package information</title>
|
||||
<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>
|
||||
</sect3>
|
||||
|
||||
<sect3><title><application><acronym>GTK</acronym>-Doc</application>
|
||||
dependencies</title>
|
||||
<sect4><title>Required</title>
|
||||
<para><xref linkend="openjade"/>,
|
||||
<xref linkend="libxslt"/>,
|
||||
<xref linkend="DocBook"/> and
|
||||
<xref linkend="docbook-xsl"/></para>
|
||||
</sect4>
|
||||
|
||||
<sect4><title>Optional</title>
|
||||
<para><xref linkend="sgml-dtd"/> and <xref linkend="docbook-dsssl"/></para>
|
||||
</sect4>
|
||||
|
||||
</sect3>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>Installation of <application><acronym>GTK</acronym>-Doc</application>
|
||||
</title>
|
||||
|
||||
<para>Install <application><acronym>GTK</acronym>-Doc</application> by running
|
||||
the following commands:</para>
|
||||
|
||||
<screen><userinput><command>./configure --prefix=/usr</command></userinput></screen>
|
||||
|
||||
<para>Now, as the root user:</para>
|
||||
|
||||
<screen><userinput role='root'><command>make install</command></userinput></screen>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<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>/usr/share/gtk-doc and /usr/share/sgml/gtk-doc</seg>
|
||||
</seglistitem>
|
||||
</segmentedlist>
|
||||
|
||||
<sect3><title> Short description</title>
|
||||
<para>These are all <application>Perl</application> scripts used by
|
||||
package <filename>Makefile</filename> scripts to generate documentation for
|
||||
the package being built.</para>
|
||||
</sect3>
|
||||
|
||||
</sect2>
|
||||
<screen><userinput>./configure --prefix=/usr</userinput></screen>
|
||||
|
||||
<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-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman,
|
||||
gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj</seg>
|
||||
<seg>None</seg>
|
||||
<seg>/usr/share/gtk-doc and /usr/share/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>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user