X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fusing.xml;h=95f5b9402a776526db2931bdd6a3d8424a2b9e84;hb=497f8aa6c2c8770daf3d39f57ee5e04dcdcc3778;hp=329c31fffc08945540e3b42b6f7a810b0451b74d;hpb=335b9f366ac440259318777c4c07e4fa42fbbec6;p=ghc-hetmet.git
diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml
index 329c31f..95f5b94 100644
--- a/docs/users_guide/using.xml
+++ b/docs/users_guide/using.xml
@@ -6,6 +6,77 @@
using GHC
+ Getting started: compiling programs
+
+
+ In this chapter you'll find a complete reference to the GHC
+ command-line syntax, including all 400+ flags. It's a large and
+ complex system, and there are lots of details, so it can be
+ quite hard to figure out how to get started. With that in mind,
+ this introductory section provides a quick introduction to the
+ basic usage of GHC for compiling a Haskell program, before the
+ following sections dive into the full syntax.
+
+
+
+ Let's create a Hello World program, and compile and run it.
+ First, create a file hello.hs containing
+ the Haskell code:
+
+
+
+main = putStrLn "Hello, World!"
+
+
+ To compile the program, use GHC like this:
+
+
+$ ghc hello.hs
+
+ (where $ represents the prompt: don't
+ type it). GHC will compile the source
+ file hello.hs, producing
+ an object
+ filehello.o and
+ an interface
+ filehello.hi, and then it
+ will link the object file to the libraries that come with GHC
+ to produce an executable called hello on
+ Unix/Linux/Mac, or hello.exe on
+ Windows.
+
+
+ By default GHC will be very quiet about what it is doing, only
+ printing error messages. If you want to see in more detail
+ what's going on behind the scenes, add to
+ the command line.
+
+
+
+ Then we can run the program like this:
+
+
+
+$ ./hello
+Hello World!
+
+
+ If your program contains multiple modules, then you only need to
+ tell GHC the name of the source file containing
+ the Main module, and GHC will examine
+ the import declarations to find the other
+ modules that make up the program and find their source files.
+ This means that, with the exception of
+ the Main module, every source file should be
+ named after the module name that it contains (with dots replaced
+ by directory separators). For example, the
+ module Data.Person would be in the
+ file Data/Person.hs on Unix/Linux/Mac,
+ or Data\Person.hs on Windows.
+
+
+
+ Options overviewGHC's behaviour is controlled by
@@ -110,7 +181,7 @@ module X where
Mode flags
- For example, or .
+ For example, or .
There may only be a single mode flag on the command line. The
available modes are listed in .
@@ -220,10 +291,20 @@ module X where
Modes of operation
- GHC's behaviour is firstly controlled by a mode flag. Only
- one of these flags may be given, but it does not necessarily need
- to be the first option on the command-line. The available modes
- are:
+
+ GHC's behaviour is firstly controlled by a mode flag. Only one
+ of these flags may be given, but it does not necessarily need to
+ be the first option on the command-line.
+
+
+
+ If no mode flag is present, then GHC will enter make mode
+ () if there are any Haskell source
+ files given on the command line, or else it will link the
+ objects named on the command line to produce an executable.
+
+
+ The available mode flags are:
@@ -242,7 +323,7 @@ module X where
- ghc --make
+ ghc ––makemake mode
@@ -254,6 +335,12 @@ module X where
likely to be much easier, and faster, than using
make. Make mode is described in .
+
+
+ This mode is the default if there are any Haskell
+ source files mentioned on the command line, and in this case
+ the option can be omitted.
+
@@ -428,8 +515,7 @@ module X where
separate compilation
- When given the option,
- GHC will build a multi-module Haskell program by following
+ In this mode, GHC will build a multi-module Haskell program by following
dependencies from one or more root modules (usually just
Main). For example, if your
Main module is in a file called
@@ -440,12 +526,22 @@ module X where
ghc ––make Main.hs
- The command line may contain any number of source file
- names or module names; GHC will figure out all the modules in
- the program by following the imports from these initial modules.
- It will then attempt to compile each module which is out of
- date, and finally, if there is a Main module,
- the program will also be linked into an executable.
+
+ In fact, GHC enters make mode automatically if there are any
+ Haskell source files on the command line and no other mode is
+ specified, so in this case we could just type
+
+
+
+ghc Main.hs
+
+
+ Any number of source file names or module names may be
+ specified; GHC will figure out all the modules in the program by
+ following the imports from these initial modules. It will then
+ attempt to compile each module which is out of date, and
+ finally, if there is a Main module, the
+ program will also be linked into an executable.The main advantages to using ghc
––make over traditional
@@ -1841,7 +1937,7 @@ f "2" = 2
special option or libraries compiled in a certain way. To get access to
the support libraries for Concurrent Haskell, just import
Control.Concurrent. More information on Concurrent Haskell is provided in the documentation for that module.
+ url="&libraryBaseLocation;/Control-Concurrent.html">Control.Concurrent. More information on Concurrent Haskell is provided in the documentation for that module.The following RTS option(s) affect the behaviour of Concurrent
Haskell programs:RTS options, concurrent
@@ -2125,7 +2221,7 @@ statements or clauses.
GHC can dump its optimized intermediate code (said to be in “Core” format)
to a file as a side-effect of compilation. Non-GHC back-end tools can read and process Core files; these files have the suffix
- .hcr. The Core format is described in
+ .hcr. The Core format is described in An External Representation for the GHC Core Language,
and sample tools
for manipulating Core files (in Haskell) are in the GHC source distribution