Skip to content

Commit c2e5af3

Browse files
author
Tristan Webb
committed
Introducing a man page
1 parent a0c4f3c commit c2e5af3

File tree

1 file changed

+222
-0
lines changed

1 file changed

+222
-0
lines changed

‎man/man1/stack.1

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
.TH STACK 1 "" "1.14.0.4"
2+
.SH NAME
3+
stack - The Haskell Tool Stack
4+
.SH SYNOPSIS
5+
.sp
6+
.nf
7+
\fIstack [\-\-version] [\-\-help] [\-\-docker*] ([\-\-verbosity VERBOSITY] |
8+
[\-v|\-\-verbose]) ([\-\-system\-ghc] | [\-\-no\-system\-ghc])
9+
([\-\-install\-ghc] | [\-\-no\-install\-ghc]) [\-\-arch ARCH] [\-\-os OS]
10+
[\-j|\-\-jobs JOBS] [\-\-extra\-include\-dirs DIR] [\-\-extra\-lib\-dirs DIR]
11+
[\-\-resolver RESOLVER] [\-\-no\-terminal] COMMAND
12+
.fi
13+
.sp
14+
.SH "DESCRIPTION"
15+
.SS The Haskell Tool Stack
16+
.PP
17+
\f[B]stack\fR is a cross\-platform program for developing Haskell
18+
projects.
19+
It is aimed at Haskellers both new and experienced.
20+
.PP
21+
.PP
22+
It features:
23+
.IP \[bu] 2
24+
Installing GHC automatically.
25+
.IP \[bu] 2
26+
Installing packages needed for your project.
27+
.IP \[bu] 2
28+
Building your project.
29+
.IP \[bu] 2
30+
Testing your project.
31+
.IP \[bu] 2
32+
Benchmarking your project.
33+
.SS How to use
34+
.PP
35+
Go into a Haskell project directory and run \f[C]stack\ build\f[].
36+
If everything is already configured, this will:
37+
.IP \[bu] 2
38+
Download the package index.
39+
.IP \[bu] 2
40+
Download and install all necessary dependencies for the project.
41+
.IP \[bu] 2
42+
Build and install the project.
43+
.PP
44+
You may be prompted to run some of the following along the way:
45+
.IP \[bu] 2
46+
\f[B]stack\ new\f[] to create a brand new project.
47+
.IP \[bu] 2
48+
\f[B]stack\ init\f[] to create a stack configuration file for an
49+
existing project. stack will figure out what Stackage release (LTS or nightly) is
50+
appropriate for the dependencies.
51+
.IP \[bu] 2
52+
\f[B]stack\ setup\f[] to download and install the correct GHC version.
53+
(For information on installation paths, please use the
54+
\f[B]stack\ path\f[] command.)
55+
.PP
56+
.PP stack - The Haskell Tool Stack
57+
58+
.SH "STACK COMMANDS"
59+
60+
.PP
61+
\fBbuild\fR
62+
.RS 4
63+
Build the project(s) in this directory/configuration\&
64+
.RE
65+
.PP
66+
\fBinstall\fR
67+
.RS 4
68+
Build executables and install to a user path\&
69+
.RE
70+
.PP
71+
\fBtest\fR
72+
.RS 4
73+
Build and test the project(s) in this directory /configuration\&
74+
.RE
75+
.PP
76+
\fBbench\fR
77+
.RS 4
78+
Build and benchmark the project(s) in this directory /configuration\&
79+
.RE
80+
.PP
81+
\fBhaddock\fR
82+
.RS 4
83+
Generate haddocks for the project(s) in this directory /configuration\&
84+
.RE
85+
.PP
86+
\fBnew\fR
87+
.RS 4
88+
Create a brand new project\&
89+
.RE
90+
.PP
91+
\fBinit\fR
92+
.RS 4
93+
Initialize a stack project based on one or more cabal packages\&
94+
.RE
95+
.PP
96+
\fBsetup\fR
97+
.RS 4
98+
Get the appropriate ghc for your project\&
99+
.RE
100+
.PP
101+
\fBunpack\fR
102+
.RS 4
103+
Unpack one or more packages locally\&
104+
.RE
105+
.PP
106+
\fBupdate\fR
107+
.RS 4
108+
Update the package index\&
109+
.RE
110+
.PP
111+
\fBupload\fR
112+
.RS 4
113+
Upload a package to Hackage\&
114+
.RE
115+
.PP
116+
\fBexec\fR
117+
.RS 4
118+
Execute a command\&
119+
.RE
120+
.PP
121+
\fBghc\fR
122+
.RS 4
123+
Run ghc\&
124+
.RE
125+
.PP
126+
\fBghci\fR
127+
.RS 4
128+
Run ghci in the context of project(s)\&
129+
.RE
130+
.PP
131+
\fBrunghc\fR
132+
.RS 4
133+
Run runghc\&
134+
.RE
135+
.PP
136+
\fBclean\fR
137+
.RS 4
138+
Clean the local packages\&
139+
.RE
140+
.PP
141+
\fBpath\fR
142+
.RS 4
143+
Print path information for certain things
144+
.RE
145+
.PP
146+
\fBdocker\fR
147+
.RS 4
148+
Subcommands specific to Docker use
149+
.RE
150+
.PP
151+
152+
.SH "OPTIONS"
153+
.SS "GLOBAL OPTIONS"
154+
.nf
155+
\-\-version Show version
156+
\-\-help Show this help text
157+
\-\-docker* Run 'stack \-\-docker\-help' for details
158+
\-\-verbosity VERBOSITY Verbosity: silent, error, warn, info, debug
159+
\-v,\-\-verbose Enable verbose mode: verbosity level "debug"
160+
\-\-system\-ghc Enable using the system installed GHC (on the PATH)
161+
if available and a matching version
162+
\-\-no\-system\-ghc Disable using the system installed GHC (on the PATH)
163+
if available and a matching version
164+
\-\-install\-ghc Enable downloading and installing GHC if necessary
165+
(can be done manually with stack setup)
166+
\-\-no\-install\-ghc Disable downloading and installing GHC if necessary
167+
(can be done manually with stack setup)
168+
\-\-arch ARCH System architecture, e.g. i386, x86_64
169+
\-\-os OS Operating system, e.g. linux, windows
170+
\-j,\-\-jobs JOBS Number of concurrent jobs to run
171+
\-\-extra\-include\-dirs DIR Extra directories to check for C header files
172+
\-\-extra\-lib\-dirs DIR Extra directories to check for libraries
173+
\-\-resolver RESOLVER Override resolver in project file
174+
\-\-no\-terminal Override terminal detection in the case of running in
175+
a false terminal
176+
.fi
177+
.PP
178+
.SS "BUILD OPTIONS"
179+
The following options are shared between the build, install, test, bench commands.
180+
.nf
181+
TARGET If none specified, use all packages defined in
182+
current directory
183+
\-\-library\-profiling Enable library profiling for TARGETs and all its
184+
dependencies
185+
\-\-no\-library\-profiling Disable library profiling for TARGETs and all its
186+
dependencies
187+
\-\-executable\-profiling Enable library profiling for TARGETs and all its
188+
dependencies
189+
\-\-no\-executable\-profiling
190+
Disable library profiling for TARGETs and all its
191+
dependencies
192+
\-\-optimizations Enable optimizations for TARGETs and all its
193+
dependencies
194+
\-\-no\-optimizations Disable optimizations for TARGETs and all its
195+
dependencies
196+
\-\-dry\-run Don't build anything, just prepare to
197+
\-\-pedantic Turn on \-Wall and \-Werror (note: option name may
198+
change in the future
199+
\-\-ghc\-options OPTION Additional options passed to GHC
200+
\-\-flag PACKAGE:[\-]FLAG Override flags set in stack.yaml (applies to local
201+
packages and extra\-deps)
202+
\-\-prefetch Fetch packages necessary for the build immediately,
203+
useful with \-\-dry\-run
204+
\-\-test\-arguments TEST_ARGS
205+
Arguments passed in to the test suite program
206+
\-\-only\-snapshot Only build packages for the snapshot database, not
207+
the local database
208+
.fi
209+
.PP
210+
.SS "ADDITIONAL OPTIONS"
211+
Additional options can be read by running \fBstack\fR <command> \fB\-\-help\fR
212+
213+
.SS "ENVIRONMENTAL VARIABLES"
214+
\fBSTACK_YAML\fR
215+
.RS 4
216+
The path to the project's yaml config file, if unset will default to "./stack.yaml"\&
217+
.RE
218+
.PP
219+
220+
.SH "REPORTING BUGS"
221+
.sp
222+
Report bugs to the issue tracker<https://www.github.com/commercialhaskell/stack> where the development and maintenance is primarily done\&.

0 commit comments

Comments
 (0)