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 "&gnome-download-http;/gnome-doc-utils/0.20/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
8 | <!ENTITY gnome-doc-utils-download-ftp "&gnome-download-ftp;/gnome-doc-utils/0.20/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
9 | <!ENTITY gnome-doc-utils-md5sum "8f6e05071599bc073007830ea0a68391">
|
---|
10 | <!ENTITY gnome-doc-utils-size "700 KB">
|
---|
11 | <!ENTITY gnome-doc-utils-buildsize "19 MB">
|
---|
12 | <!ENTITY gnome-doc-utils-time "0.2 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
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
|
---|
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
|
---|
40 | <application>GNOME</application> packages require
|
---|
41 | <application>GNOME Doc Utils</application>.</para>
|
---|
42 |
|
---|
43 | &lfs70_built;
|
---|
44 |
|
---|
45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
46 | <itemizedlist spacing="compact">
|
---|
47 | <listitem>
|
---|
48 | <para>Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/></para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/></para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Download MD5 sum: &gnome-doc-utils-md5sum;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Download size: &gnome-doc-utils-size;</para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>Estimated disk space required: &gnome-doc-utils-buildsize;</para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>Estimated build time: &gnome-doc-utils-time;</para>
|
---|
64 | </listitem>
|
---|
65 | </itemizedlist>
|
---|
66 |
|
---|
67 | <bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
70 | <para role="required"><xref linkend="intltool"/>,
|
---|
71 | <xref linkend="libxslt"/>, and
|
---|
72 | <xref linkend="python2"/> ( Required to be installed prior to <xref linkend="libxml2"/>)</para>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
75 | <para role="recommended"><xref linkend="rarian"/></para>
|
---|
76 |
|
---|
77 | <para>The packages are listed as recommended even though
|
---|
78 | <application>GNOME Doc Utils</application> will build fine without them.
|
---|
79 | If you don't install the recommended packages (and you pass the appropriate
|
---|
80 | flags to the <command>configure</command> command so that it will build
|
---|
81 | without them), functionality will be missing that is expected later in
|
---|
82 | other GNOME packages.</para>
|
---|
83 |
|
---|
84 | <para condition="html" role="usernotes">User Notes:
|
---|
85 | <ulink url="&blfs-wiki;/gnome-doc-utils"/></para>
|
---|
86 |
|
---|
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/2001/XInclude"
|
---|
93 | href="../../xincludes/without-gnome.xml"/>
|
---|
94 |
|
---|
95 | <para>Install <application>GNOME Doc Utils</application>
|
---|
96 | by running the following commands:</para>
|
---|
97 |
|
---|
98 | <screen><userinput>./configure --prefix=$GNOME_PREFIX &&
|
---|
99 | make</userinput></screen>
|
---|
100 |
|
---|
101 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
102 |
|
---|
103 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
104 |
|
---|
105 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
106 |
|
---|
107 | </sect2>
|
---|
108 |
|
---|
109 | <sect2 role="commands">
|
---|
110 | <title>Command Explanations</title>
|
---|
111 |
|
---|
112 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
113 | href="../../xincludes/gnome-prefix.xml"/>
|
---|
114 |
|
---|
115 | </sect2>
|
---|
116 |
|
---|
117 | <sect2 role="content">
|
---|
118 | <title>Contents</title>
|
---|
119 |
|
---|
120 | <segmentedlist>
|
---|
121 | <segtitle>Installed Programs</segtitle>
|
---|
122 | <segtitle>Installed Libraries</segtitle>
|
---|
123 | <segtitle>Installed Directories</segtitle>
|
---|
124 | <segtitle>Installed Stylesheets</segtitle>
|
---|
125 |
|
---|
126 | <seglistitem>
|
---|
127 | <seg>gnome-doc-prepare, gnome-doc-tool and xml2po</seg>
|
---|
128 | <seg>None</seg>
|
---|
129 | <seg><envar>$GNOME_PREFIX</envar>/share/{gnome-doc-utils/{icons/hicolor/{48x48/status,
|
---|
130 | scalable/status},templates,watermarks},gnome/help/{gnome-doc-make/{C,
|
---|
131 | de},gnome-doc-xslt/{C,de}},omf/{gnome-doc-make,gnome-doc-xslt},
|
---|
132 | xml/{gnome/xslt/{common,docbook/{common,html,omf,utils},gettext,
|
---|
133 | mallard/{cache,common,html}},mallard/1.0}}
|
---|
134 | and /usr/lib/python2.7/site-packages/xml2po/</seg>
|
---|
135 | <seg>Custom DocBook XSLT stylesheets</seg>
|
---|
136 | </seglistitem>
|
---|
137 | </segmentedlist>
|
---|
138 |
|
---|
139 | <variablelist>
|
---|
140 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
141 | <?dbfo list-presentation="list"?>
|
---|
142 | <?dbhtml list-presentation="table"?>
|
---|
143 |
|
---|
144 | <varlistentry id="gnome-doc-prepare">
|
---|
145 | <term><command>gnome-doc-prepare</command></term>
|
---|
146 | <listitem>
|
---|
147 | <para>prepares a package to use
|
---|
148 | <application>gnome-doc-utils</application>.</para>
|
---|
149 | <indexterm zone="gnome-doc-utils gnome-doc-prepare">
|
---|
150 | <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
|
---|
151 | </indexterm>
|
---|
152 | </listitem>
|
---|
153 | </varlistentry>
|
---|
154 |
|
---|
155 | <varlistentry id="gnome-doc-tool">
|
---|
156 | <term><command>gnome-doc-tool</command></term>
|
---|
157 | <listitem>
|
---|
158 | <para>is used to convert documents to either HTML or XHTML.</para>
|
---|
159 | <indexterm zone="gnome-doc-utils gnome-doc-tool">
|
---|
160 | <primary sortas="b-gnome-doc-tool">gnome-doc-tool</primary>
|
---|
161 | </indexterm>
|
---|
162 | </listitem>
|
---|
163 | </varlistentry>
|
---|
164 |
|
---|
165 | <varlistentry id="xml2po">
|
---|
166 | <term><command>xml2po</command></term>
|
---|
167 | <listitem>
|
---|
168 | <para>is a <application>Python</application> script used to
|
---|
169 | translate XML documents.</para>
|
---|
170 | <indexterm zone="gnome-doc-utils xml2po">
|
---|
171 | <primary sortas="b-xml2po">xml2po</primary>
|
---|
172 | </indexterm>
|
---|
173 | </listitem>
|
---|
174 | </varlistentry>
|
---|
175 |
|
---|
176 | </variablelist>
|
---|
177 |
|
---|
178 | </sect2>
|
---|
179 |
|
---|
180 | </sect1>
|
---|