From: simonmar Date: Mon, 10 Sep 2001 16:48:10 +0000 (+0000) Subject: [project @ 2001-09-10 16:48:10 by simonmar] X-Git-Tag: Approximately_9120_patches~997 X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=978840b58d20b9621beb0950bf7ee5e1ddd69634;p=ghc-hetmet.git [project @ 2001-09-10 16:48:10 by simonmar] Sync the documentation with the extra-bin removal. --- diff --git a/ghc/docs/users_guide/installing.sgml b/ghc/docs/users_guide/installing.sgml index b245c9e..b3bbc10 100644 --- a/ghc/docs/users_guide/installing.sgml +++ b/ghc/docs/users_guide/installing.sgml @@ -700,10 +700,9 @@ call to find the directory in which the running GHC executable lives, and derive Layout of the library directory - -The layout of the library directory is almost identical on Windows and Unix, -as follows: -layout: +The layout of the library directory is almost identical on +Windows and Unix, as follows: layout: + $(libdir)/ package.conf GHC package configuration @@ -713,17 +712,16 @@ layout: ghc.exe ghci.bat - extra-bin/ Support binaries - unlit Remove literate markup - - touchy.exe [Win32 only] - perl.exe [Win32 only] - gcc.exe [Win32 only] + unlit Remove literate markup - ghc [Unix only] - - ghc-split Asm code splitter - ghc-asm Asm code mangler + touchy.exe [Win32 only] + perl.exe [Win32 only] + gcc.exe [Win32 only] + + ghc-x.xx GHC executable [Unix only] + + ghc-split Asm code splitter + ghc-asm Asm code mangler gcc-lib/ [Win32 only] Support files for gcc specs gcc configuration @@ -775,41 +773,45 @@ and cmd.exe (which executes .bat files truncates them. [We assume people won't invoke ghci with very long command lines.] -On Unix, the user-invokable ghc invokes $(libdir)/extra-bin/ghc, +On Unix, the user-invokable ghc invokes $(libdir)/ghc-version, passing a suitable flag. - - $(libdir)/extra-bin/ contains support binaries. These -are not expected to be on the user's PATH, but -and are invoked directly by GHC. In the Makefile system, this directory is called -$(libexecdir), but you aren't free to change it. It must -be $(libdir)/extra-bin/. - - + + $(libdir) also contains support + binaries. These are not expected to be + on the user's PATH, but and are invoked + directly by GHC. In the Makefile system, this directory is + also called $(libexecdir), but + you are not free to change it. It must + be the same as $(libdir). + - We distribute gcc with the Win32 distribution of GHC, so that users +We distribute gcc with the Win32 distribution of GHC, so that users don't need to install gcc, nor need to care about which version it is. All gcc's support files are kept in $(libdir)/gcc-lib/. - Similarly, we distribute perl and a touch +Similarly, we distribute perl and a touch replacement (touchy.exe) with the Win32 distribution of GHC. - The support programs ghc-split and ghc-asm -are Perl scripts. The first line says #!/bin/perl; on Unix, the script is -indeed invoked as a shell script, which invokes Perl; on Windows, GHC invokes -$(libdir)/extra-bin/perl directly, -which treats the #!/bin/perl as a comment. Reason: on Windows we want -to invoke the Perl distributed with GHC, rather than assume some installed one. - - + + The support programs ghc-split + and ghc-asm are Perl scripts. The + first line says #!/bin/perl; on Unix, the + script is indeed invoked as a shell script, which invokes + Perl; on Windows, GHC invokes + $(libdir)/perl.exe directly, which + treats the #!/bin/perl as a comment. + Reason: on Windows we want to invoke the Perl distributed + with GHC, rather than assume some installed one. + @@ -820,21 +822,19 @@ to invoke the Perl distributed with GHC, rather than assume some installed one. Building the documentation - -We use the DocBook DTD, which is widely used. Most shrink-wrapped +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. - -Instructions on installing and configuring the DocBook tools follow. +Instructions on installing and configuring the DocBook tools follow. Installing the DocBook tools from RPMs - If you're using a system that can handle RedHat RPM packages, +If you're 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 @@ -872,8 +872,7 @@ to /usr/lib/sgml/lib/dblib.dsl. Installing from binaries on Windows - -It's a good idea to use Norman Walsh's 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 @@ -892,8 +891,7 @@ end up in \docbook\stylesheets\docbook). Jade - -Install OpenJade (Windows binaries are available as well as sources). If you want DVI, PS, or PDF then install JadeTeX from the dsssl +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: @@ -909,8 +907,7 @@ straight to make install, or enter them as ../filename.) - -Make links from virtex to jadetex +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. @@ -921,21 +918,18 @@ and pdfvirtex to pdfjadetex DocBook and the DocBook stylesheets - -Get a Zip of Get a Zip of DocBook and install the contents in /usr/[local/]/lib/sgml. - -Get the DocBook +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 Download the ISO entities into /usr/[local/]lib/sgml. @@ -947,8 +941,7 @@ entities into /usr/[local/]lib/sgml. Configuring the DocBook tools - -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. +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. @@ -956,8 +949,7 @@ Once the DocBook tools are installed, the configure script will detect them and Remaining problems - -If you install from source, you'll get a pile of warnings of the form +If you install from source, you'll get a pile of warnings of the form DTDDECL catalog entries are not supported