From 3907bc8a1577a969c3801ee44b8c21e138f41fad Mon Sep 17 00:00:00 2001 From: rrt Date: Fri, 19 May 2000 14:21:24 +0000 Subject: [PATCH] [project @ 2000-05-19 14:21:24 by rrt] Improved DocBook instructions and added a special section for Windows. --- ghc/docs/users_guide/installing.sgml | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) diff --git a/ghc/docs/users_guide/installing.sgml b/ghc/docs/users_guide/installing.sgml index 9603188..863bef6 100644 --- a/ghc/docs/users_guide/installing.sgml +++ b/ghc/docs/users_guide/installing.sgml @@ -1033,10 +1033,8 @@ of perl instead, a cygwin port We use the DocBook DTD, which is widely used; however, shrink-wrapped distributions of DocBook are few and far between, and getting it to work out -of the box can be tricky. There are currently two supported ways of using -DocBook: installing from sources yourself, and the Cygnus DocBook tools. -Neither is ideal: installing by yourself is tricky, while the Cygnus tools -are idiosyncratic, slightly broken, and only available as RedHat RPMs +of the box can be tricky. There are currently three supported ways of using +DocBook: installing from sources yourself, various flavours of RPM installation, and installing binaries on Windows (with some care). @@ -1056,25 +1054,27 @@ find. You need all the RPMs except for psgml (i.e. jadetex, sgmlcommon and stylesheets). Note that most of these RPMs are architecture neutral, so are likely to be found in a -noarch directory. N.B. The Cygnus -version of the tools is assumed. Others, such as the SuSE version, may not -work. +noarch directory. The SuSE RPMs also work; the RedHat ones don't at the moment. + -Installing the DocBook tools from source +Installing from binaries on Windows -Especially if you're working in Windows, you may find Norman Walsh's installation -notes a better way to install DocBook tools. You should get version +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. +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). + +Installing the DocBook tools from source + Jade @@ -1134,14 +1134,8 @@ entities into /usr/[local/]lib/sgml. Configuring the DocBook tools -The supported way to do this is to edit one of the -CATALOG files in -fptools/glafp-utils/docbook to suit your system. -CATALOG.generic should work on most Unix systems when the files have been installed as per these instructions; CATALOG.cygnus is for systems with the Cygnus DocBook tools. You need to edit all the paths so they match your system. The edited file should be called CATALOG, and placed in the same directory. - - - -Alternatively, if you have a properly working DocBook toolset (the FreeBSD package is likely to be one such), set SGML_CATALOG_FILES to point to the catalog in a pre-installed working system (even if it doesn't normally). The build system will complain if there's no CATALOG in glafp-utils/docbook and SGML_CATALOG_FILES is unset. +You should either edit one of the CATALOG files in +fptools/glafp-utils/docbook to suit your system, or set SGML_CATALOG_FILES to point to a valid catalog. SuSE systems should work out of the box. CATALOG.generic should work on most Unix systems when the files have been installed as per these instructions; CATALOG.cygnus is for systems with the Cygnus DocBook tools. CATALOG.windows is for Windows systems following the special instructions for that special OS. You may need to edit the paths so they match your system. The edited file should be called CATALOG, and placed in the same directory. -- 1.7.10.4