X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fbuilding%2Fbuilding.xml;h=3affc087ab5df3620053ad25d1cb4456ae6b0bb3;hb=31b36891326ccace3f9d7d29ae036628069ce7da;hp=32a4f9de88530e2a2866432d749962edc0e9657d;hpb=b6bdc1892e0759f1f3bbbc7e162b57fd12f95dd6;p=ghc-hetmet.git
diff --git a/docs/building/building.xml b/docs/building/building.xml
index 32a4f9d..3affc08 100644
--- a/docs/building/building.xml
+++ b/docs/building/building.xml
@@ -1445,8 +1445,8 @@ $ cvs checkout nofib/spectral
Quick Start
If you are starting from a source distribution, and just
- want a completely standard build, then the following should
- work:
+ want a completely standard build, then the following procedure should
+ work (unless you're on Windows, in which case go to ).
$ autoreconf
$ ./configure
@@ -3345,9 +3345,8 @@ directive.
DocBook, pre-supposed
- Much of our documentation is written in SGML, using
- the DocBook DTD. Instructions on installing and
- configuring the DocBook tools are below.
+ Much of our documentation is written in DocBook XML, instructions
+ on installing and configuring the DocBook tools are below.
@@ -3387,27 +3386,21 @@ directive.
Installing the DocBook tools on Linux
- If you're on a recent RedHat system (7.0+), you probably
- have working DocBook tools already installed. The configure
- script should detect your setup and you're away.
+ If you're on a recent RedHat (7.0+) or SuSE (8.1+) system,
+ you probably have working DocBook tools already installed. The
+ configure script should detect your setup and you're away.
If you don't have DocBook tools installed, and you are
- using a system that can handle RedHat RPM packages, you can
- probably use the Cygnus
- DocBook tools, which is the most shrink-wrapped SGML
- suite that we could find. You need all the RPMs except for
- psgml (i.e. docbook,
- jade, jadetex,
- sgmlcommon and
- stylesheets). Note that most of these
- RPMs are architecture neutral, so are likely to be found in a
- noarch directory. The SuSE RPMs also
- work; the RedHat ones don't in RedHat 6.2
- (7.0 and later should be OK), but they are easy to fix: just
- make a symlink from
- /usr/lib/sgml/stylesheets/nwalsh-modular/lib/dblib.dsl
- to /usr/lib/sgml/lib/dblib.dsl.
+ using a system that can handle RPM packages, you can use Rpmfind.net to find suitable
+ packages for your system. Search for the packages
+ docbook-dtd,
+ docbook-xsl-stylesheets,
+ libxslt,
+ libxml2,
+ fop,
+ xmltex, and
+ dvips.
@@ -3429,77 +3422,24 @@ $ make install
Installing from binaries on Windows
- It's a good idea to use Norman Walsh's installation
- notes as a guide. You should get version 3.1 of
- DocBook, and note that his file test.sgm
- won't work, as it needs version 3.0. You should unpack Jade
- into \Jade, along with the entities,
- DocBook into \docbook, and the DocBook
- stylesheets into \docbook\stylesheets (so
- they actually end up in
- \docbook\stylesheets\docbook).
+ Probably the fastest route to a working DocBook environment on
+ Windows is to install Cygwin
+ with the complete Doc category. If you are using
+ MinGW for compilation, you
+ have to help configure a little bit: Set the
+ environment variables XmllintCmd and
+ XsltprocCmd to the paths of the Cygwin executables
+ xmllint and xsltproc,
+ respectively, and set fp_cv_dir_docbook_xsl to the path
+ of the directory where the XSL stylesheets are installed,
+ e.g. c:/cygwin/usr/share/docbook-xsl.
+
+
+ If you want to build HTML Help, you have to install the
+ HTML Help SDK,
+ too, and make sure that hhc is in your PATH.
-
-
- Installing the DocBook tools from source
-
-
- Jade
-
- Install OpenJade
- (Windows binaries are available as well as sources). If you
- want DVI, PS, or PDF then install JadeTeX from the
- dsssl subdirectory. (If you get the
- error:
-
-! LaTeX Error: Unknown option implicit=false' for package hyperref'.
-
- your version of hyperref is out of date;
- download it from CTAN
- (macros/latex/contrib/supported/hyperref),
- and make it, ensuring that you have first removed or renamed
- your old copy. If you start getting file not found errors
- when making the test for hyperref, you
- can abort at that point and proceed straight to
- make install, or enter them as
- ../filename.)
-
- Make links from virtex to
- jadetex and
- pdfvirtex to
- pdfjadetex (otherwise DVI, PostScript
- and PDF output will not work). Copy
- dsssl/*.{dtd,dsl} and
- catalog to
- /usr/[local/]lib/sgml.
-
-
-
- DocBook and the DocBook stylesheets
-
- Get a Zip of DocBook
- and install the contents in
- /usr/[local/]/lib/sgml.
-
- Get the DocBook
- stylesheets and install in
- /usr/[local/]lib/sgml/stylesheets
- (thereby creating a subdirectory docbook). For indexing,
- copy or link collateindex.pl from the
- DocBook stylesheets archive in bin into
- a directory on your PATH.
-
- Download the ISO
- entities into
- /usr/[local/]lib/sgml.
-
-
@@ -3512,20 +3452,6 @@ $ make install
- Remaining problems
-
- If you install from source, you'll get a pile of warnings
- of the form
-
-DTDDECL catalog entries are not supported
-
- every time you build anything. These can safely be ignored, but
- if you find them tedious you can get rid of them by removing all
- the DTDDECL entries from
- docbook.cat.
-
-
-
Building the documentation
To build documentation in a certain format, you can
@@ -3548,11 +3474,11 @@ $ make install
Because there are many different formats that the DocBook
documentation can be generated in, you have to select which ones
- you want by setting the SGMLDocWays variable
+ you want by setting the XMLDocWays variable
to a list of them. For example, in
build.mk you might have a line:
-SGMLDocWays = html ps
+XMLDocWays = html ps
This will cause the documentation to be built in the requested
formats as part of the main build (the default is not to build
@@ -3572,9 +3498,9 @@ $ make install
documentation, which goes into
$(datadir)/html, to keep things tidy.
- Note that unless you set $(SGMLDocWays)
+ Note that unless you set $(XMLDocWays)
to a list of formats, the install-docs target
- won't do anything for SGML documentation.
+ won't do anything for DocBook XML documentation.