source: general/genutils/gtk-doc.xml@ 01f6162

<?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/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
  <!ENTITY gtk-doc-download-ftp  "&gnome-download-ftp;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
  <!ENTITY gtk-doc-md5sum        "7aa8a1262c70692ebbdf33395fddd5c4">
  <!ENTITY gtk-doc-size          "767 KB">
  <!ENTITY gtk-doc-buildsize     "10 MB">
  <!ENTITY gtk-doc-time          "0.4 SBU">
]>

<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-doc-version;">
  <?dbhtml filename="gtk-doc.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>GTK-Doc-&gtk-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>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&gtk-doc-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&gtk-doc-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gtk-doc-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gtk-doc-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &gtk-doc-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &gtk-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"/>, and
    <xref linkend="libxslt"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="glib2"/> (for the testsuite),
    <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
    <xref linkend="fop"/> (XML PDF support),
    <xref linkend="gnome-doc-utils"/> and
    <xref linkend="which"/> (builds gtk-doc documentation),
    <xref linkend="openjade"/> with
    <xref linkend="sgml-dtd"/> and
    <xref linkend="docbook-dsssl"/>
    (SGML support, not actively maintained any more),
    <xref linkend="python"/> (builds gtkdoc-depscan), and
    <xref linkend="rarian"/></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>

    <!-- Does not apply to this version? <note>
      <para>If you installed the <xref linkend="scrollkeeper"/> package and
      then followed it with <xref linkend="rarian"/> package, there will be
      Scrollkeeper files missing (Rarian removed them) and the build will
      fail. In this instance you should add the paramater
      <option>\-\-disable-scrollkeeper</option> to the
      <command>./configure</command> command shown below.</para>
    </note> -->

    <para>Install <application>GTK-Doc</application> by running
    the following commands:</para>

<screen><userinput>./configure --prefix=/usr  \
            --disable-scrollkeeper &amp;&amp;
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>

    <!--  <para>The test suite requires that the package has been installed first, but
    there's no reason to run it as there is a missing file which causes the test
    suite to fail.  If you insist on seeing the results, an an unprivileged user
    run: <command>make check</command>.</para> -->

  </sect2>

<!--  <sect2 role="commands">
    <title>Command Explanations</title>

    \<\!\-\- no scrollkeeper files with this version
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/scrollkeeper-dir.xml"/> \-\-\>

  </sect2> -->

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--disable-scrollkeeper</parameter>: Do not make updates to
    the <application>scrollkeeper</application> database. Remove it if you have
    <application>rarian</application> installed.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdocize,
        gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-mktmpl,
        gtkdoc-rebase, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj</seg>
        <seg>None</seg>
        <seg>/usr/share/{gnome/help/gtk-doc-manual/*,gtk-doc/data,omf/gtk-doc-manual,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 shell, <application>Perl</application>, 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>