X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Finstalling.xml;h=36213ad0890fce5483a55ca494c4020a75648ac5;hb=aedb94f5f220b5e442b23ecc445fd38c8d9b6ba0;hp=b66feeba552345c6fd379ae14907dd14a1aea2af;hpb=5d048ef6cb359e74290de34401a52dce405cb10b;p=ghc-hetmet.git
diff --git a/docs/users_guide/installing.xml b/docs/users_guide/installing.xml
index b66feeb..36213ad 100644
--- a/docs/users_guide/installing.xml
+++ b/docs/users_guide/installing.xml
@@ -63,7 +63,7 @@ Binary distributions come in “bundles,” called
% cd /your/scratch/space
-% bunnzip2 < ghc-version-platform.tar.bz2 | tar xvf -
+% bunzip2 < ghc-version-platform.tar.bz2 | tar xvf -
@@ -225,16 +225,16 @@ url="http://www.haskell.org/ghc/download.html">GHC download page.
Run the installer.
On Windows, all of GHC's files are installed in a single directory.
You can override it, but by default this directory is
-c:/ghc/ghc-version.
+c:/ghc/ghc-version.
The executable binary for GHC will be installed in the
bin/ sub-directory of the installation directory.
If you want to invoke GHC from a command line, add this
-to your PATH environment variable.
+to your $PATH environment variable.
When installation is complete, you should find GHCi and the GHC
documentation are available in your Start menu under
-"Start/All Programs/GHC/ghc-version".
+"Start/All Programs/GHC/ghc-version".
@@ -243,17 +243,17 @@ 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,
+The path in the environment variable TMP,
if TMP is set.
-Otherwise, the path in environment variable TEMP,
+Otherwise, the path in the 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
+c:\Documents and Settings\<username>\Local Settings\Temp.
-The main point is that if you don't do anything GHC will work fine;
+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.
@@ -282,7 +282,7 @@ You do not need the Cygwin toolchain, or anything
else, to install and run GHC.
-An installation of GHC requires about 340M of disk space.
+An installation of GHC requires about 365M of disk space.
To run GHC comfortably, your machine should have at least
64M of memory.
@@ -291,16 +291,16 @@ To run GHC comfortably, your machine should have at least
Moving GHC around
Once GHC is installed, you can freely move the entire GHC tree just by copying
-the c:/ghc/ghc-version
+the c:/ghc/ghc-version
directory. (You will need to fix up
-the links in "Start/All Programs/GHC/ghc-version"
+the links in "Start/All Programs/GHC/ghc-version"
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 happens.
-We havn't quite got to the bottom of this, but so far as we know it's not
+We haven'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.
@@ -392,9 +392,9 @@ That is why $(bindir) must be $(libdir)/bin The binary directory
-The binary directory, $(bindir) contains user-visible
+The binary directory, $(bindir), contains user-visible
executables, notably ghc and ghci.
-You should add it to your $PATH
+You should add it to your $PATH.
On Unix, the user-invokable ghc invokes $(libdir)/ghc-version,
@@ -417,18 +417,20 @@ truncates them. Similarly ghci is a C wrapper program that
The library directory
-The layout of the library directory, $(libdir) is almost identical on
+The layout of the library directory, $(libdir),
+is almost identical on
Windows and Unix, as follows. Differences between Windows and Unix
-are noted thus [Win32 only] and are commented below.
+are annotated [Win32 only] and are commented below.
$(libdir)/
package.conf GHC package configuration
ghc-usage.txt Message displayed by ghc ––help
+ ghci-usage.txt Message displayed by ghci ––help
bin/ [Win32 only] User-visible binaries
- ghc.exe
- ghci.exe
+ ghc.exe
+ ghci.exe
unlit Remove literate markup
@@ -439,7 +441,7 @@ are noted thus [Win32 only] and are commented below.
ghc-x.xx GHC executable [Unix only]
ghc-split Asm code splitter
- ghc-asm Asm code mangler
+ ghc-asm Asm code mangler
gcc-lib/ [Win32 only] Support files for gcc
specs gcc configuration
@@ -449,32 +451,31 @@ are noted thus [Win32 only] and are commented below.
ld.exe
crt0.o Standard
- ..etc.. binaries
+ ..etc.. binaries
libmingw32.a Standard
- ..etc.. libraries
+ ..etc.. libraries
*.h Include files
- imports/ GHC interface files
- std/*.hi 'std' library
- lang/*.hi 'lang' library
- ..etc..
+ hslibs-imports/ GHC interface files for the...
+ ghc/*.hi ...'ghc' library
include/ C header files
StgMacros.h GHC-specific
- ..etc... header files
+ ..etc.. header files
mingw/*.h [Win32 only] Mingwin header files
- libHSrts.a GHC library archives
- libHSstd.a
- libHSlang.a
- ..etc..
+ lib/ GHC's library
+ base-2.1
+ ..etc..
+
+ libHSrts*.a GHC RTS archive
+ libHSghc.a GHC package archive
- HSstd1.o GHC library linkables
- HSstd2.o (used by ghci, which does
- HSlang.o not grok .a files yet)
+ HSrts.o GHC RTS linkable, used by ghci
+ HSghc.o GHC package linkable, used by ghci
Note that:
@@ -483,7 +484,7 @@ are noted thus [Win32 only] and are commented below.
$(libdir) also contains support
binaries. These are not expected to be
- on the user's PATH, but and are invoked
+ on the user's PATH, but 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
@@ -506,11 +507,11 @@ 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
+ first line says #!/usr/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.
+ treats the #!/usr/bin/perl as a comment.
Reason: on Windows we want to invoke the Perl distributed
with GHC, rather than assume some installed one.