[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 |
|
---|
[e9039e4] | 7 | <!ENTITY gnome-doc-utils-download-http "&gnome-download-http;/gnome-doc-utils/0.4/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
| 8 | <!ENTITY gnome-doc-utils-download-ftp "&gnome-download-ftp;/gnome-doc-utils/0.4/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
[ede3489] | 9 | <!ENTITY gnome-doc-utils-md5sum "b89d9e9830f5b3e0ead295104637a207">
|
---|
| 10 | <!ENTITY gnome-doc-utils-size "382 KB">
|
---|
| 11 | <!ENTITY gnome-doc-utils-buildsize "6.5 MB">
|
---|
[0c4e116] | 12 | <!ENTITY gnome-doc-utils-time "less than 0.1 SBU">
|
---|
[0a31110] | 13 | ]>
|
---|
| 14 |
|
---|
[34d0cf2] | 15 | <sect1 id="gnome-doc-utils" xreflabel="GNOME Doc Utils-&gnome-doc-utils-version;">
|
---|
| 16 | <?dbhtml filename="gnome-doc-utils.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[b22e19bf] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">gnome-doc-utils-&gnome-doc-utils-version;.tar</keyword>
|
---|
[e7307aa1] | 23 | <keyword role="ftpdir">gnome-doc-utils</keyword>
|
---|
[b22e19bf] | 24 | </keywordset>
|
---|
[34d0cf2] | 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>GNOME Doc Utils-&gnome-doc-utils-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="gnome-doc-utils">
|
---|
| 30 | <primary sortas="a-GNOME-Doc-Utils">GNOME Doc Utils</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to GNOME Doc Utils</title>
|
---|
| 35 |
|
---|
| 36 | <para>The <application>GNOME Doc Utils</application> package is a collection
|
---|
| 37 | of documentation utilities for the <application>GNOME</application> project.
|
---|
| 38 | Notably, it contains utilities for building documentation and all auxiliary
|
---|
| 39 | files in your source tree, and it contains the DocBook XSLT stylesheets that
|
---|
| 40 | were once distributed with <application>Yelp</application>. Starting with
|
---|
[0c4e116] | 41 | <application>GNOME</application> 2.8, <application>Yelp</application>
|
---|
| 42 | requires <application>GNOME Doc Utils</application> for the XSLT. Starting
|
---|
| 43 | with <application>GNOME</application> 2.12, many of the core
|
---|
[ecec697] | 44 | <application>GNOME</application> packages require
|
---|
[0c4e116] | 45 | <application>GNOME Doc Utils</application>.</para>
|
---|
[34d0cf2] | 46 |
|
---|
| 47 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 48 | <itemizedlist spacing="compact">
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/></para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/></para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Download MD5 sum: &gnome-doc-utils-md5sum;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Download size: &gnome-doc-utils-size;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>Estimated disk space required: &gnome-doc-utils-buildsize;</para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>Estimated build time: &gnome-doc-utils-time;</para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[e9039e4] | 72 | <para role="required"><xref linkend="python"/>,
|
---|
| 73 | <xref linkend="scrollkeeper"/>, and
|
---|
| 74 | <xref linkend="perl-xml-parser"/></para>
|
---|
[ecec697] | 75 |
|
---|
[34d0cf2] | 76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b22e19bf] | 77 | <para role="optional"><xref linkend="pkgconfig"/></para>
|
---|
[34d0cf2] | 78 |
|
---|
| 79 | </sect2>
|
---|
| 80 |
|
---|
| 81 | <sect2 role="installation">
|
---|
| 82 | <title>Installation of GNOME Doc Utils</title>
|
---|
| 83 |
|
---|
| 84 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
| 85 | href="../without-gnome.xml"/>
|
---|
| 86 |
|
---|
| 87 | <para>Install <application>GNOME Doc Utils</application>
|
---|
| 88 | by running the following commands:</para>
|
---|
| 89 |
|
---|
[e957423] | 90 | <screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` &&
|
---|
[34d0cf2] | 91 | make</userinput></screen>
|
---|
| 92 |
|
---|
| 93 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
| 94 |
|
---|
| 95 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 96 |
|
---|
| 97 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 98 |
|
---|
| 99 | </sect2>
|
---|
| 100 |
|
---|
| 101 | <sect2 role="content">
|
---|
| 102 | <title>Contents</title>
|
---|
| 103 |
|
---|
| 104 | <segmentedlist>
|
---|
| 105 | <segtitle>Installed Programs</segtitle>
|
---|
| 106 | <segtitle>Installed Libraries</segtitle>
|
---|
| 107 | <segtitle>Installed Directories</segtitle>
|
---|
| 108 | <segtitle>Installed Stylesheets</segtitle>
|
---|
| 109 |
|
---|
| 110 | <seglistitem>
|
---|
| 111 | <seg>gnome-doc-prepare and xml2po</seg>
|
---|
| 112 | <seg>None</seg>
|
---|
[e62f701] | 113 | <seg>The following subdirectories of $GNOME_PREFIX/:
|
---|
| 114 | share/[gnome-doc-utils, gnome/help/gnome-doc-[make,xslt],
|
---|
| 115 | omf/gnome-doc-[make,xslt], xml/gnome, and xml2po]</seg>
|
---|
[0c4e116] | 116 | <seg>Custom DocBook XSLT stylesheets</seg>
|
---|
[34d0cf2] | 117 | </seglistitem>
|
---|
| 118 | </segmentedlist>
|
---|
| 119 |
|
---|
| 120 | <variablelist>
|
---|
| 121 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 122 | <?dbfo list-presentation="list"?>
|
---|
| 123 | <?dbhtml list-presentation="table"?>
|
---|
| 124 |
|
---|
| 125 | <varlistentry id="gnome-doc-prepare">
|
---|
| 126 | <term><command>gnome-doc-prepare</command></term>
|
---|
| 127 | <listitem>
|
---|
| 128 | <para>prepares a package to use
|
---|
| 129 | <application>gnome-doc-utils</application>.</para>
|
---|
| 130 | <indexterm zone="gnome-doc-utils gnome-doc-prepare">
|
---|
| 131 | <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
|
---|
| 132 | </indexterm>
|
---|
| 133 | </listitem>
|
---|
| 134 | </varlistentry>
|
---|
| 135 |
|
---|
| 136 | <varlistentry id="xml2po">
|
---|
| 137 | <term><command>xml2po</command></term>
|
---|
| 138 | <listitem>
|
---|
| 139 | <para>is a <application>Python</application> script used to
|
---|
| 140 | translate XML documents.</para>
|
---|
| 141 | <indexterm zone="gnome-doc-utils xml2po">
|
---|
| 142 | <primary sortas="b-xml2po">xml2po</primary>
|
---|
| 143 | </indexterm>
|
---|
| 144 | </listitem>
|
---|
| 145 | </varlistentry>
|
---|
| 146 |
|
---|
| 147 | </variablelist>
|
---|
| 148 |
|
---|
| 149 | </sect2>
|
---|
[0a31110] | 150 |
|
---|
| 151 | </sect1>
|
---|