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