source: gnome/core/gnome-doc-utils.xml@ 9761bea4

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 9761bea4 was 9761bea4, checked in by Randy McMurchy <randy@…>, 15 years ago

Various corrections to the GNOME2 instructions

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

  • Property mode set to 100644
File size: 5.8 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 because if they are not
72 installed (and the proper switches are passed to the
73 <command>configure</command> command), functionality will be missing that
74 is expected later in other GNOME packages.</para>
75
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional"><xref linkend="pkgconfig"/></para>
78
79 <para condition="html" role="usernotes">User Notes:
80 <ulink url="&blfs-wiki;/gnome-doc-utils"/></para>
81
82 </sect2>
83
84 <sect2 role="installation">
85 <title>Installation of GNOME Doc Utils</title>
86
87 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
88 href="../without-gnome.xml"/>
89
90 <para>Install <application>GNOME Doc Utils</application>
91 by running the following commands:</para>
92
93<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
94 --mandir=$(pkg-config \
95 --variable=prefix ORBit-2.0)/share/man &amp;&amp;
96make</userinput></screen>
97
98 <para>To test the results, issue: <command>make check</command>.</para>
99
100 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
101
102<screen role="root"><userinput>make install</userinput></screen>
103
104 </sect2>
105
106 <sect2 role="content">
107 <title>Contents</title>
108
109 <segmentedlist>
110 <segtitle>Installed Programs</segtitle>
111 <segtitle>Installed Libraries</segtitle>
112 <segtitle>Installed Directories</segtitle>
113 <segtitle>Installed Stylesheets</segtitle>
114
115 <seglistitem>
116 <seg>gnome-doc-prepare and xml2po</seg>
117 <seg>None</seg>
118 <seg>The following subdirectories of $GNOME_PREFIX/share/:
119 gnome-doc-utils,
120 gnome/help/gnome-doc-{make,xslt},
121 omf/gnome-doc-{make,xslt},
122 xml/gnome and
123 xml2po}</seg>
124 <seg>Custom DocBook XSLT stylesheets</seg>
125 </seglistitem>
126 </segmentedlist>
127
128 <variablelist>
129 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
130 <?dbfo list-presentation="list"?>
131 <?dbhtml list-presentation="table"?>
132
133 <varlistentry id="gnome-doc-prepare">
134 <term><command>gnome-doc-prepare</command></term>
135 <listitem>
136 <para>prepares a package to use
137 <application>gnome-doc-utils</application>.</para>
138 <indexterm zone="gnome-doc-utils gnome-doc-prepare">
139 <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
140 </indexterm>
141 </listitem>
142 </varlistentry>
143
144 <varlistentry id="xml2po">
145 <term><command>xml2po</command></term>
146 <listitem>
147 <para>is a <application>Python</application> script used to
148 translate XML documents.</para>
149 <indexterm zone="gnome-doc-utils xml2po">
150 <primary sortas="b-xml2po">xml2po</primary>
151 </indexterm>
152 </listitem>
153 </varlistentry>
154
155 </variablelist>
156
157 </sect2>
158
159</sect1>
Note: See TracBrowser for help on using the repository browser.