[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 |
|
---|
[9761bea4] | 7 | <!ENTITY gnome-doc-utils-download-http "&gnome-download-http;/gnome-doc-utils/0.6/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
| 8 | <!ENTITY gnome-doc-utils-download-ftp "&gnome-download-ftp;/gnome-doc-utils/0.6/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
[a6bee1f] | 9 | <!ENTITY gnome-doc-utils-md5sum "c706b807b15e07e58561f903c0f20c26">
|
---|
| 10 | <!ENTITY gnome-doc-utils-size "384 KB">
|
---|
| 11 | <!ENTITY gnome-doc-utils-buildsize "9.0 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>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>GNOME Doc Utils-&gnome-doc-utils-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="gnome-doc-utils">
|
---|
| 26 | <primary sortas="a-GNOME-Doc-Utils">GNOME Doc Utils</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to GNOME Doc Utils</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>GNOME Doc Utils</application> package is a collection
|
---|
| 33 | of documentation utilities for the <application>GNOME</application> project.
|
---|
| 34 | Notably, it contains utilities for building documentation and all auxiliary
|
---|
| 35 | files in your source tree, and it contains the DocBook XSLT stylesheets that
|
---|
| 36 | were once distributed with <application>Yelp</application>. Starting with
|
---|
[0c4e116] | 37 | <application>GNOME</application> 2.8, <application>Yelp</application>
|
---|
| 38 | requires <application>GNOME Doc Utils</application> for the XSLT. Starting
|
---|
| 39 | with <application>GNOME</application> 2.12, many of the core
|
---|
[ecec697] | 40 | <application>GNOME</application> packages require
|
---|
[0c4e116] | 41 | <application>GNOME Doc Utils</application>.</para>
|
---|
[34d0cf2] | 42 |
|
---|
| 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download MD5 sum: &gnome-doc-utils-md5sum;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download size: &gnome-doc-utils-size;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated disk space required: &gnome-doc-utils-buildsize;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated build time: &gnome-doc-utils-time;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
| 64 |
|
---|
| 65 | <bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead>
|
---|
| 66 |
|
---|
[e155d07] | 67 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 68 | <para role="required"><xref linkend="libxslt"/></para>
|
---|
| 69 |
|
---|
[a6bee1f] | 70 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[695a621] | 71 | <para role="required"><xref linkend="python"/> and
|
---|
| 72 | <xref linkend="scrollkeeper"/></para>
|
---|
[ecec697] | 73 |
|
---|
[551b9389] | 74 | <para>The packages are listed as recommended even though
|
---|
| 75 | <application>GNOME Doc Utils</application> will build fine without them.
|
---|
| 76 | If you don't install the recommended packages (and you pass the appropriate
|
---|
| 77 | flags to the <command>configure</command> command so that it will build
|
---|
| 78 | without them), functionality will be missing that is expected later in
|
---|
| 79 | other GNOME packages.</para>
|
---|
[a6bee1f] | 80 |
|
---|
[34d0cf2] | 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b22e19bf] | 82 | <para role="optional"><xref linkend="pkgconfig"/></para>
|
---|
[34d0cf2] | 83 |
|
---|
[0a7c3921] | 84 | <para condition="html" role="usernotes">User Notes:
|
---|
| 85 | <ulink url="&blfs-wiki;/gnome-doc-utils"/></para>
|
---|
| 86 |
|
---|
[34d0cf2] | 87 | </sect2>
|
---|
| 88 |
|
---|
| 89 | <sect2 role="installation">
|
---|
| 90 | <title>Installation of GNOME Doc Utils</title>
|
---|
| 91 |
|
---|
| 92 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
[7cdaed0] | 93 | href="../../xincludes/without-gnome.xml"/>
|
---|
[34d0cf2] | 94 |
|
---|
| 95 | <para>Install <application>GNOME Doc Utils</application>
|
---|
| 96 | by running the following commands:</para>
|
---|
| 97 |
|
---|
[0833850] | 98 | <screen><userinput>sed -i 's/@.*@pkgconfig/pkgconfig/' Makefile.in &&
|
---|
| 99 | ./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
|
---|
[a6bee1f] | 100 | --mandir=$(pkg-config \
|
---|
| 101 | --variable=prefix ORBit-2.0)/share/man &&
|
---|
[34d0cf2] | 102 | make</userinput></screen>
|
---|
| 103 |
|
---|
| 104 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
| 105 |
|
---|
| 106 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 107 |
|
---|
| 108 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 109 |
|
---|
| 110 | </sect2>
|
---|
| 111 |
|
---|
[551b9389] | 112 | <sect2 role="commands">
|
---|
| 113 | <title>Command Explanations</title>
|
---|
| 114 |
|
---|
[0833850] | 115 | <para><command>sed -i 's/@.*@pkgconfig/pkgconfig/' Makefile.in</command>:
|
---|
| 116 | If you build <application>GNOME Doc Utils</application>
|
---|
| 117 | without <application>Python</application>, the
|
---|
| 118 | <application>pkg-config</application> support files will not be
|
---|
| 119 | installed. This command ensures that they are always installed.</para>
|
---|
| 120 |
|
---|
[551b9389] | 121 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
[7cdaed0] | 122 | href="../../xincludes/gnome-prefix.xml"/>
|
---|
[551b9389] | 123 |
|
---|
| 124 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
[7cdaed0] | 125 | href="../../xincludes/gnome-mandir.xml"/>
|
---|
[551b9389] | 126 |
|
---|
| 127 | </sect2>
|
---|
| 128 |
|
---|
[34d0cf2] | 129 | <sect2 role="content">
|
---|
| 130 | <title>Contents</title>
|
---|
| 131 |
|
---|
| 132 | <segmentedlist>
|
---|
| 133 | <segtitle>Installed Programs</segtitle>
|
---|
| 134 | <segtitle>Installed Libraries</segtitle>
|
---|
| 135 | <segtitle>Installed Directories</segtitle>
|
---|
| 136 | <segtitle>Installed Stylesheets</segtitle>
|
---|
| 137 |
|
---|
| 138 | <seglistitem>
|
---|
| 139 | <seg>gnome-doc-prepare and xml2po</seg>
|
---|
| 140 | <seg>None</seg>
|
---|
[551b9389] | 141 | <seg>The following subdirectories of
|
---|
| 142 | <envar>$GNOME_PREFIX</envar>/share/:
|
---|
[a6bee1f] | 143 | gnome-doc-utils,
|
---|
| 144 | gnome/help/gnome-doc-{make,xslt},
|
---|
| 145 | omf/gnome-doc-{make,xslt},
|
---|
| 146 | xml/gnome and
|
---|
| 147 | xml2po}</seg>
|
---|
[0c4e116] | 148 | <seg>Custom DocBook XSLT stylesheets</seg>
|
---|
[34d0cf2] | 149 | </seglistitem>
|
---|
| 150 | </segmentedlist>
|
---|
| 151 |
|
---|
| 152 | <variablelist>
|
---|
| 153 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 154 | <?dbfo list-presentation="list"?>
|
---|
| 155 | <?dbhtml list-presentation="table"?>
|
---|
| 156 |
|
---|
| 157 | <varlistentry id="gnome-doc-prepare">
|
---|
| 158 | <term><command>gnome-doc-prepare</command></term>
|
---|
| 159 | <listitem>
|
---|
| 160 | <para>prepares a package to use
|
---|
| 161 | <application>gnome-doc-utils</application>.</para>
|
---|
| 162 | <indexterm zone="gnome-doc-utils gnome-doc-prepare">
|
---|
| 163 | <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
|
---|
| 164 | </indexterm>
|
---|
| 165 | </listitem>
|
---|
| 166 | </varlistentry>
|
---|
| 167 |
|
---|
| 168 | <varlistentry id="xml2po">
|
---|
| 169 | <term><command>xml2po</command></term>
|
---|
| 170 | <listitem>
|
---|
| 171 | <para>is a <application>Python</application> script used to
|
---|
| 172 | translate XML documents.</para>
|
---|
| 173 | <indexterm zone="gnome-doc-utils xml2po">
|
---|
| 174 | <primary sortas="b-xml2po">xml2po</primary>
|
---|
| 175 | </indexterm>
|
---|
| 176 | </listitem>
|
---|
| 177 | </varlistentry>
|
---|
| 178 |
|
---|
| 179 | </variablelist>
|
---|
| 180 |
|
---|
| 181 | </sect2>
|
---|
[0a31110] | 182 |
|
---|
| 183 | </sect1>
|
---|