X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fdocs%2Fusers_guide%2Finstalling.sgml;h=fae2d0079ebe3abb25562e7b152bd777068b9584;hb=0316a9e603115e6d3f04bd03824a1ca9430b0f0f;hp=f53586fa819f7f679ce973d0cf07f6e5bbfdbfbd;hpb=c5bff5b3740aa3cbdda070a7c00c0cc4ad8617fc;p=ghc-hetmet.git
diff --git a/ghc/docs/users_guide/installing.sgml b/ghc/docs/users_guide/installing.sgml
index f53586f..fae2d00 100644
--- a/ghc/docs/users_guide/installing.sgml
+++ b/ghc/docs/users_guide/installing.sgml
@@ -16,16 +16,23 @@ having a Haskell compiler.)
This guide is in several parts:
-
- Installing on Unix-a-likes ().
- Installing on Windows ().
- The layout of installed files ().
-You don't need to know this to install GHC,
-but it's useful if you are changing the implementation.
- Installing or building the documentation ().
-
-
+
+
+ Installing on Unix-a-likes ().
+
+
+ Installing on Windows ().
+
+
+ The layout of installed files (). You don't need to know this to
+ install GHC, but it's useful if you are changing the
+ implementation.
+
+ Installing on Unix-a-likes
@@ -44,10 +51,11 @@ but it's useful if you are changing the implementation.
- RedHat Linux/x86
+ RedHat or SuSE Linux/x86
- RPM source & binary packages for RedHat Linux (x86
- only) are available for most major releases.
+ RPM source & binary packages for RedHat and SuSE
+ Linux (x86 only) are available for most major
+ releases.
@@ -95,8 +103,9 @@ Binary distributions come in “bundles,” one bundle per file called
-Then you should find a single directory, fptools, with the following
-structure:
+Then you should find a single directory,
+ghc-version, with the
+following structure:
@@ -527,44 +536,64 @@ on...Installing on Windows
-
-Getting the Glasgow Haskell Compiler (GHC) to run on Windows platforms can
-be a bit of a trying experience. It should be much easier now than in the
-past, since all the software required to use GHC is included in
-the InstallShield.
-
-
-
-An installation of GHC requires about 70M of disk space.
-To run GHC comfortably, your machine should have at least
-64M of memory.
-
-
+
+Getting the Glasgow Haskell Compiler (post 5.02) to run on Windows platforms is
+a snap: the Installshield does everything you need.
+
-Installing GHC
+Installing GHC on Windows
-
-Download the latest GHC distribution (ghc-5.02 InstallShield installer, 24M)
-from haskell.org
-It is packaged up using an installer that should be familiar-looking to
-Windows users.
-
-
-
-Note: GHC's support for file names containing
-spaces is not 100%, so make sure that you install ghc in a directory
-that has no embedded spaces (i.e., resist the temptation to put it
-in /Program Files/!)
-
+
+To install GHC, use the following steps:
+
+
+Download the Installshield setup.exe
+from the GHC download page
+haskell.org.
+
+
+Run setup.exe.
+(If you have a previous version of GHC, Installshield will offer to "modify",
+or "remove" GHC. Choose "remove"; then run setup.exe a
+second time. This time it should offer to install.)
+
+
+At this point you should find GHCi and the GHC documentation are
+available in your Start menu under "Start/Programs/Glasgow Haskell Compiler".
+
+
-
-When the installer has completed, make sure you add the location of the
-ghc bin/ directory to your path (e.g.
-C:/ghc/ghc-5.02/bin).
-You need to do this in order to bring the various GHC binaries into scope.
-
+
+The final dialogue box from the install process tells you where GHC has
+been installed. If you want to invoke GHC from a command line, add this
+to your PATH environment variable. Usually, GHC installs into
+c:/ghc/ghc-5.02, though the last part of this path
+depends on which version of GHC you are installing, of course.
+You need to add c:/ghc/ghc-5.02/bin to your path if yo
+
+
+
+GHC needs a directory in which to create, and later delete, temporary files.
+It uses the standard Windows procedure GetTempPath() to
+find a suitable directory. This procedure returns:
+
+The path in environment variable TMP,
+if TMP is set.
+Otherwise, the path in environment variable TEMP,
+if TEMP is set.
+Otherwise, there is a per-user default which varies
+between versions of Windows. On NT and XP-ish versions, it might
+be:
+c:\Documents and Settings\<username>\Local Settings\Temp
+
+
+The main point is that if you don't do anything GHC will work fine;
+but if you want to control where the directory is, you can do so by
+setting TMP or TEMP.
+
+
To test the fruits of your labour, try now to compile a simple
Haskell program:
@@ -580,23 +609,36 @@ bash$ ghc -o main main.hs
bash$ ./main
Hello, world!
bash$
+
+
+
+You do not need the Cygwin toolchain, or anything
+else, to install and run GHC.
+
-OK, assuming that worked, you're all set. Go forth and write useful
-Haskell programs :-) If not, consult the installation FAQ (); if that still doesn't help then please report the problems you're experiencing (see ).
+An installation of GHC requires about 140M of disk space.
+To run GHC comfortably, your machine should have at least
+64M of memory.
+
+Moving GHC around
-Further information on using GHC under Windows can be found in Sigbjørn Finne's
-pages. Note: ignore the installation instructions, which are rather
-out of date; the Miscellaneous section at the bottom of
-the page is of most interest, covering topics beyond the scope of this
-manual.
+At the moment, GHC installs in a fixed place (c:/ghc/ghc-x.yy,
+but once it is installed, you can freely move the entire GHC tree just by copying
+the ghc-x.yy directory. (You may need to fix up
+the links in "Start/Programs/Glasgow Haskell Compiler" if you do this.)
+
+
+It is OK to put GHC tree in a directory whose path involves spaces. However,
+don't do this if you use want to use GHC with the Cygwin tools,
+because Cygwin can get confused when this happpens.
+We havn't quite got to the bottom of this, but so far as we know it's not
+a problem with GHC itself. Nevertheless, just to keep life simple we usually
+put GHC in a place with a space-free path.
-
-
-
+Installing ghc-win32 FAQ
@@ -642,6 +684,16 @@ on or rebooting may be the quickest cure.
+
@@ -700,29 +752,28 @@ 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
+ ghc-usage.txt Message displayed by ghc ––help
bin/ [Win32 only] User-visible binaries
ghc.exe
ghci.bat
- extra-bin/ Support binaries
- unlit Remove literate markup
+ unlit Remove literate markup
- touchy.exe [Win32 only]
- perl.exe [Win32 only]
- gcc.exe [Win32 only]
-
- 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
@@ -764,7 +815,7 @@ layout:
On Win32, the $(libdir)/bin directory contains user-visible binaries;
-add it to you PATH. The ghci executable is a .bat
+add it to your PATH. The ghci executable is a .bat
file which invokes ghc. The GHC executable is the Real Thing (no intervening
@@ -774,199 +825,51 @@ 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
-replacement (touchy.exe)
+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.
+
-
-
-Building the documentation
-
-
-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.
-
-
-
-Installing the DocBook tools from RPMs
-
- 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
-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.
-
-
-
-
- Installing DocBook on FreeBSD
-
- On FreeBSD systems, the easiest way to get DocBook up and
- running is to install it from the ports tree or a pre-compiled
- package (packages are available from your local FreeBSD mirror
- site).
-
- To use the ports tree, do this:
-
- $ cd /usr/ports/textproc/docproj
- $ make install
-
- This installs the FreeBSD documentation project tools, which
- includes everything needed to format the GHC
- documentation.
-
-
-
-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).
-
-
-
-
-
-
-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.
-
-
-
-
-
-
-
-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.
-
-
-
-
-
-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.
-
-
-
-
-
-