Add a --print-docdir flag
[ghc-hetmet.git] / docs / users_guide / using.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <chapter id="using-ghc">
3   <title>Using GHC</title>
4
5   <indexterm><primary>GHC, using</primary></indexterm>
6   <indexterm><primary>using GHC</primary></indexterm>
7
8   <sect1>
9     <title>Options overview</title>
10     
11     <para>GHC's behaviour is controlled by
12     <firstterm>options</firstterm>, which for historical reasons are
13     also sometimes referred to as command-line flags or arguments.
14     Options can be specified in three ways:</para>
15
16     <sect2>
17       <title>Command-line arguments</title>
18       
19       <indexterm><primary>structure, command-line</primary></indexterm>
20       <indexterm><primary>command-line</primary><secondary>arguments</secondary></indexterm>
21       <indexterm><primary>arguments</primary><secondary>command-line</secondary></indexterm>
22       
23       <para>An invocation of GHC takes the following form:</para>
24
25 <screen>
26 ghc [argument...]
27 </screen>
28
29       <para>Command-line arguments are either options or file names.</para>
30
31       <para>Command-line options begin with <literal>-</literal>.
32       They may <emphasis>not</emphasis> be grouped:
33       <option>-vO</option> is different from <option>-v -O</option>.
34       Options need not precede filenames: e.g., <literal>ghc *.o -o
35       foo</literal>.  All options are processed and then applied to
36       all files; you cannot, for example, invoke <literal>ghc -c -O1
37       Foo.hs -O2 Bar.hs</literal> to apply different optimisation
38       levels to the files <filename>Foo.hs</filename> and
39       <filename>Bar.hs</filename>.</para>
40     </sect2>
41
42     <sect2 id="source-file-options">
43       <title>Command line options in source files</title>
44     
45       <indexterm><primary>source-file options</primary></indexterm>
46
47       <para>Sometimes it is useful to make the connection between a
48       source file and the command-line options it requires quite
49       tight. For instance, if a Haskell source file uses GHC
50       extensions, it will always need to be compiled with the
51       <option>-fglasgow-exts</option> option.  Rather than maintaining
52       the list of per-file options in a <filename>Makefile</filename>,
53       it is possible to do this directly in the source file using the
54       <literal>OPTIONS_GHC</literal> pragma <indexterm><primary>OPTIONS_GHC
55       pragma</primary></indexterm>:</para>
56
57 <programlisting>
58 {-# OPTIONS_GHC -fglasgow-exts #-}
59 module X where
60 ...
61 </programlisting>
62       
63       <para><literal>OPTIONS_GHC</literal> pragmas are only looked for at
64       the top of your source files, upto the first
65       (non-literate,non-empty) line not containing
66       <literal>OPTIONS_GHC</literal>. Multiple <literal>OPTIONS_GHC</literal>
67       pragmas are recognised.  Do not put comments before, or on the same line
68         as, the <literal>OPTIONS_GHC</literal> pragma.</para>
69
70       <para>Note that your command shell does not
71       get to the source file options, they are just included literally
72       in the array of command-line arguments the compiler
73       maintains internally, so you'll be desperately disappointed if
74       you try to glob etc. inside <literal>OPTIONS_GHC</literal>.</para>
75
76       <para>NOTE: the contents of OPTIONS_GHC are prepended to the
77       command-line options, so you <emphasis>do</emphasis> have the
78       ability to override OPTIONS_GHC settings via the command
79       line.</para>
80
81       <para>It is not recommended to move all the contents of your
82       Makefiles into your source files, but in some circumstances, the
83       <literal>OPTIONS_GHC</literal> pragma is the Right Thing. (If you
84       use <option>-keep-hc-file</option> and have OPTION flags in
85       your module, the OPTIONS_GHC will get put into the generated .hc
86       file).</para>
87     </sect2>
88
89     <sect2>
90       <title>Setting options in GHCi</title>
91
92       <para>Options may also be modified from within GHCi, using the
93       <literal>:set</literal> command.  See <xref linkend="ghci-set"/>
94       for more details.</para>
95     </sect2>
96   </sect1>
97     
98   <sect1 id="static-dynamic-flags">
99     <title>Static, Dynamic, and Mode options</title>
100     <indexterm><primary>static</primary><secondary>options</secondary>
101     </indexterm>
102     <indexterm><primary>dynamic</primary><secondary>options</secondary>
103     </indexterm>
104     <indexterm><primary>mode</primary><secondary>options</secondary>
105     </indexterm>
106
107     <para>Each of GHC's command line options is classified as
108     <firstterm>static</firstterm>, <firstterm>dynamic</firstterm> or
109       <firstterm>mode</firstterm>:</para>
110
111     <variablelist>
112       <varlistentry>
113         <term>Mode flags</term>
114         <listitem>
115           <para>For example, <option>--make</option> or <option>-E</option>.
116             There may only be a single mode flag on the command line.  The
117             available modes are listed in <xref linkend="modes"/>.</para>
118         </listitem>
119       </varlistentry>
120       <varlistentry>
121         <term>Dynamic Flags</term>
122         <listitem>
123           <para>Most non-mode flags fall into this category.  A dynamic flag
124             may be used on the command line, in a
125             <literal>GHC_OPTIONS</literal> pragma in a source file, or set
126             using <literal>:set</literal> in GHCi.</para>
127         </listitem>
128       </varlistentry>
129       <varlistentry>
130         <term>Static Flags</term>
131         <listitem>
132           <para>A few flags are "static", which means they can only be used on
133             the command-line, and remain in force over the entire GHC/GHCi
134             run.</para>
135         </listitem>
136       </varlistentry>
137     </variablelist>
138     
139     <para>The flag reference tables (<xref
140     linkend="flag-reference"/>) lists the status of each flag.</para>
141
142     <para>There are a few flags that are static except that they can
143     also be used with GHCi's <literal>:set</literal> command; these
144     are listed as &ldquo;static/<literal>:set</literal>&rdquo; in the
145     table.</para> 
146   </sect1>
147
148   <sect1 id="file-suffixes">
149     <title>Meaningful file suffixes</title>
150
151     <indexterm><primary>suffixes, file</primary></indexterm>
152     <indexterm><primary>file suffixes for GHC</primary></indexterm>
153
154     <para>File names with &ldquo;meaningful&rdquo; suffixes (e.g.,
155     <filename>.lhs</filename> or <filename>.o</filename>) cause the
156     &ldquo;right thing&rdquo; to happen to those files.</para>
157
158     <variablelist>
159
160       <varlistentry>
161         <term><filename>.hs</filename></term>
162         <listitem>
163           <para>A Haskell module.</para>
164         </listitem>
165       </varlistentry>
166
167       <varlistentry>
168         <term>
169           <filename>.lhs</filename>
170           <indexterm><primary><literal>lhs</literal> suffix</primary></indexterm>
171         </term>
172         <listitem>
173           <para>A &ldquo;literate Haskell&rdquo; module.</para>
174         </listitem>
175       </varlistentry>
176
177       <varlistentry>
178         <term><filename>.hi</filename></term>
179         <listitem>
180           <para>A Haskell interface file, probably
181           compiler-generated.</para>
182         </listitem>
183       </varlistentry>
184
185       <varlistentry>
186         <term><filename>.hc</filename></term>
187         <listitem>
188           <para>Intermediate C file produced by the Haskell
189           compiler.</para>
190         </listitem>
191       </varlistentry>
192
193       <varlistentry>
194         <term><filename>.c</filename></term>
195         <listitem>
196           <para>A C&nbsp;file not produced by the Haskell
197           compiler.</para>
198         </listitem>
199       </varlistentry>
200       
201       <varlistentry>
202         <term><filename>.s</filename></term>
203         <listitem>
204           <para>An assembly-language source file, usually produced by
205           the compiler.</para>
206         </listitem>
207       </varlistentry>
208
209       <varlistentry>
210         <term><filename>.o</filename></term>
211         <listitem>
212           <para>An object file, produced by an assembler.</para>
213         </listitem>
214       </varlistentry>
215     </variablelist>
216
217     <para>Files with other suffixes (or without suffixes) are passed
218     straight to the linker.</para>
219
220   </sect1>
221
222   <sect1 id="modes">
223     <title>Modes of operation</title>
224
225     <para>GHC's behaviour is firstly controlled by a mode flag.  Only
226     one of these flags may be given, but it does not necessarily need
227     to be the first option on the command-line.  The available modes
228     are:</para>
229
230     <variablelist>
231       <varlistentry>
232         <term>
233           <cmdsynopsis><command>ghc --interactive</command>
234           </cmdsynopsis>
235           <indexterm><primary>interactive mode</primary></indexterm>
236           <indexterm><primary>ghci</primary></indexterm>
237         </term>
238         <listitem>
239           <para>Interactive mode, which is also available as
240           <command>ghci</command>.  Interactive mode is described in
241           more detail in <xref linkend="ghci"/>.</para>
242         </listitem>
243       </varlistentry>
244       
245       <varlistentry>
246         <term>
247           <cmdsynopsis><command>ghc --make</command>
248           </cmdsynopsis>
249           <indexterm><primary>make mode</primary></indexterm>
250           <indexterm><primary><option>&ndash;&ndash;make</option></primary></indexterm>
251         </term>
252         <listitem>
253           <para>In this mode, GHC will build a multi-module Haskell
254           program automatically, figuring out dependencies for itself.
255           If you have a straightforward Haskell program, this is
256           likely to be much easier, and faster, than using
257           <command>make</command>.  Make mode is described in <xref
258           linkend="make-mode"/>.</para>
259         </listitem>
260       </varlistentry>
261
262       <varlistentry>
263         <term>
264           <cmdsynopsis><command>ghc -e</command>
265              <arg choice='plain'><replaceable>expr</replaceable></arg>
266           </cmdsynopsis>
267           <indexterm><primary>eval mode</primary></indexterm>
268         </term>
269         <listitem>
270           <para>Expression-evaluation mode.  This is very similar to
271           interactive mode, except that there is a single expression
272           to evaluate (<replaceable>expr</replaceable>) which is given
273           on the command line.  See <xref linkend="eval-mode"/> for
274           more details.</para>
275         </listitem>
276       </varlistentry>
277       
278       <varlistentry>
279         <term>
280           <cmdsynopsis>
281             <command>ghc -E</command>
282             <command>ghc -c</command>
283             <command>ghc -S</command>
284             <command>ghc -c</command>
285           </cmdsynopsis>
286           <indexterm><primary><option>-E</option></primary></indexterm>
287           <indexterm><primary><option>-C</option></primary></indexterm>
288           <indexterm><primary><option>-S</option></primary></indexterm>
289           <indexterm><primary><option>-c</option></primary></indexterm>
290         </term>
291         <listitem>
292           <para>This is the traditional batch-compiler mode, in which
293           GHC can compile source files one at a time, or link objects
294           together into an executable.  This mode also applies if
295           there is no other mode flag specified on the command line,
296           in which case it means that the specified files should be
297           compiled and then linked to form a program. See <xref
298           linkend="options-order"/>.</para>
299         </listitem>
300       </varlistentry>
301
302       <varlistentry>
303         <term>
304           <cmdsynopsis>
305             <command>ghc -M</command>
306           </cmdsynopsis>
307           <indexterm><primary>dependency-generation mode</primary></indexterm>
308         </term>
309         <listitem>
310           <para>Dependency-generation mode.  In this mode, GHC can be
311           used to generate dependency information suitable for use in
312           a <literal>Makefile</literal>.  See <xref
313           linkend="makefile-dependencies"/>.</para>
314         </listitem>
315       </varlistentry>
316
317       <varlistentry>
318         <term>
319           <cmdsynopsis>
320             <command>ghc --mk-dll</command>
321           </cmdsynopsis>
322           <indexterm><primary>DLL-creation mode</primary></indexterm>
323         </term>
324         <listitem>
325           <para>DLL-creation mode (Windows only).  See <xref
326           linkend="win32-dlls-create"/>.</para>
327         </listitem>
328       </varlistentry>
329
330       <varlistentry>
331         <term>
332           <cmdsynopsis>
333           <command>ghc --help</command> <command>ghc -?</command>
334             </cmdsynopsis>
335           <indexterm><primary><option>&ndash;&ndash;help</option></primary></indexterm>
336         </term>
337         <listitem>
338           <para>Cause GHC to spew a long usage message to standard
339           output and then exit.</para>
340         </listitem>
341       </varlistentry>
342
343       <varlistentry>
344         <term>
345           <cmdsynopsis>
346             <command>ghc --supported-languages</command>
347           </cmdsynopsis>
348           <indexterm><primary><option>&ndash;&ndash;supported-languages</option></primary></indexterm>
349         </term>
350         <listitem>
351           <para>Print the supported language extensions.</para>
352         </listitem>
353       </varlistentry>
354
355       <varlistentry>
356         <term>
357           <cmdsynopsis>
358             <command>ghc --info</command>
359           </cmdsynopsis>
360           <indexterm><primary><option>&ndash;&ndash;info</option></primary></indexterm>
361         </term>
362         <listitem>
363           <para>Print information about the compiler.</para>
364         </listitem>
365       </varlistentry>
366
367       <varlistentry>
368         <term>
369           <cmdsynopsis>
370             <command>ghc --version</command>
371             <command>ghc -V</command>
372           </cmdsynopsis>
373           <indexterm><primary><option>-V</option></primary></indexterm>
374           <indexterm><primary><option>&ndash;&ndash;version</option></primary></indexterm>
375         </term>
376         <listitem>
377           <para>Print a one-line string including GHC's version number.</para>
378         </listitem>
379       </varlistentry>
380
381       <varlistentry>
382         <term>
383           <cmdsynopsis>
384             <command>ghc --numeric-version</command>
385           </cmdsynopsis>
386           <indexterm><primary><option>&ndash;&ndash;numeric-version</option></primary></indexterm>
387         </term>
388         <listitem>
389           <para>Print GHC's numeric version number only.</para>
390         </listitem>
391       </varlistentry>
392
393       <varlistentry>
394         <term>
395           <cmdsynopsis>
396             <command>ghc --print-libdir</command>
397           </cmdsynopsis>
398           <indexterm><primary><option>&ndash;&ndash;print-libdir</option></primary></indexterm>
399         </term>
400         <listitem>
401           <para>Print the path to GHC's library directory.  This is
402           the top of the directory tree containing GHC's libraries,
403           interfaces, and include files (usually something like
404           <literal>/usr/local/lib/ghc-5.04</literal> on Unix).  This
405           is the value of
406           <literal>$libdir</literal><indexterm><primary><literal>libdir</literal></primary></indexterm>
407       in the package configuration file
408       (see <xref linkend="packages"/>).</para>
409         </listitem>
410       </varlistentry>
411
412       <varlistentry>
413         <term>
414           <cmdsynopsis>
415             <command>ghc --print-docdir</command>
416           </cmdsynopsis>
417           <indexterm><primary><option>&ndash;&ndash;print-docdir</option></primary></indexterm>
418         </term>
419         <listitem>
420           <para>Print the path to GHC's documentation directory. Note that
421       some distributions do no include the documentation, in which case
422       this directory may be empty or may not exist.</para>
423         </listitem>
424       </varlistentry>
425
426     </variablelist>
427
428     <sect2 id="make-mode">
429       <title>Using <command>ghc</command> <option>&ndash;&ndash;make</option></title>
430       <indexterm><primary><option>&ndash;&ndash;make</option></primary></indexterm>
431       <indexterm><primary>separate compilation</primary></indexterm>
432       
433       <para>When given the <option>&ndash;&ndash;make</option> option,
434       GHC will build a multi-module Haskell program by following
435       dependencies from one or more root modules (usually just
436       <literal>Main</literal>).  For example, if your
437       <literal>Main</literal> module is in a file called
438       <filename>Main.hs</filename>, you could compile and link the
439       program like this:</para>
440
441 <screen>
442 ghc &ndash;&ndash;make Main.hs
443 </screen>
444
445       <para>The command line may contain any number of source file
446       names or module names; GHC will figure out all the modules in
447       the program by following the imports from these initial modules.
448       It will then attempt to compile each module which is out of
449       date, and finally, if there is a <literal>Main</literal> module,
450       the program will also be linked into an executable.</para>
451
452       <para>The main advantages to using <literal>ghc
453       &ndash;&ndash;make</literal> over traditional
454       <literal>Makefile</literal>s are:</para>
455
456       <itemizedlist>
457         <listitem>
458           <para>GHC doesn't have to be restarted for each compilation,
459           which means it can cache information between compilations.
460           Compiling a multi-module program with <literal>ghc
461           &ndash;&ndash;make</literal> can be up to twice as fast as
462           running <literal>ghc</literal> individually on each source
463           file.</para>
464         </listitem>
465         <listitem>
466           <para>You don't have to write a <literal>Makefile</literal>.</para>
467           <indexterm><primary><literal>Makefile</literal>s</primary><secondary>avoiding</secondary></indexterm>
468         </listitem>
469         <listitem>
470           <para>GHC re-calculates the dependencies each time it is
471           invoked, so the dependencies never get out of sync with the
472           source.</para>
473         </listitem>
474       </itemizedlist>
475       
476       <para>Any of the command-line options described in the rest of
477       this chapter can be used with
478       <option>&ndash;&ndash;make</option>, but note that any options
479       you give on the command line will apply to all the source files
480       compiled, so if you want any options to apply to a single source
481       file only, you'll need to use an <literal>OPTIONS_GHC</literal>
482       pragma (see <xref linkend="source-file-options"/>).</para>
483
484       <para>If the program needs to be linked with additional objects
485       (say, some auxiliary C code), then the object files can be
486       given on the command line and GHC will include them when linking
487       the executable.</para>
488       
489       <para>Note that GHC can only follow dependencies if it has the
490       source file available, so if your program includes a module for
491       which there is no source file, even if you have an object and an
492       interface file for the module, then GHC will complain.  The
493       exception to this rule is for package modules, which may or may
494       not have source files.</para>
495
496       <para>The source files for the program don't all need to be in
497       the same directory; the <option>-i</option> option can be used
498       to add directories to the search path (see <xref
499       linkend="search-path"/>).</para>
500     </sect2>
501   
502     <sect2 id="eval-mode">
503       <title>Expression evaluation mode</title>
504
505       <para>This mode is very similar to interactive mode, except that
506       there is a single expression to evaluate which is specified on
507       the command line as an argument to the <option>-e</option>
508       option:</para>
509
510 <screen>
511 ghc -e <replaceable>expr</replaceable>
512 </screen>
513
514       <para>Haskell source files may be named on the command line, and
515       they will be loaded exactly as in interactive mode.  The
516       expression is evaluated in the context of the loaded
517       modules.</para>
518
519       <para>For example, to load and run a Haskell program containing
520       a module <literal>Main</literal>, we might say</para>
521
522 <screen>
523 ghc -e Main.main Main.hs
524 </screen>
525       
526       <para>or we can just use this mode to evaluate expressions in
527       the context of the <literal>Prelude</literal>:</para>
528
529 <screen>
530 $ ghc -e "interact (unlines.map reverse.lines)"
531 hello
532 olleh
533 </screen>
534     </sect2>
535
536     <sect2 id="options-order">
537       <title>Batch compiler mode</title>
538       
539       <para>In <emphasis>batch mode</emphasis>, GHC will compile one or more source files
540       given on the command line.</para>
541       
542       <para>The first phase to run is determined by each input-file
543       suffix, and the last phase is determined by a flag.  If no
544       relevant flag is present, then go all the way through to linking.
545       This table summarises:</para>
546       
547       <informaltable>
548         <tgroup cols="4">
549           <colspec align="left"/>
550           <colspec align="left"/>
551           <colspec align="left"/>
552           <colspec align="left"/>
553           
554           <thead>
555             <row>
556               <entry>Phase of the compilation system</entry>
557               <entry>Suffix saying &ldquo;start here&rdquo;</entry>
558               <entry>Flag saying &ldquo;stop after&rdquo;</entry>
559               <entry>(suffix of) output file</entry>
560             </row>
561           </thead>
562           <tbody>
563             <row>
564               <entry>literate pre-processor</entry>
565               <entry><literal>.lhs</literal></entry>
566               <entry>-</entry>
567               <entry><literal>.hs</literal></entry>
568             </row>
569             
570             <row>
571               <entry>C pre-processor (opt.) </entry>
572               <entry><literal>.hs</literal> (with
573               <option>-cpp</option>)</entry>
574               <entry><option>-E</option></entry>
575               <entry><literal>.hspp</literal></entry>
576             </row>
577             
578             <row>
579               <entry>Haskell compiler</entry>
580               <entry><literal>.hs</literal></entry>
581               <entry><option>-C</option>, <option>-S</option></entry>
582               <entry><literal>.hc</literal>, <literal>.s</literal></entry>
583             </row>
584             
585             <row>
586               <entry>C compiler (opt.)</entry>
587               <entry><literal>.hc</literal> or <literal>.c</literal></entry>
588               <entry><option>-S</option></entry>
589               <entry><literal>.s</literal></entry>
590             </row>
591             
592             <row>
593               <entry>assembler</entry>
594               <entry><literal>.s</literal></entry>
595               <entry><option>-c</option></entry>
596               <entry><literal>.o</literal></entry>
597             </row>
598             
599             <row>
600               <entry>linker</entry>
601               <entry><replaceable>other</replaceable></entry>
602               <entry>-</entry>
603               <entry><filename>a.out</filename></entry>
604             </row>
605           </tbody>
606         </tgroup>
607       </informaltable>
608       
609       <indexterm><primary><option>-C</option></primary></indexterm>
610       <indexterm><primary><option>-E</option></primary></indexterm>
611       <indexterm><primary><option>-S</option></primary></indexterm>
612       <indexterm><primary><option>-c</option></primary></indexterm>
613       
614       <para>Thus, a common invocation would be: </para>
615
616 <screen>
617 ghc -c Foo.hs</screen>
618       
619       <para>to compile the Haskell source file
620       <filename>Foo.hs</filename> to an object file
621       <filename>Foo.o</filename>.</para>
622
623       <para>Note: What the Haskell compiler proper produces depends on
624       whether a native-code generator<indexterm><primary>native-code
625       generator</primary></indexterm> is used (producing assembly
626       language) or not (producing C).  See <xref
627       linkend="options-codegen"/> for more details.</para>
628
629       <para>Note: C pre-processing is optional, the
630       <option>-cpp</option><indexterm><primary><option>-cpp</option></primary></indexterm>
631       flag turns it on.  See <xref linkend="c-pre-processor"/> for more
632       details.</para>
633       
634       <para>Note: The option <option>-E</option><indexterm><primary>-E
635       option</primary></indexterm> runs just the pre-processing passes
636       of the compiler, dumping the result in a file.</para>
637
638       <sect3 id="overriding-suffixes">
639         <title>Overriding the default behaviour for a file</title>
640
641         <para>As described above, the way in which a file is processed by GHC
642           depends on its suffix.  This behaviour can be overriden using the
643           <option>-x</option> option:</para>
644
645         <variablelist>
646           <varlistentry>
647             <term><option>-x</option> <replaceable>suffix</replaceable>
648                       <indexterm><primary><option>-x</option></primary>
649               </indexterm></term>
650               <listitem>
651                 <para>Causes all files following this option on the command
652                   line to be processed as if they had the suffix
653                   <replaceable>suffix</replaceable>.  For example, to compile a
654                   Haskell module in the file <literal>M.my-hs</literal>,
655                   use <literal>ghc -c -x hs M.my-hs</literal>.</para>
656               </listitem>
657           </varlistentry>
658         </variablelist>
659       </sect3>
660
661     </sect2>
662   </sect1>
663
664   <sect1 id="options-help">
665     <title>Help and verbosity options</title>
666
667     <indexterm><primary>help options</primary></indexterm>
668     <indexterm><primary>verbosity options</primary></indexterm>
669
670     <para>See also the <option>--help</option>, <option>--version</option>, <option>--numeric-version</option>,
671     and <option>--print-libdir</option> modes in <xref linkend="modes"/>.</para>
672     <variablelist>
673       <varlistentry>
674         <term>
675           <option>-n</option>
676           <indexterm><primary><option>-n</option></primary></indexterm>
677         </term>
678         <listitem>
679           <para>Does a dry-run, i.e. GHC goes through all the motions
680           of compiling as normal, but does not actually run any
681           external commands.</para>
682         </listitem>
683       </varlistentry>
684
685       <varlistentry>
686         <term>
687           <option>-v</option>
688           <indexterm><primary><option>-v</option></primary></indexterm>
689         </term>
690         <listitem>
691           <para>The <option>-v</option> option makes GHC
692           <emphasis>verbose</emphasis>: it reports its version number
693           and shows (on stderr) exactly how it invokes each phase of
694           the compilation system.  Moreover, it passes the
695           <option>-v</option> flag to most phases; each reports its
696           version number (and possibly some other information).</para>
697
698           <para>Please, oh please, use the <option>-v</option> option
699           when reporting bugs!  Knowing that you ran the right bits in
700           the right order is always the first thing we want to
701           verify.</para>
702         </listitem>
703       </varlistentry>
704         
705       <varlistentry>
706         <term>
707           <option>-v</option><replaceable>n</replaceable>
708           <indexterm><primary><option>-v</option></primary></indexterm>
709         </term>
710         <listitem>
711           <para>To provide more control over the compiler's verbosity,
712           the <option>-v</option> flag takes an optional numeric
713           argument.  Specifying <option>-v</option> on its own is
714           equivalent to <option>-v3</option>, and the other levels
715           have the following meanings:</para>
716           
717           <variablelist>
718             <varlistentry>
719               <term><option>-v0</option></term>
720               <listitem>
721                 <para>Disable all non-essential messages (this is the
722                 default).</para>
723               </listitem>
724             </varlistentry>
725
726             <varlistentry>
727               <term><option>-v1</option></term>
728               <listitem>
729                 <para>Minimal verbosity: print one line per
730                 compilation (this is the default when
731                 <option>&ndash;&ndash;make</option> or
732                 <option>&ndash;&ndash;interactive</option> is on).</para>
733               </listitem>
734             </varlistentry>
735
736             <varlistentry>
737               <term><option>-v2</option></term>
738               <listitem>
739                 <para>Print the name of each compilation phase as it
740                 is executed. (equivalent to
741                 <option>-dshow-passes</option>).</para>
742               </listitem>
743             </varlistentry>
744
745             <varlistentry>
746               <term><option>-v3</option></term>
747               <listitem>
748                 <para>The same as <option>-v2</option>, except that in
749                 addition the full command line (if appropriate) for
750                 each compilation phase is also printed.</para>
751               </listitem>
752             </varlistentry>
753
754             <varlistentry>
755               <term><option>-v4</option></term>
756               <listitem>
757                 <para>The same as <option>-v3</option> except that the
758                 intermediate program representation after each
759                 compilation phase is also printed (excluding
760                 preprocessed and C/assembly files).</para>
761               </listitem>
762             </varlistentry>
763           </variablelist>
764         </listitem>
765       </varlistentry>
766       
767       <varlistentry>
768         <term><option>-ferror-spans</option>
769           <indexterm><primary><option>-ferror-spans</option></primary>
770           </indexterm>
771         </term>
772         <listitem>
773           <para>Causes GHC to emit the full source span of the
774           syntactic entity relating to an error message.  Normally, GHC
775           emits the source location of the start of the syntactic
776           entity only.</para>
777
778           <para>For example:</para>
779
780 <screen>test.hs:3:6: parse error on input `where'</screen>
781
782           <para>becomes:</para>
783
784 <screen>test296.hs:3:6-10: parse error on input `where'</screen>
785
786           <para>And multi-line spans are possible too:</para>
787
788 <screen>test.hs:(5,4)-(6,7):
789     Conflicting definitions for `a'
790     Bound at: test.hs:5:4
791               test.hs:6:7
792     In the binding group for: a, b, a</screen>
793
794           <para>Note that line numbers start counting at one, but
795           column numbers start at zero.  This choice was made to
796           follow existing convention (i.e. this is how Emacs does
797           it).</para>
798         </listitem>
799       </varlistentry>
800
801       <varlistentry>
802         <term><option>-H</option><replaceable>size</replaceable>
803         <indexterm><primary><option>-H</option></primary></indexterm>
804         </term>
805         <listitem>
806           <para>Set the minimum size of the heap to
807           <replaceable>size</replaceable>.
808           This option is equivalent to
809           <literal>+RTS&nbsp;-H<replaceable>size</replaceable></literal>,
810           see <xref linkend="rts-options-gc" />.
811           </para>
812         </listitem>
813       </varlistentry>
814
815       <varlistentry>
816         <term><option>-Rghc-timing</option>
817         <indexterm><primary><option>-Rghc-timing</option></primary></indexterm>
818         </term>
819         <listitem>
820           <para>Prints a one-line summary of timing statistics for the
821           GHC run.  This option is equivalent to
822           <literal>+RTS&nbsp;-tstderr</literal>, see <xref
823           linkend="rts-options-gc" />.
824           </para>
825         </listitem>
826       </varlistentry>
827     </variablelist>
828   </sect1>
829
830   &separate;
831
832   <sect1 id="options-sanity">
833     <title>Warnings and sanity-checking</title>
834
835     <indexterm><primary>sanity-checking options</primary></indexterm>
836     <indexterm><primary>warnings</primary></indexterm>
837
838
839     <para>GHC has a number of options that select which types of
840     non-fatal error messages, otherwise known as warnings, can be
841     generated during compilation.  By default, you get a standard set
842     of warnings which are generally likely to indicate bugs in your
843     program.  These are:
844     <option>-fwarn-overlapping-patterns</option>,
845     <option>-fwarn-deprecations</option>,
846     <option>-fwarn-duplicate-exports</option>,
847     <option>-fwarn-missing-fields</option>, and
848     <option>-fwarn-missing-methods</option>.  The following flags are
849     simple ways to select standard &ldquo;packages&rdquo; of warnings:
850     </para>
851
852     <variablelist>
853
854       <varlistentry>
855         <term><option>-W</option>:</term>
856         <listitem>
857           <indexterm><primary>-W option</primary></indexterm>
858           <para>Provides the standard warnings plus
859           <option>-fwarn-incomplete-patterns</option>,
860           <option>-fwarn-dodgy-imports</option>,
861           <option>-fwarn-unused-matches</option>,
862           <option>-fwarn-unused-imports</option>, and
863           <option>-fwarn-unused-binds</option>.</para>
864         </listitem>
865       </varlistentry>
866
867       <varlistentry>
868         <term><option>-Wall</option>:</term>
869         <listitem>
870           <indexterm><primary><option>-Wall</option></primary></indexterm>
871           <para>Turns on all warning options that indicate potentially
872           suspicious code.  The warnings that are
873           <emphasis>not</emphasis> enabled by <option>-Wall</option>
874           are
875             <option>-fwarn-simple-patterns</option>,
876             <option>-fwarn-tabs</option>,
877             <option>-fwarn-incomplete-record-updates</option>,
878             <option>-fwarn-monomorphism-restriction</option>, and
879             <option>-fwarn-implicit-prelude</option>.</para>
880         </listitem>
881       </varlistentry>
882
883       <varlistentry>
884         <term><option>-w</option>:</term>
885         <listitem>
886           <indexterm><primary><option>-w</option></primary></indexterm>
887           <para>Turns off all warnings, including the standard ones and
888       those that <literal>-Wall</literal> doesn't enable.</para>
889         </listitem>
890       </varlistentry>
891
892       <varlistentry>
893         <term><option>-Werror</option>:</term>
894         <listitem>
895           <indexterm><primary><option>-Werror</option></primary></indexterm>
896           <para>Makes any warning into a fatal error. Useful so that you don't 
897             miss warnings when doing batch compilation. </para>
898         </listitem>
899       </varlistentry>
900
901     </variablelist>
902
903     <para>The full set of warning options is described below.  To turn
904     off any warning, simply give the corresponding
905     <option>-fno-warn-...</option> option on the command line.</para>
906
907     <variablelist>
908
909       <varlistentry>
910         <term><option>-fwarn-deprecations</option>:</term>
911         <listitem>
912           <indexterm><primary><option>-fwarn-deprecations</option></primary>
913           </indexterm>
914           <indexterm><primary>deprecations</primary></indexterm>
915           <para>Causes a warning to be emitted when a deprecated
916           function or type is used.  Entities can be marked as
917           deprecated using a pragma, see <xref
918           linkend="deprecated-pragma"/>.</para>
919
920           <para>This option is on by default.</para>
921         </listitem>
922       </varlistentry>
923
924       <varlistentry>
925         <term><option>-fwarn-dodgy-imports</option>:</term>
926         <listitem>
927           <indexterm><primary><option>-fwarn-dodgy-imports</option></primary>
928           </indexterm>
929           <para>Causes a warning to be emitted when a a datatype
930       <literal>T</literal> is imported
931       with all constructors, i.e. <literal>T(..)</literal>, but has been
932       exported abstractly, i.e. <literal>T</literal>.</para>
933         </listitem>
934       </varlistentry>
935
936       <varlistentry>
937         <term><option>-fwarn-duplicate-exports</option>:</term>
938         <listitem>
939           <indexterm><primary><option>-fwarn-duplicate-exports</option></primary></indexterm>
940           <indexterm><primary>duplicate exports, warning</primary></indexterm>
941           <indexterm><primary>export lists, duplicates</primary></indexterm>
942
943           <para>Have the compiler warn about duplicate entries in
944           export lists. This is useful information if you maintain
945           large export lists, and want to avoid the continued export
946           of a definition after you've deleted (one) mention of it in
947           the export list.</para>
948
949           <para>This option is on by default.</para>
950         </listitem>
951       </varlistentry>
952
953       <varlistentry>
954         <term><option>-fwarn-hi-shadowing</option>:</term>
955         <listitem>
956           <indexterm><primary><option>-fwarn-hi-shadowing</option></primary></indexterm>
957           <indexterm><primary>shadowing</primary>
958             <secondary>interface files</secondary></indexterm>
959
960           <para>Causes the compiler to emit a warning when a module or
961           interface file in the current directory is shadowing one
962           with the same module name in a library or other
963           directory.</para>
964         </listitem>
965       </varlistentry>
966
967       <varlistentry>
968         <term><option>-fwarn-implicit-prelude</option>:</term>
969         <listitem>
970           <indexterm><primary><option>-fwarn-implicit-prelude</option></primary></indexterm>
971           <indexterm><primary>implicit prelude, warning</primary></indexterm>
972           <para>Have the compiler warn if the Prelude is implicitly
973           imported.  This happens unless either the Prelude module is
974           explicitly imported with an <literal>import ... Prelude ...</literal>
975           line, or this implicit import is disabled (either by
976           <option>-fno-implicit-prelude</option> or a
977           <literal>LANGUAGE NoImplicitPrelude</literal> pragma).</para>
978
979           <para>Note that no warning is given for syntax that implicitly
980           refers to the Prelude, even if <option>-fno-implicit-prelude</option>
981           would change whether it refers to the Prelude.
982           For example, no warning is given when
983           <literal>368</literal> means
984           <literal>Prelude.fromInteger (368::Prelude.Integer)</literal>
985           (where <literal>Prelude</literal> refers to the actual Prelude module,
986           regardless of the imports of the module being compiled).</para>
987
988           <para>This warning is off by default.</para>
989         </listitem>
990       </varlistentry>
991
992       <varlistentry>
993         <term><option>-fwarn-incomplete-patterns</option>:</term>
994         <listitem>
995           <indexterm><primary><option>-fwarn-incomplete-patterns</option></primary></indexterm>
996           <indexterm><primary>incomplete patterns, warning</primary></indexterm>
997           <indexterm><primary>patterns, incomplete</primary></indexterm>
998
999           <para>Similarly for incomplete patterns, the function
1000           <function>g</function> below will fail when applied to
1001           non-empty lists, so the compiler will emit a warning about
1002           this when <option>-fwarn-incomplete-patterns</option> is
1003           enabled.</para>
1004
1005 <programlisting>
1006 g [] = 2
1007 </programlisting>
1008
1009           <para>This option isn't enabled by default because it can be
1010           a bit noisy, and it doesn't always indicate a bug in the
1011           program.  However, it's generally considered good practice
1012           to cover all the cases in your functions.</para>
1013         </listitem>
1014       </varlistentry>
1015
1016       <varlistentry>
1017         <term><option>-fwarn-incomplete-record-updates</option>:</term>
1018         <listitem>
1019           <indexterm><primary><option>-fwarn-incomplete-record-updates</option></primary></indexterm>
1020           <indexterm><primary>incomplete record updates, warning</primary></indexterm>
1021           <indexterm><primary>record updates, incomplete</primary></indexterm>
1022
1023           <para>The function
1024           <function>f</function> below will fail when applied to
1025           <literal>Bar</literal>, so the compiler will emit a warning about
1026           this when <option>-fwarn-incomplete-record-updates</option> is
1027           enabled.</para>
1028
1029 <programlisting>
1030 data Foo = Foo { x :: Int }
1031          | Bar
1032
1033 f :: Foo -> Foo
1034 f foo = foo { x = 6 }
1035 </programlisting>
1036
1037           <para>This option isn't enabled by default because it can be
1038           very noisy, and it often doesn't indicate a bug in the
1039           program.</para>
1040         </listitem>
1041       </varlistentry>
1042
1043       <varlistentry>
1044         <term>
1045           <option>-fwarn-missing-fields</option>:
1046           <indexterm><primary><option>-fwarn-missing-fields</option></primary></indexterm>
1047           <indexterm><primary>missing fields, warning</primary></indexterm>
1048           <indexterm><primary>fields, missing</primary></indexterm>
1049         </term>
1050         <listitem>
1051
1052           <para>This option is on by default, and warns you whenever
1053           the construction of a labelled field constructor isn't
1054           complete, missing initializers for one or more fields. While
1055           not an error (the missing fields are initialised with
1056           bottoms), it is often an indication of a programmer error.</para>
1057         </listitem>
1058       </varlistentry>
1059
1060       <varlistentry>
1061         <term><option>-fwarn-missing-methods</option>:</term>
1062         <listitem>
1063           <indexterm><primary><option>-fwarn-missing-methods</option></primary></indexterm>
1064           <indexterm><primary>missing methods, warning</primary></indexterm>
1065           <indexterm><primary>methods, missing</primary></indexterm>
1066
1067           <para>This option is on by default, and warns you whenever
1068           an instance declaration is missing one or more methods, and
1069           the corresponding class declaration has no default
1070           declaration for them.</para>
1071           <para>The warning is suppressed if the method name
1072           begins with an underscore.  Here's an example where this is useful:
1073             <programlisting>
1074               class C a where
1075                 _simpleFn :: a -> String
1076                 complexFn :: a -> a -> String
1077                 complexFn x y = ... _simpleFn ...
1078               </programlisting>
1079             The idea is that: (a) users of the class will only call <literal>complexFn</literal>; 
1080             never <literal>_simpleFn</literal>; and (b)
1081             instance declarations can define either <literal>complexFn</literal> or <literal>_simpleFn</literal>.
1082             </para>
1083         </listitem>
1084       </varlistentry>
1085
1086       <varlistentry>
1087         <term><option>-fwarn-missing-signatures</option>:</term>
1088         <listitem>
1089           <indexterm><primary><option>-fwarn-missing-signatures</option></primary></indexterm>
1090           <indexterm><primary>type signatures, missing</primary></indexterm>
1091
1092           <para>If you would like GHC to check that every top-level
1093           function/value has a type signature, use the
1094           <option>-fwarn-missing-signatures</option> option.  As part of
1095             the warning GHC also reports the inferred type.  The
1096           option is off by default.</para>
1097         </listitem>
1098       </varlistentry>
1099
1100       <varlistentry>
1101         <term><option>-fwarn-name-shadowing</option>:</term>
1102         <listitem>
1103           <indexterm><primary><option>-fwarn-name-shadowing</option></primary></indexterm>
1104           <indexterm><primary>shadowing, warning</primary></indexterm>
1105           
1106           <para>This option causes a warning to be emitted whenever an
1107           inner-scope value has the same name as an outer-scope value,
1108           i.e. the inner value shadows the outer one.  This can catch
1109           typographical errors that turn into hard-to-find bugs, e.g.,
1110           in the inadvertent capture of what would be a recursive call in
1111           <literal>f = ... let f = id in ... f ...</literal>.</para>
1112         </listitem>
1113       </varlistentry>
1114
1115       <varlistentry>
1116         <term><option>-fwarn-orphans</option>:</term>
1117         <listitem>
1118           <indexterm><primary><option>-fwarn-orphans</option></primary></indexterm>
1119           <indexterm><primary>orphan instances, warning</primary></indexterm>
1120           <indexterm><primary>orphan rules, warning</primary></indexterm>
1121           
1122           <para>This option causes a warning to be emitted whenever the 
1123             module contains an "orphan" instance declaration or rewrite rule.
1124             An instance declartion is an orphan if it appears in a module in
1125             which neither the class nor the type being instanced are declared
1126             in the same module.  A rule is an orphan if it is a rule for a
1127             function declared in another module.  A module containing any
1128           orphans is called an orphan module.</para>
1129           <para>The trouble with orphans is that GHC must pro-actively read the interface
1130             files for all orphan modules, just in case their instances or rules
1131             play a role, whether or not the module's interface would otherwise 
1132             be of any use.  Other things being equal, avoid orphan modules.</para>
1133         </listitem>
1134       </varlistentry>
1135
1136       <varlistentry>
1137         <term>
1138           <option>-fwarn-overlapping-patterns</option>:
1139           <indexterm><primary><option>-fwarn-overlapping-patterns</option></primary></indexterm>
1140           <indexterm><primary>overlapping patterns, warning</primary></indexterm>
1141           <indexterm><primary>patterns, overlapping</primary></indexterm>
1142         </term>
1143         <listitem>
1144           <para>By default, the compiler will warn you if a set of
1145           patterns are overlapping, e.g.,</para>
1146
1147 <programlisting>
1148 f :: String -&#62; Int
1149 f []     = 0
1150 f (_:xs) = 1
1151 f "2"    = 2
1152 </programlisting>
1153
1154           <para>where the last pattern match in <function>f</function>
1155           won't ever be reached, as the second pattern overlaps
1156           it. More often than not, redundant patterns is a programmer
1157           mistake/error, so this option is enabled by default.</para>
1158         </listitem>
1159       </varlistentry>
1160
1161       <varlistentry>
1162         <term><option>-fwarn-simple-patterns</option>:</term>
1163         <listitem>
1164           <indexterm><primary><option>-fwarn-simple-patterns</option></primary>
1165           </indexterm>
1166           <para>Causes the compiler to warn about lambda-bound
1167           patterns that can fail, eg. <literal>\(x:xs)->...</literal>.
1168           Normally, these aren't treated as incomplete patterns by
1169           <option>-fwarn-incomplete-patterns</option>.</para>
1170           <para>&ldquo;Lambda-bound patterns&rdquo; includes all places where there is a single pattern,
1171             including list comprehensions and do-notation.  In these cases, a pattern-match 
1172             failure is quite legitimate, and triggers filtering (list comprehensions) or
1173             the monad <literal>fail</literal> operation (monads). For example:
1174             <programlisting>
1175               f :: [Maybe a] -> [a]
1176               f xs = [y | Just y &lt;- xs]
1177               </programlisting>
1178             Switching on <option>-fwarn-simple-patterns</option> will elicit warnings about
1179             these probably-innocent cases, which is why the flag is off by default. </para>
1180         </listitem>
1181       </varlistentry>
1182
1183       <varlistentry>
1184         <term><option>-fwarn-tabs</option>:</term>
1185         <listitem>
1186           <indexterm><primary><option>-fwarn-tabs</option></primary></indexterm>
1187           <indexterm><primary>tabs, warning</primary></indexterm>
1188           <para>Have the compiler warn if there are tabs in your source
1189           file.</para>
1190
1191           <para>This warning is off by default.</para>
1192         </listitem>
1193       </varlistentry>
1194
1195       <varlistentry>
1196         <term><option>-fwarn-type-defaults</option>:</term>
1197         <listitem>
1198           <indexterm><primary><option>-fwarn-type-defaults</option></primary></indexterm>
1199           <indexterm><primary>defaulting mechanism, warning</primary></indexterm>
1200           <para>Have the compiler warn/inform you where in your source
1201           the Haskell defaulting mechanism for numeric types kicks
1202           in. This is useful information when converting code from a
1203           context that assumed one default into one with another,
1204           e.g., the &lsquo;default default&rsquo; for Haskell 1.4 caused the
1205           otherwise unconstrained value <constant>1</constant> to be
1206           given the type <literal>Int</literal>, whereas Haskell 98
1207           defaults it to <literal>Integer</literal>.  This may lead to
1208           differences in performance and behaviour, hence the
1209           usefulness of being non-silent about this.</para>
1210
1211           <para>This warning is off by default.</para>
1212         </listitem>
1213       </varlistentry>
1214
1215       <varlistentry>
1216         <term><option>-fwarn-monomorphism-restriction</option>:</term>
1217         <listitem>
1218           <indexterm><primary><option>-fwarn-monomorphism-restriction</option></primary></indexterm>
1219           <indexterm><primary>monomorphism restriction, warning</primary></indexterm>
1220           <para>Have the compiler warn/inform you where in your source
1221           the Haskell Monomorphism Restriction is applied.  If applied silently
1222           the MR can give rise to unexpected behaviour, so it can be helpful
1223           to have an explicit warning that it is being applied.</para>
1224
1225           <para>This warning is off by default.</para>
1226         </listitem>
1227       </varlistentry>
1228
1229       <varlistentry>
1230         <term><option>-fwarn-unused-binds</option>:</term>
1231         <listitem>
1232           <indexterm><primary><option>-fwarn-unused-binds</option></primary></indexterm>
1233           <indexterm><primary>unused binds, warning</primary></indexterm>
1234           <indexterm><primary>binds, unused</primary></indexterm>
1235           <para>Report any function definitions (and local bindings)
1236           which are unused.  For top-level functions, the warning is
1237           only given if the binding is not exported.</para>
1238           <para>A definition is regarded as "used" if (a) it is exported, or (b) it is
1239             mentioned in the right hand side of another definition that is used, or (c) the 
1240             function it defines begins with an underscore.  The last case provides a 
1241             way to suppress unused-binding warnings selectively.  </para>
1242           <para> Notice that a variable
1243             is reported as unused even if it appears in the right-hand side of another
1244             unused binding. </para>
1245         </listitem>
1246       </varlistentry>
1247
1248       <varlistentry>
1249         <term><option>-fwarn-unused-imports</option>:</term>
1250         <listitem>
1251           <indexterm><primary><option>-fwarn-unused-imports</option></primary></indexterm>
1252           <indexterm><primary>unused imports, warning</primary></indexterm>
1253           <indexterm><primary>imports, unused</primary></indexterm>
1254
1255           <para>Report any modules that are explicitly imported but
1256           never used.  However, the form <literal>import M()</literal> is
1257           never reported as an unused import, because it is a useful idiom
1258           for importing instance declarations, which are anonymous in Haskell.</para>
1259         </listitem>
1260       </varlistentry>
1261
1262       <varlistentry>
1263         <term><option>-fwarn-unused-matches</option>:</term>
1264         <listitem>
1265           <indexterm><primary><option>-fwarn-unused-matches</option></primary></indexterm>
1266           <indexterm><primary>unused matches, warning</primary></indexterm>
1267           <indexterm><primary>matches, unused</primary></indexterm>
1268
1269           <para>Report all unused variables which arise from pattern
1270           matches, including patterns consisting of a single variable.
1271           For instance <literal>f x y = []</literal> would report
1272           <varname>x</varname> and <varname>y</varname> as unused.  The
1273           warning is suppressed if the variable name begins with an underscore, thus:
1274             <programlisting>
1275                f _x = True
1276             </programlisting>
1277           </para>
1278         </listitem>
1279       </varlistentry>
1280
1281     </variablelist>
1282
1283     <para>If you're feeling really paranoid, the
1284     <option>-dcore-lint</option>
1285     option<indexterm><primary><option>-dcore-lint</option></primary></indexterm>
1286     is a good choice.  It turns on heavyweight intra-pass
1287     sanity-checking within GHC.  (It checks GHC's sanity, not
1288     yours.)</para>
1289
1290   </sect1>
1291
1292   &packages;
1293
1294   <sect1 id="options-optimise">
1295     <title>Optimisation (code improvement)</title>
1296
1297     <indexterm><primary>optimisation</primary></indexterm>
1298     <indexterm><primary>improvement, code</primary></indexterm>
1299
1300     <para>The <option>-O*</option> options specify convenient
1301     &ldquo;packages&rdquo; of optimisation flags; the
1302     <option>-f*</option> options described later on specify
1303     <emphasis>individual</emphasis> optimisations to be turned on/off;
1304     the <option>-m*</option> options specify
1305     <emphasis>machine-specific</emphasis> optimisations to be turned
1306     on/off.</para>
1307
1308     <sect2 id="optimise-pkgs">
1309       <title><option>-O*</option>: convenient &ldquo;packages&rdquo; of optimisation flags.</title>
1310
1311       <para>There are <emphasis>many</emphasis> options that affect
1312       the quality of code produced by GHC.  Most people only have a
1313       general goal, something like &ldquo;Compile quickly&rdquo; or
1314       &ldquo;Make my program run like greased lightning.&rdquo; The
1315       following &ldquo;packages&rdquo; of optimisations (or lack
1316       thereof) should suffice.</para>
1317
1318       <para>Note that higher optimisation levels cause more
1319       cross-module optimisation to be performed, which can have an
1320       impact on how much of your program needs to be recompiled when
1321       you change something.  This is one reason to stick to
1322       no-optimisation when developing code.</para>
1323
1324       <variablelist>
1325
1326         <varlistentry>
1327           <term>
1328             No <option>-O*</option>-type option specified:
1329             <indexterm><primary>-O* not specified</primary></indexterm>
1330           </term>
1331           <listitem>
1332             <para>This is taken to mean: &ldquo;Please compile
1333             quickly; I'm not over-bothered about compiled-code
1334             quality.&rdquo; So, for example: <command>ghc -c
1335             Foo.hs</command></para>
1336           </listitem>
1337         </varlistentry>
1338
1339         <varlistentry>
1340           <term>
1341             <option>-O0</option>:
1342             <indexterm><primary><option>-O0</option></primary></indexterm>
1343           </term>
1344           <listitem>
1345             <para>Means &ldquo;turn off all optimisation&rdquo;,
1346             reverting to the same settings as if no
1347             <option>-O</option> options had been specified.  Saying
1348             <option>-O0</option> can be useful if
1349             eg. <command>make</command> has inserted a
1350             <option>-O</option> on the command line already.</para>
1351           </listitem>
1352         </varlistentry>
1353
1354         <varlistentry>
1355           <term>
1356             <option>-O</option> or <option>-O1</option>:
1357             <indexterm><primary>-O option</primary></indexterm>
1358             <indexterm><primary>-O1 option</primary></indexterm>
1359             <indexterm><primary>optimise</primary><secondary>normally</secondary></indexterm>
1360           </term>
1361           <listitem>
1362             <para>Means: &ldquo;Generate good-quality code without
1363             taking too long about it.&rdquo; Thus, for example:
1364             <command>ghc -c -O Main.lhs</command></para>
1365           </listitem>
1366         </varlistentry>
1367
1368         <varlistentry>
1369           <term>
1370             <option>-O2</option>:
1371             <indexterm><primary>-O2 option</primary></indexterm>
1372             <indexterm><primary>optimise</primary><secondary>aggressively</secondary></indexterm>
1373           </term>
1374           <listitem>
1375             <para>Means: &ldquo;Apply every non-dangerous
1376             optimisation, even if it means significantly longer
1377             compile times.&rdquo;</para>
1378
1379             <para>The avoided &ldquo;dangerous&rdquo; optimisations
1380             are those that can make runtime or space
1381             <emphasis>worse</emphasis> if you're unlucky.  They are
1382             normally turned on or off individually.</para>
1383
1384             <para>At the moment, <option>-O2</option> is
1385             <emphasis>unlikely</emphasis> to produce better code than
1386             <option>-O</option>.</para>
1387           </listitem>
1388         </varlistentry>
1389
1390         <varlistentry>
1391           <term>
1392             <option>-Ofile &lt;file&gt;</option>:
1393             <indexterm><primary>-Ofile &lt;file&gt; option</primary></indexterm>
1394             <indexterm><primary>optimising, customised</primary></indexterm>
1395           </term>
1396           <listitem>
1397             <para>(NOTE: not supported since GHC 4.x.  Please ask if
1398             you're interested in this.)</para>
1399             
1400             <para>For those who need <emphasis>absolute</emphasis>
1401             control over <emphasis>exactly</emphasis> what options are
1402             used (e.g., compiler writers, sometimes :-), a list of
1403             options can be put in a file and then slurped in with
1404             <option>-Ofile</option>.</para>
1405
1406             <para>In that file, comments are of the
1407             <literal>&num;</literal>-to-end-of-line variety; blank
1408             lines and most whitespace is ignored.</para>
1409
1410             <para>Please ask if you are baffled and would like an
1411             example of <option>-Ofile</option>!</para>
1412           </listitem>
1413         </varlistentry>
1414       </variablelist>
1415
1416       <para>We don't use a <option>-O*</option> flag for day-to-day
1417       work.  We use <option>-O</option> to get respectable speed;
1418       e.g., when we want to measure something.  When we want to go for
1419       broke, we tend to use <option>-O2 -fvia-C</option> (and we go for
1420       lots of coffee breaks).</para>
1421
1422       <para>The easiest way to see what <option>-O</option> (etc.)
1423       &ldquo;really mean&rdquo; is to run with <option>-v</option>,
1424       then stand back in amazement.</para>
1425     </sect2>
1426
1427     <sect2 id="options-f">
1428       <title><option>-f*</option>: platform-independent flags</title>
1429
1430       <indexterm><primary>-f* options (GHC)</primary></indexterm>
1431       <indexterm><primary>-fno-* options (GHC)</primary></indexterm>
1432
1433       <para>These flags turn on and off individual optimisations.
1434       They are normally set via the <option>-O</option> options
1435       described above, and as such, you shouldn't need to set any of
1436       them explicitly (indeed, doing so could lead to unexpected
1437       results).  However, there are one or two that may be of
1438       interest:</para>
1439
1440       <variablelist>
1441         <varlistentry>
1442           <term><option>-fexcess-precision</option>:</term>
1443           <listitem>
1444             <indexterm><primary><option>-fexcess-precision</option></primary></indexterm>
1445             <para>When this option is given, intermediate floating
1446             point values can have a <emphasis>greater</emphasis>
1447             precision/range than the final type.  Generally this is a
1448             good thing, but some programs may rely on the exact
1449             precision/range of
1450             <literal>Float</literal>/<literal>Double</literal> values
1451             and should not use this option for their compilation.</para>
1452           </listitem>
1453         </varlistentry>
1454
1455         <varlistentry>
1456           <term><option>-fignore-asserts</option>:</term>
1457           <listitem>
1458             <indexterm><primary><option>-fignore-asserts</option></primary></indexterm>
1459             <para>Causes GHC to ignore uses of the function
1460             <literal>Exception.assert</literal> in source code (in
1461             other words, rewriting <literal>Exception.assert p
1462             e</literal> to <literal>e</literal> (see <xref
1463             linkend="assertions"/>).  This flag is turned on by
1464             <option>-O</option>.
1465             </para>
1466           </listitem>
1467         </varlistentry>
1468
1469         <varlistentry>
1470           <term>
1471             <option>-fno-cse</option>
1472             <indexterm><primary><option>-fno-cse</option></primary></indexterm>
1473           </term>
1474           <listitem>
1475             <para>Turns off the common-sub-expression elimination optimisation.
1476               Can be useful if you have some <literal>unsafePerformIO</literal>
1477             expressions that you don't want commoned-up.</para>
1478           </listitem>
1479         </varlistentry>
1480
1481         <varlistentry>
1482           <term>
1483             <option>-fno-strictness</option>
1484             <indexterm><primary><option>-fno-strictness</option></primary></indexterm>
1485           </term>
1486           <listitem>
1487             <para>Turns off the strictness analyser; sometimes it eats
1488             too many cycles.</para>
1489           </listitem>
1490         </varlistentry>
1491
1492         <varlistentry>
1493           <term>
1494             <option>-fno-full-laziness</option>
1495             <indexterm><primary><option>-fno-full-laziness</option></primary></indexterm>
1496           </term>
1497           <listitem>
1498             <para>Turns off the full laziness optimisation (also known as
1499               let-floating).  Full laziness increases sharing, which can lead
1500               to increased memory residency.</para>
1501
1502             <para>NOTE: GHC doesn't implement complete full-laziness.
1503             When optimisation in on, and
1504             <option>-fno-full-laziness</option> is not given, some
1505             transformations that increase sharing are performed, such
1506             as extracting repeated computations from a loop.  These
1507             are the same transformations that a fully lazy
1508             implementation would do, the difference is that GHC
1509             doesn't consistently apply full-laziness, so don't rely on
1510             it.</para>
1511           </listitem>
1512         </varlistentry>
1513
1514         <varlistentry>
1515           <term>
1516             <option>-fno-state-hack</option>
1517             <indexterm><primary><option>-fno-state-hack</option></primary></indexterm>
1518           </term>
1519           <listitem>
1520             <para>Turn off the "state hack" whereby any lambda with a
1521               <literal>State#</literal> token as argument is considered to be
1522               single-entry, hence it is considered OK to inline things inside
1523               it.  This can improve performance of IO and ST monad code, but it
1524             runs the risk of reducing sharing.</para> 
1525           </listitem>
1526         </varlistentry>
1527
1528         <varlistentry>
1529           <term>
1530             <option>-fno-state-hack</option>
1531             <indexterm><primary><option>-fno-state-hack</option></primary></indexterm>
1532           </term>
1533           <listitem>
1534             <para>Turn off the "state hack" whereby any lambda with a
1535               <literal>State#</literal> token as argument is considered to be
1536               single-entry, hence it is considered OK to inline things inside
1537               it.  This can improve performance of IO and ST monad code, but it
1538             runs the risk of reducing sharing.</para> 
1539           </listitem>
1540         </varlistentry>
1541
1542         <varlistentry>
1543           <term>
1544             <option>-fomit-interface-pragmas</option>
1545             <indexterm><primary><option>-fomit-interface-pragmas</option></primary></indexterm>
1546           </term>
1547           <listitem>
1548             <para>Tells GHC to omit all inessential information from the interface file
1549               generated for the module being compiled (say M).  This means that a module
1550               importing M will see only the <emphasis>types</emphasis> of the functions that M exports, but not
1551               their unfoldings, strictness info, etc.  Hence, for example,
1552               no function exported by M will be inlined
1553               into an importing module.  The benefit is that modules that import M will
1554               need to be recompiled less often (only when M's exports change their type,
1555               not when they change their implementation).
1556               </para>
1557           </listitem>
1558         </varlistentry>
1559
1560         <varlistentry>
1561           <term>
1562             <option>-fignore-interface-pragmas</option>
1563             <indexterm><primary><option>-fignore-interface-pragmas</option></primary></indexterm>
1564           </term>
1565           <listitem>
1566             <para>Tells GHC to ignore all inessential information when reading interface files.
1567             That is, even if <filename>M.hi</filename> contains unfolding or strictness information
1568             for a function, GHC will ignore that information.</para>
1569           </listitem>
1570         </varlistentry>
1571
1572         <varlistentry>
1573           <term>
1574             <option>-funbox-strict-fields</option>:
1575             <indexterm><primary><option>-funbox-strict-fields</option></primary></indexterm>
1576             <indexterm><primary>strict constructor fields</primary></indexterm>
1577             <indexterm><primary>constructor fields, strict</primary></indexterm>
1578           </term>
1579           <listitem>
1580             <para>This option causes all constructor fields which are
1581             marked strict (i.e. &ldquo;!&rdquo;) to be unboxed or
1582             unpacked if possible.  It is equivalent to adding an
1583             <literal>UNPACK</literal> pragma to every strict
1584             constructor field (see <xref
1585             linkend="unpack-pragma"/>).</para>
1586
1587             <para>This option is a bit of a sledgehammer: it might
1588             sometimes make things worse.  Selectively unboxing fields
1589             by using <literal>UNPACK</literal> pragmas might be
1590             better.</para>
1591           </listitem>
1592         </varlistentry>
1593
1594         <varlistentry>
1595           <term>
1596             <option>-funfolding-update-in-place=<replaceable>n</replaceable></option>
1597             <indexterm><primary><option>-funfolding-update-in-place</option></primary></indexterm>
1598           </term>
1599           <listitem>
1600             <para>Switches on an experimental "optimisation".
1601             Switching it on makes the compiler a little keener to
1602             inline a function that returns a constructor, if the
1603             context is that of a thunk.
1604 <programlisting>
1605    x = plusInt a b
1606 </programlisting>
1607             If we inlined plusInt we might get an opportunity to use
1608             update-in-place for the thunk 'x'.</para>
1609           </listitem>
1610         </varlistentry>
1611
1612         <varlistentry>
1613           <term>
1614             <option>-funfolding-creation-threshold=<replaceable>n</replaceable></option>:
1615             <indexterm><primary><option>-funfolding-creation-threshold</option></primary></indexterm>
1616             <indexterm><primary>inlining, controlling</primary></indexterm>
1617             <indexterm><primary>unfolding, controlling</primary></indexterm>
1618           </term>
1619           <listitem>
1620             <para>(Default: 45) Governs the maximum size that GHC will 
1621             allow a function unfolding to be.   (An unfolding has a
1622             &ldquo;size&rdquo; that reflects the cost in terms of
1623             &ldquo;code bloat&rdquo; of expanding that unfolding at
1624             at a call site. A bigger function would be assigned a
1625             bigger cost.) </para>
1626
1627             <para> Consequences: (a) nothing larger than this will be
1628             inlined (unless it has an INLINE pragma); (b) nothing
1629             larger than this will be spewed into an interface
1630             file. </para>
1631
1632
1633             <para> Increasing this figure is more likely to result in longer
1634             compile times than faster code.  The next option is more
1635             useful:</para>
1636           </listitem>
1637         </varlistentry>
1638
1639         <varlistentry>
1640           <term><option>-funfolding-use-threshold=<replaceable>n</replaceable></option></term>
1641           <listitem>
1642             <indexterm><primary><option>-funfolding-use-threshold</option></primary></indexterm>
1643             <indexterm><primary>inlining, controlling</primary></indexterm>
1644             <indexterm><primary>unfolding, controlling</primary></indexterm>
1645
1646             <para>(Default: 8) This is the magic cut-off figure for
1647             unfolding: below this size, a function definition will be
1648             unfolded at the call-site, any bigger and it won't.  The
1649             size computed for a function depends on two things: the
1650             actual size of the expression minus any discounts that
1651             apply (see <option>-funfolding-con-discount</option>).</para>
1652           </listitem>
1653         </varlistentry>
1654       </variablelist>
1655
1656     </sect2>
1657     
1658   </sect1>
1659   
1660   &phases;  
1661   
1662   <sect1 id="using-concurrent">
1663     <title>Using Concurrent Haskell</title>
1664     <indexterm><primary>Concurrent Haskell</primary><secondary>using</secondary></indexterm>
1665
1666     <para>GHC supports Concurrent Haskell by default, without requiring a
1667       special option or libraries compiled in a certain way.  To get access to
1668       the support libraries for Concurrent Haskell, just import
1669       <ulink
1670         url="../libraries/base/Control-Concurrent.html"><literal>Control.Concurrent</literal></ulink>.  More information on Concurrent Haskell is provided in the documentation for that module.</para>
1671
1672     <para>The following RTS option(s) affect the behaviour of Concurrent
1673       Haskell programs:<indexterm><primary>RTS options, concurrent</primary></indexterm></para>
1674
1675     <variablelist>
1676       <varlistentry>
1677         <term><option>-C<replaceable>s</replaceable></option></term>
1678         <listitem>
1679           <para><indexterm><primary><option>-C<replaceable>s</replaceable></option></primary><secondary>RTS option</secondary></indexterm>
1680             Sets the context switch interval to <replaceable>s</replaceable>
1681             seconds.  A context switch will occur at the next heap block
1682             allocation after the timer expires (a heap block allocation occurs
1683             every 4k of allocation).  With <option>-C0</option> or
1684             <option>-C</option>, context switches will occur as often as
1685             possible (at every heap block allocation).  By default, context
1686             switches occur every 20ms.</para>
1687         </listitem>
1688       </varlistentry>
1689     </variablelist>
1690   </sect1>
1691
1692   <sect1 id="using-smp">
1693     <title>Using SMP parallelism</title>
1694     <indexterm><primary>parallelism</primary>
1695     </indexterm>
1696     <indexterm><primary>SMP</primary>
1697     </indexterm>
1698
1699     <para>GHC supports running Haskell programs in parallel on an SMP
1700       (symmetric multiprocessor).</para>
1701
1702     <para>There's a fine distinction between
1703       <emphasis>concurrency</emphasis> and <emphasis>parallelism</emphasis>:
1704       parallelism is all about making your program run
1705       <emphasis>faster</emphasis> by making use of multiple processors
1706       simultaneously.  Concurrency, on the other hand, is a means of
1707       abstraction: it is a convenient way to structure a program that must
1708       respond to multiple asynchronous events.</para>
1709
1710     <para>However, the two terms are certainly related.  By making use of
1711       multiple CPUs it is possible to run concurrent threads in parallel,
1712       and this is exactly what GHC's SMP parallelism support does.  But it
1713       is also possible to obtain performance improvements with parallelism
1714       on programs that do not use concurrency.  This section describes how to
1715       use GHC to compile and run parallel programs, in <xref
1716         linkend="lang-parallel" /> we desribe the language features that affect
1717     parallelism.</para>
1718     
1719     <sect2 id="parallel-options">
1720       <title>Options to enable SMP parallelism</title>
1721
1722       <para>In order to make use of multiple CPUs, your program must be
1723         linked with the <option>-threaded</option> option (see <xref
1724           linkend="options-linker" />).  Then, to run a program on multiple
1725         CPUs, use the RTS <option>-N</option> option:</para>
1726       
1727       <variablelist>
1728         <varlistentry>
1729           <term><option>-N<replaceable>x</replaceable></option></term>
1730           <listitem>
1731             <para><indexterm><primary><option>-N<replaceable>x</replaceable></option></primary><secondary>RTS option</secondary></indexterm>
1732               Use <replaceable>x</replaceable> simultaneous threads when
1733               running the program.  Normally <replaceable>x</replaceable>
1734               should be chosen to match the number of CPU cores on the machine.
1735               There is no means (currently) by which this value may vary after
1736               the program has started.</para> 
1737             
1738             <para>For example, on a dual-core machine we would probably use
1739               <literal>+RTS -N2 -RTS</literal>.</para>
1740             
1741             <para>Whether hyperthreading cores should be counted or not is an
1742               open question; please feel free to experiment and let us know what
1743               results you find.</para>
1744           </listitem>
1745         </varlistentry>
1746       </variablelist>
1747     </sect2>
1748       
1749     <sect2>
1750       <title>Hints for using SMP parallelism</title>
1751
1752       <para>Add the <literal>-sstderr</literal> RTS option when
1753         running the program to see timing stats, which will help to tell you
1754         whether your program got faster by using more CPUs or not.  If the user
1755         time is greater than
1756         the elapsed time, then the program used more than one CPU.  You should
1757         also run the program without <literal>-N</literal> for comparison.</para>
1758
1759       <para>GHC's parallelism support is new and experimental.  It may make your
1760         program go faster, or it might slow it down - either way, we'd be
1761         interested to hear from you.</para>
1762       
1763       <para>One significant limitation with the current implementation is that
1764         the garbage collector is still single-threaded, and all execution must
1765         stop when GC takes place.  This can be a significant bottleneck in a
1766         parallel program, especially if your program does a lot of GC.  If this
1767         happens to you, then try reducing the cost of GC by tweaking the GC
1768         settings (<xref linkend="rts-options-gc" />): enlarging the heap or the
1769         allocation area size is a good start.</para>
1770     </sect2>
1771   </sect1>
1772
1773   <sect1 id="options-platform">
1774     <title>Platform-specific Flags</title>
1775
1776     <indexterm><primary>-m* options</primary></indexterm>
1777     <indexterm><primary>platform-specific options</primary></indexterm>
1778     <indexterm><primary>machine-specific options</primary></indexterm>
1779
1780     <para>Some flags only make sense for particular target
1781     platforms.</para>
1782
1783     <variablelist>
1784
1785       <varlistentry>
1786         <term><option>-monly-[32]-regs</option>:</term>
1787         <listitem>
1788           <para>(iX86 machines)<indexterm><primary>-monly-N-regs
1789           option (iX86 only)</primary></indexterm> GHC tries to
1790           &ldquo;steal&rdquo; four registers from GCC, for performance
1791           reasons; it almost always works.  However, when GCC is
1792           compiling some modules with four stolen registers, it will
1793           crash, probably saying:
1794
1795 <screen>
1796 Foo.hc:533: fixed or forbidden register was spilled.
1797 This may be due to a compiler bug or to impossible asm
1798 statements or clauses.
1799 </screen>
1800
1801           Just give some registers back with
1802           <option>-monly-N-regs</option>.  Try `3' first, then `2'.
1803           If `2' doesn't work, please report the bug to us.</para>
1804         </listitem>
1805       </varlistentry>
1806     </variablelist>
1807
1808   </sect1>
1809
1810 &runtime;
1811
1812 <sect1 id="ext-core">
1813   <title>Generating and compiling External Core Files</title>
1814
1815   <indexterm><primary>intermediate code generation</primary></indexterm>
1816
1817   <para>GHC can dump its optimized intermediate code (said to be in &ldquo;Core&rdquo; format) 
1818   to a file as a side-effect of compilation. Core files, which are given the suffix
1819   <filename>.hcr</filename>, can be read and processed by non-GHC back-end
1820   tools.  The Core format is formally described in <ulink url="http://www.haskell.org/ghc/docs/papers/core.ps.gz">
1821   <citetitle>An External Representation for the GHC Core Language</citetitle></ulink>, 
1822   and sample tools (in Haskell)
1823   for manipulating Core files are available in the GHC source distribution 
1824   directory <literal>/fptools/ghc/utils/ext-core</literal>.  
1825   Note that the format of <literal>.hcr</literal> 
1826   files is <emphasis>different</emphasis> (though similar) to the Core output format generated 
1827   for debugging purposes (<xref linkend="options-debugging"/>).</para>
1828
1829   <para>The Core format natively supports notes which you can add to
1830   your source code using the <literal>CORE</literal> pragma (see <xref
1831   linkend="pragmas"/>).</para>
1832
1833     <variablelist>
1834
1835         <varlistentry>
1836           <term>
1837             <option>-fext-core</option>
1838             <indexterm><primary><option>-fext-core</option></primary></indexterm>
1839           </term>
1840           <listitem>
1841             <para>Generate <literal>.hcr</literal> files.</para>
1842           </listitem>
1843         </varlistentry>
1844
1845     </variablelist>
1846
1847 <para>GHC can also read in External Core files as source; just give the <literal>.hcr</literal> file on
1848 the command line, instead of the <literal>.hs</literal> or <literal>.lhs</literal> Haskell source.
1849 A current infelicity is that you need to give the <literal>-fglasgow-exts</literal> flag too, because
1850 ordinary Haskell 98, when translated to External Core, uses things like rank-2 types.</para>
1851 </sect1>
1852
1853 &debug;
1854 &flags;
1855
1856 </chapter>
1857
1858 <!-- Emacs stuff:
1859      ;;; Local Variables: ***
1860      ;;; mode: xml ***
1861      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter") ***
1862      ;;; End: ***
1863  -->