| 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY gnome-doc-utils-download-http "http://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/&gnome-doc-utils-version;/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
|---|
| 8 | <!ENTITY gnome-doc-utils-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/&gnome-doc-utils-version;/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
|---|
| 9 | <!ENTITY gnome-doc-utils-md5sum "5b741eb63e11bc35e81587839e4d4759">
|
|---|
| 10 | <!ENTITY gnome-doc-utils-size "233 KB">
|
|---|
| 11 | <!ENTITY gnome-doc-utils-buildsize "5.5 MB">
|
|---|
| 12 | <!ENTITY gnome-doc-utils-time "0.04 SBU">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="gnome-doc-utils" xreflabel="GNOME Doc Utils-&gnome-doc-utils-version;">
|
|---|
| 16 | <sect1info>
|
|---|
| 17 | <othername>$LastChangedBy$</othername>
|
|---|
| 18 | <date>$Date$</date>
|
|---|
| 19 | </sect1info>
|
|---|
| 20 | <?dbhtml filename="gnome-doc-utils.html"?>
|
|---|
| 21 | <title><application><acronym>GNOME</acronym> Doc
|
|---|
| 22 | Utils</application>-&gnome-doc-utils-version;</title>
|
|---|
| 23 |
|
|---|
| 24 | <sect2>
|
|---|
| 25 | <title>Introduction to <application><acronym>GNOME</acronym> Doc
|
|---|
| 26 | Utils</application></title>
|
|---|
| 27 |
|
|---|
| 28 | <para>The <application><acronym>GNOME</acronym> Doc Utils</application>
|
|---|
| 29 | package is a collection of documentation utilities for the
|
|---|
| 30 | <application><acronym>GNOME</acronym></application> project. Notably, it
|
|---|
| 31 | contains utilities for building documentation and all auxiliary files in your
|
|---|
| 32 | source tree, and it contains the DocBook <acronym>XSLT</acronym> stylesheets
|
|---|
| 33 | that were once distributed with <application>Yelp</application>. Starting with
|
|---|
| 34 | <application><acronym>GNOME</acronym></application> 2.8,
|
|---|
| 35 | <application>Yelp</application> will require
|
|---|
| 36 | <application><acronym>GNOME</acronym> Doc Utils</application> for the
|
|---|
| 37 | <acronym>XSLT</acronym>.</para>
|
|---|
| 38 |
|
|---|
| 39 | <sect3><title>Package information</title>
|
|---|
| 40 | <itemizedlist spacing="compact">
|
|---|
| 41 | <listitem><para>Download (HTTP):
|
|---|
| 42 | <ulink url="&gnome-doc-utils-download-http;"/></para></listitem>
|
|---|
| 43 | <listitem><para>Download (FTP):
|
|---|
| 44 | <ulink url="&gnome-doc-utils-download-ftp;"/></para></listitem>
|
|---|
| 45 | <listitem><para>Download MD5 sum: &gnome-doc-utils-md5sum;</para></listitem>
|
|---|
| 46 | <listitem><para>Download size: &gnome-doc-utils-size;</para></listitem>
|
|---|
| 47 | <listitem><para>Estimated disk space required:
|
|---|
| 48 | &gnome-doc-utils-buildsize;</para></listitem>
|
|---|
| 49 | <listitem><para>Estimated build time:
|
|---|
| 50 | &gnome-doc-utils-time;</para></listitem></itemizedlist>
|
|---|
| 51 | </sect3>
|
|---|
| 52 |
|
|---|
| 53 | <sect3><title><application><acronym>GNOME</acronym> Doc Utils</application>
|
|---|
| 54 | dependencies</title>
|
|---|
| 55 | <sect4><title>Required</title>
|
|---|
| 56 | <para><xref linkend="scrollkeeper"/></para>
|
|---|
| 57 | </sect4>
|
|---|
| 58 |
|
|---|
| 59 | <sect4><title>Optional</title>
|
|---|
| 60 | <para><xref linkend="pkgconfig"/> and <xref linkend="python"/></para>
|
|---|
| 61 | </sect4>
|
|---|
| 62 | </sect3>
|
|---|
| 63 |
|
|---|
| 64 | </sect2>
|
|---|
| 65 |
|
|---|
| 66 | <sect2>
|
|---|
| 67 | <title>Installation of <application><acronym>GNOME</acronym> Doc
|
|---|
| 68 | Utils</application></title>
|
|---|
| 69 |
|
|---|
| 70 | <para>Install <application><acronym>GNOME</acronym> Doc Utils</application>
|
|---|
| 71 | by running the following commands:</para>
|
|---|
| 72 |
|
|---|
| 73 | <screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
|
|---|
| 74 | --localstatedir=/var/lib &&
|
|---|
| 75 | make &&
|
|---|
| 76 | make install</command></userinput></screen>
|
|---|
| 77 |
|
|---|
| 78 | </sect2>
|
|---|
| 79 |
|
|---|
| 80 | <sect2>
|
|---|
| 81 | <title>Command explanations</title>
|
|---|
| 82 |
|
|---|
| 83 | <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
|
|---|
| 84 | <application>ScrollKeeper</application> files in
|
|---|
| 85 | <filename class='directory'>/var/lib/scrollkeeper</filename> instead of
|
|---|
| 86 | <filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>
|
|---|
| 87 |
|
|---|
| 88 | </sect2>
|
|---|
| 89 |
|
|---|
| 90 | <sect2>
|
|---|
| 91 | <title>Contents</title>
|
|---|
| 92 |
|
|---|
| 93 | <para>The <application><acronym>GNOME</acronym> Doc Utils</application>
|
|---|
| 94 | package contains <command>xml2po</command> and custom DocBook
|
|---|
| 95 | <acronym>XSLT</acronym> stylesheets.</para>
|
|---|
| 96 |
|
|---|
| 97 | </sect2>
|
|---|
| 98 |
|
|---|
| 99 | <sect2><title>Description</title>
|
|---|
| 100 |
|
|---|
| 101 | <sect3><title>xml2po</title>
|
|---|
| 102 | <para><command>xml2po</command> is a <application>Python</application> script
|
|---|
| 103 | used to translate <acronym>XML</acronym> documents.</para>
|
|---|
| 104 | </sect3>
|
|---|
| 105 |
|
|---|
| 106 | <sect3><title><acronym>XSLT</acronym> stylesheets</title>
|
|---|
| 107 | <para><filename>XSLT stylesheets</filename> are used
|
|---|
| 108 | instead of the Sourceforge maintained stylesheets.</para>
|
|---|
| 109 | </sect3>
|
|---|
| 110 |
|
|---|
| 111 | </sect2>
|
|---|
| 112 |
|
|---|
| 113 | </sect1>
|
|---|
| 114 |
|
|---|
