source: gnome/core/gnome-doc-utils.xml@ 440d664

<?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 gnome-doc-utils-download-http 
           "&gnome-download-http;/gnome-doc-utils/0.20/gnome-doc-utils-&gnome-doc-utils-version;.tar.xz">
  <!ENTITY gnome-doc-utils-download-ftp  
           "&gnome-download-ftp;/gnome-doc-utils/0.20/gnome-doc-utils-&gnome-doc-utils-version;.tar.xz">
  <!ENTITY gnome-doc-utils-md5sum        "3c64ad7bacd617b04999e4a168afaac5">
  <!ENTITY gnome-doc-utils-size          "516 KB">
  <!ENTITY gnome-doc-utils-buildsize     "17 MB">
  <!ENTITY gnome-doc-utils-time          "0.2 SBU">
]>

<sect1 id="gnome-doc-utils" xreflabel="gnome-doc-utils-&gnome-doc-utils-version;">
  <?dbhtml filename="gnome-doc-utils.html"?>

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

  <title>gnome-doc-utils-&gnome-doc-utils-version;</title>

  <indexterm zone="gnome-doc-utils">
    <primary sortas="a-gnome-doc-utils">gnome-doc-utils</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Doc Utils</title>

    <para>
      The <application>GNOME Doc Utils</application> package is a collection
      of documentation utilities for the <application>GNOME</application> project.
      Notably, it contains utilities for building documentation and all auxiliary
      files in your source tree, and it contains the DocBook XSLT stylesheets that
      were once distributed with <application>Yelp</application>.
    </para>

    &lfs72_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &gnome-doc-utils-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &gnome-doc-utils-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &gnome-doc-utils-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &gnome-doc-utils-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="intltool"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="python2"/> (Required to be installed prior to <xref linkend="libxml2"/>) and
      <xref linkend="which"/> 
      <!-- (Every package that uses gnome-doc-utils requires 
      which but no configure script references it) -->
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="rarian"/>
    </para>

    <para>
      <application>Rarian</application> is listed as recommended even though
      <application>GNOME Doc Utils</application> will build fine without it.
      If you don't install <application>Rarian</application> (and you pass the
      the appropriate flag to the <command>configure</command> command so that
      it will build without it), functionality will be missing that is expected
      later in other <application>GNOME</application> packages.
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/gnome-doc-utils"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Doc Utils</title>

    <para>
      Install <application>GNOME Doc Utils</application>
      by running the following commands:
    </para>

<screen><userinput>./configure --prefix=/usr &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>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gnome-doc-prepare, gnome-doc-tool and xml2po
        </seg>
        <seg>
          /usr/lib/python&python2-majorver;/site-packages/xml2po,
          /usr/share/gnome-doc-utils,
          /usr/share/xml/gnome,
          /usr/share/xml/mallard,
          /usr/share/gnome/help/gnome-doc-make and
          /usr/share/gnome/help/gnome-doc-xslt
        </seg>
        <seg>
          Custom DocBook XSLT stylesheets
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gnome-doc-prepare">
        <term><command>gnome-doc-prepare</command></term>
        <listitem>
          <para>
            prepares a package to use
            <application>GNOME Doc Utils</application>.
          </para>
          <indexterm zone="gnome-doc-utils gnome-doc-prepare">
            <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-doc-tool">
        <term><command>gnome-doc-tool</command></term>
        <listitem>
          <para>
            is used to convert documents to either HTML or XHTML.
          </para>
          <indexterm zone="gnome-doc-utils gnome-doc-tool">
            <primary sortas="b-gnome-doc-tool">gnome-doc-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xml2po">
        <term><command>xml2po</command></term>
        <listitem>
          <para>
            is a <application>Python</application> script used to
            translate XML documents.
          </para>
          <indexterm zone="gnome-doc-utils xml2po">
            <primary sortas="b-xml2po">xml2po</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>