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