[0a31110] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[0a31110] | 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 |
|
---|
[370f305] | 15 | <sect1 id="gnome-doc-utils"
|
---|
| 16 | xreflabel="GNOME Doc Utils-&gnome-doc-utils-version;">
|
---|
[0a31110] | 17 | <sect1info>
|
---|
| 18 | <othername>$LastChangedBy$</othername>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 | <?dbhtml filename="gnome-doc-utils.html"?>
|
---|
| 22 | <title><application><acronym>GNOME</acronym> Doc
|
---|
| 23 | Utils</application>-&gnome-doc-utils-version;</title>
|
---|
[370f305] | 24 | <indexterm zone="gnome-doc-utils">
|
---|
| 25 | <primary sortas="a-GNOME-Doc-Utils">GNOME Doc Utils</primary>
|
---|
| 26 | </indexterm>
|
---|
[0a31110] | 27 |
|
---|
| 28 | <sect2>
|
---|
| 29 | <title>Introduction to <application><acronym>GNOME</acronym> Doc
|
---|
| 30 | Utils</application></title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application><acronym>GNOME</acronym> Doc Utils</application>
|
---|
| 33 | package is a collection of documentation utilities for the
|
---|
| 34 | <application><acronym>GNOME</acronym></application> project. Notably, it
|
---|
| 35 | contains utilities for building documentation and all auxiliary files in your
|
---|
| 36 | source tree, and it contains the DocBook <acronym>XSLT</acronym> stylesheets
|
---|
| 37 | that were once distributed with <application>Yelp</application>. Starting with
|
---|
| 38 | <application><acronym>GNOME</acronym></application> 2.8,
|
---|
| 39 | <application>Yelp</application> will require
|
---|
| 40 | <application><acronym>GNOME</acronym> Doc Utils</application> for the
|
---|
| 41 | <acronym>XSLT</acronym>.</para>
|
---|
| 42 |
|
---|
| 43 | <sect3><title>Package information</title>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem><para>Download (HTTP):
|
---|
| 46 | <ulink url="&gnome-doc-utils-download-http;"/></para></listitem>
|
---|
| 47 | <listitem><para>Download (FTP):
|
---|
| 48 | <ulink url="&gnome-doc-utils-download-ftp;"/></para></listitem>
|
---|
| 49 | <listitem><para>Download MD5 sum: &gnome-doc-utils-md5sum;</para></listitem>
|
---|
| 50 | <listitem><para>Download size: &gnome-doc-utils-size;</para></listitem>
|
---|
| 51 | <listitem><para>Estimated disk space required:
|
---|
| 52 | &gnome-doc-utils-buildsize;</para></listitem>
|
---|
| 53 | <listitem><para>Estimated build time:
|
---|
| 54 | &gnome-doc-utils-time;</para></listitem></itemizedlist>
|
---|
| 55 | </sect3>
|
---|
| 56 |
|
---|
| 57 | <sect3><title><application><acronym>GNOME</acronym> Doc Utils</application>
|
---|
| 58 | dependencies</title>
|
---|
| 59 | <sect4><title>Required</title>
|
---|
| 60 | <para><xref linkend="scrollkeeper"/></para>
|
---|
| 61 | </sect4>
|
---|
| 62 |
|
---|
| 63 | <sect4><title>Optional</title>
|
---|
[775c349a] | 64 | <para><xref linkend="pkgconfig"/> and <xref linkend="python"/></para>
|
---|
[0a31110] | 65 | </sect4>
|
---|
| 66 | </sect3>
|
---|
| 67 |
|
---|
| 68 | </sect2>
|
---|
| 69 |
|
---|
| 70 | <sect2>
|
---|
| 71 | <title>Installation of <application><acronym>GNOME</acronym> Doc
|
---|
| 72 | Utils</application></title>
|
---|
| 73 |
|
---|
| 74 | <para>Install <application><acronym>GNOME</acronym> Doc Utils</application>
|
---|
| 75 | by running the following commands:</para>
|
---|
| 76 |
|
---|
| 77 | <screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
|
---|
| 78 | --localstatedir=/var/lib &&
|
---|
[370f305] | 79 | make</command></userinput></screen>
|
---|
| 80 |
|
---|
| 81 | <para>Now, as the root user:</para>
|
---|
| 82 |
|
---|
| 83 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
[0a31110] | 84 |
|
---|
| 85 | </sect2>
|
---|
| 86 |
|
---|
| 87 | <sect2>
|
---|
| 88 | <title>Command explanations</title>
|
---|
| 89 |
|
---|
| 90 | <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
|
---|
| 91 | <application>ScrollKeeper</application> files in
|
---|
| 92 | <filename class='directory'>/var/lib/scrollkeeper</filename> instead of
|
---|
| 93 | <filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>
|
---|
| 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2>
|
---|
| 98 | <title>Contents</title>
|
---|
| 99 |
|
---|
[370f305] | 100 | <segmentedlist>
|
---|
| 101 | <segtitle>Installed Programs</segtitle>
|
---|
| 102 | <segtitle>Installed Libraries</segtitle>
|
---|
| 103 | <segtitle>Installed Directories</segtitle>
|
---|
| 104 | <segtitle>Installed Stylesheets</segtitle>
|
---|
| 105 |
|
---|
| 106 | <seglistitem>
|
---|
| 107 | <seg>xml2po</seg>
|
---|
| 108 | <seg>None</seg>
|
---|
| 109 | <seg>$GNOME_PREFIX/share/gnome-doc-utils,
|
---|
| 110 | $GNOME_PREFIX/share/gnome/help/gnome-doc-xslt,
|
---|
| 111 | $GNOME_PREFIX/share/omf/gnome-doc-make,
|
---|
| 112 | $GNOME_PREFIX/share/omf/gnome-doc-xslt,
|
---|
| 113 | $GNOME_PREFIX/share/xml and
|
---|
| 114 | $GNOME_PREFIX/share/xml2po</seg>
|
---|
| 115 | <seg>Custom DocBook XSLT stylesheets used by Yelp</seg>
|
---|
| 116 | </seglistitem>
|
---|
| 117 | </segmentedlist>
|
---|
| 118 |
|
---|
| 119 | <variablelist>
|
---|
| 120 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 121 | <?dbfo list-presentation="list"?>
|
---|
| 122 |
|
---|
| 123 | <varlistentry id="xml2po">
|
---|
| 124 | <term><command>xml2po</command></term>
|
---|
| 125 | <listitem><para>is a <application>Python</application> script used to
|
---|
| 126 | translate <acronym>XML</acronym> documents.</para>
|
---|
| 127 | <indexterm zone="gnome-doc-utils xml2po">
|
---|
| 128 | <primary sortas="b-xml2po">xml2po</primary>
|
---|
| 129 | </indexterm></listitem>
|
---|
| 130 | </varlistentry>
|
---|
| 131 | </variablelist>
|
---|
[0a31110] | 132 |
|
---|
| 133 | </sect2>
|
---|
| 134 |
|
---|
| 135 | </sect1>
|
---|
| 136 |
|
---|