[project @ 2002-07-02 13:20:53 by simonmar]
[ghc-hetmet.git] / ghc / docs / index.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <HTML>
3 <HEAD>
4 <TITLE>GHC Documentation</TITLE>
5 <BODY>
6
7 <H1>GHC Documentation</H1>
8
9 <P>Welcome to GHC!
10
11 <P>This is the top of the GHC documentation tree, where you will find
12 links to all the supplied documentation about GHC and its
13 libraries.</P>
14
15 <UL>
16  <LI><P><B><A HREF="users_guide/users-guide.html">The User's Guide</A></B>
17      <P>The User's Guide has all you need to know about using GHC:
18      command line options, language extensions, GHCi, etc.
19  </LI>
20
21  <P>
22  <LI><P><B>Hierarchical Libraries</B>
23
24  <P>GHC comes with a large number of libraries, arranged
25  hierarchically.  The libraries are divided into <EM>packages</EM> -
26  to use a package of libraries from GHC or GHCi just add the flag
27  <TT>-package &lt;name&gt;</TT> to the command line, where
28  <TT>&lt;name&gt;</TT> is the name of the package (see the
29  section on packages in the User's Guide for more information).  The
30  <TT>base</TT> and <TT>haskell98</TT> packages are always available,
31  so you don't need to use the <TT>-package</TT> flag to get these.
32
33  <P>
34  <UL>
35   <LI><A HREF="base/index.html"><TT>base</TT></a>: the Prelude,
36   and a large collection of useful libraries.</LI>
37
38   <LI><A HREF="haskell98/index.html"><TT>haskell98</TT></a>:
39   Haskell 98 Standard Libraries.</LI>
40
41   <LI><A HREF="network/index.html"><TT>network</TT></a>:
42   networking support libraries.</LI>
43
44   <LI><A HREF="haskell-src/index.html"><TT>haskell-src</TT></a>:
45   manipulating Haskell source code.</LI>
46  </UL>
47  </LI>
48
49  <P>
50  <LI><B><A HREF="hslibs/book-hslibs.html">(Old) Haskell Libraries</A></B>
51
52  <P>Previous versions of GHC (before version 5.04) came with a suite
53  of libraries known as <TT>hslibs</TT>, aka the Hugs-GHC libraries.
54  As we are in the process of moving towards using hierarchical
55  libraries for everything, many of these libraries have moved over to
56  the new packages in the hierarchical libraries above.  We still
57  provide the old <TT>hslibs</TT> libraries for backwards compatibility
58  and also for those libraries which have yet to move into the
59  hierarchy.  For libraries which have moved, the documentation
60  contains a pointer to the location in the new libraries.
61
62  <P>Libraries which haven't moved yet, so are still only available from
63  here, include: the POSIX library, the Win32 library, HaXml, Readline,
64  and a few others.
65  </LI>
66
67 </UL>
68
69 </BODY>
70 </HTML>