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 "http://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/0.2/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
8 | <!ENTITY gnome-doc-utils-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/0.2/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
---|
9 | <!ENTITY gnome-doc-utils-md5sum "c72f2a974e4f05210d2736e92399c58e">
|
---|
10 | <!ENTITY gnome-doc-utils-size "285 KB">
|
---|
11 | <!ENTITY gnome-doc-utils-buildsize "5 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> will
|
---|
38 | require <application>GNOME Doc Utils</application> for the XSLT.</para>
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/></para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download MD5 sum: &gnome-doc-utils-md5sum;</para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download size: &gnome-doc-utils-size;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Estimated disk space required: &gnome-doc-utils-buildsize;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated build time: &gnome-doc-utils-time;</para>
|
---|
59 | </listitem>
|
---|
60 | </itemizedlist>
|
---|
61 |
|
---|
62 | <bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead>
|
---|
63 |
|
---|
64 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
65 | <para><xref linkend="scrollkeeper"/></para>
|
---|
66 |
|
---|
67 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
68 | <para><xref linkend="pkgconfig"/> and <xref linkend="python"/></para>
|
---|
69 |
|
---|
70 | </sect2>
|
---|
71 |
|
---|
72 | <sect2 role="installation">
|
---|
73 | <title>Installation of GNOME Doc Utils</title>
|
---|
74 |
|
---|
75 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
76 | href="../without-gnome.xml"/>
|
---|
77 |
|
---|
78 | <para>Install <application>GNOME Doc Utils</application>
|
---|
79 | by running the following commands:</para>
|
---|
80 |
|
---|
81 | <screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
|
---|
82 | --localstatedir=/var/lib &&
|
---|
83 | make</userinput></screen>
|
---|
84 |
|
---|
85 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
86 |
|
---|
87 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
88 |
|
---|
89 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
90 |
|
---|
91 | </sect2>
|
---|
92 |
|
---|
93 | <sect2 role="commands">
|
---|
94 | <title>Command Explanations</title>
|
---|
95 |
|
---|
96 | <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
|
---|
97 | <application>ScrollKeeper</application> files in
|
---|
98 | <filename class='directory'>/var/lib/scrollkeeper</filename> instead of
|
---|
99 | <filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>
|
---|
100 |
|
---|
101 | </sect2>
|
---|
102 |
|
---|
103 | <sect2 role="content">
|
---|
104 | <title>Contents</title>
|
---|
105 |
|
---|
106 | <segmentedlist>
|
---|
107 | <segtitle>Installed Programs</segtitle>
|
---|
108 | <segtitle>Installed Libraries</segtitle>
|
---|
109 | <segtitle>Installed Directories</segtitle>
|
---|
110 | <segtitle>Installed Stylesheets</segtitle>
|
---|
111 |
|
---|
112 | <seglistitem>
|
---|
113 | <seg>gnome-doc-prepare and xml2po</seg>
|
---|
114 | <seg>None</seg>
|
---|
115 | <seg>$GNOME_PREFIX/share/gnome-doc-utils,
|
---|
116 | $GNOME_PREFIX/share/gnome/help/gnome-doc-make,
|
---|
117 | $GNOME_PREFIX/share/gnome/help/gnome-doc-xslt,
|
---|
118 | $GNOME_PREFIX/share/omf/gnome-doc-make,
|
---|
119 | $GNOME_PREFIX/share/omf/gnome-doc-xslt,
|
---|
120 | $GNOME_PREFIX/share/xml/gnome and
|
---|
121 | $GNOME_PREFIX/share/xml2po</seg>
|
---|
122 | <seg>Custom DocBook XSLT stylesheets used by Yelp</seg>
|
---|
123 | </seglistitem>
|
---|
124 | </segmentedlist>
|
---|
125 |
|
---|
126 | <variablelist>
|
---|
127 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
128 | <?dbfo list-presentation="list"?>
|
---|
129 | <?dbhtml list-presentation="table"?>
|
---|
130 |
|
---|
131 | <varlistentry id="gnome-doc-prepare">
|
---|
132 | <term><command>gnome-doc-prepare</command></term>
|
---|
133 | <listitem>
|
---|
134 | <para>prepares a package to use
|
---|
135 | <application>gnome-doc-utils</application>.</para>
|
---|
136 | <indexterm zone="gnome-doc-utils gnome-doc-prepare">
|
---|
137 | <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
|
---|
138 | </indexterm>
|
---|
139 | </listitem>
|
---|
140 | </varlistentry>
|
---|
141 |
|
---|
142 | <varlistentry id="xml2po">
|
---|
143 | <term><command>xml2po</command></term>
|
---|
144 | <listitem>
|
---|
145 | <para>is a <application>Python</application> script used to
|
---|
146 | translate XML documents.</para>
|
---|
147 | <indexterm zone="gnome-doc-utils xml2po">
|
---|
148 | <primary sortas="b-xml2po">xml2po</primary>
|
---|
149 | </indexterm>
|
---|
150 | </listitem>
|
---|
151 | </varlistentry>
|
---|
152 |
|
---|
153 | </variablelist>
|
---|
154 |
|
---|
155 | </sect2>
|
---|
156 |
|
---|
157 | </sect1>
|
---|