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