[project @ 2003-07-01 12:25:49 by panne]
[ghc-hetmet.git] / ghc / docs / libraries.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>Haskell Hierarchical Libraries</TITLE>
5   </HEAD>
6
7   <BODY>
8     <H1>Haskell Hierarchical Libraries</H1>
9
10     <P>The libraries are divided into several <EM>packages</EM>.
11     NOTE: there is not always a clean division between packages in the
12     hierarchy, which means a node and its children might be in
13     different packages.  If you're looking for a specific module, try
14     all the packages below.</P>
15
16     <DL>
17       <DT>
18         <A HREF="base/index.html"><TT>base</TT></a>
19       </DT><DD>
20         the Prelude, and a large collection of useful libraries.
21       </DD>
22       <DT>
23         <A HREF="haskell98/index.html"><TT>haskell98</TT></a>
24       </DT><DD>
25         Haskell 98 and FFI Standard Libraries.
26       </DD>
27       <DT>
28         <A HREF="network/index.html"><TT>network</TT></a>
29       </DT><DD>
30         networking support libraries.
31       </DD>
32       <DT>
33         <A HREF="haskell-src/index.html"><TT>haskell-src</TT></a>
34       </DT><DD>
35         manipulating Haskell source code.
36       </DD>
37       <DT>
38         <A HREF="readline/index.html"><TT>readline</TT></a>
39       </DT><DD>
40         a library for interactively reading input from the console.
41       </DD>
42 @unixHTMLStart@
43       <DT>
44         <A HREF="unix/index.html"><TT>unix</TT></a>
45       </DT><DD>
46         supplies POSIX functionality.
47       </DD>
48 @unixHTMLEnd@
49 @HOpenGLHTMLStart@
50       <DT>
51         <A HREF="OpenGL/index.html"><TT>OpenGL</TT></a>
52       </DT><DD>
53         3D rendering.
54       </DD>
55       <DT>
56         <A HREF="GLUT/index.html"><TT>GLUT</TT></a>
57       </DT><DD>
58         the OpenGL utility toolkit.
59       </DD>
60 @HOpenGLHTMLEnd@
61 @ObjectIOHTMLStart@
62       <DT>
63         <A HREF="ObjectIO/index.html"><TT>ObjectIO</TT></a>
64       </DT><DD>
65         GUI library.
66       </DD>
67 @ObjectIOHTMLEnd@
68     </DL>
69
70     <H2>Implementation-specific notes</H2>
71
72     <DL>
73       <DT><A HREF="http://www.haskell.org/ghc/">GHC/GHCi</A></DT>
74       <DD>
75         Most of the time, all the packages are available without the
76         need to use any additional command-line options.  The only
77         time when this is not the case is when linking a program on the
78         command line, without using the <tt>--make</tt> option: in this
79         case you must list all the packages to link to by adding the
80         <tt>-package</tt> <i>P</i> flag (where <i>P</i> is the package
81         name) to the command line for each package.
82         See the <a href="users_guide/users-guide.html">User's Guide</a>
83         for more details.
84       </DD>
85
86       <DT><A HREF="http://www.haskell.org/hugs/">Hugs 98</A></DT>
87       <DD>
88         Hugs provides almost all of the modules in the
89         <A HREF="base/index.html"><TT>base</TT></a> package and all the
90         modules in the <A HREF="haskell98/index.html"><TT>haskell98</TT></a>,
91         <A HREF="network/index.html"><TT>network</TT></a> and
92         <A HREF="haskell-src/index.html"><TT>haskell-src</TT></a> packages.
93 @unixHTMLStart@
94         Some of the modules in the <A HREF="unix/index.html"><TT>unix</TT></a> package are supported, too.
95 @unixHTMLEnd@
96         All those modules are always available, as a single hierarchy;
97         Hugs does not use the package subdivision.
98       </DD>
99
100       <DT><A HREF="http://www.haskell.org/nhc98/">Nhc98</A></DT>
101       <DD>
102         To use modules from a package <i>P</i> with Nhc98,
103         add the compile-time option <tt>-package</tt> <i>P</i>.
104         Nhc98 currently provides many of the modules in the
105         <tt>base</tt> package (see the
106         <a href="http://www.haskell.org/nhc98/libraries.html">Nhc98 libraries page</a>
107         for a list).
108       </DD>
109
110     </DL>
111
112   </BODY>
113 </HTML>