source: gnome/core/gnome-doc-utils.xml@ 551b9389

10.0 10.1 11.0 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 551b9389 was 551b9389, checked in by Randy McMurchy <randy@…>, 15 years ago

Minor fixes and clean-up to the core GNOME-2 package instructions including standardizing the text in the 'Command Explanations' section by using xinclude files and changing the creation of symbolic links to using PYTHONPATH so Python can find modules installed in non-standard locations

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6211 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 6.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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.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">
9 <!ENTITY gnome-doc-utils-md5sum "c706b807b15e07e58561f903c0f20c26">
10 <!ENTITY gnome-doc-utils-size "384 KB">
11 <!ENTITY gnome-doc-utils-buildsize "9.0 MB">
12 <!ENTITY gnome-doc-utils-time "less than 0.1 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 <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
67 <bridgehead renderas="sect4">Recommended</bridgehead>
68 <para role="required"><xref linkend="python"/> and
69 <xref linkend="scrollkeeper"/></para>
70
71 <para>The packages are listed as recommended even though
72 <application>GNOME Doc Utils</application> will build fine without them.
73 If you don't install the recommended packages (and you pass the appropriate
74 flags to the <command>configure</command> command so that it will build
75 without them), functionality will be missing that is expected later in
76 other GNOME packages.</para>
77
78 <bridgehead renderas="sect4">Optional</bridgehead>
79 <para role="optional"><xref linkend="pkgconfig"/></para>
80
81 <para condition="html" role="usernotes">User Notes:
82 <ulink url="&blfs-wiki;/gnome-doc-utils"/></para>
83
84 </sect2>
85
86 <sect2 role="installation">
87 <title>Installation of GNOME Doc Utils</title>
88
89 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
90 href="../without-gnome.xml"/>
91
92 <para>Install <application>GNOME Doc Utils</application>
93 by running the following commands:</para>
94
95<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
96 --mandir=$(pkg-config \
97 --variable=prefix ORBit-2.0)/share/man &amp;&amp;
98make</userinput></screen>
99
100 <para>To test the results, issue: <command>make check</command>.</para>
101
102 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
103
104<screen role="root"><userinput>make install</userinput></screen>
105
106 </sect2>
107
108 <sect2 role="commands">
109 <title>Command Explanations</title>
110
111 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
112 href="../gnome-prefix.xml"/>
113
114 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
115 href="../gnome-mandir.xml"/>
116
117 </sect2>
118
119 <sect2 role="content">
120 <title>Contents</title>
121
122 <segmentedlist>
123 <segtitle>Installed Programs</segtitle>
124 <segtitle>Installed Libraries</segtitle>
125 <segtitle>Installed Directories</segtitle>
126 <segtitle>Installed Stylesheets</segtitle>
127
128 <seglistitem>
129 <seg>gnome-doc-prepare and xml2po</seg>
130 <seg>None</seg>
131 <seg>The following subdirectories of
132 <envar>$GNOME_PREFIX</envar>/share/:
133 gnome-doc-utils,
134 gnome/help/gnome-doc-{make,xslt},
135 omf/gnome-doc-{make,xslt},
136 xml/gnome and
137 xml2po}</seg>
138 <seg>Custom DocBook XSLT stylesheets</seg>
139 </seglistitem>
140 </segmentedlist>
141
142 <variablelist>
143 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
144 <?dbfo list-presentation="list"?>
145 <?dbhtml list-presentation="table"?>
146
147 <varlistentry id="gnome-doc-prepare">
148 <term><command>gnome-doc-prepare</command></term>
149 <listitem>
150 <para>prepares a package to use
151 <application>gnome-doc-utils</application>.</para>
152 <indexterm zone="gnome-doc-utils gnome-doc-prepare">
153 <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
154 </indexterm>
155 </listitem>
156 </varlistentry>
157
158 <varlistentry id="xml2po">
159 <term><command>xml2po</command></term>
160 <listitem>
161 <para>is a <application>Python</application> script used to
162 translate XML documents.</para>
163 <indexterm zone="gnome-doc-utils xml2po">
164 <primary sortas="b-xml2po">xml2po</primary>
165 </indexterm>
166 </listitem>
167 </varlistentry>
168
169 </variablelist>
170
171 </sect2>
172
173</sect1>
Note: See TracBrowser for help on using the repository browser.