summaryrefslogtreecommitdiff
path: root/docs/users_guide/ghc.rst
blob: bbf10d7f1aa371fa3e052b2e80a6d319b63c1971 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
: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 <https://downloads.haskell.org/ghc/latest/docs/users_guide.pdf>`_ and `HTML <https://downloads.haskell.org/ghc/latest/docs/html/>`_.

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
-------

.. flag-print::
    :type: summary
    :category: codegen


.. flag-print::
    :type: summary
    :category: debugging


.. flag-print::
    :type: summary
    :category: cpp


.. flag-print::
    :type: summary
    :category: search-path


.. flag-print::
    :type: summary
    :category: interactive


.. flag-print::
    :type: summary
    :category: interface-files


.. flag-print::
    :type: summary
    :category: keep-intermediates


.. flag-print::
    :type: summary
    :category: language


.. flag-print::
    :type: summary
    :category: linking


.. flag-print::
    :type: summary
    :category: misc


.. flag-print::
    :type: summary
    :category: modes


.. flag-print::
    :type: summary
    :category: optimization


.. flag-print::
    :type: summary
    :category: optimization-levels


.. flag-print::
    :type: summary
    :category: packages


.. flag-print::
    :type: summary
    :category: phases


.. flag-print::
    :type: summary
    :category: phase-programs


.. flag-print::
    :type: summary
    :category: phase-options


.. flag-print::
    :type: summary
    :category: platform-options


.. flag-print::
    :type: summary
    :category: plugins


.. flag-print::
    :type: summary
    :category: profiling


.. flag-print::
    :type: summary
    :category: coverage


.. flag-print::
    :type: summary
    :category: recompilation


.. flag-print::
    :type: summary
    :category: redirect-output


.. flag-print::
    :type: summary
    :category: temp-files


.. flag-print::
    :type: summary
    :category: verbosity


.. flag-print::
    :type: summary
    :category: warnings


Code generation
~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: codegen

Debugging the compiler
~~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: debugging

C pre-processor
~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: cpp

Finding imports
~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: search-path

Interactive mode
~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: interactive

Interface files
~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: interface-files

Keeping intermediate files
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: keep-intermediates

Language options
~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: language

Linking options
~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: linking

Miscellaneous options
~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: misc

Modes of operation
~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: modes

Individual optimizations
~~~~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: optimization

Optimization levels
~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: optimization-levels

Package options
~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: packages

Phases of compilation
~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: phases

Overriding external programs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: phase-programs

Phase-specific options
~~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: phase-options

Platform-specific options
~~~~~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: platform-options

Compiler plugins
~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: plugins

Profiling
~~~~~~~~~

.. flag-print::
    :type: list
    :category: profiling

Program coverage
~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: coverage

Recompilation checking
~~~~~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: recompilation

Redirecting output
~~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: redirect-output

Temporary files
~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: temp-files

Verbosity options
~~~~~~~~~~~~~~~~~

.. flag-print::
    :type: list
    :category: verbosity

Warnings
~~~~~~~~

.. flag-print::
    :type: list
    :category: warnings

Copyright
---------

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

See also
--------

https://www.haskell.org/ghc     the GHC homepage