1 <Chapter id="sec-installing-bin-distrib">
2 <Title>Installing from binary distributions</Title>
3 <IndexTerm><Primary>binary installations</Primary></IndexTerm>
4 <IndexTerm><Primary>installation, of binaries</Primary></IndexTerm>
7 Installing from binary distributions is easiest, and recommended!
8 (Why binaries? Because GHC is a Haskell compiler written in Haskell,
9 so you've got to bootstrap it somehow. We provide
10 machine-generated C-files-from-Haskell for this purpose, but it's
11 really quite a pain to use them. If you must build GHC from its
12 sources, using a binary-distributed GHC to do so is a sensible way to
13 proceed. For the other <Literal>fptools</Literal> programs, many are written in Haskell, so binary distributions allow you to install them without having a Haskell compiler.)
16 <Para>This guide is in two parts: installing on Unix-a-likes, and installing on Windows.</Para>
19 <Sect1><Title>Installing on Unix-a-likes</Title>
22 <Title>Bundle structure</Title>
25 <IndexTerm><Primary>bundles of binary stuff</Primary></IndexTerm>
29 Binary distributions come in “bundles,” one bundle per file called
30 <Literal><bundle>-<platform>.tar.gz</Literal>. (See the building guide for the definition of a platform.) Suppose that you untar a binary-distribution bundle, thus:
36 % cd /your/scratch/space
37 % gunzip < ghc-x.xx-sun-sparc-solaris2.tar.gz | tar xvf -</Screen>
42 Then you should find a single directory, <Literal>fptools</Literal>, with the following
47 <IndexTerm><Primary>binary distribution, layout</Primary></IndexTerm>
48 <IndexTerm><Primary>directory layout (binary distributions)</Primary></IndexTerm>
52 <Term><Literal>Makefile.in</Literal></Term>
55 the raw material from which the <Literal>Makefile</Literal>
56 will be made (<Xref LinkEnd="sec-install">).
58 </ListItem></VarListEntry>
60 <Term><Literal>configure</Literal></Term>
63 the configuration script (<Xref LinkEnd="sec-install">).
65 </ListItem></VarListEntry>
67 <Term><Literal>README</Literal></Term>
70 Contains this file summary.
72 </ListItem></VarListEntry>
74 <Term><Literal>INSTALL</Literal></Term>
77 Contains this description of how to install
80 </ListItem></VarListEntry>
82 <Term><Literal>ANNOUNCE</Literal></Term>
85 The announcement message for the bundle.
87 </ListItem></VarListEntry>
89 <Term><Literal>NEWS</Literal></Term>
92 release notes for the bundle—a longer version
93 of <Literal>ANNOUNCE</Literal>. For GHC, the release notes are contained in the User
94 Guide and this file isn't present.
96 </ListItem></VarListEntry>
98 <Term><Literal>bin/<platform></Literal></Term>
101 contains platform-specific executable
102 files to be invoked directly by the user. These are the files that
103 must end up in your path.
105 </ListItem></VarListEntry>
107 <Term><Literal>lib/<platform>/</Literal></Term>
110 contains platform-specific support
111 files for the installation. Typically there is a subdirectory for
112 each <Literal>fptools</Literal> project, whose name is the name of the project with its
113 version number. For example, for GHC there would be a sub-directory
114 <Literal>ghc-x.xx</Literal>/ where <Literal>x.xx</Literal> is the version number of GHC in the bundle.
118 These sub-directories have the following general structure:
125 <Term><Literal>libHSstd.a</Literal> etc:</Term>
128 supporting library archives.
130 </ListItem></VarListEntry>
132 <Term><Literal>ghc-iface.prl</Literal> etc:</Term>
137 </ListItem></VarListEntry>
139 <Term><Literal>import/</Literal></Term>
142 <IndexTerm><Primary>Interface files</Primary></IndexTerm> (<Literal>.hi</Literal>) for the prelude.
144 </ListItem></VarListEntry>
146 <Term><Literal>include/</Literal></Term>
149 A few C <Literal>#include</Literal> files.
151 </ListItem></VarListEntry>
154 </ListItem></VarListEntry>
156 <Term><Literal>share/</Literal></Term>
159 contains platform-independent support files
160 for the installation. Again, there is a sub-directory for each
161 <Literal>fptools</Literal> project.
163 </ListItem></VarListEntry>
165 <Term><Literal>html/</Literal></Term>
168 contains HTML documentation files (one
169 sub-directory per project).
171 </ListItem></VarListEntry>
173 <Term><Literal>man/</Literal></Term>
176 contains Unix manual pages.
178 </ListItem></VarListEntry>
183 This structure is designed so that you can unpack multiple bundles
184 (including ones from different releases or platforms) into a single
185 <Literal>fptools</Literal> directory
189 this doesn't work at the
200 % cd /your/scratch/space
201 % gunzip < ghc-x.xx-sun-sparc-solaris2.tar.gz | tar xvf -
202 % gunzip < happy-x.xx-sun-sparc-sunos4.tar.gz | tar xvf -</Screen>
207 When you do multiple unpacks like this, the top level <Literal>Makefile</Literal>,
208 <Literal>README</Literal>, and <Literal>INSTALL</Literal> get overwritten each time.
209 That's fine—they should be the same. Likewise, the
210 <Literal>ANNOUNCE-<bundle></Literal> and <Literal>NEWS-<bundle></Literal>
211 files will be duplicated across multiple platforms, so they will be
212 harmlessly overwritten when you do multiple unpacks. Finally, the
213 <Literal>share/</Literal> stuff will get harmlessly overwritten when you do
214 multiple unpacks for one bundle on different platforms.
217 <Sect3 id="sec-install">
218 <Title>Installing</Title>
221 OK, so let's assume that you have unpacked your chosen bundles into a
222 scratch directory <Literal>fptools</Literal>. What next? Well, you will at least need
223 to run the <Literal>configure</Literal><IndexTerm><Primary>configure</Primary></IndexTerm> script by changing your
224 directory to <Literal>fptools</Literal> and typing <Literal>./configure</Literal>. That should convert
225 <Literal>Makefile.in</Literal> to <Literal>Makefile</Literal>.
229 <IndexTerm><Primary>installing in-place</Primary></IndexTerm>
230 <IndexTerm><Primary>in-place installation</Primary></IndexTerm>
231 You can now either start using the tools <Emphasis>in-situ</Emphasis> without going
232 through any installation process, just type <Literal>make in-place</Literal> to set the
233 tools up for this. You'll also want to add the path which <Literal>make</Literal> will
234 now echo to your <Literal>PATH</Literal> environment variable. This option is useful if
235 you simply want to try out the package and/or you don't have the
236 necessary privileges (or inclination) to properly install the tools
237 locally. Note that if you do decide to install the package `properly'
238 at a later date, you have to go through the installation steps that
243 To install an <Literal>fptools</Literal> package, you'll have to do the following:
252 Edit the <Literal>Makefile</Literal> and check the settings of the following variables:
254 <IndexTerm><Primary>directories, installation</Primary></IndexTerm>
255 <IndexTerm><Primary>installation directories</Primary></IndexTerm>
260 <Term><Literal>platform</Literal></Term>
263 the platform you are going to install for.
265 </ListItem></VarListEntry>
267 <Term><Literal>bindir</Literal></Term>
270 the directory in which to install user-invokable
273 </ListItem></VarListEntry>
275 <Term><Literal>libdir</Literal></Term>
278 the directory in which to install
279 platform-dependent support files.
281 </ListItem></VarListEntry>
283 <Term><Literal>datadir</Literal></Term>
286 the directory in which to install
287 platform-independent support files.
289 </ListItem></VarListEntry>
291 <Term><Literal>infodir</Literal></Term>
294 the directory in which to install Emacs info
297 </ListItem></VarListEntry>
299 <Term><Literal>htmldir</Literal></Term>
302 the directory in which to install HTML
305 </ListItem></VarListEntry>
307 <Term><Literal>dvidir</Literal></Term>
310 the directory in which to install DVI
313 </ListItem></VarListEntry>
316 The values for these variables can be set through invocation of the
317 <Command>configure</Command><IndexTerm><Primary>configure</Primary></IndexTerm>
318 script that comes with the distribution, but doing an optical diff to
319 see if the values match your expectations is always a Good Idea.
323 <Emphasis>Instead of running <Command>configure</Command>, it is
324 perfectly OK to copy <Filename>Makefile.in</Filename> to
325 <Filename>Makefile</Filename> and set all these variables directly
326 yourself. But do it right!</Emphasis>
333 Run <Literal>make install</Literal>. This <Emphasis>
334 should</Emphasis> work with ordinary Unix
335 <Literal>make</Literal>—no need for fancy stuff like GNU
336 <Literal>make</Literal>.
343 <Literal>rehash</Literal> (t?csh or zsh users), so your shell will see the new
344 stuff in your bin directory.
351 Once done, test your “installation” as suggested in
352 <XRef LinkEnd="sec-GHC-test">. Be sure to use a <Literal>-v</Literal>
353 option, so you can see exactly what pathnames it's using.
355 If things don't work as expected, check the list of known pitfalls in
365 <IndexTerm><Primary>link, installed as ghc</Primary></IndexTerm>
366 When installing the user-invokable binaries, this installation
367 procedure will install GHC as <Literal>ghc-x.xx</Literal> where <Literal>x.xx</Literal> is the version
368 number of GHC. It will also make a link (in the binary installation
369 directory) from <Literal>ghc</Literal> to <Literal>ghc-x.xx</Literal>. If you install multiple versions
370 of GHC then the last one “wins”, and “<Literal>ghc</Literal>” will invoke the last
371 one installed. You can change this manually if you want. But
372 regardless, <Literal>ghc-x.xx</Literal> should always invoke GHC version <Literal>x.xx</Literal>.
379 <Title>What bundles there are</Title>
382 <IndexTerm><Primary>bundles, binary</Primary></IndexTerm>
383 There are plenty of “non-basic” GHC bundles. The files for them are
384 called <Literal>ghc-x.xx-<bundle>-<platform>.tar.gz</Literal>, where
385 the <Literal><platform></Literal> is as above, and <Literal><bundle></Literal> is one
393 <Term><Literal>prof</Literal>:</Term>
396 Profiling with cost-centres. You probably want this.
397 <IndexTerm><Primary>profiling bundles</Primary></IndexTerm>
398 <IndexTerm><Primary>bundles, profiling</Primary></IndexTerm>
400 </ListItem></VarListEntry>
402 <Term><Literal>par</Literal>:</Term>
405 Parallel Haskell features (sits on top of PVM).
406 You'll want this if you're into that kind of thing.
407 <IndexTerm><Primary>parallel bundles</Primary></IndexTerm>
408 <IndexTerm><Primary>bundles, parallel</Primary></IndexTerm>
410 </ListItem></VarListEntry>
412 <Term><Literal>gran</Literal>:</Term>
415 The “GranSim” parallel-Haskell simulator
416 (hmm… mainly for implementors).
417 <IndexTerm><Primary>bundles, gransim</Primary></IndexTerm>
418 <IndexTerm><Primary>gransim bundles</Primary></IndexTerm>
420 </ListItem></VarListEntry>
422 <Term><Literal>ticky</Literal>:</Term>
425 “Ticky-ticky” profiling; very detailed
426 information about “what happened when I ran this program”—really
428 <IndexTerm><Primary>bundles, ticky-ticky</Primary></IndexTerm>
429 <IndexTerm><Primary>ticky-ticky bundles</Primary></IndexTerm>
431 </ListItem></VarListEntry>
436 One likely scenario is that you will grab <Emphasis>two</Emphasis>
437 binary bundles—basic, and profiling. We don't usually make the
438 rest, although you can build them yourself from a source distribution.
443 <Sect3 id="sec-GHC-test">
444 <Title>Testing that GHC seems to be working
448 <IndexTerm><Primary>testing a new GHC</Primary></IndexTerm>
452 The way to do this is, of course, to compile and run <Emphasis>this</Emphasis> program
453 (in a file <Literal>Main.hs</Literal>):
459 main = putStr "Hello, world!\n"
465 Compile the program, using the <Literal>-v</Literal> (verbose) flag to verify that
466 libraries, etc., are being found properly:
469 % ghc -v -o hello Main.hs</Screen>
478 Hello, world!</Screen>
483 Some simple-but-profitable tests are to compile and run the notorious
484 <Literal>nfib</Literal><IndexTerm><Primary>nfib</Primary></IndexTerm> program, using different numeric types. Start with
485 <Literal>nfib :: Int -> Int</Literal>, and then try <Literal>Integer</Literal>, <Literal>Float</Literal>, <Literal>Double</Literal>,
486 <Literal>Rational</Literal> and perhaps the overloaded version. Code for this is
487 distributed in <Literal>ghc/misc/examples/nfib/</Literal> in a source distribution.
491 For more information on how to “drive” GHC, either do <Literal>ghc -help</Literal> or
492 consult the User's Guide (distributed in several pre-compiled formats
493 with a binary distribution, or in source form in
494 <Literal>ghc/docs/users_guide</Literal> in a source distribution).
504 <Sect1 id="sec-install-windows"><Title>Installing on Windows</Title>
507 Getting the Glasgow Haskell Compiler (GHC) to run on Windows platforms can
508 be a bit of a trying experience. This document tries to simplify the task by
509 enumerating the steps you need to follow in order to set up and configure
510 your machine to run GHC.
513 <Sect2><Title>System requirements</Title>
516 An installation of GHC requires about 50M of disk space (which can be lowered by choosing a “compact” installation). The Cygwin support tools take another 200M or so (though if you really need to this can be halved by installing only the following packages: bash, binutils, cygwin, diff, fileutils, findutils, gcc, grep, make, perl, mingw, sed, textutils, w32api; however, it's fiddly and not recommended). To run GHC
517 comfortably, your machine should have at least 64M of memory.
523 <Sect2 id="sec-required"><Title>Software required</Title>
526 You need two chunks of software other than GHC itself: the Cygwin toolchain, and Perl. Here's how to get and install them.
529 <Sect3><Title>The Cygwin toolchain (1.1.x)</Title>
532 At the moment you'll need Cygwin to use GHC. Cygwin dresses up the Win32
533 environment into something more UNIX-like; (notably, it provides
534 <Command>gcc</Command>, <Command>as</Command> and <Command>ld</Command>).
535 You also need Cygwin to use CVS.
539 Important grungy information about Cygwin:
546 Cygwin doesn't deal well with filenames that include
547 spaces. "<Filename>Program Files</Filename>" and "<Filename>Local files</Filename>" are
554 Cygwin implements a symbolic link as a text file with some
555 magical text in it. So programs that don't use Cygwin's
556 I/O libraries won't recognise such files as symlinks.
557 In particular, programs compiled by GHC are meant to be runnable
558 without having Cygwin, so they don't use the Cygwin library, so
559 they don't recognise symlinks.
566 Here's how to install Cygwin.
573 Install the latest Cygwin 1.1.x from <ULink
574 URL="http://sources.redhat.com/cygwin/">sources.redhat.com/cygwin</ULink>.
575 If you have a pre-1.1 version, you should deinstall this first. Choose DOS
576 text mode. After installation, start up a Cygwin shell and issue the
580 mount -f c: /</Screen>
582 assuming you installed Cygwin at <Filename>C:\cygwin</Filename>; otherwise
583 change the drive and directory as appropriate.
589 Create <Filename>C:/Temp</Filename> if it doesn't already exist; substitute
590 the drive you installed Cygwin on for <Filename>C:</Filename>).
596 If you're an Emacs user and want to be able to run <Command>bash</Command>
597 from within a shell buffer, see the <ULink URL="http://www.cs.washington.edu/homes/voelker/ntemacs.html">NT Emacs home page</ULink> for
598 instructions on how to set this up.
607 <Sect3><Title>Environment variables</Title>
610 In case you don't already know how to set environment variables on a Windows
611 machine, here's how. On WinNT/Win2k, to edit your <Constant>PATH</Constant>
612 variable (for example), do the following:
616 <ListItem><Para>Press Start/Settings/Control Panels</Para></ListItem>
617 <ListItem><Para>Double-click System</Para></ListItem>
618 <ListItem><Para>Press Advanced</Para></ListItem>
619 <ListItem><Para>Press Environment Variables</Para></ListItem>
620 <ListItem><Para>Under System Variables, select <Constant>PATH</Constant></Para></ListItem>
621 <ListItem><Para>Press Edit</Para></ListItem>
622 <ListItem><Para>Add "<Filename>;C:\whatever</Filename>" to the end of the string (for example)</Para></ListItem>
623 <ListItem><Para>Press OK</Para></ListItem>
627 Some environment variables are “user variables” and
628 some are “system variables”. I'm not sure of the difference
629 but both are changed though the same dialogue.
633 In addition, when running <Command>bash</Command>
634 you can set environment variables in your <Filename>.bashrc</Filename> file.
635 But it is better to set your environment variables from the
636 control panel (they get inherited by bash) because then they are visible
637 to applications that aren't started by bash. For example,
638 when you're invoking CVS (and ssh) via Emacs keybindings;
639 it invokes <Filename>cvs.exe</Filename> without going via bash.
643 On a Win9x machine you need to edit <Filename>autoexec.bat</Filename> using
644 <Filename>Windows/System/Sysedit</Filename>. You must reboot to make
645 the new settings take effect.
649 The following environment variables must be set:
655 <ColSpec Align="Left" Colsep="0">
656 <ColSpec Align="Left" Colsep="0">
660 <Entry><Constant>PATH</Constant></Entry>
661 <Entry>System</Entry>
663 Add <Filename>C:\usr\bin</Filename>.
664 This should come <Emphasis>before</Emphasis> the Windows system directories
665 (e.g. <Filename>\WINNT\system32</Filename>).
670 <Entry><Constant>SHELL</Constant></Entry>
673 <Filename>C:/usr/bin/bash</Filename>.
678 <Entry><Constant>HOME</Constant></Entry>
681 Set to point to your home directory (normally under
682 <Filename>C:/WINNT/Profiles</Filename> on Win2k). This is where, for example,
683 <Command>bash</Command> will look for your <Filename>.bashrc</Filename>
689 <Entry><Constant>MAKE_MODE</Constant></Entry>
692 Set to <Literal>UNIX</Literal>. If you don't do
693 this you get very weird messages when you type <Command>make</Command>, such as:
695 /c: /c: No such file or directory</Screen></Entry>
699 <Entry><Constant>TMPDIR</Constant></Entry>
702 Set to <Filename>C:/Temp</Filename>. For some reason, Win2k invisibly sets this variable to point to a temporary directory in your profile, that contains embedded spaces. If GHC sees the <Constant>TMPDIR</Constant> variable set, it tries to use it for temporary files, but Cygwin doesn't grok filenames with spaces, so disaster results.
704 Furthermore, it seems that <Constant>TMPDIR</Constant> must be set to a directory in the same file system in which you invoke GHC. Otherwise you get very weird messages when you invoke GHC, such as:
708 Reason: file does not exist /Temp/ghc11068.cpp</Screen>
709 We think this is due to a bug in Cygwin.
719 In addition, we've had problems in the past with certain environment
720 variables being set that seem to have bad effects on GHC. If you have
721 installed other systems ported from Unix, you might too. If you get weird
722 inexplicable failures to build GHC, then it might be worth weeding out unused
723 environment variables. Known culprits from the past include
724 <Constant>GCC_EXEC_PREFIX</Constant> and <Constant>INCLUDE</Constant>.
729 </Sect2> <!-- Reqd software -->
732 <Sect2><Title>Installing GHC</Title>
735 Download the latest GHC distribution:
741 <Term>ghc-4.08 InstallShield installer, 15M: <ULink
742 URL="http://www.haskell.org/ghc/download.html">http</ULink>
747 It is packaged up using an installer that should be familiar-looking to
752 Note: The cygwin support for long file names containing
753 spaces is not 100%, so make sure that you install ghc in a directory
754 that has no embedded spaces (i.e., resist the temptation to put it
755 in <Filename>/Program Files/</Filename>!)
759 When the installer has completed, make sure you add the location of the
760 ghc <Filename>bin/</Filename> directory to your path (e.g.
761 <Filename>/ghc/ghc-4.08/bin </Filename>).
762 You need to do this in order to bring the various GHC binaries into scope.
766 Note: If you haven't got perl already installed, you will have to manually
767 copy the <Filename>perl.exe</Filename> binary from the ghc
768 <Filename>bin/</Filename> into your <Filename>/bin</Filename> directory
769 before continuing—the installer will not currently do this.
778 Make sure that you set all the environment variables described above
779 under Cygwin installation, including <Constant>TMPDIR</Constant>.
782 To test the fruits of your labour, try now to compile a simple
788 module Main(main) where
790 main = putStrLn "Hello, world!"
791 bash$ ghc -o main main.hs
798 OK, assuming that worked, you're all set. Go forth and write useful
799 Haskell programs :-) If not, consult the installation FAQ (<XRef LinkEnd="winfaq">); if that still doesn't help then please report the problems you're experiencing (see <Xref LinkEnd="wrong">).
802 <Para> Further information on using GHC under Windows can be found in <ULink
803 URL="http://www.dcs.gla.ac.uk/~sof/ghc-win32.html">Sigbjørn Finne's
804 pages</ULink>. Note: ignore the installation instructions, which are rather
805 out of date; the <Emphasis>Miscellaneous</Emphasis> section at the bottom of
806 the page is of most interest, covering topics beyond the scope of this
812 <Sect2 id="winfaq"><title>Installing ghc-win32 FAQ</title>
820 I'm having trouble with symlinks.
826 Symlinks only work under Cygwin (<Xref LinkEnd="sec-install">), so binaries
827 not linked to the Cygwin DLL, in particular those built for Mingwin, will not
838 I'm getting &ldquote;permission denied&rdquote; messages from <Command>rm</Command> or
839 <Command>mv</Command>.
845 This can have various causes: trying to rename a directory when an Explorer
846 window is open on it tends to fail. Closing the window generally cures the
847 problem, but sometimes its cause is more mysterious, and logging off and back
848 on or rebooting may be the quickest cure.
858 I get errors when trying to build GHC 4.08 with GHC 4.05.
862 <Answer> <Para> This seems to work better if you don't use
863 <Option>-O</Option> in <Constant>GhcHcOpts</Constant>. It's a bug in 4.05,
864 unfortunately. Anyway, better to install 4.08 binaries and use those.
873 My programs compile fine but do nothing when run.
879 Very recent versions of the mingw package in Cygwin seem to cause this. mingwin version 20001111-1 works fine; you should be able to find it on a <ULink
880 URL="http://sources.redhat.com/cygwin/mirrors.html">Cygwin mirror</ULink>. Download the archive <Filename>mingw-20001111-1.tar.gz</Filename>, place it in a directory called <Filename>mingw</Filename>, place that in a directory called <Filename>latest</Filename>, then run the Cygwin installer again, choose installation from local disk, and select the directory containing <Filename>latest</Filename> as the source directory for the installation packages. You should then be able to downgrade mingw to the required version by clicking on the line in the installation window until the required version appears.
892 <Sect1 id="building-docs">
893 <Title>Building the documentation</Title>
896 We use the DocBook DTD, which is widely used. Most shrink-wrapped distributions seem to be broken in one way or another; thanks to heroic efforts by Sven Panne and Manuel Chakravarty, we now support most of them, plus properly installed versions.
900 Instructions on installing and configuring the DocBook tools follow.
904 <Title>Installing the DocBook tools from RPMs</Title>
906 <Para> If you're using a system that can handle RedHat RPM packages, you can
907 probably use the <ULink
908 URL="http://sourceware.cygnus.com/docbook-tools/">Cygnus DocBook
909 tools</ULink>, which is the most shrink-wrapped SGML suite that we could
910 find. You need all the RPMs except for psgml (i.e.
911 <Filename>docbook</Filename>, <Filename>jade</Filename>,
912 <Filename>jadetex</Filename>, <Filename>sgmlcommon</Filename> and
913 <Filename>stylesheets</Filename>). Note that most of these RPMs are
914 architecture neutral, so are likely to be found in a
915 <Filename>noarch</Filename> directory. The SuSE RPMs also work; the RedHat
916 ones <Emphasis>don't</Emphasis> as of version 6.2, but they are easy to fix:
917 just make a symlink from
918 <Filename>/usr/lib/sgml/stylesheets/nwalsh-modular/lib/dblib.dsl</Filename> to
919 <Filename>/usr/lib/sgml/lib/dblib.dsl</Filename>. </Para>
925 <Title>Installing from binaries on Windows</Title>
928 It's a good idea to use Norman Walsh's <ULink
929 URL="http://nwalsh.com/docbook/dsssl/doc/install.html">installation
930 notes</ULink> as a guide. You should get version 3.1 of DocBook, and note
931 that his file <Filename>test.sgm</Filename> won't work, as it needs version
932 3.0. You should unpack Jade into <Filename>\Jade</Filename>, along with the
933 entities, DocBook into <Filename>\docbook</Filename>, and the DocBook
934 stylesheets into <Filename>\docbook\stylesheets</Filename> (so they actually
935 end up in <Filename>\docbook\stylesheets\docbook</Filename>).
942 <Title>Installing the DocBook tools from source</Title>
948 Install <ULink URL="http://openjade.sourceforge.net/">OpenJade</ULink> (Windows binaries are available as well as sources). If you want DVI, PS, or PDF then install JadeTeX from the <Filename>dsssl</Filename>
949 subdirectory. (If you get the error:
952 ! LaTeX Error: Unknown option implicit=false' for package hyperref'.
955 your version of <Command>hyperref</Command> is out of date; download it from
956 CTAN (<Filename>macros/latex/contrib/supported/hyperref</Filename>), and
957 make it, ensuring that you have first removed or renamed your old copy. If
958 you start getting file not found errors when making the test for
959 <Command>hyperref</Command>, you can abort at that point and proceed
960 straight to <Command>make install</Command>, or enter them as
961 <Filename>../</Filename><Emphasis>filename</Emphasis>.)
965 Make links from <Filename>virtex</Filename> to <Filename>jadetex</Filename>
966 and <Filename>pdfvirtex</Filename> to <Filename>pdfjadetex</Filename>
967 (otherwise DVI, PostScript and PDF output will not work). Copy
968 <Filename>dsssl/*.{dtd,dsl}</Filename> and <Filename>catalog</Filename> to <Filename>/usr/[local/]lib/sgml</Filename>.
974 <Title>DocBook and the DocBook stylesheets</Title>
978 URL="http://www.oasis-open.org/docbook/sgml/3.1/index.html">DocBook</ULink>
979 and install the contents in <Filename>/usr/[local/]/lib/sgml</Filename>.
983 Get the <ULink URL="http://nwalsh.com/docbook/dsssl/">DocBook
984 stylesheets</ULink> and install in
985 <Filename>/usr/[local/]lib/sgml/stylesheets</Filename> (thereby creating a
986 subdirectory docbook). For indexing, copy or link <Filename>collateindex.pl</Filename> from the DocBook stylesheets archive in <Filename>bin</Filename> into a directory on your <Constant>PATH</Constant>.
991 URL="http://www.oasis-open.org/cover/ISOEnts.zip">ISO
992 entities</ULink> into <Filename>/usr/[local/]lib/sgml</Filename>.
1000 <Title>Configuring the DocBook tools</Title>
1003 Once the DocBook tools are installed, the configure script will detect them and set up the build system accordingly. If you have a system that isn't supported, let us know, and we'll try to help.
1009 <Title>Remaining problems</Title>
1012 If you install from source, you'll get a pile of warnings of the form
1014 <Screen>DTDDECL catalog entries are not supported</Screen>
1016 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 <Constant>DTDDECL</Constant> entries from <Filename>docbook.cat</Filename>.
1026 ;;; Local Variables: ***
1028 ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter") ***