using.xml 64.5 KB
Newer Older
1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<chapter id="using-ghc">
3
  <title>Using GHC</title>
rrt's avatar
rrt committed
4

5 6
  <indexterm><primary>GHC, using</primary></indexterm>
  <indexterm><primary>using GHC</primary></indexterm>
rrt's avatar
rrt committed
7

8 9 10 11 12 13 14 15 16
  <sect1>
    <title>Options overview</title>
    
    <para>GHC's behaviour is controlled by
    <firstterm>options</firstterm>, which for historical reasons are
    also sometimes referred to as command-line flags or arguments.
    Options can be specified in three ways:</para>

    <sect2>
17
      <title>command-line arguments</title>
18 19 20 21 22 23
      
      <indexterm><primary>structure, command-line</primary></indexterm>
      <indexterm><primary>command-line</primary><secondary>arguments</secondary></indexterm>
      <indexterm><primary>arguments</primary><secondary>command-line</secondary></indexterm>
      
      <para>An invocation of GHC takes the following form:</para>
rrt's avatar
rrt committed
24

25
<screen>
rrt's avatar
rrt committed
26
ghc [argument...]
27
</screen>
rrt's avatar
rrt committed
28

29
      <para>command-line arguments are either options or file names.</para>
30

31
      <para>command-line options begin with <literal>-</literal>.
32 33 34 35 36 37 38 39 40
      They may <emphasis>not</emphasis> be grouped:
      <option>-vO</option> is different from <option>-v -O</option>.
      Options need not precede filenames: e.g., <literal>ghc *.o -o
      foo</literal>.  All options are processed and then applied to
      all files; you cannot, for example, invoke <literal>ghc -c -O1
      Foo.hs -O2 Bar.hs</literal> to apply different optimisation
      levels to the files <filename>Foo.hs</filename> and
      <filename>Bar.hs</filename>.</para>
    </sect2>
rrt's avatar
rrt committed
41

42 43
    <sect2 id="source-file-options">
      <title>command line options in source files</title>
44 45 46 47 48 49 50 51 52 53
    
      <indexterm><primary>source-file options</primary></indexterm>

      <para>Sometimes it is useful to make the connection between a
      source file and the command-line options it requires quite
      tight. For instance, if a Haskell source file uses GHC
      extensions, it will always need to be compiled with the
      <option>-fglasgow-exts</option> option.  Rather than maintaining
      the list of per-file options in a <filename>Makefile</filename>,
      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>
rrt's avatar
rrt committed
56

57
<programlisting>
58
{-# OPTIONS_GHC -fglasgow-exts #-}
59 60
module X where
...
61
</programlisting>
62
      
63
      <para><literal>OPTIONS_GHC</literal> pragmas are only looked for at
64 65
      the top of your source files, upto the first
      (non-literate,non-empty) line not containing
66
      <literal>OPTIONS_GHC</literal>. Multiple <literal>OPTIONS_GHC</literal>
67 68 69 70
      pragmas are recognised.  Do not put comments before, or on the same line
	as, the <literal>OPTIONS_GHC</literal> pragma.</para>

      <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 80 81 82
      line.</para>

      <para>It is not recommended to move all the contents of your
      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-too</option> and have OPTION flags in
85
      your module, the OPTIONS_GHC will get put into the generated .hc
86 87
      file).</para>
    </sect2>
rrt's avatar
rrt committed
88

89 90
    <sect2>
      <title>Setting options in GHCi</title>
rrt's avatar
rrt committed
91

92
      <para>Options may also be modified from within GHCi, using the
93
      <literal>:set</literal> command.  See <xref linkend="ghci-set"/>
94 95 96 97 98
      for more details.</para>
    </sect2>
  </sect1>
    
  <sect1 id="static-dynamic-flags">
99
    <title>Static, Dynamic, and Mode options</title>
100 101 102 103
    <indexterm><primary>static</primary><secondary>options</secondary>
    </indexterm>
    <indexterm><primary>dynamic</primary><secondary>options</secondary>
    </indexterm>
104 105
    <indexterm><primary>mode</primary><secondary>options</secondary>
    </indexterm>
106 107

    <para>Each of GHC's command line options is classified as either
108 109 110 111 112 113 114 115 116
    <firstterm>static</firstterm> or <firstterm>dynamic</firstterm> or
      <firstterm>mode</firstterm>:</para>

    <variablelist>
      <varlistentry>
	<term>Mode flags</term>
	<listitem>
	  <para>For example, <option>--make</option> or <option>-E</option>.
	    There may be only a single mode flag on the command line.  The
117
	    available modes are listed in <xref linkend="modes"/>.</para>
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>Dynamic Flags</term>
	<listitem>
	  <para>Most non-mode flags fall into this category.  A dynamic flag
	    may be used on the command line, in a
	    <literal>GHC_OPTIONS</literal> pragma in a source file, or set
	    using <literal>:set</literal> in GHCi.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>Static Flags</term>
	<listitem>
	  <para>A few flags are "static", which means they can only be used on
	    the command-line, and remain in force over the entire GHC/GHCi
	    run.</para>
	</listitem>
      </varlistentry>
    </variablelist>
    
    <para>The flag reference tables (<xref
140
    linkend="flag-reference"/>) lists the status of each flag.</para>
141 142 143 144 145

    <para>There are a few flags that are static except that they can
    also be used with GHCi's <literal>:set</literal> command; these
    are listed as &ldquo;static/<literal>:set</literal>&rdquo; in the
    table.</para> 
146
  </sect1>
rrt's avatar
rrt committed
147

148 149
  <sect1 id="file-suffixes">
    <title>Meaningful file suffixes</title>
rrt's avatar
rrt committed
150

151 152
    <indexterm><primary>suffixes, file</primary></indexterm>
    <indexterm><primary>file suffixes for GHC</primary></indexterm>
rrt's avatar
rrt committed
153

154 155 156
    <para>File names with &ldquo;meaningful&rdquo; suffixes (e.g.,
    <filename>.lhs</filename> or <filename>.o</filename>) cause the
    &ldquo;right thing&rdquo; to happen to those files.</para>
rrt's avatar
rrt committed
157

158
    <variablelist>
rrt's avatar
rrt committed
159

160
      <varlistentry>
161
	<term><filename>.hs</filename></term>
162
	<listitem>
163
	  <para>A Haskell module.</para>
164 165
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
166

167
      <varlistentry>
168 169 170 171
	<term>
          <filename>.lhs</filename>
          <indexterm><primary><literal>lhs</literal> suffix</primary></indexterm>
	</term>
172
	<listitem>
173
	  <para>A &ldquo;literate Haskell&rdquo; module.</para>
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><filename>.hi</filename></term>
	<listitem>
	  <para>A Haskell interface file, probably
	  compiler-generated.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><filename>.hc</filename></term>
	<listitem>
	  <para>Intermediate C file produced by the Haskell
	  compiler.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><filename>.c</filename></term>
	<listitem>
	  <para>A C&nbsp;file not produced by the Haskell
	  compiler.</para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><filename>.s</filename></term>
	<listitem>
	  <para>An assembly-language source file, usually produced by
          the compiler.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><filename>.o</filename></term>
	<listitem>
	  <para>An object file, produced by an assembler.</para>
	</listitem>
      </varlistentry>
    </variablelist>

    <para>Files with other suffixes (or without suffixes) are passed
    straight to the linker.</para>

  </sect1>
rrt's avatar
rrt committed
221

222 223 224 225 226 227 228 229 230 231
  <sect1 id="modes">
    <title>Modes of operation</title>

    <para>GHC's behaviour is firstly controlled by a mode flag.  Only
    one of these flags may be given, but it does not necessarily need
    to be the first option on the command-line.  The available modes
    are:</para>

    <variablelist>
      <varlistentry>
232
	<term>
233
	  <cmdsynopsis><command>ghc --interactive</command>
234 235 236 237
	  </cmdsynopsis>
          <indexterm><primary>interactive mode</primary></indexterm>
          <indexterm><primary>ghci</primary></indexterm>
	</term>
238 239 240
	<listitem>
	  <para>Interactive mode, which is also available as
	  <command>ghci</command>.  Interactive mode is described in
241
	  more detail in <xref linkend="ghci"/>.</para>
242 243 244 245
	</listitem>
      </varlistentry>
      
      <varlistentry>
246
	<term>
247
	  <cmdsynopsis><command>ghc --make</command>
248 249 250 251
	  </cmdsynopsis>
          <indexterm><primary>make mode</primary></indexterm>
          <indexterm><primary><option>&ndash;&ndash;make</option></primary></indexterm>
	</term>
252 253 254 255 256 257
	<listitem>
	  <para>In this mode, GHC will build a multi-module Haskell
	  program automatically, figuring out dependencies for itself.
	  If you have a straightforward Haskell program, this is
	  likely to be much easier, and faster, than using
	  <command>make</command>.  Make mode is described in <xref
258
	  linkend="make-mode"/>.</para>
259 260 261 262
	</listitem>
      </varlistentry>

      <varlistentry>
263
	<term>
264 265
	  <cmdsynopsis><command>ghc -e</command>
	     <arg choice='plain'><replaceable>expr</replaceable></arg>
266 267 268
          </cmdsynopsis>
          <indexterm><primary>eval mode</primary></indexterm>
	</term>
269 270 271 272
	<listitem>
	  <para>Expression-evaluation mode.  This is very similar to
	  interactive mode, except that there is a single expression
	  to evaluate (<replaceable>expr</replaceable>) which is given
273
	  on the command line.  See <xref linkend="eval-mode"/> for
274 275 276 277 278
	  more details.</para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
279 280
	<term>
          <cmdsynopsis>
281 282 283 284
	    <command>ghc -E</command>
	    <command>ghc -c</command>
	    <command>ghc -S</command>
	    <command>ghc -c</command>
285 286 287 288 289 290
	  </cmdsynopsis>
	  <indexterm><primary><option>-E</option></primary></indexterm>
	  <indexterm><primary><option>-C</option></primary></indexterm>
	  <indexterm><primary><option>-S</option></primary></indexterm>
	  <indexterm><primary><option>-c</option></primary></indexterm>
        </term>
291 292 293 294 295 296 297
	<listitem>
	  <para>This is the traditional batch-compiler mode, in which
	  GHC can compile source files one at a time, or link objects
	  together into an executable.  This mode also applies if
	  there is no other mode flag specified on the command line,
	  in which case it means that the specified files should be
	  compiled and then linked to form a program. See <xref
298
	  linkend="options-order"/>.</para>
299 300 301 302
	</listitem>
      </varlistentry>

      <varlistentry>
303 304
	<term>
          <cmdsynopsis>
305
            <command>ghc -M</command>
306 307 308
          </cmdsynopsis>
          <indexterm><primary>dependency-generation mode</primary></indexterm>
        </term>
309 310 311 312
	<listitem>
	  <para>Dependency-generation mode.  In this mode, GHC can be
	  used to generate dependency information suitable for use in
	  a <literal>Makefile</literal>.  See <xref
313
	  linkend="makefile-dependencies"/>.</para>
314 315 316 317
	</listitem>
      </varlistentry>

      <varlistentry>
318 319
	<term>
          <cmdsynopsis>
320
            <command>ghc --mk-dll</command>
321
          </cmdsynopsis>
322
	  <indexterm><primary>DLL-creation mode</primary></indexterm>
323
        </term>
324 325
	<listitem>
	  <para>DLL-creation mode (Windows only).  See <xref
326
	  linkend="win32-dlls-create"/>.</para>
327 328
	</listitem>
      </varlistentry>
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

      <varlistentry>
	<term>
	  <cmdsynopsis>
          <command>ghc --help</command> <command>ghc -?</command>
	    </cmdsynopsis>
          <indexterm><primary><option>&ndash;&ndash;help</option></primary></indexterm>
        </term>
	<listitem>
	  <para>Cause GHC to spew a long usage message to standard
          output and then exit.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
          <cmdsynopsis>
346 347 348
            <command>ghc --version</command>
            <command>ghc -V</command>
          </cmdsynopsis>
349 350 351 352 353 354 355 356 357 358 359
          <indexterm><primary><option>-V</option></primary></indexterm>
          <indexterm><primary><option>&ndash;&ndash;version</option></primary></indexterm>
        </term>
	<listitem>
	  <para>Print a one-line string including GHC's version number.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
          <cmdsynopsis>
360 361
            <command>ghc --numeric-version</command>
          </cmdsynopsis>
362 363 364 365 366 367 368 369 370 371
          <indexterm><primary><option>&ndash;&ndash;numeric-version</option></primary></indexterm>
        </term>
	<listitem>
	  <para>Print GHC's numeric version number only.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <cmdsynopsis>
372 373
            <command>ghc --print-libdir</command>
          </cmdsynopsis>
374 375 376 377 378 379 380 381 382 383 384 385 386 387
          <indexterm><primary><option>&ndash;&ndash;print-libdir</option></primary></indexterm>
        </term>
	<listitem>
	  <para>Print the path to GHC's library directory.  This is
	  the top of the directory tree containing GHC's libraries,
	  interfaces, and include files (usually something like
	  <literal>/usr/local/lib/ghc-5.04</literal> on Unix).  This
	  is the value of
	  <literal>$libdir</literal><indexterm><primary><literal>libdir</literal></primary>
	  </indexterm>in the package configuration file (see <xref
	  linkend="packages"/>).</para>
	</listitem>
      </varlistentry>

388 389 390 391
    </variablelist>

    <sect2 id="make-mode">
      <title>Using <command>ghc</command> <option>&ndash;&ndash;make</option></title>
392 393
      <indexterm><primary><option>&ndash;&ndash;make</option></primary></indexterm>
      <indexterm><primary>separate compilation</primary></indexterm>
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
      
      <para>When given the <option>&ndash;&ndash;make</option> option,
      GHC will build a multi-module Haskell program by following
      dependencies from a single root module (usually
      <literal>Main</literal>).  For example, if your
      <literal>Main</literal> module is in a file called
      <filename>Main.hs</filename>, you could compile and link the
      program like this:</para>

<screen>
ghc &ndash;&ndash;make Main.hs
</screen>

      <para>The command line may contain any number of source file
      names or module names; GHC will figure out all the modules in
      the program by following the imports from these initial modules.
      It will then attempt to compile each module which is out of
      date, and finally if there is a <literal>Main</literal> module,
      the program will also be linked into an executable.</para>

      <para>The main advantages to using <literal>ghc
      &ndash;&ndash;make</literal> over traditional
      <literal>Makefile</literal>s are:</para>

      <itemizedlist>
	<listitem>
	  <para>GHC doesn't have to be restarted for each compilation,
	  which means it can cache information between compilations.
ross's avatar
ross committed
422
	  Compiling a multi-module program with <literal>ghc
423 424 425 426 427
	  &ndash;&ndash;make</literal> can be up to twice as fast as
	  running <literal>ghc</literal> individually on each source
	  file.</para>
	</listitem>
	<listitem>
428
	  <para>You don't have to write a <literal>Makefile</literal>.</para>
429
          <indexterm><primary><literal>Makefile</literal>s</primary><secondary>avoiding</secondary></indexterm>
430 431 432 433 434 435 436 437 438 439 440 441 442
	</listitem>
	<listitem>
	  <para>GHC re-calculates the dependencies each time it is
	  invoked, so the dependencies never get out of sync with the
	  source.</para>
	</listitem>
      </itemizedlist>
      
      <para>Any of the command-line options described in the rest of
      this chapter can be used with
      <option>&ndash;&ndash;make</option>, but note that any options
      you give on the command line will apply to all the source files
      compiled, so if you want any options to apply to a single source
443
      file only, you'll need to use an <literal>OPTIONS_GHC</literal>
444
      pragma (see <xref linkend="source-file-options"/>).</para>
445 446

      <para>If the program needs to be linked with additional objects
ross's avatar
ross committed
447
      (say, some auxiliary C code), then the object files can be
448 449 450 451 452 453 454 455 456 457 458 459 460
      given on the command line and GHC will include them when linking
      the executable.</para>
      
      <para>Note that GHC can only follow dependencies if it has the
      source file available, so if your program includes a module for
      which there is no source file, even if you have an object and an
      interface file for the module, then GHC will complain.  The
      exception to this rule is for package modules, which may or may
      not have source files.</para>

      <para>The source files for the program don't all need to be in
      the same directory; the <option>-i</option> option can be used
      to add directories to the search path (see <xref
461
      linkend="search-path"/>).</para>
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
    </sect2>
  
    <sect2 id="eval-mode">
      <title>Expression evaluation mode</title>

      <para>This mode is very similar to interactive mode, except that
      there is a single expression to evaluate which is specified on
      the command line as an argument to the <option>-e</option>
      option:</para>

<screen>
ghc -e <replaceable>expr</replaceable>
</screen>

      <para>Haskell source files may be named on the command line, and
      they will be loaded exactly as in interactive mode.  The
      expression is evaluated in the context of the loaded
      modules.</para>

      <para>For example, to load and run a Haskell program containing
      a module <literal>Main</literal>, we might say</para>

<screen>
ghc -e Main.main Main.hs
</screen>
      
      <para>or we can just use this mode to evaluate expressions in
      the context of the <literal>Prelude</literal>:</para>

<screen>
$ ghc -e "interact (unlines.map reverse.lines)"
hello
olleh
</screen>
    </sect2>

    <sect2 id="options-order">
      <title>Batch compiler mode</title>
      
501
      <para>In <emphasis>batch mode</emphasis>, GHC will compile one or more source files
502 503 504 505 506 507 508 509 510
      given on the command line.</para>
      
      <para>The first phase to run is determined by each input-file
      suffix, and the last phase is determined by a flag.  If no
      relevant flag is present, then go all the way through linking.
      This table summarises:</para>
      
      <informaltable>
	<tgroup cols="4">
511 512 513 514
	  <colspec align="left"/>
	  <colspec align="left"/>
	  <colspec align="left"/>
	  <colspec align="left"/>
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
	  
	  <thead>
	    <row>
	      <entry>Phase of the compilation system</entry>
	      <entry>Suffix saying &ldquo;start here&rdquo;</entry>
	      <entry>Flag saying &ldquo;stop after&rdquo;</entry>
	      <entry>(suffix of) output file</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>literate pre-processor</entry>
	      <entry><literal>.lhs</literal></entry>
	      <entry>-</entry>
	      <entry><literal>.hs</literal></entry>
	    </row>
	    
	    <row>
	      <entry>C pre-processor (opt.) </entry>
	      <entry><literal>.hs</literal> (with
	      <option>-cpp</option>)</entry>
	      <entry><option>-E</option></entry>
	      <entry><literal>.hspp</literal></entry>
	    </row>
	    
	    <row>
	      <entry>Haskell compiler</entry>
	      <entry><literal>.hs</literal></entry>
	      <entry><option>-C</option>, <option>-S</option></entry>
	      <entry><literal>.hc</literal>, <literal>.s</literal></entry>
	    </row>
	    
	    <row>
	      <entry>C compiler (opt.)</entry>
	      <entry><literal>.hc</literal> or <literal>.c</literal></entry>
	      <entry><option>-S</option></entry>
	      <entry><literal>.s</literal></entry>
	    </row>
	    
	    <row>
	      <entry>assembler</entry>
	      <entry><literal>.s</literal></entry>
	      <entry><option>-c</option></entry>
	      <entry><literal>.o</literal></entry>
	    </row>
	    
	    <row>
	      <entry>linker</entry>
	      <entry><replaceable>other</replaceable></entry>
	      <entry>-</entry>
	      <entry><filename>a.out</filename></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
      
      <indexterm><primary><option>-C</option></primary></indexterm>
      <indexterm><primary><option>-E</option></primary></indexterm>
      <indexterm><primary><option>-S</option></primary></indexterm>
      <indexterm><primary><option>-c</option></primary></indexterm>
      
      <para>Thus, a common invocation would be: </para>

<screen>
ghc -c Foo.hs</screen>
      
      <para>to compile the Haskell source file
      <filename>Foo.hs</filename> to an object file
      <filename>Foo.o</filename>.</para>

      <para>Note: What the Haskell compiler proper produces depends on
      whether a native-code generator<indexterm><primary>native-code
      generator</primary></indexterm> is used (producing assembly
      language) or not (producing C).  See <xref
589
      linkend="options-codegen"/> for more details.</para>
590 591 592

      <para>Note: C pre-processing is optional, the
      <option>-cpp</option><indexterm><primary><option>-cpp</option></primary></indexterm>
593
      flag turns it on.  See <xref linkend="c-pre-processor"/> for more
594 595
      details.</para>
      
596 597
      <para>Note: The option <option>-E</option><indexterm><primary>-E
      option</primary></indexterm> runs just the pre-processing passes
598 599 600
      of the compiler, dumping the result in a file.  Note that this
      differs from the previous behaviour of dumping the file to
      standard output.</para>
601 602 603 604 605 606 607 608 609 610

      <sect3 id="overriding-suffixes">
	<title>Overriding the default behaviour for a file</title>

	<para>As described above, the way in which a file is processed by GHC
	  depends on its suffix.  This behaviour can be overriden using the
	  <option>-x</option> option:</para>

	<variablelist>
	  <varlistentry>
611 612 613
	    <term><option>-x</option> <replaceable>suffix</replaceable>
	    	      <indexterm><primary><option>-x</option></primary>
	      </indexterm></term>
614 615 616 617 618 619 620 621 622 623 624
	      <listitem>
		<para>Causes all files following this option on the command
		  line to be processed as if they had the suffix
		  <replaceable>suffix</replaceable>.  For example, to compile a
		  Haskell module in the file <literal>M.my-hs</literal>,
		  use <literal>ghc -c -x hs M.my-hs</literal>.</para>
	      </listitem>
	  </varlistentry>
	</variablelist>
      </sect3>

625 626 627
    </sect2>
  </sect1>

628 629
  <sect1 id="options-help">
    <title>Help and verbosity options</title>
630

631 632
    <indexterm><primary>help options</primary></indexterm>
    <indexterm><primary>verbosity options</primary></indexterm>
633

634 635
    <para>See also the <option>--help</option>, <option>--version</option>, <option>--numeric-version</option>,
    and <option>--print-libdir</option> modes in <xref linkend="modes"/>.</para>
636
    <variablelist>
637 638 639 640 641 642 643 644 645 646 647 648
      <varlistentry>
	<term>
          <option>-n</option>
          <indexterm><primary><option>-n</option></primary></indexterm>
        </term>
	<listitem>
	  <para>Does a dry-run, i.e. GHC goes through all the motions
          of compiling as normal, but does not actually run any
          external commands.</para>
	</listitem>
      </varlistentry>

649
      <varlistentry>
650 651 652 653
	<term>
          <option>-v</option>
          <indexterm><primary><option>-v</option></primary></indexterm>
        </term>
654 655
	<listitem>
	  <para>The <option>-v</option> option makes GHC
656
          <emphasis>verbose</emphasis>: it reports its version number
657 658 659 660 661 662 663 664 665 666 667 668 669
          and shows (on stderr) exactly how it invokes each phase of
          the compilation system.  Moreover, it passes the
          <option>-v</option> flag to most phases; each reports its
          version number (and possibly some other information).</para>

	  <para>Please, oh please, use the <option>-v</option> option
          when reporting bugs!  Knowing that you ran the right bits in
          the right order is always the first thing we want to
          verify.</para>
	</listitem>
      </varlistentry>
	
      <varlistentry>
670 671 672 673
	<term>
          <option>-v</option><replaceable>n</replaceable>
          <indexterm><primary><option>-v</option></primary></indexterm>
        </term>
674 675 676 677 678 679 680 681 682
	<listitem>
	  <para>To provide more control over the compiler's verbosity,
	  the <option>-v</option> flag takes an optional numeric
	  argument.  Specifying <option>-v</option> on its own is
	  equivalent to <option>-v3</option>, and the other levels
	  have the following meanings:</para>
	  
	  <variablelist>
	    <varlistentry>
683
	      <term><option>-v0</option></term>
684 685 686 687 688 689 690
	      <listitem>
		<para>Disable all non-essential messages (this is the
		default).</para>
	      </listitem>
	    </varlistentry>

	    <varlistentry>
691
	      <term><option>-v1</option></term>
692 693 694
	      <listitem>
		<para>Minimal verbosity: print one line per
		compilation (this is the default when
695 696
		<option>&ndash;&ndash;make</option> or
		<option>&ndash;&ndash;interactive</option> is on).</para>
697 698 699 700
	      </listitem>
	    </varlistentry>

	    <varlistentry>
701
	      <term><option>-v2</option></term>
702 703 704 705 706 707 708 709
	      <listitem>
		<para>Print the name of each compilation phase as it
		is executed. (equivalent to
		<option>-dshow-passes</option>).</para>
	      </listitem>
	    </varlistentry>

	    <varlistentry>
710
	      <term><option>-v3</option></term>
711 712 713 714 715 716 717 718
	      <listitem>
		<para>The same as <option>-v2</option>, except that in
                addition the full command line (if appropriate) for
                each compilation phase is also printed.</para>
	      </listitem>
	    </varlistentry>

	    <varlistentry>
719
	      <term><option>-v4</option></term>
720 721 722 723 724 725 726 727 728 729 730
	      <listitem>
		<para>The same as <option>-v3</option> except that the
		intermediate program representation after each
		compilation phase is also printed (excluding
		preprocessed and C/assembly files).</para>
	      </listitem>
	    </varlistentry>
	  </variablelist>
	</listitem>
      </varlistentry>
      
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
      <varlistentry>
	<term><option>-ferror-spans</option>
          <indexterm><primary><option>-ferror-spans</option></primary>
	  </indexterm>
        </term>
	<listitem>
	  <para>Causes GHC to emit the full source span of the
	  syntactic entity relating to an error message.  Normally, GHC
	  emits the source location of the start of the syntactic
	  entity only.</para>

	  <para>For example:</para>

<screen>test.hs:3:6: parse error on input `where'</screen>

	  <para>becomes:</para>

<screen>test296.hs:3:6-10: parse error on input `where'</screen>

	  <para>And multi-line spans are possible too:</para>

<screen>test.hs:(5,4)-(6,7):
    Conflicting definitions for `a'
    Bound at: test.hs:5:4
              test.hs:6:7
    In the binding group for: a, b, a</screen>

	  <para>Note that line numbers start counting at one, but
	  column numbers start at zero.  This choice was made to
	  follow existing convention (i.e. this is how Emacs does
	  it).</para>
	</listitem>
      </varlistentry>
764

765 766 767 768 769 770 771 772 773 774 775 776 777 778
      <varlistentry>
        <term><option>-H</option><replaceable>size</replaceable>
        <indexterm><primary><option>-H</option></primary></indexterm>
        </term>
        <listitem>
          <para>Set the minimum size of the heap to
          <replaceable>size</replaceable>.
          This option is equivalent to
          <literal>+RTS&nbsp;-H<replaceable>size</replaceable></literal>,
          see <xref linkend="rts-options-gc" />.
          </para>
        </listitem>
      </varlistentry>

779 780 781 782 783 784 785 786 787 788 789 790
      <varlistentry>
        <term><option>-Rghc-timing</option>
        <indexterm><primary><option>-Rghc-timing</option></primary></indexterm>
        </term>
        <listitem>
          <para>Prints a one-line summary of timing statistics for the
          GHC run.  This option is equivalent to
          <literal>+RTS&nbsp;-tstderr</literal>, see <xref
          linkend="rts-options-gc" />.
          </para>
        </listitem>
      </varlistentry>
791 792 793
    </variablelist>
  </sect1>

794
  &separate;
rrt's avatar
rrt committed
795

796 797 798 799 800 801 802 803 804 805 806 807
  <sect1 id="options-sanity">
    <title>Warnings and sanity-checking</title>

    <indexterm><primary>sanity-checking options</primary></indexterm>
    <indexterm><primary>warnings</primary></indexterm>


    <para>GHC has a number of options that select which types of
    non-fatal error messages, otherwise known as warnings, can be
    generated during compilation.  By default, you get a standard set
    of warnings which are generally likely to indicate bugs in your
    program.  These are:
808
    <option>-fwarn-overlapping-patterns</option>,
809 810 811 812 813 814 815
    <option>-fwarn-deprecations</option>,
    <option>-fwarn-duplicate-exports</option>,
    <option>-fwarn-missing-fields</option>, and
    <option>-fwarn-missing-methods</option>.  The following flags are
    simple ways to select standard &ldquo;packages&rdquo; of warnings:
    </para>

816
    <variablelist>
817 818 819 820

      <varlistentry>
	<term><option>-W</option>:</term>
	<listitem>
821
	  <indexterm><primary>-W option</primary></indexterm>
822 823 824
	  <para>Provides the standard warnings plus
	  <option>-fwarn-incomplete-patterns</option>,
	  <option>-fwarn-unused-matches</option>,
Ian Lynagh's avatar
Ian Lynagh committed
825
	  <option>-fwarn-unused-imports</option>, and
826 827 828
	  <option>-fwarn-unused-binds</option>.</para>
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
829

830 831 832
      <varlistentry>
	<term><option>-w</option>:</term>
	<listitem>
833
	  <indexterm><primary><option>-w</option></primary></indexterm>
834 835 836
	  <para>Turns off all warnings, including the standard ones.</para>
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
837

838 839 840
      <varlistentry>
	<term><option>-Wall</option>:</term>
	<listitem>
841
	  <indexterm><primary><option>-Wall</option></primary></indexterm>
842 843 844
	  <para>Turns on all warning options.</para>
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
845

846 847 848 849 850 851 852 853 854
      <varlistentry>
	<term><option>-Werror</option>:</term>
	<listitem>
	  <indexterm><primary><option>-Werror</option></primary></indexterm>
	  <para>Makes any warning into a fatal error. Useful so that you don't 
	    miss warnings when doing batch compilation. </para>
	</listitem>
      </varlistentry>

855
    </variablelist>
rrt's avatar
rrt committed
856

857 858 859
    <para>The full set of warning options is described below.  To turn
    off any warning, simply give the corresponding
    <option>-fno-warn-...</option> option on the command line.</para>
rrt's avatar
rrt committed
860

861
    <variablelist>
rrt's avatar
rrt committed
862

863 864 865 866 867 868 869 870 871
      <varlistentry>
	<term><option>-fwarn-deprecations</option>:</term>
	<listitem>
	  <indexterm><primary><option>-fwarn-deprecations</option></primary>
	  </indexterm>
	  <indexterm><primary>deprecations</primary></indexterm>
	  <para>Causes a warning to be emitted when a deprecated
	  function or type is used.  Entities can be marked as
	  deprecated using a pragma, see <xref
872
	  linkend="deprecated-pragma"/>.</para>
873 874
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
875

876 877 878
      <varlistentry>
	<term><option>-fwarn-duplicate-exports</option>:</term>
	<listitem>
879
	  <indexterm><primary><option>-fwarn-duplicate-exports</option></primary></indexterm>
880 881
	  <indexterm><primary>duplicate exports, warning</primary></indexterm>
	  <indexterm><primary>export lists, duplicates</primary></indexterm>
rrt's avatar
rrt committed
882

883 884 885 886 887
	  <para>Have the compiler warn about duplicate entries in
          export lists. This is useful information if you maintain
          large export lists, and want to avoid the continued export
          of a definition after you've deleted (one) mention of it in
          the export list.</para>
rrt's avatar
rrt committed
888

889 890 891 892 893 894 895
	  <para>This option is on by default.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>-fwarn-hi-shadowing</option>:</term>
	<listitem>
896
	  <indexterm><primary><option>-fwarn-hi-shadowing</option></primary></indexterm>
897 898 899 900 901 902 903 904 905 906 907 908 909
	  <indexterm><primary>shadowing</primary>
	    <secondary>interface files</secondary></indexterm>

	  <para>Causes the compiler to emit a warning when a module or
	  interface file in the current directory is shadowing one
	  with the same module name in a library or other
	  directory.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>-fwarn-incomplete-patterns</option>:</term>
	<listitem>
910
	  <indexterm><primary><option>-fwarn-incomplete-patterns</option></primary></indexterm>
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
	  <indexterm><primary>incomplete patterns, warning</primary></indexterm>
	  <indexterm><primary>patterns, incomplete</primary></indexterm>

	  <para>Similarly for incomplete patterns, the function
          <function>g</function> below will fail when applied to
          non-empty lists, so the compiler will emit a warning about
          this when <option>-fwarn-incomplete-patterns</option> is
          enabled.</para>

<programlisting>
g [] = 2
</programlisting>

	  <para>This option isn't enabled be default because it can be
          a bit noisy, and it doesn't always indicate a bug in the
          program.  However, it's generally considered good practice
          to cover all the cases in your functions.</para>
	</listitem>
      </varlistentry>

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
      <varlistentry>
	<term><option>-fwarn-incomplete-record-updates</option>:</term>
	<listitem>
	  <indexterm><primary><option>-fwarn-incomplete-record-updates</option></primary></indexterm>
	  <indexterm><primary>incomplete record updates, warning</primary></indexterm>
	  <indexterm><primary>record updates, incomplete</primary></indexterm>

	  <para>The function
          <function>f</function> below will fail when applied to
          <literal>Bar</literal>, so the compiler will emit a warning about
          this when <option>-fwarn-incomplete-record-updates</option> is
          enabled.</para>

<programlisting>
data Foo = Foo { x :: Int }
         | Bar

f :: Foo -> Foo
f foo = foo { x = 6 }
</programlisting>

	  <para>This option isn't enabled be default because it can be
          very noisy, and it often doesn't indicate a bug in the
          program.</para>
	</listitem>
      </varlistentry>

958
      <varlistentry>
959 960
	<term>
          <option>-fwarn-missing-fields</option>:
961
	  <indexterm><primary><option>-fwarn-missing-fields</option></primary></indexterm>
962 963
	  <indexterm><primary>missing fields, warning</primary></indexterm>
	  <indexterm><primary>fields, missing</primary></indexterm>
964 965
        </term>
	<listitem>
966 967 968 969 970 971 972 973 974 975 976 977

	  <para>This option is on by default, and warns you whenever
          the construction of a labelled field constructor isn't
          complete, missing initializers for one or more fields. While
          not an error (the missing fields are initialised with
          bottoms), it is often an indication of a programmer error.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>-fwarn-missing-methods</option>:</term>
	<listitem>
978
	  <indexterm><primary><option>-fwarn-missing-methods</option></primary></indexterm>
979 980 981 982 983 984 985
	  <indexterm><primary>missing methods, warning</primary></indexterm>
	  <indexterm><primary>methods, missing</primary></indexterm>

	  <para>This option is on by default, and warns you whenever
          an instance declaration is missing one or more methods, and
          the corresponding class declaration has no default
          declaration for them.</para>
986 987 988 989 990 991 992 993 994 995 996 997
	  <para>The warning is suppressed if the method name
	  begins with an underscore.  Here's an example where this is useful:
	    <programlisting>
	      class C a where
	        _simpleFn :: a -> String
	        complexFn :: a -> a -> String
	        complexFn x y = ... _simpleFn ...
	      </programlisting>
	    The idea is that: (a) users of the class will only call <literal>complexFn</literal>; 
	    never <literal>_simpleFn</literal>; and (b)
	    instance declarations can define either <literal>complexFn</literal> or <literal>_simpleFn</literal>.
	    </para>
998 999 1000 1001 1002 1003
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>-fwarn-missing-signatures</option>:</term>
	<listitem>
1004
	  <indexterm><primary><option>-fwarn-missing-signatures</option></primary></indexterm>
1005 1006 1007 1008
	  <indexterm><primary>type signatures, missing</primary></indexterm>

	  <para>If you would like GHC to check that every top-level
          function/value has a type signature, use the
1009 1010
          <option>-fwarn-missing-signatures</option> option.  As part of
	    the warning GHC also reports the inferred type.  The
1011 1012 1013 1014 1015 1016 1017
          option is off by default.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>-fwarn-name-shadowing</option>:</term>
	<listitem>
1018
	  <indexterm><primary><option>-fwarn-name-shadowing</option></primary></indexterm>
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
	  <indexterm><primary>shadowing, warning</primary></indexterm>
	  
	  <para>This option causes a warning to be emitted whenever an
          inner-scope value has the same name as an outer-scope value,
          i.e. the inner value shadows the outer one.  This can catch
          typographical errors that turn into hard-to-find bugs, e.g.,
          in the inadvertent cyclic definition <literal>let x = ... x
          ... in</literal>.</para>

	  <para>Consequently, this option does
          <emphasis>will</emphasis> complain about cyclic recursive
          definitions.</para>
	</listitem>
      </varlistentry>

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
      <varlistentry>
	<term><option>-fwarn-orphans</option>:</term>
	<listitem>
	  <indexterm><primary><option>-fwarn-orphans</option></primary></indexterm>
	  <indexterm><primary>orphan instances, warning</primary></indexterm>
	  <indexterm><primary>orphan rules, warning</primary></indexterm>
	  
	  <para>This option causes a warning to be emitted whenever the 
	    module contains an "orphan" instance declaration or rewrite rule.
	    An instance declartion is an orphan if it appears in a module in
	    which neither the class nor the type being instanced are declared
	    in the same module.  A rule is an orphan if it is a rule for a
	    function declared in another module.  A module containing any
	  orphans is called an orphan module.</para>
	  <para>The trouble with orphans is that GHC must pro-actively read the interface
	    files for all orphan modules, just in case their instances or rules
	    play a role, whether or not the module's interface would otherwise 
	    be of any use.  Other things being equal, avoid orphan modules.</para>
	</listitem>
      </varlistentry>

1055
      <varlistentry>
1056 1057 1058 1059 1060 1061
	<term>
          <option>-fwarn-overlapping-patterns</option>:
          <indexterm><primary><option>-fwarn-overlapping-patterns</option></primary></indexterm>
          <indexterm><primary>overlapping patterns, warning</primary></indexterm>
          <indexterm><primary>patterns, overlapping</primary></indexterm>
        </term>
1062 1063 1064 1065 1066
	<listitem>
	  <para>By default, the compiler will warn you if a set of
          patterns are overlapping, i.e.,</para>

<programlisting>
rrt's avatar
rrt committed
1067 1068 1069 1070
f :: String -&#62; Int
f []     = 0
f (_:xs) = 1
f "2"    = 2
1071
</programlisting>
rrt's avatar
rrt committed
1072

1073
	  <para>where the last pattern match in <function>f</function>
1074 1075 1076 1077 1078
          won't ever be reached, as the second pattern overlaps
          it. More often than not, redundant patterns is a programmer
          mistake/error, so this option is enabled by default.</para>
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
1079

1080 1081 1082 1083 1084 1085 1086 1087 1088
      <varlistentry>
	<term><option>-fwarn-simple-patterns</option>:</term>
	<listitem>
	  <indexterm><primary><option>-fwarn-simple-patterns</option></primary>
	  </indexterm>
	  <para>Causes the compiler to warn about lambda-bound
	  patterns that can fail, eg. <literal>\(x:xs)->...</literal>.
	  Normally, these aren't treated as incomplete patterns by
	  <option>-fwarn-incomplete-patterns</option>.</para>
1089 1090 1091 1092 1093 1094
	  <para>``Lambda-bound patterns'' includes all places where there is a single pattern,
	    including list comprehensions and do-notation.  In these cases, a pattern-match 
	    failure is quite legitimate, and triggers filtering (list comprehensions) or
	    the monad <literal>fail</literal> operation (monads). For example:
	    <programlisting>
	      f :: [Maybe a] -> [a]
1095
	      f xs = [y | Just y &lt;- xs]
1096 1097 1098 1099 1100 1101 1102
	      </programlisting>
	    Switching on <option>-fwarn-simple-patterns</option> will elicit warnings about
	    these probably-innocent cases, which is why the flag is off by default. </para>
	  <para> The <literal>deriving( Read )</literal> mechanism produces monadic code with
	    pattern matches, so you will also get misleading warnings about the compiler-generated
	    code.  (This is arguably a Bad Thing, but it's awkward to fix.)</para>

1103 1104
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
1105

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
      <varlistentry>
	<term><option>-fwarn-tabs</option>:</term>
	<listitem>
	  <indexterm><primary><option>-fwarn-tabs</option></primary></indexterm>
	  <indexterm><primary>tabs, warning</primary></indexterm>
	  <para>Have the compiler warn if there are tabs in your source
          file.</para>

	  <para>This warning is off by default.</para>
	</listitem>
      </varlistentry>

1118 1119 1120
      <varlistentry>
	<term><option>-fwarn-type-defaults</option>:</term>
	<listitem>
1121
	  <indexterm><primary><option>-fwarn-type-defaults</option></primary></indexterm>
1122 1123 1124 1125 1126 1127
	  <indexterm><primary>defaulting mechanism, warning</primary></indexterm>
	  <para>Have the compiler warn/inform you where in your source
          the Haskell defaulting mechanism for numeric types kicks
          in. This is useful information when converting code from a
          context that assumed one default into one with another,
          e.g., the `default default' for Haskell 1.4 caused the
1128
          otherwise unconstrained value <constant>1</constant> to be
1129 1130 1131 1132 1133 1134 1135 1136
          given the type <literal>Int</literal>, whereas Haskell 98
          defaults it to <literal>Integer</literal>.  This may lead to
          differences in performance and behaviour, hence the
          usefulness of being non-silent about this.</para>

	  <para>This warning is off by default.</para>
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
1137

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
      <varlistentry>
	<term><option>-fwarn-monomorphism-restriction</option>:</term>
	<listitem>
	  <indexterm><primary><option>-fwarn-monomorphism-restriction</option></primary></indexterm>
	  <indexterm><primary>monomorphism restriction, warning</primary></indexterm>
	  <para>Have the compiler warn/inform you where in your source
          the Haskell Monomorphism Restriction is applied.  If applied silently
	  the MR can give rise to unexpected behaviour, so it can be helpful
	  to have an explicit warning that it is being applied.</para>

	  <para>This warning is on by default.</para>
	</listitem>
      </varlistentry>

1152 1153 1154
      <varlistentry>
	<term><option>-fwarn-unused-binds</option>:</term>
	<listitem>
1155
	  <indexterm><primary><option>-fwarn-unused-binds</option></primary></indexterm>
1156 1157 1158 1159 1160
	  <indexterm><primary>unused binds, warning</primary></indexterm>
	  <indexterm><primary>binds, unused</primary></indexterm>
	  <para>Report any function definitions (and local bindings)
          which are unused.  For top-level functions, the warning is
          only given if the binding is not exported.</para>
1161 1162 1163 1164 1165 1166 1167
	  <para>A definition is regarded as "used" if (a) it is exported, or (b) it is
	    mentioned in the right hand side of another definition that is used, or (c) the 
	    function it defines begins with an underscore.  The last case provides a 
	    way to suppress unused-binding warnings selectively.  </para>
	  <para> Notice that a variable
	    is reported as unused even if it appears in the right-hand side of another
	    unused binding. </para>
1168 1169
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
1170

1171 1172 1173
      <varlistentry>
	<term><option>-fwarn-unused-imports</option>:</term>
	<listitem>
1174
	  <indexterm><primary><option>-fwarn-unused-imports</option></primary></indexterm>
1175 1176
	  <indexterm><primary>unused imports, warning</primary></indexterm>
	  <indexterm><primary>imports, unused</primary></indexterm>
rrt's avatar
rrt committed
1177

1178 1179 1180 1181
	  <para>Report any modules that are explicitly imported but
	  never used.  However, the form <literal>import M()</literal> is
	  never reported as an unused import, because it is a useful idiom
	  for importing instance declarations, which are anonymous in Haskell.</para>
1182 1183
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
1184

1185 1186 1187
      <varlistentry>
	<term><option>-fwarn-unused-matches</option>:</term>
	<listitem>
1188
	  <indexterm><primary><option>-fwarn-unused-matches</option></primary></indexterm>
1189 1190 1191 1192 1193 1194
	  <indexterm><primary>unused matches, warning</primary></indexterm>
	  <indexterm><primary>matches, unused</primary></indexterm>

	  <para>Report all unused variables which arise from pattern
          matches, including patterns consisting of a single variable.
          For instance <literal>f x y = []</literal> would report
1195
          <varname>x</varname> and <varname>y</varname> as unused.  The
1196 1197 1198 1199 1200
          warning is suppressed if the variable name begins with an underscore, thus:
	    <programlisting>
	       f _x = True
	    </programlisting>
          </para>
1201 1202
	</listitem>
      </varlistentry>
rrt's avatar
rrt committed
1203

1204
    </variablelist>
rrt's avatar
rrt committed
1205

1206
    <para>If you're feeling really paranoid, the
1207 1208 1209 1210 1211
    <option>-dcore-lint</option>
    option<indexterm><primary><option>-dcore-lint</option></primary></indexterm>
    is a good choice.  It turns on heavyweight intra-pass
    sanity-checking within GHC.  (It checks GHC's sanity, not
    yours.)</para>
rrt's avatar
rrt committed
1212

1213
  </sect1>
rrt's avatar
rrt committed
1214

1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
  &packages;

  <sect1 id="options-optimise">
    <title>Optimisation (code improvement)</title>

    <indexterm><primary>optimisation</primary></indexterm>
    <indexterm><primary>improvement, code</primary></indexterm>

    <para>The <option>-O*</option> options specify convenient
    &ldquo;packages&rdquo; of optimisation flags; the
    <option>-f*</option> options described later on specify
    <emphasis>individual</emphasis> optimisations to be turned on/off;
    the <option>-m*</option> options specify
    <emphasis>machine-specific</emphasis> optimisations to be turned
    on/off.</para>

    <sect2 id="optimise-pkgs">
      <title><option>-O*</option>: convenient &ldquo;packages&rdquo; of optimisation flags.</title>

      <para>There are <emphasis>many</emphasis> options that affect
      the quality of code produced by GHC.  Most people only have a
      general goal, something like &ldquo;Compile quickly&rdquo; or
      &ldquo;Make my program run like greased lightning.&rdquo; The
      following &ldquo;packages&rdquo; of optimisations (or lack
      thereof) should suffice.</para>

1241 1242 1243 1244 1245
      <para>Note that higher optimisation levels cause more
      cross-module optimisation to be performed, which can have an
      impact on how much of your program needs to be recompiled when
      you change something.  This is one reaosn to stick to
      no-optimisation when developing code.</para>
rrt's avatar
rrt committed
1246

1247
      <variablelist>
rrt's avatar
rrt committed
1248

1249
	<varlistentry>
1250 1251 1252 1253
	  <term>
            No <option>-O*</option>-type option specified:
            <indexterm><primary>-O* not specified</primary></indexterm>
          </term>
1254 1255 1256 1257 1258 1259 1260
	  <listitem>
	    <para>This is taken to mean: &ldquo;Please compile
            quickly; I'm not over-bothered about compiled-code
            quality.&rdquo; So, for example: <command>ghc -c
            Foo.hs</command></para>
	  </listitem>
	</varlistentry>
rrt's avatar
rrt committed
1261

1262
	<varlistentry>
1263 1264 1265 1266
	  <term>
            <option>-O0</option>:
            <indexterm><primary><option>-O0</option></primary></indexterm>
          </term>
1267 1268 1269 1270 1271 1272 1273 1274 1275
	  <listitem>
	    <para>Means &ldquo;turn off all optimisation&rdquo;,
	    reverting to the same settings as if no
	    <option>-O</option> options had been specified.  Saying
	    <option>-O0</option> can be useful if
	    eg. <command>make</command> has inserted a
	    <option>-O</option> on the command line already.</para>
	  </listitem>
	</varlistentry>
rrt's avatar
rrt committed
1276

1277
	<varlistentry>
1278 1279 1280 1281 1282 1283
	  <term>
            <option>-O</option> or <option>-O1</option>:
            <indexterm><primary>-O option</primary></indexterm>
            <indexterm><primary>-O1 option</primary></indexterm>
            <indexterm><primary>optimise</primary><secondary>normally</secondary></indexterm>
          </term>
1284 1285