Skip to content

Commit 3288160

Browse files
committed
Start documenting Stack flags and options
1 parent 697134c commit 3288160

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

doc/GUIDE_advanced.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,60 @@ Some of Stack's features will not be needed regularly or by all users. This part
66
of the guide provides information about those features. Some of the features are
77
complex and separate pages are dedicated to them.
88

9+
## The `stack --hpack-numeric-version` flag
10+
11+
Stack will report the numeric version of its built-in Hpack library to standard
12+
output (e.g. `0.35.0`) and quit.
13+
14+
## The `stack --numeric-version` flag
15+
16+
Stack will report its numeric version to standard output (e.g. `2.7.5`) and
17+
quit.
18+
19+
## The `stack --silent` flag
20+
21+
Equivalent to the `stack --verbosity silent` option.
22+
23+
## The `stack --stack-root` option
24+
25+
`stack --stack-root <absolute_path_to_the_Stack_root>` specifies the path to the
26+
Stack root directory. The path must be an absolute one. The option will override
27+
the contents of any `STACK_ROOT` environment variable.
28+
29+
## The `stack --[no-]time-in-logs` flag
30+
31+
Default: Enabled
32+
33+
Enables/disables the inclusion of time stamps against logging entries when the
34+
verbosity level is 'debug'.
35+
36+
## The `stack -v, --verbose` flags
37+
38+
Equivalent to the `stack --verbosity debug` option.
39+
40+
## The `stack --verbosity` option
41+
42+
Default: info
43+
44+
`stack --verbosity <log_level>` will set the level for logging. Possible levels
45+
are `silent`, `error`, `warn`, `info` and `debug`, in order of increasing
46+
amounts of information provided by logging.
47+
48+
## The `stack --version` flag
49+
50+
Stack will report its version to standard output and quit. For versions that are
51+
release candidates, the report will list the dependencies that Stack has been
52+
compiled with.
53+
54+
## The `stack --work-dir` option
55+
56+
Default: `.stack-work`
57+
58+
`stack --work-dir <relative_path_to_the_Stack_root>` specifies the path to
59+
Stack's work directory for the project. The path must be a relative one,
60+
relative to the project's root directory. The option will override the contents
61+
of any `STACK_WORK` environment variable.
62+
963
## The `stack build` command
1064

1165
The `stack build` command is introduced in the first part of

0 commit comments

Comments
 (0)