mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-27 09:42:12 +08:00
e155d07a8e
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6270 af4574ff-66df-0310-9fd7-8a98e5e911e0
177 lines
6.3 KiB
XML
177 lines
6.3 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../../general.ent">
|
|
%general-entities;
|
|
|
|
<!ENTITY gnome-doc-utils-download-http "&gnome-download-http;/gnome-doc-utils/0.6/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
|
<!ENTITY gnome-doc-utils-download-ftp "&gnome-download-ftp;/gnome-doc-utils/0.6/gnome-doc-utils-&gnome-doc-utils-version;.tar.bz2">
|
|
<!ENTITY gnome-doc-utils-md5sum "c706b807b15e07e58561f903c0f20c26">
|
|
<!ENTITY gnome-doc-utils-size "384 KB">
|
|
<!ENTITY gnome-doc-utils-buildsize "9.0 MB">
|
|
<!ENTITY gnome-doc-utils-time "less than 0.1 SBU">
|
|
]>
|
|
|
|
<sect1 id="gnome-doc-utils" xreflabel="GNOME Doc Utils-&gnome-doc-utils-version;">
|
|
<?dbhtml filename="gnome-doc-utils.html"?>
|
|
|
|
<sect1info>
|
|
<othername>$LastChangedBy$</othername>
|
|
<date>$Date$</date>
|
|
</sect1info>
|
|
|
|
<title>GNOME Doc Utils-&gnome-doc-utils-version;</title>
|
|
|
|
<indexterm zone="gnome-doc-utils">
|
|
<primary sortas="a-GNOME-Doc-Utils">GNOME Doc Utils</primary>
|
|
</indexterm>
|
|
|
|
<sect2 role="package">
|
|
<title>Introduction to GNOME Doc Utils</title>
|
|
|
|
<para>The <application>GNOME Doc Utils</application> package is a collection
|
|
of documentation utilities for the <application>GNOME</application> project.
|
|
Notably, it contains utilities for building documentation and all auxiliary
|
|
files in your source tree, and it contains the DocBook XSLT stylesheets that
|
|
were once distributed with <application>Yelp</application>. Starting with
|
|
<application>GNOME</application> 2.8, <application>Yelp</application>
|
|
requires <application>GNOME Doc Utils</application> for the XSLT. Starting
|
|
with <application>GNOME</application> 2.12, many of the core
|
|
<application>GNOME</application> packages require
|
|
<application>GNOME Doc Utils</application>.</para>
|
|
|
|
<bridgehead renderas="sect3">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download MD5 sum: &gnome-doc-utils-md5sum;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download size: &gnome-doc-utils-size;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated disk space required: &gnome-doc-utils-buildsize;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated build time: &gnome-doc-utils-time;</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect4">Required</bridgehead>
|
|
<para role="required"><xref linkend="libxslt"/></para>
|
|
|
|
<bridgehead renderas="sect4">Recommended</bridgehead>
|
|
<para role="required"><xref linkend="python"/> and
|
|
<xref linkend="scrollkeeper"/></para>
|
|
|
|
<para>The packages are listed as recommended even though
|
|
<application>GNOME Doc Utils</application> will build fine without them.
|
|
If you don't install the recommended packages (and you pass the appropriate
|
|
flags to the <command>configure</command> command so that it will build
|
|
without them), functionality will be missing that is expected later in
|
|
other GNOME packages.</para>
|
|
|
|
<bridgehead renderas="sect4">Optional</bridgehead>
|
|
<para role="optional"><xref linkend="pkgconfig"/></para>
|
|
|
|
<para condition="html" role="usernotes">User Notes:
|
|
<ulink url="&blfs-wiki;/gnome-doc-utils"/></para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of GNOME Doc Utils</title>
|
|
|
|
<xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
|
href="../../xincludes/without-gnome.xml"/>
|
|
|
|
<para>Install <application>GNOME Doc Utils</application>
|
|
by running the following commands:</para>
|
|
|
|
<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
|
|
--mandir=$(pkg-config \
|
|
--variable=prefix ORBit-2.0)/share/man &&
|
|
make</userinput></screen>
|
|
|
|
<para>To test the results, issue: <command>make check</command>.</para>
|
|
|
|
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|
|
|
<screen role="root"><userinput>make install</userinput></screen>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="commands">
|
|
<title>Command Explanations</title>
|
|
|
|
<xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
|
href="../../xincludes/gnome-prefix.xml"/>
|
|
|
|
<xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
|
href="../../xincludes/gnome-mandir.xml"/>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Libraries</segtitle>
|
|
<segtitle>Installed Directories</segtitle>
|
|
<segtitle>Installed Stylesheets</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>gnome-doc-prepare and xml2po</seg>
|
|
<seg>None</seg>
|
|
<seg>The following subdirectories of
|
|
<envar>$GNOME_PREFIX</envar>/share/:
|
|
gnome-doc-utils,
|
|
gnome/help/gnome-doc-{make,xslt},
|
|
omf/gnome-doc-{make,xslt},
|
|
xml/gnome and
|
|
xml2po}</seg>
|
|
<seg>Custom DocBook XSLT stylesheets</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="gnome-doc-prepare">
|
|
<term><command>gnome-doc-prepare</command></term>
|
|
<listitem>
|
|
<para>prepares a package to use
|
|
<application>gnome-doc-utils</application>.</para>
|
|
<indexterm zone="gnome-doc-utils gnome-doc-prepare">
|
|
<primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="xml2po">
|
|
<term><command>xml2po</command></term>
|
|
<listitem>
|
|
<para>is a <application>Python</application> script used to
|
|
translate XML documents.</para>
|
|
<indexterm zone="gnome-doc-utils xml2po">
|
|
<primary sortas="b-xml2po">xml2po</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|