|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
Packit |
e4b6da |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
Packit |
e4b6da |
<head>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"text/html; charset=us-ascii" />
|
|
Packit |
e4b6da |
<title>docbook2X: Package installation</title>
|
|
Packit |
e4b6da |
<link rel="stylesheet" href="docbook2X.css" type="text/css" />
|
|
Packit |
e4b6da |
<link rev="made" href="mailto:stevecheng@users.sourceforge.net" />
|
|
Packit |
e4b6da |
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"Where to get docbook2X, and details on how to install it" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Documentation Table of Contents" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Documentation Table of Contents" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Design notes" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Dependencies on other software" />
|
|
Packit |
e4b6da |
</head>
|
|
Packit |
e4b6da |
<body>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Package installation
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"design-notes.html"><< Previous
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"dependencies.html">Next >>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Package
|
|
Packit |
e4b6da |
installation
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"install-procedure">Installation
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2545830" class="indexterm" name="id2545830">
|
|
Packit |
e4b6da |
After checking that you have the
|
|
Packit |
e4b6da |
title="docbook2X: Dependencies on other software">necessary
|
|
Packit |
e4b6da |
prerequisites, unpack the tarball, then run
|
|
Packit |
e4b6da |
"userinput">./configure , and then
|
|
Packit |
e4b6da |
make ,
|
|
Packit |
e4b6da |
make install , as
|
|
Packit |
e4b6da |
usual.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Note
|
|
Packit |
e4b6da |
If you
|
|
Packit |
e4b6da |
intend to use only the pure XSLT version of docbook2X, then you do
|
|
Packit |
e4b6da |
not need to compile or build the package at all. Simply unpack the
|
|
Packit |
e4b6da |
tarball, and point your XSLT processor to the XSLT stylesheets
|
|
Packit |
e4b6da |
under the xslt/ subdirectory.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
(The last make
|
|
Packit |
e4b6da |
install step, to install the files of the package
|
|
Packit |
e4b6da |
onto the filesystem, is optional. You may use docbook2X from its
|
|
Packit |
e4b6da |
own directory after building it, although in that case, when
|
|
Packit |
e4b6da |
invoking docbook2X, you will have to specify some paths manually on
|
|
Packit |
e4b6da |
the command-line.)
|
|
Packit |
e4b6da |
You may also want to run make
|
|
Packit |
e4b6da |
check to do some checks that the package is working
|
|
Packit |
e4b6da |
properly. Typing make -W
|
|
Packit |
e4b6da |
docbook2X.xml man texi in the
|
|
Packit |
e4b6da |
"filename">doc/ directory will rebuild docbook2X’s own
|
|
Packit |
e4b6da |
documentation, and can serve as an additional check.
|
|
Packit |
e4b6da |
You need GNU make to build docbook2X properly.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If you are using the CVS version, you will also need the
|
|
Packit |
e4b6da |
autoconf and automake tools, and must run
|
|
Packit |
e4b6da |
"userinput">./autogen.sh first. But see also
|
|
Packit |
e4b6da |
the note below about the CVS version.
|
|
Packit |
e4b6da |
If you
|
|
Packit |
e4b6da |
want to (re-)build HTML documentation (after having installed
|
|
Packit |
e4b6da |
Norman Walsh’s DocBook XSL stylesheets), pass
|
|
Packit |
e4b6da |
"option">--with-html-xsl to
|
|
Packit |
e4b6da |
"userinput">./configure . You do not really
|
|
Packit |
e4b6da |
need this, since docbook2X releases already contain pre-built HTML
|
|
Packit |
e4b6da |
documentation.
|
|
Packit |
e4b6da |
Some other packages also call their conversion programs
|
|
Packit |
e4b6da |
docbook2man and
|
|
Packit |
e4b6da |
docbook2texi; you can
|
|
Packit |
e4b6da |
use the --program-transform-name
|
|
Packit |
e4b6da |
parameter to
|
|
Packit |
e4b6da |
"userinput">./configure if you do not want
|
|
Packit |
e4b6da |
docbook2X to clobber over your existing
|
|
Packit |
e4b6da |
"command">docbook2man or
|
|
Packit |
e4b6da |
"command">docbook2texi.
|
|
Packit |
e4b6da |
If you are using a Java-based XSLT processor, you need to use
|
|
Packit |
e4b6da |
pass --with-xslt-processor=saxon for
|
|
Packit |
e4b6da |
SAXON, or --with-xslt-processor=xalan-j
|
|
Packit |
e4b6da |
for Xalan-Java. (The default is for libxslt.) In addition, since
|
|
Packit |
e4b6da |
the automatic check for the installed JARs is not very intelligent,
|
|
Packit |
e4b6da |
you will probably need to pass some options to
|
|
Packit |
e4b6da |
"userinput">./configure to tell it where the
|
|
Packit |
e4b6da |
JARs are. See ./configure
|
|
Packit |
e4b6da |
--help for details.
|
|
Packit |
e4b6da |
The docbook2X package supports VPATH builds (building in a
|
|
Packit |
e4b6da |
location other than the source directory), but any newly generated
|
|
Packit |
e4b6da |
documentation will not end up in the right place for installation
|
|
Packit |
e4b6da |
and redistribution. Cross compilation is not supported at all.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"install-problems">Installation problems
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Q: Where is
|
|
Packit |
e4b6da |
XML::Handler::SGMLSpl?
|
|
Packit |
e4b6da |
Q: db2x_xsltproc tells me that
|
|
Packit |
e4b6da |
one input document is required when building docbook2X.
|
|
Packit |
e4b6da |
Q: When docbook2X attempts to
|
|
Packit |
e4b6da |
build its documentation, I get errors about “attempting to
|
|
Packit |
e4b6da |
load network entity”, etc.
|
|
Packit |
e4b6da |
Q: I cannot build from
|
|
Packit |
e4b6da |
CVS.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2547311">
|
|
Packit |
e4b6da |
"id2547313">Q:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Where is
|
|
Packit |
e4b6da |
"classname">XML::Handler::SGMLSpl?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
A:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
It’s included in the docbook2X package. If Perl says it
|
|
Packit |
e4b6da |
cannot find it, then that is a bug in the docbook2X distribution.
|
|
Packit |
e4b6da |
Please report it.
|
|
Packit |
e4b6da |
In older versions of docbook2X, the SGMLSpl module had to be
|
|
Packit |
e4b6da |
installed, or specified manually on the Perl command line. That is
|
|
Packit |
e4b6da |
no longer the case.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2547342">
|
|
Packit |
e4b6da |
"id2547344">Q:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
db2x_xsltproc
|
|
Packit |
e4b6da |
tells me that “one input document is
|
|
Packit |
e4b6da |
required” when building docbook2X.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
A:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Use GNU make to build docbook2X (as opposed to BSD make).
|
|
Packit |
e4b6da |
I could fix this incompatibility in the docbook2X make files,
|
|
Packit |
e4b6da |
but some of the default automake rules have the same problem, so I
|
|
Packit |
e4b6da |
didn’t bother.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2547378">
|
|
Packit |
e4b6da |
"id2547380">Q:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
When docbook2X attempts to build its documentation, I get errors
|
|
Packit |
e4b6da |
about “attempting to load network entity”, etc.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
A:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
You will need to set up the XML catalogs for the DocBook XML
|
|
Packit |
e4b6da |
DTDs correctly. This tells the XSLT processor where to find the
|
|
Packit |
e4b6da |
DocBook DTDs on your system. Recent Linux distributions should
|
|
Packit |
e4b6da |
already have this done for you.
|
|
Packit |
e4b6da |
This error (or rather, warning) is harmless in the case of
|
|
Packit |
e4b6da |
docbook2X documentation — it does not actually require the
|
|
Packit |
e4b6da |
DTD to build. But your other DocBook documents might (mainly
|
|
Packit |
e4b6da |
because they use the ISO entities).
|
|
Packit |
e4b6da |
libxml also understands SGML catalogs, but last time I tried it
|
|
Packit |
e4b6da |
there was some bug that stopped it from working. Your Mileage May
|
|
Packit |
e4b6da |
Vary.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2547418">
|
|
Packit |
e4b6da |
"id2547420">Q:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
I cannot build from CVS.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
A:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If the problem is related to HTML files, then you must pass
|
|
Packit |
e4b6da |
--with-html-xsl to
|
|
Packit |
e4b6da |
"command">configure. The problem is that the HTML
|
|
Packit |
e4b6da |
files are automatically generated from the XML source and are not
|
|
Packit |
e4b6da |
in CVS, but the Makefile still tries to install them. (This issue
|
|
Packit |
e4b6da |
does not appear when building from release tarballs.)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
For other docbook2X problems, please also look at its main
|
|
Packit |
e4b6da |
documentation.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"design-notes.html"><< Previous
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"dependencies.html">Next >>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Design notes
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X.html">Table of Contents
|
|
Packit |
e4b6da |
Dependencies on
|
|
Packit |
e4b6da |
other software
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"http://docbook2x.sourceforge.net/" title=
|
|
Packit |
e4b6da |
"docbook2X: Home page">docbook2X home page
|
|
Packit |
e4b6da |
</body>
|
|
Packit |
e4b6da |
</html>
|