source: gnome/core/gnome-doc-utils.xml@ 29590dda

<?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 gnome-doc-utils-download-http "http://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/0.2/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
  <!ENTITY gnome-doc-utils-download-ftp  "ftp://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/0.2/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
  <!ENTITY gnome-doc-utils-md5sum        "c72f2a974e4f05210d2736e92399c58e">
  <!ENTITY gnome-doc-utils-size          "285 KB">
  <!ENTITY gnome-doc-utils-buildsize     "5 MB">
  <!ENTITY gnome-doc-utils-time          "0.2 SBU">
]>

<sect1 id="gnome-doc-utils" 
xreflabel="GNOME Doc Utils-&gnome-doc-utils-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="gnome-doc-utils.html"?>
<title><application><acronym>GNOME</acronym> Doc 
Utils</application>-&gnome-doc-utils-version;</title>
<indexterm zone="gnome-doc-utils">
<primary sortas="a-GNOME-Doc-Utils">GNOME Doc Utils</primary>
</indexterm>

<sect2>
<title>Introduction to <application><acronym>GNOME</acronym> Doc 
Utils</application></title>

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

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application><acronym>GNOME</acronym> Doc Utils</application> 
dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="scrollkeeper"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="pkgconfig"/> and <xref linkend="python"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>GNOME</acronym> Doc 
Utils</application></title>

<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../without-gnome.xml"/>

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

<screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --localstatedir=/var/lib &amp;&amp;
make</command></userinput></screen>

<para>To test the results, issue: <command>make check</command>.</para>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
<application>ScrollKeeper</application> files in
<filename class='directory'>/var/lib/scrollkeeper</filename> instead of
<filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

</sect2>

<sect2>
<title>Contents</title>

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

<seglistitem>
<seg>gnome-doc-prepare and xml2po</seg>
<seg>None</seg>
<seg>$GNOME_PREFIX/share/gnome-doc-utils, 
$GNOME_PREFIX/share/gnome/help/gnome-doc-make, 
$GNOME_PREFIX/share/gnome/help/gnome-doc-xslt, 
$GNOME_PREFIX/share/omf/gnome-doc-make, 
$GNOME_PREFIX/share/omf/gnome-doc-xslt, 
$GNOME_PREFIX/share/xml and
$GNOME_PREFIX/share/xml2po</seg>
<seg>Custom DocBook XSLT stylesheets used by Yelp</seg>
</seglistitem>
</segmentedlist>

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

<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="xml2po">
<term><command>xml2po</command></term>
<listitem><para>is a <application>Python</application> script used to 
translate <acronym>XML</acronym> documents.</para>
<indexterm zone="gnome-doc-utils xml2po">
<primary sortas="b-xml2po">xml2po</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>