ghc/docs/index.html.in

   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   </HEAD>
   6
   7   <BODY>
   8
   9     <H1>GHC Documentation</H1>
  10
  11     <P>
  12       Welcome to GHC!
  13     </P>
  14
  15     <P>
  16       This is the top of the GHC documentation tree, where you will find
  17       links to all the supplied documentation about GHC and its libraries.
  18     </P>
  19
  20     <UL>
  21       <LI>
  22         <P>
  23           <B><A HREF="users_guide/users-guide.html">The User's Guide</A></B>
  24         </P>
  25         <P>
  26           The User's Guide has all you need to know about using GHC:
  27           command line options, language extensions, GHCi, etc.
  28         </P>
  29       </LI>
  30
  31       <LI>
  32         <P>
  33           <B>Hierarchical Libraries</B>
  34         </P>
  35         <P>
  36           GHC comes with a large number of libraries, arranged
  37           hierarchically.  The libraries are divided into <EM>packages</EM> -
  38           to use a package of libraries from GHC or GHCi just add the flag
  39           <TT>-package &lt;name&gt;</TT> to the command line, where
  40           <TT>&lt;name&gt;</TT> is the name of the package (see the
  41           section on packages in the User's Guide for more information). The
  42           <TT>base</TT> and <TT>haskell98</TT> packages are always available,
  43           so you don't need to use the <TT>-package</TT> flag to get these.
  44         </P>
  45
  46         <P>
  47         <UL>
  48           <LI>
  49             <A HREF="base/index.html"><TT>base</TT></a>:
  50             the Prelude, and a large collection of useful libraries.
  51           </LI>
  52           <LI>
  53             <A HREF="haskell98/index.html"><TT>haskell98</TT></a>:
  54             Haskell 98 Standard Libraries.
  55           </LI>
  56           <LI>
  57             <A HREF="network/index.html"><TT>network</TT></a>:
  58             networking support libraries.
  59           </LI>
  60           <LI>
  61             <A HREF="haskell-src/index.html"><TT>haskell-src</TT></a>:
  62             manipulating Haskell source code.
  63           </LI>
  64 @HOpenGLHTMLStart@
  65           <LI>
  66             <A HREF="OpenGL/index.html"><TT>OpenGL</TT></a>:
  67             3D rendering.
  68           </LI>
  69           <LI>
  70             <A HREF="GLUT/index.html"><TT>GLUT</TT></a>:
  71             the OpenGL utility toolkit.
  72           </LI>
  73 @HOpenGLHTMLEnd@
  74 @ObjectIOHTMLStart@
  75           <LI>
  76             <A HREF="ObjectIO/index.html"><TT>ObjectIO</TT></a>: GUI library.
  77           </LI>
  78 @ObjectIOHTMLEnd@
  79         </UL>
  80         </P>
  81       </LI>
  82
  83       <LI>
  84         <P>
  85           <B><A HREF="hslibs/book-hslibs.html">(Old) Haskell Libraries</A></B>
  86         </P>
  87         <P>
  88           Previous versions of GHC (before version 5.04) came with a suite
  89           of libraries known as <TT>hslibs</TT>, aka the Hugs-GHC libraries.
  90           As we are in the process of moving towards using hierarchical
  91           libraries for everything, many of these libraries have moved over to
  92           the new packages in the hierarchical libraries above.  We still
  93           provide the old <TT>hslibs</TT> libraries for backwards compatibility
  94           and also for those libraries which have yet to move into the
  95           hierarchy.  For libraries which have moved, the documentation
  96           contains a pointer to the location in the new libraries.
  97         </P>
  98         <P>
  99           Libraries which haven't moved yet, so are still only available from
 100           here, include: the POSIX library, the Win32 library, HaXml,
 101           and a few others.
 102         </P>
 103       </LI>
 104     </UL>
 105   </BODY>
 106 </HTML>