X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Finstalling.xml;h=4e732e4a20a97c4da17aed132587f9ca499d1713;hb=d12546c051b49816749b10c54ab30705a01495e5;hp=9f8e4c9eb80b788aaaaae7b72b316e0c7d46a661;hpb=0065d5ab628975892cea1ec7303f968c3338cbe1;p=ghc-hetmet.git diff --git a/docs/users_guide/installing.xml b/docs/users_guide/installing.xml index 9f8e4c9..4e732e4 100644 --- a/docs/users_guide/installing.xml +++ b/docs/users_guide/installing.xml @@ -1,5 +1,5 @@ - + Installing GHC binary installations installation, of binaries @@ -10,10 +10,7 @@ Installing from binary distributions is easiest, and recommended! so you've got to bootstrap it somehow. We provide machine-generated C-files-from-Haskell for this purpose, but it's really quite a pain to use them. If you must build GHC from its sources, using a -binary-distributed GHC to do so is a sensible way to proceed. For the -other fptools programs, many are written in -Haskell, so binary distributions allow you to install them without -having a Haskell compiler.) +binary-distributed GHC to do so is a sensible way to proceed.) This guide is in several parts: @@ -21,26 +18,26 @@ having a Haskell compiler.) Installing on Unix-a-likes (). + linkend="unix-a-likes"/>). Installing on Windows (). + linkend="install-windows"/>). The layout of installed files (). You don't need to know this to + linkend="install-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 + Installing on Unix-a-likes When a platform-specific package is available - For certain platforms, we provide GHC binaries packaged + Most common OSes provide GHC binaries packaged using the native package format for the platform. This is likely to be by far the best way to install GHC for your platform if one of these packages is available, since @@ -48,39 +45,7 @@ having a Haskell compiler.) system normally provides a way to uninstall the package at a later date. - We generally provide the following packages: - - - - RedHat or SuSE Linux/x86 - - RPM source & binary packages for RedHat and SuSE - Linux (x86 only) are available for most major - releases. - - - - - Debian Linux/x86 - - Debian packages for Linux (x86 only), also for most - major releases. - - - - - FreeBSD/x86 - - On FreeBSD/x86, GHC can be installed using either - the ports tree (cd /usr/ports/lang/ghc && make - install) or from a pre-compiled package - available from your local FreeBSD mirror. - - - - - Other platform-specific packages may be available, check - the GHC download page for details. + Check the distribution packages page to see if there is a package available for your platform. @@ -91,181 +56,47 @@ having a Haskell compiler.) -Binary distributions come in “bundles,” one bundle per file called -bundle-platform.tar.gz. (See the building guide for the definition of a platform.) Suppose that you untar a binary-distribution bundle, thus: +Binary distributions come in “bundles,” called +ghc-version-platform.tar.bz2. (See the building guide for the definition of a platform.) Suppose that you untar a binary-distribution bundle, thus: - % cd /your/scratch/space -% gunzip < ghc-x.xx-sun-sparc-solaris2.tar.gz | tar xvf - - - - - -Then you should find a single directory, -ghc-version, with the -following structure: - - - -binary distribution, layout -directory layout (binary distributions) - - - -Makefile.in - - -the raw material from which the Makefile -will be made (). - - - -configure - - -the configuration script (). - - - -README - - -Contains this file summary. - - - -INSTALL - - -Contains this description of how to install -the bundle. - - - -ANNOUNCE - - -The announcement message for the bundle. - - - -NEWS - - -release notes for the bundle—a longer version -of ANNOUNCE. For GHC, the release notes are contained in the User -Guide and this file isn't present. - - - - bin/platform - - -contains platform-specific executable -files to be invoked directly by the user. These are the files that -must end up in your path. - - - -lib/platform/ - - -contains platform-specific support -files for the installation. Typically there is a subdirectory for -each fptools project, whose name is the name of the project with its -version number. For example, for GHC there would be a sub-directory -ghc-x.xx/ where x.xx is the version number of GHC in the bundle. - - - -These sub-directories have the following general structure: +% bunnzip2 < ghc-version-platform.tar.bz2 | tar xvf - - - - -libHSstd.a etc: - - -supporting library archives. - - - -ghc-iface.prl etc: - - -support scripts. - - - -import/ - - -Interface files (.hi) for the prelude. - - - -include/ - - -A few C #include files. - - - - - - -share/ - - -contains platform-independent support files -for the installation. Again, there is a sub-directory for each -fptools project. - - - -html/ - - -contains HTML documentation files (one -sub-directory per project). - - - +Then you should find the bundle contents inside a single directory, +ghc-version. - + Installing OK, so let's assume that you have unpacked your chosen bundles. What -next? Well, you will at least need to run the +next? Well, you will first need to configureconfigure -script by changing directory into the top-level directory for the -bundle and typing ./configure. That should convert -Makefile.in to Makefile. +the bundle by +changing to the bundle's top-level directory +and typing ./configure. That should convert +Makefile-vars.in to Makefile-vars. -installing in-place -in-place installation -You can now either start using the tools in-situ without going -through any installation process, just type make in-place to set the -tools up for this. You'll also want to add the path which make will -now echo to your PATH environment variable. This option is useful if -you simply want to try out the package and/or you don't have the -necessary privileges (or inclination) to properly install the tools -locally. Note that if you do decide to install the package `properly' -at a later date, you have to go through the installation steps that -follow. +The configure script takes a number of flags. The most +commonly used is the +--prefix=/path/to/install/in +flag, which tells the bundle that you want it to be installed in +/path/to/install/in rather than the default +location (/usr/local). +To see all the flags that configure accepts, run +configure --help. -To install a package, you'll have to do the following: +Then do the following: @@ -274,112 +105,35 @@ To install a package, you'll have to do the following: - Edit the Makefile and check the settings of the following variables: - -directories, installation -installation directories - - - - -platform - - -the platform you are going to install for. - - - -bindir - - -the directory in which to install user-invokable -binaries. - - - -libdir - - -the directory in which to install -platform-dependent support files. - - - -datadir - - -the directory in which to install -platform-independent support files. - - - -infodir - - -the directory in which to install Emacs info -files. - - - -htmldir - - -the directory in which to install HTML -documentation. - - - -dvidir - - -the directory in which to install DVI -documentation. - - - - -The values for these variables can be set through invocation of the -configureconfigure -script that comes with the distribution, but doing an optical diff to -see if the values match your expectations is always a Good Idea. - - - -Instead of running configure, it is -perfectly OK to copy Makefile.in to -Makefile and set all these variables directly -yourself. But do it right! - - - - - - Run make install. This should work with ordinary Unix make—no need for fancy stuff like GNU make. - - + -rehash (t?csh or zsh users), so your shell will see the new -stuff in your bin directory. - +If appropriate, add the bin directory to your PATH, as instructed. + + +You may need to run rehash (t?csh or zsh users), in +order for your shell to see the new stuff in your bin directory. + + + Once done, test your “installation” as suggested in -. Be sure to use a -v +. Be sure to use a -v option, so you can see exactly what pathnames it's using. - If things don't work as expected, check the list of known pitfalls in -the building guide. +the building guide. + @@ -400,79 +154,7 @@ regardless, ghc-x.xx should always invoke GHC version - -What bundles there are - - -bundles, binary There are -plenty of “non-basic” GHC bundles. The files for them are -called -ghc-x.xx-bundle-platform.tar.gz, -where the platform is as above, and -bundle is one of these: - - - - - - -prof: - - -Profiling with cost-centres. You probably want this. -profiling bundles -bundles, profiling - - - -par: - - -Parallel Haskell features (sits on top of PVM). -You'll want this if you're into that kind of thing. -parallel bundles -bundles, parallel - - - -gran: - - -The “GranSim” parallel-Haskell simulator -(hmm… mainly for implementors). -bundles, gransim -gransim bundles - - - -ticky: - - -“Ticky-ticky” profiling; very detailed -information about “what happened when I ran this program”—really -for implementors. -bundles, ticky-ticky -ticky-ticky bundles - - - - - - -One likely scenario is that you will grab two -binary bundles—basic, and profiling. We don't usually make the -rest, although you can build them yourself from a source distribution. - - -The various GHC bundles are designed to be unpacked into the -same directory; then installing as per the directions above will -install the whole lot in one go. Note: you must -at least have the basic GHC binary distribution bundle, these extra -bundles won't install on their own. - - - - + Testing that GHC seems to be working @@ -529,11 +211,11 @@ on... -Installing on Windows +Installing on Windows Getting the Glasgow Haskell Compiler (post 5.02) to run on Windows platforms is -a snap: the Installshield does everything you need. +a snap: the installer does everything you need. Installing GHC on Windows @@ -542,38 +224,29 @@ a snap: the Installshield does everything you need. To install GHC, use the following steps: -Download the Installshield setup.exe -from the GHC download page +Download the installer +from the haskell.org. +url="http://www.haskell.org/ghc/download.html">GHC download page. -Run setup.exe. +Run the installer. On Windows, all of GHC's files are installed in a single directory. -If you choose ``Custom'' from the list of install options, you will be given a -choice about where this directory is; otherwise it will be installed -in c:/ghc/ghc-version. -The executable binary for GHC will be installed in the bin/ sub-directory -of the installation directory you choose. - -(If you have already installed the same 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.) +You can override it, but by default this directory is +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. -When installation is complete, you should find GHCi and the GHC documentation are -available in your Start menu under "Start/Programs/Glasgow Haskell Compiler". +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". -The final dialogue box from the install process reminds you where the GHC binary -has been installed (usually c:/ghc/ghc-version/bin/. -If you want to invoke GHC from a command line, add this -to your PATH environment variable. - - - 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: @@ -608,7 +281,7 @@ bash$ ghc -o main main.hs .. bash$ ./main Hello, world! -bash$ +bash$ @@ -617,7 +290,7 @@ You do not need the Cygwin toolchain, or anything else, to install and run GHC. -An installation of GHC requires about 140M of disk space. +An installation of GHC requires about 340M of disk space. To run GHC comfortably, your machine should have at least 64M of memory. @@ -625,10 +298,11 @@ To run GHC comfortably, your machine should have at least Moving GHC around -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.) +Once GHC is installed, you can freely move the entire GHC tree just by copying +the c:/ghc/ghc-version +directory. (You will need to fix up +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, @@ -647,7 +321,8 @@ put GHC in a place with a space-free path. I'm having trouble with symlinks. - Symlinks only work under Cygwin (), so binaries not linked to the Cygwin + Symlinks only work under Cygwin (), + so binaries not linked to the Cygwin DLL, in particular those built for Mingwin, will not work with symlinks. @@ -665,23 +340,12 @@ put GHC in a place with a space-free path. - - -The layout of installed files +The layout of installed files This section describes what files get installed where. You don't need to know it