[411e760] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY gnome-doc-utils-download-http
|
---|
| 8 | "&gnome-download-http;/gnome-doc-utils/0.20/gnome-doc-utils-&gnome-doc-utils-version;.tar.xz">
|
---|
| 9 | <!ENTITY gnome-doc-utils-download-ftp
|
---|
| 10 | "&gnome-download-ftp;/gnome-doc-utils/0.20/gnome-doc-utils-&gnome-doc-utils-version;.tar.xz">
|
---|
| 11 | <!ENTITY gnome-doc-utils-md5sum "3c64ad7bacd617b04999e4a168afaac5">
|
---|
| 12 | <!ENTITY gnome-doc-utils-size "516 KB">
|
---|
| 13 | <!ENTITY gnome-doc-utils-buildsize "17 MB">
|
---|
| 14 | <!ENTITY gnome-doc-utils-time "0.2 SBU">
|
---|
| 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect1 id="gnome-doc-utils" xreflabel="gnome-doc-utils-&gnome-doc-utils-version;">
|
---|
| 18 | <?dbhtml filename="gnome-doc-utils.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect1info>
|
---|
| 21 | <othername>$LastChangedBy$</othername>
|
---|
| 22 | <date>$Date$</date>
|
---|
| 23 | </sect1info>
|
---|
| 24 |
|
---|
| 25 | <title>gnome-doc-utils-&gnome-doc-utils-version;</title>
|
---|
| 26 |
|
---|
| 27 | <indexterm zone="gnome-doc-utils">
|
---|
| 28 | <primary sortas="a-gnome-doc-utils">gnome-doc-utils</primary>
|
---|
| 29 | </indexterm>
|
---|
| 30 |
|
---|
| 31 | <sect2 role="package">
|
---|
| 32 | <title>Introduction to GNOME Doc Utils</title>
|
---|
| 33 |
|
---|
| 34 | <para>
|
---|
| 35 | The <application>GNOME Doc Utils</application> package is a collection
|
---|
| 36 | of documentation utilities for the <application>GNOME</application> project.
|
---|
| 37 | Notably, it contains utilities for building documentation and all auxiliary
|
---|
| 38 | files in your source tree, and it contains the DocBook XSLT stylesheets that
|
---|
| 39 | were once distributed with <application>Yelp</application>.
|
---|
| 40 | </para>
|
---|
| 41 |
|
---|
| 42 | &lfs72_checked;
|
---|
| 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download MD5 sum: &gnome-doc-utils-md5sum;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Download size: &gnome-doc-utils-size;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated disk space required: &gnome-doc-utils-buildsize;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>
|
---|
| 73 | Estimated build time: &gnome-doc-utils-time;
|
---|
| 74 | </para>
|
---|
| 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 81 | <para role="required">
|
---|
| 82 | <xref linkend="intltool"/>,
|
---|
| 83 | <xref linkend="libxslt"/>,
|
---|
| 84 | <xref linkend="python2"/> (Required to be installed prior to <xref linkend="libxml2"/>) and
|
---|
| 85 | <xref linkend="which"/>
|
---|
| 86 | <!-- (Every package that uses gnome-doc-utils requires
|
---|
| 87 | which but no configure script references it) -->
|
---|
| 88 | </para>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 91 | <para role="recommended">
|
---|
| 92 | <xref linkend="rarian"/>
|
---|
| 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <para>
|
---|
| 96 | <application>Rarian</application> is listed as recommended even though
|
---|
| 97 | <application>GNOME Doc Utils</application> will build fine without it.
|
---|
| 98 | If you don't install <application>Rarian</application> (and you pass the
|
---|
| 99 | the appropriate flag to the <command>configure</command> command so that
|
---|
| 100 | it will build without it), functionality will be missing that is expected
|
---|
| 101 | later in other <application>GNOME</application> packages.
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
| 104 | <para condition="html" role="usernotes">User Notes:
|
---|
| 105 | <ulink url="&blfs-wiki;/gnome-doc-utils"/>
|
---|
| 106 | </para>
|
---|
| 107 | </sect2>
|
---|
| 108 |
|
---|
| 109 | <sect2 role="installation">
|
---|
| 110 | <title>Installation of GNOME Doc Utils</title>
|
---|
| 111 |
|
---|
| 112 | <para>
|
---|
| 113 | Install <application>GNOME Doc Utils</application>
|
---|
| 114 | by running the following commands:
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 118 | make</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
| 121 | To test the results, issue: <command>make check</command>.
|
---|
| 122 | </para>
|
---|
| 123 |
|
---|
| 124 | <para>
|
---|
| 125 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 129 |
|
---|
| 130 | </sect2>
|
---|
| 131 |
|
---|
| 132 | <sect2 role="content">
|
---|
| 133 | <title>Contents</title>
|
---|
| 134 |
|
---|
| 135 | <segmentedlist>
|
---|
| 136 | <segtitle>Installed Programs</segtitle>
|
---|
| 137 | <segtitle>Installed Libraries</segtitle>
|
---|
| 138 | <segtitle>Installed Directories</segtitle>
|
---|
| 139 | <segtitle>Installed Stylesheets</segtitle>
|
---|
| 140 |
|
---|
| 141 | <seglistitem>
|
---|
| 142 | <seg>
|
---|
| 143 | gnome-doc-prepare, gnome-doc-tool and xml2po
|
---|
| 144 | </seg>
|
---|
| 145 | <seg>
|
---|
| 146 | None
|
---|
| 147 | </seg>
|
---|
| 148 | <seg>
|
---|
| 149 | /usr/lib/python&python2-majorver;/site-packages/xml2po,
|
---|
| 150 | /usr/share/gnome-doc-utils,
|
---|
| 151 | /usr/share/xml/gnome,
|
---|
| 152 | /usr/share/xml/mallard,
|
---|
| 153 | /usr/share/gnome/help/gnome-doc-make and
|
---|
| 154 | /usr/share/gnome/help/gnome-doc-xslt
|
---|
| 155 | </seg>
|
---|
| 156 | <seg>
|
---|
| 157 | Custom DocBook XSLT stylesheets
|
---|
| 158 | </seg>
|
---|
| 159 | </seglistitem>
|
---|
| 160 | </segmentedlist>
|
---|
| 161 |
|
---|
| 162 | <variablelist>
|
---|
| 163 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 164 | <?dbfo list-presentation="list"?>
|
---|
| 165 | <?dbhtml list-presentation="table"?>
|
---|
| 166 |
|
---|
| 167 | <varlistentry id="gnome-doc-prepare">
|
---|
| 168 | <term><command>gnome-doc-prepare</command></term>
|
---|
| 169 | <listitem>
|
---|
| 170 | <para>
|
---|
| 171 | prepares a package to use
|
---|
| 172 | <application>GNOME Doc Utils</application>.
|
---|
| 173 | </para>
|
---|
| 174 | <indexterm zone="gnome-doc-utils gnome-doc-prepare">
|
---|
| 175 | <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 | </listitem>
|
---|
| 178 | </varlistentry>
|
---|
| 179 |
|
---|
| 180 | <varlistentry id="gnome-doc-tool">
|
---|
| 181 | <term><command>gnome-doc-tool</command></term>
|
---|
| 182 | <listitem>
|
---|
| 183 | <para>
|
---|
| 184 | is used to convert documents to either HTML or XHTML.
|
---|
| 185 | </para>
|
---|
| 186 | <indexterm zone="gnome-doc-utils gnome-doc-tool">
|
---|
| 187 | <primary sortas="b-gnome-doc-tool">gnome-doc-tool</primary>
|
---|
| 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
| 191 |
|
---|
| 192 | <varlistentry id="xml2po">
|
---|
| 193 | <term><command>xml2po</command></term>
|
---|
| 194 | <listitem>
|
---|
| 195 | <para>
|
---|
| 196 | is a <application>Python</application> script used to
|
---|
| 197 | translate XML documents.
|
---|
| 198 | </para>
|
---|
| 199 | <indexterm zone="gnome-doc-utils xml2po">
|
---|
| 200 | <primary sortas="b-xml2po">xml2po</primary>
|
---|
| 201 | </indexterm>
|
---|
| 202 | </listitem>
|
---|
| 203 | </varlistentry>
|
---|
| 204 |
|
---|
| 205 | </variablelist>
|
---|
| 206 |
|
---|
| 207 | </sect2>
|
---|
| 208 |
|
---|
| 209 | </sect1>
|
---|