1CABAL(1) General Commands Manual CABAL(1)
2
3
4
6 cabal - a system for building and packaging Haskell libraries and pro‐
7 grams
8
10 cabal command <arguments|[options]>...
11
12 Where the commands are
13
14 cabal list - List packages matching a search string.
15 cabal info - Display detailed information about a particular package.
16 cabal fetch - Downloads packages for later installation.
17 cabal get - Download/Extract a package's source code (repository).
18 cabal check - Check the package for common mistakes.
19 cabal upload - Uploads source packages or documentation to Hackage.
20 cabal report - Upload build reports to a remote server.
21 cabal init - Create a new .cabal package file (interactively).
22 cabal user-config - Display and update the user's global cabal configu‐
23 ration.
24 cabal gen-bounds - Generate dependency bounds.
25 cabal outdated - Check for outdated dependencies
26 cabal hscolour - Generate HsColour colourised code, in HTML format.
27 cabal v2-configure - Add extra project configuration
28 cabal new-configure - Add extra project configuration
29 cabal v2-update - Updates list of known packages.
30 cabal new-update - Updates list of known packages.
31 cabal v2-build - Compile targets within the project.
32 cabal new-build - Compile targets within the project.
33 cabal v2-repl - Open an interactive session for the given component.
34 cabal new-repl - Open an interactive session for the given component.
35 cabal v2-freeze - Freeze dependencies.
36 cabal new-freeze - Freeze dependencies.
37 cabal v2-haddock - Build Haddock documentation
38 cabal new-haddock - Build Haddock documentation
39 cabal v2-install - Install packages.
40 cabal new-install - Install packages.
41 cabal v2-run - Run an executable.
42 cabal new-run - Run an executable.
43 cabal v2-test - Run test-suites
44 cabal new-test - Run test-suites
45 cabal v2-bench - Run benchmarks
46 cabal new-bench - Run benchmarks
47 cabal v2-exec - Give a command access to the store.
48 cabal new-exec - Give a command access to the store.
49 cabal v2-clean - Clean the package store and remove temporary files.
50 cabal new-clean - Clean the package store and remove temporary files.
51 cabal v2-sdist - Generate a source distribution file (.tar.gz).
52 cabal new-sdist - Generate a source distribution file (.tar.gz).
53 cabal configure - Prepare to build the package.
54 cabal v1-configure - Prepare to build the package.
55 cabal update - Updates list of known packages.
56 cabal v1-update - Updates list of known packages.
57 cabal build - Compile all/specific components.
58 cabal v1-build - Compile all/specific components.
59 cabal repl - Open an interpreter session for the given component.
60 cabal v1-repl - Open an interpreter session for the given component.
61 cabal freeze - Freeze dependencies.
62 cabal v1-freeze - Freeze dependencies.
63 cabal haddock - Generate Haddock HTML documentation.
64 cabal v1-haddock - Generate Haddock HTML documentation.
65 cabal install - Install packages.
66 cabal v1-install - Install packages.
67 cabal run - Builds and runs an executable.
68 cabal v1-run - Builds and runs an executable.
69 cabal test - Run all/specific tests in the test suite.
70 cabal v1-test - Run all/specific tests in the test suite.
71 cabal bench - Run all/specific benchmarks.
72 cabal v1-bench - Run all/specific benchmarks.
73 cabal exec - Give a command access to the sandbox package repository.
74 cabal v1-exec - Give a command access to the sandbox package reposi‐
75 tory.
76 cabal clean - Clean up after a build.
77 cabal v1-clean - Clean up after a build.
78 cabal sdist - Generate a source distribution file (.tar.gz).
79 cabal v1-sdist - Generate a source distribution file (.tar.gz).
80 cabal doctest - Run doctest tests.
81 cabal v1-doctest - Run doctest tests.
82 cabal copy - Copy the files of all/specific components to install loca‐
83 tions.
84 cabal v1-copy - Copy the files of all/specific components to install
85 locations.
86 cabal register - Register this package with the compiler.
87 cabal v1-register - Register this package with the compiler.
88 cabal reconfigure - Reconfigure the package if necessary.
89 cabal v1-reconfigure - Reconfigure the package if necessary.
90 cabal sandbox - Create/modify/delete a sandbox.
91 cabal v1-sandbox - Create/modify/delete a sandbox.
92
94 Cabal is the standard package system for Haskell software. It helps
95 people to configure, build and install Haskell software and to distrib‐
96 ute it easily to other users and developers.
97
98 The command line cabal tool (also referred to as cabal-install) helps
99 with installing existing packages and developing new packages. It can
100 be used to work with local packages or to install packages from online
101 package archives, including automatically installing dependencies. By
102 default it is configured to use Hackage, which is Haskell's central
103 package archive that contains thousands of libraries and applications
104 in the Cabal package format.
105
107 Global options:
108
109 -V, --version
110 Print version information
111
112 --numeric-version
113 Print just the version number
114
115 --config-file FILE
116 Set an alternate location for the config file
117
118 --sandbox-config-file FILE
119 Set an alternate location for the sandbox config file (default:
120 './cabal.sandbox.config')
121
122 --default-user-config FILE
123 Set a location for a cabal.config file for projects without
124 their own cabal.config freeze file.
125
126 --require-sandbox
127 --no-require-sandbox
128 requiring the presence of a sandbox for sandbox-aware commands
129
130 --ignore-sandbox
131 Ignore any existing sandbox
132
133 --ignore-expiry
134 Ignore expiry dates on signed metadata (use only in exceptional
135 circumstances)
136
137 --http-transport HttpTransport
138 Set a transport for http(s) requests. Accepts 'curl', 'wget',
139 'powershell', and 'plain-http'. (default: 'curl')
140
141 --enable-nix
142 --disable-nix
143 Nix integration: run commands through nix-shell if a 'shell.nix'
144 file exists
145
146 --remote-repo NAME:URL
147 The name and url for a remote repository
148
149 --remote-repo-cache DIR
150 The location where downloads from all remote repos are cached
151
152 --local-repo DIR
153 The location of a local repository
154
155 --logs-dir, --logsdir DIR
156 The location to put log files
157
158 --world-file FILE
159 The location of the world file
160
161 --store-dir, --storedir DIR
162 The location of the nix-local-build store
163
164
166 cabal list
167
168 Usage: cabal list [FLAGS]
169 or: cabal list [FLAGS] STRINGS
170
171
172 List all packages, or all packages matching one of the search strings.
173
174 If there is a sandbox in the current directory and config:ignore-sand‐
175 box is False, use the sandbox package database. Otherwise, use the
176 package database specified with --package-db. If not specified, use the
177 user package database.
178
179
180 Examples:
181 cabal list pandoc
182 Will find pandoc, pandoc-citeproc, pandoc-lens, ...
183
184
185 Flags:
186 -v, --verbose [n]
187 Control verbosity (n is 0--3, default verbosity level is
188 1)
189
190 --installed
191 Only print installed packages
192
193 --simple-output
194 Print in a easy-to-parse format
195
196 --package-db DB
197 Append the given package database to the list of package
198 databases used (to satisfy dependencies and register
199 into). May be a specific file, 'global' or 'user'. The
200 initial list is ['global'], ['global', 'user'], or
201 ['global', $sandbox], depending on context. Use 'clear'
202 to reset the list to empty. See the user guide for
203 details.
204
205
206 cabal info
207
208 Usage: cabal info [FLAGS] PACKAGES
209
210
211 If there is a sandbox in the current directory and config:ignore-sand‐
212 box is False, use the sandbox package database. Otherwise, use the
213 package database specified with --package-db. If not specified, use the
214 user package database.
215
216
217 Flags:
218 -v, --verbose [n]
219 Control verbosity (n is 0--3, default verbosity level is
220 1)
221
222 --package-db DB
223 Append the given package database to the list of package
224 databases used (to satisfy dependencies and register
225 into). May be a specific file, 'global' or 'user'. The
226 initial list is ['global'], ['global', 'user'], or
227 ['global', $sandbox], depending on context. Use 'clear'
228 to reset the list to empty. See the user guide for
229 details.
230
231
232 cabal fetch
233
234 Usage: cabal fetch [FLAGS] PACKAGES
235
236
237 Note that it currently is not possible to fetch the dependencies for a
238 package in the current directory.
239
240
241 Flags:
242 -v, --verbose [n]
243 Control verbosity (n is 0--3, default verbosity level is
244 1)
245
246 --dependencies, --deps
247 Resolve and fetch dependencies (default)
248
249 --no-dependencies, --no-deps
250 Ignore dependencies
251
252 --dry-run
253 Do not install anything, only print what would be
254 installed.
255
256 --enable-tests
257 --disable-tests
258 dependency checking and compilation for test suites
259 listed in the package description file.
260
261 --enable-benchmarks
262 --disable-benchmarks
263 dependency checking and compilation for benchmarks listed
264 in the package description file.
265
266 --solver SOLVER
267 Select dependency solver to use (default: modular).
268 Choices: modular.
269
270 --max-backjumps NUM
271 Maximum number of backjumps allowed while solving
272 (default: 2000). Use a negative number to enable unlim‐
273 ited backtracking. Use 0 to disable backtracking com‐
274 pletely.
275
276 --reorder-goals
277 --no-reorder-goals
278 Try to reorder goals according to certain heuristics.
279 Slows things down on average, but may make backtracking
280 faster for some packages.
281
282 --count-conflicts
283 --no-count-conflicts
284 Try to speed up solving by preferring goals that are
285 involved in a lot of conflicts (default).
286
287 --independent-goals
288 --no-independent-goals
289 Treat several goals on the command line as independent.
290 If several goals depend on the same package, different
291 versions can be chosen.
292
293 --shadow-installed-packages
294 --no-shadow-installed-packages
295 If multiple package instances of the same version are
296 installed, treat all but one as shadowed.
297
298 --strong-flags
299 --no-strong-flags
300 Do not defer flag choices (this used to be the default in
301 cabal-install <= 1.20).
302
303 --allow-boot-library-installs
304 --no-allow-boot-library-installs
305 Allow cabal to install base, ghc-prim, integer-simple,
306 integer-gmp, and template-haskell.
307
308
309 cabal get
310
311 Usage: cabal get [PACKAGES]
312
313
314 Creates a local copy of a package's source code. By default it gets the
315 source tarball and unpacks it in a local subdirectory. Alternatively,
316 with -s it will get the code from the source repository specified by
317 the package.
318
319
320 Examples:
321 cabal get hlint
322 Download the latest stable version of hlint;
323 cabal get lens --source-repository=head
324 Download the source repository (i.e. git clone from github).
325
326
327 Flags:
328 -v, --verbose [n]
329 Control verbosity (n is 0--3, default verbosity level is
330 1)
331
332 -d, --destdir PATH
333 Where to place the package source, defaults to the cur‐
334 rent directory.
335
336 -s, --source-repository [[head|this|...]]
337 Copy the package's source repository (ie git clone, darcs
338 get, etc as appropriate).
339
340 --index-state STATE
341 Use source package index state as it existed at a previ‐
342 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
343 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
344 'HEAD' (default: 'HEAD'). This determines which package
345 versions are available as well as .cabal file revision is
346 selected (unless --pristine is used).
347
348 --pristine
349 Unpack the original pristine tarball, rather than updat‐
350 ing the .cabal file with the latest revision from the
351 package archive.
352
353
354 cabal check
355
356 Usage: cabal check [FLAGS]
357
358
359 Expects a .cabal package file in the current directory.
360
361 The checks correspond to the requirements to packages on Hackage. If no
362 errors and warnings are reported, Hackage will accept this package.
363
364
365 Flags:
366 -v, --verbose [n]
367 Control verbosity (n is 0--3, default verbosity level is
368 1)
369
370
371 cabal upload
372
373 Usage: cabal upload [FLAGS] TARFILES
374
375
376 You can store your Hackage login in the ~/.cabal/config file Relevant
377 global configuration keys:
378 username
379 password
380
381
382 Flags:
383 -v, --verbose [n]
384 Control verbosity (n is 0--3, default verbosity level is
385 1)
386
387 --publish
388 Publish the package instead of uploading it as a candi‐
389 date.
390
391 -d, --documentation
392 Upload documentation instead of a source package. By
393 default, this uploads documentation for a package candi‐
394 date. To upload documentation for a published package,
395 combine with --publish.
396
397 -u, --username USERNAME
398 Hackage username.
399
400 -p, --password PASSWORD
401 Hackage password.
402
403 -P, --password-command PASSWORD
404 Command to get Hackage password.
405
406
407 cabal report
408
409 Usage: cabal report [FLAGS]
410
411
412 You can store your Hackage login in the ~/.cabal/config file
413
414
415 Flags:
416 -v, --verbose [n]
417 Control verbosity (n is 0--3, default verbosity level is
418 1)
419
420 -u, --username USERNAME
421 Hackage username.
422
423 -p, --password PASSWORD
424 Hackage password.
425
426
427 cabal init
428
429 Usage: cabal init [FLAGS]
430
431
432 Cabalise a project by creating a .cabal, Setup.hs, and optionally a
433 LICENSE file.
434
435 Calling init with no arguments (recommended) uses an interactive mode,
436 which will try to guess as much as possible and prompt you for the
437 rest. Command-line arguments are provided for scripting purposes. If
438 you don't want interactive mode, be sure to pass the -n flag.
439
440
441 Flags:
442 -n, --non-interactive
443 Non-interactive mode.
444
445 -q, --quiet
446 Do not generate log messages to stdout.
447
448 --no-comments
449 Do not generate explanatory comments in the .cabal file.
450
451 -m, --minimal
452 Generate a minimal .cabal file, that is, do not include
453 extra empty fields. Also implies --no-comments.
454
455 --overwrite
456 Overwrite any existing .cabal, LICENSE, or Setup.hs files
457 without warning.
458
459 --package-dir, --packagedir DIRECTORY
460 Root directory of the package (default = current direc‐
461 tory).
462
463 -p, --package-name PACKAGE
464 Name of the Cabal package to create.
465
466 --version VERSION
467 Initial version of the package.
468
469 --cabal-version VERSION_RANGE
470 Version of the Cabal specification.
471
472 -l, --license LICENSE
473 Project license.
474
475 -a, --author NAME
476 Name of the project's author.
477
478 -e, --email EMAIL
479 Email address of the maintainer.
480
481 -u, --homepage URL
482 Project homepage and/or repository.
483
484 -s, --synopsis TEXT
485 Short project synopsis.
486
487 -c, --category CATEGORY
488 Project category.
489
490 -x, --extra-source-file FILE
491 Extra source file to be distributed with tarball.
492
493 --is-library
494 Build a library.
495
496 --is-executable
497 Build an executable.
498
499 --is-libandexe
500 Build a library and an executable.
501
502 --main-is FILE
503 Specify the main module.
504
505 --language LANGUAGE
506 Specify the default language.
507
508 -o, --expose-module MODULE
509 Export a module from the package.
510
511 --extension EXTENSION
512 Use a LANGUAGE extension (in the other-extensions field).
513
514 -d, --dependency PACKAGE
515 Package dependency.
516
517 --source-dir, --sourcedir DIR
518 Directory containing package source.
519
520 --build-tool TOOL
521 Required external build tool.
522
523 -w, --with-compiler PATH
524 give the path to a particular compiler
525
526 -v, --verbose [n]
527 Control verbosity (n is 0--3, default verbosity level is
528 1)
529
530
531 cabal user-config
532
533 Usage: cabal user-config init
534 or: cabal user-config diff
535 or: cabal user-config update
536
537
538 When upgrading cabal, the set of configuration keys and their default
539 values may change. This command provides means to merge the existing
540 config in ~/.cabal/config (i.e. all bindings that are actually defined
541 and not commented out) and the default config of the new version.
542
543 init: Creates a new config file at either ~/.cabal/config or as speci‐
544 fied by --config-file, if given. An existing file won't be overwritten
545 unless -f or --force is given. diff: Shows a pseudo-diff of the user's
546 ~/.cabal/config file and the default configuration that would be cre‐
547 ated by cabal if the config file did not exist. update: Applies the
548 pseudo-diff to the configuration that would be created by default, and
549 write the result back to ~/.cabal/config.
550
551
552 Flags:
553 -v, --verbose [n]
554 Control verbosity (n is 0--3, default verbosity level is
555 1)
556
557 -f, --force
558 Overwrite the config file if it already exists.
559
560 -a, --augment CONFIGLINE
561 Additional setting to augment the config file (replacing
562 a previous setting if it existed).
563
564
565 cabal gen-bounds
566
567 Usage: cabal gen-bounds [FLAGS]
568
569
570 Generates bounds for all dependencies that do not currently have them.
571 Generated bounds are printed to stdout. You can then paste them into
572 your
573
574
575
576 Flags:
577 -v, --verbose [n]
578 Control verbosity (n is 0--3, default verbosity level is
579 1)
580
581
582 cabal outdated
583
584 Usage: cabal outdated [FLAGS]
585
586
587 Checks for outdated dependencies in the package description file or
588 freeze file
589
590
591 Flags:
592 -v, --verbose [n]
593 Control verbosity (n is 0--3, default verbosity level is
594 1)
595
596 --freeze-file, --v1-freeze-file
597 Act on the freeze file
598
599 --new-freeze-file, --v2-freeze-file
600 Act on the new-style freeze file (default:
601 cabal.project.freeze)
602
603 --project-file PROJECTFILE
604 Act on the new-style freeze file named PROJECTFILE.freeze
605 rather than the default cabal.project.freeze
606
607 --simple-output
608 Only print names of outdated dependencies, one per line
609
610 --exit-code
611 Exit with non-zero when there are outdated dependencies
612
613 -q, --quiet
614 Don't print any output. Implies '--exit-code' and '-v0'
615
616 --ignore PKGS
617 Packages to ignore
618
619 --minor [PKGS]
620 Ignore major version bumps for these packages
621
622
623 cabal hscolour
624
625 Usage: cabal hscolour [FLAGS]
626
627
628 Requires the hscolour program.
629
630
631 Deprecated in favour of 'cabal haddock --hyperlink-source'.
632
633 Flags:
634 -v, --verbose [n]
635 Control verbosity (n is 0--3, default verbosity level is
636 1)
637
638 --builddir, --distdir, --distpref DIR
639 The directory where Cabal puts generated build files
640 (default dist)
641
642 --executables
643 Run hscolour for Executables targets
644
645 --tests
646 Run hscolour for Test Suite targets
647
648 --benchmarks
649 Run hscolour for Benchmark targets
650
651 --foreign-libraries
652 Run hscolour for Foreign Library targets
653
654 --all
655 Run hscolour for all targets
656
657 --css PATH
658 Use a cascading style sheet
659
660
661 cabal v2-configure
662
663 Usage: cabal v2-configure [FLAGS]
664
665
666 Adjust how the project is built by setting additional package flags and
667 other flags.
668
669 The configuration options are written to the 'cabal.project.local' file
670 (or configuration from the 'cabal.project' file (if any). This combina‐
671 tion is used as the project configuration for all other commands (such
672 as 'v2-build',
673
674 The v2-configure command also checks that the project configuration
675 will work. In particular it checks that there is a consistent set of
676 dependencies for the project as a whole.
677
678 The 'cabal.project.local' file persists across 'v2-clean' but is over‐
679 written on the next use of the 'v2-configure' command. The intention is
680 that the
681
682 It is never necessary to use the 'v2-configure' command. It is merely a
683 convenience in cases where you do not want to specify flags to
684 'v2-build' (and other commands) every time and yet do not want to alter
685 the
686
687
688 Adjust how the project is built by setting additional package flags and
689 other flags.
690
691 The configuration options are written to the 'cabal.project.local' file
692 (or configuration from the 'cabal.project' file (if any). This combina‐
693 tion is used as the project configuration for all other commands (such
694 as 'v2-build',
695
696 The v2-configure command also checks that the project configuration
697 will work. In particular it checks that there is a consistent set of
698 dependencies for the project as a whole.
699
700 The 'cabal.project.local' file persists across 'v2-clean' but is over‐
701 written on the next use of the 'v2-configure' command. The intention is
702 that the
703
704 It is never necessary to use the 'v2-configure' command. It is merely a
705 convenience in cases where you do not want to specify flags to
706 'v2-build' (and other commands) every time and yet do not want to alter
707 the
708
709
710 Flags:
711 -v, --verbose [n]
712 Control verbosity (n is 0--3, default verbosity level is
713 1)
714
715 --builddir, --distdir, --distpref DIR
716 The directory where Cabal puts generated build files
717 (default dist)
718
719 -g, --ghc
720 compile with GHC
721
722 --ghcjs
723 compile with GHCJS
724
725 --uhc
726 compile with UHC
727
728 --haskell-suite
729 compile with a haskell-suite compiler
730
731 --cabal-file PATH
732 use this Cabal file
733
734 -w, --with-compiler PATH
735 give the path to a particular compiler
736
737 --with-hc-pkg PATH
738 give the path to the package tool
739
740 --prefix DIR
741 bake this prefix in preparation of installation
742
743 --bindir DIR
744 installation directory for executables
745
746 --libdir DIR
747 installation directory for libraries
748
749 --libsubdir DIR
750 subdirectory of libdir in which libs are installed
751
752 --dynlibdir DIR
753 installation directory for dynamic libraries
754
755 --libexecdir DIR
756 installation directory for program executables
757
758 --libexecsubdir DIR
759 subdirectory of libexecdir in which private executables
760 are installed
761
762 --datadir DIR
763 installation directory for read-only data
764
765 --datasubdir DIR
766 subdirectory of datadir in which data files are installed
767
768 --docdir DIR
769 installation directory for documentation
770
771 --htmldir DIR
772 installation directory for HTML documentation
773
774 --haddockdir DIR
775 installation directory for haddock interfaces
776
777 --sysconfdir DIR
778 installation directory for configuration files
779
780 --program-prefix PREFIX
781 prefix to be applied to installed executables
782
783 --program-suffix SUFFIX
784 suffix to be applied to installed executables
785
786 --enable-library-vanilla
787 --disable-library-vanilla
788 Vanilla libraries
789
790 -p, --enable-library-profiling
791 --disable-library-profiling
792 Library profiling
793
794 --enable-shared
795 --disable-shared
796 Shared library
797
798 --enable-static
799 --disable-static
800 Static library
801
802 --enable-executable-dynamic
803 --disable-executable-dynamic
804 Executable dynamic linking
805
806 --enable-profiling
807 --disable-profiling
808 Executable and library profiling
809
810 --enable-executable-profiling
811 --disable-executable-profiling
812 Executable profiling (DEPRECATED)
813
814 --profiling-detail level
815 Profiling detail level for executable and library
816 (default, none, exported-functions, toplevel-functions,
817 all-functions).
818
819 --library-profiling-detail level
820 Profiling detail level for libraries only.
821
822 -O, --enable-optimization, --enable-optimisation [n]
823 Build with optimization (n is 0--2, default is 1)
824
825 --disable-optimization, --disable-optimisation
826 Build without optimization
827
828 --enable-debug-info [n]
829 Emit debug info (n is 0--3, default is 0)
830
831 --disable-debug-info
832 Don't emit debug info
833
834 --enable-library-for-ghci
835 --disable-library-for-ghci
836 compile library for use with GHCi
837
838 --enable-split-sections
839 --disable-split-sections
840 compile library code such that unneeded definitions can
841 be dropped from the final executable (GHC 7.8+)
842
843 --enable-split-objs
844 --disable-split-objs
845 split library into smaller objects to reduce binary sizes
846 (GHC 6.6+)
847
848 --enable-executable-stripping
849 --disable-executable-stripping
850 strip executables upon installation to reduce binary
851 sizes
852
853 --enable-library-stripping
854 --disable-library-stripping
855 strip libraries upon installation to reduce binary sizes
856
857 --configure-option OPT
858 Extra option for configure
859
860 --user
861 --global
862 doing a per-user installation
863
864 --package-db DB
865 Append the given package database to the list of package
866 databases used (to satisfy dependencies and register
867 into). May be a specific file, 'global' or 'user'. The
868 initial list is ['global'], ['global', 'user'], or
869 ['global', $sandbox], depending on context. Use 'clear'
870 to reset the list to empty. See the user guide for
871 details.
872
873 -f, --flags FLAGS
874 Force values for the given flags in Cabal conditionals in
875 the .cabal file. E.g., --flags="debug -usebytestrings"
876 forces the flag "debug" to true and "usebytestrings" to
877 false.
878
879 --extra-include-dirs PATH
880 A list of directories to search for header files
881
882 --enable-deterministic
883 --disable-deterministic
884 Try to be as deterministic as possible (used by the test
885 suite)
886
887 --ipid IPID
888 Installed package ID to compile this package as
889
890 --cid CID
891 Installed component ID to compile this component as
892
893 --extra-lib-dirs PATH
894 A list of directories to search for external libraries
895
896 --extra-framework-dirs PATH
897 A list of directories to search for external frameworks
898 (OS X only)
899
900 --extra-prog-path PATH
901 A list of directories to search for required programs (in
902 addition to the normal search locations)
903
904 --instantiate-with NAME=MOD
905 A mapping of signature names to concrete module instanti‐
906 ations.
907
908 --enable-tests
909 --disable-tests
910 dependency checking and compilation for test suites
911 listed in the package description file.
912
913 --enable-coverage
914 --disable-coverage
915 build package with Haskell Program Coverage. (GHC only)
916
917 --enable-library-coverage
918 --disable-library-coverage
919 build package with Haskell Program Coverage. (GHC only)
920 (DEPRECATED)
921
922 --enable-benchmarks
923 --disable-benchmarks
924 dependency checking and compilation for benchmarks listed
925 in the package description file.
926
927 --enable-relocatable
928 --disable-relocatable
929 building a package that is relocatable. (GHC only)
930
931 --disable-response-files
932 enable workaround for old versions of programs like "ar"
933 that do not support @file arguments
934
935 --with-alex PATH
936 give the path to alex
937
938 --with-ar PATH
939 give the path to ar
940
941 --with-c2hs PATH
942 give the path to c2hs
943
944 --with-cpphs PATH
945 give the path to cpphs
946
947 --with-doctest PATH
948 give the path to doctest
949
950 --with-gcc PATH
951 give the path to gcc
952
953 --with-ghc PATH
954 give the path to ghc
955
956 --with-ghc-pkg PATH
957 give the path to ghc-pkg
958
959 --with-ghcjs PATH
960 give the path to ghcjs
961
962 --with-ghcjs-pkg PATH
963 give the path to ghcjs-pkg
964
965 --with-greencard PATH
966 give the path to greencard
967
968 --with-haddock PATH
969 give the path to haddock
970
971 --with-happy PATH
972 give the path to happy
973
974 --with-haskell-suite PATH
975 give the path to haskell-suite
976
977 --with-haskell-suite-pkg PATH
978 give the path to haskell-suite-pkg
979
980 --with-hmake PATH
981 give the path to hmake
982
983 --with-hpc PATH
984 give the path to hpc
985
986 --with-hsc2hs PATH
987 give the path to hsc2hs
988
989 --with-hscolour PATH
990 give the path to hscolour
991
992 --with-jhc PATH
993 give the path to jhc
994
995 --with-ld PATH
996 give the path to ld
997
998 --with-pkg-config PATH
999 give the path to pkg-config
1000
1001 --with-runghc PATH
1002 give the path to runghc
1003
1004 --with-strip PATH
1005 give the path to strip
1006
1007 --with-tar PATH
1008 give the path to tar
1009
1010 --with-uhc PATH
1011 give the path to uhc
1012
1013 --alex-option OPT
1014 give an extra option to alex (no need to quote options
1015 containing spaces)
1016
1017 --ar-option OPT
1018 give an extra option to ar (no need to quote options con‐
1019 taining spaces)
1020
1021 --c2hs-option OPT
1022 give an extra option to c2hs (no need to quote options
1023 containing spaces)
1024
1025 --cpphs-option OPT
1026 give an extra option to cpphs (no need to quote options
1027 containing spaces)
1028
1029 --doctest-option OPT
1030 give an extra option to doctest (no need to quote options
1031 containing spaces)
1032
1033 --gcc-option OPT
1034 give an extra option to gcc (no need to quote options
1035 containing spaces)
1036
1037 --ghc-option OPT
1038 give an extra option to ghc (no need to quote options
1039 containing spaces)
1040
1041 --ghc-pkg-option OPT
1042 give an extra option to ghc-pkg (no need to quote options
1043 containing spaces)
1044
1045 --ghcjs-option OPT
1046 give an extra option to ghcjs (no need to quote options
1047 containing spaces)
1048
1049 --ghcjs-pkg-option OPT
1050 give an extra option to ghcjs-pkg (no need to quote
1051 options containing spaces)
1052
1053 --greencard-option OPT
1054 give an extra option to greencard (no need to quote
1055 options containing spaces)
1056
1057 --haddock-option OPT
1058 give an extra option to haddock (no need to quote options
1059 containing spaces)
1060
1061 --happy-option OPT
1062 give an extra option to happy (no need to quote options
1063 containing spaces)
1064
1065 --haskell-suite-option OPT
1066 give an extra option to haskell-suite (no need to quote
1067 options containing spaces)
1068
1069 --haskell-suite-pkg-option OPT
1070 give an extra option to haskell-suite-pkg (no need to
1071 quote options containing spaces)
1072
1073 --hmake-option OPT
1074 give an extra option to hmake (no need to quote options
1075 containing spaces)
1076
1077 --hpc-option OPT
1078 give an extra option to hpc (no need to quote options
1079 containing spaces)
1080
1081 --hsc2hs-option OPT
1082 give an extra option to hsc2hs (no need to quote options
1083 containing spaces)
1084
1085 --hscolour-option OPT
1086 give an extra option to hscolour (no need to quote
1087 options containing spaces)
1088
1089 --jhc-option OPT
1090 give an extra option to jhc (no need to quote options
1091 containing spaces)
1092
1093 --ld-option OPT
1094 give an extra option to ld (no need to quote options con‐
1095 taining spaces)
1096
1097 --pkg-config-option OPT
1098 give an extra option to pkg-config (no need to quote
1099 options containing spaces)
1100
1101 --runghc-option OPT
1102 give an extra option to runghc (no need to quote options
1103 containing spaces)
1104
1105 --strip-option OPT
1106 give an extra option to strip (no need to quote options
1107 containing spaces)
1108
1109 --tar-option OPT
1110 give an extra option to tar (no need to quote options
1111 containing spaces)
1112
1113 --uhc-option OPT
1114 give an extra option to uhc (no need to quote options
1115 containing spaces)
1116
1117 --alex-options OPTS
1118 give extra options to alex
1119
1120 --ar-options OPTS
1121 give extra options to ar
1122
1123 --c2hs-options OPTS
1124 give extra options to c2hs
1125
1126 --cpphs-options OPTS
1127 give extra options to cpphs
1128
1129 --doctest-options OPTS
1130 give extra options to doctest
1131
1132 --gcc-options OPTS
1133 give extra options to gcc
1134
1135 --ghc-options OPTS
1136 give extra options to ghc
1137
1138 --ghc-pkg-options OPTS
1139 give extra options to ghc-pkg
1140
1141 --ghcjs-options OPTS
1142 give extra options to ghcjs
1143
1144 --ghcjs-pkg-options OPTS
1145 give extra options to ghcjs-pkg
1146
1147 --greencard-options OPTS
1148 give extra options to greencard
1149
1150 --haddock-options OPTS
1151 give extra options to haddock
1152
1153 --happy-options OPTS
1154 give extra options to happy
1155
1156 --haskell-suite-options OPTS
1157 give extra options to haskell-suite
1158
1159 --haskell-suite-pkg-options OPTS
1160 give extra options to haskell-suite-pkg
1161
1162 --hmake-options OPTS
1163 give extra options to hmake
1164
1165 --hpc-options OPTS
1166 give extra options to hpc
1167
1168 --hsc2hs-options OPTS
1169 give extra options to hsc2hs
1170
1171 --hscolour-options OPTS
1172 give extra options to hscolour
1173
1174 --jhc-options OPTS
1175 give extra options to jhc
1176
1177 --ld-options OPTS
1178 give extra options to ld
1179
1180 --pkg-config-options OPTS
1181 give extra options to pkg-config
1182
1183 --runghc-options OPTS
1184 give extra options to runghc
1185
1186 --strip-options OPTS
1187 give extra options to strip
1188
1189 --tar-options OPTS
1190 give extra options to tar
1191
1192 --uhc-options OPTS
1193 give extra options to uhc
1194
1195 --cabal-lib-version VERSION
1196 Select which version of the Cabal lib to use to build
1197 packages (useful for testing).
1198
1199 --constraint CONSTRAINT
1200 Specify constraints on a package (version,
1201 installed/source, flags)
1202
1203 --preference CONSTRAINT
1204 Specify preferences (soft constraints) on the version of
1205 a package
1206
1207 --solver SOLVER
1208 Select dependency solver to use (default: modular).
1209 Choices: modular.
1210
1211 --allow-older [DEPS]
1212 Ignore lower bounds in all dependencies or DEPS
1213
1214 --allow-newer [DEPS]
1215 Ignore upper bounds in all dependencies or DEPS
1216
1217 --write-ghc-environment-files always|never|ghc8.4.4+
1218 Whether to create a .ghc.environment file after a suc‐
1219 cessful build (v2-build only)
1220
1221 --enable-documentation
1222 --disable-documentation
1223 building of documentation
1224
1225 --doc-index-file TEMPLATE
1226 A central index of haddock API documentation (template
1227 cannot use $pkgid)
1228
1229 --dry-run
1230 Do not install anything, only print what would be
1231 installed.
1232
1233 --max-backjumps NUM
1234 Maximum number of backjumps allowed while solving
1235 (default: 2000). Use a negative number to enable unlim‐
1236 ited backtracking. Use 0 to disable backtracking com‐
1237 pletely.
1238
1239 --reorder-goals
1240 --no-reorder-goals
1241 Try to reorder goals according to certain heuristics.
1242 Slows things down on average, but may make backtracking
1243 faster for some packages.
1244
1245 --count-conflicts
1246 --no-count-conflicts
1247 Try to speed up solving by preferring goals that are
1248 involved in a lot of conflicts (default).
1249
1250 --independent-goals
1251 --no-independent-goals
1252 Treat several goals on the command line as independent.
1253 If several goals depend on the same package, different
1254 versions can be chosen.
1255
1256 --shadow-installed-packages
1257 --no-shadow-installed-packages
1258 If multiple package instances of the same version are
1259 installed, treat all but one as shadowed.
1260
1261 --strong-flags
1262 --no-strong-flags
1263 Do not defer flag choices (this used to be the default in
1264 cabal-install <= 1.20).
1265
1266 --allow-boot-library-installs
1267 --no-allow-boot-library-installs
1268 Allow cabal to install base, ghc-prim, integer-simple,
1269 integer-gmp, and template-haskell.
1270
1271 --reinstall
1272 --no-reinstall
1273 Install even if it means installing the same version
1274 again.
1275
1276 --avoid-reinstalls
1277 --no-avoid-reinstalls
1278 Do not select versions that would destructively overwrite
1279 installed packages.
1280
1281 --force-reinstalls
1282 --no-force-reinstalls
1283 Reinstall packages even if they will most likely break
1284 other installed packages.
1285
1286 --upgrade-dependencies
1287 --no-upgrade-dependencies
1288 Pick the latest version for all dependencies, rather than
1289 trying to pick an installed version.
1290
1291 --only-dependencies
1292 --no-only-dependencies
1293 Install only the dependencies necessary to build the
1294 given packages
1295
1296 --dependencies-only
1297 --no-dependencies-only
1298 A synonym for --only-dependencies
1299
1300 --index-state STATE
1301 Use source package index state as it existed at a previ‐
1302 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
1303 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
1304 'HEAD' (default: 'HEAD').
1305
1306 --root-cmd COMMAND
1307 (No longer supported, do not use.)
1308
1309 --symlink-bindir DIR
1310 Add symlinks to installed executables into this direc‐
1311 tory.
1312
1313 --build-summary TEMPLATE
1314 Save build summaries to file (name template can use
1315 $pkgid, $compiler, $os, $arch)
1316
1317 --build-log TEMPLATE
1318 Log all builds to file (name template can use $pkgid,
1319 $compiler, $os, $arch)
1320
1321 --remote-build-reporting LEVEL
1322 Generate build reports to send to a remote server (none,
1323 anonymous or detailed).
1324
1325 --report-planning-failure
1326 Generate build reports when the dependency solver fails.
1327 This is used by the Hackage build bot.
1328
1329 --enable-per-component
1330 --disable-per-component
1331 Per-component builds when possible
1332
1333 --one-shot
1334 --no-one-shot
1335 Do not record the packages in the world file.
1336
1337 --run-tests
1338 Run package test suites during installation.
1339
1340 -j, --jobs [NUM]
1341 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
1342 given).
1343
1344 --keep-going
1345 After a build failure, continue to build other unaffected
1346 packages.
1347
1348 --offline
1349 --no-offline
1350 Don't download packages from the Internet.
1351
1352 --project-file FILE
1353 Set the name of the cabal.project file to search for in
1354 parent directories
1355
1356 --only
1357 Only installs the package in the current directory.
1358
1359 --haddock-hoogle
1360 Generate a hoogle database
1361
1362 --haddock-html
1363 Generate HTML documentation (the default)
1364
1365 --haddock-html-location URL
1366 Location of HTML documentation for pre-requisite packages
1367
1368 --haddock-for-hackage
1369 Collection of flags to generate documentation suitable
1370 for upload to hackage
1371
1372 --haddock-executables
1373 Run haddock for Executables targets
1374
1375 --haddock-tests
1376 Run haddock for Test Suite targets
1377
1378 --haddock-benchmarks
1379 Run haddock for Benchmark targets
1380
1381 --haddock-all
1382 Run haddock for all targets
1383
1384 --haddock-internal
1385 Run haddock for internal modules and include all symbols
1386
1387 --haddock-css PATH
1388 Use PATH as the haddock stylesheet
1389
1390 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
1391 dock-hyperlinked-source
1392 Hyperlink the documentation to the source code
1393
1394 --haddock-quickjump
1395 Generate an index for interactive documentation naviga‐
1396 tion
1397
1398 --haddock-hscolour-css PATH
1399 Use PATH as the HsColour stylesheet
1400
1401 --haddock-contents-location URL
1402 Bake URL in as the location for the contents page
1403
1404
1405 cabal new-configure
1406
1407 Usage: cabal new-configure [FLAGS]
1408
1409
1410 Adjust how the project is built by setting additional package flags and
1411 other flags.
1412
1413 The configuration options are written to the 'cabal.project.local' file
1414 (or configuration from the 'cabal.project' file (if any). This combina‐
1415 tion is used as the project configuration for all other commands (such
1416 as 'new-build',
1417
1418 The new-configure command also checks that the project configuration
1419 will work. In particular it checks that there is a consistent set of
1420 dependencies for the project as a whole.
1421
1422 The 'cabal.project.local' file persists across 'new-clean' but is over‐
1423 written on the next use of the 'new-configure' command. The intention
1424 is that the
1425
1426 It is never necessary to use the 'new-configure' command. It is merely
1427 a convenience in cases where you do not want to specify flags to 'new-
1428 build' (and other commands) every time and yet do not want to alter the
1429
1430
1431 Examples:
1432 cabal new-configure --with-compiler ghc-7.10.3
1433 Adjust the project configuration to use the given compiler
1434 program and check the resulting configuration works.
1435 cabal new-configure
1436 Reset the local configuration to empty and check the overall
1437 project configuration works.
1438
1439 Note: this command is part of the new project-based system (aka nix-
1440 style local builds). These features are currently in beta. Please see
1441 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
1442 details and advice on what you can expect to work. If you encounter
1443 problems please file issues at https://github.com/haskell/cabal/issues
1444 and if you have any time to get involved and help with testing, fixing
1445 bugs etc then that is very much appreciated.
1446
1447
1448 Flags:
1449 -v, --verbose [n]
1450 Control verbosity (n is 0--3, default verbosity level is
1451 1)
1452
1453 --builddir, --distdir, --distpref DIR
1454 The directory where Cabal puts generated build files
1455 (default dist)
1456
1457 -g, --ghc
1458 compile with GHC
1459
1460 --ghcjs
1461 compile with GHCJS
1462
1463 --uhc
1464 compile with UHC
1465
1466 --haskell-suite
1467 compile with a haskell-suite compiler
1468
1469 --cabal-file PATH
1470 use this Cabal file
1471
1472 -w, --with-compiler PATH
1473 give the path to a particular compiler
1474
1475 --with-hc-pkg PATH
1476 give the path to the package tool
1477
1478 --prefix DIR
1479 bake this prefix in preparation of installation
1480
1481 --bindir DIR
1482 installation directory for executables
1483
1484 --libdir DIR
1485 installation directory for libraries
1486
1487 --libsubdir DIR
1488 subdirectory of libdir in which libs are installed
1489
1490 --dynlibdir DIR
1491 installation directory for dynamic libraries
1492
1493 --libexecdir DIR
1494 installation directory for program executables
1495
1496 --libexecsubdir DIR
1497 subdirectory of libexecdir in which private executables
1498 are installed
1499
1500 --datadir DIR
1501 installation directory for read-only data
1502
1503 --datasubdir DIR
1504 subdirectory of datadir in which data files are installed
1505
1506 --docdir DIR
1507 installation directory for documentation
1508
1509 --htmldir DIR
1510 installation directory for HTML documentation
1511
1512 --haddockdir DIR
1513 installation directory for haddock interfaces
1514
1515 --sysconfdir DIR
1516 installation directory for configuration files
1517
1518 --program-prefix PREFIX
1519 prefix to be applied to installed executables
1520
1521 --program-suffix SUFFIX
1522 suffix to be applied to installed executables
1523
1524 --enable-library-vanilla
1525 --disable-library-vanilla
1526 Vanilla libraries
1527
1528 -p, --enable-library-profiling
1529 --disable-library-profiling
1530 Library profiling
1531
1532 --enable-shared
1533 --disable-shared
1534 Shared library
1535
1536 --enable-static
1537 --disable-static
1538 Static library
1539
1540 --enable-executable-dynamic
1541 --disable-executable-dynamic
1542 Executable dynamic linking
1543
1544 --enable-profiling
1545 --disable-profiling
1546 Executable and library profiling
1547
1548 --enable-executable-profiling
1549 --disable-executable-profiling
1550 Executable profiling (DEPRECATED)
1551
1552 --profiling-detail level
1553 Profiling detail level for executable and library
1554 (default, none, exported-functions, toplevel-functions,
1555 all-functions).
1556
1557 --library-profiling-detail level
1558 Profiling detail level for libraries only.
1559
1560 -O, --enable-optimization, --enable-optimisation [n]
1561 Build with optimization (n is 0--2, default is 1)
1562
1563 --disable-optimization, --disable-optimisation
1564 Build without optimization
1565
1566 --enable-debug-info [n]
1567 Emit debug info (n is 0--3, default is 0)
1568
1569 --disable-debug-info
1570 Don't emit debug info
1571
1572 --enable-library-for-ghci
1573 --disable-library-for-ghci
1574 compile library for use with GHCi
1575
1576 --enable-split-sections
1577 --disable-split-sections
1578 compile library code such that unneeded definitions can
1579 be dropped from the final executable (GHC 7.8+)
1580
1581 --enable-split-objs
1582 --disable-split-objs
1583 split library into smaller objects to reduce binary sizes
1584 (GHC 6.6+)
1585
1586 --enable-executable-stripping
1587 --disable-executable-stripping
1588 strip executables upon installation to reduce binary
1589 sizes
1590
1591 --enable-library-stripping
1592 --disable-library-stripping
1593 strip libraries upon installation to reduce binary sizes
1594
1595 --configure-option OPT
1596 Extra option for configure
1597
1598 --user
1599 --global
1600 doing a per-user installation
1601
1602 --package-db DB
1603 Append the given package database to the list of package
1604 databases used (to satisfy dependencies and register
1605 into). May be a specific file, 'global' or 'user'. The
1606 initial list is ['global'], ['global', 'user'], or
1607 ['global', $sandbox], depending on context. Use 'clear'
1608 to reset the list to empty. See the user guide for
1609 details.
1610
1611 -f, --flags FLAGS
1612 Force values for the given flags in Cabal conditionals in
1613 the .cabal file. E.g., --flags="debug -usebytestrings"
1614 forces the flag "debug" to true and "usebytestrings" to
1615 false.
1616
1617 --extra-include-dirs PATH
1618 A list of directories to search for header files
1619
1620 --enable-deterministic
1621 --disable-deterministic
1622 Try to be as deterministic as possible (used by the test
1623 suite)
1624
1625 --ipid IPID
1626 Installed package ID to compile this package as
1627
1628 --cid CID
1629 Installed component ID to compile this component as
1630
1631 --extra-lib-dirs PATH
1632 A list of directories to search for external libraries
1633
1634 --extra-framework-dirs PATH
1635 A list of directories to search for external frameworks
1636 (OS X only)
1637
1638 --extra-prog-path PATH
1639 A list of directories to search for required programs (in
1640 addition to the normal search locations)
1641
1642 --instantiate-with NAME=MOD
1643 A mapping of signature names to concrete module instanti‐
1644 ations.
1645
1646 --enable-tests
1647 --disable-tests
1648 dependency checking and compilation for test suites
1649 listed in the package description file.
1650
1651 --enable-coverage
1652 --disable-coverage
1653 build package with Haskell Program Coverage. (GHC only)
1654
1655 --enable-library-coverage
1656 --disable-library-coverage
1657 build package with Haskell Program Coverage. (GHC only)
1658 (DEPRECATED)
1659
1660 --enable-benchmarks
1661 --disable-benchmarks
1662 dependency checking and compilation for benchmarks listed
1663 in the package description file.
1664
1665 --enable-relocatable
1666 --disable-relocatable
1667 building a package that is relocatable. (GHC only)
1668
1669 --disable-response-files
1670 enable workaround for old versions of programs like "ar"
1671 that do not support @file arguments
1672
1673 --with-alex PATH
1674 give the path to alex
1675
1676 --with-ar PATH
1677 give the path to ar
1678
1679 --with-c2hs PATH
1680 give the path to c2hs
1681
1682 --with-cpphs PATH
1683 give the path to cpphs
1684
1685 --with-doctest PATH
1686 give the path to doctest
1687
1688 --with-gcc PATH
1689 give the path to gcc
1690
1691 --with-ghc PATH
1692 give the path to ghc
1693
1694 --with-ghc-pkg PATH
1695 give the path to ghc-pkg
1696
1697 --with-ghcjs PATH
1698 give the path to ghcjs
1699
1700 --with-ghcjs-pkg PATH
1701 give the path to ghcjs-pkg
1702
1703 --with-greencard PATH
1704 give the path to greencard
1705
1706 --with-haddock PATH
1707 give the path to haddock
1708
1709 --with-happy PATH
1710 give the path to happy
1711
1712 --with-haskell-suite PATH
1713 give the path to haskell-suite
1714
1715 --with-haskell-suite-pkg PATH
1716 give the path to haskell-suite-pkg
1717
1718 --with-hmake PATH
1719 give the path to hmake
1720
1721 --with-hpc PATH
1722 give the path to hpc
1723
1724 --with-hsc2hs PATH
1725 give the path to hsc2hs
1726
1727 --with-hscolour PATH
1728 give the path to hscolour
1729
1730 --with-jhc PATH
1731 give the path to jhc
1732
1733 --with-ld PATH
1734 give the path to ld
1735
1736 --with-pkg-config PATH
1737 give the path to pkg-config
1738
1739 --with-runghc PATH
1740 give the path to runghc
1741
1742 --with-strip PATH
1743 give the path to strip
1744
1745 --with-tar PATH
1746 give the path to tar
1747
1748 --with-uhc PATH
1749 give the path to uhc
1750
1751 --alex-option OPT
1752 give an extra option to alex (no need to quote options
1753 containing spaces)
1754
1755 --ar-option OPT
1756 give an extra option to ar (no need to quote options con‐
1757 taining spaces)
1758
1759 --c2hs-option OPT
1760 give an extra option to c2hs (no need to quote options
1761 containing spaces)
1762
1763 --cpphs-option OPT
1764 give an extra option to cpphs (no need to quote options
1765 containing spaces)
1766
1767 --doctest-option OPT
1768 give an extra option to doctest (no need to quote options
1769 containing spaces)
1770
1771 --gcc-option OPT
1772 give an extra option to gcc (no need to quote options
1773 containing spaces)
1774
1775 --ghc-option OPT
1776 give an extra option to ghc (no need to quote options
1777 containing spaces)
1778
1779 --ghc-pkg-option OPT
1780 give an extra option to ghc-pkg (no need to quote options
1781 containing spaces)
1782
1783 --ghcjs-option OPT
1784 give an extra option to ghcjs (no need to quote options
1785 containing spaces)
1786
1787 --ghcjs-pkg-option OPT
1788 give an extra option to ghcjs-pkg (no need to quote
1789 options containing spaces)
1790
1791 --greencard-option OPT
1792 give an extra option to greencard (no need to quote
1793 options containing spaces)
1794
1795 --haddock-option OPT
1796 give an extra option to haddock (no need to quote options
1797 containing spaces)
1798
1799 --happy-option OPT
1800 give an extra option to happy (no need to quote options
1801 containing spaces)
1802
1803 --haskell-suite-option OPT
1804 give an extra option to haskell-suite (no need to quote
1805 options containing spaces)
1806
1807 --haskell-suite-pkg-option OPT
1808 give an extra option to haskell-suite-pkg (no need to
1809 quote options containing spaces)
1810
1811 --hmake-option OPT
1812 give an extra option to hmake (no need to quote options
1813 containing spaces)
1814
1815 --hpc-option OPT
1816 give an extra option to hpc (no need to quote options
1817 containing spaces)
1818
1819 --hsc2hs-option OPT
1820 give an extra option to hsc2hs (no need to quote options
1821 containing spaces)
1822
1823 --hscolour-option OPT
1824 give an extra option to hscolour (no need to quote
1825 options containing spaces)
1826
1827 --jhc-option OPT
1828 give an extra option to jhc (no need to quote options
1829 containing spaces)
1830
1831 --ld-option OPT
1832 give an extra option to ld (no need to quote options con‐
1833 taining spaces)
1834
1835 --pkg-config-option OPT
1836 give an extra option to pkg-config (no need to quote
1837 options containing spaces)
1838
1839 --runghc-option OPT
1840 give an extra option to runghc (no need to quote options
1841 containing spaces)
1842
1843 --strip-option OPT
1844 give an extra option to strip (no need to quote options
1845 containing spaces)
1846
1847 --tar-option OPT
1848 give an extra option to tar (no need to quote options
1849 containing spaces)
1850
1851 --uhc-option OPT
1852 give an extra option to uhc (no need to quote options
1853 containing spaces)
1854
1855 --alex-options OPTS
1856 give extra options to alex
1857
1858 --ar-options OPTS
1859 give extra options to ar
1860
1861 --c2hs-options OPTS
1862 give extra options to c2hs
1863
1864 --cpphs-options OPTS
1865 give extra options to cpphs
1866
1867 --doctest-options OPTS
1868 give extra options to doctest
1869
1870 --gcc-options OPTS
1871 give extra options to gcc
1872
1873 --ghc-options OPTS
1874 give extra options to ghc
1875
1876 --ghc-pkg-options OPTS
1877 give extra options to ghc-pkg
1878
1879 --ghcjs-options OPTS
1880 give extra options to ghcjs
1881
1882 --ghcjs-pkg-options OPTS
1883 give extra options to ghcjs-pkg
1884
1885 --greencard-options OPTS
1886 give extra options to greencard
1887
1888 --haddock-options OPTS
1889 give extra options to haddock
1890
1891 --happy-options OPTS
1892 give extra options to happy
1893
1894 --haskell-suite-options OPTS
1895 give extra options to haskell-suite
1896
1897 --haskell-suite-pkg-options OPTS
1898 give extra options to haskell-suite-pkg
1899
1900 --hmake-options OPTS
1901 give extra options to hmake
1902
1903 --hpc-options OPTS
1904 give extra options to hpc
1905
1906 --hsc2hs-options OPTS
1907 give extra options to hsc2hs
1908
1909 --hscolour-options OPTS
1910 give extra options to hscolour
1911
1912 --jhc-options OPTS
1913 give extra options to jhc
1914
1915 --ld-options OPTS
1916 give extra options to ld
1917
1918 --pkg-config-options OPTS
1919 give extra options to pkg-config
1920
1921 --runghc-options OPTS
1922 give extra options to runghc
1923
1924 --strip-options OPTS
1925 give extra options to strip
1926
1927 --tar-options OPTS
1928 give extra options to tar
1929
1930 --uhc-options OPTS
1931 give extra options to uhc
1932
1933 --cabal-lib-version VERSION
1934 Select which version of the Cabal lib to use to build
1935 packages (useful for testing).
1936
1937 --constraint CONSTRAINT
1938 Specify constraints on a package (version,
1939 installed/source, flags)
1940
1941 --preference CONSTRAINT
1942 Specify preferences (soft constraints) on the version of
1943 a package
1944
1945 --solver SOLVER
1946 Select dependency solver to use (default: modular).
1947 Choices: modular.
1948
1949 --allow-older [DEPS]
1950 Ignore lower bounds in all dependencies or DEPS
1951
1952 --allow-newer [DEPS]
1953 Ignore upper bounds in all dependencies or DEPS
1954
1955 --write-ghc-environment-files always|never|ghc8.4.4+
1956 Whether to create a .ghc.environment file after a suc‐
1957 cessful build (v2-build only)
1958
1959 --enable-documentation
1960 --disable-documentation
1961 building of documentation
1962
1963 --doc-index-file TEMPLATE
1964 A central index of haddock API documentation (template
1965 cannot use $pkgid)
1966
1967 --dry-run
1968 Do not install anything, only print what would be
1969 installed.
1970
1971 --max-backjumps NUM
1972 Maximum number of backjumps allowed while solving
1973 (default: 2000). Use a negative number to enable unlim‐
1974 ited backtracking. Use 0 to disable backtracking com‐
1975 pletely.
1976
1977 --reorder-goals
1978 --no-reorder-goals
1979 Try to reorder goals according to certain heuristics.
1980 Slows things down on average, but may make backtracking
1981 faster for some packages.
1982
1983 --count-conflicts
1984 --no-count-conflicts
1985 Try to speed up solving by preferring goals that are
1986 involved in a lot of conflicts (default).
1987
1988 --independent-goals
1989 --no-independent-goals
1990 Treat several goals on the command line as independent.
1991 If several goals depend on the same package, different
1992 versions can be chosen.
1993
1994 --shadow-installed-packages
1995 --no-shadow-installed-packages
1996 If multiple package instances of the same version are
1997 installed, treat all but one as shadowed.
1998
1999 --strong-flags
2000 --no-strong-flags
2001 Do not defer flag choices (this used to be the default in
2002 cabal-install <= 1.20).
2003
2004 --allow-boot-library-installs
2005 --no-allow-boot-library-installs
2006 Allow cabal to install base, ghc-prim, integer-simple,
2007 integer-gmp, and template-haskell.
2008
2009 --reinstall
2010 --no-reinstall
2011 Install even if it means installing the same version
2012 again.
2013
2014 --avoid-reinstalls
2015 --no-avoid-reinstalls
2016 Do not select versions that would destructively overwrite
2017 installed packages.
2018
2019 --force-reinstalls
2020 --no-force-reinstalls
2021 Reinstall packages even if they will most likely break
2022 other installed packages.
2023
2024 --upgrade-dependencies
2025 --no-upgrade-dependencies
2026 Pick the latest version for all dependencies, rather than
2027 trying to pick an installed version.
2028
2029 --only-dependencies
2030 --no-only-dependencies
2031 Install only the dependencies necessary to build the
2032 given packages
2033
2034 --dependencies-only
2035 --no-dependencies-only
2036 A synonym for --only-dependencies
2037
2038 --index-state STATE
2039 Use source package index state as it existed at a previ‐
2040 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
2041 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
2042 'HEAD' (default: 'HEAD').
2043
2044 --root-cmd COMMAND
2045 (No longer supported, do not use.)
2046
2047 --symlink-bindir DIR
2048 Add symlinks to installed executables into this direc‐
2049 tory.
2050
2051 --build-summary TEMPLATE
2052 Save build summaries to file (name template can use
2053 $pkgid, $compiler, $os, $arch)
2054
2055 --build-log TEMPLATE
2056 Log all builds to file (name template can use $pkgid,
2057 $compiler, $os, $arch)
2058
2059 --remote-build-reporting LEVEL
2060 Generate build reports to send to a remote server (none,
2061 anonymous or detailed).
2062
2063 --report-planning-failure
2064 Generate build reports when the dependency solver fails.
2065 This is used by the Hackage build bot.
2066
2067 --enable-per-component
2068 --disable-per-component
2069 Per-component builds when possible
2070
2071 --one-shot
2072 --no-one-shot
2073 Do not record the packages in the world file.
2074
2075 --run-tests
2076 Run package test suites during installation.
2077
2078 -j, --jobs [NUM]
2079 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
2080 given).
2081
2082 --keep-going
2083 After a build failure, continue to build other unaffected
2084 packages.
2085
2086 --offline
2087 --no-offline
2088 Don't download packages from the Internet.
2089
2090 --project-file FILE
2091 Set the name of the cabal.project file to search for in
2092 parent directories
2093
2094 --only
2095 Only installs the package in the current directory.
2096
2097 --haddock-hoogle
2098 Generate a hoogle database
2099
2100 --haddock-html
2101 Generate HTML documentation (the default)
2102
2103 --haddock-html-location URL
2104 Location of HTML documentation for pre-requisite packages
2105
2106 --haddock-for-hackage
2107 Collection of flags to generate documentation suitable
2108 for upload to hackage
2109
2110 --haddock-executables
2111 Run haddock for Executables targets
2112
2113 --haddock-tests
2114 Run haddock for Test Suite targets
2115
2116 --haddock-benchmarks
2117 Run haddock for Benchmark targets
2118
2119 --haddock-all
2120 Run haddock for all targets
2121
2122 --haddock-internal
2123 Run haddock for internal modules and include all symbols
2124
2125 --haddock-css PATH
2126 Use PATH as the haddock stylesheet
2127
2128 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
2129 dock-hyperlinked-source
2130 Hyperlink the documentation to the source code
2131
2132 --haddock-quickjump
2133 Generate an index for interactive documentation naviga‐
2134 tion
2135
2136 --haddock-hscolour-css PATH
2137 Use PATH as the HsColour stylesheet
2138
2139 --haddock-contents-location URL
2140 Bake URL in as the location for the contents page
2141
2142
2143 cabal v2-update
2144
2145 Usage: cabal v2-update [FLAGS] [REPOS]
2146
2147
2148 For all known remote repositories, download the package list.
2149
2150
2151 For all known remote repositories, download the package list.
2152
2153
2154 Flags:
2155 -v, --verbose [n]
2156 Control verbosity (n is 0--3, default verbosity level is
2157 1)
2158
2159 --builddir, --distdir, --distpref DIR
2160 The directory where Cabal puts generated build files
2161 (default dist)
2162
2163 -g, --ghc
2164 compile with GHC
2165
2166 --ghcjs
2167 compile with GHCJS
2168
2169 --uhc
2170 compile with UHC
2171
2172 --haskell-suite
2173 compile with a haskell-suite compiler
2174
2175 --cabal-file PATH
2176 use this Cabal file
2177
2178 -w, --with-compiler PATH
2179 give the path to a particular compiler
2180
2181 --with-hc-pkg PATH
2182 give the path to the package tool
2183
2184 --prefix DIR
2185 bake this prefix in preparation of installation
2186
2187 --bindir DIR
2188 installation directory for executables
2189
2190 --libdir DIR
2191 installation directory for libraries
2192
2193 --libsubdir DIR
2194 subdirectory of libdir in which libs are installed
2195
2196 --dynlibdir DIR
2197 installation directory for dynamic libraries
2198
2199 --libexecdir DIR
2200 installation directory for program executables
2201
2202 --libexecsubdir DIR
2203 subdirectory of libexecdir in which private executables
2204 are installed
2205
2206 --datadir DIR
2207 installation directory for read-only data
2208
2209 --datasubdir DIR
2210 subdirectory of datadir in which data files are installed
2211
2212 --docdir DIR
2213 installation directory for documentation
2214
2215 --htmldir DIR
2216 installation directory for HTML documentation
2217
2218 --haddockdir DIR
2219 installation directory for haddock interfaces
2220
2221 --sysconfdir DIR
2222 installation directory for configuration files
2223
2224 --program-prefix PREFIX
2225 prefix to be applied to installed executables
2226
2227 --program-suffix SUFFIX
2228 suffix to be applied to installed executables
2229
2230 --enable-library-vanilla
2231 --disable-library-vanilla
2232 Vanilla libraries
2233
2234 -p, --enable-library-profiling
2235 --disable-library-profiling
2236 Library profiling
2237
2238 --enable-shared
2239 --disable-shared
2240 Shared library
2241
2242 --enable-static
2243 --disable-static
2244 Static library
2245
2246 --enable-executable-dynamic
2247 --disable-executable-dynamic
2248 Executable dynamic linking
2249
2250 --enable-profiling
2251 --disable-profiling
2252 Executable and library profiling
2253
2254 --enable-executable-profiling
2255 --disable-executable-profiling
2256 Executable profiling (DEPRECATED)
2257
2258 --profiling-detail level
2259 Profiling detail level for executable and library
2260 (default, none, exported-functions, toplevel-functions,
2261 all-functions).
2262
2263 --library-profiling-detail level
2264 Profiling detail level for libraries only.
2265
2266 -O, --enable-optimization, --enable-optimisation [n]
2267 Build with optimization (n is 0--2, default is 1)
2268
2269 --disable-optimization, --disable-optimisation
2270 Build without optimization
2271
2272 --enable-debug-info [n]
2273 Emit debug info (n is 0--3, default is 0)
2274
2275 --disable-debug-info
2276 Don't emit debug info
2277
2278 --enable-library-for-ghci
2279 --disable-library-for-ghci
2280 compile library for use with GHCi
2281
2282 --enable-split-sections
2283 --disable-split-sections
2284 compile library code such that unneeded definitions can
2285 be dropped from the final executable (GHC 7.8+)
2286
2287 --enable-split-objs
2288 --disable-split-objs
2289 split library into smaller objects to reduce binary sizes
2290 (GHC 6.6+)
2291
2292 --enable-executable-stripping
2293 --disable-executable-stripping
2294 strip executables upon installation to reduce binary
2295 sizes
2296
2297 --enable-library-stripping
2298 --disable-library-stripping
2299 strip libraries upon installation to reduce binary sizes
2300
2301 --configure-option OPT
2302 Extra option for configure
2303
2304 --user
2305 --global
2306 doing a per-user installation
2307
2308 --package-db DB
2309 Append the given package database to the list of package
2310 databases used (to satisfy dependencies and register
2311 into). May be a specific file, 'global' or 'user'. The
2312 initial list is ['global'], ['global', 'user'], or
2313 ['global', $sandbox], depending on context. Use 'clear'
2314 to reset the list to empty. See the user guide for
2315 details.
2316
2317 -f, --flags FLAGS
2318 Force values for the given flags in Cabal conditionals in
2319 the .cabal file. E.g., --flags="debug -usebytestrings"
2320 forces the flag "debug" to true and "usebytestrings" to
2321 false.
2322
2323 --extra-include-dirs PATH
2324 A list of directories to search for header files
2325
2326 --enable-deterministic
2327 --disable-deterministic
2328 Try to be as deterministic as possible (used by the test
2329 suite)
2330
2331 --ipid IPID
2332 Installed package ID to compile this package as
2333
2334 --cid CID
2335 Installed component ID to compile this component as
2336
2337 --extra-lib-dirs PATH
2338 A list of directories to search for external libraries
2339
2340 --extra-framework-dirs PATH
2341 A list of directories to search for external frameworks
2342 (OS X only)
2343
2344 --extra-prog-path PATH
2345 A list of directories to search for required programs (in
2346 addition to the normal search locations)
2347
2348 --instantiate-with NAME=MOD
2349 A mapping of signature names to concrete module instanti‐
2350 ations.
2351
2352 --enable-tests
2353 --disable-tests
2354 dependency checking and compilation for test suites
2355 listed in the package description file.
2356
2357 --enable-coverage
2358 --disable-coverage
2359 build package with Haskell Program Coverage. (GHC only)
2360
2361 --enable-library-coverage
2362 --disable-library-coverage
2363 build package with Haskell Program Coverage. (GHC only)
2364 (DEPRECATED)
2365
2366 --enable-benchmarks
2367 --disable-benchmarks
2368 dependency checking and compilation for benchmarks listed
2369 in the package description file.
2370
2371 --enable-relocatable
2372 --disable-relocatable
2373 building a package that is relocatable. (GHC only)
2374
2375 --disable-response-files
2376 enable workaround for old versions of programs like "ar"
2377 that do not support @file arguments
2378
2379 --with-alex PATH
2380 give the path to alex
2381
2382 --with-ar PATH
2383 give the path to ar
2384
2385 --with-c2hs PATH
2386 give the path to c2hs
2387
2388 --with-cpphs PATH
2389 give the path to cpphs
2390
2391 --with-doctest PATH
2392 give the path to doctest
2393
2394 --with-gcc PATH
2395 give the path to gcc
2396
2397 --with-ghc PATH
2398 give the path to ghc
2399
2400 --with-ghc-pkg PATH
2401 give the path to ghc-pkg
2402
2403 --with-ghcjs PATH
2404 give the path to ghcjs
2405
2406 --with-ghcjs-pkg PATH
2407 give the path to ghcjs-pkg
2408
2409 --with-greencard PATH
2410 give the path to greencard
2411
2412 --with-haddock PATH
2413 give the path to haddock
2414
2415 --with-happy PATH
2416 give the path to happy
2417
2418 --with-haskell-suite PATH
2419 give the path to haskell-suite
2420
2421 --with-haskell-suite-pkg PATH
2422 give the path to haskell-suite-pkg
2423
2424 --with-hmake PATH
2425 give the path to hmake
2426
2427 --with-hpc PATH
2428 give the path to hpc
2429
2430 --with-hsc2hs PATH
2431 give the path to hsc2hs
2432
2433 --with-hscolour PATH
2434 give the path to hscolour
2435
2436 --with-jhc PATH
2437 give the path to jhc
2438
2439 --with-ld PATH
2440 give the path to ld
2441
2442 --with-pkg-config PATH
2443 give the path to pkg-config
2444
2445 --with-runghc PATH
2446 give the path to runghc
2447
2448 --with-strip PATH
2449 give the path to strip
2450
2451 --with-tar PATH
2452 give the path to tar
2453
2454 --with-uhc PATH
2455 give the path to uhc
2456
2457 --alex-option OPT
2458 give an extra option to alex (no need to quote options
2459 containing spaces)
2460
2461 --ar-option OPT
2462 give an extra option to ar (no need to quote options con‐
2463 taining spaces)
2464
2465 --c2hs-option OPT
2466 give an extra option to c2hs (no need to quote options
2467 containing spaces)
2468
2469 --cpphs-option OPT
2470 give an extra option to cpphs (no need to quote options
2471 containing spaces)
2472
2473 --doctest-option OPT
2474 give an extra option to doctest (no need to quote options
2475 containing spaces)
2476
2477 --gcc-option OPT
2478 give an extra option to gcc (no need to quote options
2479 containing spaces)
2480
2481 --ghc-option OPT
2482 give an extra option to ghc (no need to quote options
2483 containing spaces)
2484
2485 --ghc-pkg-option OPT
2486 give an extra option to ghc-pkg (no need to quote options
2487 containing spaces)
2488
2489 --ghcjs-option OPT
2490 give an extra option to ghcjs (no need to quote options
2491 containing spaces)
2492
2493 --ghcjs-pkg-option OPT
2494 give an extra option to ghcjs-pkg (no need to quote
2495 options containing spaces)
2496
2497 --greencard-option OPT
2498 give an extra option to greencard (no need to quote
2499 options containing spaces)
2500
2501 --haddock-option OPT
2502 give an extra option to haddock (no need to quote options
2503 containing spaces)
2504
2505 --happy-option OPT
2506 give an extra option to happy (no need to quote options
2507 containing spaces)
2508
2509 --haskell-suite-option OPT
2510 give an extra option to haskell-suite (no need to quote
2511 options containing spaces)
2512
2513 --haskell-suite-pkg-option OPT
2514 give an extra option to haskell-suite-pkg (no need to
2515 quote options containing spaces)
2516
2517 --hmake-option OPT
2518 give an extra option to hmake (no need to quote options
2519 containing spaces)
2520
2521 --hpc-option OPT
2522 give an extra option to hpc (no need to quote options
2523 containing spaces)
2524
2525 --hsc2hs-option OPT
2526 give an extra option to hsc2hs (no need to quote options
2527 containing spaces)
2528
2529 --hscolour-option OPT
2530 give an extra option to hscolour (no need to quote
2531 options containing spaces)
2532
2533 --jhc-option OPT
2534 give an extra option to jhc (no need to quote options
2535 containing spaces)
2536
2537 --ld-option OPT
2538 give an extra option to ld (no need to quote options con‐
2539 taining spaces)
2540
2541 --pkg-config-option OPT
2542 give an extra option to pkg-config (no need to quote
2543 options containing spaces)
2544
2545 --runghc-option OPT
2546 give an extra option to runghc (no need to quote options
2547 containing spaces)
2548
2549 --strip-option OPT
2550 give an extra option to strip (no need to quote options
2551 containing spaces)
2552
2553 --tar-option OPT
2554 give an extra option to tar (no need to quote options
2555 containing spaces)
2556
2557 --uhc-option OPT
2558 give an extra option to uhc (no need to quote options
2559 containing spaces)
2560
2561 --alex-options OPTS
2562 give extra options to alex
2563
2564 --ar-options OPTS
2565 give extra options to ar
2566
2567 --c2hs-options OPTS
2568 give extra options to c2hs
2569
2570 --cpphs-options OPTS
2571 give extra options to cpphs
2572
2573 --doctest-options OPTS
2574 give extra options to doctest
2575
2576 --gcc-options OPTS
2577 give extra options to gcc
2578
2579 --ghc-options OPTS
2580 give extra options to ghc
2581
2582 --ghc-pkg-options OPTS
2583 give extra options to ghc-pkg
2584
2585 --ghcjs-options OPTS
2586 give extra options to ghcjs
2587
2588 --ghcjs-pkg-options OPTS
2589 give extra options to ghcjs-pkg
2590
2591 --greencard-options OPTS
2592 give extra options to greencard
2593
2594 --haddock-options OPTS
2595 give extra options to haddock
2596
2597 --happy-options OPTS
2598 give extra options to happy
2599
2600 --haskell-suite-options OPTS
2601 give extra options to haskell-suite
2602
2603 --haskell-suite-pkg-options OPTS
2604 give extra options to haskell-suite-pkg
2605
2606 --hmake-options OPTS
2607 give extra options to hmake
2608
2609 --hpc-options OPTS
2610 give extra options to hpc
2611
2612 --hsc2hs-options OPTS
2613 give extra options to hsc2hs
2614
2615 --hscolour-options OPTS
2616 give extra options to hscolour
2617
2618 --jhc-options OPTS
2619 give extra options to jhc
2620
2621 --ld-options OPTS
2622 give extra options to ld
2623
2624 --pkg-config-options OPTS
2625 give extra options to pkg-config
2626
2627 --runghc-options OPTS
2628 give extra options to runghc
2629
2630 --strip-options OPTS
2631 give extra options to strip
2632
2633 --tar-options OPTS
2634 give extra options to tar
2635
2636 --uhc-options OPTS
2637 give extra options to uhc
2638
2639 --cabal-lib-version VERSION
2640 Select which version of the Cabal lib to use to build
2641 packages (useful for testing).
2642
2643 --constraint CONSTRAINT
2644 Specify constraints on a package (version,
2645 installed/source, flags)
2646
2647 --preference CONSTRAINT
2648 Specify preferences (soft constraints) on the version of
2649 a package
2650
2651 --solver SOLVER
2652 Select dependency solver to use (default: modular).
2653 Choices: modular.
2654
2655 --allow-older [DEPS]
2656 Ignore lower bounds in all dependencies or DEPS
2657
2658 --allow-newer [DEPS]
2659 Ignore upper bounds in all dependencies or DEPS
2660
2661 --write-ghc-environment-files always|never|ghc8.4.4+
2662 Whether to create a .ghc.environment file after a suc‐
2663 cessful build (v2-build only)
2664
2665 --enable-documentation
2666 --disable-documentation
2667 building of documentation
2668
2669 --doc-index-file TEMPLATE
2670 A central index of haddock API documentation (template
2671 cannot use $pkgid)
2672
2673 --dry-run
2674 Do not install anything, only print what would be
2675 installed.
2676
2677 --max-backjumps NUM
2678 Maximum number of backjumps allowed while solving
2679 (default: 2000). Use a negative number to enable unlim‐
2680 ited backtracking. Use 0 to disable backtracking com‐
2681 pletely.
2682
2683 --reorder-goals
2684 --no-reorder-goals
2685 Try to reorder goals according to certain heuristics.
2686 Slows things down on average, but may make backtracking
2687 faster for some packages.
2688
2689 --count-conflicts
2690 --no-count-conflicts
2691 Try to speed up solving by preferring goals that are
2692 involved in a lot of conflicts (default).
2693
2694 --independent-goals
2695 --no-independent-goals
2696 Treat several goals on the command line as independent.
2697 If several goals depend on the same package, different
2698 versions can be chosen.
2699
2700 --shadow-installed-packages
2701 --no-shadow-installed-packages
2702 If multiple package instances of the same version are
2703 installed, treat all but one as shadowed.
2704
2705 --strong-flags
2706 --no-strong-flags
2707 Do not defer flag choices (this used to be the default in
2708 cabal-install <= 1.20).
2709
2710 --allow-boot-library-installs
2711 --no-allow-boot-library-installs
2712 Allow cabal to install base, ghc-prim, integer-simple,
2713 integer-gmp, and template-haskell.
2714
2715 --reinstall
2716 --no-reinstall
2717 Install even if it means installing the same version
2718 again.
2719
2720 --avoid-reinstalls
2721 --no-avoid-reinstalls
2722 Do not select versions that would destructively overwrite
2723 installed packages.
2724
2725 --force-reinstalls
2726 --no-force-reinstalls
2727 Reinstall packages even if they will most likely break
2728 other installed packages.
2729
2730 --upgrade-dependencies
2731 --no-upgrade-dependencies
2732 Pick the latest version for all dependencies, rather than
2733 trying to pick an installed version.
2734
2735 --only-dependencies
2736 --no-only-dependencies
2737 Install only the dependencies necessary to build the
2738 given packages
2739
2740 --dependencies-only
2741 --no-dependencies-only
2742 A synonym for --only-dependencies
2743
2744 --index-state STATE
2745 Use source package index state as it existed at a previ‐
2746 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
2747 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
2748 'HEAD' (default: 'HEAD').
2749
2750 --root-cmd COMMAND
2751 (No longer supported, do not use.)
2752
2753 --symlink-bindir DIR
2754 Add symlinks to installed executables into this direc‐
2755 tory.
2756
2757 --build-summary TEMPLATE
2758 Save build summaries to file (name template can use
2759 $pkgid, $compiler, $os, $arch)
2760
2761 --build-log TEMPLATE
2762 Log all builds to file (name template can use $pkgid,
2763 $compiler, $os, $arch)
2764
2765 --remote-build-reporting LEVEL
2766 Generate build reports to send to a remote server (none,
2767 anonymous or detailed).
2768
2769 --report-planning-failure
2770 Generate build reports when the dependency solver fails.
2771 This is used by the Hackage build bot.
2772
2773 --enable-per-component
2774 --disable-per-component
2775 Per-component builds when possible
2776
2777 --one-shot
2778 --no-one-shot
2779 Do not record the packages in the world file.
2780
2781 --run-tests
2782 Run package test suites during installation.
2783
2784 -j, --jobs [NUM]
2785 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
2786 given).
2787
2788 --keep-going
2789 After a build failure, continue to build other unaffected
2790 packages.
2791
2792 --offline
2793 --no-offline
2794 Don't download packages from the Internet.
2795
2796 --project-file FILE
2797 Set the name of the cabal.project file to search for in
2798 parent directories
2799
2800 --only
2801 Only installs the package in the current directory.
2802
2803 --haddock-hoogle
2804 Generate a hoogle database
2805
2806 --haddock-html
2807 Generate HTML documentation (the default)
2808
2809 --haddock-html-location URL
2810 Location of HTML documentation for pre-requisite packages
2811
2812 --haddock-for-hackage
2813 Collection of flags to generate documentation suitable
2814 for upload to hackage
2815
2816 --haddock-executables
2817 Run haddock for Executables targets
2818
2819 --haddock-tests
2820 Run haddock for Test Suite targets
2821
2822 --haddock-benchmarks
2823 Run haddock for Benchmark targets
2824
2825 --haddock-all
2826 Run haddock for all targets
2827
2828 --haddock-internal
2829 Run haddock for internal modules and include all symbols
2830
2831 --haddock-css PATH
2832 Use PATH as the haddock stylesheet
2833
2834 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
2835 dock-hyperlinked-source
2836 Hyperlink the documentation to the source code
2837
2838 --haddock-quickjump
2839 Generate an index for interactive documentation naviga‐
2840 tion
2841
2842 --haddock-hscolour-css PATH
2843 Use PATH as the HsColour stylesheet
2844
2845 --haddock-contents-location URL
2846 Bake URL in as the location for the contents page
2847
2848
2849 cabal new-update
2850
2851 Usage: cabal new-update [FLAGS] [REPOS]
2852
2853
2854 For all known remote repositories, download the package list.
2855
2856
2857 REPO has the format <repo-id>[,<index-state>] where index-state follows
2858 the same format and syntax that is supported by the --index-state flag.
2859
2860 Examples:
2861 cabal new-update
2862 Download the package list for all known remote repositories.
2863
2864 cabal new-update hackage.haskell.org,@1474732068
2865 cabal new-update hackage.haskell.org,2016-09-24T17:47:48Z
2866 cabal new-update hackage.haskell.org,HEAD
2867 cabal new-update hackage.haskell.org
2868 Download hackage.haskell.org at a specific index state.
2869
2870 cabal new update hackage.haskell.org head.hackage
2871 Download hackage.haskell.org and head.hackage
2872 head.hackage must be a known repo-id. E.g. from
2873 your cabal.project(.local) file.
2874
2875 Note: this command is part of the new project-based system (aka nix-
2876 style local builds). These features are currently in beta. Please see
2877 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
2878 details and advice on what you can expect to work. If you encounter
2879 problems please file issues at https://github.com/haskell/cabal/issues
2880 and if you have any time to get involved and help with testing, fixing
2881 bugs etc then that is very much appreciated.
2882
2883
2884 Flags:
2885 -v, --verbose [n]
2886 Control verbosity (n is 0--3, default verbosity level is
2887 1)
2888
2889 --builddir, --distdir, --distpref DIR
2890 The directory where Cabal puts generated build files
2891 (default dist)
2892
2893 -g, --ghc
2894 compile with GHC
2895
2896 --ghcjs
2897 compile with GHCJS
2898
2899 --uhc
2900 compile with UHC
2901
2902 --haskell-suite
2903 compile with a haskell-suite compiler
2904
2905 --cabal-file PATH
2906 use this Cabal file
2907
2908 -w, --with-compiler PATH
2909 give the path to a particular compiler
2910
2911 --with-hc-pkg PATH
2912 give the path to the package tool
2913
2914 --prefix DIR
2915 bake this prefix in preparation of installation
2916
2917 --bindir DIR
2918 installation directory for executables
2919
2920 --libdir DIR
2921 installation directory for libraries
2922
2923 --libsubdir DIR
2924 subdirectory of libdir in which libs are installed
2925
2926 --dynlibdir DIR
2927 installation directory for dynamic libraries
2928
2929 --libexecdir DIR
2930 installation directory for program executables
2931
2932 --libexecsubdir DIR
2933 subdirectory of libexecdir in which private executables
2934 are installed
2935
2936 --datadir DIR
2937 installation directory for read-only data
2938
2939 --datasubdir DIR
2940 subdirectory of datadir in which data files are installed
2941
2942 --docdir DIR
2943 installation directory for documentation
2944
2945 --htmldir DIR
2946 installation directory for HTML documentation
2947
2948 --haddockdir DIR
2949 installation directory for haddock interfaces
2950
2951 --sysconfdir DIR
2952 installation directory for configuration files
2953
2954 --program-prefix PREFIX
2955 prefix to be applied to installed executables
2956
2957 --program-suffix SUFFIX
2958 suffix to be applied to installed executables
2959
2960 --enable-library-vanilla
2961 --disable-library-vanilla
2962 Vanilla libraries
2963
2964 -p, --enable-library-profiling
2965 --disable-library-profiling
2966 Library profiling
2967
2968 --enable-shared
2969 --disable-shared
2970 Shared library
2971
2972 --enable-static
2973 --disable-static
2974 Static library
2975
2976 --enable-executable-dynamic
2977 --disable-executable-dynamic
2978 Executable dynamic linking
2979
2980 --enable-profiling
2981 --disable-profiling
2982 Executable and library profiling
2983
2984 --enable-executable-profiling
2985 --disable-executable-profiling
2986 Executable profiling (DEPRECATED)
2987
2988 --profiling-detail level
2989 Profiling detail level for executable and library
2990 (default, none, exported-functions, toplevel-functions,
2991 all-functions).
2992
2993 --library-profiling-detail level
2994 Profiling detail level for libraries only.
2995
2996 -O, --enable-optimization, --enable-optimisation [n]
2997 Build with optimization (n is 0--2, default is 1)
2998
2999 --disable-optimization, --disable-optimisation
3000 Build without optimization
3001
3002 --enable-debug-info [n]
3003 Emit debug info (n is 0--3, default is 0)
3004
3005 --disable-debug-info
3006 Don't emit debug info
3007
3008 --enable-library-for-ghci
3009 --disable-library-for-ghci
3010 compile library for use with GHCi
3011
3012 --enable-split-sections
3013 --disable-split-sections
3014 compile library code such that unneeded definitions can
3015 be dropped from the final executable (GHC 7.8+)
3016
3017 --enable-split-objs
3018 --disable-split-objs
3019 split library into smaller objects to reduce binary sizes
3020 (GHC 6.6+)
3021
3022 --enable-executable-stripping
3023 --disable-executable-stripping
3024 strip executables upon installation to reduce binary
3025 sizes
3026
3027 --enable-library-stripping
3028 --disable-library-stripping
3029 strip libraries upon installation to reduce binary sizes
3030
3031 --configure-option OPT
3032 Extra option for configure
3033
3034 --user
3035 --global
3036 doing a per-user installation
3037
3038 --package-db DB
3039 Append the given package database to the list of package
3040 databases used (to satisfy dependencies and register
3041 into). May be a specific file, 'global' or 'user'. The
3042 initial list is ['global'], ['global', 'user'], or
3043 ['global', $sandbox], depending on context. Use 'clear'
3044 to reset the list to empty. See the user guide for
3045 details.
3046
3047 -f, --flags FLAGS
3048 Force values for the given flags in Cabal conditionals in
3049 the .cabal file. E.g., --flags="debug -usebytestrings"
3050 forces the flag "debug" to true and "usebytestrings" to
3051 false.
3052
3053 --extra-include-dirs PATH
3054 A list of directories to search for header files
3055
3056 --enable-deterministic
3057 --disable-deterministic
3058 Try to be as deterministic as possible (used by the test
3059 suite)
3060
3061 --ipid IPID
3062 Installed package ID to compile this package as
3063
3064 --cid CID
3065 Installed component ID to compile this component as
3066
3067 --extra-lib-dirs PATH
3068 A list of directories to search for external libraries
3069
3070 --extra-framework-dirs PATH
3071 A list of directories to search for external frameworks
3072 (OS X only)
3073
3074 --extra-prog-path PATH
3075 A list of directories to search for required programs (in
3076 addition to the normal search locations)
3077
3078 --instantiate-with NAME=MOD
3079 A mapping of signature names to concrete module instanti‐
3080 ations.
3081
3082 --enable-tests
3083 --disable-tests
3084 dependency checking and compilation for test suites
3085 listed in the package description file.
3086
3087 --enable-coverage
3088 --disable-coverage
3089 build package with Haskell Program Coverage. (GHC only)
3090
3091 --enable-library-coverage
3092 --disable-library-coverage
3093 build package with Haskell Program Coverage. (GHC only)
3094 (DEPRECATED)
3095
3096 --enable-benchmarks
3097 --disable-benchmarks
3098 dependency checking and compilation for benchmarks listed
3099 in the package description file.
3100
3101 --enable-relocatable
3102 --disable-relocatable
3103 building a package that is relocatable. (GHC only)
3104
3105 --disable-response-files
3106 enable workaround for old versions of programs like "ar"
3107 that do not support @file arguments
3108
3109 --with-alex PATH
3110 give the path to alex
3111
3112 --with-ar PATH
3113 give the path to ar
3114
3115 --with-c2hs PATH
3116 give the path to c2hs
3117
3118 --with-cpphs PATH
3119 give the path to cpphs
3120
3121 --with-doctest PATH
3122 give the path to doctest
3123
3124 --with-gcc PATH
3125 give the path to gcc
3126
3127 --with-ghc PATH
3128 give the path to ghc
3129
3130 --with-ghc-pkg PATH
3131 give the path to ghc-pkg
3132
3133 --with-ghcjs PATH
3134 give the path to ghcjs
3135
3136 --with-ghcjs-pkg PATH
3137 give the path to ghcjs-pkg
3138
3139 --with-greencard PATH
3140 give the path to greencard
3141
3142 --with-haddock PATH
3143 give the path to haddock
3144
3145 --with-happy PATH
3146 give the path to happy
3147
3148 --with-haskell-suite PATH
3149 give the path to haskell-suite
3150
3151 --with-haskell-suite-pkg PATH
3152 give the path to haskell-suite-pkg
3153
3154 --with-hmake PATH
3155 give the path to hmake
3156
3157 --with-hpc PATH
3158 give the path to hpc
3159
3160 --with-hsc2hs PATH
3161 give the path to hsc2hs
3162
3163 --with-hscolour PATH
3164 give the path to hscolour
3165
3166 --with-jhc PATH
3167 give the path to jhc
3168
3169 --with-ld PATH
3170 give the path to ld
3171
3172 --with-pkg-config PATH
3173 give the path to pkg-config
3174
3175 --with-runghc PATH
3176 give the path to runghc
3177
3178 --with-strip PATH
3179 give the path to strip
3180
3181 --with-tar PATH
3182 give the path to tar
3183
3184 --with-uhc PATH
3185 give the path to uhc
3186
3187 --alex-option OPT
3188 give an extra option to alex (no need to quote options
3189 containing spaces)
3190
3191 --ar-option OPT
3192 give an extra option to ar (no need to quote options con‐
3193 taining spaces)
3194
3195 --c2hs-option OPT
3196 give an extra option to c2hs (no need to quote options
3197 containing spaces)
3198
3199 --cpphs-option OPT
3200 give an extra option to cpphs (no need to quote options
3201 containing spaces)
3202
3203 --doctest-option OPT
3204 give an extra option to doctest (no need to quote options
3205 containing spaces)
3206
3207 --gcc-option OPT
3208 give an extra option to gcc (no need to quote options
3209 containing spaces)
3210
3211 --ghc-option OPT
3212 give an extra option to ghc (no need to quote options
3213 containing spaces)
3214
3215 --ghc-pkg-option OPT
3216 give an extra option to ghc-pkg (no need to quote options
3217 containing spaces)
3218
3219 --ghcjs-option OPT
3220 give an extra option to ghcjs (no need to quote options
3221 containing spaces)
3222
3223 --ghcjs-pkg-option OPT
3224 give an extra option to ghcjs-pkg (no need to quote
3225 options containing spaces)
3226
3227 --greencard-option OPT
3228 give an extra option to greencard (no need to quote
3229 options containing spaces)
3230
3231 --haddock-option OPT
3232 give an extra option to haddock (no need to quote options
3233 containing spaces)
3234
3235 --happy-option OPT
3236 give an extra option to happy (no need to quote options
3237 containing spaces)
3238
3239 --haskell-suite-option OPT
3240 give an extra option to haskell-suite (no need to quote
3241 options containing spaces)
3242
3243 --haskell-suite-pkg-option OPT
3244 give an extra option to haskell-suite-pkg (no need to
3245 quote options containing spaces)
3246
3247 --hmake-option OPT
3248 give an extra option to hmake (no need to quote options
3249 containing spaces)
3250
3251 --hpc-option OPT
3252 give an extra option to hpc (no need to quote options
3253 containing spaces)
3254
3255 --hsc2hs-option OPT
3256 give an extra option to hsc2hs (no need to quote options
3257 containing spaces)
3258
3259 --hscolour-option OPT
3260 give an extra option to hscolour (no need to quote
3261 options containing spaces)
3262
3263 --jhc-option OPT
3264 give an extra option to jhc (no need to quote options
3265 containing spaces)
3266
3267 --ld-option OPT
3268 give an extra option to ld (no need to quote options con‐
3269 taining spaces)
3270
3271 --pkg-config-option OPT
3272 give an extra option to pkg-config (no need to quote
3273 options containing spaces)
3274
3275 --runghc-option OPT
3276 give an extra option to runghc (no need to quote options
3277 containing spaces)
3278
3279 --strip-option OPT
3280 give an extra option to strip (no need to quote options
3281 containing spaces)
3282
3283 --tar-option OPT
3284 give an extra option to tar (no need to quote options
3285 containing spaces)
3286
3287 --uhc-option OPT
3288 give an extra option to uhc (no need to quote options
3289 containing spaces)
3290
3291 --alex-options OPTS
3292 give extra options to alex
3293
3294 --ar-options OPTS
3295 give extra options to ar
3296
3297 --c2hs-options OPTS
3298 give extra options to c2hs
3299
3300 --cpphs-options OPTS
3301 give extra options to cpphs
3302
3303 --doctest-options OPTS
3304 give extra options to doctest
3305
3306 --gcc-options OPTS
3307 give extra options to gcc
3308
3309 --ghc-options OPTS
3310 give extra options to ghc
3311
3312 --ghc-pkg-options OPTS
3313 give extra options to ghc-pkg
3314
3315 --ghcjs-options OPTS
3316 give extra options to ghcjs
3317
3318 --ghcjs-pkg-options OPTS
3319 give extra options to ghcjs-pkg
3320
3321 --greencard-options OPTS
3322 give extra options to greencard
3323
3324 --haddock-options OPTS
3325 give extra options to haddock
3326
3327 --happy-options OPTS
3328 give extra options to happy
3329
3330 --haskell-suite-options OPTS
3331 give extra options to haskell-suite
3332
3333 --haskell-suite-pkg-options OPTS
3334 give extra options to haskell-suite-pkg
3335
3336 --hmake-options OPTS
3337 give extra options to hmake
3338
3339 --hpc-options OPTS
3340 give extra options to hpc
3341
3342 --hsc2hs-options OPTS
3343 give extra options to hsc2hs
3344
3345 --hscolour-options OPTS
3346 give extra options to hscolour
3347
3348 --jhc-options OPTS
3349 give extra options to jhc
3350
3351 --ld-options OPTS
3352 give extra options to ld
3353
3354 --pkg-config-options OPTS
3355 give extra options to pkg-config
3356
3357 --runghc-options OPTS
3358 give extra options to runghc
3359
3360 --strip-options OPTS
3361 give extra options to strip
3362
3363 --tar-options OPTS
3364 give extra options to tar
3365
3366 --uhc-options OPTS
3367 give extra options to uhc
3368
3369 --cabal-lib-version VERSION
3370 Select which version of the Cabal lib to use to build
3371 packages (useful for testing).
3372
3373 --constraint CONSTRAINT
3374 Specify constraints on a package (version,
3375 installed/source, flags)
3376
3377 --preference CONSTRAINT
3378 Specify preferences (soft constraints) on the version of
3379 a package
3380
3381 --solver SOLVER
3382 Select dependency solver to use (default: modular).
3383 Choices: modular.
3384
3385 --allow-older [DEPS]
3386 Ignore lower bounds in all dependencies or DEPS
3387
3388 --allow-newer [DEPS]
3389 Ignore upper bounds in all dependencies or DEPS
3390
3391 --write-ghc-environment-files always|never|ghc8.4.4+
3392 Whether to create a .ghc.environment file after a suc‐
3393 cessful build (v2-build only)
3394
3395 --enable-documentation
3396 --disable-documentation
3397 building of documentation
3398
3399 --doc-index-file TEMPLATE
3400 A central index of haddock API documentation (template
3401 cannot use $pkgid)
3402
3403 --dry-run
3404 Do not install anything, only print what would be
3405 installed.
3406
3407 --max-backjumps NUM
3408 Maximum number of backjumps allowed while solving
3409 (default: 2000). Use a negative number to enable unlim‐
3410 ited backtracking. Use 0 to disable backtracking com‐
3411 pletely.
3412
3413 --reorder-goals
3414 --no-reorder-goals
3415 Try to reorder goals according to certain heuristics.
3416 Slows things down on average, but may make backtracking
3417 faster for some packages.
3418
3419 --count-conflicts
3420 --no-count-conflicts
3421 Try to speed up solving by preferring goals that are
3422 involved in a lot of conflicts (default).
3423
3424 --independent-goals
3425 --no-independent-goals
3426 Treat several goals on the command line as independent.
3427 If several goals depend on the same package, different
3428 versions can be chosen.
3429
3430 --shadow-installed-packages
3431 --no-shadow-installed-packages
3432 If multiple package instances of the same version are
3433 installed, treat all but one as shadowed.
3434
3435 --strong-flags
3436 --no-strong-flags
3437 Do not defer flag choices (this used to be the default in
3438 cabal-install <= 1.20).
3439
3440 --allow-boot-library-installs
3441 --no-allow-boot-library-installs
3442 Allow cabal to install base, ghc-prim, integer-simple,
3443 integer-gmp, and template-haskell.
3444
3445 --reinstall
3446 --no-reinstall
3447 Install even if it means installing the same version
3448 again.
3449
3450 --avoid-reinstalls
3451 --no-avoid-reinstalls
3452 Do not select versions that would destructively overwrite
3453 installed packages.
3454
3455 --force-reinstalls
3456 --no-force-reinstalls
3457 Reinstall packages even if they will most likely break
3458 other installed packages.
3459
3460 --upgrade-dependencies
3461 --no-upgrade-dependencies
3462 Pick the latest version for all dependencies, rather than
3463 trying to pick an installed version.
3464
3465 --only-dependencies
3466 --no-only-dependencies
3467 Install only the dependencies necessary to build the
3468 given packages
3469
3470 --dependencies-only
3471 --no-dependencies-only
3472 A synonym for --only-dependencies
3473
3474 --index-state STATE
3475 Use source package index state as it existed at a previ‐
3476 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
3477 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
3478 'HEAD' (default: 'HEAD').
3479
3480 --root-cmd COMMAND
3481 (No longer supported, do not use.)
3482
3483 --symlink-bindir DIR
3484 Add symlinks to installed executables into this direc‐
3485 tory.
3486
3487 --build-summary TEMPLATE
3488 Save build summaries to file (name template can use
3489 $pkgid, $compiler, $os, $arch)
3490
3491 --build-log TEMPLATE
3492 Log all builds to file (name template can use $pkgid,
3493 $compiler, $os, $arch)
3494
3495 --remote-build-reporting LEVEL
3496 Generate build reports to send to a remote server (none,
3497 anonymous or detailed).
3498
3499 --report-planning-failure
3500 Generate build reports when the dependency solver fails.
3501 This is used by the Hackage build bot.
3502
3503 --enable-per-component
3504 --disable-per-component
3505 Per-component builds when possible
3506
3507 --one-shot
3508 --no-one-shot
3509 Do not record the packages in the world file.
3510
3511 --run-tests
3512 Run package test suites during installation.
3513
3514 -j, --jobs [NUM]
3515 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
3516 given).
3517
3518 --keep-going
3519 After a build failure, continue to build other unaffected
3520 packages.
3521
3522 --offline
3523 --no-offline
3524 Don't download packages from the Internet.
3525
3526 --project-file FILE
3527 Set the name of the cabal.project file to search for in
3528 parent directories
3529
3530 --only
3531 Only installs the package in the current directory.
3532
3533 --haddock-hoogle
3534 Generate a hoogle database
3535
3536 --haddock-html
3537 Generate HTML documentation (the default)
3538
3539 --haddock-html-location URL
3540 Location of HTML documentation for pre-requisite packages
3541
3542 --haddock-for-hackage
3543 Collection of flags to generate documentation suitable
3544 for upload to hackage
3545
3546 --haddock-executables
3547 Run haddock for Executables targets
3548
3549 --haddock-tests
3550 Run haddock for Test Suite targets
3551
3552 --haddock-benchmarks
3553 Run haddock for Benchmark targets
3554
3555 --haddock-all
3556 Run haddock for all targets
3557
3558 --haddock-internal
3559 Run haddock for internal modules and include all symbols
3560
3561 --haddock-css PATH
3562 Use PATH as the haddock stylesheet
3563
3564 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
3565 dock-hyperlinked-source
3566 Hyperlink the documentation to the source code
3567
3568 --haddock-quickjump
3569 Generate an index for interactive documentation naviga‐
3570 tion
3571
3572 --haddock-hscolour-css PATH
3573 Use PATH as the HsColour stylesheet
3574
3575 --haddock-contents-location URL
3576 Bake URL in as the location for the contents page
3577
3578
3579 cabal v2-build
3580
3581 Usage: cabal v2-build [TARGETS] [FLAGS]
3582
3583
3584 Build one or more targets from within the project. The available tar‐
3585 gets are the packages in the project as well as individual components
3586 within those packages, including libraries, executables, test-suites or
3587 benchmarks. Targets can be specified by name or location. If no target
3588 is specified then the default is to build the package in the current
3589 directory.
3590
3591 Dependencies are built or rebuilt as necessary. Additional configura‐
3592 tion flags can be specified on the command line and these extend the
3593 project configuration from the 'cabal.project', 'cabal.project.local'
3594 and other files.
3595
3596
3597 Build one or more targets from within the project. The available tar‐
3598 gets are the packages in the project as well as individual components
3599 within those packages, including libraries, executables, test-suites or
3600 benchmarks. Targets can be specified by name or location. If no target
3601 is specified then the default is to build the package in the current
3602 directory.
3603
3604 Dependencies are built or rebuilt as necessary. Additional configura‐
3605 tion flags can be specified on the command line and these extend the
3606 project configuration from the 'cabal.project', 'cabal.project.local'
3607 and other files.
3608
3609
3610 Flags:
3611 -v, --verbose [n]
3612 Control verbosity (n is 0--3, default verbosity level is
3613 1)
3614
3615 --builddir, --distdir, --distpref DIR
3616 The directory where Cabal puts generated build files
3617 (default dist)
3618
3619 -g, --ghc
3620 compile with GHC
3621
3622 --ghcjs
3623 compile with GHCJS
3624
3625 --uhc
3626 compile with UHC
3627
3628 --haskell-suite
3629 compile with a haskell-suite compiler
3630
3631 --cabal-file PATH
3632 use this Cabal file
3633
3634 -w, --with-compiler PATH
3635 give the path to a particular compiler
3636
3637 --with-hc-pkg PATH
3638 give the path to the package tool
3639
3640 --prefix DIR
3641 bake this prefix in preparation of installation
3642
3643 --bindir DIR
3644 installation directory for executables
3645
3646 --libdir DIR
3647 installation directory for libraries
3648
3649 --libsubdir DIR
3650 subdirectory of libdir in which libs are installed
3651
3652 --dynlibdir DIR
3653 installation directory for dynamic libraries
3654
3655 --libexecdir DIR
3656 installation directory for program executables
3657
3658 --libexecsubdir DIR
3659 subdirectory of libexecdir in which private executables
3660 are installed
3661
3662 --datadir DIR
3663 installation directory for read-only data
3664
3665 --datasubdir DIR
3666 subdirectory of datadir in which data files are installed
3667
3668 --docdir DIR
3669 installation directory for documentation
3670
3671 --htmldir DIR
3672 installation directory for HTML documentation
3673
3674 --haddockdir DIR
3675 installation directory for haddock interfaces
3676
3677 --sysconfdir DIR
3678 installation directory for configuration files
3679
3680 --program-prefix PREFIX
3681 prefix to be applied to installed executables
3682
3683 --program-suffix SUFFIX
3684 suffix to be applied to installed executables
3685
3686 --enable-library-vanilla
3687 --disable-library-vanilla
3688 Vanilla libraries
3689
3690 -p, --enable-library-profiling
3691 --disable-library-profiling
3692 Library profiling
3693
3694 --enable-shared
3695 --disable-shared
3696 Shared library
3697
3698 --enable-static
3699 --disable-static
3700 Static library
3701
3702 --enable-executable-dynamic
3703 --disable-executable-dynamic
3704 Executable dynamic linking
3705
3706 --enable-profiling
3707 --disable-profiling
3708 Executable and library profiling
3709
3710 --enable-executable-profiling
3711 --disable-executable-profiling
3712 Executable profiling (DEPRECATED)
3713
3714 --profiling-detail level
3715 Profiling detail level for executable and library
3716 (default, none, exported-functions, toplevel-functions,
3717 all-functions).
3718
3719 --library-profiling-detail level
3720 Profiling detail level for libraries only.
3721
3722 -O, --enable-optimization, --enable-optimisation [n]
3723 Build with optimization (n is 0--2, default is 1)
3724
3725 --disable-optimization, --disable-optimisation
3726 Build without optimization
3727
3728 --enable-debug-info [n]
3729 Emit debug info (n is 0--3, default is 0)
3730
3731 --disable-debug-info
3732 Don't emit debug info
3733
3734 --enable-library-for-ghci
3735 --disable-library-for-ghci
3736 compile library for use with GHCi
3737
3738 --enable-split-sections
3739 --disable-split-sections
3740 compile library code such that unneeded definitions can
3741 be dropped from the final executable (GHC 7.8+)
3742
3743 --enable-split-objs
3744 --disable-split-objs
3745 split library into smaller objects to reduce binary sizes
3746 (GHC 6.6+)
3747
3748 --enable-executable-stripping
3749 --disable-executable-stripping
3750 strip executables upon installation to reduce binary
3751 sizes
3752
3753 --enable-library-stripping
3754 --disable-library-stripping
3755 strip libraries upon installation to reduce binary sizes
3756
3757 --configure-option OPT
3758 Extra option for configure
3759
3760 --user
3761 --global
3762 doing a per-user installation
3763
3764 --package-db DB
3765 Append the given package database to the list of package
3766 databases used (to satisfy dependencies and register
3767 into). May be a specific file, 'global' or 'user'. The
3768 initial list is ['global'], ['global', 'user'], or
3769 ['global', $sandbox], depending on context. Use 'clear'
3770 to reset the list to empty. See the user guide for
3771 details.
3772
3773 -f, --flags FLAGS
3774 Force values for the given flags in Cabal conditionals in
3775 the .cabal file. E.g., --flags="debug -usebytestrings"
3776 forces the flag "debug" to true and "usebytestrings" to
3777 false.
3778
3779 --extra-include-dirs PATH
3780 A list of directories to search for header files
3781
3782 --enable-deterministic
3783 --disable-deterministic
3784 Try to be as deterministic as possible (used by the test
3785 suite)
3786
3787 --ipid IPID
3788 Installed package ID to compile this package as
3789
3790 --cid CID
3791 Installed component ID to compile this component as
3792
3793 --extra-lib-dirs PATH
3794 A list of directories to search for external libraries
3795
3796 --extra-framework-dirs PATH
3797 A list of directories to search for external frameworks
3798 (OS X only)
3799
3800 --extra-prog-path PATH
3801 A list of directories to search for required programs (in
3802 addition to the normal search locations)
3803
3804 --instantiate-with NAME=MOD
3805 A mapping of signature names to concrete module instanti‐
3806 ations.
3807
3808 --enable-tests
3809 --disable-tests
3810 dependency checking and compilation for test suites
3811 listed in the package description file.
3812
3813 --enable-coverage
3814 --disable-coverage
3815 build package with Haskell Program Coverage. (GHC only)
3816
3817 --enable-library-coverage
3818 --disable-library-coverage
3819 build package with Haskell Program Coverage. (GHC only)
3820 (DEPRECATED)
3821
3822 --enable-benchmarks
3823 --disable-benchmarks
3824 dependency checking and compilation for benchmarks listed
3825 in the package description file.
3826
3827 --enable-relocatable
3828 --disable-relocatable
3829 building a package that is relocatable. (GHC only)
3830
3831 --disable-response-files
3832 enable workaround for old versions of programs like "ar"
3833 that do not support @file arguments
3834
3835 --with-alex PATH
3836 give the path to alex
3837
3838 --with-ar PATH
3839 give the path to ar
3840
3841 --with-c2hs PATH
3842 give the path to c2hs
3843
3844 --with-cpphs PATH
3845 give the path to cpphs
3846
3847 --with-doctest PATH
3848 give the path to doctest
3849
3850 --with-gcc PATH
3851 give the path to gcc
3852
3853 --with-ghc PATH
3854 give the path to ghc
3855
3856 --with-ghc-pkg PATH
3857 give the path to ghc-pkg
3858
3859 --with-ghcjs PATH
3860 give the path to ghcjs
3861
3862 --with-ghcjs-pkg PATH
3863 give the path to ghcjs-pkg
3864
3865 --with-greencard PATH
3866 give the path to greencard
3867
3868 --with-haddock PATH
3869 give the path to haddock
3870
3871 --with-happy PATH
3872 give the path to happy
3873
3874 --with-haskell-suite PATH
3875 give the path to haskell-suite
3876
3877 --with-haskell-suite-pkg PATH
3878 give the path to haskell-suite-pkg
3879
3880 --with-hmake PATH
3881 give the path to hmake
3882
3883 --with-hpc PATH
3884 give the path to hpc
3885
3886 --with-hsc2hs PATH
3887 give the path to hsc2hs
3888
3889 --with-hscolour PATH
3890 give the path to hscolour
3891
3892 --with-jhc PATH
3893 give the path to jhc
3894
3895 --with-ld PATH
3896 give the path to ld
3897
3898 --with-pkg-config PATH
3899 give the path to pkg-config
3900
3901 --with-runghc PATH
3902 give the path to runghc
3903
3904 --with-strip PATH
3905 give the path to strip
3906
3907 --with-tar PATH
3908 give the path to tar
3909
3910 --with-uhc PATH
3911 give the path to uhc
3912
3913 --alex-option OPT
3914 give an extra option to alex (no need to quote options
3915 containing spaces)
3916
3917 --ar-option OPT
3918 give an extra option to ar (no need to quote options con‐
3919 taining spaces)
3920
3921 --c2hs-option OPT
3922 give an extra option to c2hs (no need to quote options
3923 containing spaces)
3924
3925 --cpphs-option OPT
3926 give an extra option to cpphs (no need to quote options
3927 containing spaces)
3928
3929 --doctest-option OPT
3930 give an extra option to doctest (no need to quote options
3931 containing spaces)
3932
3933 --gcc-option OPT
3934 give an extra option to gcc (no need to quote options
3935 containing spaces)
3936
3937 --ghc-option OPT
3938 give an extra option to ghc (no need to quote options
3939 containing spaces)
3940
3941 --ghc-pkg-option OPT
3942 give an extra option to ghc-pkg (no need to quote options
3943 containing spaces)
3944
3945 --ghcjs-option OPT
3946 give an extra option to ghcjs (no need to quote options
3947 containing spaces)
3948
3949 --ghcjs-pkg-option OPT
3950 give an extra option to ghcjs-pkg (no need to quote
3951 options containing spaces)
3952
3953 --greencard-option OPT
3954 give an extra option to greencard (no need to quote
3955 options containing spaces)
3956
3957 --haddock-option OPT
3958 give an extra option to haddock (no need to quote options
3959 containing spaces)
3960
3961 --happy-option OPT
3962 give an extra option to happy (no need to quote options
3963 containing spaces)
3964
3965 --haskell-suite-option OPT
3966 give an extra option to haskell-suite (no need to quote
3967 options containing spaces)
3968
3969 --haskell-suite-pkg-option OPT
3970 give an extra option to haskell-suite-pkg (no need to
3971 quote options containing spaces)
3972
3973 --hmake-option OPT
3974 give an extra option to hmake (no need to quote options
3975 containing spaces)
3976
3977 --hpc-option OPT
3978 give an extra option to hpc (no need to quote options
3979 containing spaces)
3980
3981 --hsc2hs-option OPT
3982 give an extra option to hsc2hs (no need to quote options
3983 containing spaces)
3984
3985 --hscolour-option OPT
3986 give an extra option to hscolour (no need to quote
3987 options containing spaces)
3988
3989 --jhc-option OPT
3990 give an extra option to jhc (no need to quote options
3991 containing spaces)
3992
3993 --ld-option OPT
3994 give an extra option to ld (no need to quote options con‐
3995 taining spaces)
3996
3997 --pkg-config-option OPT
3998 give an extra option to pkg-config (no need to quote
3999 options containing spaces)
4000
4001 --runghc-option OPT
4002 give an extra option to runghc (no need to quote options
4003 containing spaces)
4004
4005 --strip-option OPT
4006 give an extra option to strip (no need to quote options
4007 containing spaces)
4008
4009 --tar-option OPT
4010 give an extra option to tar (no need to quote options
4011 containing spaces)
4012
4013 --uhc-option OPT
4014 give an extra option to uhc (no need to quote options
4015 containing spaces)
4016
4017 --alex-options OPTS
4018 give extra options to alex
4019
4020 --ar-options OPTS
4021 give extra options to ar
4022
4023 --c2hs-options OPTS
4024 give extra options to c2hs
4025
4026 --cpphs-options OPTS
4027 give extra options to cpphs
4028
4029 --doctest-options OPTS
4030 give extra options to doctest
4031
4032 --gcc-options OPTS
4033 give extra options to gcc
4034
4035 --ghc-options OPTS
4036 give extra options to ghc
4037
4038 --ghc-pkg-options OPTS
4039 give extra options to ghc-pkg
4040
4041 --ghcjs-options OPTS
4042 give extra options to ghcjs
4043
4044 --ghcjs-pkg-options OPTS
4045 give extra options to ghcjs-pkg
4046
4047 --greencard-options OPTS
4048 give extra options to greencard
4049
4050 --haddock-options OPTS
4051 give extra options to haddock
4052
4053 --happy-options OPTS
4054 give extra options to happy
4055
4056 --haskell-suite-options OPTS
4057 give extra options to haskell-suite
4058
4059 --haskell-suite-pkg-options OPTS
4060 give extra options to haskell-suite-pkg
4061
4062 --hmake-options OPTS
4063 give extra options to hmake
4064
4065 --hpc-options OPTS
4066 give extra options to hpc
4067
4068 --hsc2hs-options OPTS
4069 give extra options to hsc2hs
4070
4071 --hscolour-options OPTS
4072 give extra options to hscolour
4073
4074 --jhc-options OPTS
4075 give extra options to jhc
4076
4077 --ld-options OPTS
4078 give extra options to ld
4079
4080 --pkg-config-options OPTS
4081 give extra options to pkg-config
4082
4083 --runghc-options OPTS
4084 give extra options to runghc
4085
4086 --strip-options OPTS
4087 give extra options to strip
4088
4089 --tar-options OPTS
4090 give extra options to tar
4091
4092 --uhc-options OPTS
4093 give extra options to uhc
4094
4095 --cabal-lib-version VERSION
4096 Select which version of the Cabal lib to use to build
4097 packages (useful for testing).
4098
4099 --constraint CONSTRAINT
4100 Specify constraints on a package (version,
4101 installed/source, flags)
4102
4103 --preference CONSTRAINT
4104 Specify preferences (soft constraints) on the version of
4105 a package
4106
4107 --solver SOLVER
4108 Select dependency solver to use (default: modular).
4109 Choices: modular.
4110
4111 --allow-older [DEPS]
4112 Ignore lower bounds in all dependencies or DEPS
4113
4114 --allow-newer [DEPS]
4115 Ignore upper bounds in all dependencies or DEPS
4116
4117 --write-ghc-environment-files always|never|ghc8.4.4+
4118 Whether to create a .ghc.environment file after a suc‐
4119 cessful build (v2-build only)
4120
4121 --enable-documentation
4122 --disable-documentation
4123 building of documentation
4124
4125 --doc-index-file TEMPLATE
4126 A central index of haddock API documentation (template
4127 cannot use $pkgid)
4128
4129 --dry-run
4130 Do not install anything, only print what would be
4131 installed.
4132
4133 --max-backjumps NUM
4134 Maximum number of backjumps allowed while solving
4135 (default: 2000). Use a negative number to enable unlim‐
4136 ited backtracking. Use 0 to disable backtracking com‐
4137 pletely.
4138
4139 --reorder-goals
4140 --no-reorder-goals
4141 Try to reorder goals according to certain heuristics.
4142 Slows things down on average, but may make backtracking
4143 faster for some packages.
4144
4145 --count-conflicts
4146 --no-count-conflicts
4147 Try to speed up solving by preferring goals that are
4148 involved in a lot of conflicts (default).
4149
4150 --independent-goals
4151 --no-independent-goals
4152 Treat several goals on the command line as independent.
4153 If several goals depend on the same package, different
4154 versions can be chosen.
4155
4156 --shadow-installed-packages
4157 --no-shadow-installed-packages
4158 If multiple package instances of the same version are
4159 installed, treat all but one as shadowed.
4160
4161 --strong-flags
4162 --no-strong-flags
4163 Do not defer flag choices (this used to be the default in
4164 cabal-install <= 1.20).
4165
4166 --allow-boot-library-installs
4167 --no-allow-boot-library-installs
4168 Allow cabal to install base, ghc-prim, integer-simple,
4169 integer-gmp, and template-haskell.
4170
4171 --reinstall
4172 --no-reinstall
4173 Install even if it means installing the same version
4174 again.
4175
4176 --avoid-reinstalls
4177 --no-avoid-reinstalls
4178 Do not select versions that would destructively overwrite
4179 installed packages.
4180
4181 --force-reinstalls
4182 --no-force-reinstalls
4183 Reinstall packages even if they will most likely break
4184 other installed packages.
4185
4186 --upgrade-dependencies
4187 --no-upgrade-dependencies
4188 Pick the latest version for all dependencies, rather than
4189 trying to pick an installed version.
4190
4191 --only-dependencies
4192 --no-only-dependencies
4193 Install only the dependencies necessary to build the
4194 given packages
4195
4196 --dependencies-only
4197 --no-dependencies-only
4198 A synonym for --only-dependencies
4199
4200 --index-state STATE
4201 Use source package index state as it existed at a previ‐
4202 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
4203 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
4204 'HEAD' (default: 'HEAD').
4205
4206 --root-cmd COMMAND
4207 (No longer supported, do not use.)
4208
4209 --symlink-bindir DIR
4210 Add symlinks to installed executables into this direc‐
4211 tory.
4212
4213 --build-summary TEMPLATE
4214 Save build summaries to file (name template can use
4215 $pkgid, $compiler, $os, $arch)
4216
4217 --build-log TEMPLATE
4218 Log all builds to file (name template can use $pkgid,
4219 $compiler, $os, $arch)
4220
4221 --remote-build-reporting LEVEL
4222 Generate build reports to send to a remote server (none,
4223 anonymous or detailed).
4224
4225 --report-planning-failure
4226 Generate build reports when the dependency solver fails.
4227 This is used by the Hackage build bot.
4228
4229 --enable-per-component
4230 --disable-per-component
4231 Per-component builds when possible
4232
4233 --one-shot
4234 --no-one-shot
4235 Do not record the packages in the world file.
4236
4237 --run-tests
4238 Run package test suites during installation.
4239
4240 -j, --jobs [NUM]
4241 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
4242 given).
4243
4244 --keep-going
4245 After a build failure, continue to build other unaffected
4246 packages.
4247
4248 --offline
4249 --no-offline
4250 Don't download packages from the Internet.
4251
4252 --project-file FILE
4253 Set the name of the cabal.project file to search for in
4254 parent directories
4255
4256 --only
4257 Only installs the package in the current directory.
4258
4259 --haddock-hoogle
4260 Generate a hoogle database
4261
4262 --haddock-html
4263 Generate HTML documentation (the default)
4264
4265 --haddock-html-location URL
4266 Location of HTML documentation for pre-requisite packages
4267
4268 --haddock-for-hackage
4269 Collection of flags to generate documentation suitable
4270 for upload to hackage
4271
4272 --haddock-executables
4273 Run haddock for Executables targets
4274
4275 --haddock-tests
4276 Run haddock for Test Suite targets
4277
4278 --haddock-benchmarks
4279 Run haddock for Benchmark targets
4280
4281 --haddock-all
4282 Run haddock for all targets
4283
4284 --haddock-internal
4285 Run haddock for internal modules and include all symbols
4286
4287 --haddock-css PATH
4288 Use PATH as the haddock stylesheet
4289
4290 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
4291 dock-hyperlinked-source
4292 Hyperlink the documentation to the source code
4293
4294 --haddock-quickjump
4295 Generate an index for interactive documentation naviga‐
4296 tion
4297
4298 --haddock-hscolour-css PATH
4299 Use PATH as the HsColour stylesheet
4300
4301 --haddock-contents-location URL
4302 Bake URL in as the location for the contents page
4303
4304 --only-configure
4305 --no-only-configure
4306 Instead of performing a full build just run the configure
4307 step
4308
4309
4310 cabal new-build
4311
4312 Usage: cabal new-build [TARGETS] [FLAGS]
4313
4314
4315 Build one or more targets from within the project. The available tar‐
4316 gets are the packages in the project as well as individual components
4317 within those packages, including libraries, executables, test-suites or
4318 benchmarks. Targets can be specified by name or location. If no target
4319 is specified then the default is to build the package in the current
4320 directory.
4321
4322 Dependencies are built or rebuilt as necessary. Additional configura‐
4323 tion flags can be specified on the command line and these extend the
4324 project configuration from the 'cabal.project', 'cabal.project.local'
4325 and other files.
4326
4327
4328 Examples:
4329 cabal new-build
4330 Build the package in the current directory or all packages in the
4331 project
4332 cabal new-build pkgname
4333 Build the package named pkgname in the project
4334 cabal new-build ./pkgfoo
4335 Build the package in the ./pkgfoo directory
4336 cabal new-build cname
4337 Build the component named cname in the project
4338 cabal new-build cname --enable-profiling
4339 Build the component in profiling mode (including dependencies as
4340 needed)
4341
4342 Note: this command is part of the new project-based system (aka nix-
4343 style local builds). These features are currently in beta. Please see
4344 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
4345 details and advice on what you can expect to work. If you encounter
4346 problems please file issues at https://github.com/haskell/cabal/issues
4347 and if you have any time to get involved and help with testing, fixing
4348 bugs etc then that is very much appreciated.
4349
4350
4351 Flags:
4352 -v, --verbose [n]
4353 Control verbosity (n is 0--3, default verbosity level is
4354 1)
4355
4356 --builddir, --distdir, --distpref DIR
4357 The directory where Cabal puts generated build files
4358 (default dist)
4359
4360 -g, --ghc
4361 compile with GHC
4362
4363 --ghcjs
4364 compile with GHCJS
4365
4366 --uhc
4367 compile with UHC
4368
4369 --haskell-suite
4370 compile with a haskell-suite compiler
4371
4372 --cabal-file PATH
4373 use this Cabal file
4374
4375 -w, --with-compiler PATH
4376 give the path to a particular compiler
4377
4378 --with-hc-pkg PATH
4379 give the path to the package tool
4380
4381 --prefix DIR
4382 bake this prefix in preparation of installation
4383
4384 --bindir DIR
4385 installation directory for executables
4386
4387 --libdir DIR
4388 installation directory for libraries
4389
4390 --libsubdir DIR
4391 subdirectory of libdir in which libs are installed
4392
4393 --dynlibdir DIR
4394 installation directory for dynamic libraries
4395
4396 --libexecdir DIR
4397 installation directory for program executables
4398
4399 --libexecsubdir DIR
4400 subdirectory of libexecdir in which private executables
4401 are installed
4402
4403 --datadir DIR
4404 installation directory for read-only data
4405
4406 --datasubdir DIR
4407 subdirectory of datadir in which data files are installed
4408
4409 --docdir DIR
4410 installation directory for documentation
4411
4412 --htmldir DIR
4413 installation directory for HTML documentation
4414
4415 --haddockdir DIR
4416 installation directory for haddock interfaces
4417
4418 --sysconfdir DIR
4419 installation directory for configuration files
4420
4421 --program-prefix PREFIX
4422 prefix to be applied to installed executables
4423
4424 --program-suffix SUFFIX
4425 suffix to be applied to installed executables
4426
4427 --enable-library-vanilla
4428 --disable-library-vanilla
4429 Vanilla libraries
4430
4431 -p, --enable-library-profiling
4432 --disable-library-profiling
4433 Library profiling
4434
4435 --enable-shared
4436 --disable-shared
4437 Shared library
4438
4439 --enable-static
4440 --disable-static
4441 Static library
4442
4443 --enable-executable-dynamic
4444 --disable-executable-dynamic
4445 Executable dynamic linking
4446
4447 --enable-profiling
4448 --disable-profiling
4449 Executable and library profiling
4450
4451 --enable-executable-profiling
4452 --disable-executable-profiling
4453 Executable profiling (DEPRECATED)
4454
4455 --profiling-detail level
4456 Profiling detail level for executable and library
4457 (default, none, exported-functions, toplevel-functions,
4458 all-functions).
4459
4460 --library-profiling-detail level
4461 Profiling detail level for libraries only.
4462
4463 -O, --enable-optimization, --enable-optimisation [n]
4464 Build with optimization (n is 0--2, default is 1)
4465
4466 --disable-optimization, --disable-optimisation
4467 Build without optimization
4468
4469 --enable-debug-info [n]
4470 Emit debug info (n is 0--3, default is 0)
4471
4472 --disable-debug-info
4473 Don't emit debug info
4474
4475 --enable-library-for-ghci
4476 --disable-library-for-ghci
4477 compile library for use with GHCi
4478
4479 --enable-split-sections
4480 --disable-split-sections
4481 compile library code such that unneeded definitions can
4482 be dropped from the final executable (GHC 7.8+)
4483
4484 --enable-split-objs
4485 --disable-split-objs
4486 split library into smaller objects to reduce binary sizes
4487 (GHC 6.6+)
4488
4489 --enable-executable-stripping
4490 --disable-executable-stripping
4491 strip executables upon installation to reduce binary
4492 sizes
4493
4494 --enable-library-stripping
4495 --disable-library-stripping
4496 strip libraries upon installation to reduce binary sizes
4497
4498 --configure-option OPT
4499 Extra option for configure
4500
4501 --user
4502 --global
4503 doing a per-user installation
4504
4505 --package-db DB
4506 Append the given package database to the list of package
4507 databases used (to satisfy dependencies and register
4508 into). May be a specific file, 'global' or 'user'. The
4509 initial list is ['global'], ['global', 'user'], or
4510 ['global', $sandbox], depending on context. Use 'clear'
4511 to reset the list to empty. See the user guide for
4512 details.
4513
4514 -f, --flags FLAGS
4515 Force values for the given flags in Cabal conditionals in
4516 the .cabal file. E.g., --flags="debug -usebytestrings"
4517 forces the flag "debug" to true and "usebytestrings" to
4518 false.
4519
4520 --extra-include-dirs PATH
4521 A list of directories to search for header files
4522
4523 --enable-deterministic
4524 --disable-deterministic
4525 Try to be as deterministic as possible (used by the test
4526 suite)
4527
4528 --ipid IPID
4529 Installed package ID to compile this package as
4530
4531 --cid CID
4532 Installed component ID to compile this component as
4533
4534 --extra-lib-dirs PATH
4535 A list of directories to search for external libraries
4536
4537 --extra-framework-dirs PATH
4538 A list of directories to search for external frameworks
4539 (OS X only)
4540
4541 --extra-prog-path PATH
4542 A list of directories to search for required programs (in
4543 addition to the normal search locations)
4544
4545 --instantiate-with NAME=MOD
4546 A mapping of signature names to concrete module instanti‐
4547 ations.
4548
4549 --enable-tests
4550 --disable-tests
4551 dependency checking and compilation for test suites
4552 listed in the package description file.
4553
4554 --enable-coverage
4555 --disable-coverage
4556 build package with Haskell Program Coverage. (GHC only)
4557
4558 --enable-library-coverage
4559 --disable-library-coverage
4560 build package with Haskell Program Coverage. (GHC only)
4561 (DEPRECATED)
4562
4563 --enable-benchmarks
4564 --disable-benchmarks
4565 dependency checking and compilation for benchmarks listed
4566 in the package description file.
4567
4568 --enable-relocatable
4569 --disable-relocatable
4570 building a package that is relocatable. (GHC only)
4571
4572 --disable-response-files
4573 enable workaround for old versions of programs like "ar"
4574 that do not support @file arguments
4575
4576 --with-alex PATH
4577 give the path to alex
4578
4579 --with-ar PATH
4580 give the path to ar
4581
4582 --with-c2hs PATH
4583 give the path to c2hs
4584
4585 --with-cpphs PATH
4586 give the path to cpphs
4587
4588 --with-doctest PATH
4589 give the path to doctest
4590
4591 --with-gcc PATH
4592 give the path to gcc
4593
4594 --with-ghc PATH
4595 give the path to ghc
4596
4597 --with-ghc-pkg PATH
4598 give the path to ghc-pkg
4599
4600 --with-ghcjs PATH
4601 give the path to ghcjs
4602
4603 --with-ghcjs-pkg PATH
4604 give the path to ghcjs-pkg
4605
4606 --with-greencard PATH
4607 give the path to greencard
4608
4609 --with-haddock PATH
4610 give the path to haddock
4611
4612 --with-happy PATH
4613 give the path to happy
4614
4615 --with-haskell-suite PATH
4616 give the path to haskell-suite
4617
4618 --with-haskell-suite-pkg PATH
4619 give the path to haskell-suite-pkg
4620
4621 --with-hmake PATH
4622 give the path to hmake
4623
4624 --with-hpc PATH
4625 give the path to hpc
4626
4627 --with-hsc2hs PATH
4628 give the path to hsc2hs
4629
4630 --with-hscolour PATH
4631 give the path to hscolour
4632
4633 --with-jhc PATH
4634 give the path to jhc
4635
4636 --with-ld PATH
4637 give the path to ld
4638
4639 --with-pkg-config PATH
4640 give the path to pkg-config
4641
4642 --with-runghc PATH
4643 give the path to runghc
4644
4645 --with-strip PATH
4646 give the path to strip
4647
4648 --with-tar PATH
4649 give the path to tar
4650
4651 --with-uhc PATH
4652 give the path to uhc
4653
4654 --alex-option OPT
4655 give an extra option to alex (no need to quote options
4656 containing spaces)
4657
4658 --ar-option OPT
4659 give an extra option to ar (no need to quote options con‐
4660 taining spaces)
4661
4662 --c2hs-option OPT
4663 give an extra option to c2hs (no need to quote options
4664 containing spaces)
4665
4666 --cpphs-option OPT
4667 give an extra option to cpphs (no need to quote options
4668 containing spaces)
4669
4670 --doctest-option OPT
4671 give an extra option to doctest (no need to quote options
4672 containing spaces)
4673
4674 --gcc-option OPT
4675 give an extra option to gcc (no need to quote options
4676 containing spaces)
4677
4678 --ghc-option OPT
4679 give an extra option to ghc (no need to quote options
4680 containing spaces)
4681
4682 --ghc-pkg-option OPT
4683 give an extra option to ghc-pkg (no need to quote options
4684 containing spaces)
4685
4686 --ghcjs-option OPT
4687 give an extra option to ghcjs (no need to quote options
4688 containing spaces)
4689
4690 --ghcjs-pkg-option OPT
4691 give an extra option to ghcjs-pkg (no need to quote
4692 options containing spaces)
4693
4694 --greencard-option OPT
4695 give an extra option to greencard (no need to quote
4696 options containing spaces)
4697
4698 --haddock-option OPT
4699 give an extra option to haddock (no need to quote options
4700 containing spaces)
4701
4702 --happy-option OPT
4703 give an extra option to happy (no need to quote options
4704 containing spaces)
4705
4706 --haskell-suite-option OPT
4707 give an extra option to haskell-suite (no need to quote
4708 options containing spaces)
4709
4710 --haskell-suite-pkg-option OPT
4711 give an extra option to haskell-suite-pkg (no need to
4712 quote options containing spaces)
4713
4714 --hmake-option OPT
4715 give an extra option to hmake (no need to quote options
4716 containing spaces)
4717
4718 --hpc-option OPT
4719 give an extra option to hpc (no need to quote options
4720 containing spaces)
4721
4722 --hsc2hs-option OPT
4723 give an extra option to hsc2hs (no need to quote options
4724 containing spaces)
4725
4726 --hscolour-option OPT
4727 give an extra option to hscolour (no need to quote
4728 options containing spaces)
4729
4730 --jhc-option OPT
4731 give an extra option to jhc (no need to quote options
4732 containing spaces)
4733
4734 --ld-option OPT
4735 give an extra option to ld (no need to quote options con‐
4736 taining spaces)
4737
4738 --pkg-config-option OPT
4739 give an extra option to pkg-config (no need to quote
4740 options containing spaces)
4741
4742 --runghc-option OPT
4743 give an extra option to runghc (no need to quote options
4744 containing spaces)
4745
4746 --strip-option OPT
4747 give an extra option to strip (no need to quote options
4748 containing spaces)
4749
4750 --tar-option OPT
4751 give an extra option to tar (no need to quote options
4752 containing spaces)
4753
4754 --uhc-option OPT
4755 give an extra option to uhc (no need to quote options
4756 containing spaces)
4757
4758 --alex-options OPTS
4759 give extra options to alex
4760
4761 --ar-options OPTS
4762 give extra options to ar
4763
4764 --c2hs-options OPTS
4765 give extra options to c2hs
4766
4767 --cpphs-options OPTS
4768 give extra options to cpphs
4769
4770 --doctest-options OPTS
4771 give extra options to doctest
4772
4773 --gcc-options OPTS
4774 give extra options to gcc
4775
4776 --ghc-options OPTS
4777 give extra options to ghc
4778
4779 --ghc-pkg-options OPTS
4780 give extra options to ghc-pkg
4781
4782 --ghcjs-options OPTS
4783 give extra options to ghcjs
4784
4785 --ghcjs-pkg-options OPTS
4786 give extra options to ghcjs-pkg
4787
4788 --greencard-options OPTS
4789 give extra options to greencard
4790
4791 --haddock-options OPTS
4792 give extra options to haddock
4793
4794 --happy-options OPTS
4795 give extra options to happy
4796
4797 --haskell-suite-options OPTS
4798 give extra options to haskell-suite
4799
4800 --haskell-suite-pkg-options OPTS
4801 give extra options to haskell-suite-pkg
4802
4803 --hmake-options OPTS
4804 give extra options to hmake
4805
4806 --hpc-options OPTS
4807 give extra options to hpc
4808
4809 --hsc2hs-options OPTS
4810 give extra options to hsc2hs
4811
4812 --hscolour-options OPTS
4813 give extra options to hscolour
4814
4815 --jhc-options OPTS
4816 give extra options to jhc
4817
4818 --ld-options OPTS
4819 give extra options to ld
4820
4821 --pkg-config-options OPTS
4822 give extra options to pkg-config
4823
4824 --runghc-options OPTS
4825 give extra options to runghc
4826
4827 --strip-options OPTS
4828 give extra options to strip
4829
4830 --tar-options OPTS
4831 give extra options to tar
4832
4833 --uhc-options OPTS
4834 give extra options to uhc
4835
4836 --cabal-lib-version VERSION
4837 Select which version of the Cabal lib to use to build
4838 packages (useful for testing).
4839
4840 --constraint CONSTRAINT
4841 Specify constraints on a package (version,
4842 installed/source, flags)
4843
4844 --preference CONSTRAINT
4845 Specify preferences (soft constraints) on the version of
4846 a package
4847
4848 --solver SOLVER
4849 Select dependency solver to use (default: modular).
4850 Choices: modular.
4851
4852 --allow-older [DEPS]
4853 Ignore lower bounds in all dependencies or DEPS
4854
4855 --allow-newer [DEPS]
4856 Ignore upper bounds in all dependencies or DEPS
4857
4858 --write-ghc-environment-files always|never|ghc8.4.4+
4859 Whether to create a .ghc.environment file after a suc‐
4860 cessful build (v2-build only)
4861
4862 --enable-documentation
4863 --disable-documentation
4864 building of documentation
4865
4866 --doc-index-file TEMPLATE
4867 A central index of haddock API documentation (template
4868 cannot use $pkgid)
4869
4870 --dry-run
4871 Do not install anything, only print what would be
4872 installed.
4873
4874 --max-backjumps NUM
4875 Maximum number of backjumps allowed while solving
4876 (default: 2000). Use a negative number to enable unlim‐
4877 ited backtracking. Use 0 to disable backtracking com‐
4878 pletely.
4879
4880 --reorder-goals
4881 --no-reorder-goals
4882 Try to reorder goals according to certain heuristics.
4883 Slows things down on average, but may make backtracking
4884 faster for some packages.
4885
4886 --count-conflicts
4887 --no-count-conflicts
4888 Try to speed up solving by preferring goals that are
4889 involved in a lot of conflicts (default).
4890
4891 --independent-goals
4892 --no-independent-goals
4893 Treat several goals on the command line as independent.
4894 If several goals depend on the same package, different
4895 versions can be chosen.
4896
4897 --shadow-installed-packages
4898 --no-shadow-installed-packages
4899 If multiple package instances of the same version are
4900 installed, treat all but one as shadowed.
4901
4902 --strong-flags
4903 --no-strong-flags
4904 Do not defer flag choices (this used to be the default in
4905 cabal-install <= 1.20).
4906
4907 --allow-boot-library-installs
4908 --no-allow-boot-library-installs
4909 Allow cabal to install base, ghc-prim, integer-simple,
4910 integer-gmp, and template-haskell.
4911
4912 --reinstall
4913 --no-reinstall
4914 Install even if it means installing the same version
4915 again.
4916
4917 --avoid-reinstalls
4918 --no-avoid-reinstalls
4919 Do not select versions that would destructively overwrite
4920 installed packages.
4921
4922 --force-reinstalls
4923 --no-force-reinstalls
4924 Reinstall packages even if they will most likely break
4925 other installed packages.
4926
4927 --upgrade-dependencies
4928 --no-upgrade-dependencies
4929 Pick the latest version for all dependencies, rather than
4930 trying to pick an installed version.
4931
4932 --only-dependencies
4933 --no-only-dependencies
4934 Install only the dependencies necessary to build the
4935 given packages
4936
4937 --dependencies-only
4938 --no-dependencies-only
4939 A synonym for --only-dependencies
4940
4941 --index-state STATE
4942 Use source package index state as it existed at a previ‐
4943 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
4944 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
4945 'HEAD' (default: 'HEAD').
4946
4947 --root-cmd COMMAND
4948 (No longer supported, do not use.)
4949
4950 --symlink-bindir DIR
4951 Add symlinks to installed executables into this direc‐
4952 tory.
4953
4954 --build-summary TEMPLATE
4955 Save build summaries to file (name template can use
4956 $pkgid, $compiler, $os, $arch)
4957
4958 --build-log TEMPLATE
4959 Log all builds to file (name template can use $pkgid,
4960 $compiler, $os, $arch)
4961
4962 --remote-build-reporting LEVEL
4963 Generate build reports to send to a remote server (none,
4964 anonymous or detailed).
4965
4966 --report-planning-failure
4967 Generate build reports when the dependency solver fails.
4968 This is used by the Hackage build bot.
4969
4970 --enable-per-component
4971 --disable-per-component
4972 Per-component builds when possible
4973
4974 --one-shot
4975 --no-one-shot
4976 Do not record the packages in the world file.
4977
4978 --run-tests
4979 Run package test suites during installation.
4980
4981 -j, --jobs [NUM]
4982 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
4983 given).
4984
4985 --keep-going
4986 After a build failure, continue to build other unaffected
4987 packages.
4988
4989 --offline
4990 --no-offline
4991 Don't download packages from the Internet.
4992
4993 --project-file FILE
4994 Set the name of the cabal.project file to search for in
4995 parent directories
4996
4997 --only
4998 Only installs the package in the current directory.
4999
5000 --haddock-hoogle
5001 Generate a hoogle database
5002
5003 --haddock-html
5004 Generate HTML documentation (the default)
5005
5006 --haddock-html-location URL
5007 Location of HTML documentation for pre-requisite packages
5008
5009 --haddock-for-hackage
5010 Collection of flags to generate documentation suitable
5011 for upload to hackage
5012
5013 --haddock-executables
5014 Run haddock for Executables targets
5015
5016 --haddock-tests
5017 Run haddock for Test Suite targets
5018
5019 --haddock-benchmarks
5020 Run haddock for Benchmark targets
5021
5022 --haddock-all
5023 Run haddock for all targets
5024
5025 --haddock-internal
5026 Run haddock for internal modules and include all symbols
5027
5028 --haddock-css PATH
5029 Use PATH as the haddock stylesheet
5030
5031 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
5032 dock-hyperlinked-source
5033 Hyperlink the documentation to the source code
5034
5035 --haddock-quickjump
5036 Generate an index for interactive documentation naviga‐
5037 tion
5038
5039 --haddock-hscolour-css PATH
5040 Use PATH as the HsColour stylesheet
5041
5042 --haddock-contents-location URL
5043 Bake URL in as the location for the contents page
5044
5045 --only-configure
5046 --no-only-configure
5047 Instead of performing a full build just run the configure
5048 step
5049
5050
5051 cabal v2-repl
5052
5053 Usage: cabal v2-repl [TARGET] [FLAGS]
5054
5055
5056 Open an interactive session for a component within the project. The
5057 available targets are the same as for the 'v2-build' command: individ‐
5058 ual components within packages in the project, including libraries,
5059 executables, test-suites or benchmarks. Packages can also be specified
5060 in which case the library component in the package will be used, or the
5061 (first listed) executable in the package if there is no library.
5062
5063 Dependencies are built or rebuilt as necessary. Additional configura‐
5064 tion flags can be specified on the command line and these extend the
5065 project configuration from the 'cabal.project', 'cabal.project.local'
5066 and other files.
5067
5068
5069 Open an interactive session for a component within the project. The
5070 available targets are the same as for the 'v2-build' command: individ‐
5071 ual components within packages in the project, including libraries,
5072 executables, test-suites or benchmarks. Packages can also be specified
5073 in which case the library component in the package will be used, or the
5074 (first listed) executable in the package if there is no library.
5075
5076 Dependencies are built or rebuilt as necessary. Additional configura‐
5077 tion flags can be specified on the command line and these extend the
5078 project configuration from the 'cabal.project', 'cabal.project.local'
5079 and other files.
5080
5081
5082 Flags:
5083 -v, --verbose [n]
5084 Control verbosity (n is 0--3, default verbosity level is
5085 1)
5086
5087 --builddir, --distdir, --distpref DIR
5088 The directory where Cabal puts generated build files
5089 (default dist)
5090
5091 -g, --ghc
5092 compile with GHC
5093
5094 --ghcjs
5095 compile with GHCJS
5096
5097 --uhc
5098 compile with UHC
5099
5100 --haskell-suite
5101 compile with a haskell-suite compiler
5102
5103 --cabal-file PATH
5104 use this Cabal file
5105
5106 -w, --with-compiler PATH
5107 give the path to a particular compiler
5108
5109 --with-hc-pkg PATH
5110 give the path to the package tool
5111
5112 --prefix DIR
5113 bake this prefix in preparation of installation
5114
5115 --bindir DIR
5116 installation directory for executables
5117
5118 --libdir DIR
5119 installation directory for libraries
5120
5121 --libsubdir DIR
5122 subdirectory of libdir in which libs are installed
5123
5124 --dynlibdir DIR
5125 installation directory for dynamic libraries
5126
5127 --libexecdir DIR
5128 installation directory for program executables
5129
5130 --libexecsubdir DIR
5131 subdirectory of libexecdir in which private executables
5132 are installed
5133
5134 --datadir DIR
5135 installation directory for read-only data
5136
5137 --datasubdir DIR
5138 subdirectory of datadir in which data files are installed
5139
5140 --docdir DIR
5141 installation directory for documentation
5142
5143 --htmldir DIR
5144 installation directory for HTML documentation
5145
5146 --haddockdir DIR
5147 installation directory for haddock interfaces
5148
5149 --sysconfdir DIR
5150 installation directory for configuration files
5151
5152 --program-prefix PREFIX
5153 prefix to be applied to installed executables
5154
5155 --program-suffix SUFFIX
5156 suffix to be applied to installed executables
5157
5158 --enable-library-vanilla
5159 --disable-library-vanilla
5160 Vanilla libraries
5161
5162 -p, --enable-library-profiling
5163 --disable-library-profiling
5164 Library profiling
5165
5166 --enable-shared
5167 --disable-shared
5168 Shared library
5169
5170 --enable-static
5171 --disable-static
5172 Static library
5173
5174 --enable-executable-dynamic
5175 --disable-executable-dynamic
5176 Executable dynamic linking
5177
5178 --enable-profiling
5179 --disable-profiling
5180 Executable and library profiling
5181
5182 --enable-executable-profiling
5183 --disable-executable-profiling
5184 Executable profiling (DEPRECATED)
5185
5186 --profiling-detail level
5187 Profiling detail level for executable and library
5188 (default, none, exported-functions, toplevel-functions,
5189 all-functions).
5190
5191 --library-profiling-detail level
5192 Profiling detail level for libraries only.
5193
5194 -O, --enable-optimization, --enable-optimisation [n]
5195 Build with optimization (n is 0--2, default is 1)
5196
5197 --disable-optimization, --disable-optimisation
5198 Build without optimization
5199
5200 --enable-debug-info [n]
5201 Emit debug info (n is 0--3, default is 0)
5202
5203 --disable-debug-info
5204 Don't emit debug info
5205
5206 --enable-library-for-ghci
5207 --disable-library-for-ghci
5208 compile library for use with GHCi
5209
5210 --enable-split-sections
5211 --disable-split-sections
5212 compile library code such that unneeded definitions can
5213 be dropped from the final executable (GHC 7.8+)
5214
5215 --enable-split-objs
5216 --disable-split-objs
5217 split library into smaller objects to reduce binary sizes
5218 (GHC 6.6+)
5219
5220 --enable-executable-stripping
5221 --disable-executable-stripping
5222 strip executables upon installation to reduce binary
5223 sizes
5224
5225 --enable-library-stripping
5226 --disable-library-stripping
5227 strip libraries upon installation to reduce binary sizes
5228
5229 --configure-option OPT
5230 Extra option for configure
5231
5232 --user
5233 --global
5234 doing a per-user installation
5235
5236 --package-db DB
5237 Append the given package database to the list of package
5238 databases used (to satisfy dependencies and register
5239 into). May be a specific file, 'global' or 'user'. The
5240 initial list is ['global'], ['global', 'user'], or
5241 ['global', $sandbox], depending on context. Use 'clear'
5242 to reset the list to empty. See the user guide for
5243 details.
5244
5245 -f, --flags FLAGS
5246 Force values for the given flags in Cabal conditionals in
5247 the .cabal file. E.g., --flags="debug -usebytestrings"
5248 forces the flag "debug" to true and "usebytestrings" to
5249 false.
5250
5251 --extra-include-dirs PATH
5252 A list of directories to search for header files
5253
5254 --enable-deterministic
5255 --disable-deterministic
5256 Try to be as deterministic as possible (used by the test
5257 suite)
5258
5259 --ipid IPID
5260 Installed package ID to compile this package as
5261
5262 --cid CID
5263 Installed component ID to compile this component as
5264
5265 --extra-lib-dirs PATH
5266 A list of directories to search for external libraries
5267
5268 --extra-framework-dirs PATH
5269 A list of directories to search for external frameworks
5270 (OS X only)
5271
5272 --extra-prog-path PATH
5273 A list of directories to search for required programs (in
5274 addition to the normal search locations)
5275
5276 --instantiate-with NAME=MOD
5277 A mapping of signature names to concrete module instanti‐
5278 ations.
5279
5280 --enable-tests
5281 --disable-tests
5282 dependency checking and compilation for test suites
5283 listed in the package description file.
5284
5285 --enable-coverage
5286 --disable-coverage
5287 build package with Haskell Program Coverage. (GHC only)
5288
5289 --enable-library-coverage
5290 --disable-library-coverage
5291 build package with Haskell Program Coverage. (GHC only)
5292 (DEPRECATED)
5293
5294 --enable-benchmarks
5295 --disable-benchmarks
5296 dependency checking and compilation for benchmarks listed
5297 in the package description file.
5298
5299 --enable-relocatable
5300 --disable-relocatable
5301 building a package that is relocatable. (GHC only)
5302
5303 --disable-response-files
5304 enable workaround for old versions of programs like "ar"
5305 that do not support @file arguments
5306
5307 --with-alex PATH
5308 give the path to alex
5309
5310 --with-ar PATH
5311 give the path to ar
5312
5313 --with-c2hs PATH
5314 give the path to c2hs
5315
5316 --with-cpphs PATH
5317 give the path to cpphs
5318
5319 --with-doctest PATH
5320 give the path to doctest
5321
5322 --with-gcc PATH
5323 give the path to gcc
5324
5325 --with-ghc PATH
5326 give the path to ghc
5327
5328 --with-ghc-pkg PATH
5329 give the path to ghc-pkg
5330
5331 --with-ghcjs PATH
5332 give the path to ghcjs
5333
5334 --with-ghcjs-pkg PATH
5335 give the path to ghcjs-pkg
5336
5337 --with-greencard PATH
5338 give the path to greencard
5339
5340 --with-haddock PATH
5341 give the path to haddock
5342
5343 --with-happy PATH
5344 give the path to happy
5345
5346 --with-haskell-suite PATH
5347 give the path to haskell-suite
5348
5349 --with-haskell-suite-pkg PATH
5350 give the path to haskell-suite-pkg
5351
5352 --with-hmake PATH
5353 give the path to hmake
5354
5355 --with-hpc PATH
5356 give the path to hpc
5357
5358 --with-hsc2hs PATH
5359 give the path to hsc2hs
5360
5361 --with-hscolour PATH
5362 give the path to hscolour
5363
5364 --with-jhc PATH
5365 give the path to jhc
5366
5367 --with-ld PATH
5368 give the path to ld
5369
5370 --with-pkg-config PATH
5371 give the path to pkg-config
5372
5373 --with-runghc PATH
5374 give the path to runghc
5375
5376 --with-strip PATH
5377 give the path to strip
5378
5379 --with-tar PATH
5380 give the path to tar
5381
5382 --with-uhc PATH
5383 give the path to uhc
5384
5385 --alex-option OPT
5386 give an extra option to alex (no need to quote options
5387 containing spaces)
5388
5389 --ar-option OPT
5390 give an extra option to ar (no need to quote options con‐
5391 taining spaces)
5392
5393 --c2hs-option OPT
5394 give an extra option to c2hs (no need to quote options
5395 containing spaces)
5396
5397 --cpphs-option OPT
5398 give an extra option to cpphs (no need to quote options
5399 containing spaces)
5400
5401 --doctest-option OPT
5402 give an extra option to doctest (no need to quote options
5403 containing spaces)
5404
5405 --gcc-option OPT
5406 give an extra option to gcc (no need to quote options
5407 containing spaces)
5408
5409 --ghc-option OPT
5410 give an extra option to ghc (no need to quote options
5411 containing spaces)
5412
5413 --ghc-pkg-option OPT
5414 give an extra option to ghc-pkg (no need to quote options
5415 containing spaces)
5416
5417 --ghcjs-option OPT
5418 give an extra option to ghcjs (no need to quote options
5419 containing spaces)
5420
5421 --ghcjs-pkg-option OPT
5422 give an extra option to ghcjs-pkg (no need to quote
5423 options containing spaces)
5424
5425 --greencard-option OPT
5426 give an extra option to greencard (no need to quote
5427 options containing spaces)
5428
5429 --haddock-option OPT
5430 give an extra option to haddock (no need to quote options
5431 containing spaces)
5432
5433 --happy-option OPT
5434 give an extra option to happy (no need to quote options
5435 containing spaces)
5436
5437 --haskell-suite-option OPT
5438 give an extra option to haskell-suite (no need to quote
5439 options containing spaces)
5440
5441 --haskell-suite-pkg-option OPT
5442 give an extra option to haskell-suite-pkg (no need to
5443 quote options containing spaces)
5444
5445 --hmake-option OPT
5446 give an extra option to hmake (no need to quote options
5447 containing spaces)
5448
5449 --hpc-option OPT
5450 give an extra option to hpc (no need to quote options
5451 containing spaces)
5452
5453 --hsc2hs-option OPT
5454 give an extra option to hsc2hs (no need to quote options
5455 containing spaces)
5456
5457 --hscolour-option OPT
5458 give an extra option to hscolour (no need to quote
5459 options containing spaces)
5460
5461 --jhc-option OPT
5462 give an extra option to jhc (no need to quote options
5463 containing spaces)
5464
5465 --ld-option OPT
5466 give an extra option to ld (no need to quote options con‐
5467 taining spaces)
5468
5469 --pkg-config-option OPT
5470 give an extra option to pkg-config (no need to quote
5471 options containing spaces)
5472
5473 --runghc-option OPT
5474 give an extra option to runghc (no need to quote options
5475 containing spaces)
5476
5477 --strip-option OPT
5478 give an extra option to strip (no need to quote options
5479 containing spaces)
5480
5481 --tar-option OPT
5482 give an extra option to tar (no need to quote options
5483 containing spaces)
5484
5485 --uhc-option OPT
5486 give an extra option to uhc (no need to quote options
5487 containing spaces)
5488
5489 --alex-options OPTS
5490 give extra options to alex
5491
5492 --ar-options OPTS
5493 give extra options to ar
5494
5495 --c2hs-options OPTS
5496 give extra options to c2hs
5497
5498 --cpphs-options OPTS
5499 give extra options to cpphs
5500
5501 --doctest-options OPTS
5502 give extra options to doctest
5503
5504 --gcc-options OPTS
5505 give extra options to gcc
5506
5507 --ghc-options OPTS
5508 give extra options to ghc
5509
5510 --ghc-pkg-options OPTS
5511 give extra options to ghc-pkg
5512
5513 --ghcjs-options OPTS
5514 give extra options to ghcjs
5515
5516 --ghcjs-pkg-options OPTS
5517 give extra options to ghcjs-pkg
5518
5519 --greencard-options OPTS
5520 give extra options to greencard
5521
5522 --haddock-options OPTS
5523 give extra options to haddock
5524
5525 --happy-options OPTS
5526 give extra options to happy
5527
5528 --haskell-suite-options OPTS
5529 give extra options to haskell-suite
5530
5531 --haskell-suite-pkg-options OPTS
5532 give extra options to haskell-suite-pkg
5533
5534 --hmake-options OPTS
5535 give extra options to hmake
5536
5537 --hpc-options OPTS
5538 give extra options to hpc
5539
5540 --hsc2hs-options OPTS
5541 give extra options to hsc2hs
5542
5543 --hscolour-options OPTS
5544 give extra options to hscolour
5545
5546 --jhc-options OPTS
5547 give extra options to jhc
5548
5549 --ld-options OPTS
5550 give extra options to ld
5551
5552 --pkg-config-options OPTS
5553 give extra options to pkg-config
5554
5555 --runghc-options OPTS
5556 give extra options to runghc
5557
5558 --strip-options OPTS
5559 give extra options to strip
5560
5561 --tar-options OPTS
5562 give extra options to tar
5563
5564 --uhc-options OPTS
5565 give extra options to uhc
5566
5567 --cabal-lib-version VERSION
5568 Select which version of the Cabal lib to use to build
5569 packages (useful for testing).
5570
5571 --constraint CONSTRAINT
5572 Specify constraints on a package (version,
5573 installed/source, flags)
5574
5575 --preference CONSTRAINT
5576 Specify preferences (soft constraints) on the version of
5577 a package
5578
5579 --solver SOLVER
5580 Select dependency solver to use (default: modular).
5581 Choices: modular.
5582
5583 --allow-older [DEPS]
5584 Ignore lower bounds in all dependencies or DEPS
5585
5586 --allow-newer [DEPS]
5587 Ignore upper bounds in all dependencies or DEPS
5588
5589 --write-ghc-environment-files always|never|ghc8.4.4+
5590 Whether to create a .ghc.environment file after a suc‐
5591 cessful build (v2-build only)
5592
5593 --enable-documentation
5594 --disable-documentation
5595 building of documentation
5596
5597 --doc-index-file TEMPLATE
5598 A central index of haddock API documentation (template
5599 cannot use $pkgid)
5600
5601 --dry-run
5602 Do not install anything, only print what would be
5603 installed.
5604
5605 --max-backjumps NUM
5606 Maximum number of backjumps allowed while solving
5607 (default: 2000). Use a negative number to enable unlim‐
5608 ited backtracking. Use 0 to disable backtracking com‐
5609 pletely.
5610
5611 --reorder-goals
5612 --no-reorder-goals
5613 Try to reorder goals according to certain heuristics.
5614 Slows things down on average, but may make backtracking
5615 faster for some packages.
5616
5617 --count-conflicts
5618 --no-count-conflicts
5619 Try to speed up solving by preferring goals that are
5620 involved in a lot of conflicts (default).
5621
5622 --independent-goals
5623 --no-independent-goals
5624 Treat several goals on the command line as independent.
5625 If several goals depend on the same package, different
5626 versions can be chosen.
5627
5628 --shadow-installed-packages
5629 --no-shadow-installed-packages
5630 If multiple package instances of the same version are
5631 installed, treat all but one as shadowed.
5632
5633 --strong-flags
5634 --no-strong-flags
5635 Do not defer flag choices (this used to be the default in
5636 cabal-install <= 1.20).
5637
5638 --allow-boot-library-installs
5639 --no-allow-boot-library-installs
5640 Allow cabal to install base, ghc-prim, integer-simple,
5641 integer-gmp, and template-haskell.
5642
5643 --reinstall
5644 --no-reinstall
5645 Install even if it means installing the same version
5646 again.
5647
5648 --avoid-reinstalls
5649 --no-avoid-reinstalls
5650 Do not select versions that would destructively overwrite
5651 installed packages.
5652
5653 --force-reinstalls
5654 --no-force-reinstalls
5655 Reinstall packages even if they will most likely break
5656 other installed packages.
5657
5658 --upgrade-dependencies
5659 --no-upgrade-dependencies
5660 Pick the latest version for all dependencies, rather than
5661 trying to pick an installed version.
5662
5663 --only-dependencies
5664 --no-only-dependencies
5665 Install only the dependencies necessary to build the
5666 given packages
5667
5668 --dependencies-only
5669 --no-dependencies-only
5670 A synonym for --only-dependencies
5671
5672 --index-state STATE
5673 Use source package index state as it existed at a previ‐
5674 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
5675 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
5676 'HEAD' (default: 'HEAD').
5677
5678 --root-cmd COMMAND
5679 (No longer supported, do not use.)
5680
5681 --symlink-bindir DIR
5682 Add symlinks to installed executables into this direc‐
5683 tory.
5684
5685 --build-summary TEMPLATE
5686 Save build summaries to file (name template can use
5687 $pkgid, $compiler, $os, $arch)
5688
5689 --build-log TEMPLATE
5690 Log all builds to file (name template can use $pkgid,
5691 $compiler, $os, $arch)
5692
5693 --remote-build-reporting LEVEL
5694 Generate build reports to send to a remote server (none,
5695 anonymous or detailed).
5696
5697 --report-planning-failure
5698 Generate build reports when the dependency solver fails.
5699 This is used by the Hackage build bot.
5700
5701 --enable-per-component
5702 --disable-per-component
5703 Per-component builds when possible
5704
5705 --one-shot
5706 --no-one-shot
5707 Do not record the packages in the world file.
5708
5709 --run-tests
5710 Run package test suites during installation.
5711
5712 -j, --jobs [NUM]
5713 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
5714 given).
5715
5716 --keep-going
5717 After a build failure, continue to build other unaffected
5718 packages.
5719
5720 --offline
5721 --no-offline
5722 Don't download packages from the Internet.
5723
5724 --project-file FILE
5725 Set the name of the cabal.project file to search for in
5726 parent directories
5727
5728 --only
5729 Only installs the package in the current directory.
5730
5731 --haddock-hoogle
5732 Generate a hoogle database
5733
5734 --haddock-html
5735 Generate HTML documentation (the default)
5736
5737 --haddock-html-location URL
5738 Location of HTML documentation for pre-requisite packages
5739
5740 --haddock-for-hackage
5741 Collection of flags to generate documentation suitable
5742 for upload to hackage
5743
5744 --haddock-executables
5745 Run haddock for Executables targets
5746
5747 --haddock-tests
5748 Run haddock for Test Suite targets
5749
5750 --haddock-benchmarks
5751 Run haddock for Benchmark targets
5752
5753 --haddock-all
5754 Run haddock for all targets
5755
5756 --haddock-internal
5757 Run haddock for internal modules and include all symbols
5758
5759 --haddock-css PATH
5760 Use PATH as the haddock stylesheet
5761
5762 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
5763 dock-hyperlinked-source
5764 Hyperlink the documentation to the source code
5765
5766 --haddock-quickjump
5767 Generate an index for interactive documentation naviga‐
5768 tion
5769
5770 --haddock-hscolour-css PATH
5771 Use PATH as the HsColour stylesheet
5772
5773 --haddock-contents-location URL
5774 Bake URL in as the location for the contents page
5775
5776 --repl-options FLAG
5777 use this option for the repl
5778
5779 -b, --build-depends DEPENDENCY
5780 Include an additional package in the environment pre‐
5781 sented to GHCi.
5782
5783 --no-transitive-deps
5784 Don't automatically include transitive dependencies of
5785 requested packages.
5786
5787 -z, --ignore-project
5788 Only include explicitly specified packages (and 'base').
5789
5790
5791 cabal new-repl
5792
5793 Usage: cabal new-repl [TARGET] [FLAGS]
5794
5795
5796 Open an interactive session for a component within the project. The
5797 available targets are the same as for the 'new-build' command: individ‐
5798 ual components within packages in the project, including libraries,
5799 executables, test-suites or benchmarks. Packages can also be specified
5800 in which case the library component in the package will be used, or the
5801 (first listed) executable in the package if there is no library.
5802
5803 Dependencies are built or rebuilt as necessary. Additional configura‐
5804 tion flags can be specified on the command line and these extend the
5805 project configuration from the 'cabal.project', 'cabal.project.local'
5806 and other files.
5807
5808
5809 Examples, open an interactive session:
5810 cabal new-repl
5811 for the default component in the package in the current directory
5812 cabal new-repl pkgname
5813 for the default component in the package named 'pkgname'
5814 cabal new-repl ./pkgfoo
5815 for the default component in the package in the ./pkgfoo directory
5816 cabal new-repl cname
5817 for the component named 'cname'
5818 cabal new-repl pkgname:cname
5819 for the component 'cname' in the package 'pkgname'
5820
5821 cabal new-repl --build-depends lens
5822 add the latest version of the library 'lens' to the default compo‐
5823 nent (or no componentif there is no project present)
5824 cabal new-repl --build-depends "lens >= 4.15 && < 4.18"
5825 add a version (constrained between 4.15 and 4.18) of the library
5826 'lens' to the default component (or no component if there is no project
5827 present) Note: this command is part of the new project-based system
5828 (aka nix-style local builds). These features are currently in beta.
5829 Please see http://cabal.readthedocs.io/en/latest/nix-local-build-over‐
5830 view.html for details and advice on what you can expect to work. If you
5831 encounter problems please file issues at
5832 https://github.com/haskell/cabal/issues and if you have any time to get
5833 involved and help with testing, fixing bugs etc then that is very much
5834 appreciated.
5835
5836
5837 Flags:
5838 -v, --verbose [n]
5839 Control verbosity (n is 0--3, default verbosity level is
5840 1)
5841
5842 --builddir, --distdir, --distpref DIR
5843 The directory where Cabal puts generated build files
5844 (default dist)
5845
5846 -g, --ghc
5847 compile with GHC
5848
5849 --ghcjs
5850 compile with GHCJS
5851
5852 --uhc
5853 compile with UHC
5854
5855 --haskell-suite
5856 compile with a haskell-suite compiler
5857
5858 --cabal-file PATH
5859 use this Cabal file
5860
5861 -w, --with-compiler PATH
5862 give the path to a particular compiler
5863
5864 --with-hc-pkg PATH
5865 give the path to the package tool
5866
5867 --prefix DIR
5868 bake this prefix in preparation of installation
5869
5870 --bindir DIR
5871 installation directory for executables
5872
5873 --libdir DIR
5874 installation directory for libraries
5875
5876 --libsubdir DIR
5877 subdirectory of libdir in which libs are installed
5878
5879 --dynlibdir DIR
5880 installation directory for dynamic libraries
5881
5882 --libexecdir DIR
5883 installation directory for program executables
5884
5885 --libexecsubdir DIR
5886 subdirectory of libexecdir in which private executables
5887 are installed
5888
5889 --datadir DIR
5890 installation directory for read-only data
5891
5892 --datasubdir DIR
5893 subdirectory of datadir in which data files are installed
5894
5895 --docdir DIR
5896 installation directory for documentation
5897
5898 --htmldir DIR
5899 installation directory for HTML documentation
5900
5901 --haddockdir DIR
5902 installation directory for haddock interfaces
5903
5904 --sysconfdir DIR
5905 installation directory for configuration files
5906
5907 --program-prefix PREFIX
5908 prefix to be applied to installed executables
5909
5910 --program-suffix SUFFIX
5911 suffix to be applied to installed executables
5912
5913 --enable-library-vanilla
5914 --disable-library-vanilla
5915 Vanilla libraries
5916
5917 -p, --enable-library-profiling
5918 --disable-library-profiling
5919 Library profiling
5920
5921 --enable-shared
5922 --disable-shared
5923 Shared library
5924
5925 --enable-static
5926 --disable-static
5927 Static library
5928
5929 --enable-executable-dynamic
5930 --disable-executable-dynamic
5931 Executable dynamic linking
5932
5933 --enable-profiling
5934 --disable-profiling
5935 Executable and library profiling
5936
5937 --enable-executable-profiling
5938 --disable-executable-profiling
5939 Executable profiling (DEPRECATED)
5940
5941 --profiling-detail level
5942 Profiling detail level for executable and library
5943 (default, none, exported-functions, toplevel-functions,
5944 all-functions).
5945
5946 --library-profiling-detail level
5947 Profiling detail level for libraries only.
5948
5949 -O, --enable-optimization, --enable-optimisation [n]
5950 Build with optimization (n is 0--2, default is 1)
5951
5952 --disable-optimization, --disable-optimisation
5953 Build without optimization
5954
5955 --enable-debug-info [n]
5956 Emit debug info (n is 0--3, default is 0)
5957
5958 --disable-debug-info
5959 Don't emit debug info
5960
5961 --enable-library-for-ghci
5962 --disable-library-for-ghci
5963 compile library for use with GHCi
5964
5965 --enable-split-sections
5966 --disable-split-sections
5967 compile library code such that unneeded definitions can
5968 be dropped from the final executable (GHC 7.8+)
5969
5970 --enable-split-objs
5971 --disable-split-objs
5972 split library into smaller objects to reduce binary sizes
5973 (GHC 6.6+)
5974
5975 --enable-executable-stripping
5976 --disable-executable-stripping
5977 strip executables upon installation to reduce binary
5978 sizes
5979
5980 --enable-library-stripping
5981 --disable-library-stripping
5982 strip libraries upon installation to reduce binary sizes
5983
5984 --configure-option OPT
5985 Extra option for configure
5986
5987 --user
5988 --global
5989 doing a per-user installation
5990
5991 --package-db DB
5992 Append the given package database to the list of package
5993 databases used (to satisfy dependencies and register
5994 into). May be a specific file, 'global' or 'user'. The
5995 initial list is ['global'], ['global', 'user'], or
5996 ['global', $sandbox], depending on context. Use 'clear'
5997 to reset the list to empty. See the user guide for
5998 details.
5999
6000 -f, --flags FLAGS
6001 Force values for the given flags in Cabal conditionals in
6002 the .cabal file. E.g., --flags="debug -usebytestrings"
6003 forces the flag "debug" to true and "usebytestrings" to
6004 false.
6005
6006 --extra-include-dirs PATH
6007 A list of directories to search for header files
6008
6009 --enable-deterministic
6010 --disable-deterministic
6011 Try to be as deterministic as possible (used by the test
6012 suite)
6013
6014 --ipid IPID
6015 Installed package ID to compile this package as
6016
6017 --cid CID
6018 Installed component ID to compile this component as
6019
6020 --extra-lib-dirs PATH
6021 A list of directories to search for external libraries
6022
6023 --extra-framework-dirs PATH
6024 A list of directories to search for external frameworks
6025 (OS X only)
6026
6027 --extra-prog-path PATH
6028 A list of directories to search for required programs (in
6029 addition to the normal search locations)
6030
6031 --instantiate-with NAME=MOD
6032 A mapping of signature names to concrete module instanti‐
6033 ations.
6034
6035 --enable-tests
6036 --disable-tests
6037 dependency checking and compilation for test suites
6038 listed in the package description file.
6039
6040 --enable-coverage
6041 --disable-coverage
6042 build package with Haskell Program Coverage. (GHC only)
6043
6044 --enable-library-coverage
6045 --disable-library-coverage
6046 build package with Haskell Program Coverage. (GHC only)
6047 (DEPRECATED)
6048
6049 --enable-benchmarks
6050 --disable-benchmarks
6051 dependency checking and compilation for benchmarks listed
6052 in the package description file.
6053
6054 --enable-relocatable
6055 --disable-relocatable
6056 building a package that is relocatable. (GHC only)
6057
6058 --disable-response-files
6059 enable workaround for old versions of programs like "ar"
6060 that do not support @file arguments
6061
6062 --with-alex PATH
6063 give the path to alex
6064
6065 --with-ar PATH
6066 give the path to ar
6067
6068 --with-c2hs PATH
6069 give the path to c2hs
6070
6071 --with-cpphs PATH
6072 give the path to cpphs
6073
6074 --with-doctest PATH
6075 give the path to doctest
6076
6077 --with-gcc PATH
6078 give the path to gcc
6079
6080 --with-ghc PATH
6081 give the path to ghc
6082
6083 --with-ghc-pkg PATH
6084 give the path to ghc-pkg
6085
6086 --with-ghcjs PATH
6087 give the path to ghcjs
6088
6089 --with-ghcjs-pkg PATH
6090 give the path to ghcjs-pkg
6091
6092 --with-greencard PATH
6093 give the path to greencard
6094
6095 --with-haddock PATH
6096 give the path to haddock
6097
6098 --with-happy PATH
6099 give the path to happy
6100
6101 --with-haskell-suite PATH
6102 give the path to haskell-suite
6103
6104 --with-haskell-suite-pkg PATH
6105 give the path to haskell-suite-pkg
6106
6107 --with-hmake PATH
6108 give the path to hmake
6109
6110 --with-hpc PATH
6111 give the path to hpc
6112
6113 --with-hsc2hs PATH
6114 give the path to hsc2hs
6115
6116 --with-hscolour PATH
6117 give the path to hscolour
6118
6119 --with-jhc PATH
6120 give the path to jhc
6121
6122 --with-ld PATH
6123 give the path to ld
6124
6125 --with-pkg-config PATH
6126 give the path to pkg-config
6127
6128 --with-runghc PATH
6129 give the path to runghc
6130
6131 --with-strip PATH
6132 give the path to strip
6133
6134 --with-tar PATH
6135 give the path to tar
6136
6137 --with-uhc PATH
6138 give the path to uhc
6139
6140 --alex-option OPT
6141 give an extra option to alex (no need to quote options
6142 containing spaces)
6143
6144 --ar-option OPT
6145 give an extra option to ar (no need to quote options con‐
6146 taining spaces)
6147
6148 --c2hs-option OPT
6149 give an extra option to c2hs (no need to quote options
6150 containing spaces)
6151
6152 --cpphs-option OPT
6153 give an extra option to cpphs (no need to quote options
6154 containing spaces)
6155
6156 --doctest-option OPT
6157 give an extra option to doctest (no need to quote options
6158 containing spaces)
6159
6160 --gcc-option OPT
6161 give an extra option to gcc (no need to quote options
6162 containing spaces)
6163
6164 --ghc-option OPT
6165 give an extra option to ghc (no need to quote options
6166 containing spaces)
6167
6168 --ghc-pkg-option OPT
6169 give an extra option to ghc-pkg (no need to quote options
6170 containing spaces)
6171
6172 --ghcjs-option OPT
6173 give an extra option to ghcjs (no need to quote options
6174 containing spaces)
6175
6176 --ghcjs-pkg-option OPT
6177 give an extra option to ghcjs-pkg (no need to quote
6178 options containing spaces)
6179
6180 --greencard-option OPT
6181 give an extra option to greencard (no need to quote
6182 options containing spaces)
6183
6184 --haddock-option OPT
6185 give an extra option to haddock (no need to quote options
6186 containing spaces)
6187
6188 --happy-option OPT
6189 give an extra option to happy (no need to quote options
6190 containing spaces)
6191
6192 --haskell-suite-option OPT
6193 give an extra option to haskell-suite (no need to quote
6194 options containing spaces)
6195
6196 --haskell-suite-pkg-option OPT
6197 give an extra option to haskell-suite-pkg (no need to
6198 quote options containing spaces)
6199
6200 --hmake-option OPT
6201 give an extra option to hmake (no need to quote options
6202 containing spaces)
6203
6204 --hpc-option OPT
6205 give an extra option to hpc (no need to quote options
6206 containing spaces)
6207
6208 --hsc2hs-option OPT
6209 give an extra option to hsc2hs (no need to quote options
6210 containing spaces)
6211
6212 --hscolour-option OPT
6213 give an extra option to hscolour (no need to quote
6214 options containing spaces)
6215
6216 --jhc-option OPT
6217 give an extra option to jhc (no need to quote options
6218 containing spaces)
6219
6220 --ld-option OPT
6221 give an extra option to ld (no need to quote options con‐
6222 taining spaces)
6223
6224 --pkg-config-option OPT
6225 give an extra option to pkg-config (no need to quote
6226 options containing spaces)
6227
6228 --runghc-option OPT
6229 give an extra option to runghc (no need to quote options
6230 containing spaces)
6231
6232 --strip-option OPT
6233 give an extra option to strip (no need to quote options
6234 containing spaces)
6235
6236 --tar-option OPT
6237 give an extra option to tar (no need to quote options
6238 containing spaces)
6239
6240 --uhc-option OPT
6241 give an extra option to uhc (no need to quote options
6242 containing spaces)
6243
6244 --alex-options OPTS
6245 give extra options to alex
6246
6247 --ar-options OPTS
6248 give extra options to ar
6249
6250 --c2hs-options OPTS
6251 give extra options to c2hs
6252
6253 --cpphs-options OPTS
6254 give extra options to cpphs
6255
6256 --doctest-options OPTS
6257 give extra options to doctest
6258
6259 --gcc-options OPTS
6260 give extra options to gcc
6261
6262 --ghc-options OPTS
6263 give extra options to ghc
6264
6265 --ghc-pkg-options OPTS
6266 give extra options to ghc-pkg
6267
6268 --ghcjs-options OPTS
6269 give extra options to ghcjs
6270
6271 --ghcjs-pkg-options OPTS
6272 give extra options to ghcjs-pkg
6273
6274 --greencard-options OPTS
6275 give extra options to greencard
6276
6277 --haddock-options OPTS
6278 give extra options to haddock
6279
6280 --happy-options OPTS
6281 give extra options to happy
6282
6283 --haskell-suite-options OPTS
6284 give extra options to haskell-suite
6285
6286 --haskell-suite-pkg-options OPTS
6287 give extra options to haskell-suite-pkg
6288
6289 --hmake-options OPTS
6290 give extra options to hmake
6291
6292 --hpc-options OPTS
6293 give extra options to hpc
6294
6295 --hsc2hs-options OPTS
6296 give extra options to hsc2hs
6297
6298 --hscolour-options OPTS
6299 give extra options to hscolour
6300
6301 --jhc-options OPTS
6302 give extra options to jhc
6303
6304 --ld-options OPTS
6305 give extra options to ld
6306
6307 --pkg-config-options OPTS
6308 give extra options to pkg-config
6309
6310 --runghc-options OPTS
6311 give extra options to runghc
6312
6313 --strip-options OPTS
6314 give extra options to strip
6315
6316 --tar-options OPTS
6317 give extra options to tar
6318
6319 --uhc-options OPTS
6320 give extra options to uhc
6321
6322 --cabal-lib-version VERSION
6323 Select which version of the Cabal lib to use to build
6324 packages (useful for testing).
6325
6326 --constraint CONSTRAINT
6327 Specify constraints on a package (version,
6328 installed/source, flags)
6329
6330 --preference CONSTRAINT
6331 Specify preferences (soft constraints) on the version of
6332 a package
6333
6334 --solver SOLVER
6335 Select dependency solver to use (default: modular).
6336 Choices: modular.
6337
6338 --allow-older [DEPS]
6339 Ignore lower bounds in all dependencies or DEPS
6340
6341 --allow-newer [DEPS]
6342 Ignore upper bounds in all dependencies or DEPS
6343
6344 --write-ghc-environment-files always|never|ghc8.4.4+
6345 Whether to create a .ghc.environment file after a suc‐
6346 cessful build (v2-build only)
6347
6348 --enable-documentation
6349 --disable-documentation
6350 building of documentation
6351
6352 --doc-index-file TEMPLATE
6353 A central index of haddock API documentation (template
6354 cannot use $pkgid)
6355
6356 --dry-run
6357 Do not install anything, only print what would be
6358 installed.
6359
6360 --max-backjumps NUM
6361 Maximum number of backjumps allowed while solving
6362 (default: 2000). Use a negative number to enable unlim‐
6363 ited backtracking. Use 0 to disable backtracking com‐
6364 pletely.
6365
6366 --reorder-goals
6367 --no-reorder-goals
6368 Try to reorder goals according to certain heuristics.
6369 Slows things down on average, but may make backtracking
6370 faster for some packages.
6371
6372 --count-conflicts
6373 --no-count-conflicts
6374 Try to speed up solving by preferring goals that are
6375 involved in a lot of conflicts (default).
6376
6377 --independent-goals
6378 --no-independent-goals
6379 Treat several goals on the command line as independent.
6380 If several goals depend on the same package, different
6381 versions can be chosen.
6382
6383 --shadow-installed-packages
6384 --no-shadow-installed-packages
6385 If multiple package instances of the same version are
6386 installed, treat all but one as shadowed.
6387
6388 --strong-flags
6389 --no-strong-flags
6390 Do not defer flag choices (this used to be the default in
6391 cabal-install <= 1.20).
6392
6393 --allow-boot-library-installs
6394 --no-allow-boot-library-installs
6395 Allow cabal to install base, ghc-prim, integer-simple,
6396 integer-gmp, and template-haskell.
6397
6398 --reinstall
6399 --no-reinstall
6400 Install even if it means installing the same version
6401 again.
6402
6403 --avoid-reinstalls
6404 --no-avoid-reinstalls
6405 Do not select versions that would destructively overwrite
6406 installed packages.
6407
6408 --force-reinstalls
6409 --no-force-reinstalls
6410 Reinstall packages even if they will most likely break
6411 other installed packages.
6412
6413 --upgrade-dependencies
6414 --no-upgrade-dependencies
6415 Pick the latest version for all dependencies, rather than
6416 trying to pick an installed version.
6417
6418 --only-dependencies
6419 --no-only-dependencies
6420 Install only the dependencies necessary to build the
6421 given packages
6422
6423 --dependencies-only
6424 --no-dependencies-only
6425 A synonym for --only-dependencies
6426
6427 --index-state STATE
6428 Use source package index state as it existed at a previ‐
6429 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
6430 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
6431 'HEAD' (default: 'HEAD').
6432
6433 --root-cmd COMMAND
6434 (No longer supported, do not use.)
6435
6436 --symlink-bindir DIR
6437 Add symlinks to installed executables into this direc‐
6438 tory.
6439
6440 --build-summary TEMPLATE
6441 Save build summaries to file (name template can use
6442 $pkgid, $compiler, $os, $arch)
6443
6444 --build-log TEMPLATE
6445 Log all builds to file (name template can use $pkgid,
6446 $compiler, $os, $arch)
6447
6448 --remote-build-reporting LEVEL
6449 Generate build reports to send to a remote server (none,
6450 anonymous or detailed).
6451
6452 --report-planning-failure
6453 Generate build reports when the dependency solver fails.
6454 This is used by the Hackage build bot.
6455
6456 --enable-per-component
6457 --disable-per-component
6458 Per-component builds when possible
6459
6460 --one-shot
6461 --no-one-shot
6462 Do not record the packages in the world file.
6463
6464 --run-tests
6465 Run package test suites during installation.
6466
6467 -j, --jobs [NUM]
6468 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
6469 given).
6470
6471 --keep-going
6472 After a build failure, continue to build other unaffected
6473 packages.
6474
6475 --offline
6476 --no-offline
6477 Don't download packages from the Internet.
6478
6479 --project-file FILE
6480 Set the name of the cabal.project file to search for in
6481 parent directories
6482
6483 --only
6484 Only installs the package in the current directory.
6485
6486 --haddock-hoogle
6487 Generate a hoogle database
6488
6489 --haddock-html
6490 Generate HTML documentation (the default)
6491
6492 --haddock-html-location URL
6493 Location of HTML documentation for pre-requisite packages
6494
6495 --haddock-for-hackage
6496 Collection of flags to generate documentation suitable
6497 for upload to hackage
6498
6499 --haddock-executables
6500 Run haddock for Executables targets
6501
6502 --haddock-tests
6503 Run haddock for Test Suite targets
6504
6505 --haddock-benchmarks
6506 Run haddock for Benchmark targets
6507
6508 --haddock-all
6509 Run haddock for all targets
6510
6511 --haddock-internal
6512 Run haddock for internal modules and include all symbols
6513
6514 --haddock-css PATH
6515 Use PATH as the haddock stylesheet
6516
6517 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
6518 dock-hyperlinked-source
6519 Hyperlink the documentation to the source code
6520
6521 --haddock-quickjump
6522 Generate an index for interactive documentation naviga‐
6523 tion
6524
6525 --haddock-hscolour-css PATH
6526 Use PATH as the HsColour stylesheet
6527
6528 --haddock-contents-location URL
6529 Bake URL in as the location for the contents page
6530
6531 --repl-options FLAG
6532 use this option for the repl
6533
6534 -b, --build-depends DEPENDENCY
6535 Include an additional package in the environment pre‐
6536 sented to GHCi.
6537
6538 --no-transitive-deps
6539 Don't automatically include transitive dependencies of
6540 requested packages.
6541
6542 -z, --ignore-project
6543 Only include explicitly specified packages (and 'base').
6544
6545
6546 cabal v2-freeze
6547
6548 Usage: cabal v2-freeze [FLAGS]
6549
6550
6551 The project configuration is frozen so that it will be reproducible in
6552 future.
6553
6554 The precise dependency configuration for the project is written to the
6555 specified). This file extends the configuration from the
6556 'cabal.project' file and thus is used as the project configuration for
6557 all other commands (such as
6558
6559 The freeze file can be kept in source control. To make small adjust‐
6560 ments it may be edited manually, or to make bigger changes you may wish
6561 to delete the file and re-freeze. For more control, one approach is to
6562 try variations using once you have a satisfactory solution to freeze it
6563 using the 'v2-freeze' command with the same set of flags.
6564
6565
6566 The project configuration is frozen so that it will be reproducible in
6567 future.
6568
6569 The precise dependency configuration for the project is written to the
6570 specified). This file extends the configuration from the
6571 'cabal.project' file and thus is used as the project configuration for
6572 all other commands (such as
6573
6574 The freeze file can be kept in source control. To make small adjust‐
6575 ments it may be edited manually, or to make bigger changes you may wish
6576 to delete the file and re-freeze. For more control, one approach is to
6577 try variations using once you have a satisfactory solution to freeze it
6578 using the 'v2-freeze' command with the same set of flags.
6579
6580
6581 Flags:
6582 -v, --verbose [n]
6583 Control verbosity (n is 0--3, default verbosity level is
6584 1)
6585
6586 --builddir, --distdir, --distpref DIR
6587 The directory where Cabal puts generated build files
6588 (default dist)
6589
6590 -g, --ghc
6591 compile with GHC
6592
6593 --ghcjs
6594 compile with GHCJS
6595
6596 --uhc
6597 compile with UHC
6598
6599 --haskell-suite
6600 compile with a haskell-suite compiler
6601
6602 --cabal-file PATH
6603 use this Cabal file
6604
6605 -w, --with-compiler PATH
6606 give the path to a particular compiler
6607
6608 --with-hc-pkg PATH
6609 give the path to the package tool
6610
6611 --prefix DIR
6612 bake this prefix in preparation of installation
6613
6614 --bindir DIR
6615 installation directory for executables
6616
6617 --libdir DIR
6618 installation directory for libraries
6619
6620 --libsubdir DIR
6621 subdirectory of libdir in which libs are installed
6622
6623 --dynlibdir DIR
6624 installation directory for dynamic libraries
6625
6626 --libexecdir DIR
6627 installation directory for program executables
6628
6629 --libexecsubdir DIR
6630 subdirectory of libexecdir in which private executables
6631 are installed
6632
6633 --datadir DIR
6634 installation directory for read-only data
6635
6636 --datasubdir DIR
6637 subdirectory of datadir in which data files are installed
6638
6639 --docdir DIR
6640 installation directory for documentation
6641
6642 --htmldir DIR
6643 installation directory for HTML documentation
6644
6645 --haddockdir DIR
6646 installation directory for haddock interfaces
6647
6648 --sysconfdir DIR
6649 installation directory for configuration files
6650
6651 --program-prefix PREFIX
6652 prefix to be applied to installed executables
6653
6654 --program-suffix SUFFIX
6655 suffix to be applied to installed executables
6656
6657 --enable-library-vanilla
6658 --disable-library-vanilla
6659 Vanilla libraries
6660
6661 -p, --enable-library-profiling
6662 --disable-library-profiling
6663 Library profiling
6664
6665 --enable-shared
6666 --disable-shared
6667 Shared library
6668
6669 --enable-static
6670 --disable-static
6671 Static library
6672
6673 --enable-executable-dynamic
6674 --disable-executable-dynamic
6675 Executable dynamic linking
6676
6677 --enable-profiling
6678 --disable-profiling
6679 Executable and library profiling
6680
6681 --enable-executable-profiling
6682 --disable-executable-profiling
6683 Executable profiling (DEPRECATED)
6684
6685 --profiling-detail level
6686 Profiling detail level for executable and library
6687 (default, none, exported-functions, toplevel-functions,
6688 all-functions).
6689
6690 --library-profiling-detail level
6691 Profiling detail level for libraries only.
6692
6693 -O, --enable-optimization, --enable-optimisation [n]
6694 Build with optimization (n is 0--2, default is 1)
6695
6696 --disable-optimization, --disable-optimisation
6697 Build without optimization
6698
6699 --enable-debug-info [n]
6700 Emit debug info (n is 0--3, default is 0)
6701
6702 --disable-debug-info
6703 Don't emit debug info
6704
6705 --enable-library-for-ghci
6706 --disable-library-for-ghci
6707 compile library for use with GHCi
6708
6709 --enable-split-sections
6710 --disable-split-sections
6711 compile library code such that unneeded definitions can
6712 be dropped from the final executable (GHC 7.8+)
6713
6714 --enable-split-objs
6715 --disable-split-objs
6716 split library into smaller objects to reduce binary sizes
6717 (GHC 6.6+)
6718
6719 --enable-executable-stripping
6720 --disable-executable-stripping
6721 strip executables upon installation to reduce binary
6722 sizes
6723
6724 --enable-library-stripping
6725 --disable-library-stripping
6726 strip libraries upon installation to reduce binary sizes
6727
6728 --configure-option OPT
6729 Extra option for configure
6730
6731 --user
6732 --global
6733 doing a per-user installation
6734
6735 --package-db DB
6736 Append the given package database to the list of package
6737 databases used (to satisfy dependencies and register
6738 into). May be a specific file, 'global' or 'user'. The
6739 initial list is ['global'], ['global', 'user'], or
6740 ['global', $sandbox], depending on context. Use 'clear'
6741 to reset the list to empty. See the user guide for
6742 details.
6743
6744 -f, --flags FLAGS
6745 Force values for the given flags in Cabal conditionals in
6746 the .cabal file. E.g., --flags="debug -usebytestrings"
6747 forces the flag "debug" to true and "usebytestrings" to
6748 false.
6749
6750 --extra-include-dirs PATH
6751 A list of directories to search for header files
6752
6753 --enable-deterministic
6754 --disable-deterministic
6755 Try to be as deterministic as possible (used by the test
6756 suite)
6757
6758 --ipid IPID
6759 Installed package ID to compile this package as
6760
6761 --cid CID
6762 Installed component ID to compile this component as
6763
6764 --extra-lib-dirs PATH
6765 A list of directories to search for external libraries
6766
6767 --extra-framework-dirs PATH
6768 A list of directories to search for external frameworks
6769 (OS X only)
6770
6771 --extra-prog-path PATH
6772 A list of directories to search for required programs (in
6773 addition to the normal search locations)
6774
6775 --instantiate-with NAME=MOD
6776 A mapping of signature names to concrete module instanti‐
6777 ations.
6778
6779 --enable-tests
6780 --disable-tests
6781 dependency checking and compilation for test suites
6782 listed in the package description file.
6783
6784 --enable-coverage
6785 --disable-coverage
6786 build package with Haskell Program Coverage. (GHC only)
6787
6788 --enable-library-coverage
6789 --disable-library-coverage
6790 build package with Haskell Program Coverage. (GHC only)
6791 (DEPRECATED)
6792
6793 --enable-benchmarks
6794 --disable-benchmarks
6795 dependency checking and compilation for benchmarks listed
6796 in the package description file.
6797
6798 --enable-relocatable
6799 --disable-relocatable
6800 building a package that is relocatable. (GHC only)
6801
6802 --disable-response-files
6803 enable workaround for old versions of programs like "ar"
6804 that do not support @file arguments
6805
6806 --with-alex PATH
6807 give the path to alex
6808
6809 --with-ar PATH
6810 give the path to ar
6811
6812 --with-c2hs PATH
6813 give the path to c2hs
6814
6815 --with-cpphs PATH
6816 give the path to cpphs
6817
6818 --with-doctest PATH
6819 give the path to doctest
6820
6821 --with-gcc PATH
6822 give the path to gcc
6823
6824 --with-ghc PATH
6825 give the path to ghc
6826
6827 --with-ghc-pkg PATH
6828 give the path to ghc-pkg
6829
6830 --with-ghcjs PATH
6831 give the path to ghcjs
6832
6833 --with-ghcjs-pkg PATH
6834 give the path to ghcjs-pkg
6835
6836 --with-greencard PATH
6837 give the path to greencard
6838
6839 --with-haddock PATH
6840 give the path to haddock
6841
6842 --with-happy PATH
6843 give the path to happy
6844
6845 --with-haskell-suite PATH
6846 give the path to haskell-suite
6847
6848 --with-haskell-suite-pkg PATH
6849 give the path to haskell-suite-pkg
6850
6851 --with-hmake PATH
6852 give the path to hmake
6853
6854 --with-hpc PATH
6855 give the path to hpc
6856
6857 --with-hsc2hs PATH
6858 give the path to hsc2hs
6859
6860 --with-hscolour PATH
6861 give the path to hscolour
6862
6863 --with-jhc PATH
6864 give the path to jhc
6865
6866 --with-ld PATH
6867 give the path to ld
6868
6869 --with-pkg-config PATH
6870 give the path to pkg-config
6871
6872 --with-runghc PATH
6873 give the path to runghc
6874
6875 --with-strip PATH
6876 give the path to strip
6877
6878 --with-tar PATH
6879 give the path to tar
6880
6881 --with-uhc PATH
6882 give the path to uhc
6883
6884 --alex-option OPT
6885 give an extra option to alex (no need to quote options
6886 containing spaces)
6887
6888 --ar-option OPT
6889 give an extra option to ar (no need to quote options con‐
6890 taining spaces)
6891
6892 --c2hs-option OPT
6893 give an extra option to c2hs (no need to quote options
6894 containing spaces)
6895
6896 --cpphs-option OPT
6897 give an extra option to cpphs (no need to quote options
6898 containing spaces)
6899
6900 --doctest-option OPT
6901 give an extra option to doctest (no need to quote options
6902 containing spaces)
6903
6904 --gcc-option OPT
6905 give an extra option to gcc (no need to quote options
6906 containing spaces)
6907
6908 --ghc-option OPT
6909 give an extra option to ghc (no need to quote options
6910 containing spaces)
6911
6912 --ghc-pkg-option OPT
6913 give an extra option to ghc-pkg (no need to quote options
6914 containing spaces)
6915
6916 --ghcjs-option OPT
6917 give an extra option to ghcjs (no need to quote options
6918 containing spaces)
6919
6920 --ghcjs-pkg-option OPT
6921 give an extra option to ghcjs-pkg (no need to quote
6922 options containing spaces)
6923
6924 --greencard-option OPT
6925 give an extra option to greencard (no need to quote
6926 options containing spaces)
6927
6928 --haddock-option OPT
6929 give an extra option to haddock (no need to quote options
6930 containing spaces)
6931
6932 --happy-option OPT
6933 give an extra option to happy (no need to quote options
6934 containing spaces)
6935
6936 --haskell-suite-option OPT
6937 give an extra option to haskell-suite (no need to quote
6938 options containing spaces)
6939
6940 --haskell-suite-pkg-option OPT
6941 give an extra option to haskell-suite-pkg (no need to
6942 quote options containing spaces)
6943
6944 --hmake-option OPT
6945 give an extra option to hmake (no need to quote options
6946 containing spaces)
6947
6948 --hpc-option OPT
6949 give an extra option to hpc (no need to quote options
6950 containing spaces)
6951
6952 --hsc2hs-option OPT
6953 give an extra option to hsc2hs (no need to quote options
6954 containing spaces)
6955
6956 --hscolour-option OPT
6957 give an extra option to hscolour (no need to quote
6958 options containing spaces)
6959
6960 --jhc-option OPT
6961 give an extra option to jhc (no need to quote options
6962 containing spaces)
6963
6964 --ld-option OPT
6965 give an extra option to ld (no need to quote options con‐
6966 taining spaces)
6967
6968 --pkg-config-option OPT
6969 give an extra option to pkg-config (no need to quote
6970 options containing spaces)
6971
6972 --runghc-option OPT
6973 give an extra option to runghc (no need to quote options
6974 containing spaces)
6975
6976 --strip-option OPT
6977 give an extra option to strip (no need to quote options
6978 containing spaces)
6979
6980 --tar-option OPT
6981 give an extra option to tar (no need to quote options
6982 containing spaces)
6983
6984 --uhc-option OPT
6985 give an extra option to uhc (no need to quote options
6986 containing spaces)
6987
6988 --alex-options OPTS
6989 give extra options to alex
6990
6991 --ar-options OPTS
6992 give extra options to ar
6993
6994 --c2hs-options OPTS
6995 give extra options to c2hs
6996
6997 --cpphs-options OPTS
6998 give extra options to cpphs
6999
7000 --doctest-options OPTS
7001 give extra options to doctest
7002
7003 --gcc-options OPTS
7004 give extra options to gcc
7005
7006 --ghc-options OPTS
7007 give extra options to ghc
7008
7009 --ghc-pkg-options OPTS
7010 give extra options to ghc-pkg
7011
7012 --ghcjs-options OPTS
7013 give extra options to ghcjs
7014
7015 --ghcjs-pkg-options OPTS
7016 give extra options to ghcjs-pkg
7017
7018 --greencard-options OPTS
7019 give extra options to greencard
7020
7021 --haddock-options OPTS
7022 give extra options to haddock
7023
7024 --happy-options OPTS
7025 give extra options to happy
7026
7027 --haskell-suite-options OPTS
7028 give extra options to haskell-suite
7029
7030 --haskell-suite-pkg-options OPTS
7031 give extra options to haskell-suite-pkg
7032
7033 --hmake-options OPTS
7034 give extra options to hmake
7035
7036 --hpc-options OPTS
7037 give extra options to hpc
7038
7039 --hsc2hs-options OPTS
7040 give extra options to hsc2hs
7041
7042 --hscolour-options OPTS
7043 give extra options to hscolour
7044
7045 --jhc-options OPTS
7046 give extra options to jhc
7047
7048 --ld-options OPTS
7049 give extra options to ld
7050
7051 --pkg-config-options OPTS
7052 give extra options to pkg-config
7053
7054 --runghc-options OPTS
7055 give extra options to runghc
7056
7057 --strip-options OPTS
7058 give extra options to strip
7059
7060 --tar-options OPTS
7061 give extra options to tar
7062
7063 --uhc-options OPTS
7064 give extra options to uhc
7065
7066 --cabal-lib-version VERSION
7067 Select which version of the Cabal lib to use to build
7068 packages (useful for testing).
7069
7070 --constraint CONSTRAINT
7071 Specify constraints on a package (version,
7072 installed/source, flags)
7073
7074 --preference CONSTRAINT
7075 Specify preferences (soft constraints) on the version of
7076 a package
7077
7078 --solver SOLVER
7079 Select dependency solver to use (default: modular).
7080 Choices: modular.
7081
7082 --allow-older [DEPS]
7083 Ignore lower bounds in all dependencies or DEPS
7084
7085 --allow-newer [DEPS]
7086 Ignore upper bounds in all dependencies or DEPS
7087
7088 --write-ghc-environment-files always|never|ghc8.4.4+
7089 Whether to create a .ghc.environment file after a suc‐
7090 cessful build (v2-build only)
7091
7092 --enable-documentation
7093 --disable-documentation
7094 building of documentation
7095
7096 --doc-index-file TEMPLATE
7097 A central index of haddock API documentation (template
7098 cannot use $pkgid)
7099
7100 --dry-run
7101 Do not install anything, only print what would be
7102 installed.
7103
7104 --max-backjumps NUM
7105 Maximum number of backjumps allowed while solving
7106 (default: 2000). Use a negative number to enable unlim‐
7107 ited backtracking. Use 0 to disable backtracking com‐
7108 pletely.
7109
7110 --reorder-goals
7111 --no-reorder-goals
7112 Try to reorder goals according to certain heuristics.
7113 Slows things down on average, but may make backtracking
7114 faster for some packages.
7115
7116 --count-conflicts
7117 --no-count-conflicts
7118 Try to speed up solving by preferring goals that are
7119 involved in a lot of conflicts (default).
7120
7121 --independent-goals
7122 --no-independent-goals
7123 Treat several goals on the command line as independent.
7124 If several goals depend on the same package, different
7125 versions can be chosen.
7126
7127 --shadow-installed-packages
7128 --no-shadow-installed-packages
7129 If multiple package instances of the same version are
7130 installed, treat all but one as shadowed.
7131
7132 --strong-flags
7133 --no-strong-flags
7134 Do not defer flag choices (this used to be the default in
7135 cabal-install <= 1.20).
7136
7137 --allow-boot-library-installs
7138 --no-allow-boot-library-installs
7139 Allow cabal to install base, ghc-prim, integer-simple,
7140 integer-gmp, and template-haskell.
7141
7142 --reinstall
7143 --no-reinstall
7144 Install even if it means installing the same version
7145 again.
7146
7147 --avoid-reinstalls
7148 --no-avoid-reinstalls
7149 Do not select versions that would destructively overwrite
7150 installed packages.
7151
7152 --force-reinstalls
7153 --no-force-reinstalls
7154 Reinstall packages even if they will most likely break
7155 other installed packages.
7156
7157 --upgrade-dependencies
7158 --no-upgrade-dependencies
7159 Pick the latest version for all dependencies, rather than
7160 trying to pick an installed version.
7161
7162 --only-dependencies
7163 --no-only-dependencies
7164 Install only the dependencies necessary to build the
7165 given packages
7166
7167 --dependencies-only
7168 --no-dependencies-only
7169 A synonym for --only-dependencies
7170
7171 --index-state STATE
7172 Use source package index state as it existed at a previ‐
7173 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
7174 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
7175 'HEAD' (default: 'HEAD').
7176
7177 --root-cmd COMMAND
7178 (No longer supported, do not use.)
7179
7180 --symlink-bindir DIR
7181 Add symlinks to installed executables into this direc‐
7182 tory.
7183
7184 --build-summary TEMPLATE
7185 Save build summaries to file (name template can use
7186 $pkgid, $compiler, $os, $arch)
7187
7188 --build-log TEMPLATE
7189 Log all builds to file (name template can use $pkgid,
7190 $compiler, $os, $arch)
7191
7192 --remote-build-reporting LEVEL
7193 Generate build reports to send to a remote server (none,
7194 anonymous or detailed).
7195
7196 --report-planning-failure
7197 Generate build reports when the dependency solver fails.
7198 This is used by the Hackage build bot.
7199
7200 --enable-per-component
7201 --disable-per-component
7202 Per-component builds when possible
7203
7204 --one-shot
7205 --no-one-shot
7206 Do not record the packages in the world file.
7207
7208 --run-tests
7209 Run package test suites during installation.
7210
7211 -j, --jobs [NUM]
7212 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
7213 given).
7214
7215 --keep-going
7216 After a build failure, continue to build other unaffected
7217 packages.
7218
7219 --offline
7220 --no-offline
7221 Don't download packages from the Internet.
7222
7223 --project-file FILE
7224 Set the name of the cabal.project file to search for in
7225 parent directories
7226
7227 --only
7228 Only installs the package in the current directory.
7229
7230 --haddock-hoogle
7231 Generate a hoogle database
7232
7233 --haddock-html
7234 Generate HTML documentation (the default)
7235
7236 --haddock-html-location URL
7237 Location of HTML documentation for pre-requisite packages
7238
7239 --haddock-for-hackage
7240 Collection of flags to generate documentation suitable
7241 for upload to hackage
7242
7243 --haddock-executables
7244 Run haddock for Executables targets
7245
7246 --haddock-tests
7247 Run haddock for Test Suite targets
7248
7249 --haddock-benchmarks
7250 Run haddock for Benchmark targets
7251
7252 --haddock-all
7253 Run haddock for all targets
7254
7255 --haddock-internal
7256 Run haddock for internal modules and include all symbols
7257
7258 --haddock-css PATH
7259 Use PATH as the haddock stylesheet
7260
7261 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
7262 dock-hyperlinked-source
7263 Hyperlink the documentation to the source code
7264
7265 --haddock-quickjump
7266 Generate an index for interactive documentation naviga‐
7267 tion
7268
7269 --haddock-hscolour-css PATH
7270 Use PATH as the HsColour stylesheet
7271
7272 --haddock-contents-location URL
7273 Bake URL in as the location for the contents page
7274
7275
7276 cabal new-freeze
7277
7278 Usage: cabal new-freeze [FLAGS]
7279
7280
7281 The project configuration is frozen so that it will be reproducible in
7282 future.
7283
7284 The precise dependency configuration for the project is written to the
7285 specified). This file extends the configuration from the
7286 'cabal.project' file and thus is used as the project configuration for
7287 all other commands (such as
7288
7289 The freeze file can be kept in source control. To make small adjust‐
7290 ments it may be edited manually, or to make bigger changes you may wish
7291 to delete the file and re-freeze. For more control, one approach is to
7292 try variations using once you have a satisfactory solution to freeze it
7293 using the 'new-freeze' command with the same set of flags.
7294
7295
7296 Examples:
7297 cabal new-freeze
7298 Freeze the configuration of the current project
7299
7300 cabal new-build --dry-run --constraint="aeson < 1"
7301 Check what a solution with the given constraints would look like
7302 cabal new-freeze --constraint="aeson < 1"
7303 Freeze a solution using the given constraints
7304
7305 Note: this command is part of the new project-based system (aka nix-
7306 style local builds). These features are currently in beta. Please see
7307 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
7308 details and advice on what you can expect to work. If you encounter
7309 problems please file issues at https://github.com/haskell/cabal/issues
7310 and if you have any time to get involved and help with testing, fixing
7311 bugs etc then that is very much appreciated.
7312
7313
7314 Flags:
7315 -v, --verbose [n]
7316 Control verbosity (n is 0--3, default verbosity level is
7317 1)
7318
7319 --builddir, --distdir, --distpref DIR
7320 The directory where Cabal puts generated build files
7321 (default dist)
7322
7323 -g, --ghc
7324 compile with GHC
7325
7326 --ghcjs
7327 compile with GHCJS
7328
7329 --uhc
7330 compile with UHC
7331
7332 --haskell-suite
7333 compile with a haskell-suite compiler
7334
7335 --cabal-file PATH
7336 use this Cabal file
7337
7338 -w, --with-compiler PATH
7339 give the path to a particular compiler
7340
7341 --with-hc-pkg PATH
7342 give the path to the package tool
7343
7344 --prefix DIR
7345 bake this prefix in preparation of installation
7346
7347 --bindir DIR
7348 installation directory for executables
7349
7350 --libdir DIR
7351 installation directory for libraries
7352
7353 --libsubdir DIR
7354 subdirectory of libdir in which libs are installed
7355
7356 --dynlibdir DIR
7357 installation directory for dynamic libraries
7358
7359 --libexecdir DIR
7360 installation directory for program executables
7361
7362 --libexecsubdir DIR
7363 subdirectory of libexecdir in which private executables
7364 are installed
7365
7366 --datadir DIR
7367 installation directory for read-only data
7368
7369 --datasubdir DIR
7370 subdirectory of datadir in which data files are installed
7371
7372 --docdir DIR
7373 installation directory for documentation
7374
7375 --htmldir DIR
7376 installation directory for HTML documentation
7377
7378 --haddockdir DIR
7379 installation directory for haddock interfaces
7380
7381 --sysconfdir DIR
7382 installation directory for configuration files
7383
7384 --program-prefix PREFIX
7385 prefix to be applied to installed executables
7386
7387 --program-suffix SUFFIX
7388 suffix to be applied to installed executables
7389
7390 --enable-library-vanilla
7391 --disable-library-vanilla
7392 Vanilla libraries
7393
7394 -p, --enable-library-profiling
7395 --disable-library-profiling
7396 Library profiling
7397
7398 --enable-shared
7399 --disable-shared
7400 Shared library
7401
7402 --enable-static
7403 --disable-static
7404 Static library
7405
7406 --enable-executable-dynamic
7407 --disable-executable-dynamic
7408 Executable dynamic linking
7409
7410 --enable-profiling
7411 --disable-profiling
7412 Executable and library profiling
7413
7414 --enable-executable-profiling
7415 --disable-executable-profiling
7416 Executable profiling (DEPRECATED)
7417
7418 --profiling-detail level
7419 Profiling detail level for executable and library
7420 (default, none, exported-functions, toplevel-functions,
7421 all-functions).
7422
7423 --library-profiling-detail level
7424 Profiling detail level for libraries only.
7425
7426 -O, --enable-optimization, --enable-optimisation [n]
7427 Build with optimization (n is 0--2, default is 1)
7428
7429 --disable-optimization, --disable-optimisation
7430 Build without optimization
7431
7432 --enable-debug-info [n]
7433 Emit debug info (n is 0--3, default is 0)
7434
7435 --disable-debug-info
7436 Don't emit debug info
7437
7438 --enable-library-for-ghci
7439 --disable-library-for-ghci
7440 compile library for use with GHCi
7441
7442 --enable-split-sections
7443 --disable-split-sections
7444 compile library code such that unneeded definitions can
7445 be dropped from the final executable (GHC 7.8+)
7446
7447 --enable-split-objs
7448 --disable-split-objs
7449 split library into smaller objects to reduce binary sizes
7450 (GHC 6.6+)
7451
7452 --enable-executable-stripping
7453 --disable-executable-stripping
7454 strip executables upon installation to reduce binary
7455 sizes
7456
7457 --enable-library-stripping
7458 --disable-library-stripping
7459 strip libraries upon installation to reduce binary sizes
7460
7461 --configure-option OPT
7462 Extra option for configure
7463
7464 --user
7465 --global
7466 doing a per-user installation
7467
7468 --package-db DB
7469 Append the given package database to the list of package
7470 databases used (to satisfy dependencies and register
7471 into). May be a specific file, 'global' or 'user'. The
7472 initial list is ['global'], ['global', 'user'], or
7473 ['global', $sandbox], depending on context. Use 'clear'
7474 to reset the list to empty. See the user guide for
7475 details.
7476
7477 -f, --flags FLAGS
7478 Force values for the given flags in Cabal conditionals in
7479 the .cabal file. E.g., --flags="debug -usebytestrings"
7480 forces the flag "debug" to true and "usebytestrings" to
7481 false.
7482
7483 --extra-include-dirs PATH
7484 A list of directories to search for header files
7485
7486 --enable-deterministic
7487 --disable-deterministic
7488 Try to be as deterministic as possible (used by the test
7489 suite)
7490
7491 --ipid IPID
7492 Installed package ID to compile this package as
7493
7494 --cid CID
7495 Installed component ID to compile this component as
7496
7497 --extra-lib-dirs PATH
7498 A list of directories to search for external libraries
7499
7500 --extra-framework-dirs PATH
7501 A list of directories to search for external frameworks
7502 (OS X only)
7503
7504 --extra-prog-path PATH
7505 A list of directories to search for required programs (in
7506 addition to the normal search locations)
7507
7508 --instantiate-with NAME=MOD
7509 A mapping of signature names to concrete module instanti‐
7510 ations.
7511
7512 --enable-tests
7513 --disable-tests
7514 dependency checking and compilation for test suites
7515 listed in the package description file.
7516
7517 --enable-coverage
7518 --disable-coverage
7519 build package with Haskell Program Coverage. (GHC only)
7520
7521 --enable-library-coverage
7522 --disable-library-coverage
7523 build package with Haskell Program Coverage. (GHC only)
7524 (DEPRECATED)
7525
7526 --enable-benchmarks
7527 --disable-benchmarks
7528 dependency checking and compilation for benchmarks listed
7529 in the package description file.
7530
7531 --enable-relocatable
7532 --disable-relocatable
7533 building a package that is relocatable. (GHC only)
7534
7535 --disable-response-files
7536 enable workaround for old versions of programs like "ar"
7537 that do not support @file arguments
7538
7539 --with-alex PATH
7540 give the path to alex
7541
7542 --with-ar PATH
7543 give the path to ar
7544
7545 --with-c2hs PATH
7546 give the path to c2hs
7547
7548 --with-cpphs PATH
7549 give the path to cpphs
7550
7551 --with-doctest PATH
7552 give the path to doctest
7553
7554 --with-gcc PATH
7555 give the path to gcc
7556
7557 --with-ghc PATH
7558 give the path to ghc
7559
7560 --with-ghc-pkg PATH
7561 give the path to ghc-pkg
7562
7563 --with-ghcjs PATH
7564 give the path to ghcjs
7565
7566 --with-ghcjs-pkg PATH
7567 give the path to ghcjs-pkg
7568
7569 --with-greencard PATH
7570 give the path to greencard
7571
7572 --with-haddock PATH
7573 give the path to haddock
7574
7575 --with-happy PATH
7576 give the path to happy
7577
7578 --with-haskell-suite PATH
7579 give the path to haskell-suite
7580
7581 --with-haskell-suite-pkg PATH
7582 give the path to haskell-suite-pkg
7583
7584 --with-hmake PATH
7585 give the path to hmake
7586
7587 --with-hpc PATH
7588 give the path to hpc
7589
7590 --with-hsc2hs PATH
7591 give the path to hsc2hs
7592
7593 --with-hscolour PATH
7594 give the path to hscolour
7595
7596 --with-jhc PATH
7597 give the path to jhc
7598
7599 --with-ld PATH
7600 give the path to ld
7601
7602 --with-pkg-config PATH
7603 give the path to pkg-config
7604
7605 --with-runghc PATH
7606 give the path to runghc
7607
7608 --with-strip PATH
7609 give the path to strip
7610
7611 --with-tar PATH
7612 give the path to tar
7613
7614 --with-uhc PATH
7615 give the path to uhc
7616
7617 --alex-option OPT
7618 give an extra option to alex (no need to quote options
7619 containing spaces)
7620
7621 --ar-option OPT
7622 give an extra option to ar (no need to quote options con‐
7623 taining spaces)
7624
7625 --c2hs-option OPT
7626 give an extra option to c2hs (no need to quote options
7627 containing spaces)
7628
7629 --cpphs-option OPT
7630 give an extra option to cpphs (no need to quote options
7631 containing spaces)
7632
7633 --doctest-option OPT
7634 give an extra option to doctest (no need to quote options
7635 containing spaces)
7636
7637 --gcc-option OPT
7638 give an extra option to gcc (no need to quote options
7639 containing spaces)
7640
7641 --ghc-option OPT
7642 give an extra option to ghc (no need to quote options
7643 containing spaces)
7644
7645 --ghc-pkg-option OPT
7646 give an extra option to ghc-pkg (no need to quote options
7647 containing spaces)
7648
7649 --ghcjs-option OPT
7650 give an extra option to ghcjs (no need to quote options
7651 containing spaces)
7652
7653 --ghcjs-pkg-option OPT
7654 give an extra option to ghcjs-pkg (no need to quote
7655 options containing spaces)
7656
7657 --greencard-option OPT
7658 give an extra option to greencard (no need to quote
7659 options containing spaces)
7660
7661 --haddock-option OPT
7662 give an extra option to haddock (no need to quote options
7663 containing spaces)
7664
7665 --happy-option OPT
7666 give an extra option to happy (no need to quote options
7667 containing spaces)
7668
7669 --haskell-suite-option OPT
7670 give an extra option to haskell-suite (no need to quote
7671 options containing spaces)
7672
7673 --haskell-suite-pkg-option OPT
7674 give an extra option to haskell-suite-pkg (no need to
7675 quote options containing spaces)
7676
7677 --hmake-option OPT
7678 give an extra option to hmake (no need to quote options
7679 containing spaces)
7680
7681 --hpc-option OPT
7682 give an extra option to hpc (no need to quote options
7683 containing spaces)
7684
7685 --hsc2hs-option OPT
7686 give an extra option to hsc2hs (no need to quote options
7687 containing spaces)
7688
7689 --hscolour-option OPT
7690 give an extra option to hscolour (no need to quote
7691 options containing spaces)
7692
7693 --jhc-option OPT
7694 give an extra option to jhc (no need to quote options
7695 containing spaces)
7696
7697 --ld-option OPT
7698 give an extra option to ld (no need to quote options con‐
7699 taining spaces)
7700
7701 --pkg-config-option OPT
7702 give an extra option to pkg-config (no need to quote
7703 options containing spaces)
7704
7705 --runghc-option OPT
7706 give an extra option to runghc (no need to quote options
7707 containing spaces)
7708
7709 --strip-option OPT
7710 give an extra option to strip (no need to quote options
7711 containing spaces)
7712
7713 --tar-option OPT
7714 give an extra option to tar (no need to quote options
7715 containing spaces)
7716
7717 --uhc-option OPT
7718 give an extra option to uhc (no need to quote options
7719 containing spaces)
7720
7721 --alex-options OPTS
7722 give extra options to alex
7723
7724 --ar-options OPTS
7725 give extra options to ar
7726
7727 --c2hs-options OPTS
7728 give extra options to c2hs
7729
7730 --cpphs-options OPTS
7731 give extra options to cpphs
7732
7733 --doctest-options OPTS
7734 give extra options to doctest
7735
7736 --gcc-options OPTS
7737 give extra options to gcc
7738
7739 --ghc-options OPTS
7740 give extra options to ghc
7741
7742 --ghc-pkg-options OPTS
7743 give extra options to ghc-pkg
7744
7745 --ghcjs-options OPTS
7746 give extra options to ghcjs
7747
7748 --ghcjs-pkg-options OPTS
7749 give extra options to ghcjs-pkg
7750
7751 --greencard-options OPTS
7752 give extra options to greencard
7753
7754 --haddock-options OPTS
7755 give extra options to haddock
7756
7757 --happy-options OPTS
7758 give extra options to happy
7759
7760 --haskell-suite-options OPTS
7761 give extra options to haskell-suite
7762
7763 --haskell-suite-pkg-options OPTS
7764 give extra options to haskell-suite-pkg
7765
7766 --hmake-options OPTS
7767 give extra options to hmake
7768
7769 --hpc-options OPTS
7770 give extra options to hpc
7771
7772 --hsc2hs-options OPTS
7773 give extra options to hsc2hs
7774
7775 --hscolour-options OPTS
7776 give extra options to hscolour
7777
7778 --jhc-options OPTS
7779 give extra options to jhc
7780
7781 --ld-options OPTS
7782 give extra options to ld
7783
7784 --pkg-config-options OPTS
7785 give extra options to pkg-config
7786
7787 --runghc-options OPTS
7788 give extra options to runghc
7789
7790 --strip-options OPTS
7791 give extra options to strip
7792
7793 --tar-options OPTS
7794 give extra options to tar
7795
7796 --uhc-options OPTS
7797 give extra options to uhc
7798
7799 --cabal-lib-version VERSION
7800 Select which version of the Cabal lib to use to build
7801 packages (useful for testing).
7802
7803 --constraint CONSTRAINT
7804 Specify constraints on a package (version,
7805 installed/source, flags)
7806
7807 --preference CONSTRAINT
7808 Specify preferences (soft constraints) on the version of
7809 a package
7810
7811 --solver SOLVER
7812 Select dependency solver to use (default: modular).
7813 Choices: modular.
7814
7815 --allow-older [DEPS]
7816 Ignore lower bounds in all dependencies or DEPS
7817
7818 --allow-newer [DEPS]
7819 Ignore upper bounds in all dependencies or DEPS
7820
7821 --write-ghc-environment-files always|never|ghc8.4.4+
7822 Whether to create a .ghc.environment file after a suc‐
7823 cessful build (v2-build only)
7824
7825 --enable-documentation
7826 --disable-documentation
7827 building of documentation
7828
7829 --doc-index-file TEMPLATE
7830 A central index of haddock API documentation (template
7831 cannot use $pkgid)
7832
7833 --dry-run
7834 Do not install anything, only print what would be
7835 installed.
7836
7837 --max-backjumps NUM
7838 Maximum number of backjumps allowed while solving
7839 (default: 2000). Use a negative number to enable unlim‐
7840 ited backtracking. Use 0 to disable backtracking com‐
7841 pletely.
7842
7843 --reorder-goals
7844 --no-reorder-goals
7845 Try to reorder goals according to certain heuristics.
7846 Slows things down on average, but may make backtracking
7847 faster for some packages.
7848
7849 --count-conflicts
7850 --no-count-conflicts
7851 Try to speed up solving by preferring goals that are
7852 involved in a lot of conflicts (default).
7853
7854 --independent-goals
7855 --no-independent-goals
7856 Treat several goals on the command line as independent.
7857 If several goals depend on the same package, different
7858 versions can be chosen.
7859
7860 --shadow-installed-packages
7861 --no-shadow-installed-packages
7862 If multiple package instances of the same version are
7863 installed, treat all but one as shadowed.
7864
7865 --strong-flags
7866 --no-strong-flags
7867 Do not defer flag choices (this used to be the default in
7868 cabal-install <= 1.20).
7869
7870 --allow-boot-library-installs
7871 --no-allow-boot-library-installs
7872 Allow cabal to install base, ghc-prim, integer-simple,
7873 integer-gmp, and template-haskell.
7874
7875 --reinstall
7876 --no-reinstall
7877 Install even if it means installing the same version
7878 again.
7879
7880 --avoid-reinstalls
7881 --no-avoid-reinstalls
7882 Do not select versions that would destructively overwrite
7883 installed packages.
7884
7885 --force-reinstalls
7886 --no-force-reinstalls
7887 Reinstall packages even if they will most likely break
7888 other installed packages.
7889
7890 --upgrade-dependencies
7891 --no-upgrade-dependencies
7892 Pick the latest version for all dependencies, rather than
7893 trying to pick an installed version.
7894
7895 --only-dependencies
7896 --no-only-dependencies
7897 Install only the dependencies necessary to build the
7898 given packages
7899
7900 --dependencies-only
7901 --no-dependencies-only
7902 A synonym for --only-dependencies
7903
7904 --index-state STATE
7905 Use source package index state as it existed at a previ‐
7906 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
7907 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
7908 'HEAD' (default: 'HEAD').
7909
7910 --root-cmd COMMAND
7911 (No longer supported, do not use.)
7912
7913 --symlink-bindir DIR
7914 Add symlinks to installed executables into this direc‐
7915 tory.
7916
7917 --build-summary TEMPLATE
7918 Save build summaries to file (name template can use
7919 $pkgid, $compiler, $os, $arch)
7920
7921 --build-log TEMPLATE
7922 Log all builds to file (name template can use $pkgid,
7923 $compiler, $os, $arch)
7924
7925 --remote-build-reporting LEVEL
7926 Generate build reports to send to a remote server (none,
7927 anonymous or detailed).
7928
7929 --report-planning-failure
7930 Generate build reports when the dependency solver fails.
7931 This is used by the Hackage build bot.
7932
7933 --enable-per-component
7934 --disable-per-component
7935 Per-component builds when possible
7936
7937 --one-shot
7938 --no-one-shot
7939 Do not record the packages in the world file.
7940
7941 --run-tests
7942 Run package test suites during installation.
7943
7944 -j, --jobs [NUM]
7945 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
7946 given).
7947
7948 --keep-going
7949 After a build failure, continue to build other unaffected
7950 packages.
7951
7952 --offline
7953 --no-offline
7954 Don't download packages from the Internet.
7955
7956 --project-file FILE
7957 Set the name of the cabal.project file to search for in
7958 parent directories
7959
7960 --only
7961 Only installs the package in the current directory.
7962
7963 --haddock-hoogle
7964 Generate a hoogle database
7965
7966 --haddock-html
7967 Generate HTML documentation (the default)
7968
7969 --haddock-html-location URL
7970 Location of HTML documentation for pre-requisite packages
7971
7972 --haddock-for-hackage
7973 Collection of flags to generate documentation suitable
7974 for upload to hackage
7975
7976 --haddock-executables
7977 Run haddock for Executables targets
7978
7979 --haddock-tests
7980 Run haddock for Test Suite targets
7981
7982 --haddock-benchmarks
7983 Run haddock for Benchmark targets
7984
7985 --haddock-all
7986 Run haddock for all targets
7987
7988 --haddock-internal
7989 Run haddock for internal modules and include all symbols
7990
7991 --haddock-css PATH
7992 Use PATH as the haddock stylesheet
7993
7994 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
7995 dock-hyperlinked-source
7996 Hyperlink the documentation to the source code
7997
7998 --haddock-quickjump
7999 Generate an index for interactive documentation naviga‐
8000 tion
8001
8002 --haddock-hscolour-css PATH
8003 Use PATH as the HsColour stylesheet
8004
8005 --haddock-contents-location URL
8006 Bake URL in as the location for the contents page
8007
8008
8009 cabal v2-haddock
8010
8011 Usage: cabal v2-haddock [FLAGS] TARGET
8012
8013
8014 Build Haddock documentation for the specified packages within the
8015 project.
8016
8017 Any package in the project can be specified. If no package is speci‐
8018 fied, the default is to build the documentation for the package in the
8019 current directory. The default behaviour is to build documentation for
8020 the exposed modules of the library component (if any). This can be
8021 changed with the
8022
8023 Currently, documentation for dependencies is NOT built. This behavior
8024 may change in future.
8025
8026 Additional configuration flags can be specified on the command line and
8027 these extend the project configuration from the 'cabal.project',
8028
8029
8030 Build Haddock documentation for the specified packages within the
8031 project.
8032
8033 Any package in the project can be specified. If no package is speci‐
8034 fied, the default is to build the documentation for the package in the
8035 current directory. The default behaviour is to build documentation for
8036 the exposed modules of the library component (if any). This can be
8037 changed with the
8038
8039 Currently, documentation for dependencies is NOT built. This behavior
8040 may change in future.
8041
8042 Additional configuration flags can be specified on the command line and
8043 these extend the project configuration from the 'cabal.project',
8044
8045
8046 Flags:
8047 -v, --verbose [n]
8048 Control verbosity (n is 0--3, default verbosity level is
8049 1)
8050
8051 --builddir, --distdir, --distpref DIR
8052 The directory where Cabal puts generated build files
8053 (default dist)
8054
8055 -g, --ghc
8056 compile with GHC
8057
8058 --ghcjs
8059 compile with GHCJS
8060
8061 --uhc
8062 compile with UHC
8063
8064 --haskell-suite
8065 compile with a haskell-suite compiler
8066
8067 --cabal-file PATH
8068 use this Cabal file
8069
8070 -w, --with-compiler PATH
8071 give the path to a particular compiler
8072
8073 --with-hc-pkg PATH
8074 give the path to the package tool
8075
8076 --prefix DIR
8077 bake this prefix in preparation of installation
8078
8079 --bindir DIR
8080 installation directory for executables
8081
8082 --libdir DIR
8083 installation directory for libraries
8084
8085 --libsubdir DIR
8086 subdirectory of libdir in which libs are installed
8087
8088 --dynlibdir DIR
8089 installation directory for dynamic libraries
8090
8091 --libexecdir DIR
8092 installation directory for program executables
8093
8094 --libexecsubdir DIR
8095 subdirectory of libexecdir in which private executables
8096 are installed
8097
8098 --datadir DIR
8099 installation directory for read-only data
8100
8101 --datasubdir DIR
8102 subdirectory of datadir in which data files are installed
8103
8104 --docdir DIR
8105 installation directory for documentation
8106
8107 --htmldir DIR
8108 installation directory for HTML documentation
8109
8110 --haddockdir DIR
8111 installation directory for haddock interfaces
8112
8113 --sysconfdir DIR
8114 installation directory for configuration files
8115
8116 --program-prefix PREFIX
8117 prefix to be applied to installed executables
8118
8119 --program-suffix SUFFIX
8120 suffix to be applied to installed executables
8121
8122 --enable-library-vanilla
8123 --disable-library-vanilla
8124 Vanilla libraries
8125
8126 -p, --enable-library-profiling
8127 --disable-library-profiling
8128 Library profiling
8129
8130 --enable-shared
8131 --disable-shared
8132 Shared library
8133
8134 --enable-static
8135 --disable-static
8136 Static library
8137
8138 --enable-executable-dynamic
8139 --disable-executable-dynamic
8140 Executable dynamic linking
8141
8142 --enable-profiling
8143 --disable-profiling
8144 Executable and library profiling
8145
8146 --enable-executable-profiling
8147 --disable-executable-profiling
8148 Executable profiling (DEPRECATED)
8149
8150 --profiling-detail level
8151 Profiling detail level for executable and library
8152 (default, none, exported-functions, toplevel-functions,
8153 all-functions).
8154
8155 --library-profiling-detail level
8156 Profiling detail level for libraries only.
8157
8158 -O, --enable-optimization, --enable-optimisation [n]
8159 Build with optimization (n is 0--2, default is 1)
8160
8161 --disable-optimization, --disable-optimisation
8162 Build without optimization
8163
8164 --enable-debug-info [n]
8165 Emit debug info (n is 0--3, default is 0)
8166
8167 --disable-debug-info
8168 Don't emit debug info
8169
8170 --enable-library-for-ghci
8171 --disable-library-for-ghci
8172 compile library for use with GHCi
8173
8174 --enable-split-sections
8175 --disable-split-sections
8176 compile library code such that unneeded definitions can
8177 be dropped from the final executable (GHC 7.8+)
8178
8179 --enable-split-objs
8180 --disable-split-objs
8181 split library into smaller objects to reduce binary sizes
8182 (GHC 6.6+)
8183
8184 --enable-executable-stripping
8185 --disable-executable-stripping
8186 strip executables upon installation to reduce binary
8187 sizes
8188
8189 --enable-library-stripping
8190 --disable-library-stripping
8191 strip libraries upon installation to reduce binary sizes
8192
8193 --configure-option OPT
8194 Extra option for configure
8195
8196 --user
8197 --global
8198 doing a per-user installation
8199
8200 --package-db DB
8201 Append the given package database to the list of package
8202 databases used (to satisfy dependencies and register
8203 into). May be a specific file, 'global' or 'user'. The
8204 initial list is ['global'], ['global', 'user'], or
8205 ['global', $sandbox], depending on context. Use 'clear'
8206 to reset the list to empty. See the user guide for
8207 details.
8208
8209 -f, --flags FLAGS
8210 Force values for the given flags in Cabal conditionals in
8211 the .cabal file. E.g., --flags="debug -usebytestrings"
8212 forces the flag "debug" to true and "usebytestrings" to
8213 false.
8214
8215 --extra-include-dirs PATH
8216 A list of directories to search for header files
8217
8218 --enable-deterministic
8219 --disable-deterministic
8220 Try to be as deterministic as possible (used by the test
8221 suite)
8222
8223 --ipid IPID
8224 Installed package ID to compile this package as
8225
8226 --cid CID
8227 Installed component ID to compile this component as
8228
8229 --extra-lib-dirs PATH
8230 A list of directories to search for external libraries
8231
8232 --extra-framework-dirs PATH
8233 A list of directories to search for external frameworks
8234 (OS X only)
8235
8236 --extra-prog-path PATH
8237 A list of directories to search for required programs (in
8238 addition to the normal search locations)
8239
8240 --instantiate-with NAME=MOD
8241 A mapping of signature names to concrete module instanti‐
8242 ations.
8243
8244 --enable-tests
8245 --disable-tests
8246 dependency checking and compilation for test suites
8247 listed in the package description file.
8248
8249 --enable-coverage
8250 --disable-coverage
8251 build package with Haskell Program Coverage. (GHC only)
8252
8253 --enable-library-coverage
8254 --disable-library-coverage
8255 build package with Haskell Program Coverage. (GHC only)
8256 (DEPRECATED)
8257
8258 --enable-benchmarks
8259 --disable-benchmarks
8260 dependency checking and compilation for benchmarks listed
8261 in the package description file.
8262
8263 --enable-relocatable
8264 --disable-relocatable
8265 building a package that is relocatable. (GHC only)
8266
8267 --disable-response-files
8268 enable workaround for old versions of programs like "ar"
8269 that do not support @file arguments
8270
8271 --with-alex PATH
8272 give the path to alex
8273
8274 --with-ar PATH
8275 give the path to ar
8276
8277 --with-c2hs PATH
8278 give the path to c2hs
8279
8280 --with-cpphs PATH
8281 give the path to cpphs
8282
8283 --with-doctest PATH
8284 give the path to doctest
8285
8286 --with-gcc PATH
8287 give the path to gcc
8288
8289 --with-ghc PATH
8290 give the path to ghc
8291
8292 --with-ghc-pkg PATH
8293 give the path to ghc-pkg
8294
8295 --with-ghcjs PATH
8296 give the path to ghcjs
8297
8298 --with-ghcjs-pkg PATH
8299 give the path to ghcjs-pkg
8300
8301 --with-greencard PATH
8302 give the path to greencard
8303
8304 --with-haddock PATH
8305 give the path to haddock
8306
8307 --with-happy PATH
8308 give the path to happy
8309
8310 --with-haskell-suite PATH
8311 give the path to haskell-suite
8312
8313 --with-haskell-suite-pkg PATH
8314 give the path to haskell-suite-pkg
8315
8316 --with-hmake PATH
8317 give the path to hmake
8318
8319 --with-hpc PATH
8320 give the path to hpc
8321
8322 --with-hsc2hs PATH
8323 give the path to hsc2hs
8324
8325 --with-hscolour PATH
8326 give the path to hscolour
8327
8328 --with-jhc PATH
8329 give the path to jhc
8330
8331 --with-ld PATH
8332 give the path to ld
8333
8334 --with-pkg-config PATH
8335 give the path to pkg-config
8336
8337 --with-runghc PATH
8338 give the path to runghc
8339
8340 --with-strip PATH
8341 give the path to strip
8342
8343 --with-tar PATH
8344 give the path to tar
8345
8346 --with-uhc PATH
8347 give the path to uhc
8348
8349 --alex-option OPT
8350 give an extra option to alex (no need to quote options
8351 containing spaces)
8352
8353 --ar-option OPT
8354 give an extra option to ar (no need to quote options con‐
8355 taining spaces)
8356
8357 --c2hs-option OPT
8358 give an extra option to c2hs (no need to quote options
8359 containing spaces)
8360
8361 --cpphs-option OPT
8362 give an extra option to cpphs (no need to quote options
8363 containing spaces)
8364
8365 --doctest-option OPT
8366 give an extra option to doctest (no need to quote options
8367 containing spaces)
8368
8369 --gcc-option OPT
8370 give an extra option to gcc (no need to quote options
8371 containing spaces)
8372
8373 --ghc-option OPT
8374 give an extra option to ghc (no need to quote options
8375 containing spaces)
8376
8377 --ghc-pkg-option OPT
8378 give an extra option to ghc-pkg (no need to quote options
8379 containing spaces)
8380
8381 --ghcjs-option OPT
8382 give an extra option to ghcjs (no need to quote options
8383 containing spaces)
8384
8385 --ghcjs-pkg-option OPT
8386 give an extra option to ghcjs-pkg (no need to quote
8387 options containing spaces)
8388
8389 --greencard-option OPT
8390 give an extra option to greencard (no need to quote
8391 options containing spaces)
8392
8393 --haddock-option OPT
8394 give an extra option to haddock (no need to quote options
8395 containing spaces)
8396
8397 --happy-option OPT
8398 give an extra option to happy (no need to quote options
8399 containing spaces)
8400
8401 --haskell-suite-option OPT
8402 give an extra option to haskell-suite (no need to quote
8403 options containing spaces)
8404
8405 --haskell-suite-pkg-option OPT
8406 give an extra option to haskell-suite-pkg (no need to
8407 quote options containing spaces)
8408
8409 --hmake-option OPT
8410 give an extra option to hmake (no need to quote options
8411 containing spaces)
8412
8413 --hpc-option OPT
8414 give an extra option to hpc (no need to quote options
8415 containing spaces)
8416
8417 --hsc2hs-option OPT
8418 give an extra option to hsc2hs (no need to quote options
8419 containing spaces)
8420
8421 --hscolour-option OPT
8422 give an extra option to hscolour (no need to quote
8423 options containing spaces)
8424
8425 --jhc-option OPT
8426 give an extra option to jhc (no need to quote options
8427 containing spaces)
8428
8429 --ld-option OPT
8430 give an extra option to ld (no need to quote options con‐
8431 taining spaces)
8432
8433 --pkg-config-option OPT
8434 give an extra option to pkg-config (no need to quote
8435 options containing spaces)
8436
8437 --runghc-option OPT
8438 give an extra option to runghc (no need to quote options
8439 containing spaces)
8440
8441 --strip-option OPT
8442 give an extra option to strip (no need to quote options
8443 containing spaces)
8444
8445 --tar-option OPT
8446 give an extra option to tar (no need to quote options
8447 containing spaces)
8448
8449 --uhc-option OPT
8450 give an extra option to uhc (no need to quote options
8451 containing spaces)
8452
8453 --alex-options OPTS
8454 give extra options to alex
8455
8456 --ar-options OPTS
8457 give extra options to ar
8458
8459 --c2hs-options OPTS
8460 give extra options to c2hs
8461
8462 --cpphs-options OPTS
8463 give extra options to cpphs
8464
8465 --doctest-options OPTS
8466 give extra options to doctest
8467
8468 --gcc-options OPTS
8469 give extra options to gcc
8470
8471 --ghc-options OPTS
8472 give extra options to ghc
8473
8474 --ghc-pkg-options OPTS
8475 give extra options to ghc-pkg
8476
8477 --ghcjs-options OPTS
8478 give extra options to ghcjs
8479
8480 --ghcjs-pkg-options OPTS
8481 give extra options to ghcjs-pkg
8482
8483 --greencard-options OPTS
8484 give extra options to greencard
8485
8486 --haddock-options OPTS
8487 give extra options to haddock
8488
8489 --happy-options OPTS
8490 give extra options to happy
8491
8492 --haskell-suite-options OPTS
8493 give extra options to haskell-suite
8494
8495 --haskell-suite-pkg-options OPTS
8496 give extra options to haskell-suite-pkg
8497
8498 --hmake-options OPTS
8499 give extra options to hmake
8500
8501 --hpc-options OPTS
8502 give extra options to hpc
8503
8504 --hsc2hs-options OPTS
8505 give extra options to hsc2hs
8506
8507 --hscolour-options OPTS
8508 give extra options to hscolour
8509
8510 --jhc-options OPTS
8511 give extra options to jhc
8512
8513 --ld-options OPTS
8514 give extra options to ld
8515
8516 --pkg-config-options OPTS
8517 give extra options to pkg-config
8518
8519 --runghc-options OPTS
8520 give extra options to runghc
8521
8522 --strip-options OPTS
8523 give extra options to strip
8524
8525 --tar-options OPTS
8526 give extra options to tar
8527
8528 --uhc-options OPTS
8529 give extra options to uhc
8530
8531 --cabal-lib-version VERSION
8532 Select which version of the Cabal lib to use to build
8533 packages (useful for testing).
8534
8535 --constraint CONSTRAINT
8536 Specify constraints on a package (version,
8537 installed/source, flags)
8538
8539 --preference CONSTRAINT
8540 Specify preferences (soft constraints) on the version of
8541 a package
8542
8543 --solver SOLVER
8544 Select dependency solver to use (default: modular).
8545 Choices: modular.
8546
8547 --allow-older [DEPS]
8548 Ignore lower bounds in all dependencies or DEPS
8549
8550 --allow-newer [DEPS]
8551 Ignore upper bounds in all dependencies or DEPS
8552
8553 --write-ghc-environment-files always|never|ghc8.4.4+
8554 Whether to create a .ghc.environment file after a suc‐
8555 cessful build (v2-build only)
8556
8557 --enable-documentation
8558 --disable-documentation
8559 building of documentation
8560
8561 --doc-index-file TEMPLATE
8562 A central index of haddock API documentation (template
8563 cannot use $pkgid)
8564
8565 --dry-run
8566 Do not install anything, only print what would be
8567 installed.
8568
8569 --max-backjumps NUM
8570 Maximum number of backjumps allowed while solving
8571 (default: 2000). Use a negative number to enable unlim‐
8572 ited backtracking. Use 0 to disable backtracking com‐
8573 pletely.
8574
8575 --reorder-goals
8576 --no-reorder-goals
8577 Try to reorder goals according to certain heuristics.
8578 Slows things down on average, but may make backtracking
8579 faster for some packages.
8580
8581 --count-conflicts
8582 --no-count-conflicts
8583 Try to speed up solving by preferring goals that are
8584 involved in a lot of conflicts (default).
8585
8586 --independent-goals
8587 --no-independent-goals
8588 Treat several goals on the command line as independent.
8589 If several goals depend on the same package, different
8590 versions can be chosen.
8591
8592 --shadow-installed-packages
8593 --no-shadow-installed-packages
8594 If multiple package instances of the same version are
8595 installed, treat all but one as shadowed.
8596
8597 --strong-flags
8598 --no-strong-flags
8599 Do not defer flag choices (this used to be the default in
8600 cabal-install <= 1.20).
8601
8602 --allow-boot-library-installs
8603 --no-allow-boot-library-installs
8604 Allow cabal to install base, ghc-prim, integer-simple,
8605 integer-gmp, and template-haskell.
8606
8607 --reinstall
8608 --no-reinstall
8609 Install even if it means installing the same version
8610 again.
8611
8612 --avoid-reinstalls
8613 --no-avoid-reinstalls
8614 Do not select versions that would destructively overwrite
8615 installed packages.
8616
8617 --force-reinstalls
8618 --no-force-reinstalls
8619 Reinstall packages even if they will most likely break
8620 other installed packages.
8621
8622 --upgrade-dependencies
8623 --no-upgrade-dependencies
8624 Pick the latest version for all dependencies, rather than
8625 trying to pick an installed version.
8626
8627 --only-dependencies
8628 --no-only-dependencies
8629 Install only the dependencies necessary to build the
8630 given packages
8631
8632 --dependencies-only
8633 --no-dependencies-only
8634 A synonym for --only-dependencies
8635
8636 --index-state STATE
8637 Use source package index state as it existed at a previ‐
8638 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
8639 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
8640 'HEAD' (default: 'HEAD').
8641
8642 --root-cmd COMMAND
8643 (No longer supported, do not use.)
8644
8645 --symlink-bindir DIR
8646 Add symlinks to installed executables into this direc‐
8647 tory.
8648
8649 --build-summary TEMPLATE
8650 Save build summaries to file (name template can use
8651 $pkgid, $compiler, $os, $arch)
8652
8653 --build-log TEMPLATE
8654 Log all builds to file (name template can use $pkgid,
8655 $compiler, $os, $arch)
8656
8657 --remote-build-reporting LEVEL
8658 Generate build reports to send to a remote server (none,
8659 anonymous or detailed).
8660
8661 --report-planning-failure
8662 Generate build reports when the dependency solver fails.
8663 This is used by the Hackage build bot.
8664
8665 --enable-per-component
8666 --disable-per-component
8667 Per-component builds when possible
8668
8669 --one-shot
8670 --no-one-shot
8671 Do not record the packages in the world file.
8672
8673 --run-tests
8674 Run package test suites during installation.
8675
8676 -j, --jobs [NUM]
8677 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
8678 given).
8679
8680 --keep-going
8681 After a build failure, continue to build other unaffected
8682 packages.
8683
8684 --offline
8685 --no-offline
8686 Don't download packages from the Internet.
8687
8688 --project-file FILE
8689 Set the name of the cabal.project file to search for in
8690 parent directories
8691
8692 --only
8693 Only installs the package in the current directory.
8694
8695 --haddock-hoogle
8696 Generate a hoogle database
8697
8698 --haddock-html
8699 Generate HTML documentation (the default)
8700
8701 --haddock-html-location URL
8702 Location of HTML documentation for pre-requisite packages
8703
8704 --haddock-for-hackage
8705 Collection of flags to generate documentation suitable
8706 for upload to hackage
8707
8708 --haddock-executables
8709 Run haddock for Executables targets
8710
8711 --haddock-tests
8712 Run haddock for Test Suite targets
8713
8714 --haddock-benchmarks
8715 Run haddock for Benchmark targets
8716
8717 --haddock-all
8718 Run haddock for all targets
8719
8720 --haddock-internal
8721 Run haddock for internal modules and include all symbols
8722
8723 --haddock-css PATH
8724 Use PATH as the haddock stylesheet
8725
8726 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
8727 dock-hyperlinked-source
8728 Hyperlink the documentation to the source code
8729
8730 --haddock-quickjump
8731 Generate an index for interactive documentation naviga‐
8732 tion
8733
8734 --haddock-hscolour-css PATH
8735 Use PATH as the HsColour stylesheet
8736
8737 --haddock-contents-location URL
8738 Bake URL in as the location for the contents page
8739
8740
8741 cabal new-haddock
8742
8743 Usage: cabal new-haddock [FLAGS] TARGET
8744
8745
8746 Build Haddock documentation for the specified packages within the
8747 project.
8748
8749 Any package in the project can be specified. If no package is speci‐
8750 fied, the default is to build the documentation for the package in the
8751 current directory. The default behaviour is to build documentation for
8752 the exposed modules of the library component (if any). This can be
8753 changed with the
8754
8755 Currently, documentation for dependencies is NOT built. This behavior
8756 may change in future.
8757
8758 Additional configuration flags can be specified on the command line and
8759 these extend the project configuration from the 'cabal.project',
8760
8761
8762 Examples:
8763 cabal new-haddock pkgname Build documentation for the package
8764 named pkgname
8765
8766 Note: this command is part of the new project-based system (aka nix-
8767 style local builds). These features are currently in beta. Please see
8768 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
8769 details and advice on what you can expect to work. If you encounter
8770 problems please file issues at https://github.com/haskell/cabal/issues
8771 and if you have any time to get involved and help with testing, fixing
8772 bugs etc then that is very much appreciated.
8773
8774
8775 Flags:
8776 -v, --verbose [n]
8777 Control verbosity (n is 0--3, default verbosity level is
8778 1)
8779
8780 --builddir, --distdir, --distpref DIR
8781 The directory where Cabal puts generated build files
8782 (default dist)
8783
8784 -g, --ghc
8785 compile with GHC
8786
8787 --ghcjs
8788 compile with GHCJS
8789
8790 --uhc
8791 compile with UHC
8792
8793 --haskell-suite
8794 compile with a haskell-suite compiler
8795
8796 --cabal-file PATH
8797 use this Cabal file
8798
8799 -w, --with-compiler PATH
8800 give the path to a particular compiler
8801
8802 --with-hc-pkg PATH
8803 give the path to the package tool
8804
8805 --prefix DIR
8806 bake this prefix in preparation of installation
8807
8808 --bindir DIR
8809 installation directory for executables
8810
8811 --libdir DIR
8812 installation directory for libraries
8813
8814 --libsubdir DIR
8815 subdirectory of libdir in which libs are installed
8816
8817 --dynlibdir DIR
8818 installation directory for dynamic libraries
8819
8820 --libexecdir DIR
8821 installation directory for program executables
8822
8823 --libexecsubdir DIR
8824 subdirectory of libexecdir in which private executables
8825 are installed
8826
8827 --datadir DIR
8828 installation directory for read-only data
8829
8830 --datasubdir DIR
8831 subdirectory of datadir in which data files are installed
8832
8833 --docdir DIR
8834 installation directory for documentation
8835
8836 --htmldir DIR
8837 installation directory for HTML documentation
8838
8839 --haddockdir DIR
8840 installation directory for haddock interfaces
8841
8842 --sysconfdir DIR
8843 installation directory for configuration files
8844
8845 --program-prefix PREFIX
8846 prefix to be applied to installed executables
8847
8848 --program-suffix SUFFIX
8849 suffix to be applied to installed executables
8850
8851 --enable-library-vanilla
8852 --disable-library-vanilla
8853 Vanilla libraries
8854
8855 -p, --enable-library-profiling
8856 --disable-library-profiling
8857 Library profiling
8858
8859 --enable-shared
8860 --disable-shared
8861 Shared library
8862
8863 --enable-static
8864 --disable-static
8865 Static library
8866
8867 --enable-executable-dynamic
8868 --disable-executable-dynamic
8869 Executable dynamic linking
8870
8871 --enable-profiling
8872 --disable-profiling
8873 Executable and library profiling
8874
8875 --enable-executable-profiling
8876 --disable-executable-profiling
8877 Executable profiling (DEPRECATED)
8878
8879 --profiling-detail level
8880 Profiling detail level for executable and library
8881 (default, none, exported-functions, toplevel-functions,
8882 all-functions).
8883
8884 --library-profiling-detail level
8885 Profiling detail level for libraries only.
8886
8887 -O, --enable-optimization, --enable-optimisation [n]
8888 Build with optimization (n is 0--2, default is 1)
8889
8890 --disable-optimization, --disable-optimisation
8891 Build without optimization
8892
8893 --enable-debug-info [n]
8894 Emit debug info (n is 0--3, default is 0)
8895
8896 --disable-debug-info
8897 Don't emit debug info
8898
8899 --enable-library-for-ghci
8900 --disable-library-for-ghci
8901 compile library for use with GHCi
8902
8903 --enable-split-sections
8904 --disable-split-sections
8905 compile library code such that unneeded definitions can
8906 be dropped from the final executable (GHC 7.8+)
8907
8908 --enable-split-objs
8909 --disable-split-objs
8910 split library into smaller objects to reduce binary sizes
8911 (GHC 6.6+)
8912
8913 --enable-executable-stripping
8914 --disable-executable-stripping
8915 strip executables upon installation to reduce binary
8916 sizes
8917
8918 --enable-library-stripping
8919 --disable-library-stripping
8920 strip libraries upon installation to reduce binary sizes
8921
8922 --configure-option OPT
8923 Extra option for configure
8924
8925 --user
8926 --global
8927 doing a per-user installation
8928
8929 --package-db DB
8930 Append the given package database to the list of package
8931 databases used (to satisfy dependencies and register
8932 into). May be a specific file, 'global' or 'user'. The
8933 initial list is ['global'], ['global', 'user'], or
8934 ['global', $sandbox], depending on context. Use 'clear'
8935 to reset the list to empty. See the user guide for
8936 details.
8937
8938 -f, --flags FLAGS
8939 Force values for the given flags in Cabal conditionals in
8940 the .cabal file. E.g., --flags="debug -usebytestrings"
8941 forces the flag "debug" to true and "usebytestrings" to
8942 false.
8943
8944 --extra-include-dirs PATH
8945 A list of directories to search for header files
8946
8947 --enable-deterministic
8948 --disable-deterministic
8949 Try to be as deterministic as possible (used by the test
8950 suite)
8951
8952 --ipid IPID
8953 Installed package ID to compile this package as
8954
8955 --cid CID
8956 Installed component ID to compile this component as
8957
8958 --extra-lib-dirs PATH
8959 A list of directories to search for external libraries
8960
8961 --extra-framework-dirs PATH
8962 A list of directories to search for external frameworks
8963 (OS X only)
8964
8965 --extra-prog-path PATH
8966 A list of directories to search for required programs (in
8967 addition to the normal search locations)
8968
8969 --instantiate-with NAME=MOD
8970 A mapping of signature names to concrete module instanti‐
8971 ations.
8972
8973 --enable-tests
8974 --disable-tests
8975 dependency checking and compilation for test suites
8976 listed in the package description file.
8977
8978 --enable-coverage
8979 --disable-coverage
8980 build package with Haskell Program Coverage. (GHC only)
8981
8982 --enable-library-coverage
8983 --disable-library-coverage
8984 build package with Haskell Program Coverage. (GHC only)
8985 (DEPRECATED)
8986
8987 --enable-benchmarks
8988 --disable-benchmarks
8989 dependency checking and compilation for benchmarks listed
8990 in the package description file.
8991
8992 --enable-relocatable
8993 --disable-relocatable
8994 building a package that is relocatable. (GHC only)
8995
8996 --disable-response-files
8997 enable workaround for old versions of programs like "ar"
8998 that do not support @file arguments
8999
9000 --with-alex PATH
9001 give the path to alex
9002
9003 --with-ar PATH
9004 give the path to ar
9005
9006 --with-c2hs PATH
9007 give the path to c2hs
9008
9009 --with-cpphs PATH
9010 give the path to cpphs
9011
9012 --with-doctest PATH
9013 give the path to doctest
9014
9015 --with-gcc PATH
9016 give the path to gcc
9017
9018 --with-ghc PATH
9019 give the path to ghc
9020
9021 --with-ghc-pkg PATH
9022 give the path to ghc-pkg
9023
9024 --with-ghcjs PATH
9025 give the path to ghcjs
9026
9027 --with-ghcjs-pkg PATH
9028 give the path to ghcjs-pkg
9029
9030 --with-greencard PATH
9031 give the path to greencard
9032
9033 --with-haddock PATH
9034 give the path to haddock
9035
9036 --with-happy PATH
9037 give the path to happy
9038
9039 --with-haskell-suite PATH
9040 give the path to haskell-suite
9041
9042 --with-haskell-suite-pkg PATH
9043 give the path to haskell-suite-pkg
9044
9045 --with-hmake PATH
9046 give the path to hmake
9047
9048 --with-hpc PATH
9049 give the path to hpc
9050
9051 --with-hsc2hs PATH
9052 give the path to hsc2hs
9053
9054 --with-hscolour PATH
9055 give the path to hscolour
9056
9057 --with-jhc PATH
9058 give the path to jhc
9059
9060 --with-ld PATH
9061 give the path to ld
9062
9063 --with-pkg-config PATH
9064 give the path to pkg-config
9065
9066 --with-runghc PATH
9067 give the path to runghc
9068
9069 --with-strip PATH
9070 give the path to strip
9071
9072 --with-tar PATH
9073 give the path to tar
9074
9075 --with-uhc PATH
9076 give the path to uhc
9077
9078 --alex-option OPT
9079 give an extra option to alex (no need to quote options
9080 containing spaces)
9081
9082 --ar-option OPT
9083 give an extra option to ar (no need to quote options con‐
9084 taining spaces)
9085
9086 --c2hs-option OPT
9087 give an extra option to c2hs (no need to quote options
9088 containing spaces)
9089
9090 --cpphs-option OPT
9091 give an extra option to cpphs (no need to quote options
9092 containing spaces)
9093
9094 --doctest-option OPT
9095 give an extra option to doctest (no need to quote options
9096 containing spaces)
9097
9098 --gcc-option OPT
9099 give an extra option to gcc (no need to quote options
9100 containing spaces)
9101
9102 --ghc-option OPT
9103 give an extra option to ghc (no need to quote options
9104 containing spaces)
9105
9106 --ghc-pkg-option OPT
9107 give an extra option to ghc-pkg (no need to quote options
9108 containing spaces)
9109
9110 --ghcjs-option OPT
9111 give an extra option to ghcjs (no need to quote options
9112 containing spaces)
9113
9114 --ghcjs-pkg-option OPT
9115 give an extra option to ghcjs-pkg (no need to quote
9116 options containing spaces)
9117
9118 --greencard-option OPT
9119 give an extra option to greencard (no need to quote
9120 options containing spaces)
9121
9122 --haddock-option OPT
9123 give an extra option to haddock (no need to quote options
9124 containing spaces)
9125
9126 --happy-option OPT
9127 give an extra option to happy (no need to quote options
9128 containing spaces)
9129
9130 --haskell-suite-option OPT
9131 give an extra option to haskell-suite (no need to quote
9132 options containing spaces)
9133
9134 --haskell-suite-pkg-option OPT
9135 give an extra option to haskell-suite-pkg (no need to
9136 quote options containing spaces)
9137
9138 --hmake-option OPT
9139 give an extra option to hmake (no need to quote options
9140 containing spaces)
9141
9142 --hpc-option OPT
9143 give an extra option to hpc (no need to quote options
9144 containing spaces)
9145
9146 --hsc2hs-option OPT
9147 give an extra option to hsc2hs (no need to quote options
9148 containing spaces)
9149
9150 --hscolour-option OPT
9151 give an extra option to hscolour (no need to quote
9152 options containing spaces)
9153
9154 --jhc-option OPT
9155 give an extra option to jhc (no need to quote options
9156 containing spaces)
9157
9158 --ld-option OPT
9159 give an extra option to ld (no need to quote options con‐
9160 taining spaces)
9161
9162 --pkg-config-option OPT
9163 give an extra option to pkg-config (no need to quote
9164 options containing spaces)
9165
9166 --runghc-option OPT
9167 give an extra option to runghc (no need to quote options
9168 containing spaces)
9169
9170 --strip-option OPT
9171 give an extra option to strip (no need to quote options
9172 containing spaces)
9173
9174 --tar-option OPT
9175 give an extra option to tar (no need to quote options
9176 containing spaces)
9177
9178 --uhc-option OPT
9179 give an extra option to uhc (no need to quote options
9180 containing spaces)
9181
9182 --alex-options OPTS
9183 give extra options to alex
9184
9185 --ar-options OPTS
9186 give extra options to ar
9187
9188 --c2hs-options OPTS
9189 give extra options to c2hs
9190
9191 --cpphs-options OPTS
9192 give extra options to cpphs
9193
9194 --doctest-options OPTS
9195 give extra options to doctest
9196
9197 --gcc-options OPTS
9198 give extra options to gcc
9199
9200 --ghc-options OPTS
9201 give extra options to ghc
9202
9203 --ghc-pkg-options OPTS
9204 give extra options to ghc-pkg
9205
9206 --ghcjs-options OPTS
9207 give extra options to ghcjs
9208
9209 --ghcjs-pkg-options OPTS
9210 give extra options to ghcjs-pkg
9211
9212 --greencard-options OPTS
9213 give extra options to greencard
9214
9215 --haddock-options OPTS
9216 give extra options to haddock
9217
9218 --happy-options OPTS
9219 give extra options to happy
9220
9221 --haskell-suite-options OPTS
9222 give extra options to haskell-suite
9223
9224 --haskell-suite-pkg-options OPTS
9225 give extra options to haskell-suite-pkg
9226
9227 --hmake-options OPTS
9228 give extra options to hmake
9229
9230 --hpc-options OPTS
9231 give extra options to hpc
9232
9233 --hsc2hs-options OPTS
9234 give extra options to hsc2hs
9235
9236 --hscolour-options OPTS
9237 give extra options to hscolour
9238
9239 --jhc-options OPTS
9240 give extra options to jhc
9241
9242 --ld-options OPTS
9243 give extra options to ld
9244
9245 --pkg-config-options OPTS
9246 give extra options to pkg-config
9247
9248 --runghc-options OPTS
9249 give extra options to runghc
9250
9251 --strip-options OPTS
9252 give extra options to strip
9253
9254 --tar-options OPTS
9255 give extra options to tar
9256
9257 --uhc-options OPTS
9258 give extra options to uhc
9259
9260 --cabal-lib-version VERSION
9261 Select which version of the Cabal lib to use to build
9262 packages (useful for testing).
9263
9264 --constraint CONSTRAINT
9265 Specify constraints on a package (version,
9266 installed/source, flags)
9267
9268 --preference CONSTRAINT
9269 Specify preferences (soft constraints) on the version of
9270 a package
9271
9272 --solver SOLVER
9273 Select dependency solver to use (default: modular).
9274 Choices: modular.
9275
9276 --allow-older [DEPS]
9277 Ignore lower bounds in all dependencies or DEPS
9278
9279 --allow-newer [DEPS]
9280 Ignore upper bounds in all dependencies or DEPS
9281
9282 --write-ghc-environment-files always|never|ghc8.4.4+
9283 Whether to create a .ghc.environment file after a suc‐
9284 cessful build (v2-build only)
9285
9286 --enable-documentation
9287 --disable-documentation
9288 building of documentation
9289
9290 --doc-index-file TEMPLATE
9291 A central index of haddock API documentation (template
9292 cannot use $pkgid)
9293
9294 --dry-run
9295 Do not install anything, only print what would be
9296 installed.
9297
9298 --max-backjumps NUM
9299 Maximum number of backjumps allowed while solving
9300 (default: 2000). Use a negative number to enable unlim‐
9301 ited backtracking. Use 0 to disable backtracking com‐
9302 pletely.
9303
9304 --reorder-goals
9305 --no-reorder-goals
9306 Try to reorder goals according to certain heuristics.
9307 Slows things down on average, but may make backtracking
9308 faster for some packages.
9309
9310 --count-conflicts
9311 --no-count-conflicts
9312 Try to speed up solving by preferring goals that are
9313 involved in a lot of conflicts (default).
9314
9315 --independent-goals
9316 --no-independent-goals
9317 Treat several goals on the command line as independent.
9318 If several goals depend on the same package, different
9319 versions can be chosen.
9320
9321 --shadow-installed-packages
9322 --no-shadow-installed-packages
9323 If multiple package instances of the same version are
9324 installed, treat all but one as shadowed.
9325
9326 --strong-flags
9327 --no-strong-flags
9328 Do not defer flag choices (this used to be the default in
9329 cabal-install <= 1.20).
9330
9331 --allow-boot-library-installs
9332 --no-allow-boot-library-installs
9333 Allow cabal to install base, ghc-prim, integer-simple,
9334 integer-gmp, and template-haskell.
9335
9336 --reinstall
9337 --no-reinstall
9338 Install even if it means installing the same version
9339 again.
9340
9341 --avoid-reinstalls
9342 --no-avoid-reinstalls
9343 Do not select versions that would destructively overwrite
9344 installed packages.
9345
9346 --force-reinstalls
9347 --no-force-reinstalls
9348 Reinstall packages even if they will most likely break
9349 other installed packages.
9350
9351 --upgrade-dependencies
9352 --no-upgrade-dependencies
9353 Pick the latest version for all dependencies, rather than
9354 trying to pick an installed version.
9355
9356 --only-dependencies
9357 --no-only-dependencies
9358 Install only the dependencies necessary to build the
9359 given packages
9360
9361 --dependencies-only
9362 --no-dependencies-only
9363 A synonym for --only-dependencies
9364
9365 --index-state STATE
9366 Use source package index state as it existed at a previ‐
9367 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
9368 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
9369 'HEAD' (default: 'HEAD').
9370
9371 --root-cmd COMMAND
9372 (No longer supported, do not use.)
9373
9374 --symlink-bindir DIR
9375 Add symlinks to installed executables into this direc‐
9376 tory.
9377
9378 --build-summary TEMPLATE
9379 Save build summaries to file (name template can use
9380 $pkgid, $compiler, $os, $arch)
9381
9382 --build-log TEMPLATE
9383 Log all builds to file (name template can use $pkgid,
9384 $compiler, $os, $arch)
9385
9386 --remote-build-reporting LEVEL
9387 Generate build reports to send to a remote server (none,
9388 anonymous or detailed).
9389
9390 --report-planning-failure
9391 Generate build reports when the dependency solver fails.
9392 This is used by the Hackage build bot.
9393
9394 --enable-per-component
9395 --disable-per-component
9396 Per-component builds when possible
9397
9398 --one-shot
9399 --no-one-shot
9400 Do not record the packages in the world file.
9401
9402 --run-tests
9403 Run package test suites during installation.
9404
9405 -j, --jobs [NUM]
9406 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
9407 given).
9408
9409 --keep-going
9410 After a build failure, continue to build other unaffected
9411 packages.
9412
9413 --offline
9414 --no-offline
9415 Don't download packages from the Internet.
9416
9417 --project-file FILE
9418 Set the name of the cabal.project file to search for in
9419 parent directories
9420
9421 --only
9422 Only installs the package in the current directory.
9423
9424 --haddock-hoogle
9425 Generate a hoogle database
9426
9427 --haddock-html
9428 Generate HTML documentation (the default)
9429
9430 --haddock-html-location URL
9431 Location of HTML documentation for pre-requisite packages
9432
9433 --haddock-for-hackage
9434 Collection of flags to generate documentation suitable
9435 for upload to hackage
9436
9437 --haddock-executables
9438 Run haddock for Executables targets
9439
9440 --haddock-tests
9441 Run haddock for Test Suite targets
9442
9443 --haddock-benchmarks
9444 Run haddock for Benchmark targets
9445
9446 --haddock-all
9447 Run haddock for all targets
9448
9449 --haddock-internal
9450 Run haddock for internal modules and include all symbols
9451
9452 --haddock-css PATH
9453 Use PATH as the haddock stylesheet
9454
9455 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
9456 dock-hyperlinked-source
9457 Hyperlink the documentation to the source code
9458
9459 --haddock-quickjump
9460 Generate an index for interactive documentation naviga‐
9461 tion
9462
9463 --haddock-hscolour-css PATH
9464 Use PATH as the HsColour stylesheet
9465
9466 --haddock-contents-location URL
9467 Bake URL in as the location for the contents page
9468
9469
9470 cabal v2-install
9471
9472 Usage: cabal v2-install [TARGETS] [FLAGS]
9473
9474
9475 Installs one or more packages. This is done by installing them in the
9476 store and symlinking the executables in the directory specified by the
9477 --symlink-bindir flag (`~/.cabal/bin/` by default). If you want the
9478 installed executables to be available globally, make sure that the PATH
9479 environment variable contains that directory.
9480
9481 If TARGET is a library, it will be added to the global environment.
9482 When doing this, cabal will try to build a plan that includes all the
9483 previously installed libraries. This is currently not implemented.
9484
9485
9486 Installs one or more packages. This is done by installing them in the
9487 store and symlinking the executables in the directory specified by the
9488 --symlink-bindir flag (`~/.cabal/bin/` by default). If you want the
9489 installed executables to be available globally, make sure that the PATH
9490 environment variable contains that directory.
9491
9492 If TARGET is a library, it will be added to the global environment.
9493 When doing this, cabal will try to build a plan that includes all the
9494 previously installed libraries. This is currently not implemented.
9495
9496
9497 Flags:
9498 -v, --verbose [n]
9499 Control verbosity (n is 0--3, default verbosity level is
9500 1)
9501
9502 --builddir, --distdir, --distpref DIR
9503 The directory where Cabal puts generated build files
9504 (default dist)
9505
9506 -g, --ghc
9507 compile with GHC
9508
9509 --ghcjs
9510 compile with GHCJS
9511
9512 --uhc
9513 compile with UHC
9514
9515 --haskell-suite
9516 compile with a haskell-suite compiler
9517
9518 --cabal-file PATH
9519 use this Cabal file
9520
9521 -w, --with-compiler PATH
9522 give the path to a particular compiler
9523
9524 --with-hc-pkg PATH
9525 give the path to the package tool
9526
9527 --prefix DIR
9528 bake this prefix in preparation of installation
9529
9530 --bindir DIR
9531 installation directory for executables
9532
9533 --libdir DIR
9534 installation directory for libraries
9535
9536 --libsubdir DIR
9537 subdirectory of libdir in which libs are installed
9538
9539 --dynlibdir DIR
9540 installation directory for dynamic libraries
9541
9542 --libexecdir DIR
9543 installation directory for program executables
9544
9545 --libexecsubdir DIR
9546 subdirectory of libexecdir in which private executables
9547 are installed
9548
9549 --datadir DIR
9550 installation directory for read-only data
9551
9552 --datasubdir DIR
9553 subdirectory of datadir in which data files are installed
9554
9555 --docdir DIR
9556 installation directory for documentation
9557
9558 --htmldir DIR
9559 installation directory for HTML documentation
9560
9561 --haddockdir DIR
9562 installation directory for haddock interfaces
9563
9564 --sysconfdir DIR
9565 installation directory for configuration files
9566
9567 --program-prefix PREFIX
9568 prefix to be applied to installed executables
9569
9570 --program-suffix SUFFIX
9571 suffix to be applied to installed executables
9572
9573 --enable-library-vanilla
9574 --disable-library-vanilla
9575 Vanilla libraries
9576
9577 -p, --enable-library-profiling
9578 --disable-library-profiling
9579 Library profiling
9580
9581 --enable-shared
9582 --disable-shared
9583 Shared library
9584
9585 --enable-static
9586 --disable-static
9587 Static library
9588
9589 --enable-executable-dynamic
9590 --disable-executable-dynamic
9591 Executable dynamic linking
9592
9593 --enable-profiling
9594 --disable-profiling
9595 Executable and library profiling
9596
9597 --enable-executable-profiling
9598 --disable-executable-profiling
9599 Executable profiling (DEPRECATED)
9600
9601 --profiling-detail level
9602 Profiling detail level for executable and library
9603 (default, none, exported-functions, toplevel-functions,
9604 all-functions).
9605
9606 --library-profiling-detail level
9607 Profiling detail level for libraries only.
9608
9609 -O, --enable-optimization, --enable-optimisation [n]
9610 Build with optimization (n is 0--2, default is 1)
9611
9612 --disable-optimization, --disable-optimisation
9613 Build without optimization
9614
9615 --enable-debug-info [n]
9616 Emit debug info (n is 0--3, default is 0)
9617
9618 --disable-debug-info
9619 Don't emit debug info
9620
9621 --enable-library-for-ghci
9622 --disable-library-for-ghci
9623 compile library for use with GHCi
9624
9625 --enable-split-sections
9626 --disable-split-sections
9627 compile library code such that unneeded definitions can
9628 be dropped from the final executable (GHC 7.8+)
9629
9630 --enable-split-objs
9631 --disable-split-objs
9632 split library into smaller objects to reduce binary sizes
9633 (GHC 6.6+)
9634
9635 --enable-executable-stripping
9636 --disable-executable-stripping
9637 strip executables upon installation to reduce binary
9638 sizes
9639
9640 --enable-library-stripping
9641 --disable-library-stripping
9642 strip libraries upon installation to reduce binary sizes
9643
9644 --configure-option OPT
9645 Extra option for configure
9646
9647 --user
9648 --global
9649 doing a per-user installation
9650
9651 --package-db DB
9652 Append the given package database to the list of package
9653 databases used (to satisfy dependencies and register
9654 into). May be a specific file, 'global' or 'user'. The
9655 initial list is ['global'], ['global', 'user'], or
9656 ['global', $sandbox], depending on context. Use 'clear'
9657 to reset the list to empty. See the user guide for
9658 details.
9659
9660 -f, --flags FLAGS
9661 Force values for the given flags in Cabal conditionals in
9662 the .cabal file. E.g., --flags="debug -usebytestrings"
9663 forces the flag "debug" to true and "usebytestrings" to
9664 false.
9665
9666 --extra-include-dirs PATH
9667 A list of directories to search for header files
9668
9669 --enable-deterministic
9670 --disable-deterministic
9671 Try to be as deterministic as possible (used by the test
9672 suite)
9673
9674 --ipid IPID
9675 Installed package ID to compile this package as
9676
9677 --cid CID
9678 Installed component ID to compile this component as
9679
9680 --extra-lib-dirs PATH
9681 A list of directories to search for external libraries
9682
9683 --extra-framework-dirs PATH
9684 A list of directories to search for external frameworks
9685 (OS X only)
9686
9687 --extra-prog-path PATH
9688 A list of directories to search for required programs (in
9689 addition to the normal search locations)
9690
9691 --instantiate-with NAME=MOD
9692 A mapping of signature names to concrete module instanti‐
9693 ations.
9694
9695 --enable-tests
9696 --disable-tests
9697 dependency checking and compilation for test suites
9698 listed in the package description file.
9699
9700 --enable-coverage
9701 --disable-coverage
9702 build package with Haskell Program Coverage. (GHC only)
9703
9704 --enable-library-coverage
9705 --disable-library-coverage
9706 build package with Haskell Program Coverage. (GHC only)
9707 (DEPRECATED)
9708
9709 --enable-benchmarks
9710 --disable-benchmarks
9711 dependency checking and compilation for benchmarks listed
9712 in the package description file.
9713
9714 --enable-relocatable
9715 --disable-relocatable
9716 building a package that is relocatable. (GHC only)
9717
9718 --disable-response-files
9719 enable workaround for old versions of programs like "ar"
9720 that do not support @file arguments
9721
9722 --cabal-lib-version VERSION
9723 Select which version of the Cabal lib to use to build
9724 packages (useful for testing).
9725
9726 --constraint CONSTRAINT
9727 Specify constraints on a package (version,
9728 installed/source, flags)
9729
9730 --preference CONSTRAINT
9731 Specify preferences (soft constraints) on the version of
9732 a package
9733
9734 --solver SOLVER
9735 Select dependency solver to use (default: modular).
9736 Choices: modular.
9737
9738 --allow-older [DEPS]
9739 Ignore lower bounds in all dependencies or DEPS
9740
9741 --allow-newer [DEPS]
9742 Ignore upper bounds in all dependencies or DEPS
9743
9744 --write-ghc-environment-files always|never|ghc8.4.4+
9745 Whether to create a .ghc.environment file after a suc‐
9746 cessful build (v2-build only)
9747
9748 --enable-documentation
9749 --disable-documentation
9750 building of documentation
9751
9752 --doc-index-file TEMPLATE
9753 A central index of haddock API documentation (template
9754 cannot use $pkgid)
9755
9756 --dry-run
9757 Do not install anything, only print what would be
9758 installed.
9759
9760 --max-backjumps NUM
9761 Maximum number of backjumps allowed while solving
9762 (default: 2000). Use a negative number to enable unlim‐
9763 ited backtracking. Use 0 to disable backtracking com‐
9764 pletely.
9765
9766 --reorder-goals
9767 --no-reorder-goals
9768 Try to reorder goals according to certain heuristics.
9769 Slows things down on average, but may make backtracking
9770 faster for some packages.
9771
9772 --count-conflicts
9773 --no-count-conflicts
9774 Try to speed up solving by preferring goals that are
9775 involved in a lot of conflicts (default).
9776
9777 --independent-goals
9778 --no-independent-goals
9779 Treat several goals on the command line as independent.
9780 If several goals depend on the same package, different
9781 versions can be chosen.
9782
9783 --shadow-installed-packages
9784 --no-shadow-installed-packages
9785 If multiple package instances of the same version are
9786 installed, treat all but one as shadowed.
9787
9788 --strong-flags
9789 --no-strong-flags
9790 Do not defer flag choices (this used to be the default in
9791 cabal-install <= 1.20).
9792
9793 --allow-boot-library-installs
9794 --no-allow-boot-library-installs
9795 Allow cabal to install base, ghc-prim, integer-simple,
9796 integer-gmp, and template-haskell.
9797
9798 --reinstall
9799 --no-reinstall
9800 Install even if it means installing the same version
9801 again.
9802
9803 --avoid-reinstalls
9804 --no-avoid-reinstalls
9805 Do not select versions that would destructively overwrite
9806 installed packages.
9807
9808 --force-reinstalls
9809 --no-force-reinstalls
9810 Reinstall packages even if they will most likely break
9811 other installed packages.
9812
9813 --upgrade-dependencies
9814 --no-upgrade-dependencies
9815 Pick the latest version for all dependencies, rather than
9816 trying to pick an installed version.
9817
9818 --only-dependencies
9819 --no-only-dependencies
9820 Install only the dependencies necessary to build the
9821 given packages
9822
9823 --dependencies-only
9824 --no-dependencies-only
9825 A synonym for --only-dependencies
9826
9827 --index-state STATE
9828 Use source package index state as it existed at a previ‐
9829 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
9830 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
9831 'HEAD' (default: 'HEAD').
9832
9833 --root-cmd COMMAND
9834 (No longer supported, do not use.)
9835
9836 --symlink-bindir DIR
9837 Add symlinks to installed executables into this direc‐
9838 tory.
9839
9840 --build-summary TEMPLATE
9841 Save build summaries to file (name template can use
9842 $pkgid, $compiler, $os, $arch)
9843
9844 --build-log TEMPLATE
9845 Log all builds to file (name template can use $pkgid,
9846 $compiler, $os, $arch)
9847
9848 --remote-build-reporting LEVEL
9849 Generate build reports to send to a remote server (none,
9850 anonymous or detailed).
9851
9852 --report-planning-failure
9853 Generate build reports when the dependency solver fails.
9854 This is used by the Hackage build bot.
9855
9856 --enable-per-component
9857 --disable-per-component
9858 Per-component builds when possible
9859
9860 --one-shot
9861 --no-one-shot
9862 Do not record the packages in the world file.
9863
9864 --run-tests
9865 Run package test suites during installation.
9866
9867 -j, --jobs [NUM]
9868 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
9869 given).
9870
9871 --keep-going
9872 After a build failure, continue to build other unaffected
9873 packages.
9874
9875 --offline
9876 --no-offline
9877 Don't download packages from the Internet.
9878
9879 --project-file FILE
9880 Set the name of the cabal.project file to search for in
9881 parent directories
9882
9883 --only
9884 Only installs the package in the current directory.
9885
9886 --keep-temp-files
9887 Keep temporary files
9888
9889 --hoogle
9890 Generate a hoogle database
9891
9892 --html
9893 Generate HTML documentation (the default)
9894
9895 --html-location URL
9896 Location of HTML documentation for pre-requisite packages
9897
9898 --for-hackage
9899 Collection of flags to generate documentation suitable
9900 for upload to hackage
9901
9902 --executables
9903 Run haddock for Executables targets
9904
9905 --tests
9906 Run haddock for Test Suite targets
9907
9908 --benchmarks
9909 Run haddock for Benchmark targets
9910
9911 --foreign-libraries
9912 Run haddock for Foreign Library targets
9913
9914 --all
9915 Run haddock for all targets
9916
9917 --internal
9918 Run haddock for internal modules and include all symbols
9919
9920 --css PATH
9921 Use PATH as the haddock stylesheet
9922
9923 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
9924 Hyperlink the documentation to the source code
9925
9926 --quickjump
9927 Generate an index for interactive documentation naviga‐
9928 tion
9929
9930 --hscolour-css PATH
9931 Use PATH as the HsColour stylesheet
9932
9933 --contents-location URL
9934 Bake URL in as the location for the contents page
9935
9936 --lib
9937 Install libraries rather than executables from the target
9938 package.
9939
9940 --package-env, --env ENV
9941 Set the environment file that may be modified.
9942
9943 --overwrite-policy always|never
9944 How to handle already existing symlinks.
9945
9946
9947 cabal new-install
9948
9949 Usage: cabal new-install [TARGETS] [FLAGS]
9950
9951
9952 Installs one or more packages. This is done by installing them in the
9953 store and symlinking the executables in the directory specified by the
9954 --symlink-bindir flag (`~/.cabal/bin/` by default). If you want the
9955 installed executables to be available globally, make sure that the PATH
9956 environment variable contains that directory.
9957
9958 If TARGET is a library, it will be added to the global environment.
9959 When doing this, cabal will try to build a plan that includes all the
9960 previously installed libraries. This is currently not implemented.
9961
9962
9963 Examples:
9964 cabal new-install
9965 Install the package in the current directory
9966 cabal new-install pkgname
9967 Install the package named pkgname (fetching it from hackage if nec‐
9968 essary)
9969 cabal new-install ./pkgfoo
9970 Install the package in the ./pkgfoo directory Note: this command is
9971 part of the new project-based system (aka nix-style local builds).
9972 These features are currently in beta. Please see http://cabal.readthe‐
9973 docs.io/en/latest/nix-local-build-overview.html for details and advice
9974 on what you can expect to work. If you encounter problems please file
9975 issues at https://github.com/haskell/cabal/issues and if you have any
9976 time to get involved and help with testing, fixing bugs etc then that
9977 is very much appreciated.
9978
9979
9980 Flags:
9981 -v, --verbose [n]
9982 Control verbosity (n is 0--3, default verbosity level is
9983 1)
9984
9985 --builddir, --distdir, --distpref DIR
9986 The directory where Cabal puts generated build files
9987 (default dist)
9988
9989 -g, --ghc
9990 compile with GHC
9991
9992 --ghcjs
9993 compile with GHCJS
9994
9995 --uhc
9996 compile with UHC
9997
9998 --haskell-suite
9999 compile with a haskell-suite compiler
10000
10001 --cabal-file PATH
10002 use this Cabal file
10003
10004 -w, --with-compiler PATH
10005 give the path to a particular compiler
10006
10007 --with-hc-pkg PATH
10008 give the path to the package tool
10009
10010 --prefix DIR
10011 bake this prefix in preparation of installation
10012
10013 --bindir DIR
10014 installation directory for executables
10015
10016 --libdir DIR
10017 installation directory for libraries
10018
10019 --libsubdir DIR
10020 subdirectory of libdir in which libs are installed
10021
10022 --dynlibdir DIR
10023 installation directory for dynamic libraries
10024
10025 --libexecdir DIR
10026 installation directory for program executables
10027
10028 --libexecsubdir DIR
10029 subdirectory of libexecdir in which private executables
10030 are installed
10031
10032 --datadir DIR
10033 installation directory for read-only data
10034
10035 --datasubdir DIR
10036 subdirectory of datadir in which data files are installed
10037
10038 --docdir DIR
10039 installation directory for documentation
10040
10041 --htmldir DIR
10042 installation directory for HTML documentation
10043
10044 --haddockdir DIR
10045 installation directory for haddock interfaces
10046
10047 --sysconfdir DIR
10048 installation directory for configuration files
10049
10050 --program-prefix PREFIX
10051 prefix to be applied to installed executables
10052
10053 --program-suffix SUFFIX
10054 suffix to be applied to installed executables
10055
10056 --enable-library-vanilla
10057 --disable-library-vanilla
10058 Vanilla libraries
10059
10060 -p, --enable-library-profiling
10061 --disable-library-profiling
10062 Library profiling
10063
10064 --enable-shared
10065 --disable-shared
10066 Shared library
10067
10068 --enable-static
10069 --disable-static
10070 Static library
10071
10072 --enable-executable-dynamic
10073 --disable-executable-dynamic
10074 Executable dynamic linking
10075
10076 --enable-profiling
10077 --disable-profiling
10078 Executable and library profiling
10079
10080 --enable-executable-profiling
10081 --disable-executable-profiling
10082 Executable profiling (DEPRECATED)
10083
10084 --profiling-detail level
10085 Profiling detail level for executable and library
10086 (default, none, exported-functions, toplevel-functions,
10087 all-functions).
10088
10089 --library-profiling-detail level
10090 Profiling detail level for libraries only.
10091
10092 -O, --enable-optimization, --enable-optimisation [n]
10093 Build with optimization (n is 0--2, default is 1)
10094
10095 --disable-optimization, --disable-optimisation
10096 Build without optimization
10097
10098 --enable-debug-info [n]
10099 Emit debug info (n is 0--3, default is 0)
10100
10101 --disable-debug-info
10102 Don't emit debug info
10103
10104 --enable-library-for-ghci
10105 --disable-library-for-ghci
10106 compile library for use with GHCi
10107
10108 --enable-split-sections
10109 --disable-split-sections
10110 compile library code such that unneeded definitions can
10111 be dropped from the final executable (GHC 7.8+)
10112
10113 --enable-split-objs
10114 --disable-split-objs
10115 split library into smaller objects to reduce binary sizes
10116 (GHC 6.6+)
10117
10118 --enable-executable-stripping
10119 --disable-executable-stripping
10120 strip executables upon installation to reduce binary
10121 sizes
10122
10123 --enable-library-stripping
10124 --disable-library-stripping
10125 strip libraries upon installation to reduce binary sizes
10126
10127 --configure-option OPT
10128 Extra option for configure
10129
10130 --user
10131 --global
10132 doing a per-user installation
10133
10134 --package-db DB
10135 Append the given package database to the list of package
10136 databases used (to satisfy dependencies and register
10137 into). May be a specific file, 'global' or 'user'. The
10138 initial list is ['global'], ['global', 'user'], or
10139 ['global', $sandbox], depending on context. Use 'clear'
10140 to reset the list to empty. See the user guide for
10141 details.
10142
10143 -f, --flags FLAGS
10144 Force values for the given flags in Cabal conditionals in
10145 the .cabal file. E.g., --flags="debug -usebytestrings"
10146 forces the flag "debug" to true and "usebytestrings" to
10147 false.
10148
10149 --extra-include-dirs PATH
10150 A list of directories to search for header files
10151
10152 --enable-deterministic
10153 --disable-deterministic
10154 Try to be as deterministic as possible (used by the test
10155 suite)
10156
10157 --ipid IPID
10158 Installed package ID to compile this package as
10159
10160 --cid CID
10161 Installed component ID to compile this component as
10162
10163 --extra-lib-dirs PATH
10164 A list of directories to search for external libraries
10165
10166 --extra-framework-dirs PATH
10167 A list of directories to search for external frameworks
10168 (OS X only)
10169
10170 --extra-prog-path PATH
10171 A list of directories to search for required programs (in
10172 addition to the normal search locations)
10173
10174 --instantiate-with NAME=MOD
10175 A mapping of signature names to concrete module instanti‐
10176 ations.
10177
10178 --enable-tests
10179 --disable-tests
10180 dependency checking and compilation for test suites
10181 listed in the package description file.
10182
10183 --enable-coverage
10184 --disable-coverage
10185 build package with Haskell Program Coverage. (GHC only)
10186
10187 --enable-library-coverage
10188 --disable-library-coverage
10189 build package with Haskell Program Coverage. (GHC only)
10190 (DEPRECATED)
10191
10192 --enable-benchmarks
10193 --disable-benchmarks
10194 dependency checking and compilation for benchmarks listed
10195 in the package description file.
10196
10197 --enable-relocatable
10198 --disable-relocatable
10199 building a package that is relocatable. (GHC only)
10200
10201 --disable-response-files
10202 enable workaround for old versions of programs like "ar"
10203 that do not support @file arguments
10204
10205 --cabal-lib-version VERSION
10206 Select which version of the Cabal lib to use to build
10207 packages (useful for testing).
10208
10209 --constraint CONSTRAINT
10210 Specify constraints on a package (version,
10211 installed/source, flags)
10212
10213 --preference CONSTRAINT
10214 Specify preferences (soft constraints) on the version of
10215 a package
10216
10217 --solver SOLVER
10218 Select dependency solver to use (default: modular).
10219 Choices: modular.
10220
10221 --allow-older [DEPS]
10222 Ignore lower bounds in all dependencies or DEPS
10223
10224 --allow-newer [DEPS]
10225 Ignore upper bounds in all dependencies or DEPS
10226
10227 --write-ghc-environment-files always|never|ghc8.4.4+
10228 Whether to create a .ghc.environment file after a suc‐
10229 cessful build (v2-build only)
10230
10231 --enable-documentation
10232 --disable-documentation
10233 building of documentation
10234
10235 --doc-index-file TEMPLATE
10236 A central index of haddock API documentation (template
10237 cannot use $pkgid)
10238
10239 --dry-run
10240 Do not install anything, only print what would be
10241 installed.
10242
10243 --max-backjumps NUM
10244 Maximum number of backjumps allowed while solving
10245 (default: 2000). Use a negative number to enable unlim‐
10246 ited backtracking. Use 0 to disable backtracking com‐
10247 pletely.
10248
10249 --reorder-goals
10250 --no-reorder-goals
10251 Try to reorder goals according to certain heuristics.
10252 Slows things down on average, but may make backtracking
10253 faster for some packages.
10254
10255 --count-conflicts
10256 --no-count-conflicts
10257 Try to speed up solving by preferring goals that are
10258 involved in a lot of conflicts (default).
10259
10260 --independent-goals
10261 --no-independent-goals
10262 Treat several goals on the command line as independent.
10263 If several goals depend on the same package, different
10264 versions can be chosen.
10265
10266 --shadow-installed-packages
10267 --no-shadow-installed-packages
10268 If multiple package instances of the same version are
10269 installed, treat all but one as shadowed.
10270
10271 --strong-flags
10272 --no-strong-flags
10273 Do not defer flag choices (this used to be the default in
10274 cabal-install <= 1.20).
10275
10276 --allow-boot-library-installs
10277 --no-allow-boot-library-installs
10278 Allow cabal to install base, ghc-prim, integer-simple,
10279 integer-gmp, and template-haskell.
10280
10281 --reinstall
10282 --no-reinstall
10283 Install even if it means installing the same version
10284 again.
10285
10286 --avoid-reinstalls
10287 --no-avoid-reinstalls
10288 Do not select versions that would destructively overwrite
10289 installed packages.
10290
10291 --force-reinstalls
10292 --no-force-reinstalls
10293 Reinstall packages even if they will most likely break
10294 other installed packages.
10295
10296 --upgrade-dependencies
10297 --no-upgrade-dependencies
10298 Pick the latest version for all dependencies, rather than
10299 trying to pick an installed version.
10300
10301 --only-dependencies
10302 --no-only-dependencies
10303 Install only the dependencies necessary to build the
10304 given packages
10305
10306 --dependencies-only
10307 --no-dependencies-only
10308 A synonym for --only-dependencies
10309
10310 --index-state STATE
10311 Use source package index state as it existed at a previ‐
10312 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
10313 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
10314 'HEAD' (default: 'HEAD').
10315
10316 --root-cmd COMMAND
10317 (No longer supported, do not use.)
10318
10319 --symlink-bindir DIR
10320 Add symlinks to installed executables into this direc‐
10321 tory.
10322
10323 --build-summary TEMPLATE
10324 Save build summaries to file (name template can use
10325 $pkgid, $compiler, $os, $arch)
10326
10327 --build-log TEMPLATE
10328 Log all builds to file (name template can use $pkgid,
10329 $compiler, $os, $arch)
10330
10331 --remote-build-reporting LEVEL
10332 Generate build reports to send to a remote server (none,
10333 anonymous or detailed).
10334
10335 --report-planning-failure
10336 Generate build reports when the dependency solver fails.
10337 This is used by the Hackage build bot.
10338
10339 --enable-per-component
10340 --disable-per-component
10341 Per-component builds when possible
10342
10343 --one-shot
10344 --no-one-shot
10345 Do not record the packages in the world file.
10346
10347 --run-tests
10348 Run package test suites during installation.
10349
10350 -j, --jobs [NUM]
10351 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
10352 given).
10353
10354 --keep-going
10355 After a build failure, continue to build other unaffected
10356 packages.
10357
10358 --offline
10359 --no-offline
10360 Don't download packages from the Internet.
10361
10362 --project-file FILE
10363 Set the name of the cabal.project file to search for in
10364 parent directories
10365
10366 --only
10367 Only installs the package in the current directory.
10368
10369 --keep-temp-files
10370 Keep temporary files
10371
10372 --hoogle
10373 Generate a hoogle database
10374
10375 --html
10376 Generate HTML documentation (the default)
10377
10378 --html-location URL
10379 Location of HTML documentation for pre-requisite packages
10380
10381 --for-hackage
10382 Collection of flags to generate documentation suitable
10383 for upload to hackage
10384
10385 --executables
10386 Run haddock for Executables targets
10387
10388 --tests
10389 Run haddock for Test Suite targets
10390
10391 --benchmarks
10392 Run haddock for Benchmark targets
10393
10394 --foreign-libraries
10395 Run haddock for Foreign Library targets
10396
10397 --all
10398 Run haddock for all targets
10399
10400 --internal
10401 Run haddock for internal modules and include all symbols
10402
10403 --css PATH
10404 Use PATH as the haddock stylesheet
10405
10406 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
10407 Hyperlink the documentation to the source code
10408
10409 --quickjump
10410 Generate an index for interactive documentation naviga‐
10411 tion
10412
10413 --hscolour-css PATH
10414 Use PATH as the HsColour stylesheet
10415
10416 --contents-location URL
10417 Bake URL in as the location for the contents page
10418
10419 --lib
10420 Install libraries rather than executables from the target
10421 package.
10422
10423 --package-env, --env ENV
10424 Set the environment file that may be modified.
10425
10426 --overwrite-policy always|never
10427 How to handle already existing symlinks.
10428
10429
10430 cabal v2-run
10431
10432 Usage: cabal v2-run [TARGET] [FLAGS] [-- EXECUTABLE_FLAGS]
10433
10434
10435 Runs the specified executable-like component (an executable, a test, or
10436 a benchmark), first ensuring it is up to date.
10437
10438 Any executable-like component in any package in the project can be
10439 specified. A package can be specified if contains just one executable-
10440 like. The default is to use the package in the current directory if it
10441 contains just one executable-like.
10442
10443 Extra arguments can be passed to the program, but use '--' to separate
10444 arguments for the program from arguments for cabal. The executable is
10445 run in an environment where it can find its data files inplace in the
10446 build tree.
10447
10448 Dependencies are built or rebuilt as necessary. Additional configura‐
10449 tion flags can be specified on the command line and these extend the
10450 project configuration from the 'cabal.project', 'cabal.project.local'
10451 and other files.
10452
10453
10454 Runs the specified executable-like component (an executable, a test, or
10455 a benchmark), first ensuring it is up to date.
10456
10457 Any executable-like component in any package in the project can be
10458 specified. A package can be specified if contains just one executable-
10459 like. The default is to use the package in the current directory if it
10460 contains just one executable-like.
10461
10462 Extra arguments can be passed to the program, but use '--' to separate
10463 arguments for the program from arguments for cabal. The executable is
10464 run in an environment where it can find its data files inplace in the
10465 build tree.
10466
10467 Dependencies are built or rebuilt as necessary. Additional configura‐
10468 tion flags can be specified on the command line and these extend the
10469 project configuration from the 'cabal.project', 'cabal.project.local'
10470 and other files.
10471
10472
10473 Flags:
10474 -v, --verbose [n]
10475 Control verbosity (n is 0--3, default verbosity level is
10476 1)
10477
10478 --builddir, --distdir, --distpref DIR
10479 The directory where Cabal puts generated build files
10480 (default dist)
10481
10482 -g, --ghc
10483 compile with GHC
10484
10485 --ghcjs
10486 compile with GHCJS
10487
10488 --uhc
10489 compile with UHC
10490
10491 --haskell-suite
10492 compile with a haskell-suite compiler
10493
10494 --cabal-file PATH
10495 use this Cabal file
10496
10497 -w, --with-compiler PATH
10498 give the path to a particular compiler
10499
10500 --with-hc-pkg PATH
10501 give the path to the package tool
10502
10503 --prefix DIR
10504 bake this prefix in preparation of installation
10505
10506 --bindir DIR
10507 installation directory for executables
10508
10509 --libdir DIR
10510 installation directory for libraries
10511
10512 --libsubdir DIR
10513 subdirectory of libdir in which libs are installed
10514
10515 --dynlibdir DIR
10516 installation directory for dynamic libraries
10517
10518 --libexecdir DIR
10519 installation directory for program executables
10520
10521 --libexecsubdir DIR
10522 subdirectory of libexecdir in which private executables
10523 are installed
10524
10525 --datadir DIR
10526 installation directory for read-only data
10527
10528 --datasubdir DIR
10529 subdirectory of datadir in which data files are installed
10530
10531 --docdir DIR
10532 installation directory for documentation
10533
10534 --htmldir DIR
10535 installation directory for HTML documentation
10536
10537 --haddockdir DIR
10538 installation directory for haddock interfaces
10539
10540 --sysconfdir DIR
10541 installation directory for configuration files
10542
10543 --program-prefix PREFIX
10544 prefix to be applied to installed executables
10545
10546 --program-suffix SUFFIX
10547 suffix to be applied to installed executables
10548
10549 --enable-library-vanilla
10550 --disable-library-vanilla
10551 Vanilla libraries
10552
10553 -p, --enable-library-profiling
10554 --disable-library-profiling
10555 Library profiling
10556
10557 --enable-shared
10558 --disable-shared
10559 Shared library
10560
10561 --enable-static
10562 --disable-static
10563 Static library
10564
10565 --enable-executable-dynamic
10566 --disable-executable-dynamic
10567 Executable dynamic linking
10568
10569 --enable-profiling
10570 --disable-profiling
10571 Executable and library profiling
10572
10573 --enable-executable-profiling
10574 --disable-executable-profiling
10575 Executable profiling (DEPRECATED)
10576
10577 --profiling-detail level
10578 Profiling detail level for executable and library
10579 (default, none, exported-functions, toplevel-functions,
10580 all-functions).
10581
10582 --library-profiling-detail level
10583 Profiling detail level for libraries only.
10584
10585 -O, --enable-optimization, --enable-optimisation [n]
10586 Build with optimization (n is 0--2, default is 1)
10587
10588 --disable-optimization, --disable-optimisation
10589 Build without optimization
10590
10591 --enable-debug-info [n]
10592 Emit debug info (n is 0--3, default is 0)
10593
10594 --disable-debug-info
10595 Don't emit debug info
10596
10597 --enable-library-for-ghci
10598 --disable-library-for-ghci
10599 compile library for use with GHCi
10600
10601 --enable-split-sections
10602 --disable-split-sections
10603 compile library code such that unneeded definitions can
10604 be dropped from the final executable (GHC 7.8+)
10605
10606 --enable-split-objs
10607 --disable-split-objs
10608 split library into smaller objects to reduce binary sizes
10609 (GHC 6.6+)
10610
10611 --enable-executable-stripping
10612 --disable-executable-stripping
10613 strip executables upon installation to reduce binary
10614 sizes
10615
10616 --enable-library-stripping
10617 --disable-library-stripping
10618 strip libraries upon installation to reduce binary sizes
10619
10620 --configure-option OPT
10621 Extra option for configure
10622
10623 --user
10624 --global
10625 doing a per-user installation
10626
10627 --package-db DB
10628 Append the given package database to the list of package
10629 databases used (to satisfy dependencies and register
10630 into). May be a specific file, 'global' or 'user'. The
10631 initial list is ['global'], ['global', 'user'], or
10632 ['global', $sandbox], depending on context. Use 'clear'
10633 to reset the list to empty. See the user guide for
10634 details.
10635
10636 -f, --flags FLAGS
10637 Force values for the given flags in Cabal conditionals in
10638 the .cabal file. E.g., --flags="debug -usebytestrings"
10639 forces the flag "debug" to true and "usebytestrings" to
10640 false.
10641
10642 --extra-include-dirs PATH
10643 A list of directories to search for header files
10644
10645 --enable-deterministic
10646 --disable-deterministic
10647 Try to be as deterministic as possible (used by the test
10648 suite)
10649
10650 --ipid IPID
10651 Installed package ID to compile this package as
10652
10653 --cid CID
10654 Installed component ID to compile this component as
10655
10656 --extra-lib-dirs PATH
10657 A list of directories to search for external libraries
10658
10659 --extra-framework-dirs PATH
10660 A list of directories to search for external frameworks
10661 (OS X only)
10662
10663 --extra-prog-path PATH
10664 A list of directories to search for required programs (in
10665 addition to the normal search locations)
10666
10667 --instantiate-with NAME=MOD
10668 A mapping of signature names to concrete module instanti‐
10669 ations.
10670
10671 --enable-tests
10672 --disable-tests
10673 dependency checking and compilation for test suites
10674 listed in the package description file.
10675
10676 --enable-coverage
10677 --disable-coverage
10678 build package with Haskell Program Coverage. (GHC only)
10679
10680 --enable-library-coverage
10681 --disable-library-coverage
10682 build package with Haskell Program Coverage. (GHC only)
10683 (DEPRECATED)
10684
10685 --enable-benchmarks
10686 --disable-benchmarks
10687 dependency checking and compilation for benchmarks listed
10688 in the package description file.
10689
10690 --enable-relocatable
10691 --disable-relocatable
10692 building a package that is relocatable. (GHC only)
10693
10694 --disable-response-files
10695 enable workaround for old versions of programs like "ar"
10696 that do not support @file arguments
10697
10698 --with-alex PATH
10699 give the path to alex
10700
10701 --with-ar PATH
10702 give the path to ar
10703
10704 --with-c2hs PATH
10705 give the path to c2hs
10706
10707 --with-cpphs PATH
10708 give the path to cpphs
10709
10710 --with-doctest PATH
10711 give the path to doctest
10712
10713 --with-gcc PATH
10714 give the path to gcc
10715
10716 --with-ghc PATH
10717 give the path to ghc
10718
10719 --with-ghc-pkg PATH
10720 give the path to ghc-pkg
10721
10722 --with-ghcjs PATH
10723 give the path to ghcjs
10724
10725 --with-ghcjs-pkg PATH
10726 give the path to ghcjs-pkg
10727
10728 --with-greencard PATH
10729 give the path to greencard
10730
10731 --with-haddock PATH
10732 give the path to haddock
10733
10734 --with-happy PATH
10735 give the path to happy
10736
10737 --with-haskell-suite PATH
10738 give the path to haskell-suite
10739
10740 --with-haskell-suite-pkg PATH
10741 give the path to haskell-suite-pkg
10742
10743 --with-hmake PATH
10744 give the path to hmake
10745
10746 --with-hpc PATH
10747 give the path to hpc
10748
10749 --with-hsc2hs PATH
10750 give the path to hsc2hs
10751
10752 --with-hscolour PATH
10753 give the path to hscolour
10754
10755 --with-jhc PATH
10756 give the path to jhc
10757
10758 --with-ld PATH
10759 give the path to ld
10760
10761 --with-pkg-config PATH
10762 give the path to pkg-config
10763
10764 --with-runghc PATH
10765 give the path to runghc
10766
10767 --with-strip PATH
10768 give the path to strip
10769
10770 --with-tar PATH
10771 give the path to tar
10772
10773 --with-uhc PATH
10774 give the path to uhc
10775
10776 --alex-option OPT
10777 give an extra option to alex (no need to quote options
10778 containing spaces)
10779
10780 --ar-option OPT
10781 give an extra option to ar (no need to quote options con‐
10782 taining spaces)
10783
10784 --c2hs-option OPT
10785 give an extra option to c2hs (no need to quote options
10786 containing spaces)
10787
10788 --cpphs-option OPT
10789 give an extra option to cpphs (no need to quote options
10790 containing spaces)
10791
10792 --doctest-option OPT
10793 give an extra option to doctest (no need to quote options
10794 containing spaces)
10795
10796 --gcc-option OPT
10797 give an extra option to gcc (no need to quote options
10798 containing spaces)
10799
10800 --ghc-option OPT
10801 give an extra option to ghc (no need to quote options
10802 containing spaces)
10803
10804 --ghc-pkg-option OPT
10805 give an extra option to ghc-pkg (no need to quote options
10806 containing spaces)
10807
10808 --ghcjs-option OPT
10809 give an extra option to ghcjs (no need to quote options
10810 containing spaces)
10811
10812 --ghcjs-pkg-option OPT
10813 give an extra option to ghcjs-pkg (no need to quote
10814 options containing spaces)
10815
10816 --greencard-option OPT
10817 give an extra option to greencard (no need to quote
10818 options containing spaces)
10819
10820 --haddock-option OPT
10821 give an extra option to haddock (no need to quote options
10822 containing spaces)
10823
10824 --happy-option OPT
10825 give an extra option to happy (no need to quote options
10826 containing spaces)
10827
10828 --haskell-suite-option OPT
10829 give an extra option to haskell-suite (no need to quote
10830 options containing spaces)
10831
10832 --haskell-suite-pkg-option OPT
10833 give an extra option to haskell-suite-pkg (no need to
10834 quote options containing spaces)
10835
10836 --hmake-option OPT
10837 give an extra option to hmake (no need to quote options
10838 containing spaces)
10839
10840 --hpc-option OPT
10841 give an extra option to hpc (no need to quote options
10842 containing spaces)
10843
10844 --hsc2hs-option OPT
10845 give an extra option to hsc2hs (no need to quote options
10846 containing spaces)
10847
10848 --hscolour-option OPT
10849 give an extra option to hscolour (no need to quote
10850 options containing spaces)
10851
10852 --jhc-option OPT
10853 give an extra option to jhc (no need to quote options
10854 containing spaces)
10855
10856 --ld-option OPT
10857 give an extra option to ld (no need to quote options con‐
10858 taining spaces)
10859
10860 --pkg-config-option OPT
10861 give an extra option to pkg-config (no need to quote
10862 options containing spaces)
10863
10864 --runghc-option OPT
10865 give an extra option to runghc (no need to quote options
10866 containing spaces)
10867
10868 --strip-option OPT
10869 give an extra option to strip (no need to quote options
10870 containing spaces)
10871
10872 --tar-option OPT
10873 give an extra option to tar (no need to quote options
10874 containing spaces)
10875
10876 --uhc-option OPT
10877 give an extra option to uhc (no need to quote options
10878 containing spaces)
10879
10880 --alex-options OPTS
10881 give extra options to alex
10882
10883 --ar-options OPTS
10884 give extra options to ar
10885
10886 --c2hs-options OPTS
10887 give extra options to c2hs
10888
10889 --cpphs-options OPTS
10890 give extra options to cpphs
10891
10892 --doctest-options OPTS
10893 give extra options to doctest
10894
10895 --gcc-options OPTS
10896 give extra options to gcc
10897
10898 --ghc-options OPTS
10899 give extra options to ghc
10900
10901 --ghc-pkg-options OPTS
10902 give extra options to ghc-pkg
10903
10904 --ghcjs-options OPTS
10905 give extra options to ghcjs
10906
10907 --ghcjs-pkg-options OPTS
10908 give extra options to ghcjs-pkg
10909
10910 --greencard-options OPTS
10911 give extra options to greencard
10912
10913 --haddock-options OPTS
10914 give extra options to haddock
10915
10916 --happy-options OPTS
10917 give extra options to happy
10918
10919 --haskell-suite-options OPTS
10920 give extra options to haskell-suite
10921
10922 --haskell-suite-pkg-options OPTS
10923 give extra options to haskell-suite-pkg
10924
10925 --hmake-options OPTS
10926 give extra options to hmake
10927
10928 --hpc-options OPTS
10929 give extra options to hpc
10930
10931 --hsc2hs-options OPTS
10932 give extra options to hsc2hs
10933
10934 --hscolour-options OPTS
10935 give extra options to hscolour
10936
10937 --jhc-options OPTS
10938 give extra options to jhc
10939
10940 --ld-options OPTS
10941 give extra options to ld
10942
10943 --pkg-config-options OPTS
10944 give extra options to pkg-config
10945
10946 --runghc-options OPTS
10947 give extra options to runghc
10948
10949 --strip-options OPTS
10950 give extra options to strip
10951
10952 --tar-options OPTS
10953 give extra options to tar
10954
10955 --uhc-options OPTS
10956 give extra options to uhc
10957
10958 --cabal-lib-version VERSION
10959 Select which version of the Cabal lib to use to build
10960 packages (useful for testing).
10961
10962 --constraint CONSTRAINT
10963 Specify constraints on a package (version,
10964 installed/source, flags)
10965
10966 --preference CONSTRAINT
10967 Specify preferences (soft constraints) on the version of
10968 a package
10969
10970 --solver SOLVER
10971 Select dependency solver to use (default: modular).
10972 Choices: modular.
10973
10974 --allow-older [DEPS]
10975 Ignore lower bounds in all dependencies or DEPS
10976
10977 --allow-newer [DEPS]
10978 Ignore upper bounds in all dependencies or DEPS
10979
10980 --write-ghc-environment-files always|never|ghc8.4.4+
10981 Whether to create a .ghc.environment file after a suc‐
10982 cessful build (v2-build only)
10983
10984 --enable-documentation
10985 --disable-documentation
10986 building of documentation
10987
10988 --doc-index-file TEMPLATE
10989 A central index of haddock API documentation (template
10990 cannot use $pkgid)
10991
10992 --dry-run
10993 Do not install anything, only print what would be
10994 installed.
10995
10996 --max-backjumps NUM
10997 Maximum number of backjumps allowed while solving
10998 (default: 2000). Use a negative number to enable unlim‐
10999 ited backtracking. Use 0 to disable backtracking com‐
11000 pletely.
11001
11002 --reorder-goals
11003 --no-reorder-goals
11004 Try to reorder goals according to certain heuristics.
11005 Slows things down on average, but may make backtracking
11006 faster for some packages.
11007
11008 --count-conflicts
11009 --no-count-conflicts
11010 Try to speed up solving by preferring goals that are
11011 involved in a lot of conflicts (default).
11012
11013 --independent-goals
11014 --no-independent-goals
11015 Treat several goals on the command line as independent.
11016 If several goals depend on the same package, different
11017 versions can be chosen.
11018
11019 --shadow-installed-packages
11020 --no-shadow-installed-packages
11021 If multiple package instances of the same version are
11022 installed, treat all but one as shadowed.
11023
11024 --strong-flags
11025 --no-strong-flags
11026 Do not defer flag choices (this used to be the default in
11027 cabal-install <= 1.20).
11028
11029 --allow-boot-library-installs
11030 --no-allow-boot-library-installs
11031 Allow cabal to install base, ghc-prim, integer-simple,
11032 integer-gmp, and template-haskell.
11033
11034 --reinstall
11035 --no-reinstall
11036 Install even if it means installing the same version
11037 again.
11038
11039 --avoid-reinstalls
11040 --no-avoid-reinstalls
11041 Do not select versions that would destructively overwrite
11042 installed packages.
11043
11044 --force-reinstalls
11045 --no-force-reinstalls
11046 Reinstall packages even if they will most likely break
11047 other installed packages.
11048
11049 --upgrade-dependencies
11050 --no-upgrade-dependencies
11051 Pick the latest version for all dependencies, rather than
11052 trying to pick an installed version.
11053
11054 --only-dependencies
11055 --no-only-dependencies
11056 Install only the dependencies necessary to build the
11057 given packages
11058
11059 --dependencies-only
11060 --no-dependencies-only
11061 A synonym for --only-dependencies
11062
11063 --index-state STATE
11064 Use source package index state as it existed at a previ‐
11065 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
11066 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
11067 'HEAD' (default: 'HEAD').
11068
11069 --root-cmd COMMAND
11070 (No longer supported, do not use.)
11071
11072 --symlink-bindir DIR
11073 Add symlinks to installed executables into this direc‐
11074 tory.
11075
11076 --build-summary TEMPLATE
11077 Save build summaries to file (name template can use
11078 $pkgid, $compiler, $os, $arch)
11079
11080 --build-log TEMPLATE
11081 Log all builds to file (name template can use $pkgid,
11082 $compiler, $os, $arch)
11083
11084 --remote-build-reporting LEVEL
11085 Generate build reports to send to a remote server (none,
11086 anonymous or detailed).
11087
11088 --report-planning-failure
11089 Generate build reports when the dependency solver fails.
11090 This is used by the Hackage build bot.
11091
11092 --enable-per-component
11093 --disable-per-component
11094 Per-component builds when possible
11095
11096 --one-shot
11097 --no-one-shot
11098 Do not record the packages in the world file.
11099
11100 --run-tests
11101 Run package test suites during installation.
11102
11103 -j, --jobs [NUM]
11104 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
11105 given).
11106
11107 --keep-going
11108 After a build failure, continue to build other unaffected
11109 packages.
11110
11111 --offline
11112 --no-offline
11113 Don't download packages from the Internet.
11114
11115 --project-file FILE
11116 Set the name of the cabal.project file to search for in
11117 parent directories
11118
11119 --only
11120 Only installs the package in the current directory.
11121
11122 --haddock-hoogle
11123 Generate a hoogle database
11124
11125 --haddock-html
11126 Generate HTML documentation (the default)
11127
11128 --haddock-html-location URL
11129 Location of HTML documentation for pre-requisite packages
11130
11131 --haddock-for-hackage
11132 Collection of flags to generate documentation suitable
11133 for upload to hackage
11134
11135 --haddock-executables
11136 Run haddock for Executables targets
11137
11138 --haddock-tests
11139 Run haddock for Test Suite targets
11140
11141 --haddock-benchmarks
11142 Run haddock for Benchmark targets
11143
11144 --haddock-all
11145 Run haddock for all targets
11146
11147 --haddock-internal
11148 Run haddock for internal modules and include all symbols
11149
11150 --haddock-css PATH
11151 Use PATH as the haddock stylesheet
11152
11153 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
11154 dock-hyperlinked-source
11155 Hyperlink the documentation to the source code
11156
11157 --haddock-quickjump
11158 Generate an index for interactive documentation naviga‐
11159 tion
11160
11161 --haddock-hscolour-css PATH
11162 Use PATH as the HsColour stylesheet
11163
11164 --haddock-contents-location URL
11165 Bake URL in as the location for the contents page
11166
11167
11168 cabal new-run
11169
11170 Usage: cabal new-run [TARGET] [FLAGS] [-- EXECUTABLE_FLAGS]
11171
11172
11173 Runs the specified executable-like component (an executable, a test, or
11174 a benchmark), first ensuring it is up to date.
11175
11176 Any executable-like component in any package in the project can be
11177 specified. A package can be specified if contains just one executable-
11178 like. The default is to use the package in the current directory if it
11179 contains just one executable-like.
11180
11181 Extra arguments can be passed to the program, but use '--' to separate
11182 arguments for the program from arguments for cabal. The executable is
11183 run in an environment where it can find its data files inplace in the
11184 build tree.
11185
11186 Dependencies are built or rebuilt as necessary. Additional configura‐
11187 tion flags can be specified on the command line and these extend the
11188 project configuration from the 'cabal.project', 'cabal.project.local'
11189 and other files.
11190
11191
11192 Examples:
11193 cabal new-run
11194 Run the executable-like in the package in the current directory
11195 cabal new-run foo-tool
11196 Run the named executable-like (in any package in the project)
11197 cabal new-run pkgfoo:foo-tool
11198 Run the executable-like 'foo-tool' in the package 'pkgfoo'
11199 cabal new-run foo -O2 -- dothing --fooflag
11200 Build with '-O2' and run the program, passing it extra arguments.
11201
11202 Note: this command is part of the new project-based system (aka nix-
11203 style local builds). These features are currently in beta. Please see
11204 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
11205 details and advice on what you can expect to work. If you encounter
11206 problems please file issues at https://github.com/haskell/cabal/issues
11207 and if you have any time to get involved and help with testing, fixing
11208 bugs etc then that is very much appreciated.
11209
11210
11211 Flags:
11212 -v, --verbose [n]
11213 Control verbosity (n is 0--3, default verbosity level is
11214 1)
11215
11216 --builddir, --distdir, --distpref DIR
11217 The directory where Cabal puts generated build files
11218 (default dist)
11219
11220 -g, --ghc
11221 compile with GHC
11222
11223 --ghcjs
11224 compile with GHCJS
11225
11226 --uhc
11227 compile with UHC
11228
11229 --haskell-suite
11230 compile with a haskell-suite compiler
11231
11232 --cabal-file PATH
11233 use this Cabal file
11234
11235 -w, --with-compiler PATH
11236 give the path to a particular compiler
11237
11238 --with-hc-pkg PATH
11239 give the path to the package tool
11240
11241 --prefix DIR
11242 bake this prefix in preparation of installation
11243
11244 --bindir DIR
11245 installation directory for executables
11246
11247 --libdir DIR
11248 installation directory for libraries
11249
11250 --libsubdir DIR
11251 subdirectory of libdir in which libs are installed
11252
11253 --dynlibdir DIR
11254 installation directory for dynamic libraries
11255
11256 --libexecdir DIR
11257 installation directory for program executables
11258
11259 --libexecsubdir DIR
11260 subdirectory of libexecdir in which private executables
11261 are installed
11262
11263 --datadir DIR
11264 installation directory for read-only data
11265
11266 --datasubdir DIR
11267 subdirectory of datadir in which data files are installed
11268
11269 --docdir DIR
11270 installation directory for documentation
11271
11272 --htmldir DIR
11273 installation directory for HTML documentation
11274
11275 --haddockdir DIR
11276 installation directory for haddock interfaces
11277
11278 --sysconfdir DIR
11279 installation directory for configuration files
11280
11281 --program-prefix PREFIX
11282 prefix to be applied to installed executables
11283
11284 --program-suffix SUFFIX
11285 suffix to be applied to installed executables
11286
11287 --enable-library-vanilla
11288 --disable-library-vanilla
11289 Vanilla libraries
11290
11291 -p, --enable-library-profiling
11292 --disable-library-profiling
11293 Library profiling
11294
11295 --enable-shared
11296 --disable-shared
11297 Shared library
11298
11299 --enable-static
11300 --disable-static
11301 Static library
11302
11303 --enable-executable-dynamic
11304 --disable-executable-dynamic
11305 Executable dynamic linking
11306
11307 --enable-profiling
11308 --disable-profiling
11309 Executable and library profiling
11310
11311 --enable-executable-profiling
11312 --disable-executable-profiling
11313 Executable profiling (DEPRECATED)
11314
11315 --profiling-detail level
11316 Profiling detail level for executable and library
11317 (default, none, exported-functions, toplevel-functions,
11318 all-functions).
11319
11320 --library-profiling-detail level
11321 Profiling detail level for libraries only.
11322
11323 -O, --enable-optimization, --enable-optimisation [n]
11324 Build with optimization (n is 0--2, default is 1)
11325
11326 --disable-optimization, --disable-optimisation
11327 Build without optimization
11328
11329 --enable-debug-info [n]
11330 Emit debug info (n is 0--3, default is 0)
11331
11332 --disable-debug-info
11333 Don't emit debug info
11334
11335 --enable-library-for-ghci
11336 --disable-library-for-ghci
11337 compile library for use with GHCi
11338
11339 --enable-split-sections
11340 --disable-split-sections
11341 compile library code such that unneeded definitions can
11342 be dropped from the final executable (GHC 7.8+)
11343
11344 --enable-split-objs
11345 --disable-split-objs
11346 split library into smaller objects to reduce binary sizes
11347 (GHC 6.6+)
11348
11349 --enable-executable-stripping
11350 --disable-executable-stripping
11351 strip executables upon installation to reduce binary
11352 sizes
11353
11354 --enable-library-stripping
11355 --disable-library-stripping
11356 strip libraries upon installation to reduce binary sizes
11357
11358 --configure-option OPT
11359 Extra option for configure
11360
11361 --user
11362 --global
11363 doing a per-user installation
11364
11365 --package-db DB
11366 Append the given package database to the list of package
11367 databases used (to satisfy dependencies and register
11368 into). May be a specific file, 'global' or 'user'. The
11369 initial list is ['global'], ['global', 'user'], or
11370 ['global', $sandbox], depending on context. Use 'clear'
11371 to reset the list to empty. See the user guide for
11372 details.
11373
11374 -f, --flags FLAGS
11375 Force values for the given flags in Cabal conditionals in
11376 the .cabal file. E.g., --flags="debug -usebytestrings"
11377 forces the flag "debug" to true and "usebytestrings" to
11378 false.
11379
11380 --extra-include-dirs PATH
11381 A list of directories to search for header files
11382
11383 --enable-deterministic
11384 --disable-deterministic
11385 Try to be as deterministic as possible (used by the test
11386 suite)
11387
11388 --ipid IPID
11389 Installed package ID to compile this package as
11390
11391 --cid CID
11392 Installed component ID to compile this component as
11393
11394 --extra-lib-dirs PATH
11395 A list of directories to search for external libraries
11396
11397 --extra-framework-dirs PATH
11398 A list of directories to search for external frameworks
11399 (OS X only)
11400
11401 --extra-prog-path PATH
11402 A list of directories to search for required programs (in
11403 addition to the normal search locations)
11404
11405 --instantiate-with NAME=MOD
11406 A mapping of signature names to concrete module instanti‐
11407 ations.
11408
11409 --enable-tests
11410 --disable-tests
11411 dependency checking and compilation for test suites
11412 listed in the package description file.
11413
11414 --enable-coverage
11415 --disable-coverage
11416 build package with Haskell Program Coverage. (GHC only)
11417
11418 --enable-library-coverage
11419 --disable-library-coverage
11420 build package with Haskell Program Coverage. (GHC only)
11421 (DEPRECATED)
11422
11423 --enable-benchmarks
11424 --disable-benchmarks
11425 dependency checking and compilation for benchmarks listed
11426 in the package description file.
11427
11428 --enable-relocatable
11429 --disable-relocatable
11430 building a package that is relocatable. (GHC only)
11431
11432 --disable-response-files
11433 enable workaround for old versions of programs like "ar"
11434 that do not support @file arguments
11435
11436 --with-alex PATH
11437 give the path to alex
11438
11439 --with-ar PATH
11440 give the path to ar
11441
11442 --with-c2hs PATH
11443 give the path to c2hs
11444
11445 --with-cpphs PATH
11446 give the path to cpphs
11447
11448 --with-doctest PATH
11449 give the path to doctest
11450
11451 --with-gcc PATH
11452 give the path to gcc
11453
11454 --with-ghc PATH
11455 give the path to ghc
11456
11457 --with-ghc-pkg PATH
11458 give the path to ghc-pkg
11459
11460 --with-ghcjs PATH
11461 give the path to ghcjs
11462
11463 --with-ghcjs-pkg PATH
11464 give the path to ghcjs-pkg
11465
11466 --with-greencard PATH
11467 give the path to greencard
11468
11469 --with-haddock PATH
11470 give the path to haddock
11471
11472 --with-happy PATH
11473 give the path to happy
11474
11475 --with-haskell-suite PATH
11476 give the path to haskell-suite
11477
11478 --with-haskell-suite-pkg PATH
11479 give the path to haskell-suite-pkg
11480
11481 --with-hmake PATH
11482 give the path to hmake
11483
11484 --with-hpc PATH
11485 give the path to hpc
11486
11487 --with-hsc2hs PATH
11488 give the path to hsc2hs
11489
11490 --with-hscolour PATH
11491 give the path to hscolour
11492
11493 --with-jhc PATH
11494 give the path to jhc
11495
11496 --with-ld PATH
11497 give the path to ld
11498
11499 --with-pkg-config PATH
11500 give the path to pkg-config
11501
11502 --with-runghc PATH
11503 give the path to runghc
11504
11505 --with-strip PATH
11506 give the path to strip
11507
11508 --with-tar PATH
11509 give the path to tar
11510
11511 --with-uhc PATH
11512 give the path to uhc
11513
11514 --alex-option OPT
11515 give an extra option to alex (no need to quote options
11516 containing spaces)
11517
11518 --ar-option OPT
11519 give an extra option to ar (no need to quote options con‐
11520 taining spaces)
11521
11522 --c2hs-option OPT
11523 give an extra option to c2hs (no need to quote options
11524 containing spaces)
11525
11526 --cpphs-option OPT
11527 give an extra option to cpphs (no need to quote options
11528 containing spaces)
11529
11530 --doctest-option OPT
11531 give an extra option to doctest (no need to quote options
11532 containing spaces)
11533
11534 --gcc-option OPT
11535 give an extra option to gcc (no need to quote options
11536 containing spaces)
11537
11538 --ghc-option OPT
11539 give an extra option to ghc (no need to quote options
11540 containing spaces)
11541
11542 --ghc-pkg-option OPT
11543 give an extra option to ghc-pkg (no need to quote options
11544 containing spaces)
11545
11546 --ghcjs-option OPT
11547 give an extra option to ghcjs (no need to quote options
11548 containing spaces)
11549
11550 --ghcjs-pkg-option OPT
11551 give an extra option to ghcjs-pkg (no need to quote
11552 options containing spaces)
11553
11554 --greencard-option OPT
11555 give an extra option to greencard (no need to quote
11556 options containing spaces)
11557
11558 --haddock-option OPT
11559 give an extra option to haddock (no need to quote options
11560 containing spaces)
11561
11562 --happy-option OPT
11563 give an extra option to happy (no need to quote options
11564 containing spaces)
11565
11566 --haskell-suite-option OPT
11567 give an extra option to haskell-suite (no need to quote
11568 options containing spaces)
11569
11570 --haskell-suite-pkg-option OPT
11571 give an extra option to haskell-suite-pkg (no need to
11572 quote options containing spaces)
11573
11574 --hmake-option OPT
11575 give an extra option to hmake (no need to quote options
11576 containing spaces)
11577
11578 --hpc-option OPT
11579 give an extra option to hpc (no need to quote options
11580 containing spaces)
11581
11582 --hsc2hs-option OPT
11583 give an extra option to hsc2hs (no need to quote options
11584 containing spaces)
11585
11586 --hscolour-option OPT
11587 give an extra option to hscolour (no need to quote
11588 options containing spaces)
11589
11590 --jhc-option OPT
11591 give an extra option to jhc (no need to quote options
11592 containing spaces)
11593
11594 --ld-option OPT
11595 give an extra option to ld (no need to quote options con‐
11596 taining spaces)
11597
11598 --pkg-config-option OPT
11599 give an extra option to pkg-config (no need to quote
11600 options containing spaces)
11601
11602 --runghc-option OPT
11603 give an extra option to runghc (no need to quote options
11604 containing spaces)
11605
11606 --strip-option OPT
11607 give an extra option to strip (no need to quote options
11608 containing spaces)
11609
11610 --tar-option OPT
11611 give an extra option to tar (no need to quote options
11612 containing spaces)
11613
11614 --uhc-option OPT
11615 give an extra option to uhc (no need to quote options
11616 containing spaces)
11617
11618 --alex-options OPTS
11619 give extra options to alex
11620
11621 --ar-options OPTS
11622 give extra options to ar
11623
11624 --c2hs-options OPTS
11625 give extra options to c2hs
11626
11627 --cpphs-options OPTS
11628 give extra options to cpphs
11629
11630 --doctest-options OPTS
11631 give extra options to doctest
11632
11633 --gcc-options OPTS
11634 give extra options to gcc
11635
11636 --ghc-options OPTS
11637 give extra options to ghc
11638
11639 --ghc-pkg-options OPTS
11640 give extra options to ghc-pkg
11641
11642 --ghcjs-options OPTS
11643 give extra options to ghcjs
11644
11645 --ghcjs-pkg-options OPTS
11646 give extra options to ghcjs-pkg
11647
11648 --greencard-options OPTS
11649 give extra options to greencard
11650
11651 --haddock-options OPTS
11652 give extra options to haddock
11653
11654 --happy-options OPTS
11655 give extra options to happy
11656
11657 --haskell-suite-options OPTS
11658 give extra options to haskell-suite
11659
11660 --haskell-suite-pkg-options OPTS
11661 give extra options to haskell-suite-pkg
11662
11663 --hmake-options OPTS
11664 give extra options to hmake
11665
11666 --hpc-options OPTS
11667 give extra options to hpc
11668
11669 --hsc2hs-options OPTS
11670 give extra options to hsc2hs
11671
11672 --hscolour-options OPTS
11673 give extra options to hscolour
11674
11675 --jhc-options OPTS
11676 give extra options to jhc
11677
11678 --ld-options OPTS
11679 give extra options to ld
11680
11681 --pkg-config-options OPTS
11682 give extra options to pkg-config
11683
11684 --runghc-options OPTS
11685 give extra options to runghc
11686
11687 --strip-options OPTS
11688 give extra options to strip
11689
11690 --tar-options OPTS
11691 give extra options to tar
11692
11693 --uhc-options OPTS
11694 give extra options to uhc
11695
11696 --cabal-lib-version VERSION
11697 Select which version of the Cabal lib to use to build
11698 packages (useful for testing).
11699
11700 --constraint CONSTRAINT
11701 Specify constraints on a package (version,
11702 installed/source, flags)
11703
11704 --preference CONSTRAINT
11705 Specify preferences (soft constraints) on the version of
11706 a package
11707
11708 --solver SOLVER
11709 Select dependency solver to use (default: modular).
11710 Choices: modular.
11711
11712 --allow-older [DEPS]
11713 Ignore lower bounds in all dependencies or DEPS
11714
11715 --allow-newer [DEPS]
11716 Ignore upper bounds in all dependencies or DEPS
11717
11718 --write-ghc-environment-files always|never|ghc8.4.4+
11719 Whether to create a .ghc.environment file after a suc‐
11720 cessful build (v2-build only)
11721
11722 --enable-documentation
11723 --disable-documentation
11724 building of documentation
11725
11726 --doc-index-file TEMPLATE
11727 A central index of haddock API documentation (template
11728 cannot use $pkgid)
11729
11730 --dry-run
11731 Do not install anything, only print what would be
11732 installed.
11733
11734 --max-backjumps NUM
11735 Maximum number of backjumps allowed while solving
11736 (default: 2000). Use a negative number to enable unlim‐
11737 ited backtracking. Use 0 to disable backtracking com‐
11738 pletely.
11739
11740 --reorder-goals
11741 --no-reorder-goals
11742 Try to reorder goals according to certain heuristics.
11743 Slows things down on average, but may make backtracking
11744 faster for some packages.
11745
11746 --count-conflicts
11747 --no-count-conflicts
11748 Try to speed up solving by preferring goals that are
11749 involved in a lot of conflicts (default).
11750
11751 --independent-goals
11752 --no-independent-goals
11753 Treat several goals on the command line as independent.
11754 If several goals depend on the same package, different
11755 versions can be chosen.
11756
11757 --shadow-installed-packages
11758 --no-shadow-installed-packages
11759 If multiple package instances of the same version are
11760 installed, treat all but one as shadowed.
11761
11762 --strong-flags
11763 --no-strong-flags
11764 Do not defer flag choices (this used to be the default in
11765 cabal-install <= 1.20).
11766
11767 --allow-boot-library-installs
11768 --no-allow-boot-library-installs
11769 Allow cabal to install base, ghc-prim, integer-simple,
11770 integer-gmp, and template-haskell.
11771
11772 --reinstall
11773 --no-reinstall
11774 Install even if it means installing the same version
11775 again.
11776
11777 --avoid-reinstalls
11778 --no-avoid-reinstalls
11779 Do not select versions that would destructively overwrite
11780 installed packages.
11781
11782 --force-reinstalls
11783 --no-force-reinstalls
11784 Reinstall packages even if they will most likely break
11785 other installed packages.
11786
11787 --upgrade-dependencies
11788 --no-upgrade-dependencies
11789 Pick the latest version for all dependencies, rather than
11790 trying to pick an installed version.
11791
11792 --only-dependencies
11793 --no-only-dependencies
11794 Install only the dependencies necessary to build the
11795 given packages
11796
11797 --dependencies-only
11798 --no-dependencies-only
11799 A synonym for --only-dependencies
11800
11801 --index-state STATE
11802 Use source package index state as it existed at a previ‐
11803 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
11804 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
11805 'HEAD' (default: 'HEAD').
11806
11807 --root-cmd COMMAND
11808 (No longer supported, do not use.)
11809
11810 --symlink-bindir DIR
11811 Add symlinks to installed executables into this direc‐
11812 tory.
11813
11814 --build-summary TEMPLATE
11815 Save build summaries to file (name template can use
11816 $pkgid, $compiler, $os, $arch)
11817
11818 --build-log TEMPLATE
11819 Log all builds to file (name template can use $pkgid,
11820 $compiler, $os, $arch)
11821
11822 --remote-build-reporting LEVEL
11823 Generate build reports to send to a remote server (none,
11824 anonymous or detailed).
11825
11826 --report-planning-failure
11827 Generate build reports when the dependency solver fails.
11828 This is used by the Hackage build bot.
11829
11830 --enable-per-component
11831 --disable-per-component
11832 Per-component builds when possible
11833
11834 --one-shot
11835 --no-one-shot
11836 Do not record the packages in the world file.
11837
11838 --run-tests
11839 Run package test suites during installation.
11840
11841 -j, --jobs [NUM]
11842 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
11843 given).
11844
11845 --keep-going
11846 After a build failure, continue to build other unaffected
11847 packages.
11848
11849 --offline
11850 --no-offline
11851 Don't download packages from the Internet.
11852
11853 --project-file FILE
11854 Set the name of the cabal.project file to search for in
11855 parent directories
11856
11857 --only
11858 Only installs the package in the current directory.
11859
11860 --haddock-hoogle
11861 Generate a hoogle database
11862
11863 --haddock-html
11864 Generate HTML documentation (the default)
11865
11866 --haddock-html-location URL
11867 Location of HTML documentation for pre-requisite packages
11868
11869 --haddock-for-hackage
11870 Collection of flags to generate documentation suitable
11871 for upload to hackage
11872
11873 --haddock-executables
11874 Run haddock for Executables targets
11875
11876 --haddock-tests
11877 Run haddock for Test Suite targets
11878
11879 --haddock-benchmarks
11880 Run haddock for Benchmark targets
11881
11882 --haddock-all
11883 Run haddock for all targets
11884
11885 --haddock-internal
11886 Run haddock for internal modules and include all symbols
11887
11888 --haddock-css PATH
11889 Use PATH as the haddock stylesheet
11890
11891 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
11892 dock-hyperlinked-source
11893 Hyperlink the documentation to the source code
11894
11895 --haddock-quickjump
11896 Generate an index for interactive documentation naviga‐
11897 tion
11898
11899 --haddock-hscolour-css PATH
11900 Use PATH as the HsColour stylesheet
11901
11902 --haddock-contents-location URL
11903 Bake URL in as the location for the contents page
11904
11905
11906 cabal v2-test
11907
11908 Usage: cabal v2-test [TARGETS] [FLAGS]
11909
11910
11911 Runs the specified test-suites, first ensuring they are up to date.
11912
11913 Any test-suite in any package in the project can be specified. A pack‐
11914 age can be specified in which case all the test-suites in the package
11915 are run. The default is to run all the test-suites in the package in
11916 the current directory.
11917
11918 Dependencies are built or rebuilt as necessary. Additional configura‐
11919 tion flags can be specified on the command line and these extend the
11920 project configuration from the 'cabal.project', 'cabal.project.local'
11921 and other files.
11922
11923 To pass command-line arguments to a test suite, see the v2-run command.
11924
11925
11926 Runs the specified test-suites, first ensuring they are up to date.
11927
11928 Any test-suite in any package in the project can be specified. A pack‐
11929 age can be specified in which case all the test-suites in the package
11930 are run. The default is to run all the test-suites in the package in
11931 the current directory.
11932
11933 Dependencies are built or rebuilt as necessary. Additional configura‐
11934 tion flags can be specified on the command line and these extend the
11935 project configuration from the 'cabal.project', 'cabal.project.local'
11936 and other files.
11937
11938 To pass command-line arguments to a test suite, see the v2-run command.
11939
11940
11941 Flags:
11942 -v, --verbose [n]
11943 Control verbosity (n is 0--3, default verbosity level is
11944 1)
11945
11946 --builddir, --distdir, --distpref DIR
11947 The directory where Cabal puts generated build files
11948 (default dist)
11949
11950 -g, --ghc
11951 compile with GHC
11952
11953 --ghcjs
11954 compile with GHCJS
11955
11956 --uhc
11957 compile with UHC
11958
11959 --haskell-suite
11960 compile with a haskell-suite compiler
11961
11962 --cabal-file PATH
11963 use this Cabal file
11964
11965 -w, --with-compiler PATH
11966 give the path to a particular compiler
11967
11968 --with-hc-pkg PATH
11969 give the path to the package tool
11970
11971 --prefix DIR
11972 bake this prefix in preparation of installation
11973
11974 --bindir DIR
11975 installation directory for executables
11976
11977 --libdir DIR
11978 installation directory for libraries
11979
11980 --libsubdir DIR
11981 subdirectory of libdir in which libs are installed
11982
11983 --dynlibdir DIR
11984 installation directory for dynamic libraries
11985
11986 --libexecdir DIR
11987 installation directory for program executables
11988
11989 --libexecsubdir DIR
11990 subdirectory of libexecdir in which private executables
11991 are installed
11992
11993 --datadir DIR
11994 installation directory for read-only data
11995
11996 --datasubdir DIR
11997 subdirectory of datadir in which data files are installed
11998
11999 --docdir DIR
12000 installation directory for documentation
12001
12002 --htmldir DIR
12003 installation directory for HTML documentation
12004
12005 --haddockdir DIR
12006 installation directory for haddock interfaces
12007
12008 --sysconfdir DIR
12009 installation directory for configuration files
12010
12011 --program-prefix PREFIX
12012 prefix to be applied to installed executables
12013
12014 --program-suffix SUFFIX
12015 suffix to be applied to installed executables
12016
12017 --enable-library-vanilla
12018 --disable-library-vanilla
12019 Vanilla libraries
12020
12021 -p, --enable-library-profiling
12022 --disable-library-profiling
12023 Library profiling
12024
12025 --enable-shared
12026 --disable-shared
12027 Shared library
12028
12029 --enable-static
12030 --disable-static
12031 Static library
12032
12033 --enable-executable-dynamic
12034 --disable-executable-dynamic
12035 Executable dynamic linking
12036
12037 --enable-profiling
12038 --disable-profiling
12039 Executable and library profiling
12040
12041 --enable-executable-profiling
12042 --disable-executable-profiling
12043 Executable profiling (DEPRECATED)
12044
12045 --profiling-detail level
12046 Profiling detail level for executable and library
12047 (default, none, exported-functions, toplevel-functions,
12048 all-functions).
12049
12050 --library-profiling-detail level
12051 Profiling detail level for libraries only.
12052
12053 -O, --enable-optimization, --enable-optimisation [n]
12054 Build with optimization (n is 0--2, default is 1)
12055
12056 --disable-optimization, --disable-optimisation
12057 Build without optimization
12058
12059 --enable-debug-info [n]
12060 Emit debug info (n is 0--3, default is 0)
12061
12062 --disable-debug-info
12063 Don't emit debug info
12064
12065 --enable-library-for-ghci
12066 --disable-library-for-ghci
12067 compile library for use with GHCi
12068
12069 --enable-split-sections
12070 --disable-split-sections
12071 compile library code such that unneeded definitions can
12072 be dropped from the final executable (GHC 7.8+)
12073
12074 --enable-split-objs
12075 --disable-split-objs
12076 split library into smaller objects to reduce binary sizes
12077 (GHC 6.6+)
12078
12079 --enable-executable-stripping
12080 --disable-executable-stripping
12081 strip executables upon installation to reduce binary
12082 sizes
12083
12084 --enable-library-stripping
12085 --disable-library-stripping
12086 strip libraries upon installation to reduce binary sizes
12087
12088 --configure-option OPT
12089 Extra option for configure
12090
12091 --user
12092 --global
12093 doing a per-user installation
12094
12095 --package-db DB
12096 Append the given package database to the list of package
12097 databases used (to satisfy dependencies and register
12098 into). May be a specific file, 'global' or 'user'. The
12099 initial list is ['global'], ['global', 'user'], or
12100 ['global', $sandbox], depending on context. Use 'clear'
12101 to reset the list to empty. See the user guide for
12102 details.
12103
12104 -f, --flags FLAGS
12105 Force values for the given flags in Cabal conditionals in
12106 the .cabal file. E.g., --flags="debug -usebytestrings"
12107 forces the flag "debug" to true and "usebytestrings" to
12108 false.
12109
12110 --extra-include-dirs PATH
12111 A list of directories to search for header files
12112
12113 --enable-deterministic
12114 --disable-deterministic
12115 Try to be as deterministic as possible (used by the test
12116 suite)
12117
12118 --ipid IPID
12119 Installed package ID to compile this package as
12120
12121 --cid CID
12122 Installed component ID to compile this component as
12123
12124 --extra-lib-dirs PATH
12125 A list of directories to search for external libraries
12126
12127 --extra-framework-dirs PATH
12128 A list of directories to search for external frameworks
12129 (OS X only)
12130
12131 --extra-prog-path PATH
12132 A list of directories to search for required programs (in
12133 addition to the normal search locations)
12134
12135 --instantiate-with NAME=MOD
12136 A mapping of signature names to concrete module instanti‐
12137 ations.
12138
12139 --enable-tests
12140 --disable-tests
12141 dependency checking and compilation for test suites
12142 listed in the package description file.
12143
12144 --enable-coverage
12145 --disable-coverage
12146 build package with Haskell Program Coverage. (GHC only)
12147
12148 --enable-library-coverage
12149 --disable-library-coverage
12150 build package with Haskell Program Coverage. (GHC only)
12151 (DEPRECATED)
12152
12153 --enable-benchmarks
12154 --disable-benchmarks
12155 dependency checking and compilation for benchmarks listed
12156 in the package description file.
12157
12158 --enable-relocatable
12159 --disable-relocatable
12160 building a package that is relocatable. (GHC only)
12161
12162 --disable-response-files
12163 enable workaround for old versions of programs like "ar"
12164 that do not support @file arguments
12165
12166 --with-alex PATH
12167 give the path to alex
12168
12169 --with-ar PATH
12170 give the path to ar
12171
12172 --with-c2hs PATH
12173 give the path to c2hs
12174
12175 --with-cpphs PATH
12176 give the path to cpphs
12177
12178 --with-doctest PATH
12179 give the path to doctest
12180
12181 --with-gcc PATH
12182 give the path to gcc
12183
12184 --with-ghc PATH
12185 give the path to ghc
12186
12187 --with-ghc-pkg PATH
12188 give the path to ghc-pkg
12189
12190 --with-ghcjs PATH
12191 give the path to ghcjs
12192
12193 --with-ghcjs-pkg PATH
12194 give the path to ghcjs-pkg
12195
12196 --with-greencard PATH
12197 give the path to greencard
12198
12199 --with-haddock PATH
12200 give the path to haddock
12201
12202 --with-happy PATH
12203 give the path to happy
12204
12205 --with-haskell-suite PATH
12206 give the path to haskell-suite
12207
12208 --with-haskell-suite-pkg PATH
12209 give the path to haskell-suite-pkg
12210
12211 --with-hmake PATH
12212 give the path to hmake
12213
12214 --with-hpc PATH
12215 give the path to hpc
12216
12217 --with-hsc2hs PATH
12218 give the path to hsc2hs
12219
12220 --with-hscolour PATH
12221 give the path to hscolour
12222
12223 --with-jhc PATH
12224 give the path to jhc
12225
12226 --with-ld PATH
12227 give the path to ld
12228
12229 --with-pkg-config PATH
12230 give the path to pkg-config
12231
12232 --with-runghc PATH
12233 give the path to runghc
12234
12235 --with-strip PATH
12236 give the path to strip
12237
12238 --with-tar PATH
12239 give the path to tar
12240
12241 --with-uhc PATH
12242 give the path to uhc
12243
12244 --alex-option OPT
12245 give an extra option to alex (no need to quote options
12246 containing spaces)
12247
12248 --ar-option OPT
12249 give an extra option to ar (no need to quote options con‐
12250 taining spaces)
12251
12252 --c2hs-option OPT
12253 give an extra option to c2hs (no need to quote options
12254 containing spaces)
12255
12256 --cpphs-option OPT
12257 give an extra option to cpphs (no need to quote options
12258 containing spaces)
12259
12260 --doctest-option OPT
12261 give an extra option to doctest (no need to quote options
12262 containing spaces)
12263
12264 --gcc-option OPT
12265 give an extra option to gcc (no need to quote options
12266 containing spaces)
12267
12268 --ghc-option OPT
12269 give an extra option to ghc (no need to quote options
12270 containing spaces)
12271
12272 --ghc-pkg-option OPT
12273 give an extra option to ghc-pkg (no need to quote options
12274 containing spaces)
12275
12276 --ghcjs-option OPT
12277 give an extra option to ghcjs (no need to quote options
12278 containing spaces)
12279
12280 --ghcjs-pkg-option OPT
12281 give an extra option to ghcjs-pkg (no need to quote
12282 options containing spaces)
12283
12284 --greencard-option OPT
12285 give an extra option to greencard (no need to quote
12286 options containing spaces)
12287
12288 --haddock-option OPT
12289 give an extra option to haddock (no need to quote options
12290 containing spaces)
12291
12292 --happy-option OPT
12293 give an extra option to happy (no need to quote options
12294 containing spaces)
12295
12296 --haskell-suite-option OPT
12297 give an extra option to haskell-suite (no need to quote
12298 options containing spaces)
12299
12300 --haskell-suite-pkg-option OPT
12301 give an extra option to haskell-suite-pkg (no need to
12302 quote options containing spaces)
12303
12304 --hmake-option OPT
12305 give an extra option to hmake (no need to quote options
12306 containing spaces)
12307
12308 --hpc-option OPT
12309 give an extra option to hpc (no need to quote options
12310 containing spaces)
12311
12312 --hsc2hs-option OPT
12313 give an extra option to hsc2hs (no need to quote options
12314 containing spaces)
12315
12316 --hscolour-option OPT
12317 give an extra option to hscolour (no need to quote
12318 options containing spaces)
12319
12320 --jhc-option OPT
12321 give an extra option to jhc (no need to quote options
12322 containing spaces)
12323
12324 --ld-option OPT
12325 give an extra option to ld (no need to quote options con‐
12326 taining spaces)
12327
12328 --pkg-config-option OPT
12329 give an extra option to pkg-config (no need to quote
12330 options containing spaces)
12331
12332 --runghc-option OPT
12333 give an extra option to runghc (no need to quote options
12334 containing spaces)
12335
12336 --strip-option OPT
12337 give an extra option to strip (no need to quote options
12338 containing spaces)
12339
12340 --tar-option OPT
12341 give an extra option to tar (no need to quote options
12342 containing spaces)
12343
12344 --uhc-option OPT
12345 give an extra option to uhc (no need to quote options
12346 containing spaces)
12347
12348 --alex-options OPTS
12349 give extra options to alex
12350
12351 --ar-options OPTS
12352 give extra options to ar
12353
12354 --c2hs-options OPTS
12355 give extra options to c2hs
12356
12357 --cpphs-options OPTS
12358 give extra options to cpphs
12359
12360 --doctest-options OPTS
12361 give extra options to doctest
12362
12363 --gcc-options OPTS
12364 give extra options to gcc
12365
12366 --ghc-options OPTS
12367 give extra options to ghc
12368
12369 --ghc-pkg-options OPTS
12370 give extra options to ghc-pkg
12371
12372 --ghcjs-options OPTS
12373 give extra options to ghcjs
12374
12375 --ghcjs-pkg-options OPTS
12376 give extra options to ghcjs-pkg
12377
12378 --greencard-options OPTS
12379 give extra options to greencard
12380
12381 --haddock-options OPTS
12382 give extra options to haddock
12383
12384 --happy-options OPTS
12385 give extra options to happy
12386
12387 --haskell-suite-options OPTS
12388 give extra options to haskell-suite
12389
12390 --haskell-suite-pkg-options OPTS
12391 give extra options to haskell-suite-pkg
12392
12393 --hmake-options OPTS
12394 give extra options to hmake
12395
12396 --hpc-options OPTS
12397 give extra options to hpc
12398
12399 --hsc2hs-options OPTS
12400 give extra options to hsc2hs
12401
12402 --hscolour-options OPTS
12403 give extra options to hscolour
12404
12405 --jhc-options OPTS
12406 give extra options to jhc
12407
12408 --ld-options OPTS
12409 give extra options to ld
12410
12411 --pkg-config-options OPTS
12412 give extra options to pkg-config
12413
12414 --runghc-options OPTS
12415 give extra options to runghc
12416
12417 --strip-options OPTS
12418 give extra options to strip
12419
12420 --tar-options OPTS
12421 give extra options to tar
12422
12423 --uhc-options OPTS
12424 give extra options to uhc
12425
12426 --cabal-lib-version VERSION
12427 Select which version of the Cabal lib to use to build
12428 packages (useful for testing).
12429
12430 --constraint CONSTRAINT
12431 Specify constraints on a package (version,
12432 installed/source, flags)
12433
12434 --preference CONSTRAINT
12435 Specify preferences (soft constraints) on the version of
12436 a package
12437
12438 --solver SOLVER
12439 Select dependency solver to use (default: modular).
12440 Choices: modular.
12441
12442 --allow-older [DEPS]
12443 Ignore lower bounds in all dependencies or DEPS
12444
12445 --allow-newer [DEPS]
12446 Ignore upper bounds in all dependencies or DEPS
12447
12448 --write-ghc-environment-files always|never|ghc8.4.4+
12449 Whether to create a .ghc.environment file after a suc‐
12450 cessful build (v2-build only)
12451
12452 --enable-documentation
12453 --disable-documentation
12454 building of documentation
12455
12456 --doc-index-file TEMPLATE
12457 A central index of haddock API documentation (template
12458 cannot use $pkgid)
12459
12460 --dry-run
12461 Do not install anything, only print what would be
12462 installed.
12463
12464 --max-backjumps NUM
12465 Maximum number of backjumps allowed while solving
12466 (default: 2000). Use a negative number to enable unlim‐
12467 ited backtracking. Use 0 to disable backtracking com‐
12468 pletely.
12469
12470 --reorder-goals
12471 --no-reorder-goals
12472 Try to reorder goals according to certain heuristics.
12473 Slows things down on average, but may make backtracking
12474 faster for some packages.
12475
12476 --count-conflicts
12477 --no-count-conflicts
12478 Try to speed up solving by preferring goals that are
12479 involved in a lot of conflicts (default).
12480
12481 --independent-goals
12482 --no-independent-goals
12483 Treat several goals on the command line as independent.
12484 If several goals depend on the same package, different
12485 versions can be chosen.
12486
12487 --shadow-installed-packages
12488 --no-shadow-installed-packages
12489 If multiple package instances of the same version are
12490 installed, treat all but one as shadowed.
12491
12492 --strong-flags
12493 --no-strong-flags
12494 Do not defer flag choices (this used to be the default in
12495 cabal-install <= 1.20).
12496
12497 --allow-boot-library-installs
12498 --no-allow-boot-library-installs
12499 Allow cabal to install base, ghc-prim, integer-simple,
12500 integer-gmp, and template-haskell.
12501
12502 --reinstall
12503 --no-reinstall
12504 Install even if it means installing the same version
12505 again.
12506
12507 --avoid-reinstalls
12508 --no-avoid-reinstalls
12509 Do not select versions that would destructively overwrite
12510 installed packages.
12511
12512 --force-reinstalls
12513 --no-force-reinstalls
12514 Reinstall packages even if they will most likely break
12515 other installed packages.
12516
12517 --upgrade-dependencies
12518 --no-upgrade-dependencies
12519 Pick the latest version for all dependencies, rather than
12520 trying to pick an installed version.
12521
12522 --only-dependencies
12523 --no-only-dependencies
12524 Install only the dependencies necessary to build the
12525 given packages
12526
12527 --dependencies-only
12528 --no-dependencies-only
12529 A synonym for --only-dependencies
12530
12531 --index-state STATE
12532 Use source package index state as it existed at a previ‐
12533 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
12534 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
12535 'HEAD' (default: 'HEAD').
12536
12537 --root-cmd COMMAND
12538 (No longer supported, do not use.)
12539
12540 --symlink-bindir DIR
12541 Add symlinks to installed executables into this direc‐
12542 tory.
12543
12544 --build-summary TEMPLATE
12545 Save build summaries to file (name template can use
12546 $pkgid, $compiler, $os, $arch)
12547
12548 --build-log TEMPLATE
12549 Log all builds to file (name template can use $pkgid,
12550 $compiler, $os, $arch)
12551
12552 --remote-build-reporting LEVEL
12553 Generate build reports to send to a remote server (none,
12554 anonymous or detailed).
12555
12556 --report-planning-failure
12557 Generate build reports when the dependency solver fails.
12558 This is used by the Hackage build bot.
12559
12560 --enable-per-component
12561 --disable-per-component
12562 Per-component builds when possible
12563
12564 --one-shot
12565 --no-one-shot
12566 Do not record the packages in the world file.
12567
12568 --run-tests
12569 Run package test suites during installation.
12570
12571 -j, --jobs [NUM]
12572 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
12573 given).
12574
12575 --keep-going
12576 After a build failure, continue to build other unaffected
12577 packages.
12578
12579 --offline
12580 --no-offline
12581 Don't download packages from the Internet.
12582
12583 --project-file FILE
12584 Set the name of the cabal.project file to search for in
12585 parent directories
12586
12587 --only
12588 Only installs the package in the current directory.
12589
12590 --haddock-hoogle
12591 Generate a hoogle database
12592
12593 --haddock-html
12594 Generate HTML documentation (the default)
12595
12596 --haddock-html-location URL
12597 Location of HTML documentation for pre-requisite packages
12598
12599 --haddock-for-hackage
12600 Collection of flags to generate documentation suitable
12601 for upload to hackage
12602
12603 --haddock-executables
12604 Run haddock for Executables targets
12605
12606 --haddock-tests
12607 Run haddock for Test Suite targets
12608
12609 --haddock-benchmarks
12610 Run haddock for Benchmark targets
12611
12612 --haddock-all
12613 Run haddock for all targets
12614
12615 --haddock-internal
12616 Run haddock for internal modules and include all symbols
12617
12618 --haddock-css PATH
12619 Use PATH as the haddock stylesheet
12620
12621 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
12622 dock-hyperlinked-source
12623 Hyperlink the documentation to the source code
12624
12625 --haddock-quickjump
12626 Generate an index for interactive documentation naviga‐
12627 tion
12628
12629 --haddock-hscolour-css PATH
12630 Use PATH as the HsColour stylesheet
12631
12632 --haddock-contents-location URL
12633 Bake URL in as the location for the contents page
12634
12635
12636 cabal new-test
12637
12638 Usage: cabal new-test [TARGETS] [FLAGS]
12639
12640
12641 Runs the specified test-suites, first ensuring they are up to date.
12642
12643 Any test-suite in any package in the project can be specified. A pack‐
12644 age can be specified in which case all the test-suites in the package
12645 are run. The default is to run all the test-suites in the package in
12646 the current directory.
12647
12648 Dependencies are built or rebuilt as necessary. Additional configura‐
12649 tion flags can be specified on the command line and these extend the
12650 project configuration from the 'cabal.project', 'cabal.project.local'
12651 and other files.
12652
12653 To pass command-line arguments to a test suite, see the new-run com‐
12654 mand.
12655
12656
12657 Examples:
12658 cabal new-test
12659 Run all the test-suites in the package in the current directory
12660 cabal new-test pkgname
12661 Run all the test-suites in the package named pkgname
12662 cabal new-test cname
12663 Run the test-suite named cname
12664 cabal new-test cname --enable-coverage
12665 Run the test-suite built with code coverage (including local libs
12666 used)
12667
12668 Note: this command is part of the new project-based system (aka nix-
12669 style local builds). These features are currently in beta. Please see
12670 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
12671 details and advice on what you can expect to work. If you encounter
12672 problems please file issues at https://github.com/haskell/cabal/issues
12673 and if you have any time to get involved and help with testing, fixing
12674 bugs etc then that is very much appreciated.
12675
12676
12677 Flags:
12678 -v, --verbose [n]
12679 Control verbosity (n is 0--3, default verbosity level is
12680 1)
12681
12682 --builddir, --distdir, --distpref DIR
12683 The directory where Cabal puts generated build files
12684 (default dist)
12685
12686 -g, --ghc
12687 compile with GHC
12688
12689 --ghcjs
12690 compile with GHCJS
12691
12692 --uhc
12693 compile with UHC
12694
12695 --haskell-suite
12696 compile with a haskell-suite compiler
12697
12698 --cabal-file PATH
12699 use this Cabal file
12700
12701 -w, --with-compiler PATH
12702 give the path to a particular compiler
12703
12704 --with-hc-pkg PATH
12705 give the path to the package tool
12706
12707 --prefix DIR
12708 bake this prefix in preparation of installation
12709
12710 --bindir DIR
12711 installation directory for executables
12712
12713 --libdir DIR
12714 installation directory for libraries
12715
12716 --libsubdir DIR
12717 subdirectory of libdir in which libs are installed
12718
12719 --dynlibdir DIR
12720 installation directory for dynamic libraries
12721
12722 --libexecdir DIR
12723 installation directory for program executables
12724
12725 --libexecsubdir DIR
12726 subdirectory of libexecdir in which private executables
12727 are installed
12728
12729 --datadir DIR
12730 installation directory for read-only data
12731
12732 --datasubdir DIR
12733 subdirectory of datadir in which data files are installed
12734
12735 --docdir DIR
12736 installation directory for documentation
12737
12738 --htmldir DIR
12739 installation directory for HTML documentation
12740
12741 --haddockdir DIR
12742 installation directory for haddock interfaces
12743
12744 --sysconfdir DIR
12745 installation directory for configuration files
12746
12747 --program-prefix PREFIX
12748 prefix to be applied to installed executables
12749
12750 --program-suffix SUFFIX
12751 suffix to be applied to installed executables
12752
12753 --enable-library-vanilla
12754 --disable-library-vanilla
12755 Vanilla libraries
12756
12757 -p, --enable-library-profiling
12758 --disable-library-profiling
12759 Library profiling
12760
12761 --enable-shared
12762 --disable-shared
12763 Shared library
12764
12765 --enable-static
12766 --disable-static
12767 Static library
12768
12769 --enable-executable-dynamic
12770 --disable-executable-dynamic
12771 Executable dynamic linking
12772
12773 --enable-profiling
12774 --disable-profiling
12775 Executable and library profiling
12776
12777 --enable-executable-profiling
12778 --disable-executable-profiling
12779 Executable profiling (DEPRECATED)
12780
12781 --profiling-detail level
12782 Profiling detail level for executable and library
12783 (default, none, exported-functions, toplevel-functions,
12784 all-functions).
12785
12786 --library-profiling-detail level
12787 Profiling detail level for libraries only.
12788
12789 -O, --enable-optimization, --enable-optimisation [n]
12790 Build with optimization (n is 0--2, default is 1)
12791
12792 --disable-optimization, --disable-optimisation
12793 Build without optimization
12794
12795 --enable-debug-info [n]
12796 Emit debug info (n is 0--3, default is 0)
12797
12798 --disable-debug-info
12799 Don't emit debug info
12800
12801 --enable-library-for-ghci
12802 --disable-library-for-ghci
12803 compile library for use with GHCi
12804
12805 --enable-split-sections
12806 --disable-split-sections
12807 compile library code such that unneeded definitions can
12808 be dropped from the final executable (GHC 7.8+)
12809
12810 --enable-split-objs
12811 --disable-split-objs
12812 split library into smaller objects to reduce binary sizes
12813 (GHC 6.6+)
12814
12815 --enable-executable-stripping
12816 --disable-executable-stripping
12817 strip executables upon installation to reduce binary
12818 sizes
12819
12820 --enable-library-stripping
12821 --disable-library-stripping
12822 strip libraries upon installation to reduce binary sizes
12823
12824 --configure-option OPT
12825 Extra option for configure
12826
12827 --user
12828 --global
12829 doing a per-user installation
12830
12831 --package-db DB
12832 Append the given package database to the list of package
12833 databases used (to satisfy dependencies and register
12834 into). May be a specific file, 'global' or 'user'. The
12835 initial list is ['global'], ['global', 'user'], or
12836 ['global', $sandbox], depending on context. Use 'clear'
12837 to reset the list to empty. See the user guide for
12838 details.
12839
12840 -f, --flags FLAGS
12841 Force values for the given flags in Cabal conditionals in
12842 the .cabal file. E.g., --flags="debug -usebytestrings"
12843 forces the flag "debug" to true and "usebytestrings" to
12844 false.
12845
12846 --extra-include-dirs PATH
12847 A list of directories to search for header files
12848
12849 --enable-deterministic
12850 --disable-deterministic
12851 Try to be as deterministic as possible (used by the test
12852 suite)
12853
12854 --ipid IPID
12855 Installed package ID to compile this package as
12856
12857 --cid CID
12858 Installed component ID to compile this component as
12859
12860 --extra-lib-dirs PATH
12861 A list of directories to search for external libraries
12862
12863 --extra-framework-dirs PATH
12864 A list of directories to search for external frameworks
12865 (OS X only)
12866
12867 --extra-prog-path PATH
12868 A list of directories to search for required programs (in
12869 addition to the normal search locations)
12870
12871 --instantiate-with NAME=MOD
12872 A mapping of signature names to concrete module instanti‐
12873 ations.
12874
12875 --enable-tests
12876 --disable-tests
12877 dependency checking and compilation for test suites
12878 listed in the package description file.
12879
12880 --enable-coverage
12881 --disable-coverage
12882 build package with Haskell Program Coverage. (GHC only)
12883
12884 --enable-library-coverage
12885 --disable-library-coverage
12886 build package with Haskell Program Coverage. (GHC only)
12887 (DEPRECATED)
12888
12889 --enable-benchmarks
12890 --disable-benchmarks
12891 dependency checking and compilation for benchmarks listed
12892 in the package description file.
12893
12894 --enable-relocatable
12895 --disable-relocatable
12896 building a package that is relocatable. (GHC only)
12897
12898 --disable-response-files
12899 enable workaround for old versions of programs like "ar"
12900 that do not support @file arguments
12901
12902 --with-alex PATH
12903 give the path to alex
12904
12905 --with-ar PATH
12906 give the path to ar
12907
12908 --with-c2hs PATH
12909 give the path to c2hs
12910
12911 --with-cpphs PATH
12912 give the path to cpphs
12913
12914 --with-doctest PATH
12915 give the path to doctest
12916
12917 --with-gcc PATH
12918 give the path to gcc
12919
12920 --with-ghc PATH
12921 give the path to ghc
12922
12923 --with-ghc-pkg PATH
12924 give the path to ghc-pkg
12925
12926 --with-ghcjs PATH
12927 give the path to ghcjs
12928
12929 --with-ghcjs-pkg PATH
12930 give the path to ghcjs-pkg
12931
12932 --with-greencard PATH
12933 give the path to greencard
12934
12935 --with-haddock PATH
12936 give the path to haddock
12937
12938 --with-happy PATH
12939 give the path to happy
12940
12941 --with-haskell-suite PATH
12942 give the path to haskell-suite
12943
12944 --with-haskell-suite-pkg PATH
12945 give the path to haskell-suite-pkg
12946
12947 --with-hmake PATH
12948 give the path to hmake
12949
12950 --with-hpc PATH
12951 give the path to hpc
12952
12953 --with-hsc2hs PATH
12954 give the path to hsc2hs
12955
12956 --with-hscolour PATH
12957 give the path to hscolour
12958
12959 --with-jhc PATH
12960 give the path to jhc
12961
12962 --with-ld PATH
12963 give the path to ld
12964
12965 --with-pkg-config PATH
12966 give the path to pkg-config
12967
12968 --with-runghc PATH
12969 give the path to runghc
12970
12971 --with-strip PATH
12972 give the path to strip
12973
12974 --with-tar PATH
12975 give the path to tar
12976
12977 --with-uhc PATH
12978 give the path to uhc
12979
12980 --alex-option OPT
12981 give an extra option to alex (no need to quote options
12982 containing spaces)
12983
12984 --ar-option OPT
12985 give an extra option to ar (no need to quote options con‐
12986 taining spaces)
12987
12988 --c2hs-option OPT
12989 give an extra option to c2hs (no need to quote options
12990 containing spaces)
12991
12992 --cpphs-option OPT
12993 give an extra option to cpphs (no need to quote options
12994 containing spaces)
12995
12996 --doctest-option OPT
12997 give an extra option to doctest (no need to quote options
12998 containing spaces)
12999
13000 --gcc-option OPT
13001 give an extra option to gcc (no need to quote options
13002 containing spaces)
13003
13004 --ghc-option OPT
13005 give an extra option to ghc (no need to quote options
13006 containing spaces)
13007
13008 --ghc-pkg-option OPT
13009 give an extra option to ghc-pkg (no need to quote options
13010 containing spaces)
13011
13012 --ghcjs-option OPT
13013 give an extra option to ghcjs (no need to quote options
13014 containing spaces)
13015
13016 --ghcjs-pkg-option OPT
13017 give an extra option to ghcjs-pkg (no need to quote
13018 options containing spaces)
13019
13020 --greencard-option OPT
13021 give an extra option to greencard (no need to quote
13022 options containing spaces)
13023
13024 --haddock-option OPT
13025 give an extra option to haddock (no need to quote options
13026 containing spaces)
13027
13028 --happy-option OPT
13029 give an extra option to happy (no need to quote options
13030 containing spaces)
13031
13032 --haskell-suite-option OPT
13033 give an extra option to haskell-suite (no need to quote
13034 options containing spaces)
13035
13036 --haskell-suite-pkg-option OPT
13037 give an extra option to haskell-suite-pkg (no need to
13038 quote options containing spaces)
13039
13040 --hmake-option OPT
13041 give an extra option to hmake (no need to quote options
13042 containing spaces)
13043
13044 --hpc-option OPT
13045 give an extra option to hpc (no need to quote options
13046 containing spaces)
13047
13048 --hsc2hs-option OPT
13049 give an extra option to hsc2hs (no need to quote options
13050 containing spaces)
13051
13052 --hscolour-option OPT
13053 give an extra option to hscolour (no need to quote
13054 options containing spaces)
13055
13056 --jhc-option OPT
13057 give an extra option to jhc (no need to quote options
13058 containing spaces)
13059
13060 --ld-option OPT
13061 give an extra option to ld (no need to quote options con‐
13062 taining spaces)
13063
13064 --pkg-config-option OPT
13065 give an extra option to pkg-config (no need to quote
13066 options containing spaces)
13067
13068 --runghc-option OPT
13069 give an extra option to runghc (no need to quote options
13070 containing spaces)
13071
13072 --strip-option OPT
13073 give an extra option to strip (no need to quote options
13074 containing spaces)
13075
13076 --tar-option OPT
13077 give an extra option to tar (no need to quote options
13078 containing spaces)
13079
13080 --uhc-option OPT
13081 give an extra option to uhc (no need to quote options
13082 containing spaces)
13083
13084 --alex-options OPTS
13085 give extra options to alex
13086
13087 --ar-options OPTS
13088 give extra options to ar
13089
13090 --c2hs-options OPTS
13091 give extra options to c2hs
13092
13093 --cpphs-options OPTS
13094 give extra options to cpphs
13095
13096 --doctest-options OPTS
13097 give extra options to doctest
13098
13099 --gcc-options OPTS
13100 give extra options to gcc
13101
13102 --ghc-options OPTS
13103 give extra options to ghc
13104
13105 --ghc-pkg-options OPTS
13106 give extra options to ghc-pkg
13107
13108 --ghcjs-options OPTS
13109 give extra options to ghcjs
13110
13111 --ghcjs-pkg-options OPTS
13112 give extra options to ghcjs-pkg
13113
13114 --greencard-options OPTS
13115 give extra options to greencard
13116
13117 --haddock-options OPTS
13118 give extra options to haddock
13119
13120 --happy-options OPTS
13121 give extra options to happy
13122
13123 --haskell-suite-options OPTS
13124 give extra options to haskell-suite
13125
13126 --haskell-suite-pkg-options OPTS
13127 give extra options to haskell-suite-pkg
13128
13129 --hmake-options OPTS
13130 give extra options to hmake
13131
13132 --hpc-options OPTS
13133 give extra options to hpc
13134
13135 --hsc2hs-options OPTS
13136 give extra options to hsc2hs
13137
13138 --hscolour-options OPTS
13139 give extra options to hscolour
13140
13141 --jhc-options OPTS
13142 give extra options to jhc
13143
13144 --ld-options OPTS
13145 give extra options to ld
13146
13147 --pkg-config-options OPTS
13148 give extra options to pkg-config
13149
13150 --runghc-options OPTS
13151 give extra options to runghc
13152
13153 --strip-options OPTS
13154 give extra options to strip
13155
13156 --tar-options OPTS
13157 give extra options to tar
13158
13159 --uhc-options OPTS
13160 give extra options to uhc
13161
13162 --cabal-lib-version VERSION
13163 Select which version of the Cabal lib to use to build
13164 packages (useful for testing).
13165
13166 --constraint CONSTRAINT
13167 Specify constraints on a package (version,
13168 installed/source, flags)
13169
13170 --preference CONSTRAINT
13171 Specify preferences (soft constraints) on the version of
13172 a package
13173
13174 --solver SOLVER
13175 Select dependency solver to use (default: modular).
13176 Choices: modular.
13177
13178 --allow-older [DEPS]
13179 Ignore lower bounds in all dependencies or DEPS
13180
13181 --allow-newer [DEPS]
13182 Ignore upper bounds in all dependencies or DEPS
13183
13184 --write-ghc-environment-files always|never|ghc8.4.4+
13185 Whether to create a .ghc.environment file after a suc‐
13186 cessful build (v2-build only)
13187
13188 --enable-documentation
13189 --disable-documentation
13190 building of documentation
13191
13192 --doc-index-file TEMPLATE
13193 A central index of haddock API documentation (template
13194 cannot use $pkgid)
13195
13196 --dry-run
13197 Do not install anything, only print what would be
13198 installed.
13199
13200 --max-backjumps NUM
13201 Maximum number of backjumps allowed while solving
13202 (default: 2000). Use a negative number to enable unlim‐
13203 ited backtracking. Use 0 to disable backtracking com‐
13204 pletely.
13205
13206 --reorder-goals
13207 --no-reorder-goals
13208 Try to reorder goals according to certain heuristics.
13209 Slows things down on average, but may make backtracking
13210 faster for some packages.
13211
13212 --count-conflicts
13213 --no-count-conflicts
13214 Try to speed up solving by preferring goals that are
13215 involved in a lot of conflicts (default).
13216
13217 --independent-goals
13218 --no-independent-goals
13219 Treat several goals on the command line as independent.
13220 If several goals depend on the same package, different
13221 versions can be chosen.
13222
13223 --shadow-installed-packages
13224 --no-shadow-installed-packages
13225 If multiple package instances of the same version are
13226 installed, treat all but one as shadowed.
13227
13228 --strong-flags
13229 --no-strong-flags
13230 Do not defer flag choices (this used to be the default in
13231 cabal-install <= 1.20).
13232
13233 --allow-boot-library-installs
13234 --no-allow-boot-library-installs
13235 Allow cabal to install base, ghc-prim, integer-simple,
13236 integer-gmp, and template-haskell.
13237
13238 --reinstall
13239 --no-reinstall
13240 Install even if it means installing the same version
13241 again.
13242
13243 --avoid-reinstalls
13244 --no-avoid-reinstalls
13245 Do not select versions that would destructively overwrite
13246 installed packages.
13247
13248 --force-reinstalls
13249 --no-force-reinstalls
13250 Reinstall packages even if they will most likely break
13251 other installed packages.
13252
13253 --upgrade-dependencies
13254 --no-upgrade-dependencies
13255 Pick the latest version for all dependencies, rather than
13256 trying to pick an installed version.
13257
13258 --only-dependencies
13259 --no-only-dependencies
13260 Install only the dependencies necessary to build the
13261 given packages
13262
13263 --dependencies-only
13264 --no-dependencies-only
13265 A synonym for --only-dependencies
13266
13267 --index-state STATE
13268 Use source package index state as it existed at a previ‐
13269 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
13270 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
13271 'HEAD' (default: 'HEAD').
13272
13273 --root-cmd COMMAND
13274 (No longer supported, do not use.)
13275
13276 --symlink-bindir DIR
13277 Add symlinks to installed executables into this direc‐
13278 tory.
13279
13280 --build-summary TEMPLATE
13281 Save build summaries to file (name template can use
13282 $pkgid, $compiler, $os, $arch)
13283
13284 --build-log TEMPLATE
13285 Log all builds to file (name template can use $pkgid,
13286 $compiler, $os, $arch)
13287
13288 --remote-build-reporting LEVEL
13289 Generate build reports to send to a remote server (none,
13290 anonymous or detailed).
13291
13292 --report-planning-failure
13293 Generate build reports when the dependency solver fails.
13294 This is used by the Hackage build bot.
13295
13296 --enable-per-component
13297 --disable-per-component
13298 Per-component builds when possible
13299
13300 --one-shot
13301 --no-one-shot
13302 Do not record the packages in the world file.
13303
13304 --run-tests
13305 Run package test suites during installation.
13306
13307 -j, --jobs [NUM]
13308 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
13309 given).
13310
13311 --keep-going
13312 After a build failure, continue to build other unaffected
13313 packages.
13314
13315 --offline
13316 --no-offline
13317 Don't download packages from the Internet.
13318
13319 --project-file FILE
13320 Set the name of the cabal.project file to search for in
13321 parent directories
13322
13323 --only
13324 Only installs the package in the current directory.
13325
13326 --haddock-hoogle
13327 Generate a hoogle database
13328
13329 --haddock-html
13330 Generate HTML documentation (the default)
13331
13332 --haddock-html-location URL
13333 Location of HTML documentation for pre-requisite packages
13334
13335 --haddock-for-hackage
13336 Collection of flags to generate documentation suitable
13337 for upload to hackage
13338
13339 --haddock-executables
13340 Run haddock for Executables targets
13341
13342 --haddock-tests
13343 Run haddock for Test Suite targets
13344
13345 --haddock-benchmarks
13346 Run haddock for Benchmark targets
13347
13348 --haddock-all
13349 Run haddock for all targets
13350
13351 --haddock-internal
13352 Run haddock for internal modules and include all symbols
13353
13354 --haddock-css PATH
13355 Use PATH as the haddock stylesheet
13356
13357 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
13358 dock-hyperlinked-source
13359 Hyperlink the documentation to the source code
13360
13361 --haddock-quickjump
13362 Generate an index for interactive documentation naviga‐
13363 tion
13364
13365 --haddock-hscolour-css PATH
13366 Use PATH as the HsColour stylesheet
13367
13368 --haddock-contents-location URL
13369 Bake URL in as the location for the contents page
13370
13371
13372 cabal v2-bench
13373
13374 Usage: cabal v2-bench [TARGETS] [FLAGS]
13375
13376
13377 Runs the specified benchmarks, first ensuring they are up to date.
13378
13379 Any benchmark in any package in the project can be specified. A package
13380 can be specified in which case all the benchmarks in the package are
13381 run. The default is to run all the benchmarks in the package in the
13382 current directory.
13383
13384 Dependencies are built or rebuilt as necessary. Additional configura‐
13385 tion flags can be specified on the command line and these extend the
13386 project configuration from the 'cabal.project', 'cabal.project.local'
13387 and other files.
13388
13389
13390 Runs the specified benchmarks, first ensuring they are up to date.
13391
13392 Any benchmark in any package in the project can be specified. A package
13393 can be specified in which case all the benchmarks in the package are
13394 run. The default is to run all the benchmarks in the package in the
13395 current directory.
13396
13397 Dependencies are built or rebuilt as necessary. Additional configura‐
13398 tion flags can be specified on the command line and these extend the
13399 project configuration from the 'cabal.project', 'cabal.project.local'
13400 and other files.
13401
13402
13403 Flags:
13404 -v, --verbose [n]
13405 Control verbosity (n is 0--3, default verbosity level is
13406 1)
13407
13408 --builddir, --distdir, --distpref DIR
13409 The directory where Cabal puts generated build files
13410 (default dist)
13411
13412 -g, --ghc
13413 compile with GHC
13414
13415 --ghcjs
13416 compile with GHCJS
13417
13418 --uhc
13419 compile with UHC
13420
13421 --haskell-suite
13422 compile with a haskell-suite compiler
13423
13424 --cabal-file PATH
13425 use this Cabal file
13426
13427 -w, --with-compiler PATH
13428 give the path to a particular compiler
13429
13430 --with-hc-pkg PATH
13431 give the path to the package tool
13432
13433 --prefix DIR
13434 bake this prefix in preparation of installation
13435
13436 --bindir DIR
13437 installation directory for executables
13438
13439 --libdir DIR
13440 installation directory for libraries
13441
13442 --libsubdir DIR
13443 subdirectory of libdir in which libs are installed
13444
13445 --dynlibdir DIR
13446 installation directory for dynamic libraries
13447
13448 --libexecdir DIR
13449 installation directory for program executables
13450
13451 --libexecsubdir DIR
13452 subdirectory of libexecdir in which private executables
13453 are installed
13454
13455 --datadir DIR
13456 installation directory for read-only data
13457
13458 --datasubdir DIR
13459 subdirectory of datadir in which data files are installed
13460
13461 --docdir DIR
13462 installation directory for documentation
13463
13464 --htmldir DIR
13465 installation directory for HTML documentation
13466
13467 --haddockdir DIR
13468 installation directory for haddock interfaces
13469
13470 --sysconfdir DIR
13471 installation directory for configuration files
13472
13473 --program-prefix PREFIX
13474 prefix to be applied to installed executables
13475
13476 --program-suffix SUFFIX
13477 suffix to be applied to installed executables
13478
13479 --enable-library-vanilla
13480 --disable-library-vanilla
13481 Vanilla libraries
13482
13483 -p, --enable-library-profiling
13484 --disable-library-profiling
13485 Library profiling
13486
13487 --enable-shared
13488 --disable-shared
13489 Shared library
13490
13491 --enable-static
13492 --disable-static
13493 Static library
13494
13495 --enable-executable-dynamic
13496 --disable-executable-dynamic
13497 Executable dynamic linking
13498
13499 --enable-profiling
13500 --disable-profiling
13501 Executable and library profiling
13502
13503 --enable-executable-profiling
13504 --disable-executable-profiling
13505 Executable profiling (DEPRECATED)
13506
13507 --profiling-detail level
13508 Profiling detail level for executable and library
13509 (default, none, exported-functions, toplevel-functions,
13510 all-functions).
13511
13512 --library-profiling-detail level
13513 Profiling detail level for libraries only.
13514
13515 -O, --enable-optimization, --enable-optimisation [n]
13516 Build with optimization (n is 0--2, default is 1)
13517
13518 --disable-optimization, --disable-optimisation
13519 Build without optimization
13520
13521 --enable-debug-info [n]
13522 Emit debug info (n is 0--3, default is 0)
13523
13524 --disable-debug-info
13525 Don't emit debug info
13526
13527 --enable-library-for-ghci
13528 --disable-library-for-ghci
13529 compile library for use with GHCi
13530
13531 --enable-split-sections
13532 --disable-split-sections
13533 compile library code such that unneeded definitions can
13534 be dropped from the final executable (GHC 7.8+)
13535
13536 --enable-split-objs
13537 --disable-split-objs
13538 split library into smaller objects to reduce binary sizes
13539 (GHC 6.6+)
13540
13541 --enable-executable-stripping
13542 --disable-executable-stripping
13543 strip executables upon installation to reduce binary
13544 sizes
13545
13546 --enable-library-stripping
13547 --disable-library-stripping
13548 strip libraries upon installation to reduce binary sizes
13549
13550 --configure-option OPT
13551 Extra option for configure
13552
13553 --user
13554 --global
13555 doing a per-user installation
13556
13557 --package-db DB
13558 Append the given package database to the list of package
13559 databases used (to satisfy dependencies and register
13560 into). May be a specific file, 'global' or 'user'. The
13561 initial list is ['global'], ['global', 'user'], or
13562 ['global', $sandbox], depending on context. Use 'clear'
13563 to reset the list to empty. See the user guide for
13564 details.
13565
13566 -f, --flags FLAGS
13567 Force values for the given flags in Cabal conditionals in
13568 the .cabal file. E.g., --flags="debug -usebytestrings"
13569 forces the flag "debug" to true and "usebytestrings" to
13570 false.
13571
13572 --extra-include-dirs PATH
13573 A list of directories to search for header files
13574
13575 --enable-deterministic
13576 --disable-deterministic
13577 Try to be as deterministic as possible (used by the test
13578 suite)
13579
13580 --ipid IPID
13581 Installed package ID to compile this package as
13582
13583 --cid CID
13584 Installed component ID to compile this component as
13585
13586 --extra-lib-dirs PATH
13587 A list of directories to search for external libraries
13588
13589 --extra-framework-dirs PATH
13590 A list of directories to search for external frameworks
13591 (OS X only)
13592
13593 --extra-prog-path PATH
13594 A list of directories to search for required programs (in
13595 addition to the normal search locations)
13596
13597 --instantiate-with NAME=MOD
13598 A mapping of signature names to concrete module instanti‐
13599 ations.
13600
13601 --enable-tests
13602 --disable-tests
13603 dependency checking and compilation for test suites
13604 listed in the package description file.
13605
13606 --enable-coverage
13607 --disable-coverage
13608 build package with Haskell Program Coverage. (GHC only)
13609
13610 --enable-library-coverage
13611 --disable-library-coverage
13612 build package with Haskell Program Coverage. (GHC only)
13613 (DEPRECATED)
13614
13615 --enable-benchmarks
13616 --disable-benchmarks
13617 dependency checking and compilation for benchmarks listed
13618 in the package description file.
13619
13620 --enable-relocatable
13621 --disable-relocatable
13622 building a package that is relocatable. (GHC only)
13623
13624 --disable-response-files
13625 enable workaround for old versions of programs like "ar"
13626 that do not support @file arguments
13627
13628 --with-alex PATH
13629 give the path to alex
13630
13631 --with-ar PATH
13632 give the path to ar
13633
13634 --with-c2hs PATH
13635 give the path to c2hs
13636
13637 --with-cpphs PATH
13638 give the path to cpphs
13639
13640 --with-doctest PATH
13641 give the path to doctest
13642
13643 --with-gcc PATH
13644 give the path to gcc
13645
13646 --with-ghc PATH
13647 give the path to ghc
13648
13649 --with-ghc-pkg PATH
13650 give the path to ghc-pkg
13651
13652 --with-ghcjs PATH
13653 give the path to ghcjs
13654
13655 --with-ghcjs-pkg PATH
13656 give the path to ghcjs-pkg
13657
13658 --with-greencard PATH
13659 give the path to greencard
13660
13661 --with-haddock PATH
13662 give the path to haddock
13663
13664 --with-happy PATH
13665 give the path to happy
13666
13667 --with-haskell-suite PATH
13668 give the path to haskell-suite
13669
13670 --with-haskell-suite-pkg PATH
13671 give the path to haskell-suite-pkg
13672
13673 --with-hmake PATH
13674 give the path to hmake
13675
13676 --with-hpc PATH
13677 give the path to hpc
13678
13679 --with-hsc2hs PATH
13680 give the path to hsc2hs
13681
13682 --with-hscolour PATH
13683 give the path to hscolour
13684
13685 --with-jhc PATH
13686 give the path to jhc
13687
13688 --with-ld PATH
13689 give the path to ld
13690
13691 --with-pkg-config PATH
13692 give the path to pkg-config
13693
13694 --with-runghc PATH
13695 give the path to runghc
13696
13697 --with-strip PATH
13698 give the path to strip
13699
13700 --with-tar PATH
13701 give the path to tar
13702
13703 --with-uhc PATH
13704 give the path to uhc
13705
13706 --alex-option OPT
13707 give an extra option to alex (no need to quote options
13708 containing spaces)
13709
13710 --ar-option OPT
13711 give an extra option to ar (no need to quote options con‐
13712 taining spaces)
13713
13714 --c2hs-option OPT
13715 give an extra option to c2hs (no need to quote options
13716 containing spaces)
13717
13718 --cpphs-option OPT
13719 give an extra option to cpphs (no need to quote options
13720 containing spaces)
13721
13722 --doctest-option OPT
13723 give an extra option to doctest (no need to quote options
13724 containing spaces)
13725
13726 --gcc-option OPT
13727 give an extra option to gcc (no need to quote options
13728 containing spaces)
13729
13730 --ghc-option OPT
13731 give an extra option to ghc (no need to quote options
13732 containing spaces)
13733
13734 --ghc-pkg-option OPT
13735 give an extra option to ghc-pkg (no need to quote options
13736 containing spaces)
13737
13738 --ghcjs-option OPT
13739 give an extra option to ghcjs (no need to quote options
13740 containing spaces)
13741
13742 --ghcjs-pkg-option OPT
13743 give an extra option to ghcjs-pkg (no need to quote
13744 options containing spaces)
13745
13746 --greencard-option OPT
13747 give an extra option to greencard (no need to quote
13748 options containing spaces)
13749
13750 --haddock-option OPT
13751 give an extra option to haddock (no need to quote options
13752 containing spaces)
13753
13754 --happy-option OPT
13755 give an extra option to happy (no need to quote options
13756 containing spaces)
13757
13758 --haskell-suite-option OPT
13759 give an extra option to haskell-suite (no need to quote
13760 options containing spaces)
13761
13762 --haskell-suite-pkg-option OPT
13763 give an extra option to haskell-suite-pkg (no need to
13764 quote options containing spaces)
13765
13766 --hmake-option OPT
13767 give an extra option to hmake (no need to quote options
13768 containing spaces)
13769
13770 --hpc-option OPT
13771 give an extra option to hpc (no need to quote options
13772 containing spaces)
13773
13774 --hsc2hs-option OPT
13775 give an extra option to hsc2hs (no need to quote options
13776 containing spaces)
13777
13778 --hscolour-option OPT
13779 give an extra option to hscolour (no need to quote
13780 options containing spaces)
13781
13782 --jhc-option OPT
13783 give an extra option to jhc (no need to quote options
13784 containing spaces)
13785
13786 --ld-option OPT
13787 give an extra option to ld (no need to quote options con‐
13788 taining spaces)
13789
13790 --pkg-config-option OPT
13791 give an extra option to pkg-config (no need to quote
13792 options containing spaces)
13793
13794 --runghc-option OPT
13795 give an extra option to runghc (no need to quote options
13796 containing spaces)
13797
13798 --strip-option OPT
13799 give an extra option to strip (no need to quote options
13800 containing spaces)
13801
13802 --tar-option OPT
13803 give an extra option to tar (no need to quote options
13804 containing spaces)
13805
13806 --uhc-option OPT
13807 give an extra option to uhc (no need to quote options
13808 containing spaces)
13809
13810 --alex-options OPTS
13811 give extra options to alex
13812
13813 --ar-options OPTS
13814 give extra options to ar
13815
13816 --c2hs-options OPTS
13817 give extra options to c2hs
13818
13819 --cpphs-options OPTS
13820 give extra options to cpphs
13821
13822 --doctest-options OPTS
13823 give extra options to doctest
13824
13825 --gcc-options OPTS
13826 give extra options to gcc
13827
13828 --ghc-options OPTS
13829 give extra options to ghc
13830
13831 --ghc-pkg-options OPTS
13832 give extra options to ghc-pkg
13833
13834 --ghcjs-options OPTS
13835 give extra options to ghcjs
13836
13837 --ghcjs-pkg-options OPTS
13838 give extra options to ghcjs-pkg
13839
13840 --greencard-options OPTS
13841 give extra options to greencard
13842
13843 --haddock-options OPTS
13844 give extra options to haddock
13845
13846 --happy-options OPTS
13847 give extra options to happy
13848
13849 --haskell-suite-options OPTS
13850 give extra options to haskell-suite
13851
13852 --haskell-suite-pkg-options OPTS
13853 give extra options to haskell-suite-pkg
13854
13855 --hmake-options OPTS
13856 give extra options to hmake
13857
13858 --hpc-options OPTS
13859 give extra options to hpc
13860
13861 --hsc2hs-options OPTS
13862 give extra options to hsc2hs
13863
13864 --hscolour-options OPTS
13865 give extra options to hscolour
13866
13867 --jhc-options OPTS
13868 give extra options to jhc
13869
13870 --ld-options OPTS
13871 give extra options to ld
13872
13873 --pkg-config-options OPTS
13874 give extra options to pkg-config
13875
13876 --runghc-options OPTS
13877 give extra options to runghc
13878
13879 --strip-options OPTS
13880 give extra options to strip
13881
13882 --tar-options OPTS
13883 give extra options to tar
13884
13885 --uhc-options OPTS
13886 give extra options to uhc
13887
13888 --cabal-lib-version VERSION
13889 Select which version of the Cabal lib to use to build
13890 packages (useful for testing).
13891
13892 --constraint CONSTRAINT
13893 Specify constraints on a package (version,
13894 installed/source, flags)
13895
13896 --preference CONSTRAINT
13897 Specify preferences (soft constraints) on the version of
13898 a package
13899
13900 --solver SOLVER
13901 Select dependency solver to use (default: modular).
13902 Choices: modular.
13903
13904 --allow-older [DEPS]
13905 Ignore lower bounds in all dependencies or DEPS
13906
13907 --allow-newer [DEPS]
13908 Ignore upper bounds in all dependencies or DEPS
13909
13910 --write-ghc-environment-files always|never|ghc8.4.4+
13911 Whether to create a .ghc.environment file after a suc‐
13912 cessful build (v2-build only)
13913
13914 --enable-documentation
13915 --disable-documentation
13916 building of documentation
13917
13918 --doc-index-file TEMPLATE
13919 A central index of haddock API documentation (template
13920 cannot use $pkgid)
13921
13922 --dry-run
13923 Do not install anything, only print what would be
13924 installed.
13925
13926 --max-backjumps NUM
13927 Maximum number of backjumps allowed while solving
13928 (default: 2000). Use a negative number to enable unlim‐
13929 ited backtracking. Use 0 to disable backtracking com‐
13930 pletely.
13931
13932 --reorder-goals
13933 --no-reorder-goals
13934 Try to reorder goals according to certain heuristics.
13935 Slows things down on average, but may make backtracking
13936 faster for some packages.
13937
13938 --count-conflicts
13939 --no-count-conflicts
13940 Try to speed up solving by preferring goals that are
13941 involved in a lot of conflicts (default).
13942
13943 --independent-goals
13944 --no-independent-goals
13945 Treat several goals on the command line as independent.
13946 If several goals depend on the same package, different
13947 versions can be chosen.
13948
13949 --shadow-installed-packages
13950 --no-shadow-installed-packages
13951 If multiple package instances of the same version are
13952 installed, treat all but one as shadowed.
13953
13954 --strong-flags
13955 --no-strong-flags
13956 Do not defer flag choices (this used to be the default in
13957 cabal-install <= 1.20).
13958
13959 --allow-boot-library-installs
13960 --no-allow-boot-library-installs
13961 Allow cabal to install base, ghc-prim, integer-simple,
13962 integer-gmp, and template-haskell.
13963
13964 --reinstall
13965 --no-reinstall
13966 Install even if it means installing the same version
13967 again.
13968
13969 --avoid-reinstalls
13970 --no-avoid-reinstalls
13971 Do not select versions that would destructively overwrite
13972 installed packages.
13973
13974 --force-reinstalls
13975 --no-force-reinstalls
13976 Reinstall packages even if they will most likely break
13977 other installed packages.
13978
13979 --upgrade-dependencies
13980 --no-upgrade-dependencies
13981 Pick the latest version for all dependencies, rather than
13982 trying to pick an installed version.
13983
13984 --only-dependencies
13985 --no-only-dependencies
13986 Install only the dependencies necessary to build the
13987 given packages
13988
13989 --dependencies-only
13990 --no-dependencies-only
13991 A synonym for --only-dependencies
13992
13993 --index-state STATE
13994 Use source package index state as it existed at a previ‐
13995 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
13996 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
13997 'HEAD' (default: 'HEAD').
13998
13999 --root-cmd COMMAND
14000 (No longer supported, do not use.)
14001
14002 --symlink-bindir DIR
14003 Add symlinks to installed executables into this direc‐
14004 tory.
14005
14006 --build-summary TEMPLATE
14007 Save build summaries to file (name template can use
14008 $pkgid, $compiler, $os, $arch)
14009
14010 --build-log TEMPLATE
14011 Log all builds to file (name template can use $pkgid,
14012 $compiler, $os, $arch)
14013
14014 --remote-build-reporting LEVEL
14015 Generate build reports to send to a remote server (none,
14016 anonymous or detailed).
14017
14018 --report-planning-failure
14019 Generate build reports when the dependency solver fails.
14020 This is used by the Hackage build bot.
14021
14022 --enable-per-component
14023 --disable-per-component
14024 Per-component builds when possible
14025
14026 --one-shot
14027 --no-one-shot
14028 Do not record the packages in the world file.
14029
14030 --run-tests
14031 Run package test suites during installation.
14032
14033 -j, --jobs [NUM]
14034 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
14035 given).
14036
14037 --keep-going
14038 After a build failure, continue to build other unaffected
14039 packages.
14040
14041 --offline
14042 --no-offline
14043 Don't download packages from the Internet.
14044
14045 --project-file FILE
14046 Set the name of the cabal.project file to search for in
14047 parent directories
14048
14049 --only
14050 Only installs the package in the current directory.
14051
14052 --haddock-hoogle
14053 Generate a hoogle database
14054
14055 --haddock-html
14056 Generate HTML documentation (the default)
14057
14058 --haddock-html-location URL
14059 Location of HTML documentation for pre-requisite packages
14060
14061 --haddock-for-hackage
14062 Collection of flags to generate documentation suitable
14063 for upload to hackage
14064
14065 --haddock-executables
14066 Run haddock for Executables targets
14067
14068 --haddock-tests
14069 Run haddock for Test Suite targets
14070
14071 --haddock-benchmarks
14072 Run haddock for Benchmark targets
14073
14074 --haddock-all
14075 Run haddock for all targets
14076
14077 --haddock-internal
14078 Run haddock for internal modules and include all symbols
14079
14080 --haddock-css PATH
14081 Use PATH as the haddock stylesheet
14082
14083 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
14084 dock-hyperlinked-source
14085 Hyperlink the documentation to the source code
14086
14087 --haddock-quickjump
14088 Generate an index for interactive documentation naviga‐
14089 tion
14090
14091 --haddock-hscolour-css PATH
14092 Use PATH as the HsColour stylesheet
14093
14094 --haddock-contents-location URL
14095 Bake URL in as the location for the contents page
14096
14097
14098 cabal new-bench
14099
14100 Usage: cabal new-bench [TARGETS] [FLAGS]
14101
14102
14103 Runs the specified benchmarks, first ensuring they are up to date.
14104
14105 Any benchmark in any package in the project can be specified. A package
14106 can be specified in which case all the benchmarks in the package are
14107 run. The default is to run all the benchmarks in the package in the
14108 current directory.
14109
14110 Dependencies are built or rebuilt as necessary. Additional configura‐
14111 tion flags can be specified on the command line and these extend the
14112 project configuration from the 'cabal.project', 'cabal.project.local'
14113 and other files.
14114
14115
14116 Examples:
14117 cabal new-bench
14118 Run all the benchmarks in the package in the current directory
14119 cabal new-bench pkgname
14120 Run all the benchmarks in the package named pkgname
14121 cabal new-bench cname
14122 Run the benchmark named cname
14123 cabal new-bench cname -O2
14124 Run the benchmark built with '-O2' (including local libs used)
14125
14126 Note: this command is part of the new project-based system (aka nix-
14127 style local builds). These features are currently in beta. Please see
14128 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
14129 details and advice on what you can expect to work. If you encounter
14130 problems please file issues at https://github.com/haskell/cabal/issues
14131 and if you have any time to get involved and help with testing, fixing
14132 bugs etc then that is very much appreciated.
14133
14134
14135 Flags:
14136 -v, --verbose [n]
14137 Control verbosity (n is 0--3, default verbosity level is
14138 1)
14139
14140 --builddir, --distdir, --distpref DIR
14141 The directory where Cabal puts generated build files
14142 (default dist)
14143
14144 -g, --ghc
14145 compile with GHC
14146
14147 --ghcjs
14148 compile with GHCJS
14149
14150 --uhc
14151 compile with UHC
14152
14153 --haskell-suite
14154 compile with a haskell-suite compiler
14155
14156 --cabal-file PATH
14157 use this Cabal file
14158
14159 -w, --with-compiler PATH
14160 give the path to a particular compiler
14161
14162 --with-hc-pkg PATH
14163 give the path to the package tool
14164
14165 --prefix DIR
14166 bake this prefix in preparation of installation
14167
14168 --bindir DIR
14169 installation directory for executables
14170
14171 --libdir DIR
14172 installation directory for libraries
14173
14174 --libsubdir DIR
14175 subdirectory of libdir in which libs are installed
14176
14177 --dynlibdir DIR
14178 installation directory for dynamic libraries
14179
14180 --libexecdir DIR
14181 installation directory for program executables
14182
14183 --libexecsubdir DIR
14184 subdirectory of libexecdir in which private executables
14185 are installed
14186
14187 --datadir DIR
14188 installation directory for read-only data
14189
14190 --datasubdir DIR
14191 subdirectory of datadir in which data files are installed
14192
14193 --docdir DIR
14194 installation directory for documentation
14195
14196 --htmldir DIR
14197 installation directory for HTML documentation
14198
14199 --haddockdir DIR
14200 installation directory for haddock interfaces
14201
14202 --sysconfdir DIR
14203 installation directory for configuration files
14204
14205 --program-prefix PREFIX
14206 prefix to be applied to installed executables
14207
14208 --program-suffix SUFFIX
14209 suffix to be applied to installed executables
14210
14211 --enable-library-vanilla
14212 --disable-library-vanilla
14213 Vanilla libraries
14214
14215 -p, --enable-library-profiling
14216 --disable-library-profiling
14217 Library profiling
14218
14219 --enable-shared
14220 --disable-shared
14221 Shared library
14222
14223 --enable-static
14224 --disable-static
14225 Static library
14226
14227 --enable-executable-dynamic
14228 --disable-executable-dynamic
14229 Executable dynamic linking
14230
14231 --enable-profiling
14232 --disable-profiling
14233 Executable and library profiling
14234
14235 --enable-executable-profiling
14236 --disable-executable-profiling
14237 Executable profiling (DEPRECATED)
14238
14239 --profiling-detail level
14240 Profiling detail level for executable and library
14241 (default, none, exported-functions, toplevel-functions,
14242 all-functions).
14243
14244 --library-profiling-detail level
14245 Profiling detail level for libraries only.
14246
14247 -O, --enable-optimization, --enable-optimisation [n]
14248 Build with optimization (n is 0--2, default is 1)
14249
14250 --disable-optimization, --disable-optimisation
14251 Build without optimization
14252
14253 --enable-debug-info [n]
14254 Emit debug info (n is 0--3, default is 0)
14255
14256 --disable-debug-info
14257 Don't emit debug info
14258
14259 --enable-library-for-ghci
14260 --disable-library-for-ghci
14261 compile library for use with GHCi
14262
14263 --enable-split-sections
14264 --disable-split-sections
14265 compile library code such that unneeded definitions can
14266 be dropped from the final executable (GHC 7.8+)
14267
14268 --enable-split-objs
14269 --disable-split-objs
14270 split library into smaller objects to reduce binary sizes
14271 (GHC 6.6+)
14272
14273 --enable-executable-stripping
14274 --disable-executable-stripping
14275 strip executables upon installation to reduce binary
14276 sizes
14277
14278 --enable-library-stripping
14279 --disable-library-stripping
14280 strip libraries upon installation to reduce binary sizes
14281
14282 --configure-option OPT
14283 Extra option for configure
14284
14285 --user
14286 --global
14287 doing a per-user installation
14288
14289 --package-db DB
14290 Append the given package database to the list of package
14291 databases used (to satisfy dependencies and register
14292 into). May be a specific file, 'global' or 'user'. The
14293 initial list is ['global'], ['global', 'user'], or
14294 ['global', $sandbox], depending on context. Use 'clear'
14295 to reset the list to empty. See the user guide for
14296 details.
14297
14298 -f, --flags FLAGS
14299 Force values for the given flags in Cabal conditionals in
14300 the .cabal file. E.g., --flags="debug -usebytestrings"
14301 forces the flag "debug" to true and "usebytestrings" to
14302 false.
14303
14304 --extra-include-dirs PATH
14305 A list of directories to search for header files
14306
14307 --enable-deterministic
14308 --disable-deterministic
14309 Try to be as deterministic as possible (used by the test
14310 suite)
14311
14312 --ipid IPID
14313 Installed package ID to compile this package as
14314
14315 --cid CID
14316 Installed component ID to compile this component as
14317
14318 --extra-lib-dirs PATH
14319 A list of directories to search for external libraries
14320
14321 --extra-framework-dirs PATH
14322 A list of directories to search for external frameworks
14323 (OS X only)
14324
14325 --extra-prog-path PATH
14326 A list of directories to search for required programs (in
14327 addition to the normal search locations)
14328
14329 --instantiate-with NAME=MOD
14330 A mapping of signature names to concrete module instanti‐
14331 ations.
14332
14333 --enable-tests
14334 --disable-tests
14335 dependency checking and compilation for test suites
14336 listed in the package description file.
14337
14338 --enable-coverage
14339 --disable-coverage
14340 build package with Haskell Program Coverage. (GHC only)
14341
14342 --enable-library-coverage
14343 --disable-library-coverage
14344 build package with Haskell Program Coverage. (GHC only)
14345 (DEPRECATED)
14346
14347 --enable-benchmarks
14348 --disable-benchmarks
14349 dependency checking and compilation for benchmarks listed
14350 in the package description file.
14351
14352 --enable-relocatable
14353 --disable-relocatable
14354 building a package that is relocatable. (GHC only)
14355
14356 --disable-response-files
14357 enable workaround for old versions of programs like "ar"
14358 that do not support @file arguments
14359
14360 --with-alex PATH
14361 give the path to alex
14362
14363 --with-ar PATH
14364 give the path to ar
14365
14366 --with-c2hs PATH
14367 give the path to c2hs
14368
14369 --with-cpphs PATH
14370 give the path to cpphs
14371
14372 --with-doctest PATH
14373 give the path to doctest
14374
14375 --with-gcc PATH
14376 give the path to gcc
14377
14378 --with-ghc PATH
14379 give the path to ghc
14380
14381 --with-ghc-pkg PATH
14382 give the path to ghc-pkg
14383
14384 --with-ghcjs PATH
14385 give the path to ghcjs
14386
14387 --with-ghcjs-pkg PATH
14388 give the path to ghcjs-pkg
14389
14390 --with-greencard PATH
14391 give the path to greencard
14392
14393 --with-haddock PATH
14394 give the path to haddock
14395
14396 --with-happy PATH
14397 give the path to happy
14398
14399 --with-haskell-suite PATH
14400 give the path to haskell-suite
14401
14402 --with-haskell-suite-pkg PATH
14403 give the path to haskell-suite-pkg
14404
14405 --with-hmake PATH
14406 give the path to hmake
14407
14408 --with-hpc PATH
14409 give the path to hpc
14410
14411 --with-hsc2hs PATH
14412 give the path to hsc2hs
14413
14414 --with-hscolour PATH
14415 give the path to hscolour
14416
14417 --with-jhc PATH
14418 give the path to jhc
14419
14420 --with-ld PATH
14421 give the path to ld
14422
14423 --with-pkg-config PATH
14424 give the path to pkg-config
14425
14426 --with-runghc PATH
14427 give the path to runghc
14428
14429 --with-strip PATH
14430 give the path to strip
14431
14432 --with-tar PATH
14433 give the path to tar
14434
14435 --with-uhc PATH
14436 give the path to uhc
14437
14438 --alex-option OPT
14439 give an extra option to alex (no need to quote options
14440 containing spaces)
14441
14442 --ar-option OPT
14443 give an extra option to ar (no need to quote options con‐
14444 taining spaces)
14445
14446 --c2hs-option OPT
14447 give an extra option to c2hs (no need to quote options
14448 containing spaces)
14449
14450 --cpphs-option OPT
14451 give an extra option to cpphs (no need to quote options
14452 containing spaces)
14453
14454 --doctest-option OPT
14455 give an extra option to doctest (no need to quote options
14456 containing spaces)
14457
14458 --gcc-option OPT
14459 give an extra option to gcc (no need to quote options
14460 containing spaces)
14461
14462 --ghc-option OPT
14463 give an extra option to ghc (no need to quote options
14464 containing spaces)
14465
14466 --ghc-pkg-option OPT
14467 give an extra option to ghc-pkg (no need to quote options
14468 containing spaces)
14469
14470 --ghcjs-option OPT
14471 give an extra option to ghcjs (no need to quote options
14472 containing spaces)
14473
14474 --ghcjs-pkg-option OPT
14475 give an extra option to ghcjs-pkg (no need to quote
14476 options containing spaces)
14477
14478 --greencard-option OPT
14479 give an extra option to greencard (no need to quote
14480 options containing spaces)
14481
14482 --haddock-option OPT
14483 give an extra option to haddock (no need to quote options
14484 containing spaces)
14485
14486 --happy-option OPT
14487 give an extra option to happy (no need to quote options
14488 containing spaces)
14489
14490 --haskell-suite-option OPT
14491 give an extra option to haskell-suite (no need to quote
14492 options containing spaces)
14493
14494 --haskell-suite-pkg-option OPT
14495 give an extra option to haskell-suite-pkg (no need to
14496 quote options containing spaces)
14497
14498 --hmake-option OPT
14499 give an extra option to hmake (no need to quote options
14500 containing spaces)
14501
14502 --hpc-option OPT
14503 give an extra option to hpc (no need to quote options
14504 containing spaces)
14505
14506 --hsc2hs-option OPT
14507 give an extra option to hsc2hs (no need to quote options
14508 containing spaces)
14509
14510 --hscolour-option OPT
14511 give an extra option to hscolour (no need to quote
14512 options containing spaces)
14513
14514 --jhc-option OPT
14515 give an extra option to jhc (no need to quote options
14516 containing spaces)
14517
14518 --ld-option OPT
14519 give an extra option to ld (no need to quote options con‐
14520 taining spaces)
14521
14522 --pkg-config-option OPT
14523 give an extra option to pkg-config (no need to quote
14524 options containing spaces)
14525
14526 --runghc-option OPT
14527 give an extra option to runghc (no need to quote options
14528 containing spaces)
14529
14530 --strip-option OPT
14531 give an extra option to strip (no need to quote options
14532 containing spaces)
14533
14534 --tar-option OPT
14535 give an extra option to tar (no need to quote options
14536 containing spaces)
14537
14538 --uhc-option OPT
14539 give an extra option to uhc (no need to quote options
14540 containing spaces)
14541
14542 --alex-options OPTS
14543 give extra options to alex
14544
14545 --ar-options OPTS
14546 give extra options to ar
14547
14548 --c2hs-options OPTS
14549 give extra options to c2hs
14550
14551 --cpphs-options OPTS
14552 give extra options to cpphs
14553
14554 --doctest-options OPTS
14555 give extra options to doctest
14556
14557 --gcc-options OPTS
14558 give extra options to gcc
14559
14560 --ghc-options OPTS
14561 give extra options to ghc
14562
14563 --ghc-pkg-options OPTS
14564 give extra options to ghc-pkg
14565
14566 --ghcjs-options OPTS
14567 give extra options to ghcjs
14568
14569 --ghcjs-pkg-options OPTS
14570 give extra options to ghcjs-pkg
14571
14572 --greencard-options OPTS
14573 give extra options to greencard
14574
14575 --haddock-options OPTS
14576 give extra options to haddock
14577
14578 --happy-options OPTS
14579 give extra options to happy
14580
14581 --haskell-suite-options OPTS
14582 give extra options to haskell-suite
14583
14584 --haskell-suite-pkg-options OPTS
14585 give extra options to haskell-suite-pkg
14586
14587 --hmake-options OPTS
14588 give extra options to hmake
14589
14590 --hpc-options OPTS
14591 give extra options to hpc
14592
14593 --hsc2hs-options OPTS
14594 give extra options to hsc2hs
14595
14596 --hscolour-options OPTS
14597 give extra options to hscolour
14598
14599 --jhc-options OPTS
14600 give extra options to jhc
14601
14602 --ld-options OPTS
14603 give extra options to ld
14604
14605 --pkg-config-options OPTS
14606 give extra options to pkg-config
14607
14608 --runghc-options OPTS
14609 give extra options to runghc
14610
14611 --strip-options OPTS
14612 give extra options to strip
14613
14614 --tar-options OPTS
14615 give extra options to tar
14616
14617 --uhc-options OPTS
14618 give extra options to uhc
14619
14620 --cabal-lib-version VERSION
14621 Select which version of the Cabal lib to use to build
14622 packages (useful for testing).
14623
14624 --constraint CONSTRAINT
14625 Specify constraints on a package (version,
14626 installed/source, flags)
14627
14628 --preference CONSTRAINT
14629 Specify preferences (soft constraints) on the version of
14630 a package
14631
14632 --solver SOLVER
14633 Select dependency solver to use (default: modular).
14634 Choices: modular.
14635
14636 --allow-older [DEPS]
14637 Ignore lower bounds in all dependencies or DEPS
14638
14639 --allow-newer [DEPS]
14640 Ignore upper bounds in all dependencies or DEPS
14641
14642 --write-ghc-environment-files always|never|ghc8.4.4+
14643 Whether to create a .ghc.environment file after a suc‐
14644 cessful build (v2-build only)
14645
14646 --enable-documentation
14647 --disable-documentation
14648 building of documentation
14649
14650 --doc-index-file TEMPLATE
14651 A central index of haddock API documentation (template
14652 cannot use $pkgid)
14653
14654 --dry-run
14655 Do not install anything, only print what would be
14656 installed.
14657
14658 --max-backjumps NUM
14659 Maximum number of backjumps allowed while solving
14660 (default: 2000). Use a negative number to enable unlim‐
14661 ited backtracking. Use 0 to disable backtracking com‐
14662 pletely.
14663
14664 --reorder-goals
14665 --no-reorder-goals
14666 Try to reorder goals according to certain heuristics.
14667 Slows things down on average, but may make backtracking
14668 faster for some packages.
14669
14670 --count-conflicts
14671 --no-count-conflicts
14672 Try to speed up solving by preferring goals that are
14673 involved in a lot of conflicts (default).
14674
14675 --independent-goals
14676 --no-independent-goals
14677 Treat several goals on the command line as independent.
14678 If several goals depend on the same package, different
14679 versions can be chosen.
14680
14681 --shadow-installed-packages
14682 --no-shadow-installed-packages
14683 If multiple package instances of the same version are
14684 installed, treat all but one as shadowed.
14685
14686 --strong-flags
14687 --no-strong-flags
14688 Do not defer flag choices (this used to be the default in
14689 cabal-install <= 1.20).
14690
14691 --allow-boot-library-installs
14692 --no-allow-boot-library-installs
14693 Allow cabal to install base, ghc-prim, integer-simple,
14694 integer-gmp, and template-haskell.
14695
14696 --reinstall
14697 --no-reinstall
14698 Install even if it means installing the same version
14699 again.
14700
14701 --avoid-reinstalls
14702 --no-avoid-reinstalls
14703 Do not select versions that would destructively overwrite
14704 installed packages.
14705
14706 --force-reinstalls
14707 --no-force-reinstalls
14708 Reinstall packages even if they will most likely break
14709 other installed packages.
14710
14711 --upgrade-dependencies
14712 --no-upgrade-dependencies
14713 Pick the latest version for all dependencies, rather than
14714 trying to pick an installed version.
14715
14716 --only-dependencies
14717 --no-only-dependencies
14718 Install only the dependencies necessary to build the
14719 given packages
14720
14721 --dependencies-only
14722 --no-dependencies-only
14723 A synonym for --only-dependencies
14724
14725 --index-state STATE
14726 Use source package index state as it existed at a previ‐
14727 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
14728 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
14729 'HEAD' (default: 'HEAD').
14730
14731 --root-cmd COMMAND
14732 (No longer supported, do not use.)
14733
14734 --symlink-bindir DIR
14735 Add symlinks to installed executables into this direc‐
14736 tory.
14737
14738 --build-summary TEMPLATE
14739 Save build summaries to file (name template can use
14740 $pkgid, $compiler, $os, $arch)
14741
14742 --build-log TEMPLATE
14743 Log all builds to file (name template can use $pkgid,
14744 $compiler, $os, $arch)
14745
14746 --remote-build-reporting LEVEL
14747 Generate build reports to send to a remote server (none,
14748 anonymous or detailed).
14749
14750 --report-planning-failure
14751 Generate build reports when the dependency solver fails.
14752 This is used by the Hackage build bot.
14753
14754 --enable-per-component
14755 --disable-per-component
14756 Per-component builds when possible
14757
14758 --one-shot
14759 --no-one-shot
14760 Do not record the packages in the world file.
14761
14762 --run-tests
14763 Run package test suites during installation.
14764
14765 -j, --jobs [NUM]
14766 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
14767 given).
14768
14769 --keep-going
14770 After a build failure, continue to build other unaffected
14771 packages.
14772
14773 --offline
14774 --no-offline
14775 Don't download packages from the Internet.
14776
14777 --project-file FILE
14778 Set the name of the cabal.project file to search for in
14779 parent directories
14780
14781 --only
14782 Only installs the package in the current directory.
14783
14784 --haddock-hoogle
14785 Generate a hoogle database
14786
14787 --haddock-html
14788 Generate HTML documentation (the default)
14789
14790 --haddock-html-location URL
14791 Location of HTML documentation for pre-requisite packages
14792
14793 --haddock-for-hackage
14794 Collection of flags to generate documentation suitable
14795 for upload to hackage
14796
14797 --haddock-executables
14798 Run haddock for Executables targets
14799
14800 --haddock-tests
14801 Run haddock for Test Suite targets
14802
14803 --haddock-benchmarks
14804 Run haddock for Benchmark targets
14805
14806 --haddock-all
14807 Run haddock for all targets
14808
14809 --haddock-internal
14810 Run haddock for internal modules and include all symbols
14811
14812 --haddock-css PATH
14813 Use PATH as the haddock stylesheet
14814
14815 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
14816 dock-hyperlinked-source
14817 Hyperlink the documentation to the source code
14818
14819 --haddock-quickjump
14820 Generate an index for interactive documentation naviga‐
14821 tion
14822
14823 --haddock-hscolour-css PATH
14824 Use PATH as the HsColour stylesheet
14825
14826 --haddock-contents-location URL
14827 Bake URL in as the location for the contents page
14828
14829
14830 cabal v2-exec
14831
14832 Usage: cabal v2-exec [FLAGS] [--] COMMAND [--] [ARGS]
14833
14834
14835 During development it is often useful to run build tasks and perform
14836 one-off program executions to experiment with the behavior of build
14837 tools. It is convenient to run these tools in the same way cabal itself
14838 would. The `cabal v2-exec` command provides a way to do so.
14839
14840 Compiler tools will be configured to see the same subset of the store
14841 that builds would see. The PATH is modified to make all executables in
14842 the dependency tree available (provided they have been built already).
14843 Commands are also rewritten in the way cabal itself would. For example,
14844 `cabal v2-exec ghc` will consult the configuration to choose an appro‐
14845 priate version of ghc and to include any ghc-specific flags requested.
14846
14847
14848 During development it is often useful to run build tasks and perform
14849 one-off program executions to experiment with the behavior of build
14850 tools. It is convenient to run these tools in the same way cabal itself
14851 would. The `cabal v2-exec` command provides a way to do so.
14852
14853 Compiler tools will be configured to see the same subset of the store
14854 that builds would see. The PATH is modified to make all executables in
14855 the dependency tree available (provided they have been built already).
14856 Commands are also rewritten in the way cabal itself would. For example,
14857 `cabal v2-exec ghc` will consult the configuration to choose an appro‐
14858 priate version of ghc and to include any ghc-specific flags requested.
14859
14860
14861 Flags:
14862 -v, --verbose [n]
14863 Control verbosity (n is 0--3, default verbosity level is
14864 1)
14865
14866 --builddir, --distdir, --distpref DIR
14867 The directory where Cabal puts generated build files
14868 (default dist)
14869
14870 -g, --ghc
14871 compile with GHC
14872
14873 --ghcjs
14874 compile with GHCJS
14875
14876 --uhc
14877 compile with UHC
14878
14879 --haskell-suite
14880 compile with a haskell-suite compiler
14881
14882 --cabal-file PATH
14883 use this Cabal file
14884
14885 -w, --with-compiler PATH
14886 give the path to a particular compiler
14887
14888 --with-hc-pkg PATH
14889 give the path to the package tool
14890
14891 --prefix DIR
14892 bake this prefix in preparation of installation
14893
14894 --bindir DIR
14895 installation directory for executables
14896
14897 --libdir DIR
14898 installation directory for libraries
14899
14900 --libsubdir DIR
14901 subdirectory of libdir in which libs are installed
14902
14903 --dynlibdir DIR
14904 installation directory for dynamic libraries
14905
14906 --libexecdir DIR
14907 installation directory for program executables
14908
14909 --libexecsubdir DIR
14910 subdirectory of libexecdir in which private executables
14911 are installed
14912
14913 --datadir DIR
14914 installation directory for read-only data
14915
14916 --datasubdir DIR
14917 subdirectory of datadir in which data files are installed
14918
14919 --docdir DIR
14920 installation directory for documentation
14921
14922 --htmldir DIR
14923 installation directory for HTML documentation
14924
14925 --haddockdir DIR
14926 installation directory for haddock interfaces
14927
14928 --sysconfdir DIR
14929 installation directory for configuration files
14930
14931 --program-prefix PREFIX
14932 prefix to be applied to installed executables
14933
14934 --program-suffix SUFFIX
14935 suffix to be applied to installed executables
14936
14937 --enable-library-vanilla
14938 --disable-library-vanilla
14939 Vanilla libraries
14940
14941 -p, --enable-library-profiling
14942 --disable-library-profiling
14943 Library profiling
14944
14945 --enable-shared
14946 --disable-shared
14947 Shared library
14948
14949 --enable-static
14950 --disable-static
14951 Static library
14952
14953 --enable-executable-dynamic
14954 --disable-executable-dynamic
14955 Executable dynamic linking
14956
14957 --enable-profiling
14958 --disable-profiling
14959 Executable and library profiling
14960
14961 --enable-executable-profiling
14962 --disable-executable-profiling
14963 Executable profiling (DEPRECATED)
14964
14965 --profiling-detail level
14966 Profiling detail level for executable and library
14967 (default, none, exported-functions, toplevel-functions,
14968 all-functions).
14969
14970 --library-profiling-detail level
14971 Profiling detail level for libraries only.
14972
14973 -O, --enable-optimization, --enable-optimisation [n]
14974 Build with optimization (n is 0--2, default is 1)
14975
14976 --disable-optimization, --disable-optimisation
14977 Build without optimization
14978
14979 --enable-debug-info [n]
14980 Emit debug info (n is 0--3, default is 0)
14981
14982 --disable-debug-info
14983 Don't emit debug info
14984
14985 --enable-library-for-ghci
14986 --disable-library-for-ghci
14987 compile library for use with GHCi
14988
14989 --enable-split-sections
14990 --disable-split-sections
14991 compile library code such that unneeded definitions can
14992 be dropped from the final executable (GHC 7.8+)
14993
14994 --enable-split-objs
14995 --disable-split-objs
14996 split library into smaller objects to reduce binary sizes
14997 (GHC 6.6+)
14998
14999 --enable-executable-stripping
15000 --disable-executable-stripping
15001 strip executables upon installation to reduce binary
15002 sizes
15003
15004 --enable-library-stripping
15005 --disable-library-stripping
15006 strip libraries upon installation to reduce binary sizes
15007
15008 --configure-option OPT
15009 Extra option for configure
15010
15011 --user
15012 --global
15013 doing a per-user installation
15014
15015 --package-db DB
15016 Append the given package database to the list of package
15017 databases used (to satisfy dependencies and register
15018 into). May be a specific file, 'global' or 'user'. The
15019 initial list is ['global'], ['global', 'user'], or
15020 ['global', $sandbox], depending on context. Use 'clear'
15021 to reset the list to empty. See the user guide for
15022 details.
15023
15024 -f, --flags FLAGS
15025 Force values for the given flags in Cabal conditionals in
15026 the .cabal file. E.g., --flags="debug -usebytestrings"
15027 forces the flag "debug" to true and "usebytestrings" to
15028 false.
15029
15030 --extra-include-dirs PATH
15031 A list of directories to search for header files
15032
15033 --enable-deterministic
15034 --disable-deterministic
15035 Try to be as deterministic as possible (used by the test
15036 suite)
15037
15038 --ipid IPID
15039 Installed package ID to compile this package as
15040
15041 --cid CID
15042 Installed component ID to compile this component as
15043
15044 --extra-lib-dirs PATH
15045 A list of directories to search for external libraries
15046
15047 --extra-framework-dirs PATH
15048 A list of directories to search for external frameworks
15049 (OS X only)
15050
15051 --extra-prog-path PATH
15052 A list of directories to search for required programs (in
15053 addition to the normal search locations)
15054
15055 --instantiate-with NAME=MOD
15056 A mapping of signature names to concrete module instanti‐
15057 ations.
15058
15059 --enable-tests
15060 --disable-tests
15061 dependency checking and compilation for test suites
15062 listed in the package description file.
15063
15064 --enable-coverage
15065 --disable-coverage
15066 build package with Haskell Program Coverage. (GHC only)
15067
15068 --enable-library-coverage
15069 --disable-library-coverage
15070 build package with Haskell Program Coverage. (GHC only)
15071 (DEPRECATED)
15072
15073 --enable-benchmarks
15074 --disable-benchmarks
15075 dependency checking and compilation for benchmarks listed
15076 in the package description file.
15077
15078 --enable-relocatable
15079 --disable-relocatable
15080 building a package that is relocatable. (GHC only)
15081
15082 --disable-response-files
15083 enable workaround for old versions of programs like "ar"
15084 that do not support @file arguments
15085
15086 --with-alex PATH
15087 give the path to alex
15088
15089 --with-ar PATH
15090 give the path to ar
15091
15092 --with-c2hs PATH
15093 give the path to c2hs
15094
15095 --with-cpphs PATH
15096 give the path to cpphs
15097
15098 --with-doctest PATH
15099 give the path to doctest
15100
15101 --with-gcc PATH
15102 give the path to gcc
15103
15104 --with-ghc PATH
15105 give the path to ghc
15106
15107 --with-ghc-pkg PATH
15108 give the path to ghc-pkg
15109
15110 --with-ghcjs PATH
15111 give the path to ghcjs
15112
15113 --with-ghcjs-pkg PATH
15114 give the path to ghcjs-pkg
15115
15116 --with-greencard PATH
15117 give the path to greencard
15118
15119 --with-haddock PATH
15120 give the path to haddock
15121
15122 --with-happy PATH
15123 give the path to happy
15124
15125 --with-haskell-suite PATH
15126 give the path to haskell-suite
15127
15128 --with-haskell-suite-pkg PATH
15129 give the path to haskell-suite-pkg
15130
15131 --with-hmake PATH
15132 give the path to hmake
15133
15134 --with-hpc PATH
15135 give the path to hpc
15136
15137 --with-hsc2hs PATH
15138 give the path to hsc2hs
15139
15140 --with-hscolour PATH
15141 give the path to hscolour
15142
15143 --with-jhc PATH
15144 give the path to jhc
15145
15146 --with-ld PATH
15147 give the path to ld
15148
15149 --with-pkg-config PATH
15150 give the path to pkg-config
15151
15152 --with-runghc PATH
15153 give the path to runghc
15154
15155 --with-strip PATH
15156 give the path to strip
15157
15158 --with-tar PATH
15159 give the path to tar
15160
15161 --with-uhc PATH
15162 give the path to uhc
15163
15164 --alex-option OPT
15165 give an extra option to alex (no need to quote options
15166 containing spaces)
15167
15168 --ar-option OPT
15169 give an extra option to ar (no need to quote options con‐
15170 taining spaces)
15171
15172 --c2hs-option OPT
15173 give an extra option to c2hs (no need to quote options
15174 containing spaces)
15175
15176 --cpphs-option OPT
15177 give an extra option to cpphs (no need to quote options
15178 containing spaces)
15179
15180 --doctest-option OPT
15181 give an extra option to doctest (no need to quote options
15182 containing spaces)
15183
15184 --gcc-option OPT
15185 give an extra option to gcc (no need to quote options
15186 containing spaces)
15187
15188 --ghc-option OPT
15189 give an extra option to ghc (no need to quote options
15190 containing spaces)
15191
15192 --ghc-pkg-option OPT
15193 give an extra option to ghc-pkg (no need to quote options
15194 containing spaces)
15195
15196 --ghcjs-option OPT
15197 give an extra option to ghcjs (no need to quote options
15198 containing spaces)
15199
15200 --ghcjs-pkg-option OPT
15201 give an extra option to ghcjs-pkg (no need to quote
15202 options containing spaces)
15203
15204 --greencard-option OPT
15205 give an extra option to greencard (no need to quote
15206 options containing spaces)
15207
15208 --haddock-option OPT
15209 give an extra option to haddock (no need to quote options
15210 containing spaces)
15211
15212 --happy-option OPT
15213 give an extra option to happy (no need to quote options
15214 containing spaces)
15215
15216 --haskell-suite-option OPT
15217 give an extra option to haskell-suite (no need to quote
15218 options containing spaces)
15219
15220 --haskell-suite-pkg-option OPT
15221 give an extra option to haskell-suite-pkg (no need to
15222 quote options containing spaces)
15223
15224 --hmake-option OPT
15225 give an extra option to hmake (no need to quote options
15226 containing spaces)
15227
15228 --hpc-option OPT
15229 give an extra option to hpc (no need to quote options
15230 containing spaces)
15231
15232 --hsc2hs-option OPT
15233 give an extra option to hsc2hs (no need to quote options
15234 containing spaces)
15235
15236 --hscolour-option OPT
15237 give an extra option to hscolour (no need to quote
15238 options containing spaces)
15239
15240 --jhc-option OPT
15241 give an extra option to jhc (no need to quote options
15242 containing spaces)
15243
15244 --ld-option OPT
15245 give an extra option to ld (no need to quote options con‐
15246 taining spaces)
15247
15248 --pkg-config-option OPT
15249 give an extra option to pkg-config (no need to quote
15250 options containing spaces)
15251
15252 --runghc-option OPT
15253 give an extra option to runghc (no need to quote options
15254 containing spaces)
15255
15256 --strip-option OPT
15257 give an extra option to strip (no need to quote options
15258 containing spaces)
15259
15260 --tar-option OPT
15261 give an extra option to tar (no need to quote options
15262 containing spaces)
15263
15264 --uhc-option OPT
15265 give an extra option to uhc (no need to quote options
15266 containing spaces)
15267
15268 --alex-options OPTS
15269 give extra options to alex
15270
15271 --ar-options OPTS
15272 give extra options to ar
15273
15274 --c2hs-options OPTS
15275 give extra options to c2hs
15276
15277 --cpphs-options OPTS
15278 give extra options to cpphs
15279
15280 --doctest-options OPTS
15281 give extra options to doctest
15282
15283 --gcc-options OPTS
15284 give extra options to gcc
15285
15286 --ghc-options OPTS
15287 give extra options to ghc
15288
15289 --ghc-pkg-options OPTS
15290 give extra options to ghc-pkg
15291
15292 --ghcjs-options OPTS
15293 give extra options to ghcjs
15294
15295 --ghcjs-pkg-options OPTS
15296 give extra options to ghcjs-pkg
15297
15298 --greencard-options OPTS
15299 give extra options to greencard
15300
15301 --haddock-options OPTS
15302 give extra options to haddock
15303
15304 --happy-options OPTS
15305 give extra options to happy
15306
15307 --haskell-suite-options OPTS
15308 give extra options to haskell-suite
15309
15310 --haskell-suite-pkg-options OPTS
15311 give extra options to haskell-suite-pkg
15312
15313 --hmake-options OPTS
15314 give extra options to hmake
15315
15316 --hpc-options OPTS
15317 give extra options to hpc
15318
15319 --hsc2hs-options OPTS
15320 give extra options to hsc2hs
15321
15322 --hscolour-options OPTS
15323 give extra options to hscolour
15324
15325 --jhc-options OPTS
15326 give extra options to jhc
15327
15328 --ld-options OPTS
15329 give extra options to ld
15330
15331 --pkg-config-options OPTS
15332 give extra options to pkg-config
15333
15334 --runghc-options OPTS
15335 give extra options to runghc
15336
15337 --strip-options OPTS
15338 give extra options to strip
15339
15340 --tar-options OPTS
15341 give extra options to tar
15342
15343 --uhc-options OPTS
15344 give extra options to uhc
15345
15346 --cabal-lib-version VERSION
15347 Select which version of the Cabal lib to use to build
15348 packages (useful for testing).
15349
15350 --constraint CONSTRAINT
15351 Specify constraints on a package (version,
15352 installed/source, flags)
15353
15354 --preference CONSTRAINT
15355 Specify preferences (soft constraints) on the version of
15356 a package
15357
15358 --solver SOLVER
15359 Select dependency solver to use (default: modular).
15360 Choices: modular.
15361
15362 --allow-older [DEPS]
15363 Ignore lower bounds in all dependencies or DEPS
15364
15365 --allow-newer [DEPS]
15366 Ignore upper bounds in all dependencies or DEPS
15367
15368 --write-ghc-environment-files always|never|ghc8.4.4+
15369 Whether to create a .ghc.environment file after a suc‐
15370 cessful build (v2-build only)
15371
15372 --enable-documentation
15373 --disable-documentation
15374 building of documentation
15375
15376 --doc-index-file TEMPLATE
15377 A central index of haddock API documentation (template
15378 cannot use $pkgid)
15379
15380 --dry-run
15381 Do not install anything, only print what would be
15382 installed.
15383
15384 --max-backjumps NUM
15385 Maximum number of backjumps allowed while solving
15386 (default: 2000). Use a negative number to enable unlim‐
15387 ited backtracking. Use 0 to disable backtracking com‐
15388 pletely.
15389
15390 --reorder-goals
15391 --no-reorder-goals
15392 Try to reorder goals according to certain heuristics.
15393 Slows things down on average, but may make backtracking
15394 faster for some packages.
15395
15396 --count-conflicts
15397 --no-count-conflicts
15398 Try to speed up solving by preferring goals that are
15399 involved in a lot of conflicts (default).
15400
15401 --independent-goals
15402 --no-independent-goals
15403 Treat several goals on the command line as independent.
15404 If several goals depend on the same package, different
15405 versions can be chosen.
15406
15407 --shadow-installed-packages
15408 --no-shadow-installed-packages
15409 If multiple package instances of the same version are
15410 installed, treat all but one as shadowed.
15411
15412 --strong-flags
15413 --no-strong-flags
15414 Do not defer flag choices (this used to be the default in
15415 cabal-install <= 1.20).
15416
15417 --allow-boot-library-installs
15418 --no-allow-boot-library-installs
15419 Allow cabal to install base, ghc-prim, integer-simple,
15420 integer-gmp, and template-haskell.
15421
15422 --reinstall
15423 --no-reinstall
15424 Install even if it means installing the same version
15425 again.
15426
15427 --avoid-reinstalls
15428 --no-avoid-reinstalls
15429 Do not select versions that would destructively overwrite
15430 installed packages.
15431
15432 --force-reinstalls
15433 --no-force-reinstalls
15434 Reinstall packages even if they will most likely break
15435 other installed packages.
15436
15437 --upgrade-dependencies
15438 --no-upgrade-dependencies
15439 Pick the latest version for all dependencies, rather than
15440 trying to pick an installed version.
15441
15442 --only-dependencies
15443 --no-only-dependencies
15444 Install only the dependencies necessary to build the
15445 given packages
15446
15447 --dependencies-only
15448 --no-dependencies-only
15449 A synonym for --only-dependencies
15450
15451 --index-state STATE
15452 Use source package index state as it existed at a previ‐
15453 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
15454 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
15455 'HEAD' (default: 'HEAD').
15456
15457 --root-cmd COMMAND
15458 (No longer supported, do not use.)
15459
15460 --symlink-bindir DIR
15461 Add symlinks to installed executables into this direc‐
15462 tory.
15463
15464 --build-summary TEMPLATE
15465 Save build summaries to file (name template can use
15466 $pkgid, $compiler, $os, $arch)
15467
15468 --build-log TEMPLATE
15469 Log all builds to file (name template can use $pkgid,
15470 $compiler, $os, $arch)
15471
15472 --remote-build-reporting LEVEL
15473 Generate build reports to send to a remote server (none,
15474 anonymous or detailed).
15475
15476 --report-planning-failure
15477 Generate build reports when the dependency solver fails.
15478 This is used by the Hackage build bot.
15479
15480 --enable-per-component
15481 --disable-per-component
15482 Per-component builds when possible
15483
15484 --one-shot
15485 --no-one-shot
15486 Do not record the packages in the world file.
15487
15488 --run-tests
15489 Run package test suites during installation.
15490
15491 -j, --jobs [NUM]
15492 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
15493 given).
15494
15495 --keep-going
15496 After a build failure, continue to build other unaffected
15497 packages.
15498
15499 --offline
15500 --no-offline
15501 Don't download packages from the Internet.
15502
15503 --project-file FILE
15504 Set the name of the cabal.project file to search for in
15505 parent directories
15506
15507 --only
15508 Only installs the package in the current directory.
15509
15510 --haddock-hoogle
15511 Generate a hoogle database
15512
15513 --haddock-html
15514 Generate HTML documentation (the default)
15515
15516 --haddock-html-location URL
15517 Location of HTML documentation for pre-requisite packages
15518
15519 --haddock-for-hackage
15520 Collection of flags to generate documentation suitable
15521 for upload to hackage
15522
15523 --haddock-executables
15524 Run haddock for Executables targets
15525
15526 --haddock-tests
15527 Run haddock for Test Suite targets
15528
15529 --haddock-benchmarks
15530 Run haddock for Benchmark targets
15531
15532 --haddock-all
15533 Run haddock for all targets
15534
15535 --haddock-internal
15536 Run haddock for internal modules and include all symbols
15537
15538 --haddock-css PATH
15539 Use PATH as the haddock stylesheet
15540
15541 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
15542 dock-hyperlinked-source
15543 Hyperlink the documentation to the source code
15544
15545 --haddock-quickjump
15546 Generate an index for interactive documentation naviga‐
15547 tion
15548
15549 --haddock-hscolour-css PATH
15550 Use PATH as the HsColour stylesheet
15551
15552 --haddock-contents-location URL
15553 Bake URL in as the location for the contents page
15554
15555
15556 cabal new-exec
15557
15558 Usage: cabal new-exec [FLAGS] [--] COMMAND [--] [ARGS]
15559
15560
15561 During development it is often useful to run build tasks and perform
15562 one-off program executions to experiment with the behavior of build
15563 tools. It is convenient to run these tools in the same way cabal itself
15564 would. The `cabal new-exec` command provides a way to do so.
15565
15566 Compiler tools will be configured to see the same subset of the store
15567 that builds would see. The PATH is modified to make all executables in
15568 the dependency tree available (provided they have been built already).
15569 Commands are also rewritten in the way cabal itself would. For example,
15570 `cabal new-exec ghc` will consult the configuration to choose an appro‐
15571 priate version of ghc and to include any ghc-specific flags requested.
15572
15573
15574 Flags:
15575 -v, --verbose [n]
15576 Control verbosity (n is 0--3, default verbosity level is
15577 1)
15578
15579 --builddir, --distdir, --distpref DIR
15580 The directory where Cabal puts generated build files
15581 (default dist)
15582
15583 -g, --ghc
15584 compile with GHC
15585
15586 --ghcjs
15587 compile with GHCJS
15588
15589 --uhc
15590 compile with UHC
15591
15592 --haskell-suite
15593 compile with a haskell-suite compiler
15594
15595 --cabal-file PATH
15596 use this Cabal file
15597
15598 -w, --with-compiler PATH
15599 give the path to a particular compiler
15600
15601 --with-hc-pkg PATH
15602 give the path to the package tool
15603
15604 --prefix DIR
15605 bake this prefix in preparation of installation
15606
15607 --bindir DIR
15608 installation directory for executables
15609
15610 --libdir DIR
15611 installation directory for libraries
15612
15613 --libsubdir DIR
15614 subdirectory of libdir in which libs are installed
15615
15616 --dynlibdir DIR
15617 installation directory for dynamic libraries
15618
15619 --libexecdir DIR
15620 installation directory for program executables
15621
15622 --libexecsubdir DIR
15623 subdirectory of libexecdir in which private executables
15624 are installed
15625
15626 --datadir DIR
15627 installation directory for read-only data
15628
15629 --datasubdir DIR
15630 subdirectory of datadir in which data files are installed
15631
15632 --docdir DIR
15633 installation directory for documentation
15634
15635 --htmldir DIR
15636 installation directory for HTML documentation
15637
15638 --haddockdir DIR
15639 installation directory for haddock interfaces
15640
15641 --sysconfdir DIR
15642 installation directory for configuration files
15643
15644 --program-prefix PREFIX
15645 prefix to be applied to installed executables
15646
15647 --program-suffix SUFFIX
15648 suffix to be applied to installed executables
15649
15650 --enable-library-vanilla
15651 --disable-library-vanilla
15652 Vanilla libraries
15653
15654 -p, --enable-library-profiling
15655 --disable-library-profiling
15656 Library profiling
15657
15658 --enable-shared
15659 --disable-shared
15660 Shared library
15661
15662 --enable-static
15663 --disable-static
15664 Static library
15665
15666 --enable-executable-dynamic
15667 --disable-executable-dynamic
15668 Executable dynamic linking
15669
15670 --enable-profiling
15671 --disable-profiling
15672 Executable and library profiling
15673
15674 --enable-executable-profiling
15675 --disable-executable-profiling
15676 Executable profiling (DEPRECATED)
15677
15678 --profiling-detail level
15679 Profiling detail level for executable and library
15680 (default, none, exported-functions, toplevel-functions,
15681 all-functions).
15682
15683 --library-profiling-detail level
15684 Profiling detail level for libraries only.
15685
15686 -O, --enable-optimization, --enable-optimisation [n]
15687 Build with optimization (n is 0--2, default is 1)
15688
15689 --disable-optimization, --disable-optimisation
15690 Build without optimization
15691
15692 --enable-debug-info [n]
15693 Emit debug info (n is 0--3, default is 0)
15694
15695 --disable-debug-info
15696 Don't emit debug info
15697
15698 --enable-library-for-ghci
15699 --disable-library-for-ghci
15700 compile library for use with GHCi
15701
15702 --enable-split-sections
15703 --disable-split-sections
15704 compile library code such that unneeded definitions can
15705 be dropped from the final executable (GHC 7.8+)
15706
15707 --enable-split-objs
15708 --disable-split-objs
15709 split library into smaller objects to reduce binary sizes
15710 (GHC 6.6+)
15711
15712 --enable-executable-stripping
15713 --disable-executable-stripping
15714 strip executables upon installation to reduce binary
15715 sizes
15716
15717 --enable-library-stripping
15718 --disable-library-stripping
15719 strip libraries upon installation to reduce binary sizes
15720
15721 --configure-option OPT
15722 Extra option for configure
15723
15724 --user
15725 --global
15726 doing a per-user installation
15727
15728 --package-db DB
15729 Append the given package database to the list of package
15730 databases used (to satisfy dependencies and register
15731 into). May be a specific file, 'global' or 'user'. The
15732 initial list is ['global'], ['global', 'user'], or
15733 ['global', $sandbox], depending on context. Use 'clear'
15734 to reset the list to empty. See the user guide for
15735 details.
15736
15737 -f, --flags FLAGS
15738 Force values for the given flags in Cabal conditionals in
15739 the .cabal file. E.g., --flags="debug -usebytestrings"
15740 forces the flag "debug" to true and "usebytestrings" to
15741 false.
15742
15743 --extra-include-dirs PATH
15744 A list of directories to search for header files
15745
15746 --enable-deterministic
15747 --disable-deterministic
15748 Try to be as deterministic as possible (used by the test
15749 suite)
15750
15751 --ipid IPID
15752 Installed package ID to compile this package as
15753
15754 --cid CID
15755 Installed component ID to compile this component as
15756
15757 --extra-lib-dirs PATH
15758 A list of directories to search for external libraries
15759
15760 --extra-framework-dirs PATH
15761 A list of directories to search for external frameworks
15762 (OS X only)
15763
15764 --extra-prog-path PATH
15765 A list of directories to search for required programs (in
15766 addition to the normal search locations)
15767
15768 --instantiate-with NAME=MOD
15769 A mapping of signature names to concrete module instanti‐
15770 ations.
15771
15772 --enable-tests
15773 --disable-tests
15774 dependency checking and compilation for test suites
15775 listed in the package description file.
15776
15777 --enable-coverage
15778 --disable-coverage
15779 build package with Haskell Program Coverage. (GHC only)
15780
15781 --enable-library-coverage
15782 --disable-library-coverage
15783 build package with Haskell Program Coverage. (GHC only)
15784 (DEPRECATED)
15785
15786 --enable-benchmarks
15787 --disable-benchmarks
15788 dependency checking and compilation for benchmarks listed
15789 in the package description file.
15790
15791 --enable-relocatable
15792 --disable-relocatable
15793 building a package that is relocatable. (GHC only)
15794
15795 --disable-response-files
15796 enable workaround for old versions of programs like "ar"
15797 that do not support @file arguments
15798
15799 --with-alex PATH
15800 give the path to alex
15801
15802 --with-ar PATH
15803 give the path to ar
15804
15805 --with-c2hs PATH
15806 give the path to c2hs
15807
15808 --with-cpphs PATH
15809 give the path to cpphs
15810
15811 --with-doctest PATH
15812 give the path to doctest
15813
15814 --with-gcc PATH
15815 give the path to gcc
15816
15817 --with-ghc PATH
15818 give the path to ghc
15819
15820 --with-ghc-pkg PATH
15821 give the path to ghc-pkg
15822
15823 --with-ghcjs PATH
15824 give the path to ghcjs
15825
15826 --with-ghcjs-pkg PATH
15827 give the path to ghcjs-pkg
15828
15829 --with-greencard PATH
15830 give the path to greencard
15831
15832 --with-haddock PATH
15833 give the path to haddock
15834
15835 --with-happy PATH
15836 give the path to happy
15837
15838 --with-haskell-suite PATH
15839 give the path to haskell-suite
15840
15841 --with-haskell-suite-pkg PATH
15842 give the path to haskell-suite-pkg
15843
15844 --with-hmake PATH
15845 give the path to hmake
15846
15847 --with-hpc PATH
15848 give the path to hpc
15849
15850 --with-hsc2hs PATH
15851 give the path to hsc2hs
15852
15853 --with-hscolour PATH
15854 give the path to hscolour
15855
15856 --with-jhc PATH
15857 give the path to jhc
15858
15859 --with-ld PATH
15860 give the path to ld
15861
15862 --with-pkg-config PATH
15863 give the path to pkg-config
15864
15865 --with-runghc PATH
15866 give the path to runghc
15867
15868 --with-strip PATH
15869 give the path to strip
15870
15871 --with-tar PATH
15872 give the path to tar
15873
15874 --with-uhc PATH
15875 give the path to uhc
15876
15877 --alex-option OPT
15878 give an extra option to alex (no need to quote options
15879 containing spaces)
15880
15881 --ar-option OPT
15882 give an extra option to ar (no need to quote options con‐
15883 taining spaces)
15884
15885 --c2hs-option OPT
15886 give an extra option to c2hs (no need to quote options
15887 containing spaces)
15888
15889 --cpphs-option OPT
15890 give an extra option to cpphs (no need to quote options
15891 containing spaces)
15892
15893 --doctest-option OPT
15894 give an extra option to doctest (no need to quote options
15895 containing spaces)
15896
15897 --gcc-option OPT
15898 give an extra option to gcc (no need to quote options
15899 containing spaces)
15900
15901 --ghc-option OPT
15902 give an extra option to ghc (no need to quote options
15903 containing spaces)
15904
15905 --ghc-pkg-option OPT
15906 give an extra option to ghc-pkg (no need to quote options
15907 containing spaces)
15908
15909 --ghcjs-option OPT
15910 give an extra option to ghcjs (no need to quote options
15911 containing spaces)
15912
15913 --ghcjs-pkg-option OPT
15914 give an extra option to ghcjs-pkg (no need to quote
15915 options containing spaces)
15916
15917 --greencard-option OPT
15918 give an extra option to greencard (no need to quote
15919 options containing spaces)
15920
15921 --haddock-option OPT
15922 give an extra option to haddock (no need to quote options
15923 containing spaces)
15924
15925 --happy-option OPT
15926 give an extra option to happy (no need to quote options
15927 containing spaces)
15928
15929 --haskell-suite-option OPT
15930 give an extra option to haskell-suite (no need to quote
15931 options containing spaces)
15932
15933 --haskell-suite-pkg-option OPT
15934 give an extra option to haskell-suite-pkg (no need to
15935 quote options containing spaces)
15936
15937 --hmake-option OPT
15938 give an extra option to hmake (no need to quote options
15939 containing spaces)
15940
15941 --hpc-option OPT
15942 give an extra option to hpc (no need to quote options
15943 containing spaces)
15944
15945 --hsc2hs-option OPT
15946 give an extra option to hsc2hs (no need to quote options
15947 containing spaces)
15948
15949 --hscolour-option OPT
15950 give an extra option to hscolour (no need to quote
15951 options containing spaces)
15952
15953 --jhc-option OPT
15954 give an extra option to jhc (no need to quote options
15955 containing spaces)
15956
15957 --ld-option OPT
15958 give an extra option to ld (no need to quote options con‐
15959 taining spaces)
15960
15961 --pkg-config-option OPT
15962 give an extra option to pkg-config (no need to quote
15963 options containing spaces)
15964
15965 --runghc-option OPT
15966 give an extra option to runghc (no need to quote options
15967 containing spaces)
15968
15969 --strip-option OPT
15970 give an extra option to strip (no need to quote options
15971 containing spaces)
15972
15973 --tar-option OPT
15974 give an extra option to tar (no need to quote options
15975 containing spaces)
15976
15977 --uhc-option OPT
15978 give an extra option to uhc (no need to quote options
15979 containing spaces)
15980
15981 --alex-options OPTS
15982 give extra options to alex
15983
15984 --ar-options OPTS
15985 give extra options to ar
15986
15987 --c2hs-options OPTS
15988 give extra options to c2hs
15989
15990 --cpphs-options OPTS
15991 give extra options to cpphs
15992
15993 --doctest-options OPTS
15994 give extra options to doctest
15995
15996 --gcc-options OPTS
15997 give extra options to gcc
15998
15999 --ghc-options OPTS
16000 give extra options to ghc
16001
16002 --ghc-pkg-options OPTS
16003 give extra options to ghc-pkg
16004
16005 --ghcjs-options OPTS
16006 give extra options to ghcjs
16007
16008 --ghcjs-pkg-options OPTS
16009 give extra options to ghcjs-pkg
16010
16011 --greencard-options OPTS
16012 give extra options to greencard
16013
16014 --haddock-options OPTS
16015 give extra options to haddock
16016
16017 --happy-options OPTS
16018 give extra options to happy
16019
16020 --haskell-suite-options OPTS
16021 give extra options to haskell-suite
16022
16023 --haskell-suite-pkg-options OPTS
16024 give extra options to haskell-suite-pkg
16025
16026 --hmake-options OPTS
16027 give extra options to hmake
16028
16029 --hpc-options OPTS
16030 give extra options to hpc
16031
16032 --hsc2hs-options OPTS
16033 give extra options to hsc2hs
16034
16035 --hscolour-options OPTS
16036 give extra options to hscolour
16037
16038 --jhc-options OPTS
16039 give extra options to jhc
16040
16041 --ld-options OPTS
16042 give extra options to ld
16043
16044 --pkg-config-options OPTS
16045 give extra options to pkg-config
16046
16047 --runghc-options OPTS
16048 give extra options to runghc
16049
16050 --strip-options OPTS
16051 give extra options to strip
16052
16053 --tar-options OPTS
16054 give extra options to tar
16055
16056 --uhc-options OPTS
16057 give extra options to uhc
16058
16059 --cabal-lib-version VERSION
16060 Select which version of the Cabal lib to use to build
16061 packages (useful for testing).
16062
16063 --constraint CONSTRAINT
16064 Specify constraints on a package (version,
16065 installed/source, flags)
16066
16067 --preference CONSTRAINT
16068 Specify preferences (soft constraints) on the version of
16069 a package
16070
16071 --solver SOLVER
16072 Select dependency solver to use (default: modular).
16073 Choices: modular.
16074
16075 --allow-older [DEPS]
16076 Ignore lower bounds in all dependencies or DEPS
16077
16078 --allow-newer [DEPS]
16079 Ignore upper bounds in all dependencies or DEPS
16080
16081 --write-ghc-environment-files always|never|ghc8.4.4+
16082 Whether to create a .ghc.environment file after a suc‐
16083 cessful build (v2-build only)
16084
16085 --enable-documentation
16086 --disable-documentation
16087 building of documentation
16088
16089 --doc-index-file TEMPLATE
16090 A central index of haddock API documentation (template
16091 cannot use $pkgid)
16092
16093 --dry-run
16094 Do not install anything, only print what would be
16095 installed.
16096
16097 --max-backjumps NUM
16098 Maximum number of backjumps allowed while solving
16099 (default: 2000). Use a negative number to enable unlim‐
16100 ited backtracking. Use 0 to disable backtracking com‐
16101 pletely.
16102
16103 --reorder-goals
16104 --no-reorder-goals
16105 Try to reorder goals according to certain heuristics.
16106 Slows things down on average, but may make backtracking
16107 faster for some packages.
16108
16109 --count-conflicts
16110 --no-count-conflicts
16111 Try to speed up solving by preferring goals that are
16112 involved in a lot of conflicts (default).
16113
16114 --independent-goals
16115 --no-independent-goals
16116 Treat several goals on the command line as independent.
16117 If several goals depend on the same package, different
16118 versions can be chosen.
16119
16120 --shadow-installed-packages
16121 --no-shadow-installed-packages
16122 If multiple package instances of the same version are
16123 installed, treat all but one as shadowed.
16124
16125 --strong-flags
16126 --no-strong-flags
16127 Do not defer flag choices (this used to be the default in
16128 cabal-install <= 1.20).
16129
16130 --allow-boot-library-installs
16131 --no-allow-boot-library-installs
16132 Allow cabal to install base, ghc-prim, integer-simple,
16133 integer-gmp, and template-haskell.
16134
16135 --reinstall
16136 --no-reinstall
16137 Install even if it means installing the same version
16138 again.
16139
16140 --avoid-reinstalls
16141 --no-avoid-reinstalls
16142 Do not select versions that would destructively overwrite
16143 installed packages.
16144
16145 --force-reinstalls
16146 --no-force-reinstalls
16147 Reinstall packages even if they will most likely break
16148 other installed packages.
16149
16150 --upgrade-dependencies
16151 --no-upgrade-dependencies
16152 Pick the latest version for all dependencies, rather than
16153 trying to pick an installed version.
16154
16155 --only-dependencies
16156 --no-only-dependencies
16157 Install only the dependencies necessary to build the
16158 given packages
16159
16160 --dependencies-only
16161 --no-dependencies-only
16162 A synonym for --only-dependencies
16163
16164 --index-state STATE
16165 Use source package index state as it existed at a previ‐
16166 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
16167 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
16168 'HEAD' (default: 'HEAD').
16169
16170 --root-cmd COMMAND
16171 (No longer supported, do not use.)
16172
16173 --symlink-bindir DIR
16174 Add symlinks to installed executables into this direc‐
16175 tory.
16176
16177 --build-summary TEMPLATE
16178 Save build summaries to file (name template can use
16179 $pkgid, $compiler, $os, $arch)
16180
16181 --build-log TEMPLATE
16182 Log all builds to file (name template can use $pkgid,
16183 $compiler, $os, $arch)
16184
16185 --remote-build-reporting LEVEL
16186 Generate build reports to send to a remote server (none,
16187 anonymous or detailed).
16188
16189 --report-planning-failure
16190 Generate build reports when the dependency solver fails.
16191 This is used by the Hackage build bot.
16192
16193 --enable-per-component
16194 --disable-per-component
16195 Per-component builds when possible
16196
16197 --one-shot
16198 --no-one-shot
16199 Do not record the packages in the world file.
16200
16201 --run-tests
16202 Run package test suites during installation.
16203
16204 -j, --jobs [NUM]
16205 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
16206 given).
16207
16208 --keep-going
16209 After a build failure, continue to build other unaffected
16210 packages.
16211
16212 --offline
16213 --no-offline
16214 Don't download packages from the Internet.
16215
16216 --project-file FILE
16217 Set the name of the cabal.project file to search for in
16218 parent directories
16219
16220 --only
16221 Only installs the package in the current directory.
16222
16223 --haddock-hoogle
16224 Generate a hoogle database
16225
16226 --haddock-html
16227 Generate HTML documentation (the default)
16228
16229 --haddock-html-location URL
16230 Location of HTML documentation for pre-requisite packages
16231
16232 --haddock-for-hackage
16233 Collection of flags to generate documentation suitable
16234 for upload to hackage
16235
16236 --haddock-executables
16237 Run haddock for Executables targets
16238
16239 --haddock-tests
16240 Run haddock for Test Suite targets
16241
16242 --haddock-benchmarks
16243 Run haddock for Benchmark targets
16244
16245 --haddock-all
16246 Run haddock for all targets
16247
16248 --haddock-internal
16249 Run haddock for internal modules and include all symbols
16250
16251 --haddock-css PATH
16252 Use PATH as the haddock stylesheet
16253
16254 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
16255 dock-hyperlinked-source
16256 Hyperlink the documentation to the source code
16257
16258 --haddock-quickjump
16259 Generate an index for interactive documentation naviga‐
16260 tion
16261
16262 --haddock-hscolour-css PATH
16263 Use PATH as the HsColour stylesheet
16264
16265 --haddock-contents-location URL
16266 Bake URL in as the location for the contents page
16267
16268
16269 cabal v2-clean
16270
16271 Usage: cabal v2-clean [FLAGS]
16272
16273
16274 Removes all temporary files created during the building process (.hi,
16275 .o, preprocessed sources, etc.) and also empties out the local caches
16276 (by default).
16277
16278
16279
16280 Removes all temporary files created during the building process (.hi,
16281 .o, preprocessed sources, etc.) and also empties out the local caches
16282 (by default).
16283
16284
16285
16286 Flags:
16287 -v, --verbose [n]
16288 Control verbosity (n is 0--3, default verbosity level is
16289 1)
16290
16291 --builddir, --distdir, --distpref DIR
16292 The directory where Cabal puts generated build files
16293 (default dist)
16294
16295 --project-file FILE
16296 Set the name of the cabal.project file to search for in
16297 parent directories
16298
16299 -s, --save-config
16300 Save configuration, only remove build artifacts
16301
16302
16303 cabal new-clean
16304
16305 Usage: cabal new-clean [FLAGS]
16306
16307
16308 Removes all temporary files created during the building process (.hi,
16309 .o, preprocessed sources, etc.) and also empties out the local caches
16310 (by default).
16311
16312
16313
16314 Flags:
16315 -v, --verbose [n]
16316 Control verbosity (n is 0--3, default verbosity level is
16317 1)
16318
16319 --builddir, --distdir, --distpref DIR
16320 The directory where Cabal puts generated build files
16321 (default dist)
16322
16323 --project-file FILE
16324 Set the name of the cabal.project file to search for in
16325 parent directories
16326
16327 -s, --save-config
16328 Save configuration, only remove build artifacts
16329
16330
16331 cabal v2-sdist
16332
16333 Usage: cabal v2-sdist [FLAGS] [PACKAGES]
16334
16335
16336 Generates tarballs of project packages suitable for upload to Hackage.
16337
16338 Generates tarballs of project packages suitable for upload to Hackage.
16339
16340 Flags:
16341 -v, --verbose [n]
16342 Control verbosity (n is 0--3, default verbosity level is
16343 1)
16344
16345 --builddir, --distdir, --distpref DIR
16346 The directory where Cabal puts generated build files
16347 (default dist)
16348
16349 --project-file FILE
16350 Set the name of the cabal.project file to search for in
16351 parent directories
16352
16353 -l, --list-only
16354 Just list the sources, do not make a tarball
16355
16356 -z, --null-sep
16357 Separate the source files with NUL bytes rather than new‐
16358 lines.
16359
16360 --targz
16361 Produce a '.tar.gz' format archive (default and required
16362 for uploading to hackage)
16363
16364 --zip
16365 Produce a '.zip' format archive
16366
16367 -o, --output-dir, --outputdir PATH
16368 Choose the output directory of this command. '-' sends
16369 all output to stdout
16370
16371
16372 cabal new-sdist
16373
16374 Usage: cabal new-sdist [FLAGS] [PACKAGES]
16375
16376
16377 Generates tarballs of project packages suitable for upload to Hackage.
16378
16379 Flags:
16380 -v, --verbose [n]
16381 Control verbosity (n is 0--3, default verbosity level is
16382 1)
16383
16384 --builddir, --distdir, --distpref DIR
16385 The directory where Cabal puts generated build files
16386 (default dist)
16387
16388 --project-file FILE
16389 Set the name of the cabal.project file to search for in
16390 parent directories
16391
16392 -l, --list-only
16393 Just list the sources, do not make a tarball
16394
16395 -z, --null-sep
16396 Separate the source files with NUL bytes rather than new‐
16397 lines.
16398
16399 --targz
16400 Produce a '.tar.gz' format archive (default and required
16401 for uploading to hackage)
16402
16403 --zip
16404 Produce a '.zip' format archive
16405
16406 -o, --output-dir, --outputdir PATH
16407 Choose the output directory of this command. '-' sends
16408 all output to stdout
16409
16410
16411 cabal configure
16412
16413 Usage: cabal configure [FLAGS]
16414
16415
16416 Configure how the package is built by setting package (and other)
16417 flags.
16418
16419 The configuration affects several other commands, including build,
16420 test, bench, run, repl.
16421
16422
16423 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
16424 ing programs:
16425 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
16426 haddock
16427 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
16428 ld
16429 pkg-config runghc strip tar uhc
16430
16431 Examples:
16432 cabal configure
16433 Configure with defaults;
16434 cabal configure --enable-tests -fcustomflag
16435 Configure building package including tests,
16436 with some package-specific flag.
16437
16438 The configure command is a part of the legacy v1 style of cabal usage.
16439
16440 Please switch to using either the new project style and the new-config‐
16441 ure command or the legacy v1-configure alias as new-style projects will
16442 become the default in the next version of cabal-install. Please file a
16443 bug if you cannot replicate a working v1- use case with the new-style
16444 commands.
16445
16446 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
16447
16448
16449 Flags:
16450 -v, --verbose [n]
16451 Control verbosity (n is 0--3, default verbosity level is
16452 1)
16453
16454 --builddir, --distdir, --distpref DIR
16455 The directory where Cabal puts generated build files
16456 (default dist)
16457
16458 -g, --ghc
16459 compile with GHC
16460
16461 --ghcjs
16462 compile with GHCJS
16463
16464 --uhc
16465 compile with UHC
16466
16467 --haskell-suite
16468 compile with a haskell-suite compiler
16469
16470 --cabal-file PATH
16471 use this Cabal file
16472
16473 -w, --with-compiler PATH
16474 give the path to a particular compiler
16475
16476 --with-hc-pkg PATH
16477 give the path to the package tool
16478
16479 --prefix DIR
16480 bake this prefix in preparation of installation
16481
16482 --bindir DIR
16483 installation directory for executables
16484
16485 --libdir DIR
16486 installation directory for libraries
16487
16488 --libsubdir DIR
16489 subdirectory of libdir in which libs are installed
16490
16491 --dynlibdir DIR
16492 installation directory for dynamic libraries
16493
16494 --libexecdir DIR
16495 installation directory for program executables
16496
16497 --libexecsubdir DIR
16498 subdirectory of libexecdir in which private executables
16499 are installed
16500
16501 --datadir DIR
16502 installation directory for read-only data
16503
16504 --datasubdir DIR
16505 subdirectory of datadir in which data files are installed
16506
16507 --docdir DIR
16508 installation directory for documentation
16509
16510 --htmldir DIR
16511 installation directory for HTML documentation
16512
16513 --haddockdir DIR
16514 installation directory for haddock interfaces
16515
16516 --sysconfdir DIR
16517 installation directory for configuration files
16518
16519 --program-prefix PREFIX
16520 prefix to be applied to installed executables
16521
16522 --program-suffix SUFFIX
16523 suffix to be applied to installed executables
16524
16525 --enable-library-vanilla
16526 --disable-library-vanilla
16527 Vanilla libraries
16528
16529 -p, --enable-library-profiling
16530 --disable-library-profiling
16531 Library profiling
16532
16533 --enable-shared
16534 --disable-shared
16535 Shared library
16536
16537 --enable-static
16538 --disable-static
16539 Static library
16540
16541 --enable-executable-dynamic
16542 --disable-executable-dynamic
16543 Executable dynamic linking
16544
16545 --enable-profiling
16546 --disable-profiling
16547 Executable and library profiling
16548
16549 --enable-executable-profiling
16550 --disable-executable-profiling
16551 Executable profiling (DEPRECATED)
16552
16553 --profiling-detail level
16554 Profiling detail level for executable and library
16555 (default, none, exported-functions, toplevel-functions,
16556 all-functions).
16557
16558 --library-profiling-detail level
16559 Profiling detail level for libraries only.
16560
16561 -O, --enable-optimization, --enable-optimisation [n]
16562 Build with optimization (n is 0--2, default is 1)
16563
16564 --disable-optimization, --disable-optimisation
16565 Build without optimization
16566
16567 --enable-debug-info [n]
16568 Emit debug info (n is 0--3, default is 0)
16569
16570 --disable-debug-info
16571 Don't emit debug info
16572
16573 --enable-library-for-ghci
16574 --disable-library-for-ghci
16575 compile library for use with GHCi
16576
16577 --enable-split-sections
16578 --disable-split-sections
16579 compile library code such that unneeded definitions can
16580 be dropped from the final executable (GHC 7.8+)
16581
16582 --enable-split-objs
16583 --disable-split-objs
16584 split library into smaller objects to reduce binary sizes
16585 (GHC 6.6+)
16586
16587 --enable-executable-stripping
16588 --disable-executable-stripping
16589 strip executables upon installation to reduce binary
16590 sizes
16591
16592 --enable-library-stripping
16593 --disable-library-stripping
16594 strip libraries upon installation to reduce binary sizes
16595
16596 --configure-option OPT
16597 Extra option for configure
16598
16599 --user
16600 --global
16601 doing a per-user installation
16602
16603 --package-db DB
16604 Append the given package database to the list of package
16605 databases used (to satisfy dependencies and register
16606 into). May be a specific file, 'global' or 'user'. The
16607 initial list is ['global'], ['global', 'user'], or
16608 ['global', $sandbox], depending on context. Use 'clear'
16609 to reset the list to empty. See the user guide for
16610 details.
16611
16612 -f, --flags FLAGS
16613 Force values for the given flags in Cabal conditionals in
16614 the .cabal file. E.g., --flags="debug -usebytestrings"
16615 forces the flag "debug" to true and "usebytestrings" to
16616 false.
16617
16618 --extra-include-dirs PATH
16619 A list of directories to search for header files
16620
16621 --enable-deterministic
16622 --disable-deterministic
16623 Try to be as deterministic as possible (used by the test
16624 suite)
16625
16626 --ipid IPID
16627 Installed package ID to compile this package as
16628
16629 --cid CID
16630 Installed component ID to compile this component as
16631
16632 --extra-lib-dirs PATH
16633 A list of directories to search for external libraries
16634
16635 --extra-framework-dirs PATH
16636 A list of directories to search for external frameworks
16637 (OS X only)
16638
16639 --extra-prog-path PATH
16640 A list of directories to search for required programs (in
16641 addition to the normal search locations)
16642
16643 --instantiate-with NAME=MOD
16644 A mapping of signature names to concrete module instanti‐
16645 ations.
16646
16647 --enable-tests
16648 --disable-tests
16649 dependency checking and compilation for test suites
16650 listed in the package description file.
16651
16652 --enable-coverage
16653 --disable-coverage
16654 build package with Haskell Program Coverage. (GHC only)
16655
16656 --enable-library-coverage
16657 --disable-library-coverage
16658 build package with Haskell Program Coverage. (GHC only)
16659 (DEPRECATED)
16660
16661 --enable-benchmarks
16662 --disable-benchmarks
16663 dependency checking and compilation for benchmarks listed
16664 in the package description file.
16665
16666 --enable-relocatable
16667 --disable-relocatable
16668 building a package that is relocatable. (GHC only)
16669
16670 --disable-response-files
16671 enable workaround for old versions of programs like "ar"
16672 that do not support @file arguments
16673
16674 --with-alex PATH
16675 give the path to alex
16676
16677 --with-ar PATH
16678 give the path to ar
16679
16680 --with-c2hs PATH
16681 give the path to c2hs
16682
16683 --with-cpphs PATH
16684 give the path to cpphs
16685
16686 --with-doctest PATH
16687 give the path to doctest
16688
16689 --with-gcc PATH
16690 give the path to gcc
16691
16692 --with-ghc PATH
16693 give the path to ghc
16694
16695 --with-ghc-pkg PATH
16696 give the path to ghc-pkg
16697
16698 --with-ghcjs PATH
16699 give the path to ghcjs
16700
16701 --with-ghcjs-pkg PATH
16702 give the path to ghcjs-pkg
16703
16704 --with-greencard PATH
16705 give the path to greencard
16706
16707 --with-haddock PATH
16708 give the path to haddock
16709
16710 --with-happy PATH
16711 give the path to happy
16712
16713 --with-haskell-suite PATH
16714 give the path to haskell-suite
16715
16716 --with-haskell-suite-pkg PATH
16717 give the path to haskell-suite-pkg
16718
16719 --with-hmake PATH
16720 give the path to hmake
16721
16722 --with-hpc PATH
16723 give the path to hpc
16724
16725 --with-hsc2hs PATH
16726 give the path to hsc2hs
16727
16728 --with-hscolour PATH
16729 give the path to hscolour
16730
16731 --with-jhc PATH
16732 give the path to jhc
16733
16734 --with-ld PATH
16735 give the path to ld
16736
16737 --with-pkg-config PATH
16738 give the path to pkg-config
16739
16740 --with-runghc PATH
16741 give the path to runghc
16742
16743 --with-strip PATH
16744 give the path to strip
16745
16746 --with-tar PATH
16747 give the path to tar
16748
16749 --with-uhc PATH
16750 give the path to uhc
16751
16752 --alex-option OPT
16753 give an extra option to alex (no need to quote options
16754 containing spaces)
16755
16756 --ar-option OPT
16757 give an extra option to ar (no need to quote options con‐
16758 taining spaces)
16759
16760 --c2hs-option OPT
16761 give an extra option to c2hs (no need to quote options
16762 containing spaces)
16763
16764 --cpphs-option OPT
16765 give an extra option to cpphs (no need to quote options
16766 containing spaces)
16767
16768 --doctest-option OPT
16769 give an extra option to doctest (no need to quote options
16770 containing spaces)
16771
16772 --gcc-option OPT
16773 give an extra option to gcc (no need to quote options
16774 containing spaces)
16775
16776 --ghc-option OPT
16777 give an extra option to ghc (no need to quote options
16778 containing spaces)
16779
16780 --ghc-pkg-option OPT
16781 give an extra option to ghc-pkg (no need to quote options
16782 containing spaces)
16783
16784 --ghcjs-option OPT
16785 give an extra option to ghcjs (no need to quote options
16786 containing spaces)
16787
16788 --ghcjs-pkg-option OPT
16789 give an extra option to ghcjs-pkg (no need to quote
16790 options containing spaces)
16791
16792 --greencard-option OPT
16793 give an extra option to greencard (no need to quote
16794 options containing spaces)
16795
16796 --haddock-option OPT
16797 give an extra option to haddock (no need to quote options
16798 containing spaces)
16799
16800 --happy-option OPT
16801 give an extra option to happy (no need to quote options
16802 containing spaces)
16803
16804 --haskell-suite-option OPT
16805 give an extra option to haskell-suite (no need to quote
16806 options containing spaces)
16807
16808 --haskell-suite-pkg-option OPT
16809 give an extra option to haskell-suite-pkg (no need to
16810 quote options containing spaces)
16811
16812 --hmake-option OPT
16813 give an extra option to hmake (no need to quote options
16814 containing spaces)
16815
16816 --hpc-option OPT
16817 give an extra option to hpc (no need to quote options
16818 containing spaces)
16819
16820 --hsc2hs-option OPT
16821 give an extra option to hsc2hs (no need to quote options
16822 containing spaces)
16823
16824 --hscolour-option OPT
16825 give an extra option to hscolour (no need to quote
16826 options containing spaces)
16827
16828 --jhc-option OPT
16829 give an extra option to jhc (no need to quote options
16830 containing spaces)
16831
16832 --ld-option OPT
16833 give an extra option to ld (no need to quote options con‐
16834 taining spaces)
16835
16836 --pkg-config-option OPT
16837 give an extra option to pkg-config (no need to quote
16838 options containing spaces)
16839
16840 --runghc-option OPT
16841 give an extra option to runghc (no need to quote options
16842 containing spaces)
16843
16844 --strip-option OPT
16845 give an extra option to strip (no need to quote options
16846 containing spaces)
16847
16848 --tar-option OPT
16849 give an extra option to tar (no need to quote options
16850 containing spaces)
16851
16852 --uhc-option OPT
16853 give an extra option to uhc (no need to quote options
16854 containing spaces)
16855
16856 --alex-options OPTS
16857 give extra options to alex
16858
16859 --ar-options OPTS
16860 give extra options to ar
16861
16862 --c2hs-options OPTS
16863 give extra options to c2hs
16864
16865 --cpphs-options OPTS
16866 give extra options to cpphs
16867
16868 --doctest-options OPTS
16869 give extra options to doctest
16870
16871 --gcc-options OPTS
16872 give extra options to gcc
16873
16874 --ghc-options OPTS
16875 give extra options to ghc
16876
16877 --ghc-pkg-options OPTS
16878 give extra options to ghc-pkg
16879
16880 --ghcjs-options OPTS
16881 give extra options to ghcjs
16882
16883 --ghcjs-pkg-options OPTS
16884 give extra options to ghcjs-pkg
16885
16886 --greencard-options OPTS
16887 give extra options to greencard
16888
16889 --haddock-options OPTS
16890 give extra options to haddock
16891
16892 --happy-options OPTS
16893 give extra options to happy
16894
16895 --haskell-suite-options OPTS
16896 give extra options to haskell-suite
16897
16898 --haskell-suite-pkg-options OPTS
16899 give extra options to haskell-suite-pkg
16900
16901 --hmake-options OPTS
16902 give extra options to hmake
16903
16904 --hpc-options OPTS
16905 give extra options to hpc
16906
16907 --hsc2hs-options OPTS
16908 give extra options to hsc2hs
16909
16910 --hscolour-options OPTS
16911 give extra options to hscolour
16912
16913 --jhc-options OPTS
16914 give extra options to jhc
16915
16916 --ld-options OPTS
16917 give extra options to ld
16918
16919 --pkg-config-options OPTS
16920 give extra options to pkg-config
16921
16922 --runghc-options OPTS
16923 give extra options to runghc
16924
16925 --strip-options OPTS
16926 give extra options to strip
16927
16928 --tar-options OPTS
16929 give extra options to tar
16930
16931 --uhc-options OPTS
16932 give extra options to uhc
16933
16934 --cabal-lib-version VERSION
16935 Select which version of the Cabal lib to use to build
16936 packages (useful for testing).
16937
16938 --constraint CONSTRAINT
16939 Specify constraints on a package (version,
16940 installed/source, flags)
16941
16942 --preference CONSTRAINT
16943 Specify preferences (soft constraints) on the version of
16944 a package
16945
16946 --solver SOLVER
16947 Select dependency solver to use (default: modular).
16948 Choices: modular.
16949
16950 --allow-older [DEPS]
16951 Ignore lower bounds in all dependencies or DEPS
16952
16953 --allow-newer [DEPS]
16954 Ignore upper bounds in all dependencies or DEPS
16955
16956 --write-ghc-environment-files always|never|ghc8.4.4+
16957 Whether to create a .ghc.environment file after a suc‐
16958 cessful build (v2-build only)
16959
16960
16961 cabal v1-configure
16962
16963 Usage: cabal v1-configure [FLAGS]
16964
16965
16966 Configure how the package is built by setting package (and other)
16967 flags.
16968
16969 The configuration affects several other commands, including v1-build,
16970 v1-test, v1-bench, v1-run, v1-repl.
16971
16972
16973 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
16974 ing programs:
16975 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
16976 haddock
16977 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
16978 ld
16979 pkg-config runghc strip tar uhc
16980
16981 Examples:
16982 cabal v1-configure
16983 Configure with defaults;
16984 cabal v1-configure --enable-tests -fcustomflag
16985 Configure building package including tests,
16986 with some package-specific flag.
16987
16988 The v1-configure command is a part of the legacy v1 style of cabal
16989 usage.
16990
16991 It is a legacy feature and will be removed in a future release of
16992 cabal-install. Please file a bug if you cannot replicate a working v1-
16993 use case with the new-style commands.
16994
16995 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
16996
16997
16998 Flags:
16999 -v, --verbose [n]
17000 Control verbosity (n is 0--3, default verbosity level is
17001 1)
17002
17003 --builddir, --distdir, --distpref DIR
17004 The directory where Cabal puts generated build files
17005 (default dist)
17006
17007 -g, --ghc
17008 compile with GHC
17009
17010 --ghcjs
17011 compile with GHCJS
17012
17013 --uhc
17014 compile with UHC
17015
17016 --haskell-suite
17017 compile with a haskell-suite compiler
17018
17019 --cabal-file PATH
17020 use this Cabal file
17021
17022 -w, --with-compiler PATH
17023 give the path to a particular compiler
17024
17025 --with-hc-pkg PATH
17026 give the path to the package tool
17027
17028 --prefix DIR
17029 bake this prefix in preparation of installation
17030
17031 --bindir DIR
17032 installation directory for executables
17033
17034 --libdir DIR
17035 installation directory for libraries
17036
17037 --libsubdir DIR
17038 subdirectory of libdir in which libs are installed
17039
17040 --dynlibdir DIR
17041 installation directory for dynamic libraries
17042
17043 --libexecdir DIR
17044 installation directory for program executables
17045
17046 --libexecsubdir DIR
17047 subdirectory of libexecdir in which private executables
17048 are installed
17049
17050 --datadir DIR
17051 installation directory for read-only data
17052
17053 --datasubdir DIR
17054 subdirectory of datadir in which data files are installed
17055
17056 --docdir DIR
17057 installation directory for documentation
17058
17059 --htmldir DIR
17060 installation directory for HTML documentation
17061
17062 --haddockdir DIR
17063 installation directory for haddock interfaces
17064
17065 --sysconfdir DIR
17066 installation directory for configuration files
17067
17068 --program-prefix PREFIX
17069 prefix to be applied to installed executables
17070
17071 --program-suffix SUFFIX
17072 suffix to be applied to installed executables
17073
17074 --enable-library-vanilla
17075 --disable-library-vanilla
17076 Vanilla libraries
17077
17078 -p, --enable-library-profiling
17079 --disable-library-profiling
17080 Library profiling
17081
17082 --enable-shared
17083 --disable-shared
17084 Shared library
17085
17086 --enable-static
17087 --disable-static
17088 Static library
17089
17090 --enable-executable-dynamic
17091 --disable-executable-dynamic
17092 Executable dynamic linking
17093
17094 --enable-profiling
17095 --disable-profiling
17096 Executable and library profiling
17097
17098 --enable-executable-profiling
17099 --disable-executable-profiling
17100 Executable profiling (DEPRECATED)
17101
17102 --profiling-detail level
17103 Profiling detail level for executable and library
17104 (default, none, exported-functions, toplevel-functions,
17105 all-functions).
17106
17107 --library-profiling-detail level
17108 Profiling detail level for libraries only.
17109
17110 -O, --enable-optimization, --enable-optimisation [n]
17111 Build with optimization (n is 0--2, default is 1)
17112
17113 --disable-optimization, --disable-optimisation
17114 Build without optimization
17115
17116 --enable-debug-info [n]
17117 Emit debug info (n is 0--3, default is 0)
17118
17119 --disable-debug-info
17120 Don't emit debug info
17121
17122 --enable-library-for-ghci
17123 --disable-library-for-ghci
17124 compile library for use with GHCi
17125
17126 --enable-split-sections
17127 --disable-split-sections
17128 compile library code such that unneeded definitions can
17129 be dropped from the final executable (GHC 7.8+)
17130
17131 --enable-split-objs
17132 --disable-split-objs
17133 split library into smaller objects to reduce binary sizes
17134 (GHC 6.6+)
17135
17136 --enable-executable-stripping
17137 --disable-executable-stripping
17138 strip executables upon installation to reduce binary
17139 sizes
17140
17141 --enable-library-stripping
17142 --disable-library-stripping
17143 strip libraries upon installation to reduce binary sizes
17144
17145 --configure-option OPT
17146 Extra option for configure
17147
17148 --user
17149 --global
17150 doing a per-user installation
17151
17152 --package-db DB
17153 Append the given package database to the list of package
17154 databases used (to satisfy dependencies and register
17155 into). May be a specific file, 'global' or 'user'. The
17156 initial list is ['global'], ['global', 'user'], or
17157 ['global', $sandbox], depending on context. Use 'clear'
17158 to reset the list to empty. See the user guide for
17159 details.
17160
17161 -f, --flags FLAGS
17162 Force values for the given flags in Cabal conditionals in
17163 the .cabal file. E.g., --flags="debug -usebytestrings"
17164 forces the flag "debug" to true and "usebytestrings" to
17165 false.
17166
17167 --extra-include-dirs PATH
17168 A list of directories to search for header files
17169
17170 --enable-deterministic
17171 --disable-deterministic
17172 Try to be as deterministic as possible (used by the test
17173 suite)
17174
17175 --ipid IPID
17176 Installed package ID to compile this package as
17177
17178 --cid CID
17179 Installed component ID to compile this component as
17180
17181 --extra-lib-dirs PATH
17182 A list of directories to search for external libraries
17183
17184 --extra-framework-dirs PATH
17185 A list of directories to search for external frameworks
17186 (OS X only)
17187
17188 --extra-prog-path PATH
17189 A list of directories to search for required programs (in
17190 addition to the normal search locations)
17191
17192 --instantiate-with NAME=MOD
17193 A mapping of signature names to concrete module instanti‐
17194 ations.
17195
17196 --enable-tests
17197 --disable-tests
17198 dependency checking and compilation for test suites
17199 listed in the package description file.
17200
17201 --enable-coverage
17202 --disable-coverage
17203 build package with Haskell Program Coverage. (GHC only)
17204
17205 --enable-library-coverage
17206 --disable-library-coverage
17207 build package with Haskell Program Coverage. (GHC only)
17208 (DEPRECATED)
17209
17210 --enable-benchmarks
17211 --disable-benchmarks
17212 dependency checking and compilation for benchmarks listed
17213 in the package description file.
17214
17215 --enable-relocatable
17216 --disable-relocatable
17217 building a package that is relocatable. (GHC only)
17218
17219 --disable-response-files
17220 enable workaround for old versions of programs like "ar"
17221 that do not support @file arguments
17222
17223 --with-alex PATH
17224 give the path to alex
17225
17226 --with-ar PATH
17227 give the path to ar
17228
17229 --with-c2hs PATH
17230 give the path to c2hs
17231
17232 --with-cpphs PATH
17233 give the path to cpphs
17234
17235 --with-doctest PATH
17236 give the path to doctest
17237
17238 --with-gcc PATH
17239 give the path to gcc
17240
17241 --with-ghc PATH
17242 give the path to ghc
17243
17244 --with-ghc-pkg PATH
17245 give the path to ghc-pkg
17246
17247 --with-ghcjs PATH
17248 give the path to ghcjs
17249
17250 --with-ghcjs-pkg PATH
17251 give the path to ghcjs-pkg
17252
17253 --with-greencard PATH
17254 give the path to greencard
17255
17256 --with-haddock PATH
17257 give the path to haddock
17258
17259 --with-happy PATH
17260 give the path to happy
17261
17262 --with-haskell-suite PATH
17263 give the path to haskell-suite
17264
17265 --with-haskell-suite-pkg PATH
17266 give the path to haskell-suite-pkg
17267
17268 --with-hmake PATH
17269 give the path to hmake
17270
17271 --with-hpc PATH
17272 give the path to hpc
17273
17274 --with-hsc2hs PATH
17275 give the path to hsc2hs
17276
17277 --with-hscolour PATH
17278 give the path to hscolour
17279
17280 --with-jhc PATH
17281 give the path to jhc
17282
17283 --with-ld PATH
17284 give the path to ld
17285
17286 --with-pkg-config PATH
17287 give the path to pkg-config
17288
17289 --with-runghc PATH
17290 give the path to runghc
17291
17292 --with-strip PATH
17293 give the path to strip
17294
17295 --with-tar PATH
17296 give the path to tar
17297
17298 --with-uhc PATH
17299 give the path to uhc
17300
17301 --alex-option OPT
17302 give an extra option to alex (no need to quote options
17303 containing spaces)
17304
17305 --ar-option OPT
17306 give an extra option to ar (no need to quote options con‐
17307 taining spaces)
17308
17309 --c2hs-option OPT
17310 give an extra option to c2hs (no need to quote options
17311 containing spaces)
17312
17313 --cpphs-option OPT
17314 give an extra option to cpphs (no need to quote options
17315 containing spaces)
17316
17317 --doctest-option OPT
17318 give an extra option to doctest (no need to quote options
17319 containing spaces)
17320
17321 --gcc-option OPT
17322 give an extra option to gcc (no need to quote options
17323 containing spaces)
17324
17325 --ghc-option OPT
17326 give an extra option to ghc (no need to quote options
17327 containing spaces)
17328
17329 --ghc-pkg-option OPT
17330 give an extra option to ghc-pkg (no need to quote options
17331 containing spaces)
17332
17333 --ghcjs-option OPT
17334 give an extra option to ghcjs (no need to quote options
17335 containing spaces)
17336
17337 --ghcjs-pkg-option OPT
17338 give an extra option to ghcjs-pkg (no need to quote
17339 options containing spaces)
17340
17341 --greencard-option OPT
17342 give an extra option to greencard (no need to quote
17343 options containing spaces)
17344
17345 --haddock-option OPT
17346 give an extra option to haddock (no need to quote options
17347 containing spaces)
17348
17349 --happy-option OPT
17350 give an extra option to happy (no need to quote options
17351 containing spaces)
17352
17353 --haskell-suite-option OPT
17354 give an extra option to haskell-suite (no need to quote
17355 options containing spaces)
17356
17357 --haskell-suite-pkg-option OPT
17358 give an extra option to haskell-suite-pkg (no need to
17359 quote options containing spaces)
17360
17361 --hmake-option OPT
17362 give an extra option to hmake (no need to quote options
17363 containing spaces)
17364
17365 --hpc-option OPT
17366 give an extra option to hpc (no need to quote options
17367 containing spaces)
17368
17369 --hsc2hs-option OPT
17370 give an extra option to hsc2hs (no need to quote options
17371 containing spaces)
17372
17373 --hscolour-option OPT
17374 give an extra option to hscolour (no need to quote
17375 options containing spaces)
17376
17377 --jhc-option OPT
17378 give an extra option to jhc (no need to quote options
17379 containing spaces)
17380
17381 --ld-option OPT
17382 give an extra option to ld (no need to quote options con‐
17383 taining spaces)
17384
17385 --pkg-config-option OPT
17386 give an extra option to pkg-config (no need to quote
17387 options containing spaces)
17388
17389 --runghc-option OPT
17390 give an extra option to runghc (no need to quote options
17391 containing spaces)
17392
17393 --strip-option OPT
17394 give an extra option to strip (no need to quote options
17395 containing spaces)
17396
17397 --tar-option OPT
17398 give an extra option to tar (no need to quote options
17399 containing spaces)
17400
17401 --uhc-option OPT
17402 give an extra option to uhc (no need to quote options
17403 containing spaces)
17404
17405 --alex-options OPTS
17406 give extra options to alex
17407
17408 --ar-options OPTS
17409 give extra options to ar
17410
17411 --c2hs-options OPTS
17412 give extra options to c2hs
17413
17414 --cpphs-options OPTS
17415 give extra options to cpphs
17416
17417 --doctest-options OPTS
17418 give extra options to doctest
17419
17420 --gcc-options OPTS
17421 give extra options to gcc
17422
17423 --ghc-options OPTS
17424 give extra options to ghc
17425
17426 --ghc-pkg-options OPTS
17427 give extra options to ghc-pkg
17428
17429 --ghcjs-options OPTS
17430 give extra options to ghcjs
17431
17432 --ghcjs-pkg-options OPTS
17433 give extra options to ghcjs-pkg
17434
17435 --greencard-options OPTS
17436 give extra options to greencard
17437
17438 --haddock-options OPTS
17439 give extra options to haddock
17440
17441 --happy-options OPTS
17442 give extra options to happy
17443
17444 --haskell-suite-options OPTS
17445 give extra options to haskell-suite
17446
17447 --haskell-suite-pkg-options OPTS
17448 give extra options to haskell-suite-pkg
17449
17450 --hmake-options OPTS
17451 give extra options to hmake
17452
17453 --hpc-options OPTS
17454 give extra options to hpc
17455
17456 --hsc2hs-options OPTS
17457 give extra options to hsc2hs
17458
17459 --hscolour-options OPTS
17460 give extra options to hscolour
17461
17462 --jhc-options OPTS
17463 give extra options to jhc
17464
17465 --ld-options OPTS
17466 give extra options to ld
17467
17468 --pkg-config-options OPTS
17469 give extra options to pkg-config
17470
17471 --runghc-options OPTS
17472 give extra options to runghc
17473
17474 --strip-options OPTS
17475 give extra options to strip
17476
17477 --tar-options OPTS
17478 give extra options to tar
17479
17480 --uhc-options OPTS
17481 give extra options to uhc
17482
17483 --cabal-lib-version VERSION
17484 Select which version of the Cabal lib to use to build
17485 packages (useful for testing).
17486
17487 --constraint CONSTRAINT
17488 Specify constraints on a package (version,
17489 installed/source, flags)
17490
17491 --preference CONSTRAINT
17492 Specify preferences (soft constraints) on the version of
17493 a package
17494
17495 --solver SOLVER
17496 Select dependency solver to use (default: modular).
17497 Choices: modular.
17498
17499 --allow-older [DEPS]
17500 Ignore lower bounds in all dependencies or DEPS
17501
17502 --allow-newer [DEPS]
17503 Ignore upper bounds in all dependencies or DEPS
17504
17505 --write-ghc-environment-files always|never|ghc8.4.4+
17506 Whether to create a .ghc.environment file after a suc‐
17507 cessful build (v2-build only)
17508
17509
17510 cabal update
17511
17512 Usage: cabal update [FLAGS]
17513
17514
17515 For all known remote repositories, download the package list.
17516
17517
17518 Relevant global configuration keys:
17519 remote-repo
17520 remote-repo-cache
17521 local-repo
17522
17523 The update command is a part of the legacy v1 style of cabal usage.
17524
17525 Please switch to using either the new project style and the new-update
17526 command or the legacy v1-update alias as new-style projects will become
17527 the default in the next version of cabal-install. Please file a bug if
17528 you cannot replicate a working v1- use case with the new-style com‐
17529 mands.
17530
17531 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17532
17533
17534 Flags:
17535 -v, --verbose [n]
17536 Control verbosity (n is 0--3, default verbosity level is
17537 1)
17538
17539 --index-state STATE
17540 Update the source package index to its state as it
17541 existed at a previous time. Accepts unix-timestamps (e.g.
17542 '@1474732068'), ISO8601 UTC timestamps (e.g.
17543 '2016-09-24T17:47:48Z'), or 'HEAD' (default: 'HEAD').
17544
17545
17546 cabal v1-update
17547
17548 Usage: cabal v1-update [FLAGS]
17549
17550
17551 For all known remote repositories, download the package list.
17552
17553
17554 Relevant global configuration keys:
17555 remote-repo
17556 remote-repo-cache
17557 local-repo
17558
17559 The v1-update command is a part of the legacy v1 style of cabal usage.
17560
17561 It is a legacy feature and will be removed in a future release of
17562 cabal-install. Please file a bug if you cannot replicate a working v1-
17563 use case with the new-style commands.
17564
17565 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17566
17567
17568 Flags:
17569 -v, --verbose [n]
17570 Control verbosity (n is 0--3, default verbosity level is
17571 1)
17572
17573 --index-state STATE
17574 Update the source package index to its state as it
17575 existed at a previous time. Accepts unix-timestamps (e.g.
17576 '@1474732068'), ISO8601 UTC timestamps (e.g.
17577 '2016-09-24T17:47:48Z'), or 'HEAD' (default: 'HEAD').
17578
17579
17580 cabal build
17581
17582 Usage: cabal build [FLAGS]
17583 or: cabal build COMPONENTS [FLAGS]
17584
17585
17586 Components encompass executables, tests, and benchmarks.
17587
17588 Affected by configuration options, see `configure`.
17589
17590
17591 Examples:
17592 cabal build All the components in the package
17593 cabal build foo A component (i.e. lib, exe, test suite)
17594
17595 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
17596 ing programs:
17597 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
17598 haddock
17599 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
17600 ld
17601 pkg-config runghc strip tar uhc
17602
17603 The build command is a part of the legacy v1 style of cabal usage.
17604
17605 Please switch to using either the new project style and the new-build
17606 command or the legacy v1-build alias as new-style projects will become
17607 the default in the next version of cabal-install. Please file a bug if
17608 you cannot replicate a working v1- use case with the new-style com‐
17609 mands.
17610
17611 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17612
17613
17614 Flags:
17615 -v, --verbose [n]
17616 Control verbosity (n is 0--3, default verbosity level is
17617 1)
17618
17619 --builddir, --distdir, --distpref DIR
17620 The directory where Cabal puts generated build files
17621 (default dist)
17622
17623 -j, --jobs [NUM]
17624 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
17625 given).
17626
17627 --with-alex PATH
17628 give the path to alex
17629
17630 --with-ar PATH
17631 give the path to ar
17632
17633 --with-c2hs PATH
17634 give the path to c2hs
17635
17636 --with-cpphs PATH
17637 give the path to cpphs
17638
17639 --with-doctest PATH
17640 give the path to doctest
17641
17642 --with-gcc PATH
17643 give the path to gcc
17644
17645 --with-ghc PATH
17646 give the path to ghc
17647
17648 --with-ghc-pkg PATH
17649 give the path to ghc-pkg
17650
17651 --with-ghcjs PATH
17652 give the path to ghcjs
17653
17654 --with-ghcjs-pkg PATH
17655 give the path to ghcjs-pkg
17656
17657 --with-greencard PATH
17658 give the path to greencard
17659
17660 --with-haddock PATH
17661 give the path to haddock
17662
17663 --with-happy PATH
17664 give the path to happy
17665
17666 --with-haskell-suite PATH
17667 give the path to haskell-suite
17668
17669 --with-haskell-suite-pkg PATH
17670 give the path to haskell-suite-pkg
17671
17672 --with-hmake PATH
17673 give the path to hmake
17674
17675 --with-hpc PATH
17676 give the path to hpc
17677
17678 --with-hsc2hs PATH
17679 give the path to hsc2hs
17680
17681 --with-hscolour PATH
17682 give the path to hscolour
17683
17684 --with-jhc PATH
17685 give the path to jhc
17686
17687 --with-ld PATH
17688 give the path to ld
17689
17690 --with-pkg-config PATH
17691 give the path to pkg-config
17692
17693 --with-runghc PATH
17694 give the path to runghc
17695
17696 --with-strip PATH
17697 give the path to strip
17698
17699 --with-tar PATH
17700 give the path to tar
17701
17702 --with-uhc PATH
17703 give the path to uhc
17704
17705 --alex-option OPT
17706 give an extra option to alex (no need to quote options
17707 containing spaces)
17708
17709 --ar-option OPT
17710 give an extra option to ar (no need to quote options con‐
17711 taining spaces)
17712
17713 --c2hs-option OPT
17714 give an extra option to c2hs (no need to quote options
17715 containing spaces)
17716
17717 --cpphs-option OPT
17718 give an extra option to cpphs (no need to quote options
17719 containing spaces)
17720
17721 --doctest-option OPT
17722 give an extra option to doctest (no need to quote options
17723 containing spaces)
17724
17725 --gcc-option OPT
17726 give an extra option to gcc (no need to quote options
17727 containing spaces)
17728
17729 --ghc-option OPT
17730 give an extra option to ghc (no need to quote options
17731 containing spaces)
17732
17733 --ghc-pkg-option OPT
17734 give an extra option to ghc-pkg (no need to quote options
17735 containing spaces)
17736
17737 --ghcjs-option OPT
17738 give an extra option to ghcjs (no need to quote options
17739 containing spaces)
17740
17741 --ghcjs-pkg-option OPT
17742 give an extra option to ghcjs-pkg (no need to quote
17743 options containing spaces)
17744
17745 --greencard-option OPT
17746 give an extra option to greencard (no need to quote
17747 options containing spaces)
17748
17749 --haddock-option OPT
17750 give an extra option to haddock (no need to quote options
17751 containing spaces)
17752
17753 --happy-option OPT
17754 give an extra option to happy (no need to quote options
17755 containing spaces)
17756
17757 --haskell-suite-option OPT
17758 give an extra option to haskell-suite (no need to quote
17759 options containing spaces)
17760
17761 --haskell-suite-pkg-option OPT
17762 give an extra option to haskell-suite-pkg (no need to
17763 quote options containing spaces)
17764
17765 --hmake-option OPT
17766 give an extra option to hmake (no need to quote options
17767 containing spaces)
17768
17769 --hpc-option OPT
17770 give an extra option to hpc (no need to quote options
17771 containing spaces)
17772
17773 --hsc2hs-option OPT
17774 give an extra option to hsc2hs (no need to quote options
17775 containing spaces)
17776
17777 --hscolour-option OPT
17778 give an extra option to hscolour (no need to quote
17779 options containing spaces)
17780
17781 --jhc-option OPT
17782 give an extra option to jhc (no need to quote options
17783 containing spaces)
17784
17785 --ld-option OPT
17786 give an extra option to ld (no need to quote options con‐
17787 taining spaces)
17788
17789 --pkg-config-option OPT
17790 give an extra option to pkg-config (no need to quote
17791 options containing spaces)
17792
17793 --runghc-option OPT
17794 give an extra option to runghc (no need to quote options
17795 containing spaces)
17796
17797 --strip-option OPT
17798 give an extra option to strip (no need to quote options
17799 containing spaces)
17800
17801 --tar-option OPT
17802 give an extra option to tar (no need to quote options
17803 containing spaces)
17804
17805 --uhc-option OPT
17806 give an extra option to uhc (no need to quote options
17807 containing spaces)
17808
17809 --alex-options OPTS
17810 give extra options to alex
17811
17812 --ar-options OPTS
17813 give extra options to ar
17814
17815 --c2hs-options OPTS
17816 give extra options to c2hs
17817
17818 --cpphs-options OPTS
17819 give extra options to cpphs
17820
17821 --doctest-options OPTS
17822 give extra options to doctest
17823
17824 --gcc-options OPTS
17825 give extra options to gcc
17826
17827 --ghc-options OPTS
17828 give extra options to ghc
17829
17830 --ghc-pkg-options OPTS
17831 give extra options to ghc-pkg
17832
17833 --ghcjs-options OPTS
17834 give extra options to ghcjs
17835
17836 --ghcjs-pkg-options OPTS
17837 give extra options to ghcjs-pkg
17838
17839 --greencard-options OPTS
17840 give extra options to greencard
17841
17842 --haddock-options OPTS
17843 give extra options to haddock
17844
17845 --happy-options OPTS
17846 give extra options to happy
17847
17848 --haskell-suite-options OPTS
17849 give extra options to haskell-suite
17850
17851 --haskell-suite-pkg-options OPTS
17852 give extra options to haskell-suite-pkg
17853
17854 --hmake-options OPTS
17855 give extra options to hmake
17856
17857 --hpc-options OPTS
17858 give extra options to hpc
17859
17860 --hsc2hs-options OPTS
17861 give extra options to hsc2hs
17862
17863 --hscolour-options OPTS
17864 give extra options to hscolour
17865
17866 --jhc-options OPTS
17867 give extra options to jhc
17868
17869 --ld-options OPTS
17870 give extra options to ld
17871
17872 --pkg-config-options OPTS
17873 give extra options to pkg-config
17874
17875 --runghc-options OPTS
17876 give extra options to runghc
17877
17878 --strip-options OPTS
17879 give extra options to strip
17880
17881 --tar-options OPTS
17882 give extra options to tar
17883
17884 --uhc-options OPTS
17885 give extra options to uhc
17886
17887 --only
17888 Don't reinstall add-source dependencies (sandbox-only)
17889
17890
17891 cabal v1-build
17892
17893 Usage: cabal v1-build [FLAGS]
17894 or: cabal v1-build COMPONENTS [FLAGS]
17895
17896
17897 Components encompass executables, tests, and benchmarks.
17898
17899 Affected by configuration options, see `v1-configure`.
17900
17901
17902 Examples:
17903 cabal v1-build All the components in the package
17904 cabal v1-build foo A component (i.e. lib, exe, test suite)
17905
17906 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
17907 ing programs:
17908 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
17909 haddock
17910 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
17911 ld
17912 pkg-config runghc strip tar uhc
17913
17914 The v1-build command is a part of the legacy v1 style of cabal usage.
17915
17916 It is a legacy feature and will be removed in a future release of
17917 cabal-install. Please file a bug if you cannot replicate a working v1-
17918 use case with the new-style commands.
17919
17920 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17921
17922
17923 Flags:
17924 -v, --verbose [n]
17925 Control verbosity (n is 0--3, default verbosity level is
17926 1)
17927
17928 --builddir, --distdir, --distpref DIR
17929 The directory where Cabal puts generated build files
17930 (default dist)
17931
17932 -j, --jobs [NUM]
17933 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
17934 given).
17935
17936 --with-alex PATH
17937 give the path to alex
17938
17939 --with-ar PATH
17940 give the path to ar
17941
17942 --with-c2hs PATH
17943 give the path to c2hs
17944
17945 --with-cpphs PATH
17946 give the path to cpphs
17947
17948 --with-doctest PATH
17949 give the path to doctest
17950
17951 --with-gcc PATH
17952 give the path to gcc
17953
17954 --with-ghc PATH
17955 give the path to ghc
17956
17957 --with-ghc-pkg PATH
17958 give the path to ghc-pkg
17959
17960 --with-ghcjs PATH
17961 give the path to ghcjs
17962
17963 --with-ghcjs-pkg PATH
17964 give the path to ghcjs-pkg
17965
17966 --with-greencard PATH
17967 give the path to greencard
17968
17969 --with-haddock PATH
17970 give the path to haddock
17971
17972 --with-happy PATH
17973 give the path to happy
17974
17975 --with-haskell-suite PATH
17976 give the path to haskell-suite
17977
17978 --with-haskell-suite-pkg PATH
17979 give the path to haskell-suite-pkg
17980
17981 --with-hmake PATH
17982 give the path to hmake
17983
17984 --with-hpc PATH
17985 give the path to hpc
17986
17987 --with-hsc2hs PATH
17988 give the path to hsc2hs
17989
17990 --with-hscolour PATH
17991 give the path to hscolour
17992
17993 --with-jhc PATH
17994 give the path to jhc
17995
17996 --with-ld PATH
17997 give the path to ld
17998
17999 --with-pkg-config PATH
18000 give the path to pkg-config
18001
18002 --with-runghc PATH
18003 give the path to runghc
18004
18005 --with-strip PATH
18006 give the path to strip
18007
18008 --with-tar PATH
18009 give the path to tar
18010
18011 --with-uhc PATH
18012 give the path to uhc
18013
18014 --alex-option OPT
18015 give an extra option to alex (no need to quote options
18016 containing spaces)
18017
18018 --ar-option OPT
18019 give an extra option to ar (no need to quote options con‐
18020 taining spaces)
18021
18022 --c2hs-option OPT
18023 give an extra option to c2hs (no need to quote options
18024 containing spaces)
18025
18026 --cpphs-option OPT
18027 give an extra option to cpphs (no need to quote options
18028 containing spaces)
18029
18030 --doctest-option OPT
18031 give an extra option to doctest (no need to quote options
18032 containing spaces)
18033
18034 --gcc-option OPT
18035 give an extra option to gcc (no need to quote options
18036 containing spaces)
18037
18038 --ghc-option OPT
18039 give an extra option to ghc (no need to quote options
18040 containing spaces)
18041
18042 --ghc-pkg-option OPT
18043 give an extra option to ghc-pkg (no need to quote options
18044 containing spaces)
18045
18046 --ghcjs-option OPT
18047 give an extra option to ghcjs (no need to quote options
18048 containing spaces)
18049
18050 --ghcjs-pkg-option OPT
18051 give an extra option to ghcjs-pkg (no need to quote
18052 options containing spaces)
18053
18054 --greencard-option OPT
18055 give an extra option to greencard (no need to quote
18056 options containing spaces)
18057
18058 --haddock-option OPT
18059 give an extra option to haddock (no need to quote options
18060 containing spaces)
18061
18062 --happy-option OPT
18063 give an extra option to happy (no need to quote options
18064 containing spaces)
18065
18066 --haskell-suite-option OPT
18067 give an extra option to haskell-suite (no need to quote
18068 options containing spaces)
18069
18070 --haskell-suite-pkg-option OPT
18071 give an extra option to haskell-suite-pkg (no need to
18072 quote options containing spaces)
18073
18074 --hmake-option OPT
18075 give an extra option to hmake (no need to quote options
18076 containing spaces)
18077
18078 --hpc-option OPT
18079 give an extra option to hpc (no need to quote options
18080 containing spaces)
18081
18082 --hsc2hs-option OPT
18083 give an extra option to hsc2hs (no need to quote options
18084 containing spaces)
18085
18086 --hscolour-option OPT
18087 give an extra option to hscolour (no need to quote
18088 options containing spaces)
18089
18090 --jhc-option OPT
18091 give an extra option to jhc (no need to quote options
18092 containing spaces)
18093
18094 --ld-option OPT
18095 give an extra option to ld (no need to quote options con‐
18096 taining spaces)
18097
18098 --pkg-config-option OPT
18099 give an extra option to pkg-config (no need to quote
18100 options containing spaces)
18101
18102 --runghc-option OPT
18103 give an extra option to runghc (no need to quote options
18104 containing spaces)
18105
18106 --strip-option OPT
18107 give an extra option to strip (no need to quote options
18108 containing spaces)
18109
18110 --tar-option OPT
18111 give an extra option to tar (no need to quote options
18112 containing spaces)
18113
18114 --uhc-option OPT
18115 give an extra option to uhc (no need to quote options
18116 containing spaces)
18117
18118 --alex-options OPTS
18119 give extra options to alex
18120
18121 --ar-options OPTS
18122 give extra options to ar
18123
18124 --c2hs-options OPTS
18125 give extra options to c2hs
18126
18127 --cpphs-options OPTS
18128 give extra options to cpphs
18129
18130 --doctest-options OPTS
18131 give extra options to doctest
18132
18133 --gcc-options OPTS
18134 give extra options to gcc
18135
18136 --ghc-options OPTS
18137 give extra options to ghc
18138
18139 --ghc-pkg-options OPTS
18140 give extra options to ghc-pkg
18141
18142 --ghcjs-options OPTS
18143 give extra options to ghcjs
18144
18145 --ghcjs-pkg-options OPTS
18146 give extra options to ghcjs-pkg
18147
18148 --greencard-options OPTS
18149 give extra options to greencard
18150
18151 --haddock-options OPTS
18152 give extra options to haddock
18153
18154 --happy-options OPTS
18155 give extra options to happy
18156
18157 --haskell-suite-options OPTS
18158 give extra options to haskell-suite
18159
18160 --haskell-suite-pkg-options OPTS
18161 give extra options to haskell-suite-pkg
18162
18163 --hmake-options OPTS
18164 give extra options to hmake
18165
18166 --hpc-options OPTS
18167 give extra options to hpc
18168
18169 --hsc2hs-options OPTS
18170 give extra options to hsc2hs
18171
18172 --hscolour-options OPTS
18173 give extra options to hscolour
18174
18175 --jhc-options OPTS
18176 give extra options to jhc
18177
18178 --ld-options OPTS
18179 give extra options to ld
18180
18181 --pkg-config-options OPTS
18182 give extra options to pkg-config
18183
18184 --runghc-options OPTS
18185 give extra options to runghc
18186
18187 --strip-options OPTS
18188 give extra options to strip
18189
18190 --tar-options OPTS
18191 give extra options to tar
18192
18193 --uhc-options OPTS
18194 give extra options to uhc
18195
18196 --only
18197 Don't reinstall add-source dependencies (sandbox-only)
18198
18199
18200 cabal repl
18201
18202 Usage: cabal repl [COMPONENT] [FLAGS]
18203
18204
18205 If the current directory contains no package, ignores COMPONENT parame‐
18206 ters and opens an interactive interpreter session; if a sandbox is
18207 present, its package database will be used.
18208
18209 Otherwise, (re)configures with the given or default flags, and loads
18210 the interpreter with the relevant modules. For executables, tests and
18211 benchmarks, loads the main module (and its dependencies); for libraries
18212 all exposed/other modules.
18213
18214 The default component is the library itself, or the executable if that
18215 is the only component.
18216
18217 Support for loading specific modules is planned but not implemented
18218 yet. For certain scenarios, `cabal exec -- ghci :l Foo` may be used
18219 instead. Note that `exec` will not (re)configure and you will have to
18220 specify the location of other modules, if required.
18221
18222
18223 Examples:
18224 cabal repl The first component in the package
18225 cabal repl foo A named component (i.e. lib, exe, test
18226 suite)
18227 cabal repl --ghc-options="-lstdc++" Specifying flags for interpreter
18228
18229 The repl command is a part of the legacy v1 style of cabal usage.
18230
18231 Please switch to using either the new project style and the new-repl
18232 command or the legacy v1-repl alias as new-style projects will become
18233 the default in the next version of cabal-install. Please file a bug if
18234 you cannot replicate a working v1- use case with the new-style com‐
18235 mands.
18236
18237 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18238
18239
18240 Flags:
18241 -v, --verbose [n]
18242 Control verbosity (n is 0--3, default verbosity level is
18243 1)
18244
18245 --builddir, --distdir, --distpref DIR
18246 The directory where Cabal puts generated build files
18247 (default dist)
18248
18249 --with-alex PATH
18250 give the path to alex
18251
18252 --with-ar PATH
18253 give the path to ar
18254
18255 --with-c2hs PATH
18256 give the path to c2hs
18257
18258 --with-cpphs PATH
18259 give the path to cpphs
18260
18261 --with-doctest PATH
18262 give the path to doctest
18263
18264 --with-gcc PATH
18265 give the path to gcc
18266
18267 --with-ghc PATH
18268 give the path to ghc
18269
18270 --with-ghc-pkg PATH
18271 give the path to ghc-pkg
18272
18273 --with-ghcjs PATH
18274 give the path to ghcjs
18275
18276 --with-ghcjs-pkg PATH
18277 give the path to ghcjs-pkg
18278
18279 --with-greencard PATH
18280 give the path to greencard
18281
18282 --with-haddock PATH
18283 give the path to haddock
18284
18285 --with-happy PATH
18286 give the path to happy
18287
18288 --with-haskell-suite PATH
18289 give the path to haskell-suite
18290
18291 --with-haskell-suite-pkg PATH
18292 give the path to haskell-suite-pkg
18293
18294 --with-hmake PATH
18295 give the path to hmake
18296
18297 --with-hpc PATH
18298 give the path to hpc
18299
18300 --with-hsc2hs PATH
18301 give the path to hsc2hs
18302
18303 --with-hscolour PATH
18304 give the path to hscolour
18305
18306 --with-jhc PATH
18307 give the path to jhc
18308
18309 --with-ld PATH
18310 give the path to ld
18311
18312 --with-pkg-config PATH
18313 give the path to pkg-config
18314
18315 --with-runghc PATH
18316 give the path to runghc
18317
18318 --with-strip PATH
18319 give the path to strip
18320
18321 --with-tar PATH
18322 give the path to tar
18323
18324 --with-uhc PATH
18325 give the path to uhc
18326
18327 --alex-option OPT
18328 give an extra option to alex (no need to quote options
18329 containing spaces)
18330
18331 --ar-option OPT
18332 give an extra option to ar (no need to quote options con‐
18333 taining spaces)
18334
18335 --c2hs-option OPT
18336 give an extra option to c2hs (no need to quote options
18337 containing spaces)
18338
18339 --cpphs-option OPT
18340 give an extra option to cpphs (no need to quote options
18341 containing spaces)
18342
18343 --doctest-option OPT
18344 give an extra option to doctest (no need to quote options
18345 containing spaces)
18346
18347 --gcc-option OPT
18348 give an extra option to gcc (no need to quote options
18349 containing spaces)
18350
18351 --ghc-option OPT
18352 give an extra option to ghc (no need to quote options
18353 containing spaces)
18354
18355 --ghc-pkg-option OPT
18356 give an extra option to ghc-pkg (no need to quote options
18357 containing spaces)
18358
18359 --ghcjs-option OPT
18360 give an extra option to ghcjs (no need to quote options
18361 containing spaces)
18362
18363 --ghcjs-pkg-option OPT
18364 give an extra option to ghcjs-pkg (no need to quote
18365 options containing spaces)
18366
18367 --greencard-option OPT
18368 give an extra option to greencard (no need to quote
18369 options containing spaces)
18370
18371 --haddock-option OPT
18372 give an extra option to haddock (no need to quote options
18373 containing spaces)
18374
18375 --happy-option OPT
18376 give an extra option to happy (no need to quote options
18377 containing spaces)
18378
18379 --haskell-suite-option OPT
18380 give an extra option to haskell-suite (no need to quote
18381 options containing spaces)
18382
18383 --haskell-suite-pkg-option OPT
18384 give an extra option to haskell-suite-pkg (no need to
18385 quote options containing spaces)
18386
18387 --hmake-option OPT
18388 give an extra option to hmake (no need to quote options
18389 containing spaces)
18390
18391 --hpc-option OPT
18392 give an extra option to hpc (no need to quote options
18393 containing spaces)
18394
18395 --hsc2hs-option OPT
18396 give an extra option to hsc2hs (no need to quote options
18397 containing spaces)
18398
18399 --hscolour-option OPT
18400 give an extra option to hscolour (no need to quote
18401 options containing spaces)
18402
18403 --jhc-option OPT
18404 give an extra option to jhc (no need to quote options
18405 containing spaces)
18406
18407 --ld-option OPT
18408 give an extra option to ld (no need to quote options con‐
18409 taining spaces)
18410
18411 --pkg-config-option OPT
18412 give an extra option to pkg-config (no need to quote
18413 options containing spaces)
18414
18415 --runghc-option OPT
18416 give an extra option to runghc (no need to quote options
18417 containing spaces)
18418
18419 --strip-option OPT
18420 give an extra option to strip (no need to quote options
18421 containing spaces)
18422
18423 --tar-option OPT
18424 give an extra option to tar (no need to quote options
18425 containing spaces)
18426
18427 --uhc-option OPT
18428 give an extra option to uhc (no need to quote options
18429 containing spaces)
18430
18431 --alex-options OPTS
18432 give extra options to alex
18433
18434 --ar-options OPTS
18435 give extra options to ar
18436
18437 --c2hs-options OPTS
18438 give extra options to c2hs
18439
18440 --cpphs-options OPTS
18441 give extra options to cpphs
18442
18443 --doctest-options OPTS
18444 give extra options to doctest
18445
18446 --gcc-options OPTS
18447 give extra options to gcc
18448
18449 --ghc-options OPTS
18450 give extra options to ghc
18451
18452 --ghc-pkg-options OPTS
18453 give extra options to ghc-pkg
18454
18455 --ghcjs-options OPTS
18456 give extra options to ghcjs
18457
18458 --ghcjs-pkg-options OPTS
18459 give extra options to ghcjs-pkg
18460
18461 --greencard-options OPTS
18462 give extra options to greencard
18463
18464 --haddock-options OPTS
18465 give extra options to haddock
18466
18467 --happy-options OPTS
18468 give extra options to happy
18469
18470 --haskell-suite-options OPTS
18471 give extra options to haskell-suite
18472
18473 --haskell-suite-pkg-options OPTS
18474 give extra options to haskell-suite-pkg
18475
18476 --hmake-options OPTS
18477 give extra options to hmake
18478
18479 --hpc-options OPTS
18480 give extra options to hpc
18481
18482 --hsc2hs-options OPTS
18483 give extra options to hsc2hs
18484
18485 --hscolour-options OPTS
18486 give extra options to hscolour
18487
18488 --jhc-options OPTS
18489 give extra options to jhc
18490
18491 --ld-options OPTS
18492 give extra options to ld
18493
18494 --pkg-config-options OPTS
18495 give extra options to pkg-config
18496
18497 --runghc-options OPTS
18498 give extra options to runghc
18499
18500 --strip-options OPTS
18501 give extra options to strip
18502
18503 --tar-options OPTS
18504 give extra options to tar
18505
18506 --uhc-options OPTS
18507 give extra options to uhc
18508
18509 --reload
18510 Used from within an interpreter to update files.
18511
18512 --repl-options FLAG
18513 use this option for the repl
18514
18515 --only
18516 Don't reinstall add-source dependencies (sandbox-only)
18517
18518
18519 cabal v1-repl
18520
18521 Usage: cabal v1-repl [COMPONENT] [FLAGS]
18522
18523
18524 If the current directory contains no package, ignores COMPONENT parame‐
18525 ters and opens an interactive interpreter session; if a sandbox is
18526 present, its package database will be used.
18527
18528 Otherwise, (re)configures with the given or default flags, and loads
18529 the interpreter with the relevant modules. For executables, tests and
18530 benchmarks, loads the main module (and its dependencies); for libraries
18531 all exposed/other modules.
18532
18533 The default component is the library itself, or the executable if that
18534 is the only component.
18535
18536 Support for loading specific modules is planned but not implemented
18537 yet. For certain scenarios, `cabal v1-exec -- ghci :l Foo` may be used
18538 instead. Note that `v1-exec` will not (re)configure and you will have
18539 to specify the location of other modules, if required.
18540
18541
18542 Examples:
18543 cabal v1-repl The first component in the package
18544 cabal v1-repl foo A named component (i.e. lib, exe, test
18545 suite)
18546 cabal v1-repl --ghc-options="-lstdc++" Specifying flags for inter‐
18547 preter
18548
18549 The v1-repl command is a part of the legacy v1 style of cabal usage.
18550
18551 It is a legacy feature and will be removed in a future release of
18552 cabal-install. Please file a bug if you cannot replicate a working v1-
18553 use case with the new-style commands.
18554
18555 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18556
18557
18558 Flags:
18559 -v, --verbose [n]
18560 Control verbosity (n is 0--3, default verbosity level is
18561 1)
18562
18563 --builddir, --distdir, --distpref DIR
18564 The directory where Cabal puts generated build files
18565 (default dist)
18566
18567 --with-alex PATH
18568 give the path to alex
18569
18570 --with-ar PATH
18571 give the path to ar
18572
18573 --with-c2hs PATH
18574 give the path to c2hs
18575
18576 --with-cpphs PATH
18577 give the path to cpphs
18578
18579 --with-doctest PATH
18580 give the path to doctest
18581
18582 --with-gcc PATH
18583 give the path to gcc
18584
18585 --with-ghc PATH
18586 give the path to ghc
18587
18588 --with-ghc-pkg PATH
18589 give the path to ghc-pkg
18590
18591 --with-ghcjs PATH
18592 give the path to ghcjs
18593
18594 --with-ghcjs-pkg PATH
18595 give the path to ghcjs-pkg
18596
18597 --with-greencard PATH
18598 give the path to greencard
18599
18600 --with-haddock PATH
18601 give the path to haddock
18602
18603 --with-happy PATH
18604 give the path to happy
18605
18606 --with-haskell-suite PATH
18607 give the path to haskell-suite
18608
18609 --with-haskell-suite-pkg PATH
18610 give the path to haskell-suite-pkg
18611
18612 --with-hmake PATH
18613 give the path to hmake
18614
18615 --with-hpc PATH
18616 give the path to hpc
18617
18618 --with-hsc2hs PATH
18619 give the path to hsc2hs
18620
18621 --with-hscolour PATH
18622 give the path to hscolour
18623
18624 --with-jhc PATH
18625 give the path to jhc
18626
18627 --with-ld PATH
18628 give the path to ld
18629
18630 --with-pkg-config PATH
18631 give the path to pkg-config
18632
18633 --with-runghc PATH
18634 give the path to runghc
18635
18636 --with-strip PATH
18637 give the path to strip
18638
18639 --with-tar PATH
18640 give the path to tar
18641
18642 --with-uhc PATH
18643 give the path to uhc
18644
18645 --alex-option OPT
18646 give an extra option to alex (no need to quote options
18647 containing spaces)
18648
18649 --ar-option OPT
18650 give an extra option to ar (no need to quote options con‐
18651 taining spaces)
18652
18653 --c2hs-option OPT
18654 give an extra option to c2hs (no need to quote options
18655 containing spaces)
18656
18657 --cpphs-option OPT
18658 give an extra option to cpphs (no need to quote options
18659 containing spaces)
18660
18661 --doctest-option OPT
18662 give an extra option to doctest (no need to quote options
18663 containing spaces)
18664
18665 --gcc-option OPT
18666 give an extra option to gcc (no need to quote options
18667 containing spaces)
18668
18669 --ghc-option OPT
18670 give an extra option to ghc (no need to quote options
18671 containing spaces)
18672
18673 --ghc-pkg-option OPT
18674 give an extra option to ghc-pkg (no need to quote options
18675 containing spaces)
18676
18677 --ghcjs-option OPT
18678 give an extra option to ghcjs (no need to quote options
18679 containing spaces)
18680
18681 --ghcjs-pkg-option OPT
18682 give an extra option to ghcjs-pkg (no need to quote
18683 options containing spaces)
18684
18685 --greencard-option OPT
18686 give an extra option to greencard (no need to quote
18687 options containing spaces)
18688
18689 --haddock-option OPT
18690 give an extra option to haddock (no need to quote options
18691 containing spaces)
18692
18693 --happy-option OPT
18694 give an extra option to happy (no need to quote options
18695 containing spaces)
18696
18697 --haskell-suite-option OPT
18698 give an extra option to haskell-suite (no need to quote
18699 options containing spaces)
18700
18701 --haskell-suite-pkg-option OPT
18702 give an extra option to haskell-suite-pkg (no need to
18703 quote options containing spaces)
18704
18705 --hmake-option OPT
18706 give an extra option to hmake (no need to quote options
18707 containing spaces)
18708
18709 --hpc-option OPT
18710 give an extra option to hpc (no need to quote options
18711 containing spaces)
18712
18713 --hsc2hs-option OPT
18714 give an extra option to hsc2hs (no need to quote options
18715 containing spaces)
18716
18717 --hscolour-option OPT
18718 give an extra option to hscolour (no need to quote
18719 options containing spaces)
18720
18721 --jhc-option OPT
18722 give an extra option to jhc (no need to quote options
18723 containing spaces)
18724
18725 --ld-option OPT
18726 give an extra option to ld (no need to quote options con‐
18727 taining spaces)
18728
18729 --pkg-config-option OPT
18730 give an extra option to pkg-config (no need to quote
18731 options containing spaces)
18732
18733 --runghc-option OPT
18734 give an extra option to runghc (no need to quote options
18735 containing spaces)
18736
18737 --strip-option OPT
18738 give an extra option to strip (no need to quote options
18739 containing spaces)
18740
18741 --tar-option OPT
18742 give an extra option to tar (no need to quote options
18743 containing spaces)
18744
18745 --uhc-option OPT
18746 give an extra option to uhc (no need to quote options
18747 containing spaces)
18748
18749 --alex-options OPTS
18750 give extra options to alex
18751
18752 --ar-options OPTS
18753 give extra options to ar
18754
18755 --c2hs-options OPTS
18756 give extra options to c2hs
18757
18758 --cpphs-options OPTS
18759 give extra options to cpphs
18760
18761 --doctest-options OPTS
18762 give extra options to doctest
18763
18764 --gcc-options OPTS
18765 give extra options to gcc
18766
18767 --ghc-options OPTS
18768 give extra options to ghc
18769
18770 --ghc-pkg-options OPTS
18771 give extra options to ghc-pkg
18772
18773 --ghcjs-options OPTS
18774 give extra options to ghcjs
18775
18776 --ghcjs-pkg-options OPTS
18777 give extra options to ghcjs-pkg
18778
18779 --greencard-options OPTS
18780 give extra options to greencard
18781
18782 --haddock-options OPTS
18783 give extra options to haddock
18784
18785 --happy-options OPTS
18786 give extra options to happy
18787
18788 --haskell-suite-options OPTS
18789 give extra options to haskell-suite
18790
18791 --haskell-suite-pkg-options OPTS
18792 give extra options to haskell-suite-pkg
18793
18794 --hmake-options OPTS
18795 give extra options to hmake
18796
18797 --hpc-options OPTS
18798 give extra options to hpc
18799
18800 --hsc2hs-options OPTS
18801 give extra options to hsc2hs
18802
18803 --hscolour-options OPTS
18804 give extra options to hscolour
18805
18806 --jhc-options OPTS
18807 give extra options to jhc
18808
18809 --ld-options OPTS
18810 give extra options to ld
18811
18812 --pkg-config-options OPTS
18813 give extra options to pkg-config
18814
18815 --runghc-options OPTS
18816 give extra options to runghc
18817
18818 --strip-options OPTS
18819 give extra options to strip
18820
18821 --tar-options OPTS
18822 give extra options to tar
18823
18824 --uhc-options OPTS
18825 give extra options to uhc
18826
18827 --reload
18828 Used from within an interpreter to update files.
18829
18830 --repl-options FLAG
18831 use this option for the repl
18832
18833 --only
18834 Don't reinstall add-source dependencies (sandbox-only)
18835
18836
18837 cabal freeze
18838
18839 Usage: cabal freeze [FLAGS]
18840
18841
18842 Calculates a valid set of dependencies and their exact versions. If
18843 successful, saves the result to the file `cabal.config`.
18844
18845 The package versions specified in `cabal.config` will be used for any
18846 future installs.
18847
18848 An existing `cabal.config` is ignored and overwritten.
18849
18850
18851 The freeze command is a part of the legacy v1 style of cabal usage.
18852
18853 Please switch to using either the new project style and the new-freeze
18854 command or the legacy v1-freeze alias as new-style projects will become
18855 the default in the next version of cabal-install. Please file a bug if
18856 you cannot replicate a working v1- use case with the new-style com‐
18857 mands.
18858
18859 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18860
18861
18862 Flags:
18863 -v, --verbose [n]
18864 Control verbosity (n is 0--3, default verbosity level is
18865 1)
18866
18867 --dry-run
18868 Do not freeze anything, only print what would be frozen
18869
18870 --enable-tests
18871 --disable-tests
18872 freezing of the dependencies of any tests suites in the
18873 package description file.
18874
18875 --enable-benchmarks
18876 --disable-benchmarks
18877 freezing of the dependencies of any benchmarks suites in
18878 the package description file.
18879
18880 --solver SOLVER
18881 Select dependency solver to use (default: modular).
18882 Choices: modular.
18883
18884 --max-backjumps NUM
18885 Maximum number of backjumps allowed while solving
18886 (default: 2000). Use a negative number to enable unlim‐
18887 ited backtracking. Use 0 to disable backtracking com‐
18888 pletely.
18889
18890 --reorder-goals
18891 --no-reorder-goals
18892 Try to reorder goals according to certain heuristics.
18893 Slows things down on average, but may make backtracking
18894 faster for some packages.
18895
18896 --count-conflicts
18897 --no-count-conflicts
18898 Try to speed up solving by preferring goals that are
18899 involved in a lot of conflicts (default).
18900
18901 --independent-goals
18902 --no-independent-goals
18903 Treat several goals on the command line as independent.
18904 If several goals depend on the same package, different
18905 versions can be chosen.
18906
18907 --shadow-installed-packages
18908 --no-shadow-installed-packages
18909 If multiple package instances of the same version are
18910 installed, treat all but one as shadowed.
18911
18912 --strong-flags
18913 --no-strong-flags
18914 Do not defer flag choices (this used to be the default in
18915 cabal-install <= 1.20).
18916
18917 --allow-boot-library-installs
18918 --no-allow-boot-library-installs
18919 Allow cabal to install base, ghc-prim, integer-simple,
18920 integer-gmp, and template-haskell.
18921
18922
18923 cabal v1-freeze
18924
18925 Usage: cabal freeze [FLAGS]
18926
18927
18928 Calculates a valid set of dependencies and their exact versions. If
18929 successful, saves the result to the file `cabal.config`.
18930
18931 The package versions specified in `cabal.config` will be used for any
18932 future installs.
18933
18934 An existing `cabal.config` is ignored and overwritten.
18935
18936
18937 The v1-freeze command is a part of the legacy v1 style of cabal usage.
18938
18939 It is a legacy feature and will be removed in a future release of
18940 cabal-install. Please file a bug if you cannot replicate a working v1-
18941 use case with the new-style commands.
18942
18943 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18944
18945
18946 Flags:
18947 -v, --verbose [n]
18948 Control verbosity (n is 0--3, default verbosity level is
18949 1)
18950
18951 --dry-run
18952 Do not freeze anything, only print what would be frozen
18953
18954 --enable-tests
18955 --disable-tests
18956 freezing of the dependencies of any tests suites in the
18957 package description file.
18958
18959 --enable-benchmarks
18960 --disable-benchmarks
18961 freezing of the dependencies of any benchmarks suites in
18962 the package description file.
18963
18964 --solver SOLVER
18965 Select dependency solver to use (default: modular).
18966 Choices: modular.
18967
18968 --max-backjumps NUM
18969 Maximum number of backjumps allowed while solving
18970 (default: 2000). Use a negative number to enable unlim‐
18971 ited backtracking. Use 0 to disable backtracking com‐
18972 pletely.
18973
18974 --reorder-goals
18975 --no-reorder-goals
18976 Try to reorder goals according to certain heuristics.
18977 Slows things down on average, but may make backtracking
18978 faster for some packages.
18979
18980 --count-conflicts
18981 --no-count-conflicts
18982 Try to speed up solving by preferring goals that are
18983 involved in a lot of conflicts (default).
18984
18985 --independent-goals
18986 --no-independent-goals
18987 Treat several goals on the command line as independent.
18988 If several goals depend on the same package, different
18989 versions can be chosen.
18990
18991 --shadow-installed-packages
18992 --no-shadow-installed-packages
18993 If multiple package instances of the same version are
18994 installed, treat all but one as shadowed.
18995
18996 --strong-flags
18997 --no-strong-flags
18998 Do not defer flag choices (this used to be the default in
18999 cabal-install <= 1.20).
19000
19001 --allow-boot-library-installs
19002 --no-allow-boot-library-installs
19003 Allow cabal to install base, ghc-prim, integer-simple,
19004 integer-gmp, and template-haskell.
19005
19006
19007 cabal haddock
19008
19009 Usage: cabal haddock [FLAGS]
19010 or: cabal haddock COMPONENTS [FLAGS]
19011
19012
19013 Requires the program haddock, version 2.x.
19014
19015
19016 The haddock command is a part of the legacy v1 style of cabal usage.
19017
19018 Please switch to using either the new project style and the new-haddock
19019 command or the legacy v1-haddock alias as new-style projects will
19020 become the default in the next version of cabal-install. Please file a
19021 bug if you cannot replicate a working v1- use case with the new-style
19022 commands.
19023
19024 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
19025
19026
19027 Flags:
19028 -v, --verbose [n]
19029 Control verbosity (n is 0--3, default verbosity level is
19030 1)
19031
19032 --builddir, --distdir, --distpref DIR
19033 The directory where Cabal puts generated build files
19034 (default dist)
19035
19036 --keep-temp-files
19037 Keep temporary files
19038
19039 --hoogle
19040 Generate a hoogle database
19041
19042 --html
19043 Generate HTML documentation (the default)
19044
19045 --html-location URL
19046 Location of HTML documentation for pre-requisite packages
19047
19048 --for-hackage
19049 Collection of flags to generate documentation suitable
19050 for upload to hackage
19051
19052 --executables
19053 Run haddock for Executables targets
19054
19055 --tests
19056 Run haddock for Test Suite targets
19057
19058 --benchmarks
19059 Run haddock for Benchmark targets
19060
19061 --foreign-libraries
19062 Run haddock for Foreign Library targets
19063
19064 --all
19065 Run haddock for all targets
19066
19067 --internal
19068 Run haddock for internal modules and include all symbols
19069
19070 --css PATH
19071 Use PATH as the haddock stylesheet
19072
19073 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
19074 Hyperlink the documentation to the source code
19075
19076 --quickjump
19077 Generate an index for interactive documentation naviga‐
19078 tion
19079
19080 --hscolour-css PATH
19081 Use PATH as the HsColour stylesheet
19082
19083 --contents-location URL
19084 Bake URL in as the location for the contents page
19085
19086 --with-ghc PATH
19087 give the path to ghc
19088
19089 --with-haddock PATH
19090 give the path to haddock
19091
19092 --ghc-option OPT
19093 give an extra option to ghc (no need to quote options
19094 containing spaces)
19095
19096 --haddock-option OPT
19097 give an extra option to haddock (no need to quote options
19098 containing spaces)
19099
19100 --ghc-options OPTS
19101 give extra options to ghc
19102
19103 --haddock-options OPTS
19104 give extra options to haddock
19105
19106
19107 cabal v1-haddock
19108
19109 Usage: cabal v1-haddock [FLAGS]
19110 or: cabal v1-haddock COMPONENTS [FLAGS]
19111
19112
19113 Requires the program haddock, version 2.x.
19114
19115
19116 The v1-haddock command is a part of the legacy v1 style of cabal usage.
19117
19118 It is a legacy feature and will be removed in a future release of
19119 cabal-install. Please file a bug if you cannot replicate a working v1-
19120 use case with the new-style commands.
19121
19122 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
19123
19124
19125 Flags:
19126 -v, --verbose [n]
19127 Control verbosity (n is 0--3, default verbosity level is
19128 1)
19129
19130 --builddir, --distdir, --distpref DIR
19131 The directory where Cabal puts generated build files
19132 (default dist)
19133
19134 --keep-temp-files
19135 Keep temporary files
19136
19137 --hoogle
19138 Generate a hoogle database
19139
19140 --html
19141 Generate HTML documentation (the default)
19142
19143 --html-location URL
19144 Location of HTML documentation for pre-requisite packages
19145
19146 --for-hackage
19147 Collection of flags to generate documentation suitable
19148 for upload to hackage
19149
19150 --executables
19151 Run haddock for Executables targets
19152
19153 --tests
19154 Run haddock for Test Suite targets
19155
19156 --benchmarks
19157 Run haddock for Benchmark targets
19158
19159 --foreign-libraries
19160 Run haddock for Foreign Library targets
19161
19162 --all
19163 Run haddock for all targets
19164
19165 --internal
19166 Run haddock for internal modules and include all symbols
19167
19168 --css PATH
19169 Use PATH as the haddock stylesheet
19170
19171 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
19172 Hyperlink the documentation to the source code
19173
19174 --quickjump
19175 Generate an index for interactive documentation naviga‐
19176 tion
19177
19178 --hscolour-css PATH
19179 Use PATH as the HsColour stylesheet
19180
19181 --contents-location URL
19182 Bake URL in as the location for the contents page
19183
19184 --with-ghc PATH
19185 give the path to ghc
19186
19187 --with-haddock PATH
19188 give the path to haddock
19189
19190 --ghc-option OPT
19191 give an extra option to ghc (no need to quote options
19192 containing spaces)
19193
19194 --haddock-option OPT
19195 give an extra option to haddock (no need to quote options
19196 containing spaces)
19197
19198 --ghc-options OPTS
19199 give extra options to ghc
19200
19201 --haddock-options OPTS
19202 give extra options to haddock
19203
19204
19205 cabal install
19206
19207 Usage: cabal install [FLAGS]
19208 or: cabal install [FLAGS] PACKAGES
19209
19210
19211 Installs one or more packages. By default, the installed package will
19212 be registered in the user's package database or, if a sandbox is
19213 present in the current directory, inside the sandbox.
19214
19215 If PACKAGES are specified, downloads and installs those packages. Oth‐
19216 erwise, install the package in the current directory (and/or its depen‐
19217 dencies) (there must be exactly one .cabal file in the current direc‐
19218 tory).
19219
19220 When using a sandbox, the flags for `install` only affect the current
19221 command and have no effect on future commands. (To achieve that, `con‐
19222 figure` must be used.) In contrast, without a sandbox, the flags to
19223 `install` are saved and affect future commands such as `build` and
19224 `repl`. See the help for `configure` for a list of commands being
19225 affected.
19226
19227 Installed executables will by default (and without a sandbox) be put
19228 into `~/.cabal/bin/`. If you want installed executable to be available
19229 globally, make sure that the PATH environment variable contains that
19230 directory. When using a sandbox, executables will be put into `$SAND‐
19231 BOX/bin/` (by default: `./.cabal-sandbox/bin/`).
19232
19233 When specifying --bindir, consider also specifying --datadir; this way
19234 the sandbox can be deleted and the executable should continue working
19235 as long as bindir and datadir are left untouched.
19236
19237
19238 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
19239 ing programs:
19240 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
19241 haddock
19242 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
19243 ld
19244 pkg-config runghc strip tar uhc
19245
19246 Examples:
19247 cabal install Package in the current directory
19248 cabal install foo Package from the hackage server
19249 cabal install foo-1.0 Specific version of a package
19250 cabal install 'foo < 2' Constrained package version
19251 cabal install haddock --bindir=$HOME/hask-bin/ --datadir=$HOME/hask-
19252 data/
19253 Change installation destination
19254
19255 The install command is a part of the legacy v1 style of cabal usage.
19256
19257 Please switch to using either the new project style and the new-install
19258 command or the legacy v1-install alias as new-style projects will
19259 become the default in the next version of cabal-install. Please file a
19260 bug if you cannot replicate a working v1- use case with the new-style
19261 commands.
19262
19263 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
19264
19265
19266 Flags:
19267 -v, --verbose [n]
19268 Control verbosity (n is 0--3, default verbosity level is
19269 1)
19270
19271 --builddir, --distdir, --distpref DIR
19272 The directory where Cabal puts generated build files
19273 (default dist)
19274
19275 -g, --ghc
19276 compile with GHC
19277
19278 --ghcjs
19279 compile with GHCJS
19280
19281 --uhc
19282 compile with UHC
19283
19284 --haskell-suite
19285 compile with a haskell-suite compiler
19286
19287 --cabal-file PATH
19288 use this Cabal file
19289
19290 -w, --with-compiler PATH
19291 give the path to a particular compiler
19292
19293 --with-hc-pkg PATH
19294 give the path to the package tool
19295
19296 --prefix DIR
19297 bake this prefix in preparation of installation
19298
19299 --bindir DIR
19300 installation directory for executables
19301
19302 --libdir DIR
19303 installation directory for libraries
19304
19305 --libsubdir DIR
19306 subdirectory of libdir in which libs are installed
19307
19308 --dynlibdir DIR
19309 installation directory for dynamic libraries
19310
19311 --libexecdir DIR
19312 installation directory for program executables
19313
19314 --libexecsubdir DIR
19315 subdirectory of libexecdir in which private executables
19316 are installed
19317
19318 --datadir DIR
19319 installation directory for read-only data
19320
19321 --datasubdir DIR
19322 subdirectory of datadir in which data files are installed
19323
19324 --docdir DIR
19325 installation directory for documentation
19326
19327 --htmldir DIR
19328 installation directory for HTML documentation
19329
19330 --haddockdir DIR
19331 installation directory for haddock interfaces
19332
19333 --sysconfdir DIR
19334 installation directory for configuration files
19335
19336 --program-prefix PREFIX
19337 prefix to be applied to installed executables
19338
19339 --program-suffix SUFFIX
19340 suffix to be applied to installed executables
19341
19342 --enable-library-vanilla
19343 --disable-library-vanilla
19344 Vanilla libraries
19345
19346 -p, --enable-library-profiling
19347 --disable-library-profiling
19348 Library profiling
19349
19350 --enable-shared
19351 --disable-shared
19352 Shared library
19353
19354 --enable-static
19355 --disable-static
19356 Static library
19357
19358 --enable-executable-dynamic
19359 --disable-executable-dynamic
19360 Executable dynamic linking
19361
19362 --enable-profiling
19363 --disable-profiling
19364 Executable and library profiling
19365
19366 --enable-executable-profiling
19367 --disable-executable-profiling
19368 Executable profiling (DEPRECATED)
19369
19370 --profiling-detail level
19371 Profiling detail level for executable and library
19372 (default, none, exported-functions, toplevel-functions,
19373 all-functions).
19374
19375 --library-profiling-detail level
19376 Profiling detail level for libraries only.
19377
19378 -O, --enable-optimization, --enable-optimisation [n]
19379 Build with optimization (n is 0--2, default is 1)
19380
19381 --disable-optimization, --disable-optimisation
19382 Build without optimization
19383
19384 --enable-debug-info [n]
19385 Emit debug info (n is 0--3, default is 0)
19386
19387 --disable-debug-info
19388 Don't emit debug info
19389
19390 --enable-library-for-ghci
19391 --disable-library-for-ghci
19392 compile library for use with GHCi
19393
19394 --enable-split-sections
19395 --disable-split-sections
19396 compile library code such that unneeded definitions can
19397 be dropped from the final executable (GHC 7.8+)
19398
19399 --enable-split-objs
19400 --disable-split-objs
19401 split library into smaller objects to reduce binary sizes
19402 (GHC 6.6+)
19403
19404 --enable-executable-stripping
19405 --disable-executable-stripping
19406 strip executables upon installation to reduce binary
19407 sizes
19408
19409 --enable-library-stripping
19410 --disable-library-stripping
19411 strip libraries upon installation to reduce binary sizes
19412
19413 --configure-option OPT
19414 Extra option for configure
19415
19416 --user
19417 --global
19418 doing a per-user installation
19419
19420 --package-db DB
19421 Append the given package database to the list of package
19422 databases used (to satisfy dependencies and register
19423 into). May be a specific file, 'global' or 'user'. The
19424 initial list is ['global'], ['global', 'user'], or
19425 ['global', $sandbox], depending on context. Use 'clear'
19426 to reset the list to empty. See the user guide for
19427 details.
19428
19429 -f, --flags FLAGS
19430 Force values for the given flags in Cabal conditionals in
19431 the .cabal file. E.g., --flags="debug -usebytestrings"
19432 forces the flag "debug" to true and "usebytestrings" to
19433 false.
19434
19435 --extra-include-dirs PATH
19436 A list of directories to search for header files
19437
19438 --enable-deterministic
19439 --disable-deterministic
19440 Try to be as deterministic as possible (used by the test
19441 suite)
19442
19443 --ipid IPID
19444 Installed package ID to compile this package as
19445
19446 --cid CID
19447 Installed component ID to compile this component as
19448
19449 --extra-lib-dirs PATH
19450 A list of directories to search for external libraries
19451
19452 --extra-framework-dirs PATH
19453 A list of directories to search for external frameworks
19454 (OS X only)
19455
19456 --extra-prog-path PATH
19457 A list of directories to search for required programs (in
19458 addition to the normal search locations)
19459
19460 --instantiate-with NAME=MOD
19461 A mapping of signature names to concrete module instanti‐
19462 ations.
19463
19464 --enable-tests
19465 --disable-tests
19466 dependency checking and compilation for test suites
19467 listed in the package description file.
19468
19469 --enable-coverage
19470 --disable-coverage
19471 build package with Haskell Program Coverage. (GHC only)
19472
19473 --enable-library-coverage
19474 --disable-library-coverage
19475 build package with Haskell Program Coverage. (GHC only)
19476 (DEPRECATED)
19477
19478 --enable-benchmarks
19479 --disable-benchmarks
19480 dependency checking and compilation for benchmarks listed
19481 in the package description file.
19482
19483 --enable-relocatable
19484 --disable-relocatable
19485 building a package that is relocatable. (GHC only)
19486
19487 --disable-response-files
19488 enable workaround for old versions of programs like "ar"
19489 that do not support @file arguments
19490
19491 --with-alex PATH
19492 give the path to alex
19493
19494 --with-ar PATH
19495 give the path to ar
19496
19497 --with-c2hs PATH
19498 give the path to c2hs
19499
19500 --with-cpphs PATH
19501 give the path to cpphs
19502
19503 --with-doctest PATH
19504 give the path to doctest
19505
19506 --with-gcc PATH
19507 give the path to gcc
19508
19509 --with-ghc PATH
19510 give the path to ghc
19511
19512 --with-ghc-pkg PATH
19513 give the path to ghc-pkg
19514
19515 --with-ghcjs PATH
19516 give the path to ghcjs
19517
19518 --with-ghcjs-pkg PATH
19519 give the path to ghcjs-pkg
19520
19521 --with-greencard PATH
19522 give the path to greencard
19523
19524 --with-haddock PATH
19525 give the path to haddock
19526
19527 --with-happy PATH
19528 give the path to happy
19529
19530 --with-haskell-suite PATH
19531 give the path to haskell-suite
19532
19533 --with-haskell-suite-pkg PATH
19534 give the path to haskell-suite-pkg
19535
19536 --with-hmake PATH
19537 give the path to hmake
19538
19539 --with-hpc PATH
19540 give the path to hpc
19541
19542 --with-hsc2hs PATH
19543 give the path to hsc2hs
19544
19545 --with-hscolour PATH
19546 give the path to hscolour
19547
19548 --with-jhc PATH
19549 give the path to jhc
19550
19551 --with-ld PATH
19552 give the path to ld
19553
19554 --with-pkg-config PATH
19555 give the path to pkg-config
19556
19557 --with-runghc PATH
19558 give the path to runghc
19559
19560 --with-strip PATH
19561 give the path to strip
19562
19563 --with-tar PATH
19564 give the path to tar
19565
19566 --with-uhc PATH
19567 give the path to uhc
19568
19569 --alex-option OPT
19570 give an extra option to alex (no need to quote options
19571 containing spaces)
19572
19573 --ar-option OPT
19574 give an extra option to ar (no need to quote options con‐
19575 taining spaces)
19576
19577 --c2hs-option OPT
19578 give an extra option to c2hs (no need to quote options
19579 containing spaces)
19580
19581 --cpphs-option OPT
19582 give an extra option to cpphs (no need to quote options
19583 containing spaces)
19584
19585 --doctest-option OPT
19586 give an extra option to doctest (no need to quote options
19587 containing spaces)
19588
19589 --gcc-option OPT
19590 give an extra option to gcc (no need to quote options
19591 containing spaces)
19592
19593 --ghc-option OPT
19594 give an extra option to ghc (no need to quote options
19595 containing spaces)
19596
19597 --ghc-pkg-option OPT
19598 give an extra option to ghc-pkg (no need to quote options
19599 containing spaces)
19600
19601 --ghcjs-option OPT
19602 give an extra option to ghcjs (no need to quote options
19603 containing spaces)
19604
19605 --ghcjs-pkg-option OPT
19606 give an extra option to ghcjs-pkg (no need to quote
19607 options containing spaces)
19608
19609 --greencard-option OPT
19610 give an extra option to greencard (no need to quote
19611 options containing spaces)
19612
19613 --haddock-option OPT
19614 give an extra option to haddock (no need to quote options
19615 containing spaces)
19616
19617 --happy-option OPT
19618 give an extra option to happy (no need to quote options
19619 containing spaces)
19620
19621 --haskell-suite-option OPT
19622 give an extra option to haskell-suite (no need to quote
19623 options containing spaces)
19624
19625 --haskell-suite-pkg-option OPT
19626 give an extra option to haskell-suite-pkg (no need to
19627 quote options containing spaces)
19628
19629 --hmake-option OPT
19630 give an extra option to hmake (no need to quote options
19631 containing spaces)
19632
19633 --hpc-option OPT
19634 give an extra option to hpc (no need to quote options
19635 containing spaces)
19636
19637 --hsc2hs-option OPT
19638 give an extra option to hsc2hs (no need to quote options
19639 containing spaces)
19640
19641 --hscolour-option OPT
19642 give an extra option to hscolour (no need to quote
19643 options containing spaces)
19644
19645 --jhc-option OPT
19646 give an extra option to jhc (no need to quote options
19647 containing spaces)
19648
19649 --ld-option OPT
19650 give an extra option to ld (no need to quote options con‐
19651 taining spaces)
19652
19653 --pkg-config-option OPT
19654 give an extra option to pkg-config (no need to quote
19655 options containing spaces)
19656
19657 --runghc-option OPT
19658 give an extra option to runghc (no need to quote options
19659 containing spaces)
19660
19661 --strip-option OPT
19662 give an extra option to strip (no need to quote options
19663 containing spaces)
19664
19665 --tar-option OPT
19666 give an extra option to tar (no need to quote options
19667 containing spaces)
19668
19669 --uhc-option OPT
19670 give an extra option to uhc (no need to quote options
19671 containing spaces)
19672
19673 --alex-options OPTS
19674 give extra options to alex
19675
19676 --ar-options OPTS
19677 give extra options to ar
19678
19679 --c2hs-options OPTS
19680 give extra options to c2hs
19681
19682 --cpphs-options OPTS
19683 give extra options to cpphs
19684
19685 --doctest-options OPTS
19686 give extra options to doctest
19687
19688 --gcc-options OPTS
19689 give extra options to gcc
19690
19691 --ghc-options OPTS
19692 give extra options to ghc
19693
19694 --ghc-pkg-options OPTS
19695 give extra options to ghc-pkg
19696
19697 --ghcjs-options OPTS
19698 give extra options to ghcjs
19699
19700 --ghcjs-pkg-options OPTS
19701 give extra options to ghcjs-pkg
19702
19703 --greencard-options OPTS
19704 give extra options to greencard
19705
19706 --haddock-options OPTS
19707 give extra options to haddock
19708
19709 --happy-options OPTS
19710 give extra options to happy
19711
19712 --haskell-suite-options OPTS
19713 give extra options to haskell-suite
19714
19715 --haskell-suite-pkg-options OPTS
19716 give extra options to haskell-suite-pkg
19717
19718 --hmake-options OPTS
19719 give extra options to hmake
19720
19721 --hpc-options OPTS
19722 give extra options to hpc
19723
19724 --hsc2hs-options OPTS
19725 give extra options to hsc2hs
19726
19727 --hscolour-options OPTS
19728 give extra options to hscolour
19729
19730 --jhc-options OPTS
19731 give extra options to jhc
19732
19733 --ld-options OPTS
19734 give extra options to ld
19735
19736 --pkg-config-options OPTS
19737 give extra options to pkg-config
19738
19739 --runghc-options OPTS
19740 give extra options to runghc
19741
19742 --strip-options OPTS
19743 give extra options to strip
19744
19745 --tar-options OPTS
19746 give extra options to tar
19747
19748 --uhc-options OPTS
19749 give extra options to uhc
19750
19751 --cabal-lib-version VERSION
19752 Select which version of the Cabal lib to use to build
19753 packages (useful for testing).
19754
19755 --constraint CONSTRAINT
19756 Specify constraints on a package (version,
19757 installed/source, flags)
19758
19759 --preference CONSTRAINT
19760 Specify preferences (soft constraints) on the version of
19761 a package
19762
19763 --solver SOLVER
19764 Select dependency solver to use (default: modular).
19765 Choices: modular.
19766
19767 --allow-older [DEPS]
19768 Ignore lower bounds in all dependencies or DEPS
19769
19770 --allow-newer [DEPS]
19771 Ignore upper bounds in all dependencies or DEPS
19772
19773 --write-ghc-environment-files always|never|ghc8.4.4+
19774 Whether to create a .ghc.environment file after a suc‐
19775 cessful build (v2-build only)
19776
19777 --enable-documentation
19778 --disable-documentation
19779 building of documentation
19780
19781 --doc-index-file TEMPLATE
19782 A central index of haddock API documentation (template
19783 cannot use $pkgid)
19784
19785 --dry-run
19786 Do not install anything, only print what would be
19787 installed.
19788
19789 --max-backjumps NUM
19790 Maximum number of backjumps allowed while solving
19791 (default: 2000). Use a negative number to enable unlim‐
19792 ited backtracking. Use 0 to disable backtracking com‐
19793 pletely.
19794
19795 --reorder-goals
19796 --no-reorder-goals
19797 Try to reorder goals according to certain heuristics.
19798 Slows things down on average, but may make backtracking
19799 faster for some packages.
19800
19801 --count-conflicts
19802 --no-count-conflicts
19803 Try to speed up solving by preferring goals that are
19804 involved in a lot of conflicts (default).
19805
19806 --independent-goals
19807 --no-independent-goals
19808 Treat several goals on the command line as independent.
19809 If several goals depend on the same package, different
19810 versions can be chosen.
19811
19812 --shadow-installed-packages
19813 --no-shadow-installed-packages
19814 If multiple package instances of the same version are
19815 installed, treat all but one as shadowed.
19816
19817 --strong-flags
19818 --no-strong-flags
19819 Do not defer flag choices (this used to be the default in
19820 cabal-install <= 1.20).
19821
19822 --allow-boot-library-installs
19823 --no-allow-boot-library-installs
19824 Allow cabal to install base, ghc-prim, integer-simple,
19825 integer-gmp, and template-haskell.
19826
19827 --reinstall
19828 --no-reinstall
19829 Install even if it means installing the same version
19830 again.
19831
19832 --avoid-reinstalls
19833 --no-avoid-reinstalls
19834 Do not select versions that would destructively overwrite
19835 installed packages.
19836
19837 --force-reinstalls
19838 --no-force-reinstalls
19839 Reinstall packages even if they will most likely break
19840 other installed packages.
19841
19842 --upgrade-dependencies
19843 --no-upgrade-dependencies
19844 Pick the latest version for all dependencies, rather than
19845 trying to pick an installed version.
19846
19847 --only-dependencies
19848 --no-only-dependencies
19849 Install only the dependencies necessary to build the
19850 given packages
19851
19852 --dependencies-only
19853 --no-dependencies-only
19854 A synonym for --only-dependencies
19855
19856 --index-state STATE
19857 Use source package index state as it existed at a previ‐
19858 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
19859 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
19860 'HEAD' (default: 'HEAD').
19861
19862 --root-cmd COMMAND
19863 (No longer supported, do not use.)
19864
19865 --symlink-bindir DIR
19866 Add symlinks to installed executables into this direc‐
19867 tory.
19868
19869 --build-summary TEMPLATE
19870 Save build summaries to file (name template can use
19871 $pkgid, $compiler, $os, $arch)
19872
19873 --build-log TEMPLATE
19874 Log all builds to file (name template can use $pkgid,
19875 $compiler, $os, $arch)
19876
19877 --remote-build-reporting LEVEL
19878 Generate build reports to send to a remote server (none,
19879 anonymous or detailed).
19880
19881 --report-planning-failure
19882 Generate build reports when the dependency solver fails.
19883 This is used by the Hackage build bot.
19884
19885 --enable-per-component
19886 --disable-per-component
19887 Per-component builds when possible
19888
19889 --one-shot
19890 --no-one-shot
19891 Do not record the packages in the world file.
19892
19893 --run-tests
19894 Run package test suites during installation.
19895
19896 -j, --jobs [NUM]
19897 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
19898 given).
19899
19900 --keep-going
19901 After a build failure, continue to build other unaffected
19902 packages.
19903
19904 --offline
19905 --no-offline
19906 Don't download packages from the Internet.
19907
19908 --project-file FILE
19909 Set the name of the cabal.project file to search for in
19910 parent directories
19911
19912 --only
19913 Only installs the package in the current directory.
19914
19915 --haddock-hoogle
19916 Generate a hoogle database
19917
19918 --haddock-html
19919 Generate HTML documentation (the default)
19920
19921 --haddock-html-location URL
19922 Location of HTML documentation for pre-requisite packages
19923
19924 --haddock-for-hackage
19925 Collection of flags to generate documentation suitable
19926 for upload to hackage
19927
19928 --haddock-executables
19929 Run haddock for Executables targets
19930
19931 --haddock-tests
19932 Run haddock for Test Suite targets
19933
19934 --haddock-benchmarks
19935 Run haddock for Benchmark targets
19936
19937 --haddock-all
19938 Run haddock for all targets
19939
19940 --haddock-internal
19941 Run haddock for internal modules and include all symbols
19942
19943 --haddock-css PATH
19944 Use PATH as the haddock stylesheet
19945
19946 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
19947 dock-hyperlinked-source
19948 Hyperlink the documentation to the source code
19949
19950 --haddock-quickjump
19951 Generate an index for interactive documentation naviga‐
19952 tion
19953
19954 --haddock-hscolour-css PATH
19955 Use PATH as the HsColour stylesheet
19956
19957 --haddock-contents-location URL
19958 Bake URL in as the location for the contents page
19959
19960
19961 cabal v1-install
19962
19963 Usage: cabal v1-install [FLAGS]
19964 or: cabal v1-install [FLAGS] PACKAGES
19965
19966
19967 Installs one or more packages. By default, the installed package will
19968 be registered in the user's package database or, if a sandbox is
19969 present in the current directory, inside the sandbox.
19970
19971 If PACKAGES are specified, downloads and installs those packages. Oth‐
19972 erwise, install the package in the current directory (and/or its depen‐
19973 dencies) (there must be exactly one .cabal file in the current direc‐
19974 tory).
19975
19976 When using a sandbox, the flags for `v1-install` only affect the cur‐
19977 rent command and have no effect on future commands. (To achieve that,
19978 `v1-configure` must be used.) In contrast, without a sandbox, the
19979 flags to `v1-install` are saved and affect future commands such as
19980 `v1-build` and `v1-repl`. See the help for `v1-configure` for a list of
19981 commands being affected.
19982
19983 Installed executables will by default (and without a sandbox) be put
19984 into `~/.cabal/bin/`. If you want installed executable to be available
19985 globally, make sure that the PATH environment variable contains that
19986 directory. When using a sandbox, executables will be put into `$SAND‐
19987 BOX/bin/` (by default: `./.cabal-sandbox/bin/`).
19988
19989 When specifying --bindir, consider also specifying --datadir; this way
19990 the sandbox can be deleted and the executable should continue working
19991 as long as bindir and datadir are left untouched.
19992
19993
19994 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
19995 ing programs:
19996 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
19997 haddock
19998 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
19999 ld
20000 pkg-config runghc strip tar uhc
20001
20002 Examples:
20003 cabal v1-install Package in the current directory
20004 cabal v1-install foo Package from the hackage server
20005 cabal v1-install foo-1.0 Specific version of a package
20006 cabal v1-install 'foo < 2' Constrained package version
20007 cabal v1-install haddock --bindir=$HOME/hask-bin/
20008 --datadir=$HOME/hask-data/
20009 Change installation destination
20010
20011 The v1-install command is a part of the legacy v1 style of cabal usage.
20012
20013 It is a legacy feature and will be removed in a future release of
20014 cabal-install. Please file a bug if you cannot replicate a working v1-
20015 use case with the new-style commands.
20016
20017 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
20018
20019
20020 Flags:
20021 -v, --verbose [n]
20022 Control verbosity (n is 0--3, default verbosity level is
20023 1)
20024
20025 --builddir, --distdir, --distpref DIR
20026 The directory where Cabal puts generated build files
20027 (default dist)
20028
20029 -g, --ghc
20030 compile with GHC
20031
20032 --ghcjs
20033 compile with GHCJS
20034
20035 --uhc
20036 compile with UHC
20037
20038 --haskell-suite
20039 compile with a haskell-suite compiler
20040
20041 --cabal-file PATH
20042 use this Cabal file
20043
20044 -w, --with-compiler PATH
20045 give the path to a particular compiler
20046
20047 --with-hc-pkg PATH
20048 give the path to the package tool
20049
20050 --prefix DIR
20051 bake this prefix in preparation of installation
20052
20053 --bindir DIR
20054 installation directory for executables
20055
20056 --libdir DIR
20057 installation directory for libraries
20058
20059 --libsubdir DIR
20060 subdirectory of libdir in which libs are installed
20061
20062 --dynlibdir DIR
20063 installation directory for dynamic libraries
20064
20065 --libexecdir DIR
20066 installation directory for program executables
20067
20068 --libexecsubdir DIR
20069 subdirectory of libexecdir in which private executables
20070 are installed
20071
20072 --datadir DIR
20073 installation directory for read-only data
20074
20075 --datasubdir DIR
20076 subdirectory of datadir in which data files are installed
20077
20078 --docdir DIR
20079 installation directory for documentation
20080
20081 --htmldir DIR
20082 installation directory for HTML documentation
20083
20084 --haddockdir DIR
20085 installation directory for haddock interfaces
20086
20087 --sysconfdir DIR
20088 installation directory for configuration files
20089
20090 --program-prefix PREFIX
20091 prefix to be applied to installed executables
20092
20093 --program-suffix SUFFIX
20094 suffix to be applied to installed executables
20095
20096 --enable-library-vanilla
20097 --disable-library-vanilla
20098 Vanilla libraries
20099
20100 -p, --enable-library-profiling
20101 --disable-library-profiling
20102 Library profiling
20103
20104 --enable-shared
20105 --disable-shared
20106 Shared library
20107
20108 --enable-static
20109 --disable-static
20110 Static library
20111
20112 --enable-executable-dynamic
20113 --disable-executable-dynamic
20114 Executable dynamic linking
20115
20116 --enable-profiling
20117 --disable-profiling
20118 Executable and library profiling
20119
20120 --enable-executable-profiling
20121 --disable-executable-profiling
20122 Executable profiling (DEPRECATED)
20123
20124 --profiling-detail level
20125 Profiling detail level for executable and library
20126 (default, none, exported-functions, toplevel-functions,
20127 all-functions).
20128
20129 --library-profiling-detail level
20130 Profiling detail level for libraries only.
20131
20132 -O, --enable-optimization, --enable-optimisation [n]
20133 Build with optimization (n is 0--2, default is 1)
20134
20135 --disable-optimization, --disable-optimisation
20136 Build without optimization
20137
20138 --enable-debug-info [n]
20139 Emit debug info (n is 0--3, default is 0)
20140
20141 --disable-debug-info
20142 Don't emit debug info
20143
20144 --enable-library-for-ghci
20145 --disable-library-for-ghci
20146 compile library for use with GHCi
20147
20148 --enable-split-sections
20149 --disable-split-sections
20150 compile library code such that unneeded definitions can
20151 be dropped from the final executable (GHC 7.8+)
20152
20153 --enable-split-objs
20154 --disable-split-objs
20155 split library into smaller objects to reduce binary sizes
20156 (GHC 6.6+)
20157
20158 --enable-executable-stripping
20159 --disable-executable-stripping
20160 strip executables upon installation to reduce binary
20161 sizes
20162
20163 --enable-library-stripping
20164 --disable-library-stripping
20165 strip libraries upon installation to reduce binary sizes
20166
20167 --configure-option OPT
20168 Extra option for configure
20169
20170 --user
20171 --global
20172 doing a per-user installation
20173
20174 --package-db DB
20175 Append the given package database to the list of package
20176 databases used (to satisfy dependencies and register
20177 into). May be a specific file, 'global' or 'user'. The
20178 initial list is ['global'], ['global', 'user'], or
20179 ['global', $sandbox], depending on context. Use 'clear'
20180 to reset the list to empty. See the user guide for
20181 details.
20182
20183 -f, --flags FLAGS
20184 Force values for the given flags in Cabal conditionals in
20185 the .cabal file. E.g., --flags="debug -usebytestrings"
20186 forces the flag "debug" to true and "usebytestrings" to
20187 false.
20188
20189 --extra-include-dirs PATH
20190 A list of directories to search for header files
20191
20192 --enable-deterministic
20193 --disable-deterministic
20194 Try to be as deterministic as possible (used by the test
20195 suite)
20196
20197 --ipid IPID
20198 Installed package ID to compile this package as
20199
20200 --cid CID
20201 Installed component ID to compile this component as
20202
20203 --extra-lib-dirs PATH
20204 A list of directories to search for external libraries
20205
20206 --extra-framework-dirs PATH
20207 A list of directories to search for external frameworks
20208 (OS X only)
20209
20210 --extra-prog-path PATH
20211 A list of directories to search for required programs (in
20212 addition to the normal search locations)
20213
20214 --instantiate-with NAME=MOD
20215 A mapping of signature names to concrete module instanti‐
20216 ations.
20217
20218 --enable-tests
20219 --disable-tests
20220 dependency checking and compilation for test suites
20221 listed in the package description file.
20222
20223 --enable-coverage
20224 --disable-coverage
20225 build package with Haskell Program Coverage. (GHC only)
20226
20227 --enable-library-coverage
20228 --disable-library-coverage
20229 build package with Haskell Program Coverage. (GHC only)
20230 (DEPRECATED)
20231
20232 --enable-benchmarks
20233 --disable-benchmarks
20234 dependency checking and compilation for benchmarks listed
20235 in the package description file.
20236
20237 --enable-relocatable
20238 --disable-relocatable
20239 building a package that is relocatable. (GHC only)
20240
20241 --disable-response-files
20242 enable workaround for old versions of programs like "ar"
20243 that do not support @file arguments
20244
20245 --with-alex PATH
20246 give the path to alex
20247
20248 --with-ar PATH
20249 give the path to ar
20250
20251 --with-c2hs PATH
20252 give the path to c2hs
20253
20254 --with-cpphs PATH
20255 give the path to cpphs
20256
20257 --with-doctest PATH
20258 give the path to doctest
20259
20260 --with-gcc PATH
20261 give the path to gcc
20262
20263 --with-ghc PATH
20264 give the path to ghc
20265
20266 --with-ghc-pkg PATH
20267 give the path to ghc-pkg
20268
20269 --with-ghcjs PATH
20270 give the path to ghcjs
20271
20272 --with-ghcjs-pkg PATH
20273 give the path to ghcjs-pkg
20274
20275 --with-greencard PATH
20276 give the path to greencard
20277
20278 --with-haddock PATH
20279 give the path to haddock
20280
20281 --with-happy PATH
20282 give the path to happy
20283
20284 --with-haskell-suite PATH
20285 give the path to haskell-suite
20286
20287 --with-haskell-suite-pkg PATH
20288 give the path to haskell-suite-pkg
20289
20290 --with-hmake PATH
20291 give the path to hmake
20292
20293 --with-hpc PATH
20294 give the path to hpc
20295
20296 --with-hsc2hs PATH
20297 give the path to hsc2hs
20298
20299 --with-hscolour PATH
20300 give the path to hscolour
20301
20302 --with-jhc PATH
20303 give the path to jhc
20304
20305 --with-ld PATH
20306 give the path to ld
20307
20308 --with-pkg-config PATH
20309 give the path to pkg-config
20310
20311 --with-runghc PATH
20312 give the path to runghc
20313
20314 --with-strip PATH
20315 give the path to strip
20316
20317 --with-tar PATH
20318 give the path to tar
20319
20320 --with-uhc PATH
20321 give the path to uhc
20322
20323 --alex-option OPT
20324 give an extra option to alex (no need to quote options
20325 containing spaces)
20326
20327 --ar-option OPT
20328 give an extra option to ar (no need to quote options con‐
20329 taining spaces)
20330
20331 --c2hs-option OPT
20332 give an extra option to c2hs (no need to quote options
20333 containing spaces)
20334
20335 --cpphs-option OPT
20336 give an extra option to cpphs (no need to quote options
20337 containing spaces)
20338
20339 --doctest-option OPT
20340 give an extra option to doctest (no need to quote options
20341 containing spaces)
20342
20343 --gcc-option OPT
20344 give an extra option to gcc (no need to quote options
20345 containing spaces)
20346
20347 --ghc-option OPT
20348 give an extra option to ghc (no need to quote options
20349 containing spaces)
20350
20351 --ghc-pkg-option OPT
20352 give an extra option to ghc-pkg (no need to quote options
20353 containing spaces)
20354
20355 --ghcjs-option OPT
20356 give an extra option to ghcjs (no need to quote options
20357 containing spaces)
20358
20359 --ghcjs-pkg-option OPT
20360 give an extra option to ghcjs-pkg (no need to quote
20361 options containing spaces)
20362
20363 --greencard-option OPT
20364 give an extra option to greencard (no need to quote
20365 options containing spaces)
20366
20367 --haddock-option OPT
20368 give an extra option to haddock (no need to quote options
20369 containing spaces)
20370
20371 --happy-option OPT
20372 give an extra option to happy (no need to quote options
20373 containing spaces)
20374
20375 --haskell-suite-option OPT
20376 give an extra option to haskell-suite (no need to quote
20377 options containing spaces)
20378
20379 --haskell-suite-pkg-option OPT
20380 give an extra option to haskell-suite-pkg (no need to
20381 quote options containing spaces)
20382
20383 --hmake-option OPT
20384 give an extra option to hmake (no need to quote options
20385 containing spaces)
20386
20387 --hpc-option OPT
20388 give an extra option to hpc (no need to quote options
20389 containing spaces)
20390
20391 --hsc2hs-option OPT
20392 give an extra option to hsc2hs (no need to quote options
20393 containing spaces)
20394
20395 --hscolour-option OPT
20396 give an extra option to hscolour (no need to quote
20397 options containing spaces)
20398
20399 --jhc-option OPT
20400 give an extra option to jhc (no need to quote options
20401 containing spaces)
20402
20403 --ld-option OPT
20404 give an extra option to ld (no need to quote options con‐
20405 taining spaces)
20406
20407 --pkg-config-option OPT
20408 give an extra option to pkg-config (no need to quote
20409 options containing spaces)
20410
20411 --runghc-option OPT
20412 give an extra option to runghc (no need to quote options
20413 containing spaces)
20414
20415 --strip-option OPT
20416 give an extra option to strip (no need to quote options
20417 containing spaces)
20418
20419 --tar-option OPT
20420 give an extra option to tar (no need to quote options
20421 containing spaces)
20422
20423 --uhc-option OPT
20424 give an extra option to uhc (no need to quote options
20425 containing spaces)
20426
20427 --alex-options OPTS
20428 give extra options to alex
20429
20430 --ar-options OPTS
20431 give extra options to ar
20432
20433 --c2hs-options OPTS
20434 give extra options to c2hs
20435
20436 --cpphs-options OPTS
20437 give extra options to cpphs
20438
20439 --doctest-options OPTS
20440 give extra options to doctest
20441
20442 --gcc-options OPTS
20443 give extra options to gcc
20444
20445 --ghc-options OPTS
20446 give extra options to ghc
20447
20448 --ghc-pkg-options OPTS
20449 give extra options to ghc-pkg
20450
20451 --ghcjs-options OPTS
20452 give extra options to ghcjs
20453
20454 --ghcjs-pkg-options OPTS
20455 give extra options to ghcjs-pkg
20456
20457 --greencard-options OPTS
20458 give extra options to greencard
20459
20460 --haddock-options OPTS
20461 give extra options to haddock
20462
20463 --happy-options OPTS
20464 give extra options to happy
20465
20466 --haskell-suite-options OPTS
20467 give extra options to haskell-suite
20468
20469 --haskell-suite-pkg-options OPTS
20470 give extra options to haskell-suite-pkg
20471
20472 --hmake-options OPTS
20473 give extra options to hmake
20474
20475 --hpc-options OPTS
20476 give extra options to hpc
20477
20478 --hsc2hs-options OPTS
20479 give extra options to hsc2hs
20480
20481 --hscolour-options OPTS
20482 give extra options to hscolour
20483
20484 --jhc-options OPTS
20485 give extra options to jhc
20486
20487 --ld-options OPTS
20488 give extra options to ld
20489
20490 --pkg-config-options OPTS
20491 give extra options to pkg-config
20492
20493 --runghc-options OPTS
20494 give extra options to runghc
20495
20496 --strip-options OPTS
20497 give extra options to strip
20498
20499 --tar-options OPTS
20500 give extra options to tar
20501
20502 --uhc-options OPTS
20503 give extra options to uhc
20504
20505 --cabal-lib-version VERSION
20506 Select which version of the Cabal lib to use to build
20507 packages (useful for testing).
20508
20509 --constraint CONSTRAINT
20510 Specify constraints on a package (version,
20511 installed/source, flags)
20512
20513 --preference CONSTRAINT
20514 Specify preferences (soft constraints) on the version of
20515 a package
20516
20517 --solver SOLVER
20518 Select dependency solver to use (default: modular).
20519 Choices: modular.
20520
20521 --allow-older [DEPS]
20522 Ignore lower bounds in all dependencies or DEPS
20523
20524 --allow-newer [DEPS]
20525 Ignore upper bounds in all dependencies or DEPS
20526
20527 --write-ghc-environment-files always|never|ghc8.4.4+
20528 Whether to create a .ghc.environment file after a suc‐
20529 cessful build (v2-build only)
20530
20531 --enable-documentation
20532 --disable-documentation
20533 building of documentation
20534
20535 --doc-index-file TEMPLATE
20536 A central index of haddock API documentation (template
20537 cannot use $pkgid)
20538
20539 --dry-run
20540 Do not install anything, only print what would be
20541 installed.
20542
20543 --max-backjumps NUM
20544 Maximum number of backjumps allowed while solving
20545 (default: 2000). Use a negative number to enable unlim‐
20546 ited backtracking. Use 0 to disable backtracking com‐
20547 pletely.
20548
20549 --reorder-goals
20550 --no-reorder-goals
20551 Try to reorder goals according to certain heuristics.
20552 Slows things down on average, but may make backtracking
20553 faster for some packages.
20554
20555 --count-conflicts
20556 --no-count-conflicts
20557 Try to speed up solving by preferring goals that are
20558 involved in a lot of conflicts (default).
20559
20560 --independent-goals
20561 --no-independent-goals
20562 Treat several goals on the command line as independent.
20563 If several goals depend on the same package, different
20564 versions can be chosen.
20565
20566 --shadow-installed-packages
20567 --no-shadow-installed-packages
20568 If multiple package instances of the same version are
20569 installed, treat all but one as shadowed.
20570
20571 --strong-flags
20572 --no-strong-flags
20573 Do not defer flag choices (this used to be the default in
20574 cabal-install <= 1.20).
20575
20576 --allow-boot-library-installs
20577 --no-allow-boot-library-installs
20578 Allow cabal to install base, ghc-prim, integer-simple,
20579 integer-gmp, and template-haskell.
20580
20581 --reinstall
20582 --no-reinstall
20583 Install even if it means installing the same version
20584 again.
20585
20586 --avoid-reinstalls
20587 --no-avoid-reinstalls
20588 Do not select versions that would destructively overwrite
20589 installed packages.
20590
20591 --force-reinstalls
20592 --no-force-reinstalls
20593 Reinstall packages even if they will most likely break
20594 other installed packages.
20595
20596 --upgrade-dependencies
20597 --no-upgrade-dependencies
20598 Pick the latest version for all dependencies, rather than
20599 trying to pick an installed version.
20600
20601 --only-dependencies
20602 --no-only-dependencies
20603 Install only the dependencies necessary to build the
20604 given packages
20605
20606 --dependencies-only
20607 --no-dependencies-only
20608 A synonym for --only-dependencies
20609
20610 --index-state STATE
20611 Use source package index state as it existed at a previ‐
20612 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
20613 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
20614 'HEAD' (default: 'HEAD').
20615
20616 --root-cmd COMMAND
20617 (No longer supported, do not use.)
20618
20619 --symlink-bindir DIR
20620 Add symlinks to installed executables into this direc‐
20621 tory.
20622
20623 --build-summary TEMPLATE
20624 Save build summaries to file (name template can use
20625 $pkgid, $compiler, $os, $arch)
20626
20627 --build-log TEMPLATE
20628 Log all builds to file (name template can use $pkgid,
20629 $compiler, $os, $arch)
20630
20631 --remote-build-reporting LEVEL
20632 Generate build reports to send to a remote server (none,
20633 anonymous or detailed).
20634
20635 --report-planning-failure
20636 Generate build reports when the dependency solver fails.
20637 This is used by the Hackage build bot.
20638
20639 --enable-per-component
20640 --disable-per-component
20641 Per-component builds when possible
20642
20643 --one-shot
20644 --no-one-shot
20645 Do not record the packages in the world file.
20646
20647 --run-tests
20648 Run package test suites during installation.
20649
20650 -j, --jobs [NUM]
20651 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
20652 given).
20653
20654 --keep-going
20655 After a build failure, continue to build other unaffected
20656 packages.
20657
20658 --offline
20659 --no-offline
20660 Don't download packages from the Internet.
20661
20662 --project-file FILE
20663 Set the name of the cabal.project file to search for in
20664 parent directories
20665
20666 --only
20667 Only installs the package in the current directory.
20668
20669 --haddock-hoogle
20670 Generate a hoogle database
20671
20672 --haddock-html
20673 Generate HTML documentation (the default)
20674
20675 --haddock-html-location URL
20676 Location of HTML documentation for pre-requisite packages
20677
20678 --haddock-for-hackage
20679 Collection of flags to generate documentation suitable
20680 for upload to hackage
20681
20682 --haddock-executables
20683 Run haddock for Executables targets
20684
20685 --haddock-tests
20686 Run haddock for Test Suite targets
20687
20688 --haddock-benchmarks
20689 Run haddock for Benchmark targets
20690
20691 --haddock-all
20692 Run haddock for all targets
20693
20694 --haddock-internal
20695 Run haddock for internal modules and include all symbols
20696
20697 --haddock-css PATH
20698 Use PATH as the haddock stylesheet
20699
20700 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
20701 dock-hyperlinked-source
20702 Hyperlink the documentation to the source code
20703
20704 --haddock-quickjump
20705 Generate an index for interactive documentation naviga‐
20706 tion
20707
20708 --haddock-hscolour-css PATH
20709 Use PATH as the HsColour stylesheet
20710
20711 --haddock-contents-location URL
20712 Bake URL in as the location for the contents page
20713
20714
20715 cabal run
20716
20717 Usage: cabal run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]
20718
20719
20720 Builds and then runs the specified executable. If no executable is
20721 specified, but the package contains just one executable, that one is
20722 built and executed.
20723
20724 Use `cabal test --show-details=streaming` to run a test-suite and get
20725 its full output.
20726
20727
20728 Examples:
20729 cabal run
20730 Run the only executable in the current package;
20731 cabal run foo -- --fooflag
20732 Works similar to `./foo --fooflag`.
20733
20734 The run command is a part of the legacy v1 style of cabal usage.
20735
20736 Please switch to using either the new project style and the new-run
20737 command or the legacy v1-run alias as new-style projects will become
20738 the default in the next version of cabal-install. Please file a bug if
20739 you cannot replicate a working v1- use case with the new-style com‐
20740 mands.
20741
20742 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
20743
20744
20745 Flags:
20746 -v, --verbose [n]
20747 Control verbosity (n is 0--3, default verbosity level is
20748 1)
20749
20750 --builddir, --distdir, --distpref DIR
20751 The directory where Cabal puts generated build files
20752 (default dist)
20753
20754 -j, --jobs [NUM]
20755 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
20756 given).
20757
20758 --with-alex PATH
20759 give the path to alex
20760
20761 --with-ar PATH
20762 give the path to ar
20763
20764 --with-c2hs PATH
20765 give the path to c2hs
20766
20767 --with-cpphs PATH
20768 give the path to cpphs
20769
20770 --with-doctest PATH
20771 give the path to doctest
20772
20773 --with-gcc PATH
20774 give the path to gcc
20775
20776 --with-ghc PATH
20777 give the path to ghc
20778
20779 --with-ghc-pkg PATH
20780 give the path to ghc-pkg
20781
20782 --with-ghcjs PATH
20783 give the path to ghcjs
20784
20785 --with-ghcjs-pkg PATH
20786 give the path to ghcjs-pkg
20787
20788 --with-greencard PATH
20789 give the path to greencard
20790
20791 --with-haddock PATH
20792 give the path to haddock
20793
20794 --with-happy PATH
20795 give the path to happy
20796
20797 --with-haskell-suite PATH
20798 give the path to haskell-suite
20799
20800 --with-haskell-suite-pkg PATH
20801 give the path to haskell-suite-pkg
20802
20803 --with-hmake PATH
20804 give the path to hmake
20805
20806 --with-hpc PATH
20807 give the path to hpc
20808
20809 --with-hsc2hs PATH
20810 give the path to hsc2hs
20811
20812 --with-hscolour PATH
20813 give the path to hscolour
20814
20815 --with-jhc PATH
20816 give the path to jhc
20817
20818 --with-ld PATH
20819 give the path to ld
20820
20821 --with-pkg-config PATH
20822 give the path to pkg-config
20823
20824 --with-runghc PATH
20825 give the path to runghc
20826
20827 --with-strip PATH
20828 give the path to strip
20829
20830 --with-tar PATH
20831 give the path to tar
20832
20833 --with-uhc PATH
20834 give the path to uhc
20835
20836 --alex-option OPT
20837 give an extra option to alex (no need to quote options
20838 containing spaces)
20839
20840 --ar-option OPT
20841 give an extra option to ar (no need to quote options con‐
20842 taining spaces)
20843
20844 --c2hs-option OPT
20845 give an extra option to c2hs (no need to quote options
20846 containing spaces)
20847
20848 --cpphs-option OPT
20849 give an extra option to cpphs (no need to quote options
20850 containing spaces)
20851
20852 --doctest-option OPT
20853 give an extra option to doctest (no need to quote options
20854 containing spaces)
20855
20856 --gcc-option OPT
20857 give an extra option to gcc (no need to quote options
20858 containing spaces)
20859
20860 --ghc-option OPT
20861 give an extra option to ghc (no need to quote options
20862 containing spaces)
20863
20864 --ghc-pkg-option OPT
20865 give an extra option to ghc-pkg (no need to quote options
20866 containing spaces)
20867
20868 --ghcjs-option OPT
20869 give an extra option to ghcjs (no need to quote options
20870 containing spaces)
20871
20872 --ghcjs-pkg-option OPT
20873 give an extra option to ghcjs-pkg (no need to quote
20874 options containing spaces)
20875
20876 --greencard-option OPT
20877 give an extra option to greencard (no need to quote
20878 options containing spaces)
20879
20880 --haddock-option OPT
20881 give an extra option to haddock (no need to quote options
20882 containing spaces)
20883
20884 --happy-option OPT
20885 give an extra option to happy (no need to quote options
20886 containing spaces)
20887
20888 --haskell-suite-option OPT
20889 give an extra option to haskell-suite (no need to quote
20890 options containing spaces)
20891
20892 --haskell-suite-pkg-option OPT
20893 give an extra option to haskell-suite-pkg (no need to
20894 quote options containing spaces)
20895
20896 --hmake-option OPT
20897 give an extra option to hmake (no need to quote options
20898 containing spaces)
20899
20900 --hpc-option OPT
20901 give an extra option to hpc (no need to quote options
20902 containing spaces)
20903
20904 --hsc2hs-option OPT
20905 give an extra option to hsc2hs (no need to quote options
20906 containing spaces)
20907
20908 --hscolour-option OPT
20909 give an extra option to hscolour (no need to quote
20910 options containing spaces)
20911
20912 --jhc-option OPT
20913 give an extra option to jhc (no need to quote options
20914 containing spaces)
20915
20916 --ld-option OPT
20917 give an extra option to ld (no need to quote options con‐
20918 taining spaces)
20919
20920 --pkg-config-option OPT
20921 give an extra option to pkg-config (no need to quote
20922 options containing spaces)
20923
20924 --runghc-option OPT
20925 give an extra option to runghc (no need to quote options
20926 containing spaces)
20927
20928 --strip-option OPT
20929 give an extra option to strip (no need to quote options
20930 containing spaces)
20931
20932 --tar-option OPT
20933 give an extra option to tar (no need to quote options
20934 containing spaces)
20935
20936 --uhc-option OPT
20937 give an extra option to uhc (no need to quote options
20938 containing spaces)
20939
20940 --alex-options OPTS
20941 give extra options to alex
20942
20943 --ar-options OPTS
20944 give extra options to ar
20945
20946 --c2hs-options OPTS
20947 give extra options to c2hs
20948
20949 --cpphs-options OPTS
20950 give extra options to cpphs
20951
20952 --doctest-options OPTS
20953 give extra options to doctest
20954
20955 --gcc-options OPTS
20956 give extra options to gcc
20957
20958 --ghc-options OPTS
20959 give extra options to ghc
20960
20961 --ghc-pkg-options OPTS
20962 give extra options to ghc-pkg
20963
20964 --ghcjs-options OPTS
20965 give extra options to ghcjs
20966
20967 --ghcjs-pkg-options OPTS
20968 give extra options to ghcjs-pkg
20969
20970 --greencard-options OPTS
20971 give extra options to greencard
20972
20973 --haddock-options OPTS
20974 give extra options to haddock
20975
20976 --happy-options OPTS
20977 give extra options to happy
20978
20979 --haskell-suite-options OPTS
20980 give extra options to haskell-suite
20981
20982 --haskell-suite-pkg-options OPTS
20983 give extra options to haskell-suite-pkg
20984
20985 --hmake-options OPTS
20986 give extra options to hmake
20987
20988 --hpc-options OPTS
20989 give extra options to hpc
20990
20991 --hsc2hs-options OPTS
20992 give extra options to hsc2hs
20993
20994 --hscolour-options OPTS
20995 give extra options to hscolour
20996
20997 --jhc-options OPTS
20998 give extra options to jhc
20999
21000 --ld-options OPTS
21001 give extra options to ld
21002
21003 --pkg-config-options OPTS
21004 give extra options to pkg-config
21005
21006 --runghc-options OPTS
21007 give extra options to runghc
21008
21009 --strip-options OPTS
21010 give extra options to strip
21011
21012 --tar-options OPTS
21013 give extra options to tar
21014
21015 --uhc-options OPTS
21016 give extra options to uhc
21017
21018 --only
21019 Don't reinstall add-source dependencies (sandbox-only)
21020
21021
21022 cabal v1-run
21023
21024 Usage: cabal v1-run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]
21025
21026
21027 Builds and then runs the specified executable. If no executable is
21028 specified, but the package contains just one executable, that one is
21029 built and executed.
21030
21031 Use `cabal v1-test --show-details=streaming` to run a test-suite and
21032 get its full output.
21033
21034
21035 Examples:
21036 cabal v1-run
21037 Run the only executable in the current package;
21038 cabal v1-run foo -- --fooflag
21039 Works similar to `./foo --fooflag`.
21040
21041 The v1-run command is a part of the legacy v1 style of cabal usage.
21042
21043 It is a legacy feature and will be removed in a future release of
21044 cabal-install. Please file a bug if you cannot replicate a working v1-
21045 use case with the new-style commands.
21046
21047 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
21048
21049
21050 Flags:
21051 -v, --verbose [n]
21052 Control verbosity (n is 0--3, default verbosity level is
21053 1)
21054
21055 --builddir, --distdir, --distpref DIR
21056 The directory where Cabal puts generated build files
21057 (default dist)
21058
21059 -j, --jobs [NUM]
21060 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
21061 given).
21062
21063 --with-alex PATH
21064 give the path to alex
21065
21066 --with-ar PATH
21067 give the path to ar
21068
21069 --with-c2hs PATH
21070 give the path to c2hs
21071
21072 --with-cpphs PATH
21073 give the path to cpphs
21074
21075 --with-doctest PATH
21076 give the path to doctest
21077
21078 --with-gcc PATH
21079 give the path to gcc
21080
21081 --with-ghc PATH
21082 give the path to ghc
21083
21084 --with-ghc-pkg PATH
21085 give the path to ghc-pkg
21086
21087 --with-ghcjs PATH
21088 give the path to ghcjs
21089
21090 --with-ghcjs-pkg PATH
21091 give the path to ghcjs-pkg
21092
21093 --with-greencard PATH
21094 give the path to greencard
21095
21096 --with-haddock PATH
21097 give the path to haddock
21098
21099 --with-happy PATH
21100 give the path to happy
21101
21102 --with-haskell-suite PATH
21103 give the path to haskell-suite
21104
21105 --with-haskell-suite-pkg PATH
21106 give the path to haskell-suite-pkg
21107
21108 --with-hmake PATH
21109 give the path to hmake
21110
21111 --with-hpc PATH
21112 give the path to hpc
21113
21114 --with-hsc2hs PATH
21115 give the path to hsc2hs
21116
21117 --with-hscolour PATH
21118 give the path to hscolour
21119
21120 --with-jhc PATH
21121 give the path to jhc
21122
21123 --with-ld PATH
21124 give the path to ld
21125
21126 --with-pkg-config PATH
21127 give the path to pkg-config
21128
21129 --with-runghc PATH
21130 give the path to runghc
21131
21132 --with-strip PATH
21133 give the path to strip
21134
21135 --with-tar PATH
21136 give the path to tar
21137
21138 --with-uhc PATH
21139 give the path to uhc
21140
21141 --alex-option OPT
21142 give an extra option to alex (no need to quote options
21143 containing spaces)
21144
21145 --ar-option OPT
21146 give an extra option to ar (no need to quote options con‐
21147 taining spaces)
21148
21149 --c2hs-option OPT
21150 give an extra option to c2hs (no need to quote options
21151 containing spaces)
21152
21153 --cpphs-option OPT
21154 give an extra option to cpphs (no need to quote options
21155 containing spaces)
21156
21157 --doctest-option OPT
21158 give an extra option to doctest (no need to quote options
21159 containing spaces)
21160
21161 --gcc-option OPT
21162 give an extra option to gcc (no need to quote options
21163 containing spaces)
21164
21165 --ghc-option OPT
21166 give an extra option to ghc (no need to quote options
21167 containing spaces)
21168
21169 --ghc-pkg-option OPT
21170 give an extra option to ghc-pkg (no need to quote options
21171 containing spaces)
21172
21173 --ghcjs-option OPT
21174 give an extra option to ghcjs (no need to quote options
21175 containing spaces)
21176
21177 --ghcjs-pkg-option OPT
21178 give an extra option to ghcjs-pkg (no need to quote
21179 options containing spaces)
21180
21181 --greencard-option OPT
21182 give an extra option to greencard (no need to quote
21183 options containing spaces)
21184
21185 --haddock-option OPT
21186 give an extra option to haddock (no need to quote options
21187 containing spaces)
21188
21189 --happy-option OPT
21190 give an extra option to happy (no need to quote options
21191 containing spaces)
21192
21193 --haskell-suite-option OPT
21194 give an extra option to haskell-suite (no need to quote
21195 options containing spaces)
21196
21197 --haskell-suite-pkg-option OPT
21198 give an extra option to haskell-suite-pkg (no need to
21199 quote options containing spaces)
21200
21201 --hmake-option OPT
21202 give an extra option to hmake (no need to quote options
21203 containing spaces)
21204
21205 --hpc-option OPT
21206 give an extra option to hpc (no need to quote options
21207 containing spaces)
21208
21209 --hsc2hs-option OPT
21210 give an extra option to hsc2hs (no need to quote options
21211 containing spaces)
21212
21213 --hscolour-option OPT
21214 give an extra option to hscolour (no need to quote
21215 options containing spaces)
21216
21217 --jhc-option OPT
21218 give an extra option to jhc (no need to quote options
21219 containing spaces)
21220
21221 --ld-option OPT
21222 give an extra option to ld (no need to quote options con‐
21223 taining spaces)
21224
21225 --pkg-config-option OPT
21226 give an extra option to pkg-config (no need to quote
21227 options containing spaces)
21228
21229 --runghc-option OPT
21230 give an extra option to runghc (no need to quote options
21231 containing spaces)
21232
21233 --strip-option OPT
21234 give an extra option to strip (no need to quote options
21235 containing spaces)
21236
21237 --tar-option OPT
21238 give an extra option to tar (no need to quote options
21239 containing spaces)
21240
21241 --uhc-option OPT
21242 give an extra option to uhc (no need to quote options
21243 containing spaces)
21244
21245 --alex-options OPTS
21246 give extra options to alex
21247
21248 --ar-options OPTS
21249 give extra options to ar
21250
21251 --c2hs-options OPTS
21252 give extra options to c2hs
21253
21254 --cpphs-options OPTS
21255 give extra options to cpphs
21256
21257 --doctest-options OPTS
21258 give extra options to doctest
21259
21260 --gcc-options OPTS
21261 give extra options to gcc
21262
21263 --ghc-options OPTS
21264 give extra options to ghc
21265
21266 --ghc-pkg-options OPTS
21267 give extra options to ghc-pkg
21268
21269 --ghcjs-options OPTS
21270 give extra options to ghcjs
21271
21272 --ghcjs-pkg-options OPTS
21273 give extra options to ghcjs-pkg
21274
21275 --greencard-options OPTS
21276 give extra options to greencard
21277
21278 --haddock-options OPTS
21279 give extra options to haddock
21280
21281 --happy-options OPTS
21282 give extra options to happy
21283
21284 --haskell-suite-options OPTS
21285 give extra options to haskell-suite
21286
21287 --haskell-suite-pkg-options OPTS
21288 give extra options to haskell-suite-pkg
21289
21290 --hmake-options OPTS
21291 give extra options to hmake
21292
21293 --hpc-options OPTS
21294 give extra options to hpc
21295
21296 --hsc2hs-options OPTS
21297 give extra options to hsc2hs
21298
21299 --hscolour-options OPTS
21300 give extra options to hscolour
21301
21302 --jhc-options OPTS
21303 give extra options to jhc
21304
21305 --ld-options OPTS
21306 give extra options to ld
21307
21308 --pkg-config-options OPTS
21309 give extra options to pkg-config
21310
21311 --runghc-options OPTS
21312 give extra options to runghc
21313
21314 --strip-options OPTS
21315 give extra options to strip
21316
21317 --tar-options OPTS
21318 give extra options to tar
21319
21320 --uhc-options OPTS
21321 give extra options to uhc
21322
21323 --only
21324 Don't reinstall add-source dependencies (sandbox-only)
21325
21326
21327 cabal test
21328
21329 Usage: cabal test [FLAGS]
21330 or: cabal test TESTCOMPONENTS [FLAGS]
21331
21332
21333 If necessary (re)configures with `--enable-tests` flag and builds the
21334 test suite.
21335
21336 Remember that the tests' dependencies must be installed if there are
21337 additional ones; e.g. with `cabal install --only-dependencies --enable-
21338 tests`.
21339
21340 By defining UserHooks in a custom Setup.hs, the package can define
21341 actions to be executed before and after running tests.
21342
21343
21344 The test command is a part of the legacy v1 style of cabal usage.
21345
21346 Please switch to using either the new project style and the new-test
21347 command or the legacy v1-test alias as new-style projects will become
21348 the default in the next version of cabal-install. Please file a bug if
21349 you cannot replicate a working v1- use case with the new-style com‐
21350 mands.
21351
21352 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
21353
21354
21355 Flags:
21356 -v, --verbose [n]
21357 Control verbosity (n is 0--3, default verbosity level is
21358 1)
21359
21360 --builddir, --distdir, --distpref DIR
21361 The directory where Cabal puts generated build files
21362 (default dist)
21363
21364 --log TEMPLATE
21365 Log all test suite results to file (name template can use
21366 $pkgid, $compiler, $os, $arch, $test-suite, $result)
21367
21368 --machine-log TEMPLATE
21369 Produce a machine-readable log file (name template can
21370 use $pkgid, $compiler, $os, $arch, $result)
21371
21372 --show-details FILTER
21373
21374 --keep-tix-files
21375 keep .tix files for HPC between test runs
21376
21377 --test-options TEMPLATES
21378 give extra options to test executables (name templates
21379 can use $pkgid, $compiler, $os, $arch, $test-suite)
21380
21381 --test-option TEMPLATE
21382 give extra option to test executables (no need to quote
21383 options containing spaces, name template can use $pkgid,
21384 $compiler, $os, $arch, $test-suite)
21385
21386 -j, --jobs [NUM]
21387 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
21388 given).
21389
21390 --with-alex PATH
21391 give the path to alex
21392
21393 --with-ar PATH
21394 give the path to ar
21395
21396 --with-c2hs PATH
21397 give the path to c2hs
21398
21399 --with-cpphs PATH
21400 give the path to cpphs
21401
21402 --with-doctest PATH
21403 give the path to doctest
21404
21405 --with-gcc PATH
21406 give the path to gcc
21407
21408 --with-ghc PATH
21409 give the path to ghc
21410
21411 --with-ghc-pkg PATH
21412 give the path to ghc-pkg
21413
21414 --with-ghcjs PATH
21415 give the path to ghcjs
21416
21417 --with-ghcjs-pkg PATH
21418 give the path to ghcjs-pkg
21419
21420 --with-greencard PATH
21421 give the path to greencard
21422
21423 --with-haddock PATH
21424 give the path to haddock
21425
21426 --with-happy PATH
21427 give the path to happy
21428
21429 --with-haskell-suite PATH
21430 give the path to haskell-suite
21431
21432 --with-haskell-suite-pkg PATH
21433 give the path to haskell-suite-pkg
21434
21435 --with-hmake PATH
21436 give the path to hmake
21437
21438 --with-hpc PATH
21439 give the path to hpc
21440
21441 --with-hsc2hs PATH
21442 give the path to hsc2hs
21443
21444 --with-hscolour PATH
21445 give the path to hscolour
21446
21447 --with-jhc PATH
21448 give the path to jhc
21449
21450 --with-ld PATH
21451 give the path to ld
21452
21453 --with-pkg-config PATH
21454 give the path to pkg-config
21455
21456 --with-runghc PATH
21457 give the path to runghc
21458
21459 --with-strip PATH
21460 give the path to strip
21461
21462 --with-tar PATH
21463 give the path to tar
21464
21465 --with-uhc PATH
21466 give the path to uhc
21467
21468 --alex-option OPT
21469 give an extra option to alex (no need to quote options
21470 containing spaces)
21471
21472 --ar-option OPT
21473 give an extra option to ar (no need to quote options con‐
21474 taining spaces)
21475
21476 --c2hs-option OPT
21477 give an extra option to c2hs (no need to quote options
21478 containing spaces)
21479
21480 --cpphs-option OPT
21481 give an extra option to cpphs (no need to quote options
21482 containing spaces)
21483
21484 --doctest-option OPT
21485 give an extra option to doctest (no need to quote options
21486 containing spaces)
21487
21488 --gcc-option OPT
21489 give an extra option to gcc (no need to quote options
21490 containing spaces)
21491
21492 --ghc-option OPT
21493 give an extra option to ghc (no need to quote options
21494 containing spaces)
21495
21496 --ghc-pkg-option OPT
21497 give an extra option to ghc-pkg (no need to quote options
21498 containing spaces)
21499
21500 --ghcjs-option OPT
21501 give an extra option to ghcjs (no need to quote options
21502 containing spaces)
21503
21504 --ghcjs-pkg-option OPT
21505 give an extra option to ghcjs-pkg (no need to quote
21506 options containing spaces)
21507
21508 --greencard-option OPT
21509 give an extra option to greencard (no need to quote
21510 options containing spaces)
21511
21512 --haddock-option OPT
21513 give an extra option to haddock (no need to quote options
21514 containing spaces)
21515
21516 --happy-option OPT
21517 give an extra option to happy (no need to quote options
21518 containing spaces)
21519
21520 --haskell-suite-option OPT
21521 give an extra option to haskell-suite (no need to quote
21522 options containing spaces)
21523
21524 --haskell-suite-pkg-option OPT
21525 give an extra option to haskell-suite-pkg (no need to
21526 quote options containing spaces)
21527
21528 --hmake-option OPT
21529 give an extra option to hmake (no need to quote options
21530 containing spaces)
21531
21532 --hpc-option OPT
21533 give an extra option to hpc (no need to quote options
21534 containing spaces)
21535
21536 --hsc2hs-option OPT
21537 give an extra option to hsc2hs (no need to quote options
21538 containing spaces)
21539
21540 --hscolour-option OPT
21541 give an extra option to hscolour (no need to quote
21542 options containing spaces)
21543
21544 --jhc-option OPT
21545 give an extra option to jhc (no need to quote options
21546 containing spaces)
21547
21548 --ld-option OPT
21549 give an extra option to ld (no need to quote options con‐
21550 taining spaces)
21551
21552 --pkg-config-option OPT
21553 give an extra option to pkg-config (no need to quote
21554 options containing spaces)
21555
21556 --runghc-option OPT
21557 give an extra option to runghc (no need to quote options
21558 containing spaces)
21559
21560 --strip-option OPT
21561 give an extra option to strip (no need to quote options
21562 containing spaces)
21563
21564 --tar-option OPT
21565 give an extra option to tar (no need to quote options
21566 containing spaces)
21567
21568 --uhc-option OPT
21569 give an extra option to uhc (no need to quote options
21570 containing spaces)
21571
21572 --alex-options OPTS
21573 give extra options to alex
21574
21575 --ar-options OPTS
21576 give extra options to ar
21577
21578 --c2hs-options OPTS
21579 give extra options to c2hs
21580
21581 --cpphs-options OPTS
21582 give extra options to cpphs
21583
21584 --doctest-options OPTS
21585 give extra options to doctest
21586
21587 --gcc-options OPTS
21588 give extra options to gcc
21589
21590 --ghc-options OPTS
21591 give extra options to ghc
21592
21593 --ghc-pkg-options OPTS
21594 give extra options to ghc-pkg
21595
21596 --ghcjs-options OPTS
21597 give extra options to ghcjs
21598
21599 --ghcjs-pkg-options OPTS
21600 give extra options to ghcjs-pkg
21601
21602 --greencard-options OPTS
21603 give extra options to greencard
21604
21605 --haddock-options OPTS
21606 give extra options to haddock
21607
21608 --happy-options OPTS
21609 give extra options to happy
21610
21611 --haskell-suite-options OPTS
21612 give extra options to haskell-suite
21613
21614 --haskell-suite-pkg-options OPTS
21615 give extra options to haskell-suite-pkg
21616
21617 --hmake-options OPTS
21618 give extra options to hmake
21619
21620 --hpc-options OPTS
21621 give extra options to hpc
21622
21623 --hsc2hs-options OPTS
21624 give extra options to hsc2hs
21625
21626 --hscolour-options OPTS
21627 give extra options to hscolour
21628
21629 --jhc-options OPTS
21630 give extra options to jhc
21631
21632 --ld-options OPTS
21633 give extra options to ld
21634
21635 --pkg-config-options OPTS
21636 give extra options to pkg-config
21637
21638 --runghc-options OPTS
21639 give extra options to runghc
21640
21641 --strip-options OPTS
21642 give extra options to strip
21643
21644 --tar-options OPTS
21645 give extra options to tar
21646
21647 --uhc-options OPTS
21648 give extra options to uhc
21649
21650 --only
21651 Don't reinstall add-source dependencies (sandbox-only)
21652
21653
21654 cabal v1-test
21655
21656 Usage: cabal v1-test [FLAGS]
21657 or: cabal v1-test TESTCOMPONENTS [FLAGS]
21658
21659
21660 If necessary (re)configures with `--enable-tests` flag and builds the
21661 test suite.
21662
21663 Remember that the tests' dependencies must be installed if there are
21664 additional ones; e.g. with `cabal v1-install --only-dependencies
21665 --enable-tests`.
21666
21667 By defining UserHooks in a custom Setup.hs, the package can define
21668 actions to be executed before and after running tests.
21669
21670
21671 The v1-test command is a part of the legacy v1 style of cabal usage.
21672
21673 It is a legacy feature and will be removed in a future release of
21674 cabal-install. Please file a bug if you cannot replicate a working v1-
21675 use case with the new-style commands.
21676
21677 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
21678
21679
21680 Flags:
21681 -v, --verbose [n]
21682 Control verbosity (n is 0--3, default verbosity level is
21683 1)
21684
21685 --builddir, --distdir, --distpref DIR
21686 The directory where Cabal puts generated build files
21687 (default dist)
21688
21689 --log TEMPLATE
21690 Log all test suite results to file (name template can use
21691 $pkgid, $compiler, $os, $arch, $test-suite, $result)
21692
21693 --machine-log TEMPLATE
21694 Produce a machine-readable log file (name template can
21695 use $pkgid, $compiler, $os, $arch, $result)
21696
21697 --show-details FILTER
21698
21699 --keep-tix-files
21700 keep .tix files for HPC between test runs
21701
21702 --test-options TEMPLATES
21703 give extra options to test executables (name templates
21704 can use $pkgid, $compiler, $os, $arch, $test-suite)
21705
21706 --test-option TEMPLATE
21707 give extra option to test executables (no need to quote
21708 options containing spaces, name template can use $pkgid,
21709 $compiler, $os, $arch, $test-suite)
21710
21711 -j, --jobs [NUM]
21712 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
21713 given).
21714
21715 --with-alex PATH
21716 give the path to alex
21717
21718 --with-ar PATH
21719 give the path to ar
21720
21721 --with-c2hs PATH
21722 give the path to c2hs
21723
21724 --with-cpphs PATH
21725 give the path to cpphs
21726
21727 --with-doctest PATH
21728 give the path to doctest
21729
21730 --with-gcc PATH
21731 give the path to gcc
21732
21733 --with-ghc PATH
21734 give the path to ghc
21735
21736 --with-ghc-pkg PATH
21737 give the path to ghc-pkg
21738
21739 --with-ghcjs PATH
21740 give the path to ghcjs
21741
21742 --with-ghcjs-pkg PATH
21743 give the path to ghcjs-pkg
21744
21745 --with-greencard PATH
21746 give the path to greencard
21747
21748 --with-haddock PATH
21749 give the path to haddock
21750
21751 --with-happy PATH
21752 give the path to happy
21753
21754 --with-haskell-suite PATH
21755 give the path to haskell-suite
21756
21757 --with-haskell-suite-pkg PATH
21758 give the path to haskell-suite-pkg
21759
21760 --with-hmake PATH
21761 give the path to hmake
21762
21763 --with-hpc PATH
21764 give the path to hpc
21765
21766 --with-hsc2hs PATH
21767 give the path to hsc2hs
21768
21769 --with-hscolour PATH
21770 give the path to hscolour
21771
21772 --with-jhc PATH
21773 give the path to jhc
21774
21775 --with-ld PATH
21776 give the path to ld
21777
21778 --with-pkg-config PATH
21779 give the path to pkg-config
21780
21781 --with-runghc PATH
21782 give the path to runghc
21783
21784 --with-strip PATH
21785 give the path to strip
21786
21787 --with-tar PATH
21788 give the path to tar
21789
21790 --with-uhc PATH
21791 give the path to uhc
21792
21793 --alex-option OPT
21794 give an extra option to alex (no need to quote options
21795 containing spaces)
21796
21797 --ar-option OPT
21798 give an extra option to ar (no need to quote options con‐
21799 taining spaces)
21800
21801 --c2hs-option OPT
21802 give an extra option to c2hs (no need to quote options
21803 containing spaces)
21804
21805 --cpphs-option OPT
21806 give an extra option to cpphs (no need to quote options
21807 containing spaces)
21808
21809 --doctest-option OPT
21810 give an extra option to doctest (no need to quote options
21811 containing spaces)
21812
21813 --gcc-option OPT
21814 give an extra option to gcc (no need to quote options
21815 containing spaces)
21816
21817 --ghc-option OPT
21818 give an extra option to ghc (no need to quote options
21819 containing spaces)
21820
21821 --ghc-pkg-option OPT
21822 give an extra option to ghc-pkg (no need to quote options
21823 containing spaces)
21824
21825 --ghcjs-option OPT
21826 give an extra option to ghcjs (no need to quote options
21827 containing spaces)
21828
21829 --ghcjs-pkg-option OPT
21830 give an extra option to ghcjs-pkg (no need to quote
21831 options containing spaces)
21832
21833 --greencard-option OPT
21834 give an extra option to greencard (no need to quote
21835 options containing spaces)
21836
21837 --haddock-option OPT
21838 give an extra option to haddock (no need to quote options
21839 containing spaces)
21840
21841 --happy-option OPT
21842 give an extra option to happy (no need to quote options
21843 containing spaces)
21844
21845 --haskell-suite-option OPT
21846 give an extra option to haskell-suite (no need to quote
21847 options containing spaces)
21848
21849 --haskell-suite-pkg-option OPT
21850 give an extra option to haskell-suite-pkg (no need to
21851 quote options containing spaces)
21852
21853 --hmake-option OPT
21854 give an extra option to hmake (no need to quote options
21855 containing spaces)
21856
21857 --hpc-option OPT
21858 give an extra option to hpc (no need to quote options
21859 containing spaces)
21860
21861 --hsc2hs-option OPT
21862 give an extra option to hsc2hs (no need to quote options
21863 containing spaces)
21864
21865 --hscolour-option OPT
21866 give an extra option to hscolour (no need to quote
21867 options containing spaces)
21868
21869 --jhc-option OPT
21870 give an extra option to jhc (no need to quote options
21871 containing spaces)
21872
21873 --ld-option OPT
21874 give an extra option to ld (no need to quote options con‐
21875 taining spaces)
21876
21877 --pkg-config-option OPT
21878 give an extra option to pkg-config (no need to quote
21879 options containing spaces)
21880
21881 --runghc-option OPT
21882 give an extra option to runghc (no need to quote options
21883 containing spaces)
21884
21885 --strip-option OPT
21886 give an extra option to strip (no need to quote options
21887 containing spaces)
21888
21889 --tar-option OPT
21890 give an extra option to tar (no need to quote options
21891 containing spaces)
21892
21893 --uhc-option OPT
21894 give an extra option to uhc (no need to quote options
21895 containing spaces)
21896
21897 --alex-options OPTS
21898 give extra options to alex
21899
21900 --ar-options OPTS
21901 give extra options to ar
21902
21903 --c2hs-options OPTS
21904 give extra options to c2hs
21905
21906 --cpphs-options OPTS
21907 give extra options to cpphs
21908
21909 --doctest-options OPTS
21910 give extra options to doctest
21911
21912 --gcc-options OPTS
21913 give extra options to gcc
21914
21915 --ghc-options OPTS
21916 give extra options to ghc
21917
21918 --ghc-pkg-options OPTS
21919 give extra options to ghc-pkg
21920
21921 --ghcjs-options OPTS
21922 give extra options to ghcjs
21923
21924 --ghcjs-pkg-options OPTS
21925 give extra options to ghcjs-pkg
21926
21927 --greencard-options OPTS
21928 give extra options to greencard
21929
21930 --haddock-options OPTS
21931 give extra options to haddock
21932
21933 --happy-options OPTS
21934 give extra options to happy
21935
21936 --haskell-suite-options OPTS
21937 give extra options to haskell-suite
21938
21939 --haskell-suite-pkg-options OPTS
21940 give extra options to haskell-suite-pkg
21941
21942 --hmake-options OPTS
21943 give extra options to hmake
21944
21945 --hpc-options OPTS
21946 give extra options to hpc
21947
21948 --hsc2hs-options OPTS
21949 give extra options to hsc2hs
21950
21951 --hscolour-options OPTS
21952 give extra options to hscolour
21953
21954 --jhc-options OPTS
21955 give extra options to jhc
21956
21957 --ld-options OPTS
21958 give extra options to ld
21959
21960 --pkg-config-options OPTS
21961 give extra options to pkg-config
21962
21963 --runghc-options OPTS
21964 give extra options to runghc
21965
21966 --strip-options OPTS
21967 give extra options to strip
21968
21969 --tar-options OPTS
21970 give extra options to tar
21971
21972 --uhc-options OPTS
21973 give extra options to uhc
21974
21975 --only
21976 Don't reinstall add-source dependencies (sandbox-only)
21977
21978
21979 cabal bench
21980
21981 Usage: cabal bench [FLAGS]
21982 or: cabal bench BENCHCOMPONENTS [FLAGS]
21983
21984
21985 If necessary (re)configures with `--enable-benchmarks` flag and builds
21986 the benchmarks.
21987
21988 Remember that the benchmarks' dependencies must be installed if there
21989 are additional ones; e.g. with `cabal install --only-dependencies
21990 --enable-benchmarks`.
21991
21992 By defining UserHooks in a custom Setup.hs, the package can define
21993 actions to be executed before and after running benchmarks.
21994
21995
21996 The bench command is a part of the legacy v1 style of cabal usage.
21997
21998 Please switch to using either the new project style and the new-bench
21999 command or the legacy v1-bench alias as new-style projects will become
22000 the default in the next version of cabal-install. Please file a bug if
22001 you cannot replicate a working v1- use case with the new-style com‐
22002 mands.
22003
22004 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22005
22006
22007 Flags:
22008 -v, --verbose [n]
22009 Control verbosity (n is 0--3, default verbosity level is
22010 1)
22011
22012 --builddir, --distdir, --distpref DIR
22013 The directory where Cabal puts generated build files
22014 (default dist)
22015
22016 --benchmark-options TEMPLATES
22017 give extra options to benchmark executables (name tem‐
22018 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
22019
22020 --benchmark-option TEMPLATE
22021 give extra option to benchmark executables (no need to
22022 quote options containing spaces, name template can use
22023 $pkgid, $compiler, $os, $arch, $benchmark)
22024
22025 -j, --jobs [NUM]
22026 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
22027 given).
22028
22029 --with-alex PATH
22030 give the path to alex
22031
22032 --with-ar PATH
22033 give the path to ar
22034
22035 --with-c2hs PATH
22036 give the path to c2hs
22037
22038 --with-cpphs PATH
22039 give the path to cpphs
22040
22041 --with-doctest PATH
22042 give the path to doctest
22043
22044 --with-gcc PATH
22045 give the path to gcc
22046
22047 --with-ghc PATH
22048 give the path to ghc
22049
22050 --with-ghc-pkg PATH
22051 give the path to ghc-pkg
22052
22053 --with-ghcjs PATH
22054 give the path to ghcjs
22055
22056 --with-ghcjs-pkg PATH
22057 give the path to ghcjs-pkg
22058
22059 --with-greencard PATH
22060 give the path to greencard
22061
22062 --with-haddock PATH
22063 give the path to haddock
22064
22065 --with-happy PATH
22066 give the path to happy
22067
22068 --with-haskell-suite PATH
22069 give the path to haskell-suite
22070
22071 --with-haskell-suite-pkg PATH
22072 give the path to haskell-suite-pkg
22073
22074 --with-hmake PATH
22075 give the path to hmake
22076
22077 --with-hpc PATH
22078 give the path to hpc
22079
22080 --with-hsc2hs PATH
22081 give the path to hsc2hs
22082
22083 --with-hscolour PATH
22084 give the path to hscolour
22085
22086 --with-jhc PATH
22087 give the path to jhc
22088
22089 --with-ld PATH
22090 give the path to ld
22091
22092 --with-pkg-config PATH
22093 give the path to pkg-config
22094
22095 --with-runghc PATH
22096 give the path to runghc
22097
22098 --with-strip PATH
22099 give the path to strip
22100
22101 --with-tar PATH
22102 give the path to tar
22103
22104 --with-uhc PATH
22105 give the path to uhc
22106
22107 --alex-option OPT
22108 give an extra option to alex (no need to quote options
22109 containing spaces)
22110
22111 --ar-option OPT
22112 give an extra option to ar (no need to quote options con‐
22113 taining spaces)
22114
22115 --c2hs-option OPT
22116 give an extra option to c2hs (no need to quote options
22117 containing spaces)
22118
22119 --cpphs-option OPT
22120 give an extra option to cpphs (no need to quote options
22121 containing spaces)
22122
22123 --doctest-option OPT
22124 give an extra option to doctest (no need to quote options
22125 containing spaces)
22126
22127 --gcc-option OPT
22128 give an extra option to gcc (no need to quote options
22129 containing spaces)
22130
22131 --ghc-option OPT
22132 give an extra option to ghc (no need to quote options
22133 containing spaces)
22134
22135 --ghc-pkg-option OPT
22136 give an extra option to ghc-pkg (no need to quote options
22137 containing spaces)
22138
22139 --ghcjs-option OPT
22140 give an extra option to ghcjs (no need to quote options
22141 containing spaces)
22142
22143 --ghcjs-pkg-option OPT
22144 give an extra option to ghcjs-pkg (no need to quote
22145 options containing spaces)
22146
22147 --greencard-option OPT
22148 give an extra option to greencard (no need to quote
22149 options containing spaces)
22150
22151 --haddock-option OPT
22152 give an extra option to haddock (no need to quote options
22153 containing spaces)
22154
22155 --happy-option OPT
22156 give an extra option to happy (no need to quote options
22157 containing spaces)
22158
22159 --haskell-suite-option OPT
22160 give an extra option to haskell-suite (no need to quote
22161 options containing spaces)
22162
22163 --haskell-suite-pkg-option OPT
22164 give an extra option to haskell-suite-pkg (no need to
22165 quote options containing spaces)
22166
22167 --hmake-option OPT
22168 give an extra option to hmake (no need to quote options
22169 containing spaces)
22170
22171 --hpc-option OPT
22172 give an extra option to hpc (no need to quote options
22173 containing spaces)
22174
22175 --hsc2hs-option OPT
22176 give an extra option to hsc2hs (no need to quote options
22177 containing spaces)
22178
22179 --hscolour-option OPT
22180 give an extra option to hscolour (no need to quote
22181 options containing spaces)
22182
22183 --jhc-option OPT
22184 give an extra option to jhc (no need to quote options
22185 containing spaces)
22186
22187 --ld-option OPT
22188 give an extra option to ld (no need to quote options con‐
22189 taining spaces)
22190
22191 --pkg-config-option OPT
22192 give an extra option to pkg-config (no need to quote
22193 options containing spaces)
22194
22195 --runghc-option OPT
22196 give an extra option to runghc (no need to quote options
22197 containing spaces)
22198
22199 --strip-option OPT
22200 give an extra option to strip (no need to quote options
22201 containing spaces)
22202
22203 --tar-option OPT
22204 give an extra option to tar (no need to quote options
22205 containing spaces)
22206
22207 --uhc-option OPT
22208 give an extra option to uhc (no need to quote options
22209 containing spaces)
22210
22211 --alex-options OPTS
22212 give extra options to alex
22213
22214 --ar-options OPTS
22215 give extra options to ar
22216
22217 --c2hs-options OPTS
22218 give extra options to c2hs
22219
22220 --cpphs-options OPTS
22221 give extra options to cpphs
22222
22223 --doctest-options OPTS
22224 give extra options to doctest
22225
22226 --gcc-options OPTS
22227 give extra options to gcc
22228
22229 --ghc-options OPTS
22230 give extra options to ghc
22231
22232 --ghc-pkg-options OPTS
22233 give extra options to ghc-pkg
22234
22235 --ghcjs-options OPTS
22236 give extra options to ghcjs
22237
22238 --ghcjs-pkg-options OPTS
22239 give extra options to ghcjs-pkg
22240
22241 --greencard-options OPTS
22242 give extra options to greencard
22243
22244 --haddock-options OPTS
22245 give extra options to haddock
22246
22247 --happy-options OPTS
22248 give extra options to happy
22249
22250 --haskell-suite-options OPTS
22251 give extra options to haskell-suite
22252
22253 --haskell-suite-pkg-options OPTS
22254 give extra options to haskell-suite-pkg
22255
22256 --hmake-options OPTS
22257 give extra options to hmake
22258
22259 --hpc-options OPTS
22260 give extra options to hpc
22261
22262 --hsc2hs-options OPTS
22263 give extra options to hsc2hs
22264
22265 --hscolour-options OPTS
22266 give extra options to hscolour
22267
22268 --jhc-options OPTS
22269 give extra options to jhc
22270
22271 --ld-options OPTS
22272 give extra options to ld
22273
22274 --pkg-config-options OPTS
22275 give extra options to pkg-config
22276
22277 --runghc-options OPTS
22278 give extra options to runghc
22279
22280 --strip-options OPTS
22281 give extra options to strip
22282
22283 --tar-options OPTS
22284 give extra options to tar
22285
22286 --uhc-options OPTS
22287 give extra options to uhc
22288
22289 --only
22290 Don't reinstall add-source dependencies (sandbox-only)
22291
22292
22293 cabal v1-bench
22294
22295 Usage: cabal v1-bench [FLAGS]
22296 or: cabal v1-bench BENCHCOMPONENTS [FLAGS]
22297
22298
22299 If necessary (re)configures with `--enable-benchmarks` flag and builds
22300 the benchmarks.
22301
22302 Remember that the benchmarks' dependencies must be installed if there
22303 are additional ones; e.g. with `cabal v1-install --only-dependencies
22304 --enable-benchmarks`.
22305
22306 By defining UserHooks in a custom Setup.hs, the package can define
22307 actions to be executed before and after running benchmarks.
22308
22309
22310 The v1-bench command is a part of the legacy v1 style of cabal usage.
22311
22312 It is a legacy feature and will be removed in a future release of
22313 cabal-install. Please file a bug if you cannot replicate a working v1-
22314 use case with the new-style commands.
22315
22316 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22317
22318
22319 Flags:
22320 -v, --verbose [n]
22321 Control verbosity (n is 0--3, default verbosity level is
22322 1)
22323
22324 --builddir, --distdir, --distpref DIR
22325 The directory where Cabal puts generated build files
22326 (default dist)
22327
22328 --benchmark-options TEMPLATES
22329 give extra options to benchmark executables (name tem‐
22330 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
22331
22332 --benchmark-option TEMPLATE
22333 give extra option to benchmark executables (no need to
22334 quote options containing spaces, name template can use
22335 $pkgid, $compiler, $os, $arch, $benchmark)
22336
22337 -j, --jobs [NUM]
22338 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
22339 given).
22340
22341 --with-alex PATH
22342 give the path to alex
22343
22344 --with-ar PATH
22345 give the path to ar
22346
22347 --with-c2hs PATH
22348 give the path to c2hs
22349
22350 --with-cpphs PATH
22351 give the path to cpphs
22352
22353 --with-doctest PATH
22354 give the path to doctest
22355
22356 --with-gcc PATH
22357 give the path to gcc
22358
22359 --with-ghc PATH
22360 give the path to ghc
22361
22362 --with-ghc-pkg PATH
22363 give the path to ghc-pkg
22364
22365 --with-ghcjs PATH
22366 give the path to ghcjs
22367
22368 --with-ghcjs-pkg PATH
22369 give the path to ghcjs-pkg
22370
22371 --with-greencard PATH
22372 give the path to greencard
22373
22374 --with-haddock PATH
22375 give the path to haddock
22376
22377 --with-happy PATH
22378 give the path to happy
22379
22380 --with-haskell-suite PATH
22381 give the path to haskell-suite
22382
22383 --with-haskell-suite-pkg PATH
22384 give the path to haskell-suite-pkg
22385
22386 --with-hmake PATH
22387 give the path to hmake
22388
22389 --with-hpc PATH
22390 give the path to hpc
22391
22392 --with-hsc2hs PATH
22393 give the path to hsc2hs
22394
22395 --with-hscolour PATH
22396 give the path to hscolour
22397
22398 --with-jhc PATH
22399 give the path to jhc
22400
22401 --with-ld PATH
22402 give the path to ld
22403
22404 --with-pkg-config PATH
22405 give the path to pkg-config
22406
22407 --with-runghc PATH
22408 give the path to runghc
22409
22410 --with-strip PATH
22411 give the path to strip
22412
22413 --with-tar PATH
22414 give the path to tar
22415
22416 --with-uhc PATH
22417 give the path to uhc
22418
22419 --alex-option OPT
22420 give an extra option to alex (no need to quote options
22421 containing spaces)
22422
22423 --ar-option OPT
22424 give an extra option to ar (no need to quote options con‐
22425 taining spaces)
22426
22427 --c2hs-option OPT
22428 give an extra option to c2hs (no need to quote options
22429 containing spaces)
22430
22431 --cpphs-option OPT
22432 give an extra option to cpphs (no need to quote options
22433 containing spaces)
22434
22435 --doctest-option OPT
22436 give an extra option to doctest (no need to quote options
22437 containing spaces)
22438
22439 --gcc-option OPT
22440 give an extra option to gcc (no need to quote options
22441 containing spaces)
22442
22443 --ghc-option OPT
22444 give an extra option to ghc (no need to quote options
22445 containing spaces)
22446
22447 --ghc-pkg-option OPT
22448 give an extra option to ghc-pkg (no need to quote options
22449 containing spaces)
22450
22451 --ghcjs-option OPT
22452 give an extra option to ghcjs (no need to quote options
22453 containing spaces)
22454
22455 --ghcjs-pkg-option OPT
22456 give an extra option to ghcjs-pkg (no need to quote
22457 options containing spaces)
22458
22459 --greencard-option OPT
22460 give an extra option to greencard (no need to quote
22461 options containing spaces)
22462
22463 --haddock-option OPT
22464 give an extra option to haddock (no need to quote options
22465 containing spaces)
22466
22467 --happy-option OPT
22468 give an extra option to happy (no need to quote options
22469 containing spaces)
22470
22471 --haskell-suite-option OPT
22472 give an extra option to haskell-suite (no need to quote
22473 options containing spaces)
22474
22475 --haskell-suite-pkg-option OPT
22476 give an extra option to haskell-suite-pkg (no need to
22477 quote options containing spaces)
22478
22479 --hmake-option OPT
22480 give an extra option to hmake (no need to quote options
22481 containing spaces)
22482
22483 --hpc-option OPT
22484 give an extra option to hpc (no need to quote options
22485 containing spaces)
22486
22487 --hsc2hs-option OPT
22488 give an extra option to hsc2hs (no need to quote options
22489 containing spaces)
22490
22491 --hscolour-option OPT
22492 give an extra option to hscolour (no need to quote
22493 options containing spaces)
22494
22495 --jhc-option OPT
22496 give an extra option to jhc (no need to quote options
22497 containing spaces)
22498
22499 --ld-option OPT
22500 give an extra option to ld (no need to quote options con‐
22501 taining spaces)
22502
22503 --pkg-config-option OPT
22504 give an extra option to pkg-config (no need to quote
22505 options containing spaces)
22506
22507 --runghc-option OPT
22508 give an extra option to runghc (no need to quote options
22509 containing spaces)
22510
22511 --strip-option OPT
22512 give an extra option to strip (no need to quote options
22513 containing spaces)
22514
22515 --tar-option OPT
22516 give an extra option to tar (no need to quote options
22517 containing spaces)
22518
22519 --uhc-option OPT
22520 give an extra option to uhc (no need to quote options
22521 containing spaces)
22522
22523 --alex-options OPTS
22524 give extra options to alex
22525
22526 --ar-options OPTS
22527 give extra options to ar
22528
22529 --c2hs-options OPTS
22530 give extra options to c2hs
22531
22532 --cpphs-options OPTS
22533 give extra options to cpphs
22534
22535 --doctest-options OPTS
22536 give extra options to doctest
22537
22538 --gcc-options OPTS
22539 give extra options to gcc
22540
22541 --ghc-options OPTS
22542 give extra options to ghc
22543
22544 --ghc-pkg-options OPTS
22545 give extra options to ghc-pkg
22546
22547 --ghcjs-options OPTS
22548 give extra options to ghcjs
22549
22550 --ghcjs-pkg-options OPTS
22551 give extra options to ghcjs-pkg
22552
22553 --greencard-options OPTS
22554 give extra options to greencard
22555
22556 --haddock-options OPTS
22557 give extra options to haddock
22558
22559 --happy-options OPTS
22560 give extra options to happy
22561
22562 --haskell-suite-options OPTS
22563 give extra options to haskell-suite
22564
22565 --haskell-suite-pkg-options OPTS
22566 give extra options to haskell-suite-pkg
22567
22568 --hmake-options OPTS
22569 give extra options to hmake
22570
22571 --hpc-options OPTS
22572 give extra options to hpc
22573
22574 --hsc2hs-options OPTS
22575 give extra options to hsc2hs
22576
22577 --hscolour-options OPTS
22578 give extra options to hscolour
22579
22580 --jhc-options OPTS
22581 give extra options to jhc
22582
22583 --ld-options OPTS
22584 give extra options to ld
22585
22586 --pkg-config-options OPTS
22587 give extra options to pkg-config
22588
22589 --runghc-options OPTS
22590 give extra options to runghc
22591
22592 --strip-options OPTS
22593 give extra options to strip
22594
22595 --tar-options OPTS
22596 give extra options to tar
22597
22598 --uhc-options OPTS
22599 give extra options to uhc
22600
22601 --only
22602 Don't reinstall add-source dependencies (sandbox-only)
22603
22604
22605 cabal exec
22606
22607 Usage: cabal exec [FLAGS] [--] COMMAND [--] [ARGS]
22608
22609
22610 A directly invoked GHC will not automatically be aware of any sand‐
22611 boxes: the GHC_PACKAGE_PATH environment variable controls what GHC
22612 uses. `cabal exec` can be used to modify this variable: COMMAND will be
22613 executed in a modified environment and thereby uses the sandbox package
22614 database.
22615
22616 If there is no sandbox, behaves as identity (executing COMMAND).
22617
22618 Note that other cabal commands change the environment variable appro‐
22619 priately already, so there is no need to wrap those in `cabal exec`.
22620 But with `cabal exec`, the user has more control and can, for example,
22621 execute custom scripts which indirectly execute GHC.
22622
22623 Note that `cabal repl` is different from `cabal exec -- ghci` as the
22624 latter will not forward any additional flags being defined in the local
22625 package to ghci.
22626
22627 See `cabal sandbox`.
22628
22629
22630 Examples:
22631 cabal exec -- ghci -Wall
22632 Start a repl session with sandbox packages and all warnings;
22633 cabal exec gitit -- -f gitit.cnf
22634 Give gitit access to the sandbox packages, and pass it a flag;
22635 cabal exec runghc Foo.hs
22636 Execute runghc on Foo.hs with runghc configured to use the
22637 sandbox package database (if a sandbox is being used).
22638
22639 The exec command is a part of the legacy v1 style of cabal usage.
22640
22641 Please switch to using either the new project style and the new-exec
22642 command or the legacy v1-exec alias as new-style projects will become
22643 the default in the next version of cabal-install. Please file a bug if
22644 you cannot replicate a working v1- use case with the new-style com‐
22645 mands.
22646
22647 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22648
22649
22650 Flags:
22651 -v, --verbose [n]
22652 Control verbosity (n is 0--3, default verbosity level is
22653 1)
22654
22655 --builddir, --distdir, --distpref DIR
22656 The directory where Cabal puts generated build files
22657 (default dist)
22658
22659
22660 cabal v1-exec
22661
22662 Usage: cabal v1-exec [FLAGS] [--] COMMAND [--] [ARGS]
22663
22664
22665 A directly invoked GHC will not automatically be aware of any sand‐
22666 boxes: the GHC_PACKAGE_PATH environment variable controls what GHC
22667 uses. `cabal v1-exec` can be used to modify this variable: COMMAND will
22668 be executed in a modified environment and thereby uses the sandbox
22669 package database.
22670
22671 If there is no sandbox, behaves as identity (executing COMMAND).
22672
22673 Note that other cabal commands change the environment variable appro‐
22674 priately already, so there is no need to wrap those in `cabal v1-exec`.
22675 But with `cabal v1-exec`, the user has more control and can, for exam‐
22676 ple, execute custom scripts which indirectly execute GHC.
22677
22678 Note that `cabal v1-repl` is different from `cabal v1-exec -- ghci` as
22679 the latter will not forward any additional flags being defined in the
22680 local package to ghci.
22681
22682 See `cabal sandbox`.
22683
22684
22685 Examples:
22686 cabal v1-exec -- ghci -Wall
22687 Start a repl session with sandbox packages and all warnings;
22688 cabal v1-exec gitit -- -f gitit.cnf
22689 Give gitit access to the sandbox packages, and pass it a flag;
22690 cabal v1-exec runghc Foo.hs
22691 Execute runghc on Foo.hs with runghc configured to use the
22692 sandbox package database (if a sandbox is being used).
22693
22694 The v1-exec command is a part of the legacy v1 style of cabal usage.
22695
22696 It is a legacy feature and will be removed in a future release of
22697 cabal-install. Please file a bug if you cannot replicate a working v1-
22698 use case with the new-style commands.
22699
22700 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22701
22702
22703 Flags:
22704 -v, --verbose [n]
22705 Control verbosity (n is 0--3, default verbosity level is
22706 1)
22707
22708 --builddir, --distdir, --distpref DIR
22709 The directory where Cabal puts generated build files
22710 (default dist)
22711
22712
22713 cabal clean
22714
22715 Usage: cabal clean [FLAGS]
22716
22717
22718 Removes .hi, .o, preprocessed sources, etc.
22719
22720
22721 The clean command is a part of the legacy v1 style of cabal usage.
22722
22723 Please switch to using either the new project style and the new-clean
22724 command or the legacy v1-clean alias as new-style projects will become
22725 the default in the next version of cabal-install. Please file a bug if
22726 you cannot replicate a working v1- use case with the new-style com‐
22727 mands.
22728
22729 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22730
22731
22732 Flags:
22733 -v, --verbose [n]
22734 Control verbosity (n is 0--3, default verbosity level is
22735 1)
22736
22737 --builddir, --distdir, --distpref DIR
22738 The directory where Cabal puts generated build files
22739 (default dist)
22740
22741 -s, --save-configure
22742 Do not remove the configuration file (dist/setup-config)
22743 during cleaning. Saves need to reconfigure.
22744
22745
22746 cabal v1-clean
22747
22748 Usage: cabal v1-clean [FLAGS]
22749
22750
22751 Removes .hi, .o, preprocessed sources, etc.
22752
22753
22754 The v1-clean command is a part of the legacy v1 style of cabal usage.
22755
22756 It is a legacy feature and will be removed in a future release of
22757 cabal-install. Please file a bug if you cannot replicate a working v1-
22758 use case with the new-style commands.
22759
22760 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22761
22762
22763 Flags:
22764 -v, --verbose [n]
22765 Control verbosity (n is 0--3, default verbosity level is
22766 1)
22767
22768 --builddir, --distdir, --distpref DIR
22769 The directory where Cabal puts generated build files
22770 (default dist)
22771
22772 -s, --save-configure
22773 Do not remove the configuration file (dist/setup-config)
22774 during cleaning. Saves need to reconfigure.
22775
22776
22777 cabal sdist
22778
22779 Usage: cabal sdist [FLAGS]
22780
22781
22782 The sdist command is a part of the legacy v1 style of cabal usage.
22783
22784 Please switch to using either the new project style and the new-sdist
22785 command or the legacy v1-sdist alias as new-style projects will become
22786 the default in the next version of cabal-install. Please file a bug if
22787 you cannot replicate a working v1- use case with the new-style com‐
22788 mands.
22789
22790 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22791
22792
22793 Flags:
22794 -v, --verbose [n]
22795 Control verbosity (n is 0--3, default verbosity level is
22796 1)
22797
22798 --builddir, --distdir, --distpref DIR
22799 The directory where Cabal puts generated build files
22800 (default dist)
22801
22802 --list-sources FILE
22803 Just write a list of the package's sources to a file
22804
22805 --snapshot
22806 Produce a snapshot source distribution
22807
22808 --output-directory DIR
22809 Generate a source distribution in the given directory,
22810 without creating a tarball
22811
22812 --targz
22813 Produce a '.tar.gz' format archive (default and required
22814 for uploading to hackage)
22815
22816 --zip
22817 Produce a '.zip' format archive
22818
22819
22820 cabal v1-sdist
22821
22822 Usage: cabal v1-sdist [FLAGS]
22823
22824
22825 The v1-sdist command is a part of the legacy v1 style of cabal usage.
22826
22827 It is a legacy feature and will be removed in a future release of
22828 cabal-install. Please file a bug if you cannot replicate a working v1-
22829 use case with the new-style commands.
22830
22831 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22832
22833
22834 Flags:
22835 -v, --verbose [n]
22836 Control verbosity (n is 0--3, default verbosity level is
22837 1)
22838
22839 --builddir, --distdir, --distpref DIR
22840 The directory where Cabal puts generated build files
22841 (default dist)
22842
22843 --list-sources FILE
22844 Just write a list of the package's sources to a file
22845
22846 --snapshot
22847 Produce a snapshot source distribution
22848
22849 --output-directory DIR
22850 Generate a source distribution in the given directory,
22851 without creating a tarball
22852
22853 --targz
22854 Produce a '.tar.gz' format archive (default and required
22855 for uploading to hackage)
22856
22857 --zip
22858 Produce a '.zip' format archive
22859
22860
22861 cabal doctest
22862
22863 Usage: cabal doctest [FLAGS]
22864
22865
22866 Requires the program doctest, version 0.12.
22867
22868
22869 The doctest command is a part of the legacy v1 style of cabal usage.
22870
22871 Please switch to using either the new project style and the new-doctest
22872 command or the legacy v1-doctest alias as new-style projects will
22873 become the default in the next version of cabal-install. Please file a
22874 bug if you cannot replicate a working v1- use case with the new-style
22875 commands.
22876
22877 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22878
22879
22880 Flags:
22881 -v, --verbose [n]
22882 Control verbosity (n is 0--3, default verbosity level is
22883 1)
22884
22885 --builddir, --distdir, --distpref DIR
22886 The directory where Cabal puts generated build files
22887 (default dist)
22888
22889 --with-doctest PATH
22890 give the path to doctest
22891
22892 --doctest-option OPT
22893 give an extra option to doctest (no need to quote options
22894 containing spaces)
22895
22896 --doctest-options OPTS
22897 give extra options to doctest
22898
22899
22900 cabal v1-doctest
22901
22902 Usage: cabal v1-doctest [FLAGS]
22903
22904
22905 Requires the program doctest, version 0.12.
22906
22907
22908 The v1-doctest command is a part of the legacy v1 style of cabal usage.
22909
22910 It is a legacy feature and will be removed in a future release of
22911 cabal-install. Please file a bug if you cannot replicate a working v1-
22912 use case with the new-style commands.
22913
22914 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22915
22916
22917 Flags:
22918 -v, --verbose [n]
22919 Control verbosity (n is 0--3, default verbosity level is
22920 1)
22921
22922 --builddir, --distdir, --distpref DIR
22923 The directory where Cabal puts generated build files
22924 (default dist)
22925
22926 --with-doctest PATH
22927 give the path to doctest
22928
22929 --doctest-option OPT
22930 give an extra option to doctest (no need to quote options
22931 containing spaces)
22932
22933 --doctest-options OPTS
22934 give extra options to doctest
22935
22936
22937 cabal copy
22938
22939 Usage: cabal copy [FLAGS]
22940 or: cabal copy COMPONENTS [FLAGS]
22941
22942
22943 Components encompass executables and libraries. Does not call register,
22944 and allows a prefix at install time. Without the --destdir flag, con‐
22945 figure determines location.
22946
22947
22948 Examples:
22949 cabal copy All the components in the package
22950 cabal copy foo A component (i.e. lib, exe, test suite) The
22951 copy command is a part of the legacy v1 style of cabal usage.
22952
22953 Please switch to using either the new project style and the new-copy
22954 command or the legacy v1-copy alias as new-style projects will become
22955 the default in the next version of cabal-install. Please file a bug if
22956 you cannot replicate a working v1- use case with the new-style com‐
22957 mands.
22958
22959 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22960
22961
22962 Flags:
22963 -v, --verbose [n]
22964 Control verbosity (n is 0--3, default verbosity level is
22965 1)
22966
22967 --builddir, --distdir, --distpref DIR
22968 The directory where Cabal puts generated build files
22969 (default dist)
22970
22971 --destdir DIR
22972 directory to copy files to, prepended to installation
22973 directories
22974
22975 --target-package-db DATABASE
22976 package database to copy files into. Required when using
22977 ${pkgroot} prefix.
22978
22979
22980 cabal v1-copy
22981
22982 Usage: cabal v1-copy [FLAGS]
22983 or: cabal v1-copy COMPONENTS [FLAGS]
22984
22985
22986 Components encompass executables and libraries. Does not call register,
22987 and allows a prefix at install time. Without the --destdir flag, con‐
22988 figure determines location.
22989
22990
22991 Examples:
22992 cabal v1-copy All the components in the package
22993 cabal v1-copy foo A component (i.e. lib, exe, test suite)
22994 The v1-copy command is a part of the legacy v1 style of cabal usage.
22995
22996 It is a legacy feature and will be removed in a future release of
22997 cabal-install. Please file a bug if you cannot replicate a working v1-
22998 use case with the new-style commands.
22999
23000 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
23001
23002
23003 Flags:
23004 -v, --verbose [n]
23005 Control verbosity (n is 0--3, default verbosity level is
23006 1)
23007
23008 --builddir, --distdir, --distpref DIR
23009 The directory where Cabal puts generated build files
23010 (default dist)
23011
23012 --destdir DIR
23013 directory to copy files to, prepended to installation
23014 directories
23015
23016 --target-package-db DATABASE
23017 package database to copy files into. Required when using
23018 ${pkgroot} prefix.
23019
23020
23021 cabal register
23022
23023 Usage: cabal register [FLAGS]
23024
23025
23026 The register command is a part of the legacy v1 style of cabal usage.
23027
23028 Please switch to using either the new project style and the new-regis‐
23029 ter command or the legacy v1-register alias as new-style projects will
23030 become the default in the next version of cabal-install. Please file a
23031 bug if you cannot replicate a working v1- use case with the new-style
23032 commands.
23033
23034 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
23035
23036
23037 Flags:
23038 -v, --verbose [n]
23039 Control verbosity (n is 0--3, default verbosity level is
23040 1)
23041
23042 --builddir, --distdir, --distpref DIR
23043 The directory where Cabal puts generated build files
23044 (default dist)
23045
23046 --user
23047 upon registration, register this package in the user's
23048 local package database
23049
23050 --global
23051 (default)upon registration, register this package in the
23052 system-wide package database
23053
23054 --inplace
23055 register the package in the build location, so it can be
23056 used without being installed
23057
23058 --gen-script
23059 instead of registering, generate a script to register
23060 later
23061
23062 --gen-pkg-config [PKG]
23063 instead of registering, generate a package registration
23064 file/directory
23065
23066 --print-ipid
23067 print the installed package ID calculated for this pack‐
23068 age
23069
23070
23071 cabal v1-register
23072
23073 Usage: cabal v1-register [FLAGS]
23074
23075
23076 The v1-register command is a part of the legacy v1 style of cabal
23077 usage.
23078
23079 It is a legacy feature and will be removed in a future release of
23080 cabal-install. Please file a bug if you cannot replicate a working v1-
23081 use case with the new-style commands.
23082
23083 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
23084
23085
23086 Flags:
23087 -v, --verbose [n]
23088 Control verbosity (n is 0--3, default verbosity level is
23089 1)
23090
23091 --builddir, --distdir, --distpref DIR
23092 The directory where Cabal puts generated build files
23093 (default dist)
23094
23095 --user
23096 upon registration, register this package in the user's
23097 local package database
23098
23099 --global
23100 (default)upon registration, register this package in the
23101 system-wide package database
23102
23103 --inplace
23104 register the package in the build location, so it can be
23105 used without being installed
23106
23107 --gen-script
23108 instead of registering, generate a script to register
23109 later
23110
23111 --gen-pkg-config [PKG]
23112 instead of registering, generate a package registration
23113 file/directory
23114
23115 --print-ipid
23116 print the installed package ID calculated for this pack‐
23117 age
23118
23119
23120 cabal reconfigure
23121
23122 Usage: cabal reconfigure [FLAGS]
23123
23124
23125 Run `configure` with the most recently used flags, or append FLAGS to
23126 the most recently used configuration. Accepts the same flags as `cabal
23127 configure'. If the package has never been configured, the default
23128 flags are used.
23129
23130
23131 Examples:
23132 cabal reconfigure
23133 Configure with the most recently used flags.
23134 cabal reconfigure -w PATH
23135 Reconfigure with the most recently used flags,
23136 but use the compiler at PATH.
23137
23138
23139 The reconfigure command is a part of the legacy v1 style of cabal
23140 usage.
23141
23142 Please switch to using either the new project style and the new-recon‐
23143 figure command or the legacy v1-reconfigure alias as new-style projects
23144 will become the default in the next version of cabal-install. Please
23145 file a bug if you cannot replicate a working v1- use case with the new-
23146 style commands.
23147
23148 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
23149
23150
23151 Flags:
23152 -v, --verbose [n]
23153 Control verbosity (n is 0--3, default verbosity level is
23154 1)
23155
23156 --builddir, --distdir, --distpref DIR
23157 The directory where Cabal puts generated build files
23158 (default dist)
23159
23160 -g, --ghc
23161 compile with GHC
23162
23163 --ghcjs
23164 compile with GHCJS
23165
23166 --uhc
23167 compile with UHC
23168
23169 --haskell-suite
23170 compile with a haskell-suite compiler
23171
23172 --cabal-file PATH
23173 use this Cabal file
23174
23175 -w, --with-compiler PATH
23176 give the path to a particular compiler
23177
23178 --with-hc-pkg PATH
23179 give the path to the package tool
23180
23181 --prefix DIR
23182 bake this prefix in preparation of installation
23183
23184 --bindir DIR
23185 installation directory for executables
23186
23187 --libdir DIR
23188 installation directory for libraries
23189
23190 --libsubdir DIR
23191 subdirectory of libdir in which libs are installed
23192
23193 --dynlibdir DIR
23194 installation directory for dynamic libraries
23195
23196 --libexecdir DIR
23197 installation directory for program executables
23198
23199 --libexecsubdir DIR
23200 subdirectory of libexecdir in which private executables
23201 are installed
23202
23203 --datadir DIR
23204 installation directory for read-only data
23205
23206 --datasubdir DIR
23207 subdirectory of datadir in which data files are installed
23208
23209 --docdir DIR
23210 installation directory for documentation
23211
23212 --htmldir DIR
23213 installation directory for HTML documentation
23214
23215 --haddockdir DIR
23216 installation directory for haddock interfaces
23217
23218 --sysconfdir DIR
23219 installation directory for configuration files
23220
23221 --program-prefix PREFIX
23222 prefix to be applied to installed executables
23223
23224 --program-suffix SUFFIX
23225 suffix to be applied to installed executables
23226
23227 --enable-library-vanilla
23228 --disable-library-vanilla
23229 Vanilla libraries
23230
23231 -p, --enable-library-profiling
23232 --disable-library-profiling
23233 Library profiling
23234
23235 --enable-shared
23236 --disable-shared
23237 Shared library
23238
23239 --enable-static
23240 --disable-static
23241 Static library
23242
23243 --enable-executable-dynamic
23244 --disable-executable-dynamic
23245 Executable dynamic linking
23246
23247 --enable-profiling
23248 --disable-profiling
23249 Executable and library profiling
23250
23251 --enable-executable-profiling
23252 --disable-executable-profiling
23253 Executable profiling (DEPRECATED)
23254
23255 --profiling-detail level
23256 Profiling detail level for executable and library
23257 (default, none, exported-functions, toplevel-functions,
23258 all-functions).
23259
23260 --library-profiling-detail level
23261 Profiling detail level for libraries only.
23262
23263 -O, --enable-optimization, --enable-optimisation [n]
23264 Build with optimization (n is 0--2, default is 1)
23265
23266 --disable-optimization, --disable-optimisation
23267 Build without optimization
23268
23269 --enable-debug-info [n]
23270 Emit debug info (n is 0--3, default is 0)
23271
23272 --disable-debug-info
23273 Don't emit debug info
23274
23275 --enable-library-for-ghci
23276 --disable-library-for-ghci
23277 compile library for use with GHCi
23278
23279 --enable-split-sections
23280 --disable-split-sections
23281 compile library code such that unneeded definitions can
23282 be dropped from the final executable (GHC 7.8+)
23283
23284 --enable-split-objs
23285 --disable-split-objs
23286 split library into smaller objects to reduce binary sizes
23287 (GHC 6.6+)
23288
23289 --enable-executable-stripping
23290 --disable-executable-stripping
23291 strip executables upon installation to reduce binary
23292 sizes
23293
23294 --enable-library-stripping
23295 --disable-library-stripping
23296 strip libraries upon installation to reduce binary sizes
23297
23298 --configure-option OPT
23299 Extra option for configure
23300
23301 --user
23302 --global
23303 doing a per-user installation
23304
23305 --package-db DB
23306 Append the given package database to the list of package
23307 databases used (to satisfy dependencies and register
23308 into). May be a specific file, 'global' or 'user'. The
23309 initial list is ['global'], ['global', 'user'], or
23310 ['global', $sandbox], depending on context. Use 'clear'
23311 to reset the list to empty. See the user guide for
23312 details.
23313
23314 -f, --flags FLAGS
23315 Force values for the given flags in Cabal conditionals in
23316 the .cabal file. E.g., --flags="debug -usebytestrings"
23317 forces the flag "debug" to true and "usebytestrings" to
23318 false.
23319
23320 --extra-include-dirs PATH
23321 A list of directories to search for header files
23322
23323 --enable-deterministic
23324 --disable-deterministic
23325 Try to be as deterministic as possible (used by the test
23326 suite)
23327
23328 --ipid IPID
23329 Installed package ID to compile this package as
23330
23331 --cid CID
23332 Installed component ID to compile this component as
23333
23334 --extra-lib-dirs PATH
23335 A list of directories to search for external libraries
23336
23337 --extra-framework-dirs PATH
23338 A list of directories to search for external frameworks
23339 (OS X only)
23340
23341 --extra-prog-path PATH
23342 A list of directories to search for required programs (in
23343 addition to the normal search locations)
23344
23345 --instantiate-with NAME=MOD
23346 A mapping of signature names to concrete module instanti‐
23347 ations.
23348
23349 --enable-tests
23350 --disable-tests
23351 dependency checking and compilation for test suites
23352 listed in the package description file.
23353
23354 --enable-coverage
23355 --disable-coverage
23356 build package with Haskell Program Coverage. (GHC only)
23357
23358 --enable-library-coverage
23359 --disable-library-coverage
23360 build package with Haskell Program Coverage. (GHC only)
23361 (DEPRECATED)
23362
23363 --enable-benchmarks
23364 --disable-benchmarks
23365 dependency checking and compilation for benchmarks listed
23366 in the package description file.
23367
23368 --enable-relocatable
23369 --disable-relocatable
23370 building a package that is relocatable. (GHC only)
23371
23372 --disable-response-files
23373 enable workaround for old versions of programs like "ar"
23374 that do not support @file arguments
23375
23376 --with-alex PATH
23377 give the path to alex
23378
23379 --with-ar PATH
23380 give the path to ar
23381
23382 --with-c2hs PATH
23383 give the path to c2hs
23384
23385 --with-cpphs PATH
23386 give the path to cpphs
23387
23388 --with-doctest PATH
23389 give the path to doctest
23390
23391 --with-gcc PATH
23392 give the path to gcc
23393
23394 --with-ghc PATH
23395 give the path to ghc
23396
23397 --with-ghc-pkg PATH
23398 give the path to ghc-pkg
23399
23400 --with-ghcjs PATH
23401 give the path to ghcjs
23402
23403 --with-ghcjs-pkg PATH
23404 give the path to ghcjs-pkg
23405
23406 --with-greencard PATH
23407 give the path to greencard
23408
23409 --with-haddock PATH
23410 give the path to haddock
23411
23412 --with-happy PATH
23413 give the path to happy
23414
23415 --with-haskell-suite PATH
23416 give the path to haskell-suite
23417
23418 --with-haskell-suite-pkg PATH
23419 give the path to haskell-suite-pkg
23420
23421 --with-hmake PATH
23422 give the path to hmake
23423
23424 --with-hpc PATH
23425 give the path to hpc
23426
23427 --with-hsc2hs PATH
23428 give the path to hsc2hs
23429
23430 --with-hscolour PATH
23431 give the path to hscolour
23432
23433 --with-jhc PATH
23434 give the path to jhc
23435
23436 --with-ld PATH
23437 give the path to ld
23438
23439 --with-pkg-config PATH
23440 give the path to pkg-config
23441
23442 --with-runghc PATH
23443 give the path to runghc
23444
23445 --with-strip PATH
23446 give the path to strip
23447
23448 --with-tar PATH
23449 give the path to tar
23450
23451 --with-uhc PATH
23452 give the path to uhc
23453
23454 --alex-option OPT
23455 give an extra option to alex (no need to quote options
23456 containing spaces)
23457
23458 --ar-option OPT
23459 give an extra option to ar (no need to quote options con‐
23460 taining spaces)
23461
23462 --c2hs-option OPT
23463 give an extra option to c2hs (no need to quote options
23464 containing spaces)
23465
23466 --cpphs-option OPT
23467 give an extra option to cpphs (no need to quote options
23468 containing spaces)
23469
23470 --doctest-option OPT
23471 give an extra option to doctest (no need to quote options
23472 containing spaces)
23473
23474 --gcc-option OPT
23475 give an extra option to gcc (no need to quote options
23476 containing spaces)
23477
23478 --ghc-option OPT
23479 give an extra option to ghc (no need to quote options
23480 containing spaces)
23481
23482 --ghc-pkg-option OPT
23483 give an extra option to ghc-pkg (no need to quote options
23484 containing spaces)
23485
23486 --ghcjs-option OPT
23487 give an extra option to ghcjs (no need to quote options
23488 containing spaces)
23489
23490 --ghcjs-pkg-option OPT
23491 give an extra option to ghcjs-pkg (no need to quote
23492 options containing spaces)
23493
23494 --greencard-option OPT
23495 give an extra option to greencard (no need to quote
23496 options containing spaces)
23497
23498 --haddock-option OPT
23499 give an extra option to haddock (no need to quote options
23500 containing spaces)
23501
23502 --happy-option OPT
23503 give an extra option to happy (no need to quote options
23504 containing spaces)
23505
23506 --haskell-suite-option OPT
23507 give an extra option to haskell-suite (no need to quote
23508 options containing spaces)
23509
23510 --haskell-suite-pkg-option OPT
23511 give an extra option to haskell-suite-pkg (no need to
23512 quote options containing spaces)
23513
23514 --hmake-option OPT
23515 give an extra option to hmake (no need to quote options
23516 containing spaces)
23517
23518 --hpc-option OPT
23519 give an extra option to hpc (no need to quote options
23520 containing spaces)
23521
23522 --hsc2hs-option OPT
23523 give an extra option to hsc2hs (no need to quote options
23524 containing spaces)
23525
23526 --hscolour-option OPT
23527 give an extra option to hscolour (no need to quote
23528 options containing spaces)
23529
23530 --jhc-option OPT
23531 give an extra option to jhc (no need to quote options
23532 containing spaces)
23533
23534 --ld-option OPT
23535 give an extra option to ld (no need to quote options con‐
23536 taining spaces)
23537
23538 --pkg-config-option OPT
23539 give an extra option to pkg-config (no need to quote
23540 options containing spaces)
23541
23542 --runghc-option OPT
23543 give an extra option to runghc (no need to quote options
23544 containing spaces)
23545
23546 --strip-option OPT
23547 give an extra option to strip (no need to quote options
23548 containing spaces)
23549
23550 --tar-option OPT
23551 give an extra option to tar (no need to quote options
23552 containing spaces)
23553
23554 --uhc-option OPT
23555 give an extra option to uhc (no need to quote options
23556 containing spaces)
23557
23558 --alex-options OPTS
23559 give extra options to alex
23560
23561 --ar-options OPTS
23562 give extra options to ar
23563
23564 --c2hs-options OPTS
23565 give extra options to c2hs
23566
23567 --cpphs-options OPTS
23568 give extra options to cpphs
23569
23570 --doctest-options OPTS
23571 give extra options to doctest
23572
23573 --gcc-options OPTS
23574 give extra options to gcc
23575
23576 --ghc-options OPTS
23577 give extra options to ghc
23578
23579 --ghc-pkg-options OPTS
23580 give extra options to ghc-pkg
23581
23582 --ghcjs-options OPTS
23583 give extra options to ghcjs
23584
23585 --ghcjs-pkg-options OPTS
23586 give extra options to ghcjs-pkg
23587
23588 --greencard-options OPTS
23589 give extra options to greencard
23590
23591 --haddock-options OPTS
23592 give extra options to haddock
23593
23594 --happy-options OPTS
23595 give extra options to happy
23596
23597 --haskell-suite-options OPTS
23598 give extra options to haskell-suite
23599
23600 --haskell-suite-pkg-options OPTS
23601 give extra options to haskell-suite-pkg
23602
23603 --hmake-options OPTS
23604 give extra options to hmake
23605
23606 --hpc-options OPTS
23607 give extra options to hpc
23608
23609 --hsc2hs-options OPTS
23610 give extra options to hsc2hs
23611
23612 --hscolour-options OPTS
23613 give extra options to hscolour
23614
23615 --jhc-options OPTS
23616 give extra options to jhc
23617
23618 --ld-options OPTS
23619 give extra options to ld
23620
23621 --pkg-config-options OPTS
23622 give extra options to pkg-config
23623
23624 --runghc-options OPTS
23625 give extra options to runghc
23626
23627 --strip-options OPTS
23628 give extra options to strip
23629
23630 --tar-options OPTS
23631 give extra options to tar
23632
23633 --uhc-options OPTS
23634 give extra options to uhc
23635
23636 --cabal-lib-version VERSION
23637 Select which version of the Cabal lib to use to build
23638 packages (useful for testing).
23639
23640 --constraint CONSTRAINT
23641 Specify constraints on a package (version,
23642 installed/source, flags)
23643
23644 --preference CONSTRAINT
23645 Specify preferences (soft constraints) on the version of
23646 a package
23647
23648 --solver SOLVER
23649 Select dependency solver to use (default: modular).
23650 Choices: modular.
23651
23652 --allow-older [DEPS]
23653 Ignore lower bounds in all dependencies or DEPS
23654
23655 --allow-newer [DEPS]
23656 Ignore upper bounds in all dependencies or DEPS
23657
23658 --write-ghc-environment-files always|never|ghc8.4.4+
23659 Whether to create a .ghc.environment file after a suc‐
23660 cessful build (v2-build only)
23661
23662
23663 cabal v1-reconfigure
23664
23665 Usage: cabal v1-reconfigure [FLAGS]
23666
23667
23668 Run `configure` with the most recently used flags, or append FLAGS to
23669 the most recently used configuration. Accepts the same flags as `cabal
23670 v1-configure'. If the package has never been configured, the default
23671 flags are used.
23672
23673
23674 Examples:
23675 cabal v1-reconfigure
23676 Configure with the most recently used flags.
23677 cabal v1-reconfigure -w PATH
23678 Reconfigure with the most recently used flags,
23679 but use the compiler at PATH.
23680
23681
23682 The v1-reconfigure command is a part of the legacy v1 style of cabal
23683 usage.
23684
23685 It is a legacy feature and will be removed in a future release of
23686 cabal-install. Please file a bug if you cannot replicate a working v1-
23687 use case with the new-style commands.
23688
23689 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
23690
23691
23692 Flags:
23693 -v, --verbose [n]
23694 Control verbosity (n is 0--3, default verbosity level is
23695 1)
23696
23697 --builddir, --distdir, --distpref DIR
23698 The directory where Cabal puts generated build files
23699 (default dist)
23700
23701 -g, --ghc
23702 compile with GHC
23703
23704 --ghcjs
23705 compile with GHCJS
23706
23707 --uhc
23708 compile with UHC
23709
23710 --haskell-suite
23711 compile with a haskell-suite compiler
23712
23713 --cabal-file PATH
23714 use this Cabal file
23715
23716 -w, --with-compiler PATH
23717 give the path to a particular compiler
23718
23719 --with-hc-pkg PATH
23720 give the path to the package tool
23721
23722 --prefix DIR
23723 bake this prefix in preparation of installation
23724
23725 --bindir DIR
23726 installation directory for executables
23727
23728 --libdir DIR
23729 installation directory for libraries
23730
23731 --libsubdir DIR
23732 subdirectory of libdir in which libs are installed
23733
23734 --dynlibdir DIR
23735 installation directory for dynamic libraries
23736
23737 --libexecdir DIR
23738 installation directory for program executables
23739
23740 --libexecsubdir DIR
23741 subdirectory of libexecdir in which private executables
23742 are installed
23743
23744 --datadir DIR
23745 installation directory for read-only data
23746
23747 --datasubdir DIR
23748 subdirectory of datadir in which data files are installed
23749
23750 --docdir DIR
23751 installation directory for documentation
23752
23753 --htmldir DIR
23754 installation directory for HTML documentation
23755
23756 --haddockdir DIR
23757 installation directory for haddock interfaces
23758
23759 --sysconfdir DIR
23760 installation directory for configuration files
23761
23762 --program-prefix PREFIX
23763 prefix to be applied to installed executables
23764
23765 --program-suffix SUFFIX
23766 suffix to be applied to installed executables
23767
23768 --enable-library-vanilla
23769 --disable-library-vanilla
23770 Vanilla libraries
23771
23772 -p, --enable-library-profiling
23773 --disable-library-profiling
23774 Library profiling
23775
23776 --enable-shared
23777 --disable-shared
23778 Shared library
23779
23780 --enable-static
23781 --disable-static
23782 Static library
23783
23784 --enable-executable-dynamic
23785 --disable-executable-dynamic
23786 Executable dynamic linking
23787
23788 --enable-profiling
23789 --disable-profiling
23790 Executable and library profiling
23791
23792 --enable-executable-profiling
23793 --disable-executable-profiling
23794 Executable profiling (DEPRECATED)
23795
23796 --profiling-detail level
23797 Profiling detail level for executable and library
23798 (default, none, exported-functions, toplevel-functions,
23799 all-functions).
23800
23801 --library-profiling-detail level
23802 Profiling detail level for libraries only.
23803
23804 -O, --enable-optimization, --enable-optimisation [n]
23805 Build with optimization (n is 0--2, default is 1)
23806
23807 --disable-optimization, --disable-optimisation
23808 Build without optimization
23809
23810 --enable-debug-info [n]
23811 Emit debug info (n is 0--3, default is 0)
23812
23813 --disable-debug-info
23814 Don't emit debug info
23815
23816 --enable-library-for-ghci
23817 --disable-library-for-ghci
23818 compile library for use with GHCi
23819
23820 --enable-split-sections
23821 --disable-split-sections
23822 compile library code such that unneeded definitions can
23823 be dropped from the final executable (GHC 7.8+)
23824
23825 --enable-split-objs
23826 --disable-split-objs
23827 split library into smaller objects to reduce binary sizes
23828 (GHC 6.6+)
23829
23830 --enable-executable-stripping
23831 --disable-executable-stripping
23832 strip executables upon installation to reduce binary
23833 sizes
23834
23835 --enable-library-stripping
23836 --disable-library-stripping
23837 strip libraries upon installation to reduce binary sizes
23838
23839 --configure-option OPT
23840 Extra option for configure
23841
23842 --user
23843 --global
23844 doing a per-user installation
23845
23846 --package-db DB
23847 Append the given package database to the list of package
23848 databases used (to satisfy dependencies and register
23849 into). May be a specific file, 'global' or 'user'. The
23850 initial list is ['global'], ['global', 'user'], or
23851 ['global', $sandbox], depending on context. Use 'clear'
23852 to reset the list to empty. See the user guide for
23853 details.
23854
23855 -f, --flags FLAGS
23856 Force values for the given flags in Cabal conditionals in
23857 the .cabal file. E.g., --flags="debug -usebytestrings"
23858 forces the flag "debug" to true and "usebytestrings" to
23859 false.
23860
23861 --extra-include-dirs PATH
23862 A list of directories to search for header files
23863
23864 --enable-deterministic
23865 --disable-deterministic
23866 Try to be as deterministic as possible (used by the test
23867 suite)
23868
23869 --ipid IPID
23870 Installed package ID to compile this package as
23871
23872 --cid CID
23873 Installed component ID to compile this component as
23874
23875 --extra-lib-dirs PATH
23876 A list of directories to search for external libraries
23877
23878 --extra-framework-dirs PATH
23879 A list of directories to search for external frameworks
23880 (OS X only)
23881
23882 --extra-prog-path PATH
23883 A list of directories to search for required programs (in
23884 addition to the normal search locations)
23885
23886 --instantiate-with NAME=MOD
23887 A mapping of signature names to concrete module instanti‐
23888 ations.
23889
23890 --enable-tests
23891 --disable-tests
23892 dependency checking and compilation for test suites
23893 listed in the package description file.
23894
23895 --enable-coverage
23896 --disable-coverage
23897 build package with Haskell Program Coverage. (GHC only)
23898
23899 --enable-library-coverage
23900 --disable-library-coverage
23901 build package with Haskell Program Coverage. (GHC only)
23902 (DEPRECATED)
23903
23904 --enable-benchmarks
23905 --disable-benchmarks
23906 dependency checking and compilation for benchmarks listed
23907 in the package description file.
23908
23909 --enable-relocatable
23910 --disable-relocatable
23911 building a package that is relocatable. (GHC only)
23912
23913 --disable-response-files
23914 enable workaround for old versions of programs like "ar"
23915 that do not support @file arguments
23916
23917 --with-alex PATH
23918 give the path to alex
23919
23920 --with-ar PATH
23921 give the path to ar
23922
23923 --with-c2hs PATH
23924 give the path to c2hs
23925
23926 --with-cpphs PATH
23927 give the path to cpphs
23928
23929 --with-doctest PATH
23930 give the path to doctest
23931
23932 --with-gcc PATH
23933 give the path to gcc
23934
23935 --with-ghc PATH
23936 give the path to ghc
23937
23938 --with-ghc-pkg PATH
23939 give the path to ghc-pkg
23940
23941 --with-ghcjs PATH
23942 give the path to ghcjs
23943
23944 --with-ghcjs-pkg PATH
23945 give the path to ghcjs-pkg
23946
23947 --with-greencard PATH
23948 give the path to greencard
23949
23950 --with-haddock PATH
23951 give the path to haddock
23952
23953 --with-happy PATH
23954 give the path to happy
23955
23956 --with-haskell-suite PATH
23957 give the path to haskell-suite
23958
23959 --with-haskell-suite-pkg PATH
23960 give the path to haskell-suite-pkg
23961
23962 --with-hmake PATH
23963 give the path to hmake
23964
23965 --with-hpc PATH
23966 give the path to hpc
23967
23968 --with-hsc2hs PATH
23969 give the path to hsc2hs
23970
23971 --with-hscolour PATH
23972 give the path to hscolour
23973
23974 --with-jhc PATH
23975 give the path to jhc
23976
23977 --with-ld PATH
23978 give the path to ld
23979
23980 --with-pkg-config PATH
23981 give the path to pkg-config
23982
23983 --with-runghc PATH
23984 give the path to runghc
23985
23986 --with-strip PATH
23987 give the path to strip
23988
23989 --with-tar PATH
23990 give the path to tar
23991
23992 --with-uhc PATH
23993 give the path to uhc
23994
23995 --alex-option OPT
23996 give an extra option to alex (no need to quote options
23997 containing spaces)
23998
23999 --ar-option OPT
24000 give an extra option to ar (no need to quote options con‐
24001 taining spaces)
24002
24003 --c2hs-option OPT
24004 give an extra option to c2hs (no need to quote options
24005 containing spaces)
24006
24007 --cpphs-option OPT
24008 give an extra option to cpphs (no need to quote options
24009 containing spaces)
24010
24011 --doctest-option OPT
24012 give an extra option to doctest (no need to quote options
24013 containing spaces)
24014
24015 --gcc-option OPT
24016 give an extra option to gcc (no need to quote options
24017 containing spaces)
24018
24019 --ghc-option OPT
24020 give an extra option to ghc (no need to quote options
24021 containing spaces)
24022
24023 --ghc-pkg-option OPT
24024 give an extra option to ghc-pkg (no need to quote options
24025 containing spaces)
24026
24027 --ghcjs-option OPT
24028 give an extra option to ghcjs (no need to quote options
24029 containing spaces)
24030
24031 --ghcjs-pkg-option OPT
24032 give an extra option to ghcjs-pkg (no need to quote
24033 options containing spaces)
24034
24035 --greencard-option OPT
24036 give an extra option to greencard (no need to quote
24037 options containing spaces)
24038
24039 --haddock-option OPT
24040 give an extra option to haddock (no need to quote options
24041 containing spaces)
24042
24043 --happy-option OPT
24044 give an extra option to happy (no need to quote options
24045 containing spaces)
24046
24047 --haskell-suite-option OPT
24048 give an extra option to haskell-suite (no need to quote
24049 options containing spaces)
24050
24051 --haskell-suite-pkg-option OPT
24052 give an extra option to haskell-suite-pkg (no need to
24053 quote options containing spaces)
24054
24055 --hmake-option OPT
24056 give an extra option to hmake (no need to quote options
24057 containing spaces)
24058
24059 --hpc-option OPT
24060 give an extra option to hpc (no need to quote options
24061 containing spaces)
24062
24063 --hsc2hs-option OPT
24064 give an extra option to hsc2hs (no need to quote options
24065 containing spaces)
24066
24067 --hscolour-option OPT
24068 give an extra option to hscolour (no need to quote
24069 options containing spaces)
24070
24071 --jhc-option OPT
24072 give an extra option to jhc (no need to quote options
24073 containing spaces)
24074
24075 --ld-option OPT
24076 give an extra option to ld (no need to quote options con‐
24077 taining spaces)
24078
24079 --pkg-config-option OPT
24080 give an extra option to pkg-config (no need to quote
24081 options containing spaces)
24082
24083 --runghc-option OPT
24084 give an extra option to runghc (no need to quote options
24085 containing spaces)
24086
24087 --strip-option OPT
24088 give an extra option to strip (no need to quote options
24089 containing spaces)
24090
24091 --tar-option OPT
24092 give an extra option to tar (no need to quote options
24093 containing spaces)
24094
24095 --uhc-option OPT
24096 give an extra option to uhc (no need to quote options
24097 containing spaces)
24098
24099 --alex-options OPTS
24100 give extra options to alex
24101
24102 --ar-options OPTS
24103 give extra options to ar
24104
24105 --c2hs-options OPTS
24106 give extra options to c2hs
24107
24108 --cpphs-options OPTS
24109 give extra options to cpphs
24110
24111 --doctest-options OPTS
24112 give extra options to doctest
24113
24114 --gcc-options OPTS
24115 give extra options to gcc
24116
24117 --ghc-options OPTS
24118 give extra options to ghc
24119
24120 --ghc-pkg-options OPTS
24121 give extra options to ghc-pkg
24122
24123 --ghcjs-options OPTS
24124 give extra options to ghcjs
24125
24126 --ghcjs-pkg-options OPTS
24127 give extra options to ghcjs-pkg
24128
24129 --greencard-options OPTS
24130 give extra options to greencard
24131
24132 --haddock-options OPTS
24133 give extra options to haddock
24134
24135 --happy-options OPTS
24136 give extra options to happy
24137
24138 --haskell-suite-options OPTS
24139 give extra options to haskell-suite
24140
24141 --haskell-suite-pkg-options OPTS
24142 give extra options to haskell-suite-pkg
24143
24144 --hmake-options OPTS
24145 give extra options to hmake
24146
24147 --hpc-options OPTS
24148 give extra options to hpc
24149
24150 --hsc2hs-options OPTS
24151 give extra options to hsc2hs
24152
24153 --hscolour-options OPTS
24154 give extra options to hscolour
24155
24156 --jhc-options OPTS
24157 give extra options to jhc
24158
24159 --ld-options OPTS
24160 give extra options to ld
24161
24162 --pkg-config-options OPTS
24163 give extra options to pkg-config
24164
24165 --runghc-options OPTS
24166 give extra options to runghc
24167
24168 --strip-options OPTS
24169 give extra options to strip
24170
24171 --tar-options OPTS
24172 give extra options to tar
24173
24174 --uhc-options OPTS
24175 give extra options to uhc
24176
24177 --cabal-lib-version VERSION
24178 Select which version of the Cabal lib to use to build
24179 packages (useful for testing).
24180
24181 --constraint CONSTRAINT
24182 Specify constraints on a package (version,
24183 installed/source, flags)
24184
24185 --preference CONSTRAINT
24186 Specify preferences (soft constraints) on the version of
24187 a package
24188
24189 --solver SOLVER
24190 Select dependency solver to use (default: modular).
24191 Choices: modular.
24192
24193 --allow-older [DEPS]
24194 Ignore lower bounds in all dependencies or DEPS
24195
24196 --allow-newer [DEPS]
24197 Ignore upper bounds in all dependencies or DEPS
24198
24199 --write-ghc-environment-files always|never|ghc8.4.4+
24200 Whether to create a .ghc.environment file after a suc‐
24201 cessful build (v2-build only)
24202
24203
24204 cabal sandbox
24205
24206 Usage: cabal sandbox init [FLAGS]
24207 or: cabal sandbox delete [FLAGS]
24208 or: cabal sandbox add-source [FLAGS] PATHS
24209 or: cabal sandbox delete-source [FLAGS] PATHS
24210 or: cabal sandbox list-sources [FLAGS]
24211 or: cabal sandbox hc-pkg [FLAGS] [--] COMMAND [--] [ARGS]
24212
24213
24214 Sandboxes are isolated package databases that can be used to prevent
24215 dependency conflicts that arise when many different packages are
24216 installed in the same database (i.e. the user's database in the home
24217 directory).
24218
24219 A sandbox in the current directory (created by `sandbox init`) will be
24220 used instead of the user's database for commands such as `install` and
24221 `build`. Note that (a directly invoked) GHC will not automatically be
24222 aware of sandboxes; only if called via appropriate cabal commands, e.g.
24223 `repl`, `build`, `exec`.
24224
24225 Currently, cabal will not search for a sandbox in folders above the
24226 current one, so cabal will not see the sandbox if you are in a sub‐
24227 folder of a sandbox.
24228
24229 Subcommands:
24230
24231 init:
24232 Initialize a sandbox in the current directory. An existing package
24233 database
24234 will not be modified, but settings (such as the location of the data‐
24235 base)
24236 can be modified this way.
24237
24238 delete:
24239 Remove the sandbox; deleting all the packages installed inside.
24240
24241 add-source:
24242 Make one or more local packages available in the sandbox. PATHS may
24243 be
24244 relative or absolute. Typical usecase is when you need to make a
24245 (temporary)
24246 modification to a dependency: You download the package into a differ‐
24247 ent
24248 directory, make the modification, and add that directory to the sand‐
24249 box with
24250 `add-source`.
24251
24252 Unless given `--snapshot`, any add-source'd dependency that was modi‐
24253 fied
24254 since the last build will be re-installed automatically.
24255
24256 delete-source:
24257 Remove an add-source dependency; however, this will not delete the
24258 package(s) that have been installed in the sandbox from this depen‐
24259 dency. You
24260 can either unregister the package(s) via `cabal sandbox hc-pkg
24261 unregister` or re-create the sandbox (`sandbox delete; sandbox
24262 init`).
24263
24264 list-sources:
24265 List the directories of local packages made available via `cabal
24266 sandbox
24267 add-source`.
24268
24269 hc-pkg:
24270 Similar to `ghc-pkg`, but for the sandbox package database. Can be
24271 used to
24272 list specific/all packages that are installed in the sandbox. For
24273 subcommands, see the help for ghc-pkg. Affected by the compiler ver‐
24274 sion
24275 specified by `configure`.
24276
24277
24278
24279 Relevant global configuration keys:
24280 require-sandbox
24281 ignore-sandbox
24282
24283 Examples:
24284 Set up a sandbox with one local dependency, located at ../foo:
24285 cabal sandbox init
24286 cabal sandbox add-source ../foo
24287 cabal install --only-dependencies
24288 Reset the sandbox:
24289 cabal sandbox delete
24290 cabal sandbox init
24291 cabal install --only-dependencies
24292 List the packages in the sandbox:
24293 cabal sandbox hc-pkg list
24294 Unregister the `broken` package from the sandbox:
24295 cabal sandbox hc-pkg -- --force unregister broken
24296
24297 The sandbox command is a part of the legacy v1 style of cabal usage.
24298
24299 Please switch to using either the new project style and the new-sandbox
24300 command or the legacy v1-sandbox alias as new-style projects will
24301 become the default in the next version of cabal-install. Please file a
24302 bug if you cannot replicate a working v1- use case with the new-style
24303 commands.
24304
24305 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
24306
24307
24308 Flags:
24309 -v, --verbose [n]
24310 Control verbosity (n is 0--3, default verbosity level is
24311 1)
24312
24313 --snapshot
24314 Take a snapshot instead of creating a link (only applies
24315 to 'add-source')
24316
24317 --sandbox DIR
24318 Sandbox location (default: './.cabal-sandbox').
24319
24320
24321 cabal v1-sandbox
24322
24323 Usage: cabal v1-sandbox init [FLAGS]
24324 or: cabal v1-sandbox delete [FLAGS]
24325 or: cabal v1-sandbox add-source [FLAGS] PATHS
24326 or: cabal v1-sandbox delete-source [FLAGS] PATHS
24327 or: cabal v1-sandbox list-sources [FLAGS]
24328 or: cabal v1-sandbox hc-pkg [FLAGS] [--] COMMAND [--] [ARGS]
24329
24330
24331 Sandboxes are isolated package databases that can be used to prevent
24332 dependency conflicts that arise when many different packages are
24333 installed in the same database (i.e. the user's database in the home
24334 directory).
24335
24336 A sandbox in the current directory (created by `v1-sandbox init`) will
24337 be used instead of the user's database for commands such as
24338 `v1-install` and `v1-build`. Note that (a directly invoked) GHC will
24339 not automatically be aware of sandboxes; only if called via appropriate
24340 cabal commands, e.g. `v1-repl`, `v1-build`, `v1-exec`.
24341
24342 Currently, cabal will not search for a sandbox in folders above the
24343 current one, so cabal will not see the sandbox if you are in a sub‐
24344 folder of a sandbox.
24345
24346 Subcommands:
24347
24348 init:
24349 Initialize a sandbox in the current directory. An existing package
24350 database
24351 will not be modified, but settings (such as the location of the data‐
24352 base)
24353 can be modified this way.
24354
24355 delete:
24356 Remove the sandbox; deleting all the packages installed inside.
24357
24358 add-source:
24359 Make one or more local packages available in the sandbox. PATHS may
24360 be
24361 relative or absolute. Typical usecase is when you need to make a
24362 (temporary)
24363 modification to a dependency: You download the package into a differ‐
24364 ent
24365 directory, make the modification, and add that directory to the sand‐
24366 box with
24367 `add-source`.
24368
24369 Unless given `--snapshot`, any add-source'd dependency that was modi‐
24370 fied
24371 since the last build will be re-installed automatically.
24372
24373 delete-source:
24374 Remove an add-source dependency; however, this will not delete the
24375 package(s) that have been installed in the sandbox from this depen‐
24376 dency. You
24377 can either unregister the package(s) via `cabal v1-sandbox hc-pkg
24378 unregister` or re-create the sandbox (`v1-sandbox delete; v1-sandbox
24379 init`).
24380
24381 list-sources:
24382 List the directories of local packages made available via `cabal
24383 v1-sandbox
24384 add-source`.
24385
24386 hc-pkg:
24387 Similar to `ghc-pkg`, but for the sandbox package database. Can be
24388 used to
24389 list specific/all packages that are installed in the sandbox. For
24390 subcommands, see the help for ghc-pkg. Affected by the compiler ver‐
24391 sion
24392 specified by `v1-configure`.
24393
24394
24395
24396 Relevant global configuration keys:
24397 require-sandbox
24398 ignore-sandbox
24399
24400 Examples:
24401 Set up a sandbox with one local dependency, located at ../foo:
24402 cabal v1-sandbox init
24403 cabal v1-sandbox add-source ../foo
24404 cabal v1-install --only-dependencies
24405 Reset the sandbox:
24406 cabal v1-sandbox delete
24407 cabal v1-sandbox init
24408 cabal v1-install --only-dependencies
24409 List the packages in the sandbox:
24410 cabal v1-sandbox hc-pkg list
24411 Unregister the `broken` package from the sandbox:
24412 cabal v1-sandbox hc-pkg -- --force unregister broken
24413
24414 The v1-sandbox command is a part of the legacy v1 style of cabal usage.
24415
24416 It is a legacy feature and will be removed in a future release of
24417 cabal-install. Please file a bug if you cannot replicate a working v1-
24418 use case with the new-style commands.
24419
24420 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
24421
24422
24423 Flags:
24424 -v, --verbose [n]
24425 Control verbosity (n is 0--3, default verbosity level is
24426 1)
24427
24428 --snapshot
24429 Take a snapshot instead of creating a link (only applies
24430 to 'add-source')
24431
24432 --sandbox DIR
24433 Sandbox location (default: './.cabal-sandbox').
24434
24435
24436
24438 ~/.cabal/config
24439 The defaults that can be overridden with command-line options.
24440
24441 ~/.cabal/world
24442 A list of all packages whose installation has been explicitly
24443 requested.
24444
24445
24447 To browse the list of known issues or report a new one please see
24448 https://github.com/haskell/cabal/labels/cabal-install.
24449
24450
24451
24452
24453 CABAL(1)