@@ -7,7 +7,7 @@ flags and options apply to all of Stack's commands. In addition, all of Stack's
7
7
commands accept the ` --setup-info-yaml ` and ` --snapshot-location-base ` options
8
8
and the ` --help ` flag.
9
9
10
- ## The ` --allow-different-user ` flag
10
+ ## ` --allow-different-user ` flag
11
11
12
12
Restrictions: POSIX systems only
13
13
@@ -18,109 +18,109 @@ to use a Stack installation. For further information, see the documentation for
18
18
the corresponding non-project specific configuration
19
19
[ option] ( yaml_configuration.md#allow-different-user ) .
20
20
21
- ## The ` --arch ` option
21
+ ## ` --arch ` option
22
22
23
23
Pass the option ` --arch <architecture> ` to specify the relevant machine
24
24
architecture. For further information, see the documentation for the
25
25
corresponding non-project specific configuration
26
26
[ option] ( yaml_configuration.md#arch ) .
27
27
28
- ## The ` --color ` or ` -colour ` options
28
+ ## ` --color ` or ` -colour ` options
29
29
30
30
Pass the option ` stack --color <when> ` to specify when to use color in output.
31
31
For further information, see the documentation for the corresponding non-project
32
32
specific configuration [ option] ( yaml_configuration.md#color ) .
33
33
34
- ## The ` --compiler ` option
34
+ ## ` --compiler ` option
35
35
36
36
Pass the option ` --compiler <compiler> ` to specify the compiler. For further
37
37
information, see the [ YAML configuration] ( yaml_configuration.md#compiler )
38
38
documentation.
39
39
40
- ## The ` --custom-preprocessor-extensions ` option
40
+ ## ` --custom-preprocessor-extensions ` option
41
41
42
42
Pass the option ` --custom-preprocessor-extensions <extension> ` to specify an
43
43
extension used for a custom preprocessor. For further information, see the
44
44
documentation for the corresponding non-project specific configuration
45
45
[ option] ( yaml_configuration.md#custom-preprocessor-extensions ) .
46
46
47
- ## The ` --docker* ` flags and options
47
+ ## ` --docker* ` flags and options
48
48
49
49
Stack supports automatically performing builds inside a Docker container. For
50
50
further information see ` stack --docker-help ` or the
51
51
[ Docker integratiom] ( docker_integration.md ) documentation.
52
52
53
- ## The ` --[no-]dump-logs ` flag
53
+ ## ` --[no-]dump-logs ` flag
54
54
55
55
Default: Dump warning logs
56
56
57
57
Enables/disables the dumping of the build output logs for local packages to the
58
58
console. For further information, see the documentation for the corresponding
59
59
non-project specific configuration [ option] ( yaml_configuration.md#dump-logs ) .
60
60
61
- ## The ` --extra-include-dirs ` option
61
+ ## ` --extra-include-dirs ` option
62
62
63
63
Pass the option ` --extra-include-dirs <director> ` to specify an extra directory
64
64
to check for C header files. The option can be specified multiple times. For
65
65
further information, see the documentation for the corresponding non-project
66
66
specific configuration [ option] ( yaml_configuration.md#extra-include-dirs ) .
67
67
68
- ## The ` --extra-lib-dirs ` option
68
+ ## ` --extra-lib-dirs ` option
69
69
70
70
Pass the option ` --extra-lib-dirs <director> ` to specify an extra directory
71
71
to check for libraries. The option can be specified multiple times. For further
72
72
information, see the documentation for the corresponding non-project specific
73
73
configuration [ option] ( yaml_configuration.md#extra-lib-dirs ) .
74
74
75
- ## The ` --ghc-build ` option
75
+ ## ` --ghc-build ` option
76
76
77
77
Pass the option ` --ghc-build <build> ` to specify the relevant specialised GHC
78
78
build. For further information, see the documentation for the corresponding
79
79
non-project specific configuration [ option] ( yaml_configuration.md#ghc-build ) .
80
80
81
- ## The ` --ghc-variant ` option
81
+ ## ` --ghc-variant ` option
82
82
83
83
Pass the option ` --ghc-variant <variant> ` to specify the relevant GHC variant.
84
84
For further information, see the documentation for the corresponding non-project
85
85
specific configuration [ option] ( yaml_configuration.md#ghc-variant ) .
86
86
87
- ## The ` --hpack-numeric-version ` flag
87
+ ## ` --hpack-numeric-version ` flag
88
88
89
89
Pass the flag ` --hpack-numeric-version ` to cause Stack to report the numeric
90
90
version of its built-in Hpack library to standard output (e.g. ` 0.35.0 ` ) and
91
91
quit.
92
92
93
- ## The ` --[no-]install-ghc ` flag
93
+ ## ` --[no-]install-ghc ` flag
94
94
95
95
Default: Enabled
96
96
97
97
Enables/disables the download and instalation of GHC if necessary. For further
98
98
information, see the documentation for the corresponding non-project specific
99
99
configuration [ option] ( yaml_configuration.md#install-ghc ) .
100
100
101
- ## The ` --jobs ` or ` -j ` option
101
+ ## ` --jobs ` or ` -j ` option
102
102
103
103
Pass the option ` --jobs <number_of_jobs> ` to specify the number of concurrent
104
104
jobs to run. For further information, see the documentation for the
105
105
corresponding non-project specific configuration
106
106
[ option] ( yaml_configuration.md#jobs ) .
107
107
108
- ## The ` --local-bin-path ` option
108
+ ## ` --local-bin-path ` option
109
109
110
110
Pass the option ` --local-bin-path <directory> ` to specify the directory in which
111
111
Stack installs executables. For further information, see the documentation for
112
112
the corresponding non-project specific configuration
113
113
[ option] ( yaml_configuration.md#local-bin-path ) .
114
114
115
- ## The ` --lock-file ` option
115
+ ## ` --lock-file ` option
116
116
117
117
Default: ` read-write ` , if snapshot specified in YAML configuration file;
118
118
` read-only ` , if a different snapshot is specified on the command line.
119
119
120
120
Pass the option ` --lock-file <mode> ` to specify how Stack interacts with lock
121
121
files. Valid modes are ` error-on-write ` , ` ignore ` , ` read-only ` and ` read-write ` .
122
122
123
- ## The ` --[no-]modify-code-page ` flag
123
+ ## ` --[no-]modify-code-page ` flag
124
124
125
125
Restrictions: Windows systems only
126
126
@@ -130,23 +130,23 @@ Enables/disables setting the codepage to support UTF-8. For further information,
130
130
see the documentation for the corresponding non-project specific configuration
131
131
[ option] ( yaml_configuration.md#modify-code-page ) .
132
132
133
- ## The ` --nix* ` flags and options
133
+ ## ` --nix* ` flags and options
134
134
135
135
Stack can be configured to integrate with Nix. For further information, see
136
136
` stack --nix-help ` or the [ Nix integration] ( nix_integration.md ) documentation.
137
137
138
- ## The ` --numeric-version ` flag
138
+ ## ` --numeric-version ` flag
139
139
140
140
Pass the flag ` --numeric-version ` to cause Stack to report its numeric version
141
141
to standard output (e.g. ` 2.9.1 ` ) and quit.
142
142
143
- ## The ` --resolver ` option
143
+ ## ` --resolver ` option
144
144
145
145
Pass the option ` --resolver <snapshot> ` to specify the snapshot. For further
146
146
information, see the
147
147
[ YAML configuration] ( yaml_configuration.md#resolver-or-snapshot ) documentation.
148
148
149
- ## The ` --[no-]rsl-in-log ` flag
149
+ ## ` --[no-]rsl-in-log ` flag
150
150
151
151
[ :octicons-tag-24: 2.9.1] ( https://github.com/commercialhaskell/stack/releases/tag/v2.9.1 )
152
152
@@ -156,26 +156,26 @@ Enables/disables the logging of the raw snapshot layer (rsl) in debug output.
156
156
Information about the raw snapshot layer can be lengthy. If you do not need it,
157
157
it is best omitted from the debug output.
158
158
159
- ## The ` --[no-]script-no-run-compile ` flag
159
+ ## ` --[no-]script-no-run-compile ` flag
160
160
161
161
Default: Disabled
162
162
163
163
Enables/disables the use of options ` --no-run --compile ` with the
164
164
[ ` stack script ` command] ( script_command.md ) .
165
165
166
- ## The ` --silent ` flag
166
+ ## ` --silent ` flag
167
167
168
168
Equivalent to the ` --verbosity silent ` option.
169
169
170
- ## The ` --[no-]skip-ghc-check ` option
170
+ ## ` --[no-]skip-ghc-check ` option
171
171
172
172
Default: Disabled
173
173
174
174
Enables/disables the skipping of checking the GHC version and architecture. For
175
175
further information, see the documentation for the corresponding non-project
176
176
specific configuration [ option] ( yaml_configuration.md#skip-ghc-check ) .
177
177
178
- ## The ` --[no-]skip-msys ` option
178
+ ## ` --[no-]skip-msys ` option
179
179
180
180
Restrictions: Windows systems only
181
181
@@ -185,20 +185,20 @@ Enables/disables the skipping of installing MSYS2. For further information, see
185
185
the documentation for the corresponding non-project specific configuration
186
186
[ option] ( yaml_configuration.md#skip-msys ) .
187
187
188
- ## The ` --stack-colors ` or ` --stack-colours ` options
188
+ ## ` --stack-colors ` or ` --stack-colours ` options
189
189
190
190
Pass the option ` --stack-colors <styles> ` to specify Stack's output styles. For
191
191
further information, see the documentation for the corresponding non-project
192
192
specific configuration [ option] ( yaml_configuration.md#stack-colors ) .
193
193
194
- ## The ` --stack-root ` option
194
+ ## ` --stack-root ` option
195
195
196
196
Overrides: ` STACK_ROOT ` environment variable
197
197
198
198
Pass the option ` --stack-root <absolute_path_to_the_Stack_root> ` to specify the
199
199
path to the Stack root directory. The path must be an absolute one.
200
200
201
- ## The ` --stack-yaml ` option
201
+ ## ` --stack-yaml ` option
202
202
203
203
Default: ` stack.yaml `
204
204
@@ -207,64 +207,64 @@ Overrides: `STACK_YAML` enviroment variable
207
207
Pass the option ` --stack-yaml <file> ` to specify Stack's project-level YAML
208
208
configuration file.
209
209
210
- ## The ` --[no-]system-ghc ` flag
210
+ ## ` --[no-]system-ghc ` flag
211
211
212
212
Default: Disabled
213
213
214
214
Enables/disables the use of a GHC executable on the PATH, if one is available
215
215
and its version matches.
216
216
217
- ## The ` --[no-]terminal ` flag
217
+ ## ` --[no-]terminal ` flag
218
218
219
219
Default: Stack is running in a terminal (as detected)
220
220
221
221
Enables/disables whether Stack is running in a terminal.
222
222
223
- ## The ` --terminal-width ` option
223
+ ## ` --terminal-width ` option
224
224
225
225
Default: the terminal width (if detected); otherwise ` 100 `
226
226
227
227
Pass the option ` --terminal-width <width> ` to specify the width of the terminal,
228
228
used by Stack's pretty printed messages.
229
229
230
- ## The ` --[no-]time-in-logs ` flag
230
+ ## ` --[no-]time-in-logs ` flag
231
231
232
232
Default: Enabled
233
233
234
234
Enables/disables the inclusion of time stamps against logging entries when the
235
235
verbosity level is 'debug'.
236
236
237
- ## The ` --verbose ` or ` -v ` flags
237
+ ## ` --verbose ` or ` -v ` flags
238
238
239
239
Equivalent to the ` --verbosity debug ` option.
240
240
241
- ## The ` --verbosity ` option
241
+ ## ` --verbosity ` option
242
242
243
243
Default: ` info `
244
244
245
245
Pass the option ` --verbosity <log_level> ` to specify the level for logging.
246
246
Possible levels are ` silent ` , ` error ` , ` warn ` , ` info ` and ` debug ` , in order of
247
247
increasing amounts of information provided by logging.
248
248
249
- ## The ` --version ` flag
249
+ ## ` --version ` flag
250
250
251
251
Pass the flag ` --version ` to cause Stack to report its version to standard
252
252
output and quit. For versions that are release candidates, the report will list
253
253
the dependencies that Stack has been compiled with.
254
254
255
- ## The ` --with-gcc ` option
255
+ ## ` --with-gcc ` option
256
256
257
257
Pass the option ` --with-gcc <path_to_gcc> ` to specify use of a GCC executable.
258
258
For further information, see the documentation for the corresponding non-project
259
259
specific configuration [ option] ( yaml_configuration.md#with-gcc ) .
260
260
261
- ## The ` --with-hpack ` option
261
+ ## ` --with-hpack ` option
262
262
263
263
Pass the option ` --with-hpack <hpack> ` to specify use of an Hpack executable.
264
264
For further information, see the documentation for the corresponding
265
265
non-project specific configuration [ option] ( yaml_configuration.md#with-hpack ) .
266
266
267
- ## The ` --work-dir ` option
267
+ ## ` --work-dir ` option
268
268
269
269
Default: ` .stack-work `
270
270
@@ -278,21 +278,21 @@ path must be a relative one, relative to the the root directory of the project
278
278
or package. The relative path cannot include a ` .. ` (parent directory)
279
279
component.
280
280
281
- ## The ` --setup-info-yaml ` command option
281
+ ## ` --setup-info-yaml ` command option
282
282
283
283
Default: ` https://raw.githubusercontent.com/commercialhaskell/stackage-content/master/stack/stack-setup-2.yaml `
284
284
285
285
The ` --setup-info-yaml <url> ` command option specifies the location of a
286
286
` setup-info ` dictionary. The option can be specified multiple times.
287
287
288
- ## The ` --snapshot-location-base ` command option
288
+ ## ` --snapshot-location-base ` command option
289
289
290
290
Default: ` https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master `
291
291
292
292
The ` --snapshot-location-base <url> ` command option specifies the base location
293
293
of snapshots.
294
294
295
- ## The ` --help ` command flag
295
+ ## ` --help ` command flag
296
296
297
297
If Stack is passed the ` --help ` command flag, it will output help for the
298
298
command.
0 commit comments