summaryrefslogtreecommitdiff
path: root/docs/users_guide/ghc.rst
blob: a44c9d94f6c9013ad6e2226495bf9adfd5d9fc66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
:orphan:

GHC
===

Synopsis
--------

::

    ghc [option|filename]
    ghci [option|filename]


Description
-----------

This manual page documents briefly the ``ghc`` and ``ghci`` commands. Note that
``ghci`` is not yet available on all architectures. Extensive documentation is
available in various other formats including PDF and HTML; see below.

Each of GHC's command line options is classified as either *static* or
*dynamic*. A static flag may only be specified on the command line, whereas a
dynamic flag may also be given in an ``OPTIONS`` pragma in a source file or
set from the GHCi command-line with ``:set`` .

As a rule of thumb, all the language options are dynamic, as are the
warning options and the debugging options.

The rest are static, with the notable exceptions of
``-v``, ``-cpp``, ``-fasm``, ``-fvia-C``, ``-fllvm``, and
``-#include``.
The OPTIONS sections lists the status of each flag.

Common suffixes of file names for Haskell are:

``.hs``
    Haskell source code; preprocess, compile

``.lhs``
    literate Haskell source; unlit, preprocess, compile

``.hi``
    Interface file; contains information about exported symbols

``.hc``
    intermediate C files

``.⟨way⟩_o``
    object files for "way" ⟨way⟩; common ways are:

    ``dyn``
        dynamically-linked
    ``p``
        built with profiling

``.⟨way⟩_hi``
    interface files for "way" ⟨way⟩; common ways are:

.. _options-ref:

Options
-------

.. include:: all-flags.gen.rst

Copyright
---------

Copyright 2015. The University Court of the University of Glasgow.
All rights reserved.