1CABAL(1) General Commands Manual CABAL(1)
2
6 cabal - a system for building and packaging Haskell libraries and pro‐
7 grams
8
10 cabal command <arguments|[options]>...
11 Where the commands are
13 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.
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 configure - Add extra project configuration
28 cabal new-configure - Add extra project configuration
29 cabal v2-configure - Add extra project configuration
30 cabal update - Updates list of known packages.
31 cabal new-update - Updates list of known packages.
32 cabal v2-update - Updates list of known packages.
33 cabal build - Compile targets within the project.
34 cabal new-build - Compile targets within the project.
35 cabal v2-build - Compile targets within the project.
36 cabal repl - Open an interactive session for the given component.
37 cabal new-repl - Open an interactive session for the given component.
38 cabal v2-repl - Open an interactive session for the given component.
39 cabal freeze - Freeze dependencies.
40 cabal new-freeze - Freeze dependencies.
41 cabal v2-freeze - Freeze dependencies.
42 cabal haddock - Build Haddock documentation
43 cabal new-haddock - Build Haddock documentation
44 cabal v2-haddock - Build Haddock documentation
45 cabal install - Install packages.
46 cabal new-install - Install packages.
47 cabal v2-install - Install packages.
48 cabal run - Run an executable.
49 cabal new-run - Run an executable.
50 cabal v2-run - Run an executable.
51 cabal test - Run test-suites
52 cabal new-test - Run test-suites
53 cabal v2-test - Run test-suites
54 cabal bench - Run benchmarks
55 cabal new-bench - Run benchmarks
56 cabal v2-bench - Run benchmarks
57 cabal exec - Give a command access to the store.
58 cabal new-exec - Give a command access to the store.
59 cabal v2-exec - Give a command access to the store.
60 cabal clean - Clean the package store and remove temporary files.
61 cabal new-clean - Clean the package store and remove temporary files.
62 cabal v2-clean - Clean the package store and remove temporary files.
63 cabal sdist - Generate a source distribution file (.tar.gz).
64 cabal new-sdist - Generate a source distribution file (.tar.gz).
65 cabal v2-sdist - Generate a source distribution file (.tar.gz).
66 cabal v1-configure - Prepare to build the package.
67 cabal v1-update - Updates list of known packages.
68 cabal v1-build - Compile all/specific components.
69 cabal v1-repl - Open an interpreter session for the given component.
70 cabal v1-freeze - Freeze dependencies.
71 cabal v1-haddock - Generate Haddock HTML documentation.
72 cabal v1-install - Install packages.
73 cabal v1-run - Builds and runs an executable.
74 cabal v1-test - Run all/specific tests in the test suite.
75 cabal v1-bench - Run all/specific benchmarks.
76 cabal v1-exec - Give a command access to the sandbox package reposi‐
77 tory.
78 cabal v1-clean - Clean up after a build.
79 cabal v1-sdist - Generate a source distribution file (.tar.gz).
80 cabal v1-doctest - Run doctest tests.
81 cabal v1-copy - Copy the files of all/specific components to install
82 locations.
83 cabal v1-register - Register this package with the compiler.
84 cabal v1-reconfigure - Reconfigure the package if necessary.
85 cabal v1-sandbox - Create/modify/delete a sandbox.
86
88 Cabal is the standard package system for Haskell software. It helps
89 people to configure, build and install Haskell software and to distrib‐
90 ute it easily to other users and developers.
91 The command line cabal tool (also referred to as cabal-install) helps
93 with installing existing packages and developing new packages. It can
94 be used to work with local packages or to install packages from online
95 package archives, including automatically installing dependencies. By
96 default it is configured to use Hackage, which is Haskell's central
97 package archive that contains thousands of libraries and applications
98 in the Cabal package format.
99
101 Global options:
102 -V, --version
104 Print version information
105 --numeric-version
107 Print just the version number
108 --config-file FILE
110 Set an alternate location for the config file
111 --sandbox-config-file FILE
113 Set an alternate location for the sandbox config file (default:
114 './cabal.sandbox.config')
115 --default-user-config FILE
117 Set a location for a cabal.config file for projects without
118 their own cabal.config freeze file.
119 --require-sandbox
121 --no-require-sandbox
122 requiring the presence of a sandbox for sandbox-aware commands
123 --ignore-sandbox
125 Ignore any existing sandbox
126 --ignore-expiry
128 Ignore expiry dates on signed metadata (use only in exceptional
129 circumstances)
130 --http-transport HttpTransport
132 Set a transport for http(s) requests. Accepts 'curl', 'wget',
133 'powershell', and 'plain-http'. (default: 'curl')
134 --enable-nix
136 --disable-nix
137 Nix integration: run commands through nix-shell if a 'shell.nix'
138 file exists
139 --remote-repo NAME:URL
141 The name and url for a remote repository
142 --local-no-index-repo NAME:PATH
144 The name and a path for a local no-index repository
145 --remote-repo-cache DIR
147 The location where downloads from all remote repos are cached
148 --local-repo DIR
150 The location of a local repository
151 --logs-dir, --logsdir DIR
153 The location to put log files
154 --world-file FILE
156 The location of the world file
157 --store-dir, --storedir DIR
159 The location of the nix-local-build store
160
163 cabal list
164 Usage: cabal list [FLAGS]
166 or: cabal list [FLAGS] STRINGS
167 List all packages, or all packages matching one of the search strings.
170 If there is a sandbox in the current directory and config:ignore-sand‐
172 box is False, use the sandbox package database. Otherwise, use the
173 package database specified with --package-db. If not specified, use the
174 user package database.
175 Examples:
178 cabal list pandoc
179 Will find pandoc, pandoc-citeproc, pandoc-lens, ...
180 Flags:
183 -v, --verbose [n]
184 Control verbosity (n is 0--3, default verbosity level is
185 1)
186 --installed
188 Only print installed packages
189 --simple-output
191 Print in a easy-to-parse format
192 --package-db DB
194 Append the given package database to the list of package
195 databases used (to satisfy dependencies and register
196 into). May be a specific file, 'global' or 'user'. The
197 initial list is ['global'], ['global', 'user'], or
198 ['global', $sandbox], depending on context. Use 'clear'
199 to reset the list to empty. See the user guide for de‐
200 tails.
201 cabal info
204 Usage: cabal info [FLAGS] PACKAGES
206 If there is a sandbox in the current directory and config:ignore-sand‐
209 box is False, use the sandbox package database. Otherwise, use the
210 package database specified with --package-db. If not specified, use the
211 user package database.
212 Flags:
215 -v, --verbose [n]
216 Control verbosity (n is 0--3, default verbosity level is
217 1)
218 --package-db DB
220 Append the given package database to the list of package
221 databases used (to satisfy dependencies and register
222 into). May be a specific file, 'global' or 'user'. The
223 initial list is ['global'], ['global', 'user'], or
224 ['global', $sandbox], depending on context. Use 'clear'
225 to reset the list to empty. See the user guide for de‐
226 tails.
227 cabal fetch
230 Usage: cabal fetch [FLAGS] PACKAGES
232 Note that it currently is not possible to fetch the dependencies for a
235 package in the current directory.
236 Flags:
239 -v, --verbose [n]
240 Control verbosity (n is 0--3, default verbosity level is
241 1)
242 --dependencies, --deps
244 Resolve and fetch dependencies (default)
245 --no-dependencies, --no-deps
247 Ignore dependencies
248 --dry-run
250 Do not install anything, only print what would be in‐
251 stalled.
252 --enable-tests
254 --disable-tests
255 dependency checking and compilation for test suites
256 listed in the package description file.
257 --enable-benchmarks
259 --disable-benchmarks
260 dependency checking and compilation for benchmarks listed
261 in the package description file.
262 --solver SOLVER
264 Select dependency solver to use (default: modular).
265 Choices: modular.
266 --max-backjumps NUM
268 Maximum number of backjumps allowed while solving (de‐
269 fault: 4000). Use a negative number to enable unlimited
270 backtracking. Use 0 to disable backtracking completely.
271 --reorder-goals
273 --no-reorder-goals
274 Try to reorder goals according to certain heuristics.
275 Slows things down on average, but may make backtracking
276 faster for some packages.
277 --count-conflicts
279 --no-count-conflicts
280 Try to speed up solving by preferring goals that are in‐
281 volved in a lot of conflicts (default).
282 --fine-grained-conflicts
284 --no-fine-grained-conflicts
285 Skip a version of a package if it does not resolve the
286 conflicts encountered in the last version, as a solver
287 optimization (default).
288 --minimize-conflict-set
290 --no-minimize-conflict-set
291 When there is no solution, try to improve the error mes‐
292 sage by finding a minimal conflict set (default: false).
293 May increase run time significantly.
294 --independent-goals
296 --no-independent-goals
297 Treat several goals on the command line as independent.
298 If several goals depend on the same package, different
299 versions can be chosen.
300 --shadow-installed-packages
302 --no-shadow-installed-packages
303 If multiple package instances of the same version are in‐
304 stalled, treat all but one as shadowed.
305 --strong-flags
307 --no-strong-flags
308 Do not defer flag choices (this used to be the default in
309 cabal-install <= 1.20).
310 --allow-boot-library-installs
312 --no-allow-boot-library-installs
313 Allow cabal to install base, ghc-prim, integer-simple,
314 integer-gmp, and template-haskell.
315 --reject-unconstrained-dependencies none|all
317 Require these packages to have constraints on them if
318 they are to be selected (default: none).
319 cabal get
322 Usage: cabal get [PACKAGES]
324 Creates a local copy of a package's source code. By default it gets the
327 source tarball and unpacks it in a local subdirectory. Alternatively,
328 with -s it will get the code from the source repository specified by
329 the package.
330 Examples:
333 cabal get hlint
334 Download the latest stable version of hlint;
335 cabal get lens --source-repository=head
336 Download the source repository (i.e. git clone from github).
337 Flags:
340 -v, --verbose [n]
341 Control verbosity (n is 0--3, default verbosity level is
342 1)
343 -d, --destdir PATH
345 Where to place the package source, defaults to the cur‐
346 rent directory.
347 -s, --source-repository [[head|this|...]]
349 Copy the package's source repository (ie git clone, darcs
350 get, etc as appropriate).
351 --index-state STATE
353 Use source package index state as it existed at a previ‐
354 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
355 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
356 'HEAD' (default: 'HEAD'). This determines which package
357 versions are available as well as .cabal file revision is
358 selected (unless --pristine is used).
359 --pristine
361 Unpack the original pristine tarball, rather than updat‐
362 ing the .cabal file with the latest revision from the
363 package archive.
364 cabal check
367 Usage: cabal check [FLAGS]
369 Expects a .cabal package file in the current directory.
372 The checks correspond to the requirements to packages on Hackage. If no
374 errors and warnings are reported, Hackage will accept this package.
375 Flags:
378 -v, --verbose [n]
379 Control verbosity (n is 0--3, default verbosity level is
380 1)
381 cabal upload
384 Usage: cabal upload [FLAGS] TARFILES
386 You can store your Hackage login in the ~/.cabal/config file Relevant
389 global configuration keys:
390 username
391 password
392 Flags:
395 -v, --verbose [n]
396 Control verbosity (n is 0--3, default verbosity level is
397 1)
398 --publish
400 Publish the package instead of uploading it as a candi‐
401 date.
402 -d, --documentation
404 Upload documentation instead of a source package. By de‐
405 fault, this uploads documentation for a package candi‐
406 date. To upload documentation for a published package,
407 combine with --publish.
408 -u, --username USERNAME
410 Hackage username.
411 -p, --password PASSWORD
413 Hackage password.
414 -P, --password-command PASSWORD
416 Command to get Hackage password.
417 cabal report
420 Usage: cabal report [FLAGS]
422 You can store your Hackage login in the ~/.cabal/config file
425 Flags:
428 -v, --verbose [n]
429 Control verbosity (n is 0--3, default verbosity level is
430 1)
431 -u, --username USERNAME
433 Hackage username.
434 -p, --password PASSWORD
436 Hackage password.
437 cabal init
440 Usage: cabal init [FLAGS]
442 Create a .cabal, Setup.hs, and optionally a LICENSE file.
445 Calling init with no arguments creates an executable, guessing as many
447 options as possible. The interactive mode can be invoked by the
448 -i/--interactive flag, which will try to guess as much as possible and
449 prompt you for the rest. You can change init to always be interactive
450 by setting the interactive flag in your configuration file. Command-
451 line arguments are provided for scripting purposes.
452 Flags:
455 -i, --interactive
456 -n, --non-interactive
457 interactive mode.
458 -q, --quiet
460 Do not generate log messages to stdout.
461 --no-comments
463 Do not generate explanatory comments in the .cabal file.
464 -m, --minimal
466 Generate a minimal .cabal file, that is, do not include
467 extra empty fields. Also implies --no-comments.
468 --overwrite
470 Overwrite any existing .cabal, LICENSE, or Setup.hs files
471 without warning.
472 --package-dir, --packagedir DIRECTORY
474 Root directory of the package (default = current direc‐
475 tory).
476 -p, --package-name PACKAGE
478 Name of the Cabal package to create.
479 --version VERSION
481 Initial version of the package.
482 --cabal-version VERSION_RANGE
484 Version of the Cabal specification.
485 -l, --license LICENSE
487 Project license.
488 -a, --author NAME
490 Name of the project's author.
491 -e, --email EMAIL
493 Email address of the maintainer.
494 -u, --homepage URL
496 Project homepage and/or repository.
497 -s, --synopsis TEXT
499 Short project synopsis.
500 -c, --category CATEGORY
502 Project category.
503 -x, --extra-source-file FILE
505 Extra source file to be distributed with tarball.
506 --lib, --is-library
508 Build a library.
509 --exe, --is-executable
511 Build an executable.
512 --libandexe, --is-libandexe
514 Build a library and an executable.
515 --tests
517 Generate a test suite for the library.
518 --test-dir DIR
520 Directory containing tests.
521 --simple
523 Create a simple project with sensible defaults.
524 --main-is FILE
526 Specify the main module.
527 --language LANGUAGE
529 Specify the default language.
530 -o, --expose-module MODULE
532 Export a module from the package.
533 --extension EXTENSION
535 Use a LANGUAGE extension (in the other-extensions field).
536 -d, --dependency PACKAGE
538 Package dependency.
539 --application-dir DIR
541 Directory containing package application executable.
542 --source-dir, --sourcedir DIR
544 Directory containing package library source.
545 --build-tool TOOL
547 Required external build tool.
548 -w, --with-compiler PATH
550 give the path to a particular compiler
551 -v, --verbose [n]
553 Control verbosity (n is 0--3, default verbosity level is
554 1)
555 cabal user-config
558 Usage: cabal user-config init
560 or: cabal user-config diff
561 or: cabal user-config update
562 When upgrading cabal, the set of configuration keys and their default
565 values may change. This command provides means to merge the existing
566 config in ~/.cabal/config (i.e. all bindings that are actually defined
567 and not commented out) and the default config of the new version.
568 init: Creates a new config file at either ~/.cabal/config or as speci‐
570 fied by --config-file, if given. An existing file won't be overwritten
571 unless -f or --force is given. diff: Shows a pseudo-diff of the user's
572 ~/.cabal/config file and the default configuration that would be cre‐
573 ated by cabal if the config file did not exist. update: Applies the
574 pseudo-diff to the configuration that would be created by default, and
575 write the result back to ~/.cabal/config.
576 Flags:
579 -v, --verbose [n]
580 Control verbosity (n is 0--3, default verbosity level is
581 1)
582 -f, --force
584 Overwrite the config file if it already exists.
585 -a, --augment CONFIGLINE
587 Additional setting to augment the config file (replacing
588 a previous setting if it existed).
589 cabal gen-bounds
592 Usage: cabal gen-bounds [FLAGS]
594 Generates bounds for all dependencies that do not currently have them.
597 Generated bounds are printed to stdout. You can then paste them into
598 your
599 Flags:
603 -v, --verbose [n]
604 Control verbosity (n is 0--3, default verbosity level is
605 1)
606 cabal outdated
609 Usage: cabal outdated [FLAGS]
611 Checks for outdated dependencies in the package description file or
614 freeze file
615 Flags:
618 -v, --verbose [n]
619 Control verbosity (n is 0--3, default verbosity level is
620 1)
621 --freeze-file, --v1-freeze-file
623 Act on the freeze file
624 --v2-freeze-file, --new-freeze-file
626 Act on the new-style freeze file (default: ca‐
627 bal.project.freeze)
628 --project-file PROJECTFILE
630 Act on the new-style freeze file named PROJECTFILE.freeze
631 rather than the default cabal.project.freeze
632 --simple-output
634 Only print names of outdated dependencies, one per line
635 --exit-code
637 Exit with non-zero when there are outdated dependencies
638 -q, --quiet
640 Don't print any output. Implies '--exit-code' and '-v0'
641 --ignore PKGS
643 Packages to ignore
644 --minor [PKGS]
646 Ignore major version bumps for these packages
647 cabal hscolour
650 Usage: cabal hscolour [FLAGS]
652 Requires the hscolour program.
655 Deprecated in favour of 'cabal haddock --hyperlink-source'.
658 Flags:
660 -v, --verbose [n]
661 Control verbosity (n is 0--3, default verbosity level is
662 1)
663 --builddir, --distdir, --distpref DIR
665 The directory where Cabal puts generated build files (de‐
666 fault dist)
667 --executables
669 Run hscolour for Executables targets
670 --tests
672 Run hscolour for Test Suite targets
673 --benchmarks
675 Run hscolour for Benchmark targets
676 --foreign-libraries
678 Run hscolour for Foreign Library targets
679 --all
681 Run hscolour for all targets
682 --css PATH
684 Use a cascading style sheet
685 cabal configure
688 Usage: cabal configure [FLAGS]
690 Adjust how the project is built by setting additional package flags and
693 other flags.
694 The configuration options are written to the 'cabal.project.local' file
696 (or configuration from the 'cabal.project' file (if any). This combina‐
697 tion is used as the project configuration for all other commands (such
698 as 'build',
699 The configure command also checks that the project configuration will
701 work. In particular it checks that there is a consistent set of depen‐
702 dencies for the project as a whole.
703 The 'cabal.project.local' file persists across 'clean' but is overwrit‐
705 ten on the next use of the 'configure' command. The intention is that
706 the
707 It is never necessary to use the 'configure' command. It is merely a
709 convenience in cases where you do not want to specify flags to 'build'
710 (and other commands) every time and yet do not want to alter the 'ca‐
711 bal.project' persistently.
712 Adjust how the project is built by setting additional package flags and
715 other flags.
716 The configuration options are written to the 'cabal.project.local' file
718 (or configuration from the 'cabal.project' file (if any). This combina‐
719 tion is used as the project configuration for all other commands (such
720 as 'build',
721 The configure command also checks that the project configuration will
723 work. In particular it checks that there is a consistent set of depen‐
724 dencies for the project as a whole.
725 The 'cabal.project.local' file persists across 'clean' but is overwrit‐
727 ten on the next use of the 'configure' command. The intention is that
728 the
729 It is never necessary to use the 'configure' command. It is merely a
731 convenience in cases where you do not want to specify flags to 'build'
732 (and other commands) every time and yet do not want to alter the 'ca‐
733 bal.project' persistently.
734 Flags:
737 -v, --verbose [n]
738 Control verbosity (n is 0--3, default verbosity level is
739 1)
740 --builddir, --distdir, --distpref DIR
742 The directory where Cabal puts generated build files (de‐
743 fault dist)
744 -g, --ghc
746 compile with GHC
747 --ghcjs
749 compile with GHCJS
750 --uhc
752 compile with UHC
753 --haskell-suite
755 compile with a haskell-suite compiler
756 --cabal-file PATH
758 use this Cabal file
759 -w, --with-compiler PATH
761 give the path to a particular compiler
762 --with-hc-pkg PATH
764 give the path to the package tool
765 --prefix DIR
767 bake this prefix in preparation of installation
768 --bindir DIR
770 installation directory for executables
771 --libdir DIR
773 installation directory for libraries
774 --libsubdir DIR
776 subdirectory of libdir in which libs are installed
777 --dynlibdir DIR
779 installation directory for dynamic libraries
780 --libexecdir DIR
782 installation directory for program executables
783 --libexecsubdir DIR
785 subdirectory of libexecdir in which private executables
786 are installed
787 --datadir DIR
789 installation directory for read-only data
790 --datasubdir DIR
792 subdirectory of datadir in which data files are installed
793 --docdir DIR
795 installation directory for documentation
796 --htmldir DIR
798 installation directory for HTML documentation
799 --haddockdir DIR
801 installation directory for haddock interfaces
802 --sysconfdir DIR
804 installation directory for configuration files
805 --program-prefix PREFIX
807 prefix to be applied to installed executables
808 --program-suffix SUFFIX
810 suffix to be applied to installed executables
811 --enable-library-vanilla
813 --disable-library-vanilla
814 Vanilla libraries
815 -p, --enable-library-profiling
817 --disable-library-profiling
818 Library profiling
819 --enable-shared
821 --disable-shared
822 Shared library
823 --enable-static
825 --disable-static
826 Static library
827 --enable-executable-dynamic
829 --disable-executable-dynamic
830 Executable dynamic linking
831 --enable-executable-static
833 --disable-executable-static
834 Executable fully static linking
835 --enable-profiling
837 --disable-profiling
838 Executable and library profiling
839 --enable-executable-profiling
841 --disable-executable-profiling
842 Executable profiling (DEPRECATED)
843 --profiling-detail level
845 Profiling detail level for executable and library (de‐
846 fault, none, exported-functions, toplevel-functions,
847 all-functions).
848 --library-profiling-detail level
850 Profiling detail level for libraries only.
851 -O, --enable-optimization, --enable-optimisation [n]
853 Build with optimization (n is 0--2, default is 1)
854 --disable-optimization, --disable-optimisation
856 Build without optimization
857 --enable-debug-info [n]
859 Emit debug info (n is 0--3, default is 0)
860 --disable-debug-info
862 Don't emit debug info
863 --enable-library-for-ghci
865 --disable-library-for-ghci
866 compile library for use with GHCi
867 --enable-split-sections
869 --disable-split-sections
870 compile library code such that unneeded definitions can
871 be dropped from the final executable (GHC 7.8+)
872 --enable-split-objs
874 --disable-split-objs
875 split library into smaller objects to reduce binary sizes
876 (GHC 6.6+)
877 --enable-executable-stripping
879 --disable-executable-stripping
880 strip executables upon installation to reduce binary
881 sizes
882 --enable-library-stripping
884 --disable-library-stripping
885 strip libraries upon installation to reduce binary sizes
886 --configure-option OPT
888 Extra option for configure
889 --user
891 --global
892 doing a per-user installation
893 --package-db DB
895 Append the given package database to the list of package
896 databases used (to satisfy dependencies and register
897 into). May be a specific file, 'global' or 'user'. The
898 initial list is ['global'], ['global', 'user'], or
899 ['global', $sandbox], depending on context. Use 'clear'
900 to reset the list to empty. See the user guide for de‐
901 tails.
902 -f, --flags FLAGS
904 Force values for the given flags in Cabal conditionals in
905 the .cabal file. E.g., --flags="debug -usebytestrings"
906 forces the flag "debug" to true and "usebytestrings" to
907 false.
908 --extra-include-dirs PATH
910 A list of directories to search for header files
911 --enable-deterministic
913 --disable-deterministic
914 Try to be as deterministic as possible (used by the test
915 suite)
916 --ipid IPID
918 Installed package ID to compile this package as
919 --cid CID
921 Installed component ID to compile this component as
922 --extra-lib-dirs PATH
924 A list of directories to search for external libraries
925 --extra-framework-dirs PATH
927 A list of directories to search for external frameworks
928 (OS X only)
929 --extra-prog-path PATH
931 A list of directories to search for required programs (in
932 addition to the normal search locations)
933 --instantiate-with NAME=MOD
935 A mapping of signature names to concrete module instanti‐
936 ations.
937 --enable-tests
939 --disable-tests
940 dependency checking and compilation for test suites
941 listed in the package description file.
942 --enable-coverage
944 --disable-coverage
945 build package with Haskell Program Coverage. (GHC only)
946 --enable-library-coverage
948 --disable-library-coverage
949 build package with Haskell Program Coverage. (GHC only)
950 (DEPRECATED)
951 --enable-benchmarks
953 --disable-benchmarks
954 dependency checking and compilation for benchmarks listed
955 in the package description file.
956 --enable-relocatable
958 --disable-relocatable
959 building a package that is relocatable. (GHC only)
960 --disable-response-files
962 enable workaround for old versions of programs like "ar"
963 that do not support @file arguments
964 --allow-depending-on-private-libs
966 Allow depending on private libraries. If set, the library
967 visibility check MUST be done externally.
968 --with-alex PATH
970 give the path to alex
971 --with-ar PATH
973 give the path to ar
974 --with-c2hs PATH
976 give the path to c2hs
977 --with-cpphs PATH
979 give the path to cpphs
980 --with-doctest PATH
982 give the path to doctest
983 --with-gcc PATH
985 give the path to gcc
986 --with-ghc PATH
988 give the path to ghc
989 --with-ghc-pkg PATH
991 give the path to ghc-pkg
992 --with-ghcjs PATH
994 give the path to ghcjs
995 --with-ghcjs-pkg PATH
997 give the path to ghcjs-pkg
998 --with-greencard PATH
1000 give the path to greencard
1001 --with-haddock PATH
1003 give the path to haddock
1004 --with-happy PATH
1006 give the path to happy
1007 --with-haskell-suite PATH
1009 give the path to haskell-suite
1010 --with-haskell-suite-pkg PATH
1012 give the path to haskell-suite-pkg
1013 --with-hmake PATH
1015 give the path to hmake
1016 --with-hpc PATH
1018 give the path to hpc
1019 --with-hsc2hs PATH
1021 give the path to hsc2hs
1022 --with-hscolour PATH
1024 give the path to hscolour
1025 --with-jhc PATH
1027 give the path to jhc
1028 --with-ld PATH
1030 give the path to ld
1031 --with-pkg-config PATH
1033 give the path to pkg-config
1034 --with-runghc PATH
1036 give the path to runghc
1037 --with-strip PATH
1039 give the path to strip
1040 --with-tar PATH
1042 give the path to tar
1043 --with-uhc PATH
1045 give the path to uhc
1046 --alex-option OPT
1048 give an extra option to alex (no need to quote options
1049 containing spaces)
1050 --ar-option OPT
1052 give an extra option to ar (no need to quote options con‐
1053 taining spaces)
1054 --c2hs-option OPT
1056 give an extra option to c2hs (no need to quote options
1057 containing spaces)
1058 --cpphs-option OPT
1060 give an extra option to cpphs (no need to quote options
1061 containing spaces)
1062 --doctest-option OPT
1064 give an extra option to doctest (no need to quote options
1065 containing spaces)
1066 --gcc-option OPT
1068 give an extra option to gcc (no need to quote options
1069 containing spaces)
1070 --ghc-option OPT
1072 give an extra option to ghc (no need to quote options
1073 containing spaces)
1074 --ghc-pkg-option OPT
1076 give an extra option to ghc-pkg (no need to quote options
1077 containing spaces)
1078 --ghcjs-option OPT
1080 give an extra option to ghcjs (no need to quote options
1081 containing spaces)
1082 --ghcjs-pkg-option OPT
1084 give an extra option to ghcjs-pkg (no need to quote op‐
1085 tions containing spaces)
1086 --greencard-option OPT
1088 give an extra option to greencard (no need to quote op‐
1089 tions containing spaces)
1090 --haddock-option OPT
1092 give an extra option to haddock (no need to quote options
1093 containing spaces)
1094 --happy-option OPT
1096 give an extra option to happy (no need to quote options
1097 containing spaces)
1098 --haskell-suite-option OPT
1100 give an extra option to haskell-suite (no need to quote
1101 options containing spaces)
1102 --haskell-suite-pkg-option OPT
1104 give an extra option to haskell-suite-pkg (no need to
1105 quote options containing spaces)
1106 --hmake-option OPT
1108 give an extra option to hmake (no need to quote options
1109 containing spaces)
1110 --hpc-option OPT
1112 give an extra option to hpc (no need to quote options
1113 containing spaces)
1114 --hsc2hs-option OPT
1116 give an extra option to hsc2hs (no need to quote options
1117 containing spaces)
1118 --hscolour-option OPT
1120 give an extra option to hscolour (no need to quote op‐
1121 tions containing spaces)
1122 --jhc-option OPT
1124 give an extra option to jhc (no need to quote options
1125 containing spaces)
1126 --ld-option OPT
1128 give an extra option to ld (no need to quote options con‐
1129 taining spaces)
1130 --pkg-config-option OPT
1132 give an extra option to pkg-config (no need to quote op‐
1133 tions containing spaces)
1134 --runghc-option OPT
1136 give an extra option to runghc (no need to quote options
1137 containing spaces)
1138 --strip-option OPT
1140 give an extra option to strip (no need to quote options
1141 containing spaces)
1142 --tar-option OPT
1144 give an extra option to tar (no need to quote options
1145 containing spaces)
1146 --uhc-option OPT
1148 give an extra option to uhc (no need to quote options
1149 containing spaces)
1150 --alex-options OPTS
1152 give extra options to alex
1153 --ar-options OPTS
1155 give extra options to ar
1156 --c2hs-options OPTS
1158 give extra options to c2hs
1159 --cpphs-options OPTS
1161 give extra options to cpphs
1162 --doctest-options OPTS
1164 give extra options to doctest
1165 --gcc-options OPTS
1167 give extra options to gcc
1168 --ghc-options OPTS
1170 give extra options to ghc
1171 --ghc-pkg-options OPTS
1173 give extra options to ghc-pkg
1174 --ghcjs-options OPTS
1176 give extra options to ghcjs
1177 --ghcjs-pkg-options OPTS
1179 give extra options to ghcjs-pkg
1180 --greencard-options OPTS
1182 give extra options to greencard
1183 --haddock-options OPTS
1185 give extra options to haddock
1186 --happy-options OPTS
1188 give extra options to happy
1189 --haskell-suite-options OPTS
1191 give extra options to haskell-suite
1192 --haskell-suite-pkg-options OPTS
1194 give extra options to haskell-suite-pkg
1195 --hmake-options OPTS
1197 give extra options to hmake
1198 --hpc-options OPTS
1200 give extra options to hpc
1201 --hsc2hs-options OPTS
1203 give extra options to hsc2hs
1204 --hscolour-options OPTS
1206 give extra options to hscolour
1207 --jhc-options OPTS
1209 give extra options to jhc
1210 --ld-options OPTS
1212 give extra options to ld
1213 --pkg-config-options OPTS
1215 give extra options to pkg-config
1216 --runghc-options OPTS
1218 give extra options to runghc
1219 --strip-options OPTS
1221 give extra options to strip
1222 --tar-options OPTS
1224 give extra options to tar
1225 --uhc-options OPTS
1227 give extra options to uhc
1228 --cabal-lib-version VERSION
1230 Select which version of the Cabal lib to use to build
1231 packages (useful for testing).
1232 --constraint CONSTRAINT
1234 Specify constraints on a package (version, in‐
1235 stalled/source, flags)
1236 --preference CONSTRAINT
1238 Specify preferences (soft constraints) on the version of
1239 a package
1240 --solver SOLVER
1242 Select dependency solver to use (default: modular).
1243 Choices: modular.
1244 --allow-older [DEPS]
1246 Ignore lower bounds in all dependencies or DEPS
1247 --allow-newer [DEPS]
1249 Ignore upper bounds in all dependencies or DEPS
1250 --write-ghc-environment-files always|never|ghc8.4.4+
1252 Whether to create a .ghc.environment file after a suc‐
1253 cessful build (v2-build only)
1254 --enable-documentation
1256 --disable-documentation
1257 building of documentation
1258 --doc-index-file TEMPLATE
1260 A central index of haddock API documentation (template
1261 cannot use $pkgid)
1262 --dry-run
1264 Do not install anything, only print what would be in‐
1265 stalled.
1266 --max-backjumps NUM
1268 Maximum number of backjumps allowed while solving (de‐
1269 fault: 4000). Use a negative number to enable unlimited
1270 backtracking. Use 0 to disable backtracking completely.
1271 --reorder-goals
1273 --no-reorder-goals
1274 Try to reorder goals according to certain heuristics.
1275 Slows things down on average, but may make backtracking
1276 faster for some packages.
1277 --count-conflicts
1279 --no-count-conflicts
1280 Try to speed up solving by preferring goals that are in‐
1281 volved in a lot of conflicts (default).
1282 --fine-grained-conflicts
1284 --no-fine-grained-conflicts
1285 Skip a version of a package if it does not resolve the
1286 conflicts encountered in the last version, as a solver
1287 optimization (default).
1288 --minimize-conflict-set
1290 --no-minimize-conflict-set
1291 When there is no solution, try to improve the error mes‐
1292 sage by finding a minimal conflict set (default: false).
1293 May increase run time significantly.
1294 --independent-goals
1296 --no-independent-goals
1297 Treat several goals on the command line as independent.
1298 If several goals depend on the same package, different
1299 versions can be chosen.
1300 --shadow-installed-packages
1302 --no-shadow-installed-packages
1303 If multiple package instances of the same version are in‐
1304 stalled, treat all but one as shadowed.
1305 --strong-flags
1307 --no-strong-flags
1308 Do not defer flag choices (this used to be the default in
1309 cabal-install <= 1.20).
1310 --allow-boot-library-installs
1312 --no-allow-boot-library-installs
1313 Allow cabal to install base, ghc-prim, integer-simple,
1314 integer-gmp, and template-haskell.
1315 --reject-unconstrained-dependencies none|all
1317 Require these packages to have constraints on them if
1318 they are to be selected (default: none).
1319 --reinstall
1321 --no-reinstall
1322 Install even if it means installing the same version
1323 again.
1324 --avoid-reinstalls
1326 --no-avoid-reinstalls
1327 Do not select versions that would destructively overwrite
1328 installed packages.
1329 --force-reinstalls
1331 --no-force-reinstalls
1332 Reinstall packages even if they will most likely break
1333 other installed packages.
1334 --upgrade-dependencies
1336 --no-upgrade-dependencies
1337 Pick the latest version for all dependencies, rather than
1338 trying to pick an installed version.
1339 --only-dependencies
1341 --no-only-dependencies
1342 Install only the dependencies necessary to build the
1343 given packages
1344 --dependencies-only
1346 --no-dependencies-only
1347 A synonym for --only-dependencies
1348 --index-state STATE
1350 Use source package index state as it existed at a previ‐
1351 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
1352 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
1353 'HEAD' (default: 'HEAD').
1354 --root-cmd COMMAND
1356 (No longer supported, do not use.)
1357 --symlink-bindir DIR
1359 Add symlinks to installed executables into this direc‐
1360 tory.
1361 --build-summary TEMPLATE
1363 Save build summaries to file (name template can use
1364 $pkgid, $compiler, $os, $arch)
1365 --build-log TEMPLATE
1367 Log all builds to file (name template can use $pkgid,
1368 $compiler, $os, $arch)
1369 --remote-build-reporting LEVEL
1371 Generate build reports to send to a remote server (none,
1372 anonymous or detailed).
1373 --report-planning-failure
1375 Generate build reports when the dependency solver fails.
1376 This is used by the Hackage build bot.
1377 --enable-per-component
1379 --disable-per-component
1380 Per-component builds when possible
1381 --one-shot
1383 --no-one-shot
1384 Do not record the packages in the world file.
1385 --run-tests
1387 Run package test suites during installation.
1388 -j, --jobs [NUM]
1390 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
1391 given).
1392 --keep-going
1394 After a build failure, continue to build other unaffected
1395 packages.
1396 --offline
1398 --no-offline
1399 Don't download packages from the Internet.
1400 --project-file FILE
1402 Set the name of the cabal.project file to search for in
1403 parent directories
1404 --only
1406 Only installs the package in the current directory.
1407 --haddock-hoogle
1409 Generate a hoogle database
1410 --haddock-html
1412 Generate HTML documentation (the default)
1413 --haddock-html-location URL
1415 Location of HTML documentation for pre-requisite packages
1416 --haddock-for-hackage
1418 Collection of flags to generate documentation suitable
1419 for upload to hackage
1420 --haddock-executables
1422 Run haddock for Executables targets
1423 --haddock-tests
1425 Run haddock for Test Suite targets
1426 --haddock-benchmarks
1428 Run haddock for Benchmark targets
1429 --haddock-all
1431 Run haddock for all targets
1432 --haddock-internal
1434 Run haddock for internal modules and include all symbols
1435 --haddock-css PATH
1437 Use PATH as the haddock stylesheet
1438 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
1440 dock-hyperlinked-source
1441 Hyperlink the documentation to the source code
1442 --haddock-quickjump
1444 Generate an index for interactive documentation naviga‐
1445 tion
1446 --haddock-hscolour-css PATH
1448 Use PATH as the HsColour stylesheet
1449 --haddock-contents-location URL
1451 Bake URL in as the location for the contents page
1452 --test-log TEMPLATE
1454 Log all test suite results to file (name template can use
1455 $pkgid, $compiler, $os, $arch, $test-suite, $result)
1456 --test-machine-log TEMPLATE
1458 Produce a machine-readable log file (name template can
1459 use $pkgid, $compiler, $os, $arch, $result)
1460 --test-show-details FILTER
1462 --test-keep-tix-files
1464 keep .tix files for HPC between test runs
1465 --test-wrapper FILE
1467 Run test through a wrapper.
1468 --test-fail-when-no-test-suites
1470 Exit with failure when no test suites are found.
1471 --test-options TEMPLATES
1473 give extra options to test executables (name templates
1474 can use $pkgid, $compiler, $os, $arch, $test-suite)
1475 --test-option TEMPLATE
1477 give extra option to test executables (no need to quote
1478 options containing spaces, name template can use $pkgid,
1479 $compiler, $os, $arch, $test-suite)
1480 --benchmark-options TEMPLATES
1482 give extra options to benchmark executables (name tem‐
1483 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
1484 --benchmark-option TEMPLATE
1486 give extra option to benchmark executables (no need to
1487 quote options containing spaces, name template can use
1488 $pkgid, $compiler, $os, $arch, $benchmark)
1489 cabal new-configure
1492 Usage: cabal new-configure [FLAGS]
1494 Adjust how the project is built by setting additional package flags and
1497 other flags.
1498 The configuration options are written to the 'cabal.project.local' file
1500 (or configuration from the 'cabal.project' file (if any). This combina‐
1501 tion is used as the project configuration for all other commands (such
1502 as 'new-build',
1503 The new-configure command also checks that the project configuration
1505 will work. In particular it checks that there is a consistent set of
1506 dependencies for the project as a whole.
1507 The 'cabal.project.local' file persists across 'new-clean' but is over‐
1509 written on the next use of the 'new-configure' command. The intention
1510 is that the
1511 It is never necessary to use the 'new-configure' command. It is merely
1513 a convenience in cases where you do not want to specify flags to 'new-
1514 build' (and other commands) every time and yet do not want to alter the
1515 'cabal.project' persistently.
1516 Adjust how the project is built by setting additional package flags and
1519 other flags.
1520 The configuration options are written to the 'cabal.project.local' file
1522 (or configuration from the 'cabal.project' file (if any). This combina‐
1523 tion is used as the project configuration for all other commands (such
1524 as 'new-build',
1525 The new-configure command also checks that the project configuration
1527 will work. In particular it checks that there is a consistent set of
1528 dependencies for the project as a whole.
1529 The 'cabal.project.local' file persists across 'new-clean' but is over‐
1531 written on the next use of the 'new-configure' command. The intention
1532 is that the
1533 It is never necessary to use the 'new-configure' command. It is merely
1535 a convenience in cases where you do not want to specify flags to 'new-
1536 build' (and other commands) every time and yet do not want to alter the
1537 'cabal.project' persistently.
1538 Flags:
1541 -v, --verbose [n]
1542 Control verbosity (n is 0--3, default verbosity level is
1543 1)
1544 --builddir, --distdir, --distpref DIR
1546 The directory where Cabal puts generated build files (de‐
1547 fault dist)
1548 -g, --ghc
1550 compile with GHC
1551 --ghcjs
1553 compile with GHCJS
1554 --uhc
1556 compile with UHC
1557 --haskell-suite
1559 compile with a haskell-suite compiler
1560 --cabal-file PATH
1562 use this Cabal file
1563 -w, --with-compiler PATH
1565 give the path to a particular compiler
1566 --with-hc-pkg PATH
1568 give the path to the package tool
1569 --prefix DIR
1571 bake this prefix in preparation of installation
1572 --bindir DIR
1574 installation directory for executables
1575 --libdir DIR
1577 installation directory for libraries
1578 --libsubdir DIR
1580 subdirectory of libdir in which libs are installed
1581 --dynlibdir DIR
1583 installation directory for dynamic libraries
1584 --libexecdir DIR
1586 installation directory for program executables
1587 --libexecsubdir DIR
1589 subdirectory of libexecdir in which private executables
1590 are installed
1591 --datadir DIR
1593 installation directory for read-only data
1594 --datasubdir DIR
1596 subdirectory of datadir in which data files are installed
1597 --docdir DIR
1599 installation directory for documentation
1600 --htmldir DIR
1602 installation directory for HTML documentation
1603 --haddockdir DIR
1605 installation directory for haddock interfaces
1606 --sysconfdir DIR
1608 installation directory for configuration files
1609 --program-prefix PREFIX
1611 prefix to be applied to installed executables
1612 --program-suffix SUFFIX
1614 suffix to be applied to installed executables
1615 --enable-library-vanilla
1617 --disable-library-vanilla
1618 Vanilla libraries
1619 -p, --enable-library-profiling
1621 --disable-library-profiling
1622 Library profiling
1623 --enable-shared
1625 --disable-shared
1626 Shared library
1627 --enable-static
1629 --disable-static
1630 Static library
1631 --enable-executable-dynamic
1633 --disable-executable-dynamic
1634 Executable dynamic linking
1635 --enable-executable-static
1637 --disable-executable-static
1638 Executable fully static linking
1639 --enable-profiling
1641 --disable-profiling
1642 Executable and library profiling
1643 --enable-executable-profiling
1645 --disable-executable-profiling
1646 Executable profiling (DEPRECATED)
1647 --profiling-detail level
1649 Profiling detail level for executable and library (de‐
1650 fault, none, exported-functions, toplevel-functions,
1651 all-functions).
1652 --library-profiling-detail level
1654 Profiling detail level for libraries only.
1655 -O, --enable-optimization, --enable-optimisation [n]
1657 Build with optimization (n is 0--2, default is 1)
1658 --disable-optimization, --disable-optimisation
1660 Build without optimization
1661 --enable-debug-info [n]
1663 Emit debug info (n is 0--3, default is 0)
1664 --disable-debug-info
1666 Don't emit debug info
1667 --enable-library-for-ghci
1669 --disable-library-for-ghci
1670 compile library for use with GHCi
1671 --enable-split-sections
1673 --disable-split-sections
1674 compile library code such that unneeded definitions can
1675 be dropped from the final executable (GHC 7.8+)
1676 --enable-split-objs
1678 --disable-split-objs
1679 split library into smaller objects to reduce binary sizes
1680 (GHC 6.6+)
1681 --enable-executable-stripping
1683 --disable-executable-stripping
1684 strip executables upon installation to reduce binary
1685 sizes
1686 --enable-library-stripping
1688 --disable-library-stripping
1689 strip libraries upon installation to reduce binary sizes
1690 --configure-option OPT
1692 Extra option for configure
1693 --user
1695 --global
1696 doing a per-user installation
1697 --package-db DB
1699 Append the given package database to the list of package
1700 databases used (to satisfy dependencies and register
1701 into). May be a specific file, 'global' or 'user'. The
1702 initial list is ['global'], ['global', 'user'], or
1703 ['global', $sandbox], depending on context. Use 'clear'
1704 to reset the list to empty. See the user guide for de‐
1705 tails.
1706 -f, --flags FLAGS
1708 Force values for the given flags in Cabal conditionals in
1709 the .cabal file. E.g., --flags="debug -usebytestrings"
1710 forces the flag "debug" to true and "usebytestrings" to
1711 false.
1712 --extra-include-dirs PATH
1714 A list of directories to search for header files
1715 --enable-deterministic
1717 --disable-deterministic
1718 Try to be as deterministic as possible (used by the test
1719 suite)
1720 --ipid IPID
1722 Installed package ID to compile this package as
1723 --cid CID
1725 Installed component ID to compile this component as
1726 --extra-lib-dirs PATH
1728 A list of directories to search for external libraries
1729 --extra-framework-dirs PATH
1731 A list of directories to search for external frameworks
1732 (OS X only)
1733 --extra-prog-path PATH
1735 A list of directories to search for required programs (in
1736 addition to the normal search locations)
1737 --instantiate-with NAME=MOD
1739 A mapping of signature names to concrete module instanti‐
1740 ations.
1741 --enable-tests
1743 --disable-tests
1744 dependency checking and compilation for test suites
1745 listed in the package description file.
1746 --enable-coverage
1748 --disable-coverage
1749 build package with Haskell Program Coverage. (GHC only)
1750 --enable-library-coverage
1752 --disable-library-coverage
1753 build package with Haskell Program Coverage. (GHC only)
1754 (DEPRECATED)
1755 --enable-benchmarks
1757 --disable-benchmarks
1758 dependency checking and compilation for benchmarks listed
1759 in the package description file.
1760 --enable-relocatable
1762 --disable-relocatable
1763 building a package that is relocatable. (GHC only)
1764 --disable-response-files
1766 enable workaround for old versions of programs like "ar"
1767 that do not support @file arguments
1768 --allow-depending-on-private-libs
1770 Allow depending on private libraries. If set, the library
1771 visibility check MUST be done externally.
1772 --with-alex PATH
1774 give the path to alex
1775 --with-ar PATH
1777 give the path to ar
1778 --with-c2hs PATH
1780 give the path to c2hs
1781 --with-cpphs PATH
1783 give the path to cpphs
1784 --with-doctest PATH
1786 give the path to doctest
1787 --with-gcc PATH
1789 give the path to gcc
1790 --with-ghc PATH
1792 give the path to ghc
1793 --with-ghc-pkg PATH
1795 give the path to ghc-pkg
1796 --with-ghcjs PATH
1798 give the path to ghcjs
1799 --with-ghcjs-pkg PATH
1801 give the path to ghcjs-pkg
1802 --with-greencard PATH
1804 give the path to greencard
1805 --with-haddock PATH
1807 give the path to haddock
1808 --with-happy PATH
1810 give the path to happy
1811 --with-haskell-suite PATH
1813 give the path to haskell-suite
1814 --with-haskell-suite-pkg PATH
1816 give the path to haskell-suite-pkg
1817 --with-hmake PATH
1819 give the path to hmake
1820 --with-hpc PATH
1822 give the path to hpc
1823 --with-hsc2hs PATH
1825 give the path to hsc2hs
1826 --with-hscolour PATH
1828 give the path to hscolour
1829 --with-jhc PATH
1831 give the path to jhc
1832 --with-ld PATH
1834 give the path to ld
1835 --with-pkg-config PATH
1837 give the path to pkg-config
1838 --with-runghc PATH
1840 give the path to runghc
1841 --with-strip PATH
1843 give the path to strip
1844 --with-tar PATH
1846 give the path to tar
1847 --with-uhc PATH
1849 give the path to uhc
1850 --alex-option OPT
1852 give an extra option to alex (no need to quote options
1853 containing spaces)
1854 --ar-option OPT
1856 give an extra option to ar (no need to quote options con‐
1857 taining spaces)
1858 --c2hs-option OPT
1860 give an extra option to c2hs (no need to quote options
1861 containing spaces)
1862 --cpphs-option OPT
1864 give an extra option to cpphs (no need to quote options
1865 containing spaces)
1866 --doctest-option OPT
1868 give an extra option to doctest (no need to quote options
1869 containing spaces)
1870 --gcc-option OPT
1872 give an extra option to gcc (no need to quote options
1873 containing spaces)
1874 --ghc-option OPT
1876 give an extra option to ghc (no need to quote options
1877 containing spaces)
1878 --ghc-pkg-option OPT
1880 give an extra option to ghc-pkg (no need to quote options
1881 containing spaces)
1882 --ghcjs-option OPT
1884 give an extra option to ghcjs (no need to quote options
1885 containing spaces)
1886 --ghcjs-pkg-option OPT
1888 give an extra option to ghcjs-pkg (no need to quote op‐
1889 tions containing spaces)
1890 --greencard-option OPT
1892 give an extra option to greencard (no need to quote op‐
1893 tions containing spaces)
1894 --haddock-option OPT
1896 give an extra option to haddock (no need to quote options
1897 containing spaces)
1898 --happy-option OPT
1900 give an extra option to happy (no need to quote options
1901 containing spaces)
1902 --haskell-suite-option OPT
1904 give an extra option to haskell-suite (no need to quote
1905 options containing spaces)
1906 --haskell-suite-pkg-option OPT
1908 give an extra option to haskell-suite-pkg (no need to
1909 quote options containing spaces)
1910 --hmake-option OPT
1912 give an extra option to hmake (no need to quote options
1913 containing spaces)
1914 --hpc-option OPT
1916 give an extra option to hpc (no need to quote options
1917 containing spaces)
1918 --hsc2hs-option OPT
1920 give an extra option to hsc2hs (no need to quote options
1921 containing spaces)
1922 --hscolour-option OPT
1924 give an extra option to hscolour (no need to quote op‐
1925 tions containing spaces)
1926 --jhc-option OPT
1928 give an extra option to jhc (no need to quote options
1929 containing spaces)
1930 --ld-option OPT
1932 give an extra option to ld (no need to quote options con‐
1933 taining spaces)
1934 --pkg-config-option OPT
1936 give an extra option to pkg-config (no need to quote op‐
1937 tions containing spaces)
1938 --runghc-option OPT
1940 give an extra option to runghc (no need to quote options
1941 containing spaces)
1942 --strip-option OPT
1944 give an extra option to strip (no need to quote options
1945 containing spaces)
1946 --tar-option OPT
1948 give an extra option to tar (no need to quote options
1949 containing spaces)
1950 --uhc-option OPT
1952 give an extra option to uhc (no need to quote options
1953 containing spaces)
1954 --alex-options OPTS
1956 give extra options to alex
1957 --ar-options OPTS
1959 give extra options to ar
1960 --c2hs-options OPTS
1962 give extra options to c2hs
1963 --cpphs-options OPTS
1965 give extra options to cpphs
1966 --doctest-options OPTS
1968 give extra options to doctest
1969 --gcc-options OPTS
1971 give extra options to gcc
1972 --ghc-options OPTS
1974 give extra options to ghc
1975 --ghc-pkg-options OPTS
1977 give extra options to ghc-pkg
1978 --ghcjs-options OPTS
1980 give extra options to ghcjs
1981 --ghcjs-pkg-options OPTS
1983 give extra options to ghcjs-pkg
1984 --greencard-options OPTS
1986 give extra options to greencard
1987 --haddock-options OPTS
1989 give extra options to haddock
1990 --happy-options OPTS
1992 give extra options to happy
1993 --haskell-suite-options OPTS
1995 give extra options to haskell-suite
1996 --haskell-suite-pkg-options OPTS
1998 give extra options to haskell-suite-pkg
1999 --hmake-options OPTS
2001 give extra options to hmake
2002 --hpc-options OPTS
2004 give extra options to hpc
2005 --hsc2hs-options OPTS
2007 give extra options to hsc2hs
2008 --hscolour-options OPTS
2010 give extra options to hscolour
2011 --jhc-options OPTS
2013 give extra options to jhc
2014 --ld-options OPTS
2016 give extra options to ld
2017 --pkg-config-options OPTS
2019 give extra options to pkg-config
2020 --runghc-options OPTS
2022 give extra options to runghc
2023 --strip-options OPTS
2025 give extra options to strip
2026 --tar-options OPTS
2028 give extra options to tar
2029 --uhc-options OPTS
2031 give extra options to uhc
2032 --cabal-lib-version VERSION
2034 Select which version of the Cabal lib to use to build
2035 packages (useful for testing).
2036 --constraint CONSTRAINT
2038 Specify constraints on a package (version, in‐
2039 stalled/source, flags)
2040 --preference CONSTRAINT
2042 Specify preferences (soft constraints) on the version of
2043 a package
2044 --solver SOLVER
2046 Select dependency solver to use (default: modular).
2047 Choices: modular.
2048 --allow-older [DEPS]
2050 Ignore lower bounds in all dependencies or DEPS
2051 --allow-newer [DEPS]
2053 Ignore upper bounds in all dependencies or DEPS
2054 --write-ghc-environment-files always|never|ghc8.4.4+
2056 Whether to create a .ghc.environment file after a suc‐
2057 cessful build (v2-build only)
2058 --enable-documentation
2060 --disable-documentation
2061 building of documentation
2062 --doc-index-file TEMPLATE
2064 A central index of haddock API documentation (template
2065 cannot use $pkgid)
2066 --dry-run
2068 Do not install anything, only print what would be in‐
2069 stalled.
2070 --max-backjumps NUM
2072 Maximum number of backjumps allowed while solving (de‐
2073 fault: 4000). Use a negative number to enable unlimited
2074 backtracking. Use 0 to disable backtracking completely.
2075 --reorder-goals
2077 --no-reorder-goals
2078 Try to reorder goals according to certain heuristics.
2079 Slows things down on average, but may make backtracking
2080 faster for some packages.
2081 --count-conflicts
2083 --no-count-conflicts
2084 Try to speed up solving by preferring goals that are in‐
2085 volved in a lot of conflicts (default).
2086 --fine-grained-conflicts
2088 --no-fine-grained-conflicts
2089 Skip a version of a package if it does not resolve the
2090 conflicts encountered in the last version, as a solver
2091 optimization (default).
2092 --minimize-conflict-set
2094 --no-minimize-conflict-set
2095 When there is no solution, try to improve the error mes‐
2096 sage by finding a minimal conflict set (default: false).
2097 May increase run time significantly.
2098 --independent-goals
2100 --no-independent-goals
2101 Treat several goals on the command line as independent.
2102 If several goals depend on the same package, different
2103 versions can be chosen.
2104 --shadow-installed-packages
2106 --no-shadow-installed-packages
2107 If multiple package instances of the same version are in‐
2108 stalled, treat all but one as shadowed.
2109 --strong-flags
2111 --no-strong-flags
2112 Do not defer flag choices (this used to be the default in
2113 cabal-install <= 1.20).
2114 --allow-boot-library-installs
2116 --no-allow-boot-library-installs
2117 Allow cabal to install base, ghc-prim, integer-simple,
2118 integer-gmp, and template-haskell.
2119 --reject-unconstrained-dependencies none|all
2121 Require these packages to have constraints on them if
2122 they are to be selected (default: none).
2123 --reinstall
2125 --no-reinstall
2126 Install even if it means installing the same version
2127 again.
2128 --avoid-reinstalls
2130 --no-avoid-reinstalls
2131 Do not select versions that would destructively overwrite
2132 installed packages.
2133 --force-reinstalls
2135 --no-force-reinstalls
2136 Reinstall packages even if they will most likely break
2137 other installed packages.
2138 --upgrade-dependencies
2140 --no-upgrade-dependencies
2141 Pick the latest version for all dependencies, rather than
2142 trying to pick an installed version.
2143 --only-dependencies
2145 --no-only-dependencies
2146 Install only the dependencies necessary to build the
2147 given packages
2148 --dependencies-only
2150 --no-dependencies-only
2151 A synonym for --only-dependencies
2152 --index-state STATE
2154 Use source package index state as it existed at a previ‐
2155 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
2156 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
2157 'HEAD' (default: 'HEAD').
2158 --root-cmd COMMAND
2160 (No longer supported, do not use.)
2161 --symlink-bindir DIR
2163 Add symlinks to installed executables into this direc‐
2164 tory.
2165 --build-summary TEMPLATE
2167 Save build summaries to file (name template can use
2168 $pkgid, $compiler, $os, $arch)
2169 --build-log TEMPLATE
2171 Log all builds to file (name template can use $pkgid,
2172 $compiler, $os, $arch)
2173 --remote-build-reporting LEVEL
2175 Generate build reports to send to a remote server (none,
2176 anonymous or detailed).
2177 --report-planning-failure
2179 Generate build reports when the dependency solver fails.
2180 This is used by the Hackage build bot.
2181 --enable-per-component
2183 --disable-per-component
2184 Per-component builds when possible
2185 --one-shot
2187 --no-one-shot
2188 Do not record the packages in the world file.
2189 --run-tests
2191 Run package test suites during installation.
2192 -j, --jobs [NUM]
2194 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
2195 given).
2196 --keep-going
2198 After a build failure, continue to build other unaffected
2199 packages.
2200 --offline
2202 --no-offline
2203 Don't download packages from the Internet.
2204 --project-file FILE
2206 Set the name of the cabal.project file to search for in
2207 parent directories
2208 --only
2210 Only installs the package in the current directory.
2211 --haddock-hoogle
2213 Generate a hoogle database
2214 --haddock-html
2216 Generate HTML documentation (the default)
2217 --haddock-html-location URL
2219 Location of HTML documentation for pre-requisite packages
2220 --haddock-for-hackage
2222 Collection of flags to generate documentation suitable
2223 for upload to hackage
2224 --haddock-executables
2226 Run haddock for Executables targets
2227 --haddock-tests
2229 Run haddock for Test Suite targets
2230 --haddock-benchmarks
2232 Run haddock for Benchmark targets
2233 --haddock-all
2235 Run haddock for all targets
2236 --haddock-internal
2238 Run haddock for internal modules and include all symbols
2239 --haddock-css PATH
2241 Use PATH as the haddock stylesheet
2242 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
2244 dock-hyperlinked-source
2245 Hyperlink the documentation to the source code
2246 --haddock-quickjump
2248 Generate an index for interactive documentation naviga‐
2249 tion
2250 --haddock-hscolour-css PATH
2252 Use PATH as the HsColour stylesheet
2253 --haddock-contents-location URL
2255 Bake URL in as the location for the contents page
2256 --test-log TEMPLATE
2258 Log all test suite results to file (name template can use
2259 $pkgid, $compiler, $os, $arch, $test-suite, $result)
2260 --test-machine-log TEMPLATE
2262 Produce a machine-readable log file (name template can
2263 use $pkgid, $compiler, $os, $arch, $result)
2264 --test-show-details FILTER
2266 --test-keep-tix-files
2268 keep .tix files for HPC between test runs
2269 --test-wrapper FILE
2271 Run test through a wrapper.
2272 --test-fail-when-no-test-suites
2274 Exit with failure when no test suites are found.
2275 --test-options TEMPLATES
2277 give extra options to test executables (name templates
2278 can use $pkgid, $compiler, $os, $arch, $test-suite)
2279 --test-option TEMPLATE
2281 give extra option to test executables (no need to quote
2282 options containing spaces, name template can use $pkgid,
2283 $compiler, $os, $arch, $test-suite)
2284 --benchmark-options TEMPLATES
2286 give extra options to benchmark executables (name tem‐
2287 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
2288 --benchmark-option TEMPLATE
2290 give extra option to benchmark executables (no need to
2291 quote options containing spaces, name template can use
2292 $pkgid, $compiler, $os, $arch, $benchmark)
2293 cabal v2-configure
2296 Usage: cabal v2-configure [FLAGS]
2298 Adjust how the project is built by setting additional package flags and
2301 other flags.
2302 The configuration options are written to the 'cabal.project.local' file
2304 (or configuration from the 'cabal.project' file (if any). This combina‐
2305 tion is used as the project configuration for all other commands (such
2306 as 'v2-build',
2307 The v2-configure command also checks that the project configuration
2309 will work. In particular it checks that there is a consistent set of
2310 dependencies for the project as a whole.
2311 The 'cabal.project.local' file persists across 'v2-clean' but is over‐
2313 written on the next use of the 'v2-configure' command. The intention is
2314 that the
2315 It is never necessary to use the 'v2-configure' command. It is merely a
2317 convenience in cases where you do not want to specify flags to
2318 'v2-build' (and other commands) every time and yet do not want to alter
2319 the 'cabal.project' persistently.
2320 Examples:
2323 cabal v2-configure --with-compiler ghc-7.10.3
2324 Adjust the project configuration to use the given compiler
2325 program and check the resulting configuration works.
2326 cabal v2-configure
2327 Reset the local configuration to empty and check the overall
2328 project configuration works.
2329 Note: this command is part of the new project-based system (aka nix-
2331 style local builds). These features are currently in beta. Please see
2332 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
2333 details and advice on what you can expect to work. If you encounter
2334 problems please file issues at https://github.com/haskell/cabal/issues
2335 and if you have any time to get involved and help with testing, fixing
2336 bugs etc then that is very much appreciated.
2337 Flags:
2340 -v, --verbose [n]
2341 Control verbosity (n is 0--3, default verbosity level is
2342 1)
2343 --builddir, --distdir, --distpref DIR
2345 The directory where Cabal puts generated build files (de‐
2346 fault dist)
2347 -g, --ghc
2349 compile with GHC
2350 --ghcjs
2352 compile with GHCJS
2353 --uhc
2355 compile with UHC
2356 --haskell-suite
2358 compile with a haskell-suite compiler
2359 --cabal-file PATH
2361 use this Cabal file
2362 -w, --with-compiler PATH
2364 give the path to a particular compiler
2365 --with-hc-pkg PATH
2367 give the path to the package tool
2368 --prefix DIR
2370 bake this prefix in preparation of installation
2371 --bindir DIR
2373 installation directory for executables
2374 --libdir DIR
2376 installation directory for libraries
2377 --libsubdir DIR
2379 subdirectory of libdir in which libs are installed
2380 --dynlibdir DIR
2382 installation directory for dynamic libraries
2383 --libexecdir DIR
2385 installation directory for program executables
2386 --libexecsubdir DIR
2388 subdirectory of libexecdir in which private executables
2389 are installed
2390 --datadir DIR
2392 installation directory for read-only data
2393 --datasubdir DIR
2395 subdirectory of datadir in which data files are installed
2396 --docdir DIR
2398 installation directory for documentation
2399 --htmldir DIR
2401 installation directory for HTML documentation
2402 --haddockdir DIR
2404 installation directory for haddock interfaces
2405 --sysconfdir DIR
2407 installation directory for configuration files
2408 --program-prefix PREFIX
2410 prefix to be applied to installed executables
2411 --program-suffix SUFFIX
2413 suffix to be applied to installed executables
2414 --enable-library-vanilla
2416 --disable-library-vanilla
2417 Vanilla libraries
2418 -p, --enable-library-profiling
2420 --disable-library-profiling
2421 Library profiling
2422 --enable-shared
2424 --disable-shared
2425 Shared library
2426 --enable-static
2428 --disable-static
2429 Static library
2430 --enable-executable-dynamic
2432 --disable-executable-dynamic
2433 Executable dynamic linking
2434 --enable-executable-static
2436 --disable-executable-static
2437 Executable fully static linking
2438 --enable-profiling
2440 --disable-profiling
2441 Executable and library profiling
2442 --enable-executable-profiling
2444 --disable-executable-profiling
2445 Executable profiling (DEPRECATED)
2446 --profiling-detail level
2448 Profiling detail level for executable and library (de‐
2449 fault, none, exported-functions, toplevel-functions,
2450 all-functions).
2451 --library-profiling-detail level
2453 Profiling detail level for libraries only.
2454 -O, --enable-optimization, --enable-optimisation [n]
2456 Build with optimization (n is 0--2, default is 1)
2457 --disable-optimization, --disable-optimisation
2459 Build without optimization
2460 --enable-debug-info [n]
2462 Emit debug info (n is 0--3, default is 0)
2463 --disable-debug-info
2465 Don't emit debug info
2466 --enable-library-for-ghci
2468 --disable-library-for-ghci
2469 compile library for use with GHCi
2470 --enable-split-sections
2472 --disable-split-sections
2473 compile library code such that unneeded definitions can
2474 be dropped from the final executable (GHC 7.8+)
2475 --enable-split-objs
2477 --disable-split-objs
2478 split library into smaller objects to reduce binary sizes
2479 (GHC 6.6+)
2480 --enable-executable-stripping
2482 --disable-executable-stripping
2483 strip executables upon installation to reduce binary
2484 sizes
2485 --enable-library-stripping
2487 --disable-library-stripping
2488 strip libraries upon installation to reduce binary sizes
2489 --configure-option OPT
2491 Extra option for configure
2492 --user
2494 --global
2495 doing a per-user installation
2496 --package-db DB
2498 Append the given package database to the list of package
2499 databases used (to satisfy dependencies and register
2500 into). May be a specific file, 'global' or 'user'. The
2501 initial list is ['global'], ['global', 'user'], or
2502 ['global', $sandbox], depending on context. Use 'clear'
2503 to reset the list to empty. See the user guide for de‐
2504 tails.
2505 -f, --flags FLAGS
2507 Force values for the given flags in Cabal conditionals in
2508 the .cabal file. E.g., --flags="debug -usebytestrings"
2509 forces the flag "debug" to true and "usebytestrings" to
2510 false.
2511 --extra-include-dirs PATH
2513 A list of directories to search for header files
2514 --enable-deterministic
2516 --disable-deterministic
2517 Try to be as deterministic as possible (used by the test
2518 suite)
2519 --ipid IPID
2521 Installed package ID to compile this package as
2522 --cid CID
2524 Installed component ID to compile this component as
2525 --extra-lib-dirs PATH
2527 A list of directories to search for external libraries
2528 --extra-framework-dirs PATH
2530 A list of directories to search for external frameworks
2531 (OS X only)
2532 --extra-prog-path PATH
2534 A list of directories to search for required programs (in
2535 addition to the normal search locations)
2536 --instantiate-with NAME=MOD
2538 A mapping of signature names to concrete module instanti‐
2539 ations.
2540 --enable-tests
2542 --disable-tests
2543 dependency checking and compilation for test suites
2544 listed in the package description file.
2545 --enable-coverage
2547 --disable-coverage
2548 build package with Haskell Program Coverage. (GHC only)
2549 --enable-library-coverage
2551 --disable-library-coverage
2552 build package with Haskell Program Coverage. (GHC only)
2553 (DEPRECATED)
2554 --enable-benchmarks
2556 --disable-benchmarks
2557 dependency checking and compilation for benchmarks listed
2558 in the package description file.
2559 --enable-relocatable
2561 --disable-relocatable
2562 building a package that is relocatable. (GHC only)
2563 --disable-response-files
2565 enable workaround for old versions of programs like "ar"
2566 that do not support @file arguments
2567 --allow-depending-on-private-libs
2569 Allow depending on private libraries. If set, the library
2570 visibility check MUST be done externally.
2571 --with-alex PATH
2573 give the path to alex
2574 --with-ar PATH
2576 give the path to ar
2577 --with-c2hs PATH
2579 give the path to c2hs
2580 --with-cpphs PATH
2582 give the path to cpphs
2583 --with-doctest PATH
2585 give the path to doctest
2586 --with-gcc PATH
2588 give the path to gcc
2589 --with-ghc PATH
2591 give the path to ghc
2592 --with-ghc-pkg PATH
2594 give the path to ghc-pkg
2595 --with-ghcjs PATH
2597 give the path to ghcjs
2598 --with-ghcjs-pkg PATH
2600 give the path to ghcjs-pkg
2601 --with-greencard PATH
2603 give the path to greencard
2604 --with-haddock PATH
2606 give the path to haddock
2607 --with-happy PATH
2609 give the path to happy
2610 --with-haskell-suite PATH
2612 give the path to haskell-suite
2613 --with-haskell-suite-pkg PATH
2615 give the path to haskell-suite-pkg
2616 --with-hmake PATH
2618 give the path to hmake
2619 --with-hpc PATH
2621 give the path to hpc
2622 --with-hsc2hs PATH
2624 give the path to hsc2hs
2625 --with-hscolour PATH
2627 give the path to hscolour
2628 --with-jhc PATH
2630 give the path to jhc
2631 --with-ld PATH
2633 give the path to ld
2634 --with-pkg-config PATH
2636 give the path to pkg-config
2637 --with-runghc PATH
2639 give the path to runghc
2640 --with-strip PATH
2642 give the path to strip
2643 --with-tar PATH
2645 give the path to tar
2646 --with-uhc PATH
2648 give the path to uhc
2649 --alex-option OPT
2651 give an extra option to alex (no need to quote options
2652 containing spaces)
2653 --ar-option OPT
2655 give an extra option to ar (no need to quote options con‐
2656 taining spaces)
2657 --c2hs-option OPT
2659 give an extra option to c2hs (no need to quote options
2660 containing spaces)
2661 --cpphs-option OPT
2663 give an extra option to cpphs (no need to quote options
2664 containing spaces)
2665 --doctest-option OPT
2667 give an extra option to doctest (no need to quote options
2668 containing spaces)
2669 --gcc-option OPT
2671 give an extra option to gcc (no need to quote options
2672 containing spaces)
2673 --ghc-option OPT
2675 give an extra option to ghc (no need to quote options
2676 containing spaces)
2677 --ghc-pkg-option OPT
2679 give an extra option to ghc-pkg (no need to quote options
2680 containing spaces)
2681 --ghcjs-option OPT
2683 give an extra option to ghcjs (no need to quote options
2684 containing spaces)
2685 --ghcjs-pkg-option OPT
2687 give an extra option to ghcjs-pkg (no need to quote op‐
2688 tions containing spaces)
2689 --greencard-option OPT
2691 give an extra option to greencard (no need to quote op‐
2692 tions containing spaces)
2693 --haddock-option OPT
2695 give an extra option to haddock (no need to quote options
2696 containing spaces)
2697 --happy-option OPT
2699 give an extra option to happy (no need to quote options
2700 containing spaces)
2701 --haskell-suite-option OPT
2703 give an extra option to haskell-suite (no need to quote
2704 options containing spaces)
2705 --haskell-suite-pkg-option OPT
2707 give an extra option to haskell-suite-pkg (no need to
2708 quote options containing spaces)
2709 --hmake-option OPT
2711 give an extra option to hmake (no need to quote options
2712 containing spaces)
2713 --hpc-option OPT
2715 give an extra option to hpc (no need to quote options
2716 containing spaces)
2717 --hsc2hs-option OPT
2719 give an extra option to hsc2hs (no need to quote options
2720 containing spaces)
2721 --hscolour-option OPT
2723 give an extra option to hscolour (no need to quote op‐
2724 tions containing spaces)
2725 --jhc-option OPT
2727 give an extra option to jhc (no need to quote options
2728 containing spaces)
2729 --ld-option OPT
2731 give an extra option to ld (no need to quote options con‐
2732 taining spaces)
2733 --pkg-config-option OPT
2735 give an extra option to pkg-config (no need to quote op‐
2736 tions containing spaces)
2737 --runghc-option OPT
2739 give an extra option to runghc (no need to quote options
2740 containing spaces)
2741 --strip-option OPT
2743 give an extra option to strip (no need to quote options
2744 containing spaces)
2745 --tar-option OPT
2747 give an extra option to tar (no need to quote options
2748 containing spaces)
2749 --uhc-option OPT
2751 give an extra option to uhc (no need to quote options
2752 containing spaces)
2753 --alex-options OPTS
2755 give extra options to alex
2756 --ar-options OPTS
2758 give extra options to ar
2759 --c2hs-options OPTS
2761 give extra options to c2hs
2762 --cpphs-options OPTS
2764 give extra options to cpphs
2765 --doctest-options OPTS
2767 give extra options to doctest
2768 --gcc-options OPTS
2770 give extra options to gcc
2771 --ghc-options OPTS
2773 give extra options to ghc
2774 --ghc-pkg-options OPTS
2776 give extra options to ghc-pkg
2777 --ghcjs-options OPTS
2779 give extra options to ghcjs
2780 --ghcjs-pkg-options OPTS
2782 give extra options to ghcjs-pkg
2783 --greencard-options OPTS
2785 give extra options to greencard
2786 --haddock-options OPTS
2788 give extra options to haddock
2789 --happy-options OPTS
2791 give extra options to happy
2792 --haskell-suite-options OPTS
2794 give extra options to haskell-suite
2795 --haskell-suite-pkg-options OPTS
2797 give extra options to haskell-suite-pkg
2798 --hmake-options OPTS
2800 give extra options to hmake
2801 --hpc-options OPTS
2803 give extra options to hpc
2804 --hsc2hs-options OPTS
2806 give extra options to hsc2hs
2807 --hscolour-options OPTS
2809 give extra options to hscolour
2810 --jhc-options OPTS
2812 give extra options to jhc
2813 --ld-options OPTS
2815 give extra options to ld
2816 --pkg-config-options OPTS
2818 give extra options to pkg-config
2819 --runghc-options OPTS
2821 give extra options to runghc
2822 --strip-options OPTS
2824 give extra options to strip
2825 --tar-options OPTS
2827 give extra options to tar
2828 --uhc-options OPTS
2830 give extra options to uhc
2831 --cabal-lib-version VERSION
2833 Select which version of the Cabal lib to use to build
2834 packages (useful for testing).
2835 --constraint CONSTRAINT
2837 Specify constraints on a package (version, in‐
2838 stalled/source, flags)
2839 --preference CONSTRAINT
2841 Specify preferences (soft constraints) on the version of
2842 a package
2843 --solver SOLVER
2845 Select dependency solver to use (default: modular).
2846 Choices: modular.
2847 --allow-older [DEPS]
2849 Ignore lower bounds in all dependencies or DEPS
2850 --allow-newer [DEPS]
2852 Ignore upper bounds in all dependencies or DEPS
2853 --write-ghc-environment-files always|never|ghc8.4.4+
2855 Whether to create a .ghc.environment file after a suc‐
2856 cessful build (v2-build only)
2857 --enable-documentation
2859 --disable-documentation
2860 building of documentation
2861 --doc-index-file TEMPLATE
2863 A central index of haddock API documentation (template
2864 cannot use $pkgid)
2865 --dry-run
2867 Do not install anything, only print what would be in‐
2868 stalled.
2869 --max-backjumps NUM
2871 Maximum number of backjumps allowed while solving (de‐
2872 fault: 4000). Use a negative number to enable unlimited
2873 backtracking. Use 0 to disable backtracking completely.
2874 --reorder-goals
2876 --no-reorder-goals
2877 Try to reorder goals according to certain heuristics.
2878 Slows things down on average, but may make backtracking
2879 faster for some packages.
2880 --count-conflicts
2882 --no-count-conflicts
2883 Try to speed up solving by preferring goals that are in‐
2884 volved in a lot of conflicts (default).
2885 --fine-grained-conflicts
2887 --no-fine-grained-conflicts
2888 Skip a version of a package if it does not resolve the
2889 conflicts encountered in the last version, as a solver
2890 optimization (default).
2891 --minimize-conflict-set
2893 --no-minimize-conflict-set
2894 When there is no solution, try to improve the error mes‐
2895 sage by finding a minimal conflict set (default: false).
2896 May increase run time significantly.
2897 --independent-goals
2899 --no-independent-goals
2900 Treat several goals on the command line as independent.
2901 If several goals depend on the same package, different
2902 versions can be chosen.
2903 --shadow-installed-packages
2905 --no-shadow-installed-packages
2906 If multiple package instances of the same version are in‐
2907 stalled, treat all but one as shadowed.
2908 --strong-flags
2910 --no-strong-flags
2911 Do not defer flag choices (this used to be the default in
2912 cabal-install <= 1.20).
2913 --allow-boot-library-installs
2915 --no-allow-boot-library-installs
2916 Allow cabal to install base, ghc-prim, integer-simple,
2917 integer-gmp, and template-haskell.
2918 --reject-unconstrained-dependencies none|all
2920 Require these packages to have constraints on them if
2921 they are to be selected (default: none).
2922 --reinstall
2924 --no-reinstall
2925 Install even if it means installing the same version
2926 again.
2927 --avoid-reinstalls
2929 --no-avoid-reinstalls
2930 Do not select versions that would destructively overwrite
2931 installed packages.
2932 --force-reinstalls
2934 --no-force-reinstalls
2935 Reinstall packages even if they will most likely break
2936 other installed packages.
2937 --upgrade-dependencies
2939 --no-upgrade-dependencies
2940 Pick the latest version for all dependencies, rather than
2941 trying to pick an installed version.
2942 --only-dependencies
2944 --no-only-dependencies
2945 Install only the dependencies necessary to build the
2946 given packages
2947 --dependencies-only
2949 --no-dependencies-only
2950 A synonym for --only-dependencies
2951 --index-state STATE
2953 Use source package index state as it existed at a previ‐
2954 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
2955 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
2956 'HEAD' (default: 'HEAD').
2957 --root-cmd COMMAND
2959 (No longer supported, do not use.)
2960 --symlink-bindir DIR
2962 Add symlinks to installed executables into this direc‐
2963 tory.
2964 --build-summary TEMPLATE
2966 Save build summaries to file (name template can use
2967 $pkgid, $compiler, $os, $arch)
2968 --build-log TEMPLATE
2970 Log all builds to file (name template can use $pkgid,
2971 $compiler, $os, $arch)
2972 --remote-build-reporting LEVEL
2974 Generate build reports to send to a remote server (none,
2975 anonymous or detailed).
2976 --report-planning-failure
2978 Generate build reports when the dependency solver fails.
2979 This is used by the Hackage build bot.
2980 --enable-per-component
2982 --disable-per-component
2983 Per-component builds when possible
2984 --one-shot
2986 --no-one-shot
2987 Do not record the packages in the world file.
2988 --run-tests
2990 Run package test suites during installation.
2991 -j, --jobs [NUM]
2993 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
2994 given).
2995 --keep-going
2997 After a build failure, continue to build other unaffected
2998 packages.
2999 --offline
3001 --no-offline
3002 Don't download packages from the Internet.
3003 --project-file FILE
3005 Set the name of the cabal.project file to search for in
3006 parent directories
3007 --only
3009 Only installs the package in the current directory.
3010 --haddock-hoogle
3012 Generate a hoogle database
3013 --haddock-html
3015 Generate HTML documentation (the default)
3016 --haddock-html-location URL
3018 Location of HTML documentation for pre-requisite packages
3019 --haddock-for-hackage
3021 Collection of flags to generate documentation suitable
3022 for upload to hackage
3023 --haddock-executables
3025 Run haddock for Executables targets
3026 --haddock-tests
3028 Run haddock for Test Suite targets
3029 --haddock-benchmarks
3031 Run haddock for Benchmark targets
3032 --haddock-all
3034 Run haddock for all targets
3035 --haddock-internal
3037 Run haddock for internal modules and include all symbols
3038 --haddock-css PATH
3040 Use PATH as the haddock stylesheet
3041 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
3043 dock-hyperlinked-source
3044 Hyperlink the documentation to the source code
3045 --haddock-quickjump
3047 Generate an index for interactive documentation naviga‐
3048 tion
3049 --haddock-hscolour-css PATH
3051 Use PATH as the HsColour stylesheet
3052 --haddock-contents-location URL
3054 Bake URL in as the location for the contents page
3055 --test-log TEMPLATE
3057 Log all test suite results to file (name template can use
3058 $pkgid, $compiler, $os, $arch, $test-suite, $result)
3059 --test-machine-log TEMPLATE
3061 Produce a machine-readable log file (name template can
3062 use $pkgid, $compiler, $os, $arch, $result)
3063 --test-show-details FILTER
3065 --test-keep-tix-files
3067 keep .tix files for HPC between test runs
3068 --test-wrapper FILE
3070 Run test through a wrapper.
3071 --test-fail-when-no-test-suites
3073 Exit with failure when no test suites are found.
3074 --test-options TEMPLATES
3076 give extra options to test executables (name templates
3077 can use $pkgid, $compiler, $os, $arch, $test-suite)
3078 --test-option TEMPLATE
3080 give extra option to test executables (no need to quote
3081 options containing spaces, name template can use $pkgid,
3082 $compiler, $os, $arch, $test-suite)
3083 --benchmark-options TEMPLATES
3085 give extra options to benchmark executables (name tem‐
3086 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
3087 --benchmark-option TEMPLATE
3089 give extra option to benchmark executables (no need to
3090 quote options containing spaces, name template can use
3091 $pkgid, $compiler, $os, $arch, $benchmark)
3092 cabal update
3095 Usage: cabal update [FLAGS] [REPOS]
3097 For all known remote repositories, download the package list.
3100 For all known remote repositories, download the package list.
3103 Flags:
3106 -v, --verbose [n]
3107 Control verbosity (n is 0--3, default verbosity level is
3108 1)
3109 --builddir, --distdir, --distpref DIR
3111 The directory where Cabal puts generated build files (de‐
3112 fault dist)
3113 -g, --ghc
3115 compile with GHC
3116 --ghcjs
3118 compile with GHCJS
3119 --uhc
3121 compile with UHC
3122 --haskell-suite
3124 compile with a haskell-suite compiler
3125 --cabal-file PATH
3127 use this Cabal file
3128 -w, --with-compiler PATH
3130 give the path to a particular compiler
3131 --with-hc-pkg PATH
3133 give the path to the package tool
3134 --prefix DIR
3136 bake this prefix in preparation of installation
3137 --bindir DIR
3139 installation directory for executables
3140 --libdir DIR
3142 installation directory for libraries
3143 --libsubdir DIR
3145 subdirectory of libdir in which libs are installed
3146 --dynlibdir DIR
3148 installation directory for dynamic libraries
3149 --libexecdir DIR
3151 installation directory for program executables
3152 --libexecsubdir DIR
3154 subdirectory of libexecdir in which private executables
3155 are installed
3156 --datadir DIR
3158 installation directory for read-only data
3159 --datasubdir DIR
3161 subdirectory of datadir in which data files are installed
3162 --docdir DIR
3164 installation directory for documentation
3165 --htmldir DIR
3167 installation directory for HTML documentation
3168 --haddockdir DIR
3170 installation directory for haddock interfaces
3171 --sysconfdir DIR
3173 installation directory for configuration files
3174 --program-prefix PREFIX
3176 prefix to be applied to installed executables
3177 --program-suffix SUFFIX
3179 suffix to be applied to installed executables
3180 --enable-library-vanilla
3182 --disable-library-vanilla
3183 Vanilla libraries
3184 -p, --enable-library-profiling
3186 --disable-library-profiling
3187 Library profiling
3188 --enable-shared
3190 --disable-shared
3191 Shared library
3192 --enable-static
3194 --disable-static
3195 Static library
3196 --enable-executable-dynamic
3198 --disable-executable-dynamic
3199 Executable dynamic linking
3200 --enable-executable-static
3202 --disable-executable-static
3203 Executable fully static linking
3204 --enable-profiling
3206 --disable-profiling
3207 Executable and library profiling
3208 --enable-executable-profiling
3210 --disable-executable-profiling
3211 Executable profiling (DEPRECATED)
3212 --profiling-detail level
3214 Profiling detail level for executable and library (de‐
3215 fault, none, exported-functions, toplevel-functions,
3216 all-functions).
3217 --library-profiling-detail level
3219 Profiling detail level for libraries only.
3220 -O, --enable-optimization, --enable-optimisation [n]
3222 Build with optimization (n is 0--2, default is 1)
3223 --disable-optimization, --disable-optimisation
3225 Build without optimization
3226 --enable-debug-info [n]
3228 Emit debug info (n is 0--3, default is 0)
3229 --disable-debug-info
3231 Don't emit debug info
3232 --enable-library-for-ghci
3234 --disable-library-for-ghci
3235 compile library for use with GHCi
3236 --enable-split-sections
3238 --disable-split-sections
3239 compile library code such that unneeded definitions can
3240 be dropped from the final executable (GHC 7.8+)
3241 --enable-split-objs
3243 --disable-split-objs
3244 split library into smaller objects to reduce binary sizes
3245 (GHC 6.6+)
3246 --enable-executable-stripping
3248 --disable-executable-stripping
3249 strip executables upon installation to reduce binary
3250 sizes
3251 --enable-library-stripping
3253 --disable-library-stripping
3254 strip libraries upon installation to reduce binary sizes
3255 --configure-option OPT
3257 Extra option for configure
3258 --user
3260 --global
3261 doing a per-user installation
3262 --package-db DB
3264 Append the given package database to the list of package
3265 databases used (to satisfy dependencies and register
3266 into). May be a specific file, 'global' or 'user'. The
3267 initial list is ['global'], ['global', 'user'], or
3268 ['global', $sandbox], depending on context. Use 'clear'
3269 to reset the list to empty. See the user guide for de‐
3270 tails.
3271 -f, --flags FLAGS
3273 Force values for the given flags in Cabal conditionals in
3274 the .cabal file. E.g., --flags="debug -usebytestrings"
3275 forces the flag "debug" to true and "usebytestrings" to
3276 false.
3277 --extra-include-dirs PATH
3279 A list of directories to search for header files
3280 --enable-deterministic
3282 --disable-deterministic
3283 Try to be as deterministic as possible (used by the test
3284 suite)
3285 --ipid IPID
3287 Installed package ID to compile this package as
3288 --cid CID
3290 Installed component ID to compile this component as
3291 --extra-lib-dirs PATH
3293 A list of directories to search for external libraries
3294 --extra-framework-dirs PATH
3296 A list of directories to search for external frameworks
3297 (OS X only)
3298 --extra-prog-path PATH
3300 A list of directories to search for required programs (in
3301 addition to the normal search locations)
3302 --instantiate-with NAME=MOD
3304 A mapping of signature names to concrete module instanti‐
3305 ations.
3306 --enable-tests
3308 --disable-tests
3309 dependency checking and compilation for test suites
3310 listed in the package description file.
3311 --enable-coverage
3313 --disable-coverage
3314 build package with Haskell Program Coverage. (GHC only)
3315 --enable-library-coverage
3317 --disable-library-coverage
3318 build package with Haskell Program Coverage. (GHC only)
3319 (DEPRECATED)
3320 --enable-benchmarks
3322 --disable-benchmarks
3323 dependency checking and compilation for benchmarks listed
3324 in the package description file.
3325 --enable-relocatable
3327 --disable-relocatable
3328 building a package that is relocatable. (GHC only)
3329 --disable-response-files
3331 enable workaround for old versions of programs like "ar"
3332 that do not support @file arguments
3333 --allow-depending-on-private-libs
3335 Allow depending on private libraries. If set, the library
3336 visibility check MUST be done externally.
3337 --with-alex PATH
3339 give the path to alex
3340 --with-ar PATH
3342 give the path to ar
3343 --with-c2hs PATH
3345 give the path to c2hs
3346 --with-cpphs PATH
3348 give the path to cpphs
3349 --with-doctest PATH
3351 give the path to doctest
3352 --with-gcc PATH
3354 give the path to gcc
3355 --with-ghc PATH
3357 give the path to ghc
3358 --with-ghc-pkg PATH
3360 give the path to ghc-pkg
3361 --with-ghcjs PATH
3363 give the path to ghcjs
3364 --with-ghcjs-pkg PATH
3366 give the path to ghcjs-pkg
3367 --with-greencard PATH
3369 give the path to greencard
3370 --with-haddock PATH
3372 give the path to haddock
3373 --with-happy PATH
3375 give the path to happy
3376 --with-haskell-suite PATH
3378 give the path to haskell-suite
3379 --with-haskell-suite-pkg PATH
3381 give the path to haskell-suite-pkg
3382 --with-hmake PATH
3384 give the path to hmake
3385 --with-hpc PATH
3387 give the path to hpc
3388 --with-hsc2hs PATH
3390 give the path to hsc2hs
3391 --with-hscolour PATH
3393 give the path to hscolour
3394 --with-jhc PATH
3396 give the path to jhc
3397 --with-ld PATH
3399 give the path to ld
3400 --with-pkg-config PATH
3402 give the path to pkg-config
3403 --with-runghc PATH
3405 give the path to runghc
3406 --with-strip PATH
3408 give the path to strip
3409 --with-tar PATH
3411 give the path to tar
3412 --with-uhc PATH
3414 give the path to uhc
3415 --alex-option OPT
3417 give an extra option to alex (no need to quote options
3418 containing spaces)
3419 --ar-option OPT
3421 give an extra option to ar (no need to quote options con‐
3422 taining spaces)
3423 --c2hs-option OPT
3425 give an extra option to c2hs (no need to quote options
3426 containing spaces)
3427 --cpphs-option OPT
3429 give an extra option to cpphs (no need to quote options
3430 containing spaces)
3431 --doctest-option OPT
3433 give an extra option to doctest (no need to quote options
3434 containing spaces)
3435 --gcc-option OPT
3437 give an extra option to gcc (no need to quote options
3438 containing spaces)
3439 --ghc-option OPT
3441 give an extra option to ghc (no need to quote options
3442 containing spaces)
3443 --ghc-pkg-option OPT
3445 give an extra option to ghc-pkg (no need to quote options
3446 containing spaces)
3447 --ghcjs-option OPT
3449 give an extra option to ghcjs (no need to quote options
3450 containing spaces)
3451 --ghcjs-pkg-option OPT
3453 give an extra option to ghcjs-pkg (no need to quote op‐
3454 tions containing spaces)
3455 --greencard-option OPT
3457 give an extra option to greencard (no need to quote op‐
3458 tions containing spaces)
3459 --haddock-option OPT
3461 give an extra option to haddock (no need to quote options
3462 containing spaces)
3463 --happy-option OPT
3465 give an extra option to happy (no need to quote options
3466 containing spaces)
3467 --haskell-suite-option OPT
3469 give an extra option to haskell-suite (no need to quote
3470 options containing spaces)
3471 --haskell-suite-pkg-option OPT
3473 give an extra option to haskell-suite-pkg (no need to
3474 quote options containing spaces)
3475 --hmake-option OPT
3477 give an extra option to hmake (no need to quote options
3478 containing spaces)
3479 --hpc-option OPT
3481 give an extra option to hpc (no need to quote options
3482 containing spaces)
3483 --hsc2hs-option OPT
3485 give an extra option to hsc2hs (no need to quote options
3486 containing spaces)
3487 --hscolour-option OPT
3489 give an extra option to hscolour (no need to quote op‐
3490 tions containing spaces)
3491 --jhc-option OPT
3493 give an extra option to jhc (no need to quote options
3494 containing spaces)
3495 --ld-option OPT
3497 give an extra option to ld (no need to quote options con‐
3498 taining spaces)
3499 --pkg-config-option OPT
3501 give an extra option to pkg-config (no need to quote op‐
3502 tions containing spaces)
3503 --runghc-option OPT
3505 give an extra option to runghc (no need to quote options
3506 containing spaces)
3507 --strip-option OPT
3509 give an extra option to strip (no need to quote options
3510 containing spaces)
3511 --tar-option OPT
3513 give an extra option to tar (no need to quote options
3514 containing spaces)
3515 --uhc-option OPT
3517 give an extra option to uhc (no need to quote options
3518 containing spaces)
3519 --alex-options OPTS
3521 give extra options to alex
3522 --ar-options OPTS
3524 give extra options to ar
3525 --c2hs-options OPTS
3527 give extra options to c2hs
3528 --cpphs-options OPTS
3530 give extra options to cpphs
3531 --doctest-options OPTS
3533 give extra options to doctest
3534 --gcc-options OPTS
3536 give extra options to gcc
3537 --ghc-options OPTS
3539 give extra options to ghc
3540 --ghc-pkg-options OPTS
3542 give extra options to ghc-pkg
3543 --ghcjs-options OPTS
3545 give extra options to ghcjs
3546 --ghcjs-pkg-options OPTS
3548 give extra options to ghcjs-pkg
3549 --greencard-options OPTS
3551 give extra options to greencard
3552 --haddock-options OPTS
3554 give extra options to haddock
3555 --happy-options OPTS
3557 give extra options to happy
3558 --haskell-suite-options OPTS
3560 give extra options to haskell-suite
3561 --haskell-suite-pkg-options OPTS
3563 give extra options to haskell-suite-pkg
3564 --hmake-options OPTS
3566 give extra options to hmake
3567 --hpc-options OPTS
3569 give extra options to hpc
3570 --hsc2hs-options OPTS
3572 give extra options to hsc2hs
3573 --hscolour-options OPTS
3575 give extra options to hscolour
3576 --jhc-options OPTS
3578 give extra options to jhc
3579 --ld-options OPTS
3581 give extra options to ld
3582 --pkg-config-options OPTS
3584 give extra options to pkg-config
3585 --runghc-options OPTS
3587 give extra options to runghc
3588 --strip-options OPTS
3590 give extra options to strip
3591 --tar-options OPTS
3593 give extra options to tar
3594 --uhc-options OPTS
3596 give extra options to uhc
3597 --cabal-lib-version VERSION
3599 Select which version of the Cabal lib to use to build
3600 packages (useful for testing).
3601 --constraint CONSTRAINT
3603 Specify constraints on a package (version, in‐
3604 stalled/source, flags)
3605 --preference CONSTRAINT
3607 Specify preferences (soft constraints) on the version of
3608 a package
3609 --solver SOLVER
3611 Select dependency solver to use (default: modular).
3612 Choices: modular.
3613 --allow-older [DEPS]
3615 Ignore lower bounds in all dependencies or DEPS
3616 --allow-newer [DEPS]
3618 Ignore upper bounds in all dependencies or DEPS
3619 --write-ghc-environment-files always|never|ghc8.4.4+
3621 Whether to create a .ghc.environment file after a suc‐
3622 cessful build (v2-build only)
3623 --enable-documentation
3625 --disable-documentation
3626 building of documentation
3627 --doc-index-file TEMPLATE
3629 A central index of haddock API documentation (template
3630 cannot use $pkgid)
3631 --dry-run
3633 Do not install anything, only print what would be in‐
3634 stalled.
3635 --max-backjumps NUM
3637 Maximum number of backjumps allowed while solving (de‐
3638 fault: 4000). Use a negative number to enable unlimited
3639 backtracking. Use 0 to disable backtracking completely.
3640 --reorder-goals
3642 --no-reorder-goals
3643 Try to reorder goals according to certain heuristics.
3644 Slows things down on average, but may make backtracking
3645 faster for some packages.
3646 --count-conflicts
3648 --no-count-conflicts
3649 Try to speed up solving by preferring goals that are in‐
3650 volved in a lot of conflicts (default).
3651 --fine-grained-conflicts
3653 --no-fine-grained-conflicts
3654 Skip a version of a package if it does not resolve the
3655 conflicts encountered in the last version, as a solver
3656 optimization (default).
3657 --minimize-conflict-set
3659 --no-minimize-conflict-set
3660 When there is no solution, try to improve the error mes‐
3661 sage by finding a minimal conflict set (default: false).
3662 May increase run time significantly.
3663 --independent-goals
3665 --no-independent-goals
3666 Treat several goals on the command line as independent.
3667 If several goals depend on the same package, different
3668 versions can be chosen.
3669 --shadow-installed-packages
3671 --no-shadow-installed-packages
3672 If multiple package instances of the same version are in‐
3673 stalled, treat all but one as shadowed.
3674 --strong-flags
3676 --no-strong-flags
3677 Do not defer flag choices (this used to be the default in
3678 cabal-install <= 1.20).
3679 --allow-boot-library-installs
3681 --no-allow-boot-library-installs
3682 Allow cabal to install base, ghc-prim, integer-simple,
3683 integer-gmp, and template-haskell.
3684 --reject-unconstrained-dependencies none|all
3686 Require these packages to have constraints on them if
3687 they are to be selected (default: none).
3688 --reinstall
3690 --no-reinstall
3691 Install even if it means installing the same version
3692 again.
3693 --avoid-reinstalls
3695 --no-avoid-reinstalls
3696 Do not select versions that would destructively overwrite
3697 installed packages.
3698 --force-reinstalls
3700 --no-force-reinstalls
3701 Reinstall packages even if they will most likely break
3702 other installed packages.
3703 --upgrade-dependencies
3705 --no-upgrade-dependencies
3706 Pick the latest version for all dependencies, rather than
3707 trying to pick an installed version.
3708 --only-dependencies
3710 --no-only-dependencies
3711 Install only the dependencies necessary to build the
3712 given packages
3713 --dependencies-only
3715 --no-dependencies-only
3716 A synonym for --only-dependencies
3717 --index-state STATE
3719 Use source package index state as it existed at a previ‐
3720 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
3721 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
3722 'HEAD' (default: 'HEAD').
3723 --root-cmd COMMAND
3725 (No longer supported, do not use.)
3726 --symlink-bindir DIR
3728 Add symlinks to installed executables into this direc‐
3729 tory.
3730 --build-summary TEMPLATE
3732 Save build summaries to file (name template can use
3733 $pkgid, $compiler, $os, $arch)
3734 --build-log TEMPLATE
3736 Log all builds to file (name template can use $pkgid,
3737 $compiler, $os, $arch)
3738 --remote-build-reporting LEVEL
3740 Generate build reports to send to a remote server (none,
3741 anonymous or detailed).
3742 --report-planning-failure
3744 Generate build reports when the dependency solver fails.
3745 This is used by the Hackage build bot.
3746 --enable-per-component
3748 --disable-per-component
3749 Per-component builds when possible
3750 --one-shot
3752 --no-one-shot
3753 Do not record the packages in the world file.
3754 --run-tests
3756 Run package test suites during installation.
3757 -j, --jobs [NUM]
3759 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
3760 given).
3761 --keep-going
3763 After a build failure, continue to build other unaffected
3764 packages.
3765 --offline
3767 --no-offline
3768 Don't download packages from the Internet.
3769 --project-file FILE
3771 Set the name of the cabal.project file to search for in
3772 parent directories
3773 --only
3775 Only installs the package in the current directory.
3776 --haddock-hoogle
3778 Generate a hoogle database
3779 --haddock-html
3781 Generate HTML documentation (the default)
3782 --haddock-html-location URL
3784 Location of HTML documentation for pre-requisite packages
3785 --haddock-for-hackage
3787 Collection of flags to generate documentation suitable
3788 for upload to hackage
3789 --haddock-executables
3791 Run haddock for Executables targets
3792 --haddock-tests
3794 Run haddock for Test Suite targets
3795 --haddock-benchmarks
3797 Run haddock for Benchmark targets
3798 --haddock-all
3800 Run haddock for all targets
3801 --haddock-internal
3803 Run haddock for internal modules and include all symbols
3804 --haddock-css PATH
3806 Use PATH as the haddock stylesheet
3807 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
3809 dock-hyperlinked-source
3810 Hyperlink the documentation to the source code
3811 --haddock-quickjump
3813 Generate an index for interactive documentation naviga‐
3814 tion
3815 --haddock-hscolour-css PATH
3817 Use PATH as the HsColour stylesheet
3818 --haddock-contents-location URL
3820 Bake URL in as the location for the contents page
3821 --test-log TEMPLATE
3823 Log all test suite results to file (name template can use
3824 $pkgid, $compiler, $os, $arch, $test-suite, $result)
3825 --test-machine-log TEMPLATE
3827 Produce a machine-readable log file (name template can
3828 use $pkgid, $compiler, $os, $arch, $result)
3829 --test-show-details FILTER
3831 --test-keep-tix-files
3833 keep .tix files for HPC between test runs
3834 --test-wrapper FILE
3836 Run test through a wrapper.
3837 --test-fail-when-no-test-suites
3839 Exit with failure when no test suites are found.
3840 --test-options TEMPLATES
3842 give extra options to test executables (name templates
3843 can use $pkgid, $compiler, $os, $arch, $test-suite)
3844 --test-option TEMPLATE
3846 give extra option to test executables (no need to quote
3847 options containing spaces, name template can use $pkgid,
3848 $compiler, $os, $arch, $test-suite)
3849 --benchmark-options TEMPLATES
3851 give extra options to benchmark executables (name tem‐
3852 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
3853 --benchmark-option TEMPLATE
3855 give extra option to benchmark executables (no need to
3856 quote options containing spaces, name template can use
3857 $pkgid, $compiler, $os, $arch, $benchmark)
3858 cabal new-update
3861 Usage: cabal new-update [FLAGS] [REPOS]
3863 For all known remote repositories, download the package list.
3866 For all known remote repositories, download the package list.
3869 Flags:
3872 -v, --verbose [n]
3873 Control verbosity (n is 0--3, default verbosity level is
3874 1)
3875 --builddir, --distdir, --distpref DIR
3877 The directory where Cabal puts generated build files (de‐
3878 fault dist)
3879 -g, --ghc
3881 compile with GHC
3882 --ghcjs
3884 compile with GHCJS
3885 --uhc
3887 compile with UHC
3888 --haskell-suite
3890 compile with a haskell-suite compiler
3891 --cabal-file PATH
3893 use this Cabal file
3894 -w, --with-compiler PATH
3896 give the path to a particular compiler
3897 --with-hc-pkg PATH
3899 give the path to the package tool
3900 --prefix DIR
3902 bake this prefix in preparation of installation
3903 --bindir DIR
3905 installation directory for executables
3906 --libdir DIR
3908 installation directory for libraries
3909 --libsubdir DIR
3911 subdirectory of libdir in which libs are installed
3912 --dynlibdir DIR
3914 installation directory for dynamic libraries
3915 --libexecdir DIR
3917 installation directory for program executables
3918 --libexecsubdir DIR
3920 subdirectory of libexecdir in which private executables
3921 are installed
3922 --datadir DIR
3924 installation directory for read-only data
3925 --datasubdir DIR
3927 subdirectory of datadir in which data files are installed
3928 --docdir DIR
3930 installation directory for documentation
3931 --htmldir DIR
3933 installation directory for HTML documentation
3934 --haddockdir DIR
3936 installation directory for haddock interfaces
3937 --sysconfdir DIR
3939 installation directory for configuration files
3940 --program-prefix PREFIX
3942 prefix to be applied to installed executables
3943 --program-suffix SUFFIX
3945 suffix to be applied to installed executables
3946 --enable-library-vanilla
3948 --disable-library-vanilla
3949 Vanilla libraries
3950 -p, --enable-library-profiling
3952 --disable-library-profiling
3953 Library profiling
3954 --enable-shared
3956 --disable-shared
3957 Shared library
3958 --enable-static
3960 --disable-static
3961 Static library
3962 --enable-executable-dynamic
3964 --disable-executable-dynamic
3965 Executable dynamic linking
3966 --enable-executable-static
3968 --disable-executable-static
3969 Executable fully static linking
3970 --enable-profiling
3972 --disable-profiling
3973 Executable and library profiling
3974 --enable-executable-profiling
3976 --disable-executable-profiling
3977 Executable profiling (DEPRECATED)
3978 --profiling-detail level
3980 Profiling detail level for executable and library (de‐
3981 fault, none, exported-functions, toplevel-functions,
3982 all-functions).
3983 --library-profiling-detail level
3985 Profiling detail level for libraries only.
3986 -O, --enable-optimization, --enable-optimisation [n]
3988 Build with optimization (n is 0--2, default is 1)
3989 --disable-optimization, --disable-optimisation
3991 Build without optimization
3992 --enable-debug-info [n]
3994 Emit debug info (n is 0--3, default is 0)
3995 --disable-debug-info
3997 Don't emit debug info
3998 --enable-library-for-ghci
4000 --disable-library-for-ghci
4001 compile library for use with GHCi
4002 --enable-split-sections
4004 --disable-split-sections
4005 compile library code such that unneeded definitions can
4006 be dropped from the final executable (GHC 7.8+)
4007 --enable-split-objs
4009 --disable-split-objs
4010 split library into smaller objects to reduce binary sizes
4011 (GHC 6.6+)
4012 --enable-executable-stripping
4014 --disable-executable-stripping
4015 strip executables upon installation to reduce binary
4016 sizes
4017 --enable-library-stripping
4019 --disable-library-stripping
4020 strip libraries upon installation to reduce binary sizes
4021 --configure-option OPT
4023 Extra option for configure
4024 --user
4026 --global
4027 doing a per-user installation
4028 --package-db DB
4030 Append the given package database to the list of package
4031 databases used (to satisfy dependencies and register
4032 into). May be a specific file, 'global' or 'user'. The
4033 initial list is ['global'], ['global', 'user'], or
4034 ['global', $sandbox], depending on context. Use 'clear'
4035 to reset the list to empty. See the user guide for de‐
4036 tails.
4037 -f, --flags FLAGS
4039 Force values for the given flags in Cabal conditionals in
4040 the .cabal file. E.g., --flags="debug -usebytestrings"
4041 forces the flag "debug" to true and "usebytestrings" to
4042 false.
4043 --extra-include-dirs PATH
4045 A list of directories to search for header files
4046 --enable-deterministic
4048 --disable-deterministic
4049 Try to be as deterministic as possible (used by the test
4050 suite)
4051 --ipid IPID
4053 Installed package ID to compile this package as
4054 --cid CID
4056 Installed component ID to compile this component as
4057 --extra-lib-dirs PATH
4059 A list of directories to search for external libraries
4060 --extra-framework-dirs PATH
4062 A list of directories to search for external frameworks
4063 (OS X only)
4064 --extra-prog-path PATH
4066 A list of directories to search for required programs (in
4067 addition to the normal search locations)
4068 --instantiate-with NAME=MOD
4070 A mapping of signature names to concrete module instanti‐
4071 ations.
4072 --enable-tests
4074 --disable-tests
4075 dependency checking and compilation for test suites
4076 listed in the package description file.
4077 --enable-coverage
4079 --disable-coverage
4080 build package with Haskell Program Coverage. (GHC only)
4081 --enable-library-coverage
4083 --disable-library-coverage
4084 build package with Haskell Program Coverage. (GHC only)
4085 (DEPRECATED)
4086 --enable-benchmarks
4088 --disable-benchmarks
4089 dependency checking and compilation for benchmarks listed
4090 in the package description file.
4091 --enable-relocatable
4093 --disable-relocatable
4094 building a package that is relocatable. (GHC only)
4095 --disable-response-files
4097 enable workaround for old versions of programs like "ar"
4098 that do not support @file arguments
4099 --allow-depending-on-private-libs
4101 Allow depending on private libraries. If set, the library
4102 visibility check MUST be done externally.
4103 --with-alex PATH
4105 give the path to alex
4106 --with-ar PATH
4108 give the path to ar
4109 --with-c2hs PATH
4111 give the path to c2hs
4112 --with-cpphs PATH
4114 give the path to cpphs
4115 --with-doctest PATH
4117 give the path to doctest
4118 --with-gcc PATH
4120 give the path to gcc
4121 --with-ghc PATH
4123 give the path to ghc
4124 --with-ghc-pkg PATH
4126 give the path to ghc-pkg
4127 --with-ghcjs PATH
4129 give the path to ghcjs
4130 --with-ghcjs-pkg PATH
4132 give the path to ghcjs-pkg
4133 --with-greencard PATH
4135 give the path to greencard
4136 --with-haddock PATH
4138 give the path to haddock
4139 --with-happy PATH
4141 give the path to happy
4142 --with-haskell-suite PATH
4144 give the path to haskell-suite
4145 --with-haskell-suite-pkg PATH
4147 give the path to haskell-suite-pkg
4148 --with-hmake PATH
4150 give the path to hmake
4151 --with-hpc PATH
4153 give the path to hpc
4154 --with-hsc2hs PATH
4156 give the path to hsc2hs
4157 --with-hscolour PATH
4159 give the path to hscolour
4160 --with-jhc PATH
4162 give the path to jhc
4163 --with-ld PATH
4165 give the path to ld
4166 --with-pkg-config PATH
4168 give the path to pkg-config
4169 --with-runghc PATH
4171 give the path to runghc
4172 --with-strip PATH
4174 give the path to strip
4175 --with-tar PATH
4177 give the path to tar
4178 --with-uhc PATH
4180 give the path to uhc
4181 --alex-option OPT
4183 give an extra option to alex (no need to quote options
4184 containing spaces)
4185 --ar-option OPT
4187 give an extra option to ar (no need to quote options con‐
4188 taining spaces)
4189 --c2hs-option OPT
4191 give an extra option to c2hs (no need to quote options
4192 containing spaces)
4193 --cpphs-option OPT
4195 give an extra option to cpphs (no need to quote options
4196 containing spaces)
4197 --doctest-option OPT
4199 give an extra option to doctest (no need to quote options
4200 containing spaces)
4201 --gcc-option OPT
4203 give an extra option to gcc (no need to quote options
4204 containing spaces)
4205 --ghc-option OPT
4207 give an extra option to ghc (no need to quote options
4208 containing spaces)
4209 --ghc-pkg-option OPT
4211 give an extra option to ghc-pkg (no need to quote options
4212 containing spaces)
4213 --ghcjs-option OPT
4215 give an extra option to ghcjs (no need to quote options
4216 containing spaces)
4217 --ghcjs-pkg-option OPT
4219 give an extra option to ghcjs-pkg (no need to quote op‐
4220 tions containing spaces)
4221 --greencard-option OPT
4223 give an extra option to greencard (no need to quote op‐
4224 tions containing spaces)
4225 --haddock-option OPT
4227 give an extra option to haddock (no need to quote options
4228 containing spaces)
4229 --happy-option OPT
4231 give an extra option to happy (no need to quote options
4232 containing spaces)
4233 --haskell-suite-option OPT
4235 give an extra option to haskell-suite (no need to quote
4236 options containing spaces)
4237 --haskell-suite-pkg-option OPT
4239 give an extra option to haskell-suite-pkg (no need to
4240 quote options containing spaces)
4241 --hmake-option OPT
4243 give an extra option to hmake (no need to quote options
4244 containing spaces)
4245 --hpc-option OPT
4247 give an extra option to hpc (no need to quote options
4248 containing spaces)
4249 --hsc2hs-option OPT
4251 give an extra option to hsc2hs (no need to quote options
4252 containing spaces)
4253 --hscolour-option OPT
4255 give an extra option to hscolour (no need to quote op‐
4256 tions containing spaces)
4257 --jhc-option OPT
4259 give an extra option to jhc (no need to quote options
4260 containing spaces)
4261 --ld-option OPT
4263 give an extra option to ld (no need to quote options con‐
4264 taining spaces)
4265 --pkg-config-option OPT
4267 give an extra option to pkg-config (no need to quote op‐
4268 tions containing spaces)
4269 --runghc-option OPT
4271 give an extra option to runghc (no need to quote options
4272 containing spaces)
4273 --strip-option OPT
4275 give an extra option to strip (no need to quote options
4276 containing spaces)
4277 --tar-option OPT
4279 give an extra option to tar (no need to quote options
4280 containing spaces)
4281 --uhc-option OPT
4283 give an extra option to uhc (no need to quote options
4284 containing spaces)
4285 --alex-options OPTS
4287 give extra options to alex
4288 --ar-options OPTS
4290 give extra options to ar
4291 --c2hs-options OPTS
4293 give extra options to c2hs
4294 --cpphs-options OPTS
4296 give extra options to cpphs
4297 --doctest-options OPTS
4299 give extra options to doctest
4300 --gcc-options OPTS
4302 give extra options to gcc
4303 --ghc-options OPTS
4305 give extra options to ghc
4306 --ghc-pkg-options OPTS
4308 give extra options to ghc-pkg
4309 --ghcjs-options OPTS
4311 give extra options to ghcjs
4312 --ghcjs-pkg-options OPTS
4314 give extra options to ghcjs-pkg
4315 --greencard-options OPTS
4317 give extra options to greencard
4318 --haddock-options OPTS
4320 give extra options to haddock
4321 --happy-options OPTS
4323 give extra options to happy
4324 --haskell-suite-options OPTS
4326 give extra options to haskell-suite
4327 --haskell-suite-pkg-options OPTS
4329 give extra options to haskell-suite-pkg
4330 --hmake-options OPTS
4332 give extra options to hmake
4333 --hpc-options OPTS
4335 give extra options to hpc
4336 --hsc2hs-options OPTS
4338 give extra options to hsc2hs
4339 --hscolour-options OPTS
4341 give extra options to hscolour
4342 --jhc-options OPTS
4344 give extra options to jhc
4345 --ld-options OPTS
4347 give extra options to ld
4348 --pkg-config-options OPTS
4350 give extra options to pkg-config
4351 --runghc-options OPTS
4353 give extra options to runghc
4354 --strip-options OPTS
4356 give extra options to strip
4357 --tar-options OPTS
4359 give extra options to tar
4360 --uhc-options OPTS
4362 give extra options to uhc
4363 --cabal-lib-version VERSION
4365 Select which version of the Cabal lib to use to build
4366 packages (useful for testing).
4367 --constraint CONSTRAINT
4369 Specify constraints on a package (version, in‐
4370 stalled/source, flags)
4371 --preference CONSTRAINT
4373 Specify preferences (soft constraints) on the version of
4374 a package
4375 --solver SOLVER
4377 Select dependency solver to use (default: modular).
4378 Choices: modular.
4379 --allow-older [DEPS]
4381 Ignore lower bounds in all dependencies or DEPS
4382 --allow-newer [DEPS]
4384 Ignore upper bounds in all dependencies or DEPS
4385 --write-ghc-environment-files always|never|ghc8.4.4+
4387 Whether to create a .ghc.environment file after a suc‐
4388 cessful build (v2-build only)
4389 --enable-documentation
4391 --disable-documentation
4392 building of documentation
4393 --doc-index-file TEMPLATE
4395 A central index of haddock API documentation (template
4396 cannot use $pkgid)
4397 --dry-run
4399 Do not install anything, only print what would be in‐
4400 stalled.
4401 --max-backjumps NUM
4403 Maximum number of backjumps allowed while solving (de‐
4404 fault: 4000). Use a negative number to enable unlimited
4405 backtracking. Use 0 to disable backtracking completely.
4406 --reorder-goals
4408 --no-reorder-goals
4409 Try to reorder goals according to certain heuristics.
4410 Slows things down on average, but may make backtracking
4411 faster for some packages.
4412 --count-conflicts
4414 --no-count-conflicts
4415 Try to speed up solving by preferring goals that are in‐
4416 volved in a lot of conflicts (default).
4417 --fine-grained-conflicts
4419 --no-fine-grained-conflicts
4420 Skip a version of a package if it does not resolve the
4421 conflicts encountered in the last version, as a solver
4422 optimization (default).
4423 --minimize-conflict-set
4425 --no-minimize-conflict-set
4426 When there is no solution, try to improve the error mes‐
4427 sage by finding a minimal conflict set (default: false).
4428 May increase run time significantly.
4429 --independent-goals
4431 --no-independent-goals
4432 Treat several goals on the command line as independent.
4433 If several goals depend on the same package, different
4434 versions can be chosen.
4435 --shadow-installed-packages
4437 --no-shadow-installed-packages
4438 If multiple package instances of the same version are in‐
4439 stalled, treat all but one as shadowed.
4440 --strong-flags
4442 --no-strong-flags
4443 Do not defer flag choices (this used to be the default in
4444 cabal-install <= 1.20).
4445 --allow-boot-library-installs
4447 --no-allow-boot-library-installs
4448 Allow cabal to install base, ghc-prim, integer-simple,
4449 integer-gmp, and template-haskell.
4450 --reject-unconstrained-dependencies none|all
4452 Require these packages to have constraints on them if
4453 they are to be selected (default: none).
4454 --reinstall
4456 --no-reinstall
4457 Install even if it means installing the same version
4458 again.
4459 --avoid-reinstalls
4461 --no-avoid-reinstalls
4462 Do not select versions that would destructively overwrite
4463 installed packages.
4464 --force-reinstalls
4466 --no-force-reinstalls
4467 Reinstall packages even if they will most likely break
4468 other installed packages.
4469 --upgrade-dependencies
4471 --no-upgrade-dependencies
4472 Pick the latest version for all dependencies, rather than
4473 trying to pick an installed version.
4474 --only-dependencies
4476 --no-only-dependencies
4477 Install only the dependencies necessary to build the
4478 given packages
4479 --dependencies-only
4481 --no-dependencies-only
4482 A synonym for --only-dependencies
4483 --index-state STATE
4485 Use source package index state as it existed at a previ‐
4486 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
4487 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
4488 'HEAD' (default: 'HEAD').
4489 --root-cmd COMMAND
4491 (No longer supported, do not use.)
4492 --symlink-bindir DIR
4494 Add symlinks to installed executables into this direc‐
4495 tory.
4496 --build-summary TEMPLATE
4498 Save build summaries to file (name template can use
4499 $pkgid, $compiler, $os, $arch)
4500 --build-log TEMPLATE
4502 Log all builds to file (name template can use $pkgid,
4503 $compiler, $os, $arch)
4504 --remote-build-reporting LEVEL
4506 Generate build reports to send to a remote server (none,
4507 anonymous or detailed).
4508 --report-planning-failure
4510 Generate build reports when the dependency solver fails.
4511 This is used by the Hackage build bot.
4512 --enable-per-component
4514 --disable-per-component
4515 Per-component builds when possible
4516 --one-shot
4518 --no-one-shot
4519 Do not record the packages in the world file.
4520 --run-tests
4522 Run package test suites during installation.
4523 -j, --jobs [NUM]
4525 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
4526 given).
4527 --keep-going
4529 After a build failure, continue to build other unaffected
4530 packages.
4531 --offline
4533 --no-offline
4534 Don't download packages from the Internet.
4535 --project-file FILE
4537 Set the name of the cabal.project file to search for in
4538 parent directories
4539 --only
4541 Only installs the package in the current directory.
4542 --haddock-hoogle
4544 Generate a hoogle database
4545 --haddock-html
4547 Generate HTML documentation (the default)
4548 --haddock-html-location URL
4550 Location of HTML documentation for pre-requisite packages
4551 --haddock-for-hackage
4553 Collection of flags to generate documentation suitable
4554 for upload to hackage
4555 --haddock-executables
4557 Run haddock for Executables targets
4558 --haddock-tests
4560 Run haddock for Test Suite targets
4561 --haddock-benchmarks
4563 Run haddock for Benchmark targets
4564 --haddock-all
4566 Run haddock for all targets
4567 --haddock-internal
4569 Run haddock for internal modules and include all symbols
4570 --haddock-css PATH
4572 Use PATH as the haddock stylesheet
4573 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
4575 dock-hyperlinked-source
4576 Hyperlink the documentation to the source code
4577 --haddock-quickjump
4579 Generate an index for interactive documentation naviga‐
4580 tion
4581 --haddock-hscolour-css PATH
4583 Use PATH as the HsColour stylesheet
4584 --haddock-contents-location URL
4586 Bake URL in as the location for the contents page
4587 --test-log TEMPLATE
4589 Log all test suite results to file (name template can use
4590 $pkgid, $compiler, $os, $arch, $test-suite, $result)
4591 --test-machine-log TEMPLATE
4593 Produce a machine-readable log file (name template can
4594 use $pkgid, $compiler, $os, $arch, $result)
4595 --test-show-details FILTER
4597 --test-keep-tix-files
4599 keep .tix files for HPC between test runs
4600 --test-wrapper FILE
4602 Run test through a wrapper.
4603 --test-fail-when-no-test-suites
4605 Exit with failure when no test suites are found.
4606 --test-options TEMPLATES
4608 give extra options to test executables (name templates
4609 can use $pkgid, $compiler, $os, $arch, $test-suite)
4610 --test-option TEMPLATE
4612 give extra option to test executables (no need to quote
4613 options containing spaces, name template can use $pkgid,
4614 $compiler, $os, $arch, $test-suite)
4615 --benchmark-options TEMPLATES
4617 give extra options to benchmark executables (name tem‐
4618 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
4619 --benchmark-option TEMPLATE
4621 give extra option to benchmark executables (no need to
4622 quote options containing spaces, name template can use
4623 $pkgid, $compiler, $os, $arch, $benchmark)
4624 cabal v2-update
4627 Usage: cabal v2-update [FLAGS] [REPOS]
4629 For all known remote repositories, download the package list.
4632 REPO has the format <repo-id>[,<index-state>] where index-state follows
4635 the same format and syntax that is supported by the --index-state flag.
4636 Examples:
4638 cabal v2-update
4639 Download the package list for all known remote repositories.
4640 cabal v2-update hackage.haskell.org,@1474732068
4642 cabal v2-update hackage.haskell.org,2016-09-24T17:47:48Z
4643 cabal v2-update hackage.haskell.org,HEAD
4644 cabal v2-update hackage.haskell.org
4645 Download hackage.haskell.org at a specific index state.
4646 cabal new update hackage.haskell.org head.hackage
4648 Download hackage.haskell.org and head.hackage
4649 head.hackage must be a known repo-id. E.g. from
4650 your cabal.project(.local) file.
4651 Note: this command is part of the new project-based system (aka nix-
4653 style local builds). These features are currently in beta. Please see
4654 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
4655 details and advice on what you can expect to work. If you encounter
4656 problems please file issues at https://github.com/haskell/cabal/issues
4657 and if you have any time to get involved and help with testing, fixing
4658 bugs etc then that is very much appreciated.
4659 Flags:
4662 -v, --verbose [n]
4663 Control verbosity (n is 0--3, default verbosity level is
4664 1)
4665 --builddir, --distdir, --distpref DIR
4667 The directory where Cabal puts generated build files (de‐
4668 fault dist)
4669 -g, --ghc
4671 compile with GHC
4672 --ghcjs
4674 compile with GHCJS
4675 --uhc
4677 compile with UHC
4678 --haskell-suite
4680 compile with a haskell-suite compiler
4681 --cabal-file PATH
4683 use this Cabal file
4684 -w, --with-compiler PATH
4686 give the path to a particular compiler
4687 --with-hc-pkg PATH
4689 give the path to the package tool
4690 --prefix DIR
4692 bake this prefix in preparation of installation
4693 --bindir DIR
4695 installation directory for executables
4696 --libdir DIR
4698 installation directory for libraries
4699 --libsubdir DIR
4701 subdirectory of libdir in which libs are installed
4702 --dynlibdir DIR
4704 installation directory for dynamic libraries
4705 --libexecdir DIR
4707 installation directory for program executables
4708 --libexecsubdir DIR
4710 subdirectory of libexecdir in which private executables
4711 are installed
4712 --datadir DIR
4714 installation directory for read-only data
4715 --datasubdir DIR
4717 subdirectory of datadir in which data files are installed
4718 --docdir DIR
4720 installation directory for documentation
4721 --htmldir DIR
4723 installation directory for HTML documentation
4724 --haddockdir DIR
4726 installation directory for haddock interfaces
4727 --sysconfdir DIR
4729 installation directory for configuration files
4730 --program-prefix PREFIX
4732 prefix to be applied to installed executables
4733 --program-suffix SUFFIX
4735 suffix to be applied to installed executables
4736 --enable-library-vanilla
4738 --disable-library-vanilla
4739 Vanilla libraries
4740 -p, --enable-library-profiling
4742 --disable-library-profiling
4743 Library profiling
4744 --enable-shared
4746 --disable-shared
4747 Shared library
4748 --enable-static
4750 --disable-static
4751 Static library
4752 --enable-executable-dynamic
4754 --disable-executable-dynamic
4755 Executable dynamic linking
4756 --enable-executable-static
4758 --disable-executable-static
4759 Executable fully static linking
4760 --enable-profiling
4762 --disable-profiling
4763 Executable and library profiling
4764 --enable-executable-profiling
4766 --disable-executable-profiling
4767 Executable profiling (DEPRECATED)
4768 --profiling-detail level
4770 Profiling detail level for executable and library (de‐
4771 fault, none, exported-functions, toplevel-functions,
4772 all-functions).
4773 --library-profiling-detail level
4775 Profiling detail level for libraries only.
4776 -O, --enable-optimization, --enable-optimisation [n]
4778 Build with optimization (n is 0--2, default is 1)
4779 --disable-optimization, --disable-optimisation
4781 Build without optimization
4782 --enable-debug-info [n]
4784 Emit debug info (n is 0--3, default is 0)
4785 --disable-debug-info
4787 Don't emit debug info
4788 --enable-library-for-ghci
4790 --disable-library-for-ghci
4791 compile library for use with GHCi
4792 --enable-split-sections
4794 --disable-split-sections
4795 compile library code such that unneeded definitions can
4796 be dropped from the final executable (GHC 7.8+)
4797 --enable-split-objs
4799 --disable-split-objs
4800 split library into smaller objects to reduce binary sizes
4801 (GHC 6.6+)
4802 --enable-executable-stripping
4804 --disable-executable-stripping
4805 strip executables upon installation to reduce binary
4806 sizes
4807 --enable-library-stripping
4809 --disable-library-stripping
4810 strip libraries upon installation to reduce binary sizes
4811 --configure-option OPT
4813 Extra option for configure
4814 --user
4816 --global
4817 doing a per-user installation
4818 --package-db DB
4820 Append the given package database to the list of package
4821 databases used (to satisfy dependencies and register
4822 into). May be a specific file, 'global' or 'user'. The
4823 initial list is ['global'], ['global', 'user'], or
4824 ['global', $sandbox], depending on context. Use 'clear'
4825 to reset the list to empty. See the user guide for de‐
4826 tails.
4827 -f, --flags FLAGS
4829 Force values for the given flags in Cabal conditionals in
4830 the .cabal file. E.g., --flags="debug -usebytestrings"
4831 forces the flag "debug" to true and "usebytestrings" to
4832 false.
4833 --extra-include-dirs PATH
4835 A list of directories to search for header files
4836 --enable-deterministic
4838 --disable-deterministic
4839 Try to be as deterministic as possible (used by the test
4840 suite)
4841 --ipid IPID
4843 Installed package ID to compile this package as
4844 --cid CID
4846 Installed component ID to compile this component as
4847 --extra-lib-dirs PATH
4849 A list of directories to search for external libraries
4850 --extra-framework-dirs PATH
4852 A list of directories to search for external frameworks
4853 (OS X only)
4854 --extra-prog-path PATH
4856 A list of directories to search for required programs (in
4857 addition to the normal search locations)
4858 --instantiate-with NAME=MOD
4860 A mapping of signature names to concrete module instanti‐
4861 ations.
4862 --enable-tests
4864 --disable-tests
4865 dependency checking and compilation for test suites
4866 listed in the package description file.
4867 --enable-coverage
4869 --disable-coverage
4870 build package with Haskell Program Coverage. (GHC only)
4871 --enable-library-coverage
4873 --disable-library-coverage
4874 build package with Haskell Program Coverage. (GHC only)
4875 (DEPRECATED)
4876 --enable-benchmarks
4878 --disable-benchmarks
4879 dependency checking and compilation for benchmarks listed
4880 in the package description file.
4881 --enable-relocatable
4883 --disable-relocatable
4884 building a package that is relocatable. (GHC only)
4885 --disable-response-files
4887 enable workaround for old versions of programs like "ar"
4888 that do not support @file arguments
4889 --allow-depending-on-private-libs
4891 Allow depending on private libraries. If set, the library
4892 visibility check MUST be done externally.
4893 --with-alex PATH
4895 give the path to alex
4896 --with-ar PATH
4898 give the path to ar
4899 --with-c2hs PATH
4901 give the path to c2hs
4902 --with-cpphs PATH
4904 give the path to cpphs
4905 --with-doctest PATH
4907 give the path to doctest
4908 --with-gcc PATH
4910 give the path to gcc
4911 --with-ghc PATH
4913 give the path to ghc
4914 --with-ghc-pkg PATH
4916 give the path to ghc-pkg
4917 --with-ghcjs PATH
4919 give the path to ghcjs
4920 --with-ghcjs-pkg PATH
4922 give the path to ghcjs-pkg
4923 --with-greencard PATH
4925 give the path to greencard
4926 --with-haddock PATH
4928 give the path to haddock
4929 --with-happy PATH
4931 give the path to happy
4932 --with-haskell-suite PATH
4934 give the path to haskell-suite
4935 --with-haskell-suite-pkg PATH
4937 give the path to haskell-suite-pkg
4938 --with-hmake PATH
4940 give the path to hmake
4941 --with-hpc PATH
4943 give the path to hpc
4944 --with-hsc2hs PATH
4946 give the path to hsc2hs
4947 --with-hscolour PATH
4949 give the path to hscolour
4950 --with-jhc PATH
4952 give the path to jhc
4953 --with-ld PATH
4955 give the path to ld
4956 --with-pkg-config PATH
4958 give the path to pkg-config
4959 --with-runghc PATH
4961 give the path to runghc
4962 --with-strip PATH
4964 give the path to strip
4965 --with-tar PATH
4967 give the path to tar
4968 --with-uhc PATH
4970 give the path to uhc
4971 --alex-option OPT
4973 give an extra option to alex (no need to quote options
4974 containing spaces)
4975 --ar-option OPT
4977 give an extra option to ar (no need to quote options con‐
4978 taining spaces)
4979 --c2hs-option OPT
4981 give an extra option to c2hs (no need to quote options
4982 containing spaces)
4983 --cpphs-option OPT
4985 give an extra option to cpphs (no need to quote options
4986 containing spaces)
4987 --doctest-option OPT
4989 give an extra option to doctest (no need to quote options
4990 containing spaces)
4991 --gcc-option OPT
4993 give an extra option to gcc (no need to quote options
4994 containing spaces)
4995 --ghc-option OPT
4997 give an extra option to ghc (no need to quote options
4998 containing spaces)
4999 --ghc-pkg-option OPT
5001 give an extra option to ghc-pkg (no need to quote options
5002 containing spaces)
5003 --ghcjs-option OPT
5005 give an extra option to ghcjs (no need to quote options
5006 containing spaces)
5007 --ghcjs-pkg-option OPT
5009 give an extra option to ghcjs-pkg (no need to quote op‐
5010 tions containing spaces)
5011 --greencard-option OPT
5013 give an extra option to greencard (no need to quote op‐
5014 tions containing spaces)
5015 --haddock-option OPT
5017 give an extra option to haddock (no need to quote options
5018 containing spaces)
5019 --happy-option OPT
5021 give an extra option to happy (no need to quote options
5022 containing spaces)
5023 --haskell-suite-option OPT
5025 give an extra option to haskell-suite (no need to quote
5026 options containing spaces)
5027 --haskell-suite-pkg-option OPT
5029 give an extra option to haskell-suite-pkg (no need to
5030 quote options containing spaces)
5031 --hmake-option OPT
5033 give an extra option to hmake (no need to quote options
5034 containing spaces)
5035 --hpc-option OPT
5037 give an extra option to hpc (no need to quote options
5038 containing spaces)
5039 --hsc2hs-option OPT
5041 give an extra option to hsc2hs (no need to quote options
5042 containing spaces)
5043 --hscolour-option OPT
5045 give an extra option to hscolour (no need to quote op‐
5046 tions containing spaces)
5047 --jhc-option OPT
5049 give an extra option to jhc (no need to quote options
5050 containing spaces)
5051 --ld-option OPT
5053 give an extra option to ld (no need to quote options con‐
5054 taining spaces)
5055 --pkg-config-option OPT
5057 give an extra option to pkg-config (no need to quote op‐
5058 tions containing spaces)
5059 --runghc-option OPT
5061 give an extra option to runghc (no need to quote options
5062 containing spaces)
5063 --strip-option OPT
5065 give an extra option to strip (no need to quote options
5066 containing spaces)
5067 --tar-option OPT
5069 give an extra option to tar (no need to quote options
5070 containing spaces)
5071 --uhc-option OPT
5073 give an extra option to uhc (no need to quote options
5074 containing spaces)
5075 --alex-options OPTS
5077 give extra options to alex
5078 --ar-options OPTS
5080 give extra options to ar
5081 --c2hs-options OPTS
5083 give extra options to c2hs
5084 --cpphs-options OPTS
5086 give extra options to cpphs
5087 --doctest-options OPTS
5089 give extra options to doctest
5090 --gcc-options OPTS
5092 give extra options to gcc
5093 --ghc-options OPTS
5095 give extra options to ghc
5096 --ghc-pkg-options OPTS
5098 give extra options to ghc-pkg
5099 --ghcjs-options OPTS
5101 give extra options to ghcjs
5102 --ghcjs-pkg-options OPTS
5104 give extra options to ghcjs-pkg
5105 --greencard-options OPTS
5107 give extra options to greencard
5108 --haddock-options OPTS
5110 give extra options to haddock
5111 --happy-options OPTS
5113 give extra options to happy
5114 --haskell-suite-options OPTS
5116 give extra options to haskell-suite
5117 --haskell-suite-pkg-options OPTS
5119 give extra options to haskell-suite-pkg
5120 --hmake-options OPTS
5122 give extra options to hmake
5123 --hpc-options OPTS
5125 give extra options to hpc
5126 --hsc2hs-options OPTS
5128 give extra options to hsc2hs
5129 --hscolour-options OPTS
5131 give extra options to hscolour
5132 --jhc-options OPTS
5134 give extra options to jhc
5135 --ld-options OPTS
5137 give extra options to ld
5138 --pkg-config-options OPTS
5140 give extra options to pkg-config
5141 --runghc-options OPTS
5143 give extra options to runghc
5144 --strip-options OPTS
5146 give extra options to strip
5147 --tar-options OPTS
5149 give extra options to tar
5150 --uhc-options OPTS
5152 give extra options to uhc
5153 --cabal-lib-version VERSION
5155 Select which version of the Cabal lib to use to build
5156 packages (useful for testing).
5157 --constraint CONSTRAINT
5159 Specify constraints on a package (version, in‐
5160 stalled/source, flags)
5161 --preference CONSTRAINT
5163 Specify preferences (soft constraints) on the version of
5164 a package
5165 --solver SOLVER
5167 Select dependency solver to use (default: modular).
5168 Choices: modular.
5169 --allow-older [DEPS]
5171 Ignore lower bounds in all dependencies or DEPS
5172 --allow-newer [DEPS]
5174 Ignore upper bounds in all dependencies or DEPS
5175 --write-ghc-environment-files always|never|ghc8.4.4+
5177 Whether to create a .ghc.environment file after a suc‐
5178 cessful build (v2-build only)
5179 --enable-documentation
5181 --disable-documentation
5182 building of documentation
5183 --doc-index-file TEMPLATE
5185 A central index of haddock API documentation (template
5186 cannot use $pkgid)
5187 --dry-run
5189 Do not install anything, only print what would be in‐
5190 stalled.
5191 --max-backjumps NUM
5193 Maximum number of backjumps allowed while solving (de‐
5194 fault: 4000). Use a negative number to enable unlimited
5195 backtracking. Use 0 to disable backtracking completely.
5196 --reorder-goals
5198 --no-reorder-goals
5199 Try to reorder goals according to certain heuristics.
5200 Slows things down on average, but may make backtracking
5201 faster for some packages.
5202 --count-conflicts
5204 --no-count-conflicts
5205 Try to speed up solving by preferring goals that are in‐
5206 volved in a lot of conflicts (default).
5207 --fine-grained-conflicts
5209 --no-fine-grained-conflicts
5210 Skip a version of a package if it does not resolve the
5211 conflicts encountered in the last version, as a solver
5212 optimization (default).
5213 --minimize-conflict-set
5215 --no-minimize-conflict-set
5216 When there is no solution, try to improve the error mes‐
5217 sage by finding a minimal conflict set (default: false).
5218 May increase run time significantly.
5219 --independent-goals
5221 --no-independent-goals
5222 Treat several goals on the command line as independent.
5223 If several goals depend on the same package, different
5224 versions can be chosen.
5225 --shadow-installed-packages
5227 --no-shadow-installed-packages
5228 If multiple package instances of the same version are in‐
5229 stalled, treat all but one as shadowed.
5230 --strong-flags
5232 --no-strong-flags
5233 Do not defer flag choices (this used to be the default in
5234 cabal-install <= 1.20).
5235 --allow-boot-library-installs
5237 --no-allow-boot-library-installs
5238 Allow cabal to install base, ghc-prim, integer-simple,
5239 integer-gmp, and template-haskell.
5240 --reject-unconstrained-dependencies none|all
5242 Require these packages to have constraints on them if
5243 they are to be selected (default: none).
5244 --reinstall
5246 --no-reinstall
5247 Install even if it means installing the same version
5248 again.
5249 --avoid-reinstalls
5251 --no-avoid-reinstalls
5252 Do not select versions that would destructively overwrite
5253 installed packages.
5254 --force-reinstalls
5256 --no-force-reinstalls
5257 Reinstall packages even if they will most likely break
5258 other installed packages.
5259 --upgrade-dependencies
5261 --no-upgrade-dependencies
5262 Pick the latest version for all dependencies, rather than
5263 trying to pick an installed version.
5264 --only-dependencies
5266 --no-only-dependencies
5267 Install only the dependencies necessary to build the
5268 given packages
5269 --dependencies-only
5271 --no-dependencies-only
5272 A synonym for --only-dependencies
5273 --index-state STATE
5275 Use source package index state as it existed at a previ‐
5276 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
5277 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
5278 'HEAD' (default: 'HEAD').
5279 --root-cmd COMMAND
5281 (No longer supported, do not use.)
5282 --symlink-bindir DIR
5284 Add symlinks to installed executables into this direc‐
5285 tory.
5286 --build-summary TEMPLATE
5288 Save build summaries to file (name template can use
5289 $pkgid, $compiler, $os, $arch)
5290 --build-log TEMPLATE
5292 Log all builds to file (name template can use $pkgid,
5293 $compiler, $os, $arch)
5294 --remote-build-reporting LEVEL
5296 Generate build reports to send to a remote server (none,
5297 anonymous or detailed).
5298 --report-planning-failure
5300 Generate build reports when the dependency solver fails.
5301 This is used by the Hackage build bot.
5302 --enable-per-component
5304 --disable-per-component
5305 Per-component builds when possible
5306 --one-shot
5308 --no-one-shot
5309 Do not record the packages in the world file.
5310 --run-tests
5312 Run package test suites during installation.
5313 -j, --jobs [NUM]
5315 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
5316 given).
5317 --keep-going
5319 After a build failure, continue to build other unaffected
5320 packages.
5321 --offline
5323 --no-offline
5324 Don't download packages from the Internet.
5325 --project-file FILE
5327 Set the name of the cabal.project file to search for in
5328 parent directories
5329 --only
5331 Only installs the package in the current directory.
5332 --haddock-hoogle
5334 Generate a hoogle database
5335 --haddock-html
5337 Generate HTML documentation (the default)
5338 --haddock-html-location URL
5340 Location of HTML documentation for pre-requisite packages
5341 --haddock-for-hackage
5343 Collection of flags to generate documentation suitable
5344 for upload to hackage
5345 --haddock-executables
5347 Run haddock for Executables targets
5348 --haddock-tests
5350 Run haddock for Test Suite targets
5351 --haddock-benchmarks
5353 Run haddock for Benchmark targets
5354 --haddock-all
5356 Run haddock for all targets
5357 --haddock-internal
5359 Run haddock for internal modules and include all symbols
5360 --haddock-css PATH
5362 Use PATH as the haddock stylesheet
5363 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
5365 dock-hyperlinked-source
5366 Hyperlink the documentation to the source code
5367 --haddock-quickjump
5369 Generate an index for interactive documentation naviga‐
5370 tion
5371 --haddock-hscolour-css PATH
5373 Use PATH as the HsColour stylesheet
5374 --haddock-contents-location URL
5376 Bake URL in as the location for the contents page
5377 --test-log TEMPLATE
5379 Log all test suite results to file (name template can use
5380 $pkgid, $compiler, $os, $arch, $test-suite, $result)
5381 --test-machine-log TEMPLATE
5383 Produce a machine-readable log file (name template can
5384 use $pkgid, $compiler, $os, $arch, $result)
5385 --test-show-details FILTER
5387 --test-keep-tix-files
5389 keep .tix files for HPC between test runs
5390 --test-wrapper FILE
5392 Run test through a wrapper.
5393 --test-fail-when-no-test-suites
5395 Exit with failure when no test suites are found.
5396 --test-options TEMPLATES
5398 give extra options to test executables (name templates
5399 can use $pkgid, $compiler, $os, $arch, $test-suite)
5400 --test-option TEMPLATE
5402 give extra option to test executables (no need to quote
5403 options containing spaces, name template can use $pkgid,
5404 $compiler, $os, $arch, $test-suite)
5405 --benchmark-options TEMPLATES
5407 give extra options to benchmark executables (name tem‐
5408 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
5409 --benchmark-option TEMPLATE
5411 give extra option to benchmark executables (no need to
5412 quote options containing spaces, name template can use
5413 $pkgid, $compiler, $os, $arch, $benchmark)
5414 cabal build
5417 Usage: cabal build [TARGETS] [FLAGS]
5419 Build one or more targets from within the project. The available tar‐
5422 gets are the packages in the project as well as individual components
5423 within those packages, including libraries, executables, test-suites or
5424 benchmarks. Targets can be specified by name or location. If no target
5425 is specified then the default is to build the package in the current
5426 directory.
5427 Dependencies are built or rebuilt as necessary. Additional configura‐
5429 tion flags can be specified on the command line and these extend the
5430 project configuration from the 'cabal.project', 'cabal.project.local'
5431 and other files.
5432 Build one or more targets from within the project. The available tar‐
5435 gets are the packages in the project as well as individual components
5436 within those packages, including libraries, executables, test-suites or
5437 benchmarks. Targets can be specified by name or location. If no target
5438 is specified then the default is to build the package in the current
5439 directory.
5440 Dependencies are built or rebuilt as necessary. Additional configura‐
5442 tion flags can be specified on the command line and these extend the
5443 project configuration from the 'cabal.project', 'cabal.project.local'
5444 and other files.
5445 Flags:
5448 -v, --verbose [n]
5449 Control verbosity (n is 0--3, default verbosity level is
5450 1)
5451 --builddir, --distdir, --distpref DIR
5453 The directory where Cabal puts generated build files (de‐
5454 fault dist)
5455 -g, --ghc
5457 compile with GHC
5458 --ghcjs
5460 compile with GHCJS
5461 --uhc
5463 compile with UHC
5464 --haskell-suite
5466 compile with a haskell-suite compiler
5467 --cabal-file PATH
5469 use this Cabal file
5470 -w, --with-compiler PATH
5472 give the path to a particular compiler
5473 --with-hc-pkg PATH
5475 give the path to the package tool
5476 --prefix DIR
5478 bake this prefix in preparation of installation
5479 --bindir DIR
5481 installation directory for executables
5482 --libdir DIR
5484 installation directory for libraries
5485 --libsubdir DIR
5487 subdirectory of libdir in which libs are installed
5488 --dynlibdir DIR
5490 installation directory for dynamic libraries
5491 --libexecdir DIR
5493 installation directory for program executables
5494 --libexecsubdir DIR
5496 subdirectory of libexecdir in which private executables
5497 are installed
5498 --datadir DIR
5500 installation directory for read-only data
5501 --datasubdir DIR
5503 subdirectory of datadir in which data files are installed
5504 --docdir DIR
5506 installation directory for documentation
5507 --htmldir DIR
5509 installation directory for HTML documentation
5510 --haddockdir DIR
5512 installation directory for haddock interfaces
5513 --sysconfdir DIR
5515 installation directory for configuration files
5516 --program-prefix PREFIX
5518 prefix to be applied to installed executables
5519 --program-suffix SUFFIX
5521 suffix to be applied to installed executables
5522 --enable-library-vanilla
5524 --disable-library-vanilla
5525 Vanilla libraries
5526 -p, --enable-library-profiling
5528 --disable-library-profiling
5529 Library profiling
5530 --enable-shared
5532 --disable-shared
5533 Shared library
5534 --enable-static
5536 --disable-static
5537 Static library
5538 --enable-executable-dynamic
5540 --disable-executable-dynamic
5541 Executable dynamic linking
5542 --enable-executable-static
5544 --disable-executable-static
5545 Executable fully static linking
5546 --enable-profiling
5548 --disable-profiling
5549 Executable and library profiling
5550 --enable-executable-profiling
5552 --disable-executable-profiling
5553 Executable profiling (DEPRECATED)
5554 --profiling-detail level
5556 Profiling detail level for executable and library (de‐
5557 fault, none, exported-functions, toplevel-functions,
5558 all-functions).
5559 --library-profiling-detail level
5561 Profiling detail level for libraries only.
5562 -O, --enable-optimization, --enable-optimisation [n]
5564 Build with optimization (n is 0--2, default is 1)
5565 --disable-optimization, --disable-optimisation
5567 Build without optimization
5568 --enable-debug-info [n]
5570 Emit debug info (n is 0--3, default is 0)
5571 --disable-debug-info
5573 Don't emit debug info
5574 --enable-library-for-ghci
5576 --disable-library-for-ghci
5577 compile library for use with GHCi
5578 --enable-split-sections
5580 --disable-split-sections
5581 compile library code such that unneeded definitions can
5582 be dropped from the final executable (GHC 7.8+)
5583 --enable-split-objs
5585 --disable-split-objs
5586 split library into smaller objects to reduce binary sizes
5587 (GHC 6.6+)
5588 --enable-executable-stripping
5590 --disable-executable-stripping
5591 strip executables upon installation to reduce binary
5592 sizes
5593 --enable-library-stripping
5595 --disable-library-stripping
5596 strip libraries upon installation to reduce binary sizes
5597 --configure-option OPT
5599 Extra option for configure
5600 --user
5602 --global
5603 doing a per-user installation
5604 --package-db DB
5606 Append the given package database to the list of package
5607 databases used (to satisfy dependencies and register
5608 into). May be a specific file, 'global' or 'user'. The
5609 initial list is ['global'], ['global', 'user'], or
5610 ['global', $sandbox], depending on context. Use 'clear'
5611 to reset the list to empty. See the user guide for de‐
5612 tails.
5613 -f, --flags FLAGS
5615 Force values for the given flags in Cabal conditionals in
5616 the .cabal file. E.g., --flags="debug -usebytestrings"
5617 forces the flag "debug" to true and "usebytestrings" to
5618 false.
5619 --extra-include-dirs PATH
5621 A list of directories to search for header files
5622 --enable-deterministic
5624 --disable-deterministic
5625 Try to be as deterministic as possible (used by the test
5626 suite)
5627 --ipid IPID
5629 Installed package ID to compile this package as
5630 --cid CID
5632 Installed component ID to compile this component as
5633 --extra-lib-dirs PATH
5635 A list of directories to search for external libraries
5636 --extra-framework-dirs PATH
5638 A list of directories to search for external frameworks
5639 (OS X only)
5640 --extra-prog-path PATH
5642 A list of directories to search for required programs (in
5643 addition to the normal search locations)
5644 --instantiate-with NAME=MOD
5646 A mapping of signature names to concrete module instanti‐
5647 ations.
5648 --enable-tests
5650 --disable-tests
5651 dependency checking and compilation for test suites
5652 listed in the package description file.
5653 --enable-coverage
5655 --disable-coverage
5656 build package with Haskell Program Coverage. (GHC only)
5657 --enable-library-coverage
5659 --disable-library-coverage
5660 build package with Haskell Program Coverage. (GHC only)
5661 (DEPRECATED)
5662 --enable-benchmarks
5664 --disable-benchmarks
5665 dependency checking and compilation for benchmarks listed
5666 in the package description file.
5667 --enable-relocatable
5669 --disable-relocatable
5670 building a package that is relocatable. (GHC only)
5671 --disable-response-files
5673 enable workaround for old versions of programs like "ar"
5674 that do not support @file arguments
5675 --allow-depending-on-private-libs
5677 Allow depending on private libraries. If set, the library
5678 visibility check MUST be done externally.
5679 --with-alex PATH
5681 give the path to alex
5682 --with-ar PATH
5684 give the path to ar
5685 --with-c2hs PATH
5687 give the path to c2hs
5688 --with-cpphs PATH
5690 give the path to cpphs
5691 --with-doctest PATH
5693 give the path to doctest
5694 --with-gcc PATH
5696 give the path to gcc
5697 --with-ghc PATH
5699 give the path to ghc
5700 --with-ghc-pkg PATH
5702 give the path to ghc-pkg
5703 --with-ghcjs PATH
5705 give the path to ghcjs
5706 --with-ghcjs-pkg PATH
5708 give the path to ghcjs-pkg
5709 --with-greencard PATH
5711 give the path to greencard
5712 --with-haddock PATH
5714 give the path to haddock
5715 --with-happy PATH
5717 give the path to happy
5718 --with-haskell-suite PATH
5720 give the path to haskell-suite
5721 --with-haskell-suite-pkg PATH
5723 give the path to haskell-suite-pkg
5724 --with-hmake PATH
5726 give the path to hmake
5727 --with-hpc PATH
5729 give the path to hpc
5730 --with-hsc2hs PATH
5732 give the path to hsc2hs
5733 --with-hscolour PATH
5735 give the path to hscolour
5736 --with-jhc PATH
5738 give the path to jhc
5739 --with-ld PATH
5741 give the path to ld
5742 --with-pkg-config PATH
5744 give the path to pkg-config
5745 --with-runghc PATH
5747 give the path to runghc
5748 --with-strip PATH
5750 give the path to strip
5751 --with-tar PATH
5753 give the path to tar
5754 --with-uhc PATH
5756 give the path to uhc
5757 --alex-option OPT
5759 give an extra option to alex (no need to quote options
5760 containing spaces)
5761 --ar-option OPT
5763 give an extra option to ar (no need to quote options con‐
5764 taining spaces)
5765 --c2hs-option OPT
5767 give an extra option to c2hs (no need to quote options
5768 containing spaces)
5769 --cpphs-option OPT
5771 give an extra option to cpphs (no need to quote options
5772 containing spaces)
5773 --doctest-option OPT
5775 give an extra option to doctest (no need to quote options
5776 containing spaces)
5777 --gcc-option OPT
5779 give an extra option to gcc (no need to quote options
5780 containing spaces)
5781 --ghc-option OPT
5783 give an extra option to ghc (no need to quote options
5784 containing spaces)
5785 --ghc-pkg-option OPT
5787 give an extra option to ghc-pkg (no need to quote options
5788 containing spaces)
5789 --ghcjs-option OPT
5791 give an extra option to ghcjs (no need to quote options
5792 containing spaces)
5793 --ghcjs-pkg-option OPT
5795 give an extra option to ghcjs-pkg (no need to quote op‐
5796 tions containing spaces)
5797 --greencard-option OPT
5799 give an extra option to greencard (no need to quote op‐
5800 tions containing spaces)
5801 --haddock-option OPT
5803 give an extra option to haddock (no need to quote options
5804 containing spaces)
5805 --happy-option OPT
5807 give an extra option to happy (no need to quote options
5808 containing spaces)
5809 --haskell-suite-option OPT
5811 give an extra option to haskell-suite (no need to quote
5812 options containing spaces)
5813 --haskell-suite-pkg-option OPT
5815 give an extra option to haskell-suite-pkg (no need to
5816 quote options containing spaces)
5817 --hmake-option OPT
5819 give an extra option to hmake (no need to quote options
5820 containing spaces)
5821 --hpc-option OPT
5823 give an extra option to hpc (no need to quote options
5824 containing spaces)
5825 --hsc2hs-option OPT
5827 give an extra option to hsc2hs (no need to quote options
5828 containing spaces)
5829 --hscolour-option OPT
5831 give an extra option to hscolour (no need to quote op‐
5832 tions containing spaces)
5833 --jhc-option OPT
5835 give an extra option to jhc (no need to quote options
5836 containing spaces)
5837 --ld-option OPT
5839 give an extra option to ld (no need to quote options con‐
5840 taining spaces)
5841 --pkg-config-option OPT
5843 give an extra option to pkg-config (no need to quote op‐
5844 tions containing spaces)
5845 --runghc-option OPT
5847 give an extra option to runghc (no need to quote options
5848 containing spaces)
5849 --strip-option OPT
5851 give an extra option to strip (no need to quote options
5852 containing spaces)
5853 --tar-option OPT
5855 give an extra option to tar (no need to quote options
5856 containing spaces)
5857 --uhc-option OPT
5859 give an extra option to uhc (no need to quote options
5860 containing spaces)
5861 --alex-options OPTS
5863 give extra options to alex
5864 --ar-options OPTS
5866 give extra options to ar
5867 --c2hs-options OPTS
5869 give extra options to c2hs
5870 --cpphs-options OPTS
5872 give extra options to cpphs
5873 --doctest-options OPTS
5875 give extra options to doctest
5876 --gcc-options OPTS
5878 give extra options to gcc
5879 --ghc-options OPTS
5881 give extra options to ghc
5882 --ghc-pkg-options OPTS
5884 give extra options to ghc-pkg
5885 --ghcjs-options OPTS
5887 give extra options to ghcjs
5888 --ghcjs-pkg-options OPTS
5890 give extra options to ghcjs-pkg
5891 --greencard-options OPTS
5893 give extra options to greencard
5894 --haddock-options OPTS
5896 give extra options to haddock
5897 --happy-options OPTS
5899 give extra options to happy
5900 --haskell-suite-options OPTS
5902 give extra options to haskell-suite
5903 --haskell-suite-pkg-options OPTS
5905 give extra options to haskell-suite-pkg
5906 --hmake-options OPTS
5908 give extra options to hmake
5909 --hpc-options OPTS
5911 give extra options to hpc
5912 --hsc2hs-options OPTS
5914 give extra options to hsc2hs
5915 --hscolour-options OPTS
5917 give extra options to hscolour
5918 --jhc-options OPTS
5920 give extra options to jhc
5921 --ld-options OPTS
5923 give extra options to ld
5924 --pkg-config-options OPTS
5926 give extra options to pkg-config
5927 --runghc-options OPTS
5929 give extra options to runghc
5930 --strip-options OPTS
5932 give extra options to strip
5933 --tar-options OPTS
5935 give extra options to tar
5936 --uhc-options OPTS
5938 give extra options to uhc
5939 --cabal-lib-version VERSION
5941 Select which version of the Cabal lib to use to build
5942 packages (useful for testing).
5943 --constraint CONSTRAINT
5945 Specify constraints on a package (version, in‐
5946 stalled/source, flags)
5947 --preference CONSTRAINT
5949 Specify preferences (soft constraints) on the version of
5950 a package
5951 --solver SOLVER
5953 Select dependency solver to use (default: modular).
5954 Choices: modular.
5955 --allow-older [DEPS]
5957 Ignore lower bounds in all dependencies or DEPS
5958 --allow-newer [DEPS]
5960 Ignore upper bounds in all dependencies or DEPS
5961 --write-ghc-environment-files always|never|ghc8.4.4+
5963 Whether to create a .ghc.environment file after a suc‐
5964 cessful build (v2-build only)
5965 --enable-documentation
5967 --disable-documentation
5968 building of documentation
5969 --doc-index-file TEMPLATE
5971 A central index of haddock API documentation (template
5972 cannot use $pkgid)
5973 --dry-run
5975 Do not install anything, only print what would be in‐
5976 stalled.
5977 --max-backjumps NUM
5979 Maximum number of backjumps allowed while solving (de‐
5980 fault: 4000). Use a negative number to enable unlimited
5981 backtracking. Use 0 to disable backtracking completely.
5982 --reorder-goals
5984 --no-reorder-goals
5985 Try to reorder goals according to certain heuristics.
5986 Slows things down on average, but may make backtracking
5987 faster for some packages.
5988 --count-conflicts
5990 --no-count-conflicts
5991 Try to speed up solving by preferring goals that are in‐
5992 volved in a lot of conflicts (default).
5993 --fine-grained-conflicts
5995 --no-fine-grained-conflicts
5996 Skip a version of a package if it does not resolve the
5997 conflicts encountered in the last version, as a solver
5998 optimization (default).
5999 --minimize-conflict-set
6001 --no-minimize-conflict-set
6002 When there is no solution, try to improve the error mes‐
6003 sage by finding a minimal conflict set (default: false).
6004 May increase run time significantly.
6005 --independent-goals
6007 --no-independent-goals
6008 Treat several goals on the command line as independent.
6009 If several goals depend on the same package, different
6010 versions can be chosen.
6011 --shadow-installed-packages
6013 --no-shadow-installed-packages
6014 If multiple package instances of the same version are in‐
6015 stalled, treat all but one as shadowed.
6016 --strong-flags
6018 --no-strong-flags
6019 Do not defer flag choices (this used to be the default in
6020 cabal-install <= 1.20).
6021 --allow-boot-library-installs
6023 --no-allow-boot-library-installs
6024 Allow cabal to install base, ghc-prim, integer-simple,
6025 integer-gmp, and template-haskell.
6026 --reject-unconstrained-dependencies none|all
6028 Require these packages to have constraints on them if
6029 they are to be selected (default: none).
6030 --reinstall
6032 --no-reinstall
6033 Install even if it means installing the same version
6034 again.
6035 --avoid-reinstalls
6037 --no-avoid-reinstalls
6038 Do not select versions that would destructively overwrite
6039 installed packages.
6040 --force-reinstalls
6042 --no-force-reinstalls
6043 Reinstall packages even if they will most likely break
6044 other installed packages.
6045 --upgrade-dependencies
6047 --no-upgrade-dependencies
6048 Pick the latest version for all dependencies, rather than
6049 trying to pick an installed version.
6050 --only-dependencies
6052 --no-only-dependencies
6053 Install only the dependencies necessary to build the
6054 given packages
6055 --dependencies-only
6057 --no-dependencies-only
6058 A synonym for --only-dependencies
6059 --index-state STATE
6061 Use source package index state as it existed at a previ‐
6062 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
6063 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
6064 'HEAD' (default: 'HEAD').
6065 --root-cmd COMMAND
6067 (No longer supported, do not use.)
6068 --symlink-bindir DIR
6070 Add symlinks to installed executables into this direc‐
6071 tory.
6072 --build-summary TEMPLATE
6074 Save build summaries to file (name template can use
6075 $pkgid, $compiler, $os, $arch)
6076 --build-log TEMPLATE
6078 Log all builds to file (name template can use $pkgid,
6079 $compiler, $os, $arch)
6080 --remote-build-reporting LEVEL
6082 Generate build reports to send to a remote server (none,
6083 anonymous or detailed).
6084 --report-planning-failure
6086 Generate build reports when the dependency solver fails.
6087 This is used by the Hackage build bot.
6088 --enable-per-component
6090 --disable-per-component
6091 Per-component builds when possible
6092 --one-shot
6094 --no-one-shot
6095 Do not record the packages in the world file.
6096 --run-tests
6098 Run package test suites during installation.
6099 -j, --jobs [NUM]
6101 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
6102 given).
6103 --keep-going
6105 After a build failure, continue to build other unaffected
6106 packages.
6107 --offline
6109 --no-offline
6110 Don't download packages from the Internet.
6111 --project-file FILE
6113 Set the name of the cabal.project file to search for in
6114 parent directories
6115 --only
6117 Only installs the package in the current directory.
6118 --haddock-hoogle
6120 Generate a hoogle database
6121 --haddock-html
6123 Generate HTML documentation (the default)
6124 --haddock-html-location URL
6126 Location of HTML documentation for pre-requisite packages
6127 --haddock-for-hackage
6129 Collection of flags to generate documentation suitable
6130 for upload to hackage
6131 --haddock-executables
6133 Run haddock for Executables targets
6134 --haddock-tests
6136 Run haddock for Test Suite targets
6137 --haddock-benchmarks
6139 Run haddock for Benchmark targets
6140 --haddock-all
6142 Run haddock for all targets
6143 --haddock-internal
6145 Run haddock for internal modules and include all symbols
6146 --haddock-css PATH
6148 Use PATH as the haddock stylesheet
6149 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
6151 dock-hyperlinked-source
6152 Hyperlink the documentation to the source code
6153 --haddock-quickjump
6155 Generate an index for interactive documentation naviga‐
6156 tion
6157 --haddock-hscolour-css PATH
6159 Use PATH as the HsColour stylesheet
6160 --haddock-contents-location URL
6162 Bake URL in as the location for the contents page
6163 --test-log TEMPLATE
6165 Log all test suite results to file (name template can use
6166 $pkgid, $compiler, $os, $arch, $test-suite, $result)
6167 --test-machine-log TEMPLATE
6169 Produce a machine-readable log file (name template can
6170 use $pkgid, $compiler, $os, $arch, $result)
6171 --test-show-details FILTER
6173 --test-keep-tix-files
6175 keep .tix files for HPC between test runs
6176 --test-wrapper FILE
6178 Run test through a wrapper.
6179 --test-fail-when-no-test-suites
6181 Exit with failure when no test suites are found.
6182 --test-options TEMPLATES
6184 give extra options to test executables (name templates
6185 can use $pkgid, $compiler, $os, $arch, $test-suite)
6186 --test-option TEMPLATE
6188 give extra option to test executables (no need to quote
6189 options containing spaces, name template can use $pkgid,
6190 $compiler, $os, $arch, $test-suite)
6191 --benchmark-options TEMPLATES
6193 give extra options to benchmark executables (name tem‐
6194 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
6195 --benchmark-option TEMPLATE
6197 give extra option to benchmark executables (no need to
6198 quote options containing spaces, name template can use
6199 $pkgid, $compiler, $os, $arch, $benchmark)
6200 --only-configure
6202 --no-only-configure
6203 Instead of performing a full build just run the configure
6204 step
6205 cabal new-build
6208 Usage: cabal new-build [TARGETS] [FLAGS]
6210 Build one or more targets from within the project. The available tar‐
6213 gets are the packages in the project as well as individual components
6214 within those packages, including libraries, executables, test-suites or
6215 benchmarks. Targets can be specified by name or location. If no target
6216 is specified then the default is to build the package in the current
6217 directory.
6218 Dependencies are built or rebuilt as necessary. Additional configura‐
6220 tion flags can be specified on the command line and these extend the
6221 project configuration from the 'cabal.project', 'cabal.project.local'
6222 and other files.
6223 Build one or more targets from within the project. The available tar‐
6226 gets are the packages in the project as well as individual components
6227 within those packages, including libraries, executables, test-suites or
6228 benchmarks. Targets can be specified by name or location. If no target
6229 is specified then the default is to build the package in the current
6230 directory.
6231 Dependencies are built or rebuilt as necessary. Additional configura‐
6233 tion flags can be specified on the command line and these extend the
6234 project configuration from the 'cabal.project', 'cabal.project.local'
6235 and other files.
6236 Flags:
6239 -v, --verbose [n]
6240 Control verbosity (n is 0--3, default verbosity level is
6241 1)
6242 --builddir, --distdir, --distpref DIR
6244 The directory where Cabal puts generated build files (de‐
6245 fault dist)
6246 -g, --ghc
6248 compile with GHC
6249 --ghcjs
6251 compile with GHCJS
6252 --uhc
6254 compile with UHC
6255 --haskell-suite
6257 compile with a haskell-suite compiler
6258 --cabal-file PATH
6260 use this Cabal file
6261 -w, --with-compiler PATH
6263 give the path to a particular compiler
6264 --with-hc-pkg PATH
6266 give the path to the package tool
6267 --prefix DIR
6269 bake this prefix in preparation of installation
6270 --bindir DIR
6272 installation directory for executables
6273 --libdir DIR
6275 installation directory for libraries
6276 --libsubdir DIR
6278 subdirectory of libdir in which libs are installed
6279 --dynlibdir DIR
6281 installation directory for dynamic libraries
6282 --libexecdir DIR
6284 installation directory for program executables
6285 --libexecsubdir DIR
6287 subdirectory of libexecdir in which private executables
6288 are installed
6289 --datadir DIR
6291 installation directory for read-only data
6292 --datasubdir DIR
6294 subdirectory of datadir in which data files are installed
6295 --docdir DIR
6297 installation directory for documentation
6298 --htmldir DIR
6300 installation directory for HTML documentation
6301 --haddockdir DIR
6303 installation directory for haddock interfaces
6304 --sysconfdir DIR
6306 installation directory for configuration files
6307 --program-prefix PREFIX
6309 prefix to be applied to installed executables
6310 --program-suffix SUFFIX
6312 suffix to be applied to installed executables
6313 --enable-library-vanilla
6315 --disable-library-vanilla
6316 Vanilla libraries
6317 -p, --enable-library-profiling
6319 --disable-library-profiling
6320 Library profiling
6321 --enable-shared
6323 --disable-shared
6324 Shared library
6325 --enable-static
6327 --disable-static
6328 Static library
6329 --enable-executable-dynamic
6331 --disable-executable-dynamic
6332 Executable dynamic linking
6333 --enable-executable-static
6335 --disable-executable-static
6336 Executable fully static linking
6337 --enable-profiling
6339 --disable-profiling
6340 Executable and library profiling
6341 --enable-executable-profiling
6343 --disable-executable-profiling
6344 Executable profiling (DEPRECATED)
6345 --profiling-detail level
6347 Profiling detail level for executable and library (de‐
6348 fault, none, exported-functions, toplevel-functions,
6349 all-functions).
6350 --library-profiling-detail level
6352 Profiling detail level for libraries only.
6353 -O, --enable-optimization, --enable-optimisation [n]
6355 Build with optimization (n is 0--2, default is 1)
6356 --disable-optimization, --disable-optimisation
6358 Build without optimization
6359 --enable-debug-info [n]
6361 Emit debug info (n is 0--3, default is 0)
6362 --disable-debug-info
6364 Don't emit debug info
6365 --enable-library-for-ghci
6367 --disable-library-for-ghci
6368 compile library for use with GHCi
6369 --enable-split-sections
6371 --disable-split-sections
6372 compile library code such that unneeded definitions can
6373 be dropped from the final executable (GHC 7.8+)
6374 --enable-split-objs
6376 --disable-split-objs
6377 split library into smaller objects to reduce binary sizes
6378 (GHC 6.6+)
6379 --enable-executable-stripping
6381 --disable-executable-stripping
6382 strip executables upon installation to reduce binary
6383 sizes
6384 --enable-library-stripping
6386 --disable-library-stripping
6387 strip libraries upon installation to reduce binary sizes
6388 --configure-option OPT
6390 Extra option for configure
6391 --user
6393 --global
6394 doing a per-user installation
6395 --package-db DB
6397 Append the given package database to the list of package
6398 databases used (to satisfy dependencies and register
6399 into). May be a specific file, 'global' or 'user'. The
6400 initial list is ['global'], ['global', 'user'], or
6401 ['global', $sandbox], depending on context. Use 'clear'
6402 to reset the list to empty. See the user guide for de‐
6403 tails.
6404 -f, --flags FLAGS
6406 Force values for the given flags in Cabal conditionals in
6407 the .cabal file. E.g., --flags="debug -usebytestrings"
6408 forces the flag "debug" to true and "usebytestrings" to
6409 false.
6410 --extra-include-dirs PATH
6412 A list of directories to search for header files
6413 --enable-deterministic
6415 --disable-deterministic
6416 Try to be as deterministic as possible (used by the test
6417 suite)
6418 --ipid IPID
6420 Installed package ID to compile this package as
6421 --cid CID
6423 Installed component ID to compile this component as
6424 --extra-lib-dirs PATH
6426 A list of directories to search for external libraries
6427 --extra-framework-dirs PATH
6429 A list of directories to search for external frameworks
6430 (OS X only)
6431 --extra-prog-path PATH
6433 A list of directories to search for required programs (in
6434 addition to the normal search locations)
6435 --instantiate-with NAME=MOD
6437 A mapping of signature names to concrete module instanti‐
6438 ations.
6439 --enable-tests
6441 --disable-tests
6442 dependency checking and compilation for test suites
6443 listed in the package description file.
6444 --enable-coverage
6446 --disable-coverage
6447 build package with Haskell Program Coverage. (GHC only)
6448 --enable-library-coverage
6450 --disable-library-coverage
6451 build package with Haskell Program Coverage. (GHC only)
6452 (DEPRECATED)
6453 --enable-benchmarks
6455 --disable-benchmarks
6456 dependency checking and compilation for benchmarks listed
6457 in the package description file.
6458 --enable-relocatable
6460 --disable-relocatable
6461 building a package that is relocatable. (GHC only)
6462 --disable-response-files
6464 enable workaround for old versions of programs like "ar"
6465 that do not support @file arguments
6466 --allow-depending-on-private-libs
6468 Allow depending on private libraries. If set, the library
6469 visibility check MUST be done externally.
6470 --with-alex PATH
6472 give the path to alex
6473 --with-ar PATH
6475 give the path to ar
6476 --with-c2hs PATH
6478 give the path to c2hs
6479 --with-cpphs PATH
6481 give the path to cpphs
6482 --with-doctest PATH
6484 give the path to doctest
6485 --with-gcc PATH
6487 give the path to gcc
6488 --with-ghc PATH
6490 give the path to ghc
6491 --with-ghc-pkg PATH
6493 give the path to ghc-pkg
6494 --with-ghcjs PATH
6496 give the path to ghcjs
6497 --with-ghcjs-pkg PATH
6499 give the path to ghcjs-pkg
6500 --with-greencard PATH
6502 give the path to greencard
6503 --with-haddock PATH
6505 give the path to haddock
6506 --with-happy PATH
6508 give the path to happy
6509 --with-haskell-suite PATH
6511 give the path to haskell-suite
6512 --with-haskell-suite-pkg PATH
6514 give the path to haskell-suite-pkg
6515 --with-hmake PATH
6517 give the path to hmake
6518 --with-hpc PATH
6520 give the path to hpc
6521 --with-hsc2hs PATH
6523 give the path to hsc2hs
6524 --with-hscolour PATH
6526 give the path to hscolour
6527 --with-jhc PATH
6529 give the path to jhc
6530 --with-ld PATH
6532 give the path to ld
6533 --with-pkg-config PATH
6535 give the path to pkg-config
6536 --with-runghc PATH
6538 give the path to runghc
6539 --with-strip PATH
6541 give the path to strip
6542 --with-tar PATH
6544 give the path to tar
6545 --with-uhc PATH
6547 give the path to uhc
6548 --alex-option OPT
6550 give an extra option to alex (no need to quote options
6551 containing spaces)
6552 --ar-option OPT
6554 give an extra option to ar (no need to quote options con‐
6555 taining spaces)
6556 --c2hs-option OPT
6558 give an extra option to c2hs (no need to quote options
6559 containing spaces)
6560 --cpphs-option OPT
6562 give an extra option to cpphs (no need to quote options
6563 containing spaces)
6564 --doctest-option OPT
6566 give an extra option to doctest (no need to quote options
6567 containing spaces)
6568 --gcc-option OPT
6570 give an extra option to gcc (no need to quote options
6571 containing spaces)
6572 --ghc-option OPT
6574 give an extra option to ghc (no need to quote options
6575 containing spaces)
6576 --ghc-pkg-option OPT
6578 give an extra option to ghc-pkg (no need to quote options
6579 containing spaces)
6580 --ghcjs-option OPT
6582 give an extra option to ghcjs (no need to quote options
6583 containing spaces)
6584 --ghcjs-pkg-option OPT
6586 give an extra option to ghcjs-pkg (no need to quote op‐
6587 tions containing spaces)
6588 --greencard-option OPT
6590 give an extra option to greencard (no need to quote op‐
6591 tions containing spaces)
6592 --haddock-option OPT
6594 give an extra option to haddock (no need to quote options
6595 containing spaces)
6596 --happy-option OPT
6598 give an extra option to happy (no need to quote options
6599 containing spaces)
6600 --haskell-suite-option OPT
6602 give an extra option to haskell-suite (no need to quote
6603 options containing spaces)
6604 --haskell-suite-pkg-option OPT
6606 give an extra option to haskell-suite-pkg (no need to
6607 quote options containing spaces)
6608 --hmake-option OPT
6610 give an extra option to hmake (no need to quote options
6611 containing spaces)
6612 --hpc-option OPT
6614 give an extra option to hpc (no need to quote options
6615 containing spaces)
6616 --hsc2hs-option OPT
6618 give an extra option to hsc2hs (no need to quote options
6619 containing spaces)
6620 --hscolour-option OPT
6622 give an extra option to hscolour (no need to quote op‐
6623 tions containing spaces)
6624 --jhc-option OPT
6626 give an extra option to jhc (no need to quote options
6627 containing spaces)
6628 --ld-option OPT
6630 give an extra option to ld (no need to quote options con‐
6631 taining spaces)
6632 --pkg-config-option OPT
6634 give an extra option to pkg-config (no need to quote op‐
6635 tions containing spaces)
6636 --runghc-option OPT
6638 give an extra option to runghc (no need to quote options
6639 containing spaces)
6640 --strip-option OPT
6642 give an extra option to strip (no need to quote options
6643 containing spaces)
6644 --tar-option OPT
6646 give an extra option to tar (no need to quote options
6647 containing spaces)
6648 --uhc-option OPT
6650 give an extra option to uhc (no need to quote options
6651 containing spaces)
6652 --alex-options OPTS
6654 give extra options to alex
6655 --ar-options OPTS
6657 give extra options to ar
6658 --c2hs-options OPTS
6660 give extra options to c2hs
6661 --cpphs-options OPTS
6663 give extra options to cpphs
6664 --doctest-options OPTS
6666 give extra options to doctest
6667 --gcc-options OPTS
6669 give extra options to gcc
6670 --ghc-options OPTS
6672 give extra options to ghc
6673 --ghc-pkg-options OPTS
6675 give extra options to ghc-pkg
6676 --ghcjs-options OPTS
6678 give extra options to ghcjs
6679 --ghcjs-pkg-options OPTS
6681 give extra options to ghcjs-pkg
6682 --greencard-options OPTS
6684 give extra options to greencard
6685 --haddock-options OPTS
6687 give extra options to haddock
6688 --happy-options OPTS
6690 give extra options to happy
6691 --haskell-suite-options OPTS
6693 give extra options to haskell-suite
6694 --haskell-suite-pkg-options OPTS
6696 give extra options to haskell-suite-pkg
6697 --hmake-options OPTS
6699 give extra options to hmake
6700 --hpc-options OPTS
6702 give extra options to hpc
6703 --hsc2hs-options OPTS
6705 give extra options to hsc2hs
6706 --hscolour-options OPTS
6708 give extra options to hscolour
6709 --jhc-options OPTS
6711 give extra options to jhc
6712 --ld-options OPTS
6714 give extra options to ld
6715 --pkg-config-options OPTS
6717 give extra options to pkg-config
6718 --runghc-options OPTS
6720 give extra options to runghc
6721 --strip-options OPTS
6723 give extra options to strip
6724 --tar-options OPTS
6726 give extra options to tar
6727 --uhc-options OPTS
6729 give extra options to uhc
6730 --cabal-lib-version VERSION
6732 Select which version of the Cabal lib to use to build
6733 packages (useful for testing).
6734 --constraint CONSTRAINT
6736 Specify constraints on a package (version, in‐
6737 stalled/source, flags)
6738 --preference CONSTRAINT
6740 Specify preferences (soft constraints) on the version of
6741 a package
6742 --solver SOLVER
6744 Select dependency solver to use (default: modular).
6745 Choices: modular.
6746 --allow-older [DEPS]
6748 Ignore lower bounds in all dependencies or DEPS
6749 --allow-newer [DEPS]
6751 Ignore upper bounds in all dependencies or DEPS
6752 --write-ghc-environment-files always|never|ghc8.4.4+
6754 Whether to create a .ghc.environment file after a suc‐
6755 cessful build (v2-build only)
6756 --enable-documentation
6758 --disable-documentation
6759 building of documentation
6760 --doc-index-file TEMPLATE
6762 A central index of haddock API documentation (template
6763 cannot use $pkgid)
6764 --dry-run
6766 Do not install anything, only print what would be in‐
6767 stalled.
6768 --max-backjumps NUM
6770 Maximum number of backjumps allowed while solving (de‐
6771 fault: 4000). Use a negative number to enable unlimited
6772 backtracking. Use 0 to disable backtracking completely.
6773 --reorder-goals
6775 --no-reorder-goals
6776 Try to reorder goals according to certain heuristics.
6777 Slows things down on average, but may make backtracking
6778 faster for some packages.
6779 --count-conflicts
6781 --no-count-conflicts
6782 Try to speed up solving by preferring goals that are in‐
6783 volved in a lot of conflicts (default).
6784 --fine-grained-conflicts
6786 --no-fine-grained-conflicts
6787 Skip a version of a package if it does not resolve the
6788 conflicts encountered in the last version, as a solver
6789 optimization (default).
6790 --minimize-conflict-set
6792 --no-minimize-conflict-set
6793 When there is no solution, try to improve the error mes‐
6794 sage by finding a minimal conflict set (default: false).
6795 May increase run time significantly.
6796 --independent-goals
6798 --no-independent-goals
6799 Treat several goals on the command line as independent.
6800 If several goals depend on the same package, different
6801 versions can be chosen.
6802 --shadow-installed-packages
6804 --no-shadow-installed-packages
6805 If multiple package instances of the same version are in‐
6806 stalled, treat all but one as shadowed.
6807 --strong-flags
6809 --no-strong-flags
6810 Do not defer flag choices (this used to be the default in
6811 cabal-install <= 1.20).
6812 --allow-boot-library-installs
6814 --no-allow-boot-library-installs
6815 Allow cabal to install base, ghc-prim, integer-simple,
6816 integer-gmp, and template-haskell.
6817 --reject-unconstrained-dependencies none|all
6819 Require these packages to have constraints on them if
6820 they are to be selected (default: none).
6821 --reinstall
6823 --no-reinstall
6824 Install even if it means installing the same version
6825 again.
6826 --avoid-reinstalls
6828 --no-avoid-reinstalls
6829 Do not select versions that would destructively overwrite
6830 installed packages.
6831 --force-reinstalls
6833 --no-force-reinstalls
6834 Reinstall packages even if they will most likely break
6835 other installed packages.
6836 --upgrade-dependencies
6838 --no-upgrade-dependencies
6839 Pick the latest version for all dependencies, rather than
6840 trying to pick an installed version.
6841 --only-dependencies
6843 --no-only-dependencies
6844 Install only the dependencies necessary to build the
6845 given packages
6846 --dependencies-only
6848 --no-dependencies-only
6849 A synonym for --only-dependencies
6850 --index-state STATE
6852 Use source package index state as it existed at a previ‐
6853 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
6854 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
6855 'HEAD' (default: 'HEAD').
6856 --root-cmd COMMAND
6858 (No longer supported, do not use.)
6859 --symlink-bindir DIR
6861 Add symlinks to installed executables into this direc‐
6862 tory.
6863 --build-summary TEMPLATE
6865 Save build summaries to file (name template can use
6866 $pkgid, $compiler, $os, $arch)
6867 --build-log TEMPLATE
6869 Log all builds to file (name template can use $pkgid,
6870 $compiler, $os, $arch)
6871 --remote-build-reporting LEVEL
6873 Generate build reports to send to a remote server (none,
6874 anonymous or detailed).
6875 --report-planning-failure
6877 Generate build reports when the dependency solver fails.
6878 This is used by the Hackage build bot.
6879 --enable-per-component
6881 --disable-per-component
6882 Per-component builds when possible
6883 --one-shot
6885 --no-one-shot
6886 Do not record the packages in the world file.
6887 --run-tests
6889 Run package test suites during installation.
6890 -j, --jobs [NUM]
6892 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
6893 given).
6894 --keep-going
6896 After a build failure, continue to build other unaffected
6897 packages.
6898 --offline
6900 --no-offline
6901 Don't download packages from the Internet.
6902 --project-file FILE
6904 Set the name of the cabal.project file to search for in
6905 parent directories
6906 --only
6908 Only installs the package in the current directory.
6909 --haddock-hoogle
6911 Generate a hoogle database
6912 --haddock-html
6914 Generate HTML documentation (the default)
6915 --haddock-html-location URL
6917 Location of HTML documentation for pre-requisite packages
6918 --haddock-for-hackage
6920 Collection of flags to generate documentation suitable
6921 for upload to hackage
6922 --haddock-executables
6924 Run haddock for Executables targets
6925 --haddock-tests
6927 Run haddock for Test Suite targets
6928 --haddock-benchmarks
6930 Run haddock for Benchmark targets
6931 --haddock-all
6933 Run haddock for all targets
6934 --haddock-internal
6936 Run haddock for internal modules and include all symbols
6937 --haddock-css PATH
6939 Use PATH as the haddock stylesheet
6940 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
6942 dock-hyperlinked-source
6943 Hyperlink the documentation to the source code
6944 --haddock-quickjump
6946 Generate an index for interactive documentation naviga‐
6947 tion
6948 --haddock-hscolour-css PATH
6950 Use PATH as the HsColour stylesheet
6951 --haddock-contents-location URL
6953 Bake URL in as the location for the contents page
6954 --test-log TEMPLATE
6956 Log all test suite results to file (name template can use
6957 $pkgid, $compiler, $os, $arch, $test-suite, $result)
6958 --test-machine-log TEMPLATE
6960 Produce a machine-readable log file (name template can
6961 use $pkgid, $compiler, $os, $arch, $result)
6962 --test-show-details FILTER
6964 --test-keep-tix-files
6966 keep .tix files for HPC between test runs
6967 --test-wrapper FILE
6969 Run test through a wrapper.
6970 --test-fail-when-no-test-suites
6972 Exit with failure when no test suites are found.
6973 --test-options TEMPLATES
6975 give extra options to test executables (name templates
6976 can use $pkgid, $compiler, $os, $arch, $test-suite)
6977 --test-option TEMPLATE
6979 give extra option to test executables (no need to quote
6980 options containing spaces, name template can use $pkgid,
6981 $compiler, $os, $arch, $test-suite)
6982 --benchmark-options TEMPLATES
6984 give extra options to benchmark executables (name tem‐
6985 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
6986 --benchmark-option TEMPLATE
6988 give extra option to benchmark executables (no need to
6989 quote options containing spaces, name template can use
6990 $pkgid, $compiler, $os, $arch, $benchmark)
6991 --only-configure
6993 --no-only-configure
6994 Instead of performing a full build just run the configure
6995 step
6996 cabal v2-build
6999 Usage: cabal v2-build [TARGETS] [FLAGS]
7001 Build one or more targets from within the project. The available tar‐
7004 gets are the packages in the project as well as individual components
7005 within those packages, including libraries, executables, test-suites or
7006 benchmarks. Targets can be specified by name or location. If no target
7007 is specified then the default is to build the package in the current
7008 directory.
7009 Dependencies are built or rebuilt as necessary. Additional configura‐
7011 tion flags can be specified on the command line and these extend the
7012 project configuration from the 'cabal.project', 'cabal.project.local'
7013 and other files.
7014 Examples:
7017 cabal v2-build
7018 Build the package in the current directory or all packages in the
7019 project
7020 cabal v2-build pkgname
7021 Build the package named pkgname in the project
7022 cabal v2-build ./pkgfoo
7023 Build the package in the ./pkgfoo directory
7024 cabal v2-build cname
7025 Build the component named cname in the project
7026 cabal v2-build cname --enable-profiling
7027 Build the component in profiling mode (including dependencies as
7028 needed)
7029 Note: this command is part of the new project-based system (aka nix-
7031 style local builds). These features are currently in beta. Please see
7032 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
7033 details and advice on what you can expect to work. If you encounter
7034 problems please file issues at https://github.com/haskell/cabal/issues
7035 and if you have any time to get involved and help with testing, fixing
7036 bugs etc then that is very much appreciated.
7037 Flags:
7040 -v, --verbose [n]
7041 Control verbosity (n is 0--3, default verbosity level is
7042 1)
7043 --builddir, --distdir, --distpref DIR
7045 The directory where Cabal puts generated build files (de‐
7046 fault dist)
7047 -g, --ghc
7049 compile with GHC
7050 --ghcjs
7052 compile with GHCJS
7053 --uhc
7055 compile with UHC
7056 --haskell-suite
7058 compile with a haskell-suite compiler
7059 --cabal-file PATH
7061 use this Cabal file
7062 -w, --with-compiler PATH
7064 give the path to a particular compiler
7065 --with-hc-pkg PATH
7067 give the path to the package tool
7068 --prefix DIR
7070 bake this prefix in preparation of installation
7071 --bindir DIR
7073 installation directory for executables
7074 --libdir DIR
7076 installation directory for libraries
7077 --libsubdir DIR
7079 subdirectory of libdir in which libs are installed
7080 --dynlibdir DIR
7082 installation directory for dynamic libraries
7083 --libexecdir DIR
7085 installation directory for program executables
7086 --libexecsubdir DIR
7088 subdirectory of libexecdir in which private executables
7089 are installed
7090 --datadir DIR
7092 installation directory for read-only data
7093 --datasubdir DIR
7095 subdirectory of datadir in which data files are installed
7096 --docdir DIR
7098 installation directory for documentation
7099 --htmldir DIR
7101 installation directory for HTML documentation
7102 --haddockdir DIR
7104 installation directory for haddock interfaces
7105 --sysconfdir DIR
7107 installation directory for configuration files
7108 --program-prefix PREFIX
7110 prefix to be applied to installed executables
7111 --program-suffix SUFFIX
7113 suffix to be applied to installed executables
7114 --enable-library-vanilla
7116 --disable-library-vanilla
7117 Vanilla libraries
7118 -p, --enable-library-profiling
7120 --disable-library-profiling
7121 Library profiling
7122 --enable-shared
7124 --disable-shared
7125 Shared library
7126 --enable-static
7128 --disable-static
7129 Static library
7130 --enable-executable-dynamic
7132 --disable-executable-dynamic
7133 Executable dynamic linking
7134 --enable-executable-static
7136 --disable-executable-static
7137 Executable fully static linking
7138 --enable-profiling
7140 --disable-profiling
7141 Executable and library profiling
7142 --enable-executable-profiling
7144 --disable-executable-profiling
7145 Executable profiling (DEPRECATED)
7146 --profiling-detail level
7148 Profiling detail level for executable and library (de‐
7149 fault, none, exported-functions, toplevel-functions,
7150 all-functions).
7151 --library-profiling-detail level
7153 Profiling detail level for libraries only.
7154 -O, --enable-optimization, --enable-optimisation [n]
7156 Build with optimization (n is 0--2, default is 1)
7157 --disable-optimization, --disable-optimisation
7159 Build without optimization
7160 --enable-debug-info [n]
7162 Emit debug info (n is 0--3, default is 0)
7163 --disable-debug-info
7165 Don't emit debug info
7166 --enable-library-for-ghci
7168 --disable-library-for-ghci
7169 compile library for use with GHCi
7170 --enable-split-sections
7172 --disable-split-sections
7173 compile library code such that unneeded definitions can
7174 be dropped from the final executable (GHC 7.8+)
7175 --enable-split-objs
7177 --disable-split-objs
7178 split library into smaller objects to reduce binary sizes
7179 (GHC 6.6+)
7180 --enable-executable-stripping
7182 --disable-executable-stripping
7183 strip executables upon installation to reduce binary
7184 sizes
7185 --enable-library-stripping
7187 --disable-library-stripping
7188 strip libraries upon installation to reduce binary sizes
7189 --configure-option OPT
7191 Extra option for configure
7192 --user
7194 --global
7195 doing a per-user installation
7196 --package-db DB
7198 Append the given package database to the list of package
7199 databases used (to satisfy dependencies and register
7200 into). May be a specific file, 'global' or 'user'. The
7201 initial list is ['global'], ['global', 'user'], or
7202 ['global', $sandbox], depending on context. Use 'clear'
7203 to reset the list to empty. See the user guide for de‐
7204 tails.
7205 -f, --flags FLAGS
7207 Force values for the given flags in Cabal conditionals in
7208 the .cabal file. E.g., --flags="debug -usebytestrings"
7209 forces the flag "debug" to true and "usebytestrings" to
7210 false.
7211 --extra-include-dirs PATH
7213 A list of directories to search for header files
7214 --enable-deterministic
7216 --disable-deterministic
7217 Try to be as deterministic as possible (used by the test
7218 suite)
7219 --ipid IPID
7221 Installed package ID to compile this package as
7222 --cid CID
7224 Installed component ID to compile this component as
7225 --extra-lib-dirs PATH
7227 A list of directories to search for external libraries
7228 --extra-framework-dirs PATH
7230 A list of directories to search for external frameworks
7231 (OS X only)
7232 --extra-prog-path PATH
7234 A list of directories to search for required programs (in
7235 addition to the normal search locations)
7236 --instantiate-with NAME=MOD
7238 A mapping of signature names to concrete module instanti‐
7239 ations.
7240 --enable-tests
7242 --disable-tests
7243 dependency checking and compilation for test suites
7244 listed in the package description file.
7245 --enable-coverage
7247 --disable-coverage
7248 build package with Haskell Program Coverage. (GHC only)
7249 --enable-library-coverage
7251 --disable-library-coverage
7252 build package with Haskell Program Coverage. (GHC only)
7253 (DEPRECATED)
7254 --enable-benchmarks
7256 --disable-benchmarks
7257 dependency checking and compilation for benchmarks listed
7258 in the package description file.
7259 --enable-relocatable
7261 --disable-relocatable
7262 building a package that is relocatable. (GHC only)
7263 --disable-response-files
7265 enable workaround for old versions of programs like "ar"
7266 that do not support @file arguments
7267 --allow-depending-on-private-libs
7269 Allow depending on private libraries. If set, the library
7270 visibility check MUST be done externally.
7271 --with-alex PATH
7273 give the path to alex
7274 --with-ar PATH
7276 give the path to ar
7277 --with-c2hs PATH
7279 give the path to c2hs
7280 --with-cpphs PATH
7282 give the path to cpphs
7283 --with-doctest PATH
7285 give the path to doctest
7286 --with-gcc PATH
7288 give the path to gcc
7289 --with-ghc PATH
7291 give the path to ghc
7292 --with-ghc-pkg PATH
7294 give the path to ghc-pkg
7295 --with-ghcjs PATH
7297 give the path to ghcjs
7298 --with-ghcjs-pkg PATH
7300 give the path to ghcjs-pkg
7301 --with-greencard PATH
7303 give the path to greencard
7304 --with-haddock PATH
7306 give the path to haddock
7307 --with-happy PATH
7309 give the path to happy
7310 --with-haskell-suite PATH
7312 give the path to haskell-suite
7313 --with-haskell-suite-pkg PATH
7315 give the path to haskell-suite-pkg
7316 --with-hmake PATH
7318 give the path to hmake
7319 --with-hpc PATH
7321 give the path to hpc
7322 --with-hsc2hs PATH
7324 give the path to hsc2hs
7325 --with-hscolour PATH
7327 give the path to hscolour
7328 --with-jhc PATH
7330 give the path to jhc
7331 --with-ld PATH
7333 give the path to ld
7334 --with-pkg-config PATH
7336 give the path to pkg-config
7337 --with-runghc PATH
7339 give the path to runghc
7340 --with-strip PATH
7342 give the path to strip
7343 --with-tar PATH
7345 give the path to tar
7346 --with-uhc PATH
7348 give the path to uhc
7349 --alex-option OPT
7351 give an extra option to alex (no need to quote options
7352 containing spaces)
7353 --ar-option OPT
7355 give an extra option to ar (no need to quote options con‐
7356 taining spaces)
7357 --c2hs-option OPT
7359 give an extra option to c2hs (no need to quote options
7360 containing spaces)
7361 --cpphs-option OPT
7363 give an extra option to cpphs (no need to quote options
7364 containing spaces)
7365 --doctest-option OPT
7367 give an extra option to doctest (no need to quote options
7368 containing spaces)
7369 --gcc-option OPT
7371 give an extra option to gcc (no need to quote options
7372 containing spaces)
7373 --ghc-option OPT
7375 give an extra option to ghc (no need to quote options
7376 containing spaces)
7377 --ghc-pkg-option OPT
7379 give an extra option to ghc-pkg (no need to quote options
7380 containing spaces)
7381 --ghcjs-option OPT
7383 give an extra option to ghcjs (no need to quote options
7384 containing spaces)
7385 --ghcjs-pkg-option OPT
7387 give an extra option to ghcjs-pkg (no need to quote op‐
7388 tions containing spaces)
7389 --greencard-option OPT
7391 give an extra option to greencard (no need to quote op‐
7392 tions containing spaces)
7393 --haddock-option OPT
7395 give an extra option to haddock (no need to quote options
7396 containing spaces)
7397 --happy-option OPT
7399 give an extra option to happy (no need to quote options
7400 containing spaces)
7401 --haskell-suite-option OPT
7403 give an extra option to haskell-suite (no need to quote
7404 options containing spaces)
7405 --haskell-suite-pkg-option OPT
7407 give an extra option to haskell-suite-pkg (no need to
7408 quote options containing spaces)
7409 --hmake-option OPT
7411 give an extra option to hmake (no need to quote options
7412 containing spaces)
7413 --hpc-option OPT
7415 give an extra option to hpc (no need to quote options
7416 containing spaces)
7417 --hsc2hs-option OPT
7419 give an extra option to hsc2hs (no need to quote options
7420 containing spaces)
7421 --hscolour-option OPT
7423 give an extra option to hscolour (no need to quote op‐
7424 tions containing spaces)
7425 --jhc-option OPT
7427 give an extra option to jhc (no need to quote options
7428 containing spaces)
7429 --ld-option OPT
7431 give an extra option to ld (no need to quote options con‐
7432 taining spaces)
7433 --pkg-config-option OPT
7435 give an extra option to pkg-config (no need to quote op‐
7436 tions containing spaces)
7437 --runghc-option OPT
7439 give an extra option to runghc (no need to quote options
7440 containing spaces)
7441 --strip-option OPT
7443 give an extra option to strip (no need to quote options
7444 containing spaces)
7445 --tar-option OPT
7447 give an extra option to tar (no need to quote options
7448 containing spaces)
7449 --uhc-option OPT
7451 give an extra option to uhc (no need to quote options
7452 containing spaces)
7453 --alex-options OPTS
7455 give extra options to alex
7456 --ar-options OPTS
7458 give extra options to ar
7459 --c2hs-options OPTS
7461 give extra options to c2hs
7462 --cpphs-options OPTS
7464 give extra options to cpphs
7465 --doctest-options OPTS
7467 give extra options to doctest
7468 --gcc-options OPTS
7470 give extra options to gcc
7471 --ghc-options OPTS
7473 give extra options to ghc
7474 --ghc-pkg-options OPTS
7476 give extra options to ghc-pkg
7477 --ghcjs-options OPTS
7479 give extra options to ghcjs
7480 --ghcjs-pkg-options OPTS
7482 give extra options to ghcjs-pkg
7483 --greencard-options OPTS
7485 give extra options to greencard
7486 --haddock-options OPTS
7488 give extra options to haddock
7489 --happy-options OPTS
7491 give extra options to happy
7492 --haskell-suite-options OPTS
7494 give extra options to haskell-suite
7495 --haskell-suite-pkg-options OPTS
7497 give extra options to haskell-suite-pkg
7498 --hmake-options OPTS
7500 give extra options to hmake
7501 --hpc-options OPTS
7503 give extra options to hpc
7504 --hsc2hs-options OPTS
7506 give extra options to hsc2hs
7507 --hscolour-options OPTS
7509 give extra options to hscolour
7510 --jhc-options OPTS
7512 give extra options to jhc
7513 --ld-options OPTS
7515 give extra options to ld
7516 --pkg-config-options OPTS
7518 give extra options to pkg-config
7519 --runghc-options OPTS
7521 give extra options to runghc
7522 --strip-options OPTS
7524 give extra options to strip
7525 --tar-options OPTS
7527 give extra options to tar
7528 --uhc-options OPTS
7530 give extra options to uhc
7531 --cabal-lib-version VERSION
7533 Select which version of the Cabal lib to use to build
7534 packages (useful for testing).
7535 --constraint CONSTRAINT
7537 Specify constraints on a package (version, in‐
7538 stalled/source, flags)
7539 --preference CONSTRAINT
7541 Specify preferences (soft constraints) on the version of
7542 a package
7543 --solver SOLVER
7545 Select dependency solver to use (default: modular).
7546 Choices: modular.
7547 --allow-older [DEPS]
7549 Ignore lower bounds in all dependencies or DEPS
7550 --allow-newer [DEPS]
7552 Ignore upper bounds in all dependencies or DEPS
7553 --write-ghc-environment-files always|never|ghc8.4.4+
7555 Whether to create a .ghc.environment file after a suc‐
7556 cessful build (v2-build only)
7557 --enable-documentation
7559 --disable-documentation
7560 building of documentation
7561 --doc-index-file TEMPLATE
7563 A central index of haddock API documentation (template
7564 cannot use $pkgid)
7565 --dry-run
7567 Do not install anything, only print what would be in‐
7568 stalled.
7569 --max-backjumps NUM
7571 Maximum number of backjumps allowed while solving (de‐
7572 fault: 4000). Use a negative number to enable unlimited
7573 backtracking. Use 0 to disable backtracking completely.
7574 --reorder-goals
7576 --no-reorder-goals
7577 Try to reorder goals according to certain heuristics.
7578 Slows things down on average, but may make backtracking
7579 faster for some packages.
7580 --count-conflicts
7582 --no-count-conflicts
7583 Try to speed up solving by preferring goals that are in‐
7584 volved in a lot of conflicts (default).
7585 --fine-grained-conflicts
7587 --no-fine-grained-conflicts
7588 Skip a version of a package if it does not resolve the
7589 conflicts encountered in the last version, as a solver
7590 optimization (default).
7591 --minimize-conflict-set
7593 --no-minimize-conflict-set
7594 When there is no solution, try to improve the error mes‐
7595 sage by finding a minimal conflict set (default: false).
7596 May increase run time significantly.
7597 --independent-goals
7599 --no-independent-goals
7600 Treat several goals on the command line as independent.
7601 If several goals depend on the same package, different
7602 versions can be chosen.
7603 --shadow-installed-packages
7605 --no-shadow-installed-packages
7606 If multiple package instances of the same version are in‐
7607 stalled, treat all but one as shadowed.
7608 --strong-flags
7610 --no-strong-flags
7611 Do not defer flag choices (this used to be the default in
7612 cabal-install <= 1.20).
7613 --allow-boot-library-installs
7615 --no-allow-boot-library-installs
7616 Allow cabal to install base, ghc-prim, integer-simple,
7617 integer-gmp, and template-haskell.
7618 --reject-unconstrained-dependencies none|all
7620 Require these packages to have constraints on them if
7621 they are to be selected (default: none).
7622 --reinstall
7624 --no-reinstall
7625 Install even if it means installing the same version
7626 again.
7627 --avoid-reinstalls
7629 --no-avoid-reinstalls
7630 Do not select versions that would destructively overwrite
7631 installed packages.
7632 --force-reinstalls
7634 --no-force-reinstalls
7635 Reinstall packages even if they will most likely break
7636 other installed packages.
7637 --upgrade-dependencies
7639 --no-upgrade-dependencies
7640 Pick the latest version for all dependencies, rather than
7641 trying to pick an installed version.
7642 --only-dependencies
7644 --no-only-dependencies
7645 Install only the dependencies necessary to build the
7646 given packages
7647 --dependencies-only
7649 --no-dependencies-only
7650 A synonym for --only-dependencies
7651 --index-state STATE
7653 Use source package index state as it existed at a previ‐
7654 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
7655 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
7656 'HEAD' (default: 'HEAD').
7657 --root-cmd COMMAND
7659 (No longer supported, do not use.)
7660 --symlink-bindir DIR
7662 Add symlinks to installed executables into this direc‐
7663 tory.
7664 --build-summary TEMPLATE
7666 Save build summaries to file (name template can use
7667 $pkgid, $compiler, $os, $arch)
7668 --build-log TEMPLATE
7670 Log all builds to file (name template can use $pkgid,
7671 $compiler, $os, $arch)
7672 --remote-build-reporting LEVEL
7674 Generate build reports to send to a remote server (none,
7675 anonymous or detailed).
7676 --report-planning-failure
7678 Generate build reports when the dependency solver fails.
7679 This is used by the Hackage build bot.
7680 --enable-per-component
7682 --disable-per-component
7683 Per-component builds when possible
7684 --one-shot
7686 --no-one-shot
7687 Do not record the packages in the world file.
7688 --run-tests
7690 Run package test suites during installation.
7691 -j, --jobs [NUM]
7693 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
7694 given).
7695 --keep-going
7697 After a build failure, continue to build other unaffected
7698 packages.
7699 --offline
7701 --no-offline
7702 Don't download packages from the Internet.
7703 --project-file FILE
7705 Set the name of the cabal.project file to search for in
7706 parent directories
7707 --only
7709 Only installs the package in the current directory.
7710 --haddock-hoogle
7712 Generate a hoogle database
7713 --haddock-html
7715 Generate HTML documentation (the default)
7716 --haddock-html-location URL
7718 Location of HTML documentation for pre-requisite packages
7719 --haddock-for-hackage
7721 Collection of flags to generate documentation suitable
7722 for upload to hackage
7723 --haddock-executables
7725 Run haddock for Executables targets
7726 --haddock-tests
7728 Run haddock for Test Suite targets
7729 --haddock-benchmarks
7731 Run haddock for Benchmark targets
7732 --haddock-all
7734 Run haddock for all targets
7735 --haddock-internal
7737 Run haddock for internal modules and include all symbols
7738 --haddock-css PATH
7740 Use PATH as the haddock stylesheet
7741 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
7743 dock-hyperlinked-source
7744 Hyperlink the documentation to the source code
7745 --haddock-quickjump
7747 Generate an index for interactive documentation naviga‐
7748 tion
7749 --haddock-hscolour-css PATH
7751 Use PATH as the HsColour stylesheet
7752 --haddock-contents-location URL
7754 Bake URL in as the location for the contents page
7755 --test-log TEMPLATE
7757 Log all test suite results to file (name template can use
7758 $pkgid, $compiler, $os, $arch, $test-suite, $result)
7759 --test-machine-log TEMPLATE
7761 Produce a machine-readable log file (name template can
7762 use $pkgid, $compiler, $os, $arch, $result)
7763 --test-show-details FILTER
7765 --test-keep-tix-files
7767 keep .tix files for HPC between test runs
7768 --test-wrapper FILE
7770 Run test through a wrapper.
7771 --test-fail-when-no-test-suites
7773 Exit with failure when no test suites are found.
7774 --test-options TEMPLATES
7776 give extra options to test executables (name templates
7777 can use $pkgid, $compiler, $os, $arch, $test-suite)
7778 --test-option TEMPLATE
7780 give extra option to test executables (no need to quote
7781 options containing spaces, name template can use $pkgid,
7782 $compiler, $os, $arch, $test-suite)
7783 --benchmark-options TEMPLATES
7785 give extra options to benchmark executables (name tem‐
7786 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
7787 --benchmark-option TEMPLATE
7789 give extra option to benchmark executables (no need to
7790 quote options containing spaces, name template can use
7791 $pkgid, $compiler, $os, $arch, $benchmark)
7792 --only-configure
7794 --no-only-configure
7795 Instead of performing a full build just run the configure
7796 step
7797 cabal repl
7800 Usage: cabal repl [TARGET] [FLAGS]
7802 Open an interactive session for a component within the project. The
7805 available targets are the same as for the 'build' command: individual
7806 components within packages in the project, including libraries, exe‐
7807 cutables, test-suites or benchmarks. Packages can also be specified in
7808 which case the library component in the package will be used, or the
7809 (first listed) executable in the package if there is no library.
7810 Dependencies are built or rebuilt as necessary. Additional configura‐
7812 tion flags can be specified on the command line and these extend the
7813 project configuration from the 'cabal.project', 'cabal.project.local'
7814 and other files.
7815 Open an interactive session for a component within the project. The
7818 available targets are the same as for the 'build' command: individual
7819 components within packages in the project, including libraries, exe‐
7820 cutables, test-suites or benchmarks. Packages can also be specified in
7821 which case the library component in the package will be used, or the
7822 (first listed) executable in the package if there is no library.
7823 Dependencies are built or rebuilt as necessary. Additional configura‐
7825 tion flags can be specified on the command line and these extend the
7826 project configuration from the 'cabal.project', 'cabal.project.local'
7827 and other files.
7828 Flags:
7831 -v, --verbose [n]
7832 Control verbosity (n is 0--3, default verbosity level is
7833 1)
7834 --builddir, --distdir, --distpref DIR
7836 The directory where Cabal puts generated build files (de‐
7837 fault dist)
7838 -g, --ghc
7840 compile with GHC
7841 --ghcjs
7843 compile with GHCJS
7844 --uhc
7846 compile with UHC
7847 --haskell-suite
7849 compile with a haskell-suite compiler
7850 --cabal-file PATH
7852 use this Cabal file
7853 -w, --with-compiler PATH
7855 give the path to a particular compiler
7856 --with-hc-pkg PATH
7858 give the path to the package tool
7859 --prefix DIR
7861 bake this prefix in preparation of installation
7862 --bindir DIR
7864 installation directory for executables
7865 --libdir DIR
7867 installation directory for libraries
7868 --libsubdir DIR
7870 subdirectory of libdir in which libs are installed
7871 --dynlibdir DIR
7873 installation directory for dynamic libraries
7874 --libexecdir DIR
7876 installation directory for program executables
7877 --libexecsubdir DIR
7879 subdirectory of libexecdir in which private executables
7880 are installed
7881 --datadir DIR
7883 installation directory for read-only data
7884 --datasubdir DIR
7886 subdirectory of datadir in which data files are installed
7887 --docdir DIR
7889 installation directory for documentation
7890 --htmldir DIR
7892 installation directory for HTML documentation
7893 --haddockdir DIR
7895 installation directory for haddock interfaces
7896 --sysconfdir DIR
7898 installation directory for configuration files
7899 --program-prefix PREFIX
7901 prefix to be applied to installed executables
7902 --program-suffix SUFFIX
7904 suffix to be applied to installed executables
7905 --enable-library-vanilla
7907 --disable-library-vanilla
7908 Vanilla libraries
7909 -p, --enable-library-profiling
7911 --disable-library-profiling
7912 Library profiling
7913 --enable-shared
7915 --disable-shared
7916 Shared library
7917 --enable-static
7919 --disable-static
7920 Static library
7921 --enable-executable-dynamic
7923 --disable-executable-dynamic
7924 Executable dynamic linking
7925 --enable-executable-static
7927 --disable-executable-static
7928 Executable fully static linking
7929 --enable-profiling
7931 --disable-profiling
7932 Executable and library profiling
7933 --enable-executable-profiling
7935 --disable-executable-profiling
7936 Executable profiling (DEPRECATED)
7937 --profiling-detail level
7939 Profiling detail level for executable and library (de‐
7940 fault, none, exported-functions, toplevel-functions,
7941 all-functions).
7942 --library-profiling-detail level
7944 Profiling detail level for libraries only.
7945 -O, --enable-optimization, --enable-optimisation [n]
7947 Build with optimization (n is 0--2, default is 1)
7948 --disable-optimization, --disable-optimisation
7950 Build without optimization
7951 --enable-debug-info [n]
7953 Emit debug info (n is 0--3, default is 0)
7954 --disable-debug-info
7956 Don't emit debug info
7957 --enable-library-for-ghci
7959 --disable-library-for-ghci
7960 compile library for use with GHCi
7961 --enable-split-sections
7963 --disable-split-sections
7964 compile library code such that unneeded definitions can
7965 be dropped from the final executable (GHC 7.8+)
7966 --enable-split-objs
7968 --disable-split-objs
7969 split library into smaller objects to reduce binary sizes
7970 (GHC 6.6+)
7971 --enable-executable-stripping
7973 --disable-executable-stripping
7974 strip executables upon installation to reduce binary
7975 sizes
7976 --enable-library-stripping
7978 --disable-library-stripping
7979 strip libraries upon installation to reduce binary sizes
7980 --configure-option OPT
7982 Extra option for configure
7983 --user
7985 --global
7986 doing a per-user installation
7987 --package-db DB
7989 Append the given package database to the list of package
7990 databases used (to satisfy dependencies and register
7991 into). May be a specific file, 'global' or 'user'. The
7992 initial list is ['global'], ['global', 'user'], or
7993 ['global', $sandbox], depending on context. Use 'clear'
7994 to reset the list to empty. See the user guide for de‐
7995 tails.
7996 -f, --flags FLAGS
7998 Force values for the given flags in Cabal conditionals in
7999 the .cabal file. E.g., --flags="debug -usebytestrings"
8000 forces the flag "debug" to true and "usebytestrings" to
8001 false.
8002 --extra-include-dirs PATH
8004 A list of directories to search for header files
8005 --enable-deterministic
8007 --disable-deterministic
8008 Try to be as deterministic as possible (used by the test
8009 suite)
8010 --ipid IPID
8012 Installed package ID to compile this package as
8013 --cid CID
8015 Installed component ID to compile this component as
8016 --extra-lib-dirs PATH
8018 A list of directories to search for external libraries
8019 --extra-framework-dirs PATH
8021 A list of directories to search for external frameworks
8022 (OS X only)
8023 --extra-prog-path PATH
8025 A list of directories to search for required programs (in
8026 addition to the normal search locations)
8027 --instantiate-with NAME=MOD
8029 A mapping of signature names to concrete module instanti‐
8030 ations.
8031 --enable-tests
8033 --disable-tests
8034 dependency checking and compilation for test suites
8035 listed in the package description file.
8036 --enable-coverage
8038 --disable-coverage
8039 build package with Haskell Program Coverage. (GHC only)
8040 --enable-library-coverage
8042 --disable-library-coverage
8043 build package with Haskell Program Coverage. (GHC only)
8044 (DEPRECATED)
8045 --enable-benchmarks
8047 --disable-benchmarks
8048 dependency checking and compilation for benchmarks listed
8049 in the package description file.
8050 --enable-relocatable
8052 --disable-relocatable
8053 building a package that is relocatable. (GHC only)
8054 --disable-response-files
8056 enable workaround for old versions of programs like "ar"
8057 that do not support @file arguments
8058 --allow-depending-on-private-libs
8060 Allow depending on private libraries. If set, the library
8061 visibility check MUST be done externally.
8062 --with-alex PATH
8064 give the path to alex
8065 --with-ar PATH
8067 give the path to ar
8068 --with-c2hs PATH
8070 give the path to c2hs
8071 --with-cpphs PATH
8073 give the path to cpphs
8074 --with-doctest PATH
8076 give the path to doctest
8077 --with-gcc PATH
8079 give the path to gcc
8080 --with-ghc PATH
8082 give the path to ghc
8083 --with-ghc-pkg PATH
8085 give the path to ghc-pkg
8086 --with-ghcjs PATH
8088 give the path to ghcjs
8089 --with-ghcjs-pkg PATH
8091 give the path to ghcjs-pkg
8092 --with-greencard PATH
8094 give the path to greencard
8095 --with-haddock PATH
8097 give the path to haddock
8098 --with-happy PATH
8100 give the path to happy
8101 --with-haskell-suite PATH
8103 give the path to haskell-suite
8104 --with-haskell-suite-pkg PATH
8106 give the path to haskell-suite-pkg
8107 --with-hmake PATH
8109 give the path to hmake
8110 --with-hpc PATH
8112 give the path to hpc
8113 --with-hsc2hs PATH
8115 give the path to hsc2hs
8116 --with-hscolour PATH
8118 give the path to hscolour
8119 --with-jhc PATH
8121 give the path to jhc
8122 --with-ld PATH
8124 give the path to ld
8125 --with-pkg-config PATH
8127 give the path to pkg-config
8128 --with-runghc PATH
8130 give the path to runghc
8131 --with-strip PATH
8133 give the path to strip
8134 --with-tar PATH
8136 give the path to tar
8137 --with-uhc PATH
8139 give the path to uhc
8140 --alex-option OPT
8142 give an extra option to alex (no need to quote options
8143 containing spaces)
8144 --ar-option OPT
8146 give an extra option to ar (no need to quote options con‐
8147 taining spaces)
8148 --c2hs-option OPT
8150 give an extra option to c2hs (no need to quote options
8151 containing spaces)
8152 --cpphs-option OPT
8154 give an extra option to cpphs (no need to quote options
8155 containing spaces)
8156 --doctest-option OPT
8158 give an extra option to doctest (no need to quote options
8159 containing spaces)
8160 --gcc-option OPT
8162 give an extra option to gcc (no need to quote options
8163 containing spaces)
8164 --ghc-option OPT
8166 give an extra option to ghc (no need to quote options
8167 containing spaces)
8168 --ghc-pkg-option OPT
8170 give an extra option to ghc-pkg (no need to quote options
8171 containing spaces)
8172 --ghcjs-option OPT
8174 give an extra option to ghcjs (no need to quote options
8175 containing spaces)
8176 --ghcjs-pkg-option OPT
8178 give an extra option to ghcjs-pkg (no need to quote op‐
8179 tions containing spaces)
8180 --greencard-option OPT
8182 give an extra option to greencard (no need to quote op‐
8183 tions containing spaces)
8184 --haddock-option OPT
8186 give an extra option to haddock (no need to quote options
8187 containing spaces)
8188 --happy-option OPT
8190 give an extra option to happy (no need to quote options
8191 containing spaces)
8192 --haskell-suite-option OPT
8194 give an extra option to haskell-suite (no need to quote
8195 options containing spaces)
8196 --haskell-suite-pkg-option OPT
8198 give an extra option to haskell-suite-pkg (no need to
8199 quote options containing spaces)
8200 --hmake-option OPT
8202 give an extra option to hmake (no need to quote options
8203 containing spaces)
8204 --hpc-option OPT
8206 give an extra option to hpc (no need to quote options
8207 containing spaces)
8208 --hsc2hs-option OPT
8210 give an extra option to hsc2hs (no need to quote options
8211 containing spaces)
8212 --hscolour-option OPT
8214 give an extra option to hscolour (no need to quote op‐
8215 tions containing spaces)
8216 --jhc-option OPT
8218 give an extra option to jhc (no need to quote options
8219 containing spaces)
8220 --ld-option OPT
8222 give an extra option to ld (no need to quote options con‐
8223 taining spaces)
8224 --pkg-config-option OPT
8226 give an extra option to pkg-config (no need to quote op‐
8227 tions containing spaces)
8228 --runghc-option OPT
8230 give an extra option to runghc (no need to quote options
8231 containing spaces)
8232 --strip-option OPT
8234 give an extra option to strip (no need to quote options
8235 containing spaces)
8236 --tar-option OPT
8238 give an extra option to tar (no need to quote options
8239 containing spaces)
8240 --uhc-option OPT
8242 give an extra option to uhc (no need to quote options
8243 containing spaces)
8244 --alex-options OPTS
8246 give extra options to alex
8247 --ar-options OPTS
8249 give extra options to ar
8250 --c2hs-options OPTS
8252 give extra options to c2hs
8253 --cpphs-options OPTS
8255 give extra options to cpphs
8256 --doctest-options OPTS
8258 give extra options to doctest
8259 --gcc-options OPTS
8261 give extra options to gcc
8262 --ghc-options OPTS
8264 give extra options to ghc
8265 --ghc-pkg-options OPTS
8267 give extra options to ghc-pkg
8268 --ghcjs-options OPTS
8270 give extra options to ghcjs
8271 --ghcjs-pkg-options OPTS
8273 give extra options to ghcjs-pkg
8274 --greencard-options OPTS
8276 give extra options to greencard
8277 --haddock-options OPTS
8279 give extra options to haddock
8280 --happy-options OPTS
8282 give extra options to happy
8283 --haskell-suite-options OPTS
8285 give extra options to haskell-suite
8286 --haskell-suite-pkg-options OPTS
8288 give extra options to haskell-suite-pkg
8289 --hmake-options OPTS
8291 give extra options to hmake
8292 --hpc-options OPTS
8294 give extra options to hpc
8295 --hsc2hs-options OPTS
8297 give extra options to hsc2hs
8298 --hscolour-options OPTS
8300 give extra options to hscolour
8301 --jhc-options OPTS
8303 give extra options to jhc
8304 --ld-options OPTS
8306 give extra options to ld
8307 --pkg-config-options OPTS
8309 give extra options to pkg-config
8310 --runghc-options OPTS
8312 give extra options to runghc
8313 --strip-options OPTS
8315 give extra options to strip
8316 --tar-options OPTS
8318 give extra options to tar
8319 --uhc-options OPTS
8321 give extra options to uhc
8322 --cabal-lib-version VERSION
8324 Select which version of the Cabal lib to use to build
8325 packages (useful for testing).
8326 --constraint CONSTRAINT
8328 Specify constraints on a package (version, in‐
8329 stalled/source, flags)
8330 --preference CONSTRAINT
8332 Specify preferences (soft constraints) on the version of
8333 a package
8334 --solver SOLVER
8336 Select dependency solver to use (default: modular).
8337 Choices: modular.
8338 --allow-older [DEPS]
8340 Ignore lower bounds in all dependencies or DEPS
8341 --allow-newer [DEPS]
8343 Ignore upper bounds in all dependencies or DEPS
8344 --write-ghc-environment-files always|never|ghc8.4.4+
8346 Whether to create a .ghc.environment file after a suc‐
8347 cessful build (v2-build only)
8348 --enable-documentation
8350 --disable-documentation
8351 building of documentation
8352 --doc-index-file TEMPLATE
8354 A central index of haddock API documentation (template
8355 cannot use $pkgid)
8356 --dry-run
8358 Do not install anything, only print what would be in‐
8359 stalled.
8360 --max-backjumps NUM
8362 Maximum number of backjumps allowed while solving (de‐
8363 fault: 4000). Use a negative number to enable unlimited
8364 backtracking. Use 0 to disable backtracking completely.
8365 --reorder-goals
8367 --no-reorder-goals
8368 Try to reorder goals according to certain heuristics.
8369 Slows things down on average, but may make backtracking
8370 faster for some packages.
8371 --count-conflicts
8373 --no-count-conflicts
8374 Try to speed up solving by preferring goals that are in‐
8375 volved in a lot of conflicts (default).
8376 --fine-grained-conflicts
8378 --no-fine-grained-conflicts
8379 Skip a version of a package if it does not resolve the
8380 conflicts encountered in the last version, as a solver
8381 optimization (default).
8382 --minimize-conflict-set
8384 --no-minimize-conflict-set
8385 When there is no solution, try to improve the error mes‐
8386 sage by finding a minimal conflict set (default: false).
8387 May increase run time significantly.
8388 --independent-goals
8390 --no-independent-goals
8391 Treat several goals on the command line as independent.
8392 If several goals depend on the same package, different
8393 versions can be chosen.
8394 --shadow-installed-packages
8396 --no-shadow-installed-packages
8397 If multiple package instances of the same version are in‐
8398 stalled, treat all but one as shadowed.
8399 --strong-flags
8401 --no-strong-flags
8402 Do not defer flag choices (this used to be the default in
8403 cabal-install <= 1.20).
8404 --allow-boot-library-installs
8406 --no-allow-boot-library-installs
8407 Allow cabal to install base, ghc-prim, integer-simple,
8408 integer-gmp, and template-haskell.
8409 --reject-unconstrained-dependencies none|all
8411 Require these packages to have constraints on them if
8412 they are to be selected (default: none).
8413 --reinstall
8415 --no-reinstall
8416 Install even if it means installing the same version
8417 again.
8418 --avoid-reinstalls
8420 --no-avoid-reinstalls
8421 Do not select versions that would destructively overwrite
8422 installed packages.
8423 --force-reinstalls
8425 --no-force-reinstalls
8426 Reinstall packages even if they will most likely break
8427 other installed packages.
8428 --upgrade-dependencies
8430 --no-upgrade-dependencies
8431 Pick the latest version for all dependencies, rather than
8432 trying to pick an installed version.
8433 --only-dependencies
8435 --no-only-dependencies
8436 Install only the dependencies necessary to build the
8437 given packages
8438 --dependencies-only
8440 --no-dependencies-only
8441 A synonym for --only-dependencies
8442 --index-state STATE
8444 Use source package index state as it existed at a previ‐
8445 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
8446 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
8447 'HEAD' (default: 'HEAD').
8448 --root-cmd COMMAND
8450 (No longer supported, do not use.)
8451 --symlink-bindir DIR
8453 Add symlinks to installed executables into this direc‐
8454 tory.
8455 --build-summary TEMPLATE
8457 Save build summaries to file (name template can use
8458 $pkgid, $compiler, $os, $arch)
8459 --build-log TEMPLATE
8461 Log all builds to file (name template can use $pkgid,
8462 $compiler, $os, $arch)
8463 --remote-build-reporting LEVEL
8465 Generate build reports to send to a remote server (none,
8466 anonymous or detailed).
8467 --report-planning-failure
8469 Generate build reports when the dependency solver fails.
8470 This is used by the Hackage build bot.
8471 --enable-per-component
8473 --disable-per-component
8474 Per-component builds when possible
8475 --one-shot
8477 --no-one-shot
8478 Do not record the packages in the world file.
8479 --run-tests
8481 Run package test suites during installation.
8482 -j, --jobs [NUM]
8484 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
8485 given).
8486 --keep-going
8488 After a build failure, continue to build other unaffected
8489 packages.
8490 --offline
8492 --no-offline
8493 Don't download packages from the Internet.
8494 --project-file FILE
8496 Set the name of the cabal.project file to search for in
8497 parent directories
8498 --only
8500 Only installs the package in the current directory.
8501 --haddock-hoogle
8503 Generate a hoogle database
8504 --haddock-html
8506 Generate HTML documentation (the default)
8507 --haddock-html-location URL
8509 Location of HTML documentation for pre-requisite packages
8510 --haddock-for-hackage
8512 Collection of flags to generate documentation suitable
8513 for upload to hackage
8514 --haddock-executables
8516 Run haddock for Executables targets
8517 --haddock-tests
8519 Run haddock for Test Suite targets
8520 --haddock-benchmarks
8522 Run haddock for Benchmark targets
8523 --haddock-all
8525 Run haddock for all targets
8526 --haddock-internal
8528 Run haddock for internal modules and include all symbols
8529 --haddock-css PATH
8531 Use PATH as the haddock stylesheet
8532 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
8534 dock-hyperlinked-source
8535 Hyperlink the documentation to the source code
8536 --haddock-quickjump
8538 Generate an index for interactive documentation naviga‐
8539 tion
8540 --haddock-hscolour-css PATH
8542 Use PATH as the HsColour stylesheet
8543 --haddock-contents-location URL
8545 Bake URL in as the location for the contents page
8546 --test-log TEMPLATE
8548 Log all test suite results to file (name template can use
8549 $pkgid, $compiler, $os, $arch, $test-suite, $result)
8550 --test-machine-log TEMPLATE
8552 Produce a machine-readable log file (name template can
8553 use $pkgid, $compiler, $os, $arch, $result)
8554 --test-show-details FILTER
8556 --test-keep-tix-files
8558 keep .tix files for HPC between test runs
8559 --test-wrapper FILE
8561 Run test through a wrapper.
8562 --test-fail-when-no-test-suites
8564 Exit with failure when no test suites are found.
8565 --test-options TEMPLATES
8567 give extra options to test executables (name templates
8568 can use $pkgid, $compiler, $os, $arch, $test-suite)
8569 --test-option TEMPLATE
8571 give extra option to test executables (no need to quote
8572 options containing spaces, name template can use $pkgid,
8573 $compiler, $os, $arch, $test-suite)
8574 --benchmark-options TEMPLATES
8576 give extra options to benchmark executables (name tem‐
8577 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
8578 --benchmark-option TEMPLATE
8580 give extra option to benchmark executables (no need to
8581 quote options containing spaces, name template can use
8582 $pkgid, $compiler, $os, $arch, $benchmark)
8583 --repl-options FLAG
8585 use this option for the repl
8586 -b, --build-depends DEPENDENCY
8588 Include an additional package in the environment pre‐
8589 sented to GHCi.
8590 --no-transitive-deps
8592 Don't automatically include transitive dependencies of
8593 requested packages.
8594 -z, --ignore-project
8596 Only include explicitly specified packages (and 'base').
8597 cabal new-repl
8600 Usage: cabal new-repl [TARGET] [FLAGS]
8602 Open an interactive session for a component within the project. The
8605 available targets are the same as for the 'new-build' command: individ‐
8606 ual components within packages in the project, including libraries, ex‐
8607 ecutables, test-suites or benchmarks. Packages can also be specified in
8608 which case the library component in the package will be used, or the
8609 (first listed) executable in the package if there is no library.
8610 Dependencies are built or rebuilt as necessary. Additional configura‐
8612 tion flags can be specified on the command line and these extend the
8613 project configuration from the 'cabal.project', 'cabal.project.local'
8614 and other files.
8615 Open an interactive session for a component within the project. The
8618 available targets are the same as for the 'new-build' command: individ‐
8619 ual components within packages in the project, including libraries, ex‐
8620 ecutables, test-suites or benchmarks. Packages can also be specified in
8621 which case the library component in the package will be used, or the
8622 (first listed) executable in the package if there is no library.
8623 Dependencies are built or rebuilt as necessary. Additional configura‐
8625 tion flags can be specified on the command line and these extend the
8626 project configuration from the 'cabal.project', 'cabal.project.local'
8627 and other files.
8628 Flags:
8631 -v, --verbose [n]
8632 Control verbosity (n is 0--3, default verbosity level is
8633 1)
8634 --builddir, --distdir, --distpref DIR
8636 The directory where Cabal puts generated build files (de‐
8637 fault dist)
8638 -g, --ghc
8640 compile with GHC
8641 --ghcjs
8643 compile with GHCJS
8644 --uhc
8646 compile with UHC
8647 --haskell-suite
8649 compile with a haskell-suite compiler
8650 --cabal-file PATH
8652 use this Cabal file
8653 -w, --with-compiler PATH
8655 give the path to a particular compiler
8656 --with-hc-pkg PATH
8658 give the path to the package tool
8659 --prefix DIR
8661 bake this prefix in preparation of installation
8662 --bindir DIR
8664 installation directory for executables
8665 --libdir DIR
8667 installation directory for libraries
8668 --libsubdir DIR
8670 subdirectory of libdir in which libs are installed
8671 --dynlibdir DIR
8673 installation directory for dynamic libraries
8674 --libexecdir DIR
8676 installation directory for program executables
8677 --libexecsubdir DIR
8679 subdirectory of libexecdir in which private executables
8680 are installed
8681 --datadir DIR
8683 installation directory for read-only data
8684 --datasubdir DIR
8686 subdirectory of datadir in which data files are installed
8687 --docdir DIR
8689 installation directory for documentation
8690 --htmldir DIR
8692 installation directory for HTML documentation
8693 --haddockdir DIR
8695 installation directory for haddock interfaces
8696 --sysconfdir DIR
8698 installation directory for configuration files
8699 --program-prefix PREFIX
8701 prefix to be applied to installed executables
8702 --program-suffix SUFFIX
8704 suffix to be applied to installed executables
8705 --enable-library-vanilla
8707 --disable-library-vanilla
8708 Vanilla libraries
8709 -p, --enable-library-profiling
8711 --disable-library-profiling
8712 Library profiling
8713 --enable-shared
8715 --disable-shared
8716 Shared library
8717 --enable-static
8719 --disable-static
8720 Static library
8721 --enable-executable-dynamic
8723 --disable-executable-dynamic
8724 Executable dynamic linking
8725 --enable-executable-static
8727 --disable-executable-static
8728 Executable fully static linking
8729 --enable-profiling
8731 --disable-profiling
8732 Executable and library profiling
8733 --enable-executable-profiling
8735 --disable-executable-profiling
8736 Executable profiling (DEPRECATED)
8737 --profiling-detail level
8739 Profiling detail level for executable and library (de‐
8740 fault, none, exported-functions, toplevel-functions,
8741 all-functions).
8742 --library-profiling-detail level
8744 Profiling detail level for libraries only.
8745 -O, --enable-optimization, --enable-optimisation [n]
8747 Build with optimization (n is 0--2, default is 1)
8748 --disable-optimization, --disable-optimisation
8750 Build without optimization
8751 --enable-debug-info [n]
8753 Emit debug info (n is 0--3, default is 0)
8754 --disable-debug-info
8756 Don't emit debug info
8757 --enable-library-for-ghci
8759 --disable-library-for-ghci
8760 compile library for use with GHCi
8761 --enable-split-sections
8763 --disable-split-sections
8764 compile library code such that unneeded definitions can
8765 be dropped from the final executable (GHC 7.8+)
8766 --enable-split-objs
8768 --disable-split-objs
8769 split library into smaller objects to reduce binary sizes
8770 (GHC 6.6+)
8771 --enable-executable-stripping
8773 --disable-executable-stripping
8774 strip executables upon installation to reduce binary
8775 sizes
8776 --enable-library-stripping
8778 --disable-library-stripping
8779 strip libraries upon installation to reduce binary sizes
8780 --configure-option OPT
8782 Extra option for configure
8783 --user
8785 --global
8786 doing a per-user installation
8787 --package-db DB
8789 Append the given package database to the list of package
8790 databases used (to satisfy dependencies and register
8791 into). May be a specific file, 'global' or 'user'. The
8792 initial list is ['global'], ['global', 'user'], or
8793 ['global', $sandbox], depending on context. Use 'clear'
8794 to reset the list to empty. See the user guide for de‐
8795 tails.
8796 -f, --flags FLAGS
8798 Force values for the given flags in Cabal conditionals in
8799 the .cabal file. E.g., --flags="debug -usebytestrings"
8800 forces the flag "debug" to true and "usebytestrings" to
8801 false.
8802 --extra-include-dirs PATH
8804 A list of directories to search for header files
8805 --enable-deterministic
8807 --disable-deterministic
8808 Try to be as deterministic as possible (used by the test
8809 suite)
8810 --ipid IPID
8812 Installed package ID to compile this package as
8813 --cid CID
8815 Installed component ID to compile this component as
8816 --extra-lib-dirs PATH
8818 A list of directories to search for external libraries
8819 --extra-framework-dirs PATH
8821 A list of directories to search for external frameworks
8822 (OS X only)
8823 --extra-prog-path PATH
8825 A list of directories to search for required programs (in
8826 addition to the normal search locations)
8827 --instantiate-with NAME=MOD
8829 A mapping of signature names to concrete module instanti‐
8830 ations.
8831 --enable-tests
8833 --disable-tests
8834 dependency checking and compilation for test suites
8835 listed in the package description file.
8836 --enable-coverage
8838 --disable-coverage
8839 build package with Haskell Program Coverage. (GHC only)
8840 --enable-library-coverage
8842 --disable-library-coverage
8843 build package with Haskell Program Coverage. (GHC only)
8844 (DEPRECATED)
8845 --enable-benchmarks
8847 --disable-benchmarks
8848 dependency checking and compilation for benchmarks listed
8849 in the package description file.
8850 --enable-relocatable
8852 --disable-relocatable
8853 building a package that is relocatable. (GHC only)
8854 --disable-response-files
8856 enable workaround for old versions of programs like "ar"
8857 that do not support @file arguments
8858 --allow-depending-on-private-libs
8860 Allow depending on private libraries. If set, the library
8861 visibility check MUST be done externally.
8862 --with-alex PATH
8864 give the path to alex
8865 --with-ar PATH
8867 give the path to ar
8868 --with-c2hs PATH
8870 give the path to c2hs
8871 --with-cpphs PATH
8873 give the path to cpphs
8874 --with-doctest PATH
8876 give the path to doctest
8877 --with-gcc PATH
8879 give the path to gcc
8880 --with-ghc PATH
8882 give the path to ghc
8883 --with-ghc-pkg PATH
8885 give the path to ghc-pkg
8886 --with-ghcjs PATH
8888 give the path to ghcjs
8889 --with-ghcjs-pkg PATH
8891 give the path to ghcjs-pkg
8892 --with-greencard PATH
8894 give the path to greencard
8895 --with-haddock PATH
8897 give the path to haddock
8898 --with-happy PATH
8900 give the path to happy
8901 --with-haskell-suite PATH
8903 give the path to haskell-suite
8904 --with-haskell-suite-pkg PATH
8906 give the path to haskell-suite-pkg
8907 --with-hmake PATH
8909 give the path to hmake
8910 --with-hpc PATH
8912 give the path to hpc
8913 --with-hsc2hs PATH
8915 give the path to hsc2hs
8916 --with-hscolour PATH
8918 give the path to hscolour
8919 --with-jhc PATH
8921 give the path to jhc
8922 --with-ld PATH
8924 give the path to ld
8925 --with-pkg-config PATH
8927 give the path to pkg-config
8928 --with-runghc PATH
8930 give the path to runghc
8931 --with-strip PATH
8933 give the path to strip
8934 --with-tar PATH
8936 give the path to tar
8937 --with-uhc PATH
8939 give the path to uhc
8940 --alex-option OPT
8942 give an extra option to alex (no need to quote options
8943 containing spaces)
8944 --ar-option OPT
8946 give an extra option to ar (no need to quote options con‐
8947 taining spaces)
8948 --c2hs-option OPT
8950 give an extra option to c2hs (no need to quote options
8951 containing spaces)
8952 --cpphs-option OPT
8954 give an extra option to cpphs (no need to quote options
8955 containing spaces)
8956 --doctest-option OPT
8958 give an extra option to doctest (no need to quote options
8959 containing spaces)
8960 --gcc-option OPT
8962 give an extra option to gcc (no need to quote options
8963 containing spaces)
8964 --ghc-option OPT
8966 give an extra option to ghc (no need to quote options
8967 containing spaces)
8968 --ghc-pkg-option OPT
8970 give an extra option to ghc-pkg (no need to quote options
8971 containing spaces)
8972 --ghcjs-option OPT
8974 give an extra option to ghcjs (no need to quote options
8975 containing spaces)
8976 --ghcjs-pkg-option OPT
8978 give an extra option to ghcjs-pkg (no need to quote op‐
8979 tions containing spaces)
8980 --greencard-option OPT
8982 give an extra option to greencard (no need to quote op‐
8983 tions containing spaces)
8984 --haddock-option OPT
8986 give an extra option to haddock (no need to quote options
8987 containing spaces)
8988 --happy-option OPT
8990 give an extra option to happy (no need to quote options
8991 containing spaces)
8992 --haskell-suite-option OPT
8994 give an extra option to haskell-suite (no need to quote
8995 options containing spaces)
8996 --haskell-suite-pkg-option OPT
8998 give an extra option to haskell-suite-pkg (no need to
8999 quote options containing spaces)
9000 --hmake-option OPT
9002 give an extra option to hmake (no need to quote options
9003 containing spaces)
9004 --hpc-option OPT
9006 give an extra option to hpc (no need to quote options
9007 containing spaces)
9008 --hsc2hs-option OPT
9010 give an extra option to hsc2hs (no need to quote options
9011 containing spaces)
9012 --hscolour-option OPT
9014 give an extra option to hscolour (no need to quote op‐
9015 tions containing spaces)
9016 --jhc-option OPT
9018 give an extra option to jhc (no need to quote options
9019 containing spaces)
9020 --ld-option OPT
9022 give an extra option to ld (no need to quote options con‐
9023 taining spaces)
9024 --pkg-config-option OPT
9026 give an extra option to pkg-config (no need to quote op‐
9027 tions containing spaces)
9028 --runghc-option OPT
9030 give an extra option to runghc (no need to quote options
9031 containing spaces)
9032 --strip-option OPT
9034 give an extra option to strip (no need to quote options
9035 containing spaces)
9036 --tar-option OPT
9038 give an extra option to tar (no need to quote options
9039 containing spaces)
9040 --uhc-option OPT
9042 give an extra option to uhc (no need to quote options
9043 containing spaces)
9044 --alex-options OPTS
9046 give extra options to alex
9047 --ar-options OPTS
9049 give extra options to ar
9050 --c2hs-options OPTS
9052 give extra options to c2hs
9053 --cpphs-options OPTS
9055 give extra options to cpphs
9056 --doctest-options OPTS
9058 give extra options to doctest
9059 --gcc-options OPTS
9061 give extra options to gcc
9062 --ghc-options OPTS
9064 give extra options to ghc
9065 --ghc-pkg-options OPTS
9067 give extra options to ghc-pkg
9068 --ghcjs-options OPTS
9070 give extra options to ghcjs
9071 --ghcjs-pkg-options OPTS
9073 give extra options to ghcjs-pkg
9074 --greencard-options OPTS
9076 give extra options to greencard
9077 --haddock-options OPTS
9079 give extra options to haddock
9080 --happy-options OPTS
9082 give extra options to happy
9083 --haskell-suite-options OPTS
9085 give extra options to haskell-suite
9086 --haskell-suite-pkg-options OPTS
9088 give extra options to haskell-suite-pkg
9089 --hmake-options OPTS
9091 give extra options to hmake
9092 --hpc-options OPTS
9094 give extra options to hpc
9095 --hsc2hs-options OPTS
9097 give extra options to hsc2hs
9098 --hscolour-options OPTS
9100 give extra options to hscolour
9101 --jhc-options OPTS
9103 give extra options to jhc
9104 --ld-options OPTS
9106 give extra options to ld
9107 --pkg-config-options OPTS
9109 give extra options to pkg-config
9110 --runghc-options OPTS
9112 give extra options to runghc
9113 --strip-options OPTS
9115 give extra options to strip
9116 --tar-options OPTS
9118 give extra options to tar
9119 --uhc-options OPTS
9121 give extra options to uhc
9122 --cabal-lib-version VERSION
9124 Select which version of the Cabal lib to use to build
9125 packages (useful for testing).
9126 --constraint CONSTRAINT
9128 Specify constraints on a package (version, in‐
9129 stalled/source, flags)
9130 --preference CONSTRAINT
9132 Specify preferences (soft constraints) on the version of
9133 a package
9134 --solver SOLVER
9136 Select dependency solver to use (default: modular).
9137 Choices: modular.
9138 --allow-older [DEPS]
9140 Ignore lower bounds in all dependencies or DEPS
9141 --allow-newer [DEPS]
9143 Ignore upper bounds in all dependencies or DEPS
9144 --write-ghc-environment-files always|never|ghc8.4.4+
9146 Whether to create a .ghc.environment file after a suc‐
9147 cessful build (v2-build only)
9148 --enable-documentation
9150 --disable-documentation
9151 building of documentation
9152 --doc-index-file TEMPLATE
9154 A central index of haddock API documentation (template
9155 cannot use $pkgid)
9156 --dry-run
9158 Do not install anything, only print what would be in‐
9159 stalled.
9160 --max-backjumps NUM
9162 Maximum number of backjumps allowed while solving (de‐
9163 fault: 4000). Use a negative number to enable unlimited
9164 backtracking. Use 0 to disable backtracking completely.
9165 --reorder-goals
9167 --no-reorder-goals
9168 Try to reorder goals according to certain heuristics.
9169 Slows things down on average, but may make backtracking
9170 faster for some packages.
9171 --count-conflicts
9173 --no-count-conflicts
9174 Try to speed up solving by preferring goals that are in‐
9175 volved in a lot of conflicts (default).
9176 --fine-grained-conflicts
9178 --no-fine-grained-conflicts
9179 Skip a version of a package if it does not resolve the
9180 conflicts encountered in the last version, as a solver
9181 optimization (default).
9182 --minimize-conflict-set
9184 --no-minimize-conflict-set
9185 When there is no solution, try to improve the error mes‐
9186 sage by finding a minimal conflict set (default: false).
9187 May increase run time significantly.
9188 --independent-goals
9190 --no-independent-goals
9191 Treat several goals on the command line as independent.
9192 If several goals depend on the same package, different
9193 versions can be chosen.
9194 --shadow-installed-packages
9196 --no-shadow-installed-packages
9197 If multiple package instances of the same version are in‐
9198 stalled, treat all but one as shadowed.
9199 --strong-flags
9201 --no-strong-flags
9202 Do not defer flag choices (this used to be the default in
9203 cabal-install <= 1.20).
9204 --allow-boot-library-installs
9206 --no-allow-boot-library-installs
9207 Allow cabal to install base, ghc-prim, integer-simple,
9208 integer-gmp, and template-haskell.
9209 --reject-unconstrained-dependencies none|all
9211 Require these packages to have constraints on them if
9212 they are to be selected (default: none).
9213 --reinstall
9215 --no-reinstall
9216 Install even if it means installing the same version
9217 again.
9218 --avoid-reinstalls
9220 --no-avoid-reinstalls
9221 Do not select versions that would destructively overwrite
9222 installed packages.
9223 --force-reinstalls
9225 --no-force-reinstalls
9226 Reinstall packages even if they will most likely break
9227 other installed packages.
9228 --upgrade-dependencies
9230 --no-upgrade-dependencies
9231 Pick the latest version for all dependencies, rather than
9232 trying to pick an installed version.
9233 --only-dependencies
9235 --no-only-dependencies
9236 Install only the dependencies necessary to build the
9237 given packages
9238 --dependencies-only
9240 --no-dependencies-only
9241 A synonym for --only-dependencies
9242 --index-state STATE
9244 Use source package index state as it existed at a previ‐
9245 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
9246 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
9247 'HEAD' (default: 'HEAD').
9248 --root-cmd COMMAND
9250 (No longer supported, do not use.)
9251 --symlink-bindir DIR
9253 Add symlinks to installed executables into this direc‐
9254 tory.
9255 --build-summary TEMPLATE
9257 Save build summaries to file (name template can use
9258 $pkgid, $compiler, $os, $arch)
9259 --build-log TEMPLATE
9261 Log all builds to file (name template can use $pkgid,
9262 $compiler, $os, $arch)
9263 --remote-build-reporting LEVEL
9265 Generate build reports to send to a remote server (none,
9266 anonymous or detailed).
9267 --report-planning-failure
9269 Generate build reports when the dependency solver fails.
9270 This is used by the Hackage build bot.
9271 --enable-per-component
9273 --disable-per-component
9274 Per-component builds when possible
9275 --one-shot
9277 --no-one-shot
9278 Do not record the packages in the world file.
9279 --run-tests
9281 Run package test suites during installation.
9282 -j, --jobs [NUM]
9284 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
9285 given).
9286 --keep-going
9288 After a build failure, continue to build other unaffected
9289 packages.
9290 --offline
9292 --no-offline
9293 Don't download packages from the Internet.
9294 --project-file FILE
9296 Set the name of the cabal.project file to search for in
9297 parent directories
9298 --only
9300 Only installs the package in the current directory.
9301 --haddock-hoogle
9303 Generate a hoogle database
9304 --haddock-html
9306 Generate HTML documentation (the default)
9307 --haddock-html-location URL
9309 Location of HTML documentation for pre-requisite packages
9310 --haddock-for-hackage
9312 Collection of flags to generate documentation suitable
9313 for upload to hackage
9314 --haddock-executables
9316 Run haddock for Executables targets
9317 --haddock-tests
9319 Run haddock for Test Suite targets
9320 --haddock-benchmarks
9322 Run haddock for Benchmark targets
9323 --haddock-all
9325 Run haddock for all targets
9326 --haddock-internal
9328 Run haddock for internal modules and include all symbols
9329 --haddock-css PATH
9331 Use PATH as the haddock stylesheet
9332 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
9334 dock-hyperlinked-source
9335 Hyperlink the documentation to the source code
9336 --haddock-quickjump
9338 Generate an index for interactive documentation naviga‐
9339 tion
9340 --haddock-hscolour-css PATH
9342 Use PATH as the HsColour stylesheet
9343 --haddock-contents-location URL
9345 Bake URL in as the location for the contents page
9346 --test-log TEMPLATE
9348 Log all test suite results to file (name template can use
9349 $pkgid, $compiler, $os, $arch, $test-suite, $result)
9350 --test-machine-log TEMPLATE
9352 Produce a machine-readable log file (name template can
9353 use $pkgid, $compiler, $os, $arch, $result)
9354 --test-show-details FILTER
9356 --test-keep-tix-files
9358 keep .tix files for HPC between test runs
9359 --test-wrapper FILE
9361 Run test through a wrapper.
9362 --test-fail-when-no-test-suites
9364 Exit with failure when no test suites are found.
9365 --test-options TEMPLATES
9367 give extra options to test executables (name templates
9368 can use $pkgid, $compiler, $os, $arch, $test-suite)
9369 --test-option TEMPLATE
9371 give extra option to test executables (no need to quote
9372 options containing spaces, name template can use $pkgid,
9373 $compiler, $os, $arch, $test-suite)
9374 --benchmark-options TEMPLATES
9376 give extra options to benchmark executables (name tem‐
9377 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
9378 --benchmark-option TEMPLATE
9380 give extra option to benchmark executables (no need to
9381 quote options containing spaces, name template can use
9382 $pkgid, $compiler, $os, $arch, $benchmark)
9383 --repl-options FLAG
9385 use this option for the repl
9386 -b, --build-depends DEPENDENCY
9388 Include an additional package in the environment pre‐
9389 sented to GHCi.
9390 --no-transitive-deps
9392 Don't automatically include transitive dependencies of
9393 requested packages.
9394 -z, --ignore-project
9396 Only include explicitly specified packages (and 'base').
9397 cabal v2-repl
9400 Usage: cabal v2-repl [TARGET] [FLAGS]
9402 Open an interactive session for a component within the project. The
9405 available targets are the same as for the 'v2-build' command: individ‐
9406 ual components within packages in the project, including libraries, ex‐
9407 ecutables, test-suites or benchmarks. Packages can also be specified in
9408 which case the library component in the package will be used, or the
9409 (first listed) executable in the package if there is no library.
9410 Dependencies are built or rebuilt as necessary. Additional configura‐
9412 tion flags can be specified on the command line and these extend the
9413 project configuration from the 'cabal.project', 'cabal.project.local'
9414 and other files.
9415 Examples, open an interactive session:
9418 cabal v2-repl
9419 for the default component in the package in the current directory
9420 cabal v2-repl pkgname
9421 for the default component in the package named 'pkgname'
9422 cabal v2-repl ./pkgfoo
9423 for the default component in the package in the ./pkgfoo directory
9424 cabal v2-repl cname
9425 for the component named 'cname'
9426 cabal v2-repl pkgname:cname
9427 for the component 'cname' in the package 'pkgname'
9428 cabal v2-repl --build-depends lens
9430 add the latest version of the library 'lens' to the default compo‐
9431 nent (or no componentif there is no project present)
9432 cabal v2-repl --build-depends "lens >= 4.15 && < 4.18"
9433 add a version (constrained between 4.15 and 4.18) of the library
9434 'lens' to the default component (or no component if there is no project
9435 present) Note: this command is part of the new project-based system
9436 (aka nix-style local builds). These features are currently in beta.
9437 Please see http://cabal.readthedocs.io/en/latest/nix-local-build-over‐
9438 view.html for details and advice on what you can expect to work. If you
9439 encounter problems please file issues at https://github.com/haskell/ca‐
9440 bal/issues and if you have any time to get involved and help with test‐
9441 ing, fixing bugs etc then that is very much appreciated.
9442 Flags:
9445 -v, --verbose [n]
9446 Control verbosity (n is 0--3, default verbosity level is
9447 1)
9448 --builddir, --distdir, --distpref DIR
9450 The directory where Cabal puts generated build files (de‐
9451 fault dist)
9452 -g, --ghc
9454 compile with GHC
9455 --ghcjs
9457 compile with GHCJS
9458 --uhc
9460 compile with UHC
9461 --haskell-suite
9463 compile with a haskell-suite compiler
9464 --cabal-file PATH
9466 use this Cabal file
9467 -w, --with-compiler PATH
9469 give the path to a particular compiler
9470 --with-hc-pkg PATH
9472 give the path to the package tool
9473 --prefix DIR
9475 bake this prefix in preparation of installation
9476 --bindir DIR
9478 installation directory for executables
9479 --libdir DIR
9481 installation directory for libraries
9482 --libsubdir DIR
9484 subdirectory of libdir in which libs are installed
9485 --dynlibdir DIR
9487 installation directory for dynamic libraries
9488 --libexecdir DIR
9490 installation directory for program executables
9491 --libexecsubdir DIR
9493 subdirectory of libexecdir in which private executables
9494 are installed
9495 --datadir DIR
9497 installation directory for read-only data
9498 --datasubdir DIR
9500 subdirectory of datadir in which data files are installed
9501 --docdir DIR
9503 installation directory for documentation
9504 --htmldir DIR
9506 installation directory for HTML documentation
9507 --haddockdir DIR
9509 installation directory for haddock interfaces
9510 --sysconfdir DIR
9512 installation directory for configuration files
9513 --program-prefix PREFIX
9515 prefix to be applied to installed executables
9516 --program-suffix SUFFIX
9518 suffix to be applied to installed executables
9519 --enable-library-vanilla
9521 --disable-library-vanilla
9522 Vanilla libraries
9523 -p, --enable-library-profiling
9525 --disable-library-profiling
9526 Library profiling
9527 --enable-shared
9529 --disable-shared
9530 Shared library
9531 --enable-static
9533 --disable-static
9534 Static library
9535 --enable-executable-dynamic
9537 --disable-executable-dynamic
9538 Executable dynamic linking
9539 --enable-executable-static
9541 --disable-executable-static
9542 Executable fully static linking
9543 --enable-profiling
9545 --disable-profiling
9546 Executable and library profiling
9547 --enable-executable-profiling
9549 --disable-executable-profiling
9550 Executable profiling (DEPRECATED)
9551 --profiling-detail level
9553 Profiling detail level for executable and library (de‐
9554 fault, none, exported-functions, toplevel-functions,
9555 all-functions).
9556 --library-profiling-detail level
9558 Profiling detail level for libraries only.
9559 -O, --enable-optimization, --enable-optimisation [n]
9561 Build with optimization (n is 0--2, default is 1)
9562 --disable-optimization, --disable-optimisation
9564 Build without optimization
9565 --enable-debug-info [n]
9567 Emit debug info (n is 0--3, default is 0)
9568 --disable-debug-info
9570 Don't emit debug info
9571 --enable-library-for-ghci
9573 --disable-library-for-ghci
9574 compile library for use with GHCi
9575 --enable-split-sections
9577 --disable-split-sections
9578 compile library code such that unneeded definitions can
9579 be dropped from the final executable (GHC 7.8+)
9580 --enable-split-objs
9582 --disable-split-objs
9583 split library into smaller objects to reduce binary sizes
9584 (GHC 6.6+)
9585 --enable-executable-stripping
9587 --disable-executable-stripping
9588 strip executables upon installation to reduce binary
9589 sizes
9590 --enable-library-stripping
9592 --disable-library-stripping
9593 strip libraries upon installation to reduce binary sizes
9594 --configure-option OPT
9596 Extra option for configure
9597 --user
9599 --global
9600 doing a per-user installation
9601 --package-db DB
9603 Append the given package database to the list of package
9604 databases used (to satisfy dependencies and register
9605 into). May be a specific file, 'global' or 'user'. The
9606 initial list is ['global'], ['global', 'user'], or
9607 ['global', $sandbox], depending on context. Use 'clear'
9608 to reset the list to empty. See the user guide for de‐
9609 tails.
9610 -f, --flags FLAGS
9612 Force values for the given flags in Cabal conditionals in
9613 the .cabal file. E.g., --flags="debug -usebytestrings"
9614 forces the flag "debug" to true and "usebytestrings" to
9615 false.
9616 --extra-include-dirs PATH
9618 A list of directories to search for header files
9619 --enable-deterministic
9621 --disable-deterministic
9622 Try to be as deterministic as possible (used by the test
9623 suite)
9624 --ipid IPID
9626 Installed package ID to compile this package as
9627 --cid CID
9629 Installed component ID to compile this component as
9630 --extra-lib-dirs PATH
9632 A list of directories to search for external libraries
9633 --extra-framework-dirs PATH
9635 A list of directories to search for external frameworks
9636 (OS X only)
9637 --extra-prog-path PATH
9639 A list of directories to search for required programs (in
9640 addition to the normal search locations)
9641 --instantiate-with NAME=MOD
9643 A mapping of signature names to concrete module instanti‐
9644 ations.
9645 --enable-tests
9647 --disable-tests
9648 dependency checking and compilation for test suites
9649 listed in the package description file.
9650 --enable-coverage
9652 --disable-coverage
9653 build package with Haskell Program Coverage. (GHC only)
9654 --enable-library-coverage
9656 --disable-library-coverage
9657 build package with Haskell Program Coverage. (GHC only)
9658 (DEPRECATED)
9659 --enable-benchmarks
9661 --disable-benchmarks
9662 dependency checking and compilation for benchmarks listed
9663 in the package description file.
9664 --enable-relocatable
9666 --disable-relocatable
9667 building a package that is relocatable. (GHC only)
9668 --disable-response-files
9670 enable workaround for old versions of programs like "ar"
9671 that do not support @file arguments
9672 --allow-depending-on-private-libs
9674 Allow depending on private libraries. If set, the library
9675 visibility check MUST be done externally.
9676 --with-alex PATH
9678 give the path to alex
9679 --with-ar PATH
9681 give the path to ar
9682 --with-c2hs PATH
9684 give the path to c2hs
9685 --with-cpphs PATH
9687 give the path to cpphs
9688 --with-doctest PATH
9690 give the path to doctest
9691 --with-gcc PATH
9693 give the path to gcc
9694 --with-ghc PATH
9696 give the path to ghc
9697 --with-ghc-pkg PATH
9699 give the path to ghc-pkg
9700 --with-ghcjs PATH
9702 give the path to ghcjs
9703 --with-ghcjs-pkg PATH
9705 give the path to ghcjs-pkg
9706 --with-greencard PATH
9708 give the path to greencard
9709 --with-haddock PATH
9711 give the path to haddock
9712 --with-happy PATH
9714 give the path to happy
9715 --with-haskell-suite PATH
9717 give the path to haskell-suite
9718 --with-haskell-suite-pkg PATH
9720 give the path to haskell-suite-pkg
9721 --with-hmake PATH
9723 give the path to hmake
9724 --with-hpc PATH
9726 give the path to hpc
9727 --with-hsc2hs PATH
9729 give the path to hsc2hs
9730 --with-hscolour PATH
9732 give the path to hscolour
9733 --with-jhc PATH
9735 give the path to jhc
9736 --with-ld PATH
9738 give the path to ld
9739 --with-pkg-config PATH
9741 give the path to pkg-config
9742 --with-runghc PATH
9744 give the path to runghc
9745 --with-strip PATH
9747 give the path to strip
9748 --with-tar PATH
9750 give the path to tar
9751 --with-uhc PATH
9753 give the path to uhc
9754 --alex-option OPT
9756 give an extra option to alex (no need to quote options
9757 containing spaces)
9758 --ar-option OPT
9760 give an extra option to ar (no need to quote options con‐
9761 taining spaces)
9762 --c2hs-option OPT
9764 give an extra option to c2hs (no need to quote options
9765 containing spaces)
9766 --cpphs-option OPT
9768 give an extra option to cpphs (no need to quote options
9769 containing spaces)
9770 --doctest-option OPT
9772 give an extra option to doctest (no need to quote options
9773 containing spaces)
9774 --gcc-option OPT
9776 give an extra option to gcc (no need to quote options
9777 containing spaces)
9778 --ghc-option OPT
9780 give an extra option to ghc (no need to quote options
9781 containing spaces)
9782 --ghc-pkg-option OPT
9784 give an extra option to ghc-pkg (no need to quote options
9785 containing spaces)
9786 --ghcjs-option OPT
9788 give an extra option to ghcjs (no need to quote options
9789 containing spaces)
9790 --ghcjs-pkg-option OPT
9792 give an extra option to ghcjs-pkg (no need to quote op‐
9793 tions containing spaces)
9794 --greencard-option OPT
9796 give an extra option to greencard (no need to quote op‐
9797 tions containing spaces)
9798 --haddock-option OPT
9800 give an extra option to haddock (no need to quote options
9801 containing spaces)
9802 --happy-option OPT
9804 give an extra option to happy (no need to quote options
9805 containing spaces)
9806 --haskell-suite-option OPT
9808 give an extra option to haskell-suite (no need to quote
9809 options containing spaces)
9810 --haskell-suite-pkg-option OPT
9812 give an extra option to haskell-suite-pkg (no need to
9813 quote options containing spaces)
9814 --hmake-option OPT
9816 give an extra option to hmake (no need to quote options
9817 containing spaces)
9818 --hpc-option OPT
9820 give an extra option to hpc (no need to quote options
9821 containing spaces)
9822 --hsc2hs-option OPT
9824 give an extra option to hsc2hs (no need to quote options
9825 containing spaces)
9826 --hscolour-option OPT
9828 give an extra option to hscolour (no need to quote op‐
9829 tions containing spaces)
9830 --jhc-option OPT
9832 give an extra option to jhc (no need to quote options
9833 containing spaces)
9834 --ld-option OPT
9836 give an extra option to ld (no need to quote options con‐
9837 taining spaces)
9838 --pkg-config-option OPT
9840 give an extra option to pkg-config (no need to quote op‐
9841 tions containing spaces)
9842 --runghc-option OPT
9844 give an extra option to runghc (no need to quote options
9845 containing spaces)
9846 --strip-option OPT
9848 give an extra option to strip (no need to quote options
9849 containing spaces)
9850 --tar-option OPT
9852 give an extra option to tar (no need to quote options
9853 containing spaces)
9854 --uhc-option OPT
9856 give an extra option to uhc (no need to quote options
9857 containing spaces)
9858 --alex-options OPTS
9860 give extra options to alex
9861 --ar-options OPTS
9863 give extra options to ar
9864 --c2hs-options OPTS
9866 give extra options to c2hs
9867 --cpphs-options OPTS
9869 give extra options to cpphs
9870 --doctest-options OPTS
9872 give extra options to doctest
9873 --gcc-options OPTS
9875 give extra options to gcc
9876 --ghc-options OPTS
9878 give extra options to ghc
9879 --ghc-pkg-options OPTS
9881 give extra options to ghc-pkg
9882 --ghcjs-options OPTS
9884 give extra options to ghcjs
9885 --ghcjs-pkg-options OPTS
9887 give extra options to ghcjs-pkg
9888 --greencard-options OPTS
9890 give extra options to greencard
9891 --haddock-options OPTS
9893 give extra options to haddock
9894 --happy-options OPTS
9896 give extra options to happy
9897 --haskell-suite-options OPTS
9899 give extra options to haskell-suite
9900 --haskell-suite-pkg-options OPTS
9902 give extra options to haskell-suite-pkg
9903 --hmake-options OPTS
9905 give extra options to hmake
9906 --hpc-options OPTS
9908 give extra options to hpc
9909 --hsc2hs-options OPTS
9911 give extra options to hsc2hs
9912 --hscolour-options OPTS
9914 give extra options to hscolour
9915 --jhc-options OPTS
9917 give extra options to jhc
9918 --ld-options OPTS
9920 give extra options to ld
9921 --pkg-config-options OPTS
9923 give extra options to pkg-config
9924 --runghc-options OPTS
9926 give extra options to runghc
9927 --strip-options OPTS
9929 give extra options to strip
9930 --tar-options OPTS
9932 give extra options to tar
9933 --uhc-options OPTS
9935 give extra options to uhc
9936 --cabal-lib-version VERSION
9938 Select which version of the Cabal lib to use to build
9939 packages (useful for testing).
9940 --constraint CONSTRAINT
9942 Specify constraints on a package (version, in‐
9943 stalled/source, flags)
9944 --preference CONSTRAINT
9946 Specify preferences (soft constraints) on the version of
9947 a package
9948 --solver SOLVER
9950 Select dependency solver to use (default: modular).
9951 Choices: modular.
9952 --allow-older [DEPS]
9954 Ignore lower bounds in all dependencies or DEPS
9955 --allow-newer [DEPS]
9957 Ignore upper bounds in all dependencies or DEPS
9958 --write-ghc-environment-files always|never|ghc8.4.4+
9960 Whether to create a .ghc.environment file after a suc‐
9961 cessful build (v2-build only)
9962 --enable-documentation
9964 --disable-documentation
9965 building of documentation
9966 --doc-index-file TEMPLATE
9968 A central index of haddock API documentation (template
9969 cannot use $pkgid)
9970 --dry-run
9972 Do not install anything, only print what would be in‐
9973 stalled.
9974 --max-backjumps NUM
9976 Maximum number of backjumps allowed while solving (de‐
9977 fault: 4000). Use a negative number to enable unlimited
9978 backtracking. Use 0 to disable backtracking completely.
9979 --reorder-goals
9981 --no-reorder-goals
9982 Try to reorder goals according to certain heuristics.
9983 Slows things down on average, but may make backtracking
9984 faster for some packages.
9985 --count-conflicts
9987 --no-count-conflicts
9988 Try to speed up solving by preferring goals that are in‐
9989 volved in a lot of conflicts (default).
9990 --fine-grained-conflicts
9992 --no-fine-grained-conflicts
9993 Skip a version of a package if it does not resolve the
9994 conflicts encountered in the last version, as a solver
9995 optimization (default).
9996 --minimize-conflict-set
9998 --no-minimize-conflict-set
9999 When there is no solution, try to improve the error mes‐
10000 sage by finding a minimal conflict set (default: false).
10001 May increase run time significantly.
10002 --independent-goals
10004 --no-independent-goals
10005 Treat several goals on the command line as independent.
10006 If several goals depend on the same package, different
10007 versions can be chosen.
10008 --shadow-installed-packages
10010 --no-shadow-installed-packages
10011 If multiple package instances of the same version are in‐
10012 stalled, treat all but one as shadowed.
10013 --strong-flags
10015 --no-strong-flags
10016 Do not defer flag choices (this used to be the default in
10017 cabal-install <= 1.20).
10018 --allow-boot-library-installs
10020 --no-allow-boot-library-installs
10021 Allow cabal to install base, ghc-prim, integer-simple,
10022 integer-gmp, and template-haskell.
10023 --reject-unconstrained-dependencies none|all
10025 Require these packages to have constraints on them if
10026 they are to be selected (default: none).
10027 --reinstall
10029 --no-reinstall
10030 Install even if it means installing the same version
10031 again.
10032 --avoid-reinstalls
10034 --no-avoid-reinstalls
10035 Do not select versions that would destructively overwrite
10036 installed packages.
10037 --force-reinstalls
10039 --no-force-reinstalls
10040 Reinstall packages even if they will most likely break
10041 other installed packages.
10042 --upgrade-dependencies
10044 --no-upgrade-dependencies
10045 Pick the latest version for all dependencies, rather than
10046 trying to pick an installed version.
10047 --only-dependencies
10049 --no-only-dependencies
10050 Install only the dependencies necessary to build the
10051 given packages
10052 --dependencies-only
10054 --no-dependencies-only
10055 A synonym for --only-dependencies
10056 --index-state STATE
10058 Use source package index state as it existed at a previ‐
10059 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
10060 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
10061 'HEAD' (default: 'HEAD').
10062 --root-cmd COMMAND
10064 (No longer supported, do not use.)
10065 --symlink-bindir DIR
10067 Add symlinks to installed executables into this direc‐
10068 tory.
10069 --build-summary TEMPLATE
10071 Save build summaries to file (name template can use
10072 $pkgid, $compiler, $os, $arch)
10073 --build-log TEMPLATE
10075 Log all builds to file (name template can use $pkgid,
10076 $compiler, $os, $arch)
10077 --remote-build-reporting LEVEL
10079 Generate build reports to send to a remote server (none,
10080 anonymous or detailed).
10081 --report-planning-failure
10083 Generate build reports when the dependency solver fails.
10084 This is used by the Hackage build bot.
10085 --enable-per-component
10087 --disable-per-component
10088 Per-component builds when possible
10089 --one-shot
10091 --no-one-shot
10092 Do not record the packages in the world file.
10093 --run-tests
10095 Run package test suites during installation.
10096 -j, --jobs [NUM]
10098 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
10099 given).
10100 --keep-going
10102 After a build failure, continue to build other unaffected
10103 packages.
10104 --offline
10106 --no-offline
10107 Don't download packages from the Internet.
10108 --project-file FILE
10110 Set the name of the cabal.project file to search for in
10111 parent directories
10112 --only
10114 Only installs the package in the current directory.
10115 --haddock-hoogle
10117 Generate a hoogle database
10118 --haddock-html
10120 Generate HTML documentation (the default)
10121 --haddock-html-location URL
10123 Location of HTML documentation for pre-requisite packages
10124 --haddock-for-hackage
10126 Collection of flags to generate documentation suitable
10127 for upload to hackage
10128 --haddock-executables
10130 Run haddock for Executables targets
10131 --haddock-tests
10133 Run haddock for Test Suite targets
10134 --haddock-benchmarks
10136 Run haddock for Benchmark targets
10137 --haddock-all
10139 Run haddock for all targets
10140 --haddock-internal
10142 Run haddock for internal modules and include all symbols
10143 --haddock-css PATH
10145 Use PATH as the haddock stylesheet
10146 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
10148 dock-hyperlinked-source
10149 Hyperlink the documentation to the source code
10150 --haddock-quickjump
10152 Generate an index for interactive documentation naviga‐
10153 tion
10154 --haddock-hscolour-css PATH
10156 Use PATH as the HsColour stylesheet
10157 --haddock-contents-location URL
10159 Bake URL in as the location for the contents page
10160 --test-log TEMPLATE
10162 Log all test suite results to file (name template can use
10163 $pkgid, $compiler, $os, $arch, $test-suite, $result)
10164 --test-machine-log TEMPLATE
10166 Produce a machine-readable log file (name template can
10167 use $pkgid, $compiler, $os, $arch, $result)
10168 --test-show-details FILTER
10170 --test-keep-tix-files
10172 keep .tix files for HPC between test runs
10173 --test-wrapper FILE
10175 Run test through a wrapper.
10176 --test-fail-when-no-test-suites
10178 Exit with failure when no test suites are found.
10179 --test-options TEMPLATES
10181 give extra options to test executables (name templates
10182 can use $pkgid, $compiler, $os, $arch, $test-suite)
10183 --test-option TEMPLATE
10185 give extra option to test executables (no need to quote
10186 options containing spaces, name template can use $pkgid,
10187 $compiler, $os, $arch, $test-suite)
10188 --benchmark-options TEMPLATES
10190 give extra options to benchmark executables (name tem‐
10191 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
10192 --benchmark-option TEMPLATE
10194 give extra option to benchmark executables (no need to
10195 quote options containing spaces, name template can use
10196 $pkgid, $compiler, $os, $arch, $benchmark)
10197 --repl-options FLAG
10199 use this option for the repl
10200 -b, --build-depends DEPENDENCY
10202 Include an additional package in the environment pre‐
10203 sented to GHCi.
10204 --no-transitive-deps
10206 Don't automatically include transitive dependencies of
10207 requested packages.
10208 -z, --ignore-project
10210 Only include explicitly specified packages (and 'base').
10211 cabal freeze
10214 Usage: cabal freeze [FLAGS]
10216 The project configuration is frozen so that it will be reproducible in
10219 future.
10220 The precise dependency configuration for the project is written to the
10222 specified). This file extends the configuration from the 'ca‐
10223 bal.project' file and thus is used as the project configuration for all
10224 other commands (such as
10225 The freeze file can be kept in source control. To make small adjust‐
10227 ments it may be edited manually, or to make bigger changes you may wish
10228 to delete the file and re-freeze. For more control, one approach is to
10229 try variations using once you have a satisfactory solution to freeze it
10230 using the 'freeze' command with the same set of flags.
10231 The project configuration is frozen so that it will be reproducible in
10234 future.
10235 The precise dependency configuration for the project is written to the
10237 specified). This file extends the configuration from the 'ca‐
10238 bal.project' file and thus is used as the project configuration for all
10239 other commands (such as
10240 The freeze file can be kept in source control. To make small adjust‐
10242 ments it may be edited manually, or to make bigger changes you may wish
10243 to delete the file and re-freeze. For more control, one approach is to
10244 try variations using once you have a satisfactory solution to freeze it
10245 using the 'freeze' command with the same set of flags.
10246 Flags:
10249 -v, --verbose [n]
10250 Control verbosity (n is 0--3, default verbosity level is
10251 1)
10252 --builddir, --distdir, --distpref DIR
10254 The directory where Cabal puts generated build files (de‐
10255 fault dist)
10256 -g, --ghc
10258 compile with GHC
10259 --ghcjs
10261 compile with GHCJS
10262 --uhc
10264 compile with UHC
10265 --haskell-suite
10267 compile with a haskell-suite compiler
10268 --cabal-file PATH
10270 use this Cabal file
10271 -w, --with-compiler PATH
10273 give the path to a particular compiler
10274 --with-hc-pkg PATH
10276 give the path to the package tool
10277 --prefix DIR
10279 bake this prefix in preparation of installation
10280 --bindir DIR
10282 installation directory for executables
10283 --libdir DIR
10285 installation directory for libraries
10286 --libsubdir DIR
10288 subdirectory of libdir in which libs are installed
10289 --dynlibdir DIR
10291 installation directory for dynamic libraries
10292 --libexecdir DIR
10294 installation directory for program executables
10295 --libexecsubdir DIR
10297 subdirectory of libexecdir in which private executables
10298 are installed
10299 --datadir DIR
10301 installation directory for read-only data
10302 --datasubdir DIR
10304 subdirectory of datadir in which data files are installed
10305 --docdir DIR
10307 installation directory for documentation
10308 --htmldir DIR
10310 installation directory for HTML documentation
10311 --haddockdir DIR
10313 installation directory for haddock interfaces
10314 --sysconfdir DIR
10316 installation directory for configuration files
10317 --program-prefix PREFIX
10319 prefix to be applied to installed executables
10320 --program-suffix SUFFIX
10322 suffix to be applied to installed executables
10323 --enable-library-vanilla
10325 --disable-library-vanilla
10326 Vanilla libraries
10327 -p, --enable-library-profiling
10329 --disable-library-profiling
10330 Library profiling
10331 --enable-shared
10333 --disable-shared
10334 Shared library
10335 --enable-static
10337 --disable-static
10338 Static library
10339 --enable-executable-dynamic
10341 --disable-executable-dynamic
10342 Executable dynamic linking
10343 --enable-executable-static
10345 --disable-executable-static
10346 Executable fully static linking
10347 --enable-profiling
10349 --disable-profiling
10350 Executable and library profiling
10351 --enable-executable-profiling
10353 --disable-executable-profiling
10354 Executable profiling (DEPRECATED)
10355 --profiling-detail level
10357 Profiling detail level for executable and library (de‐
10358 fault, none, exported-functions, toplevel-functions,
10359 all-functions).
10360 --library-profiling-detail level
10362 Profiling detail level for libraries only.
10363 -O, --enable-optimization, --enable-optimisation [n]
10365 Build with optimization (n is 0--2, default is 1)
10366 --disable-optimization, --disable-optimisation
10368 Build without optimization
10369 --enable-debug-info [n]
10371 Emit debug info (n is 0--3, default is 0)
10372 --disable-debug-info
10374 Don't emit debug info
10375 --enable-library-for-ghci
10377 --disable-library-for-ghci
10378 compile library for use with GHCi
10379 --enable-split-sections
10381 --disable-split-sections
10382 compile library code such that unneeded definitions can
10383 be dropped from the final executable (GHC 7.8+)
10384 --enable-split-objs
10386 --disable-split-objs
10387 split library into smaller objects to reduce binary sizes
10388 (GHC 6.6+)
10389 --enable-executable-stripping
10391 --disable-executable-stripping
10392 strip executables upon installation to reduce binary
10393 sizes
10394 --enable-library-stripping
10396 --disable-library-stripping
10397 strip libraries upon installation to reduce binary sizes
10398 --configure-option OPT
10400 Extra option for configure
10401 --user
10403 --global
10404 doing a per-user installation
10405 --package-db DB
10407 Append the given package database to the list of package
10408 databases used (to satisfy dependencies and register
10409 into). May be a specific file, 'global' or 'user'. The
10410 initial list is ['global'], ['global', 'user'], or
10411 ['global', $sandbox], depending on context. Use 'clear'
10412 to reset the list to empty. See the user guide for de‐
10413 tails.
10414 -f, --flags FLAGS
10416 Force values for the given flags in Cabal conditionals in
10417 the .cabal file. E.g., --flags="debug -usebytestrings"
10418 forces the flag "debug" to true and "usebytestrings" to
10419 false.
10420 --extra-include-dirs PATH
10422 A list of directories to search for header files
10423 --enable-deterministic
10425 --disable-deterministic
10426 Try to be as deterministic as possible (used by the test
10427 suite)
10428 --ipid IPID
10430 Installed package ID to compile this package as
10431 --cid CID
10433 Installed component ID to compile this component as
10434 --extra-lib-dirs PATH
10436 A list of directories to search for external libraries
10437 --extra-framework-dirs PATH
10439 A list of directories to search for external frameworks
10440 (OS X only)
10441 --extra-prog-path PATH
10443 A list of directories to search for required programs (in
10444 addition to the normal search locations)
10445 --instantiate-with NAME=MOD
10447 A mapping of signature names to concrete module instanti‐
10448 ations.
10449 --enable-tests
10451 --disable-tests
10452 dependency checking and compilation for test suites
10453 listed in the package description file.
10454 --enable-coverage
10456 --disable-coverage
10457 build package with Haskell Program Coverage. (GHC only)
10458 --enable-library-coverage
10460 --disable-library-coverage
10461 build package with Haskell Program Coverage. (GHC only)
10462 (DEPRECATED)
10463 --enable-benchmarks
10465 --disable-benchmarks
10466 dependency checking and compilation for benchmarks listed
10467 in the package description file.
10468 --enable-relocatable
10470 --disable-relocatable
10471 building a package that is relocatable. (GHC only)
10472 --disable-response-files
10474 enable workaround for old versions of programs like "ar"
10475 that do not support @file arguments
10476 --allow-depending-on-private-libs
10478 Allow depending on private libraries. If set, the library
10479 visibility check MUST be done externally.
10480 --with-alex PATH
10482 give the path to alex
10483 --with-ar PATH
10485 give the path to ar
10486 --with-c2hs PATH
10488 give the path to c2hs
10489 --with-cpphs PATH
10491 give the path to cpphs
10492 --with-doctest PATH
10494 give the path to doctest
10495 --with-gcc PATH
10497 give the path to gcc
10498 --with-ghc PATH
10500 give the path to ghc
10501 --with-ghc-pkg PATH
10503 give the path to ghc-pkg
10504 --with-ghcjs PATH
10506 give the path to ghcjs
10507 --with-ghcjs-pkg PATH
10509 give the path to ghcjs-pkg
10510 --with-greencard PATH
10512 give the path to greencard
10513 --with-haddock PATH
10515 give the path to haddock
10516 --with-happy PATH
10518 give the path to happy
10519 --with-haskell-suite PATH
10521 give the path to haskell-suite
10522 --with-haskell-suite-pkg PATH
10524 give the path to haskell-suite-pkg
10525 --with-hmake PATH
10527 give the path to hmake
10528 --with-hpc PATH
10530 give the path to hpc
10531 --with-hsc2hs PATH
10533 give the path to hsc2hs
10534 --with-hscolour PATH
10536 give the path to hscolour
10537 --with-jhc PATH
10539 give the path to jhc
10540 --with-ld PATH
10542 give the path to ld
10543 --with-pkg-config PATH
10545 give the path to pkg-config
10546 --with-runghc PATH
10548 give the path to runghc
10549 --with-strip PATH
10551 give the path to strip
10552 --with-tar PATH
10554 give the path to tar
10555 --with-uhc PATH
10557 give the path to uhc
10558 --alex-option OPT
10560 give an extra option to alex (no need to quote options
10561 containing spaces)
10562 --ar-option OPT
10564 give an extra option to ar (no need to quote options con‐
10565 taining spaces)
10566 --c2hs-option OPT
10568 give an extra option to c2hs (no need to quote options
10569 containing spaces)
10570 --cpphs-option OPT
10572 give an extra option to cpphs (no need to quote options
10573 containing spaces)
10574 --doctest-option OPT
10576 give an extra option to doctest (no need to quote options
10577 containing spaces)
10578 --gcc-option OPT
10580 give an extra option to gcc (no need to quote options
10581 containing spaces)
10582 --ghc-option OPT
10584 give an extra option to ghc (no need to quote options
10585 containing spaces)
10586 --ghc-pkg-option OPT
10588 give an extra option to ghc-pkg (no need to quote options
10589 containing spaces)
10590 --ghcjs-option OPT
10592 give an extra option to ghcjs (no need to quote options
10593 containing spaces)
10594 --ghcjs-pkg-option OPT
10596 give an extra option to ghcjs-pkg (no need to quote op‐
10597 tions containing spaces)
10598 --greencard-option OPT
10600 give an extra option to greencard (no need to quote op‐
10601 tions containing spaces)
10602 --haddock-option OPT
10604 give an extra option to haddock (no need to quote options
10605 containing spaces)
10606 --happy-option OPT
10608 give an extra option to happy (no need to quote options
10609 containing spaces)
10610 --haskell-suite-option OPT
10612 give an extra option to haskell-suite (no need to quote
10613 options containing spaces)
10614 --haskell-suite-pkg-option OPT
10616 give an extra option to haskell-suite-pkg (no need to
10617 quote options containing spaces)
10618 --hmake-option OPT
10620 give an extra option to hmake (no need to quote options
10621 containing spaces)
10622 --hpc-option OPT
10624 give an extra option to hpc (no need to quote options
10625 containing spaces)
10626 --hsc2hs-option OPT
10628 give an extra option to hsc2hs (no need to quote options
10629 containing spaces)
10630 --hscolour-option OPT
10632 give an extra option to hscolour (no need to quote op‐
10633 tions containing spaces)
10634 --jhc-option OPT
10636 give an extra option to jhc (no need to quote options
10637 containing spaces)
10638 --ld-option OPT
10640 give an extra option to ld (no need to quote options con‐
10641 taining spaces)
10642 --pkg-config-option OPT
10644 give an extra option to pkg-config (no need to quote op‐
10645 tions containing spaces)
10646 --runghc-option OPT
10648 give an extra option to runghc (no need to quote options
10649 containing spaces)
10650 --strip-option OPT
10652 give an extra option to strip (no need to quote options
10653 containing spaces)
10654 --tar-option OPT
10656 give an extra option to tar (no need to quote options
10657 containing spaces)
10658 --uhc-option OPT
10660 give an extra option to uhc (no need to quote options
10661 containing spaces)
10662 --alex-options OPTS
10664 give extra options to alex
10665 --ar-options OPTS
10667 give extra options to ar
10668 --c2hs-options OPTS
10670 give extra options to c2hs
10671 --cpphs-options OPTS
10673 give extra options to cpphs
10674 --doctest-options OPTS
10676 give extra options to doctest
10677 --gcc-options OPTS
10679 give extra options to gcc
10680 --ghc-options OPTS
10682 give extra options to ghc
10683 --ghc-pkg-options OPTS
10685 give extra options to ghc-pkg
10686 --ghcjs-options OPTS
10688 give extra options to ghcjs
10689 --ghcjs-pkg-options OPTS
10691 give extra options to ghcjs-pkg
10692 --greencard-options OPTS
10694 give extra options to greencard
10695 --haddock-options OPTS
10697 give extra options to haddock
10698 --happy-options OPTS
10700 give extra options to happy
10701 --haskell-suite-options OPTS
10703 give extra options to haskell-suite
10704 --haskell-suite-pkg-options OPTS
10706 give extra options to haskell-suite-pkg
10707 --hmake-options OPTS
10709 give extra options to hmake
10710 --hpc-options OPTS
10712 give extra options to hpc
10713 --hsc2hs-options OPTS
10715 give extra options to hsc2hs
10716 --hscolour-options OPTS
10718 give extra options to hscolour
10719 --jhc-options OPTS
10721 give extra options to jhc
10722 --ld-options OPTS
10724 give extra options to ld
10725 --pkg-config-options OPTS
10727 give extra options to pkg-config
10728 --runghc-options OPTS
10730 give extra options to runghc
10731 --strip-options OPTS
10733 give extra options to strip
10734 --tar-options OPTS
10736 give extra options to tar
10737 --uhc-options OPTS
10739 give extra options to uhc
10740 --cabal-lib-version VERSION
10742 Select which version of the Cabal lib to use to build
10743 packages (useful for testing).
10744 --constraint CONSTRAINT
10746 Specify constraints on a package (version, in‐
10747 stalled/source, flags)
10748 --preference CONSTRAINT
10750 Specify preferences (soft constraints) on the version of
10751 a package
10752 --solver SOLVER
10754 Select dependency solver to use (default: modular).
10755 Choices: modular.
10756 --allow-older [DEPS]
10758 Ignore lower bounds in all dependencies or DEPS
10759 --allow-newer [DEPS]
10761 Ignore upper bounds in all dependencies or DEPS
10762 --write-ghc-environment-files always|never|ghc8.4.4+
10764 Whether to create a .ghc.environment file after a suc‐
10765 cessful build (v2-build only)
10766 --enable-documentation
10768 --disable-documentation
10769 building of documentation
10770 --doc-index-file TEMPLATE
10772 A central index of haddock API documentation (template
10773 cannot use $pkgid)
10774 --dry-run
10776 Do not install anything, only print what would be in‐
10777 stalled.
10778 --max-backjumps NUM
10780 Maximum number of backjumps allowed while solving (de‐
10781 fault: 4000). Use a negative number to enable unlimited
10782 backtracking. Use 0 to disable backtracking completely.
10783 --reorder-goals
10785 --no-reorder-goals
10786 Try to reorder goals according to certain heuristics.
10787 Slows things down on average, but may make backtracking
10788 faster for some packages.
10789 --count-conflicts
10791 --no-count-conflicts
10792 Try to speed up solving by preferring goals that are in‐
10793 volved in a lot of conflicts (default).
10794 --fine-grained-conflicts
10796 --no-fine-grained-conflicts
10797 Skip a version of a package if it does not resolve the
10798 conflicts encountered in the last version, as a solver
10799 optimization (default).
10800 --minimize-conflict-set
10802 --no-minimize-conflict-set
10803 When there is no solution, try to improve the error mes‐
10804 sage by finding a minimal conflict set (default: false).
10805 May increase run time significantly.
10806 --independent-goals
10808 --no-independent-goals
10809 Treat several goals on the command line as independent.
10810 If several goals depend on the same package, different
10811 versions can be chosen.
10812 --shadow-installed-packages
10814 --no-shadow-installed-packages
10815 If multiple package instances of the same version are in‐
10816 stalled, treat all but one as shadowed.
10817 --strong-flags
10819 --no-strong-flags
10820 Do not defer flag choices (this used to be the default in
10821 cabal-install <= 1.20).
10822 --allow-boot-library-installs
10824 --no-allow-boot-library-installs
10825 Allow cabal to install base, ghc-prim, integer-simple,
10826 integer-gmp, and template-haskell.
10827 --reject-unconstrained-dependencies none|all
10829 Require these packages to have constraints on them if
10830 they are to be selected (default: none).
10831 --reinstall
10833 --no-reinstall
10834 Install even if it means installing the same version
10835 again.
10836 --avoid-reinstalls
10838 --no-avoid-reinstalls
10839 Do not select versions that would destructively overwrite
10840 installed packages.
10841 --force-reinstalls
10843 --no-force-reinstalls
10844 Reinstall packages even if they will most likely break
10845 other installed packages.
10846 --upgrade-dependencies
10848 --no-upgrade-dependencies
10849 Pick the latest version for all dependencies, rather than
10850 trying to pick an installed version.
10851 --only-dependencies
10853 --no-only-dependencies
10854 Install only the dependencies necessary to build the
10855 given packages
10856 --dependencies-only
10858 --no-dependencies-only
10859 A synonym for --only-dependencies
10860 --index-state STATE
10862 Use source package index state as it existed at a previ‐
10863 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
10864 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
10865 'HEAD' (default: 'HEAD').
10866 --root-cmd COMMAND
10868 (No longer supported, do not use.)
10869 --symlink-bindir DIR
10871 Add symlinks to installed executables into this direc‐
10872 tory.
10873 --build-summary TEMPLATE
10875 Save build summaries to file (name template can use
10876 $pkgid, $compiler, $os, $arch)
10877 --build-log TEMPLATE
10879 Log all builds to file (name template can use $pkgid,
10880 $compiler, $os, $arch)
10881 --remote-build-reporting LEVEL
10883 Generate build reports to send to a remote server (none,
10884 anonymous or detailed).
10885 --report-planning-failure
10887 Generate build reports when the dependency solver fails.
10888 This is used by the Hackage build bot.
10889 --enable-per-component
10891 --disable-per-component
10892 Per-component builds when possible
10893 --one-shot
10895 --no-one-shot
10896 Do not record the packages in the world file.
10897 --run-tests
10899 Run package test suites during installation.
10900 -j, --jobs [NUM]
10902 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
10903 given).
10904 --keep-going
10906 After a build failure, continue to build other unaffected
10907 packages.
10908 --offline
10910 --no-offline
10911 Don't download packages from the Internet.
10912 --project-file FILE
10914 Set the name of the cabal.project file to search for in
10915 parent directories
10916 --only
10918 Only installs the package in the current directory.
10919 --haddock-hoogle
10921 Generate a hoogle database
10922 --haddock-html
10924 Generate HTML documentation (the default)
10925 --haddock-html-location URL
10927 Location of HTML documentation for pre-requisite packages
10928 --haddock-for-hackage
10930 Collection of flags to generate documentation suitable
10931 for upload to hackage
10932 --haddock-executables
10934 Run haddock for Executables targets
10935 --haddock-tests
10937 Run haddock for Test Suite targets
10938 --haddock-benchmarks
10940 Run haddock for Benchmark targets
10941 --haddock-all
10943 Run haddock for all targets
10944 --haddock-internal
10946 Run haddock for internal modules and include all symbols
10947 --haddock-css PATH
10949 Use PATH as the haddock stylesheet
10950 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
10952 dock-hyperlinked-source
10953 Hyperlink the documentation to the source code
10954 --haddock-quickjump
10956 Generate an index for interactive documentation naviga‐
10957 tion
10958 --haddock-hscolour-css PATH
10960 Use PATH as the HsColour stylesheet
10961 --haddock-contents-location URL
10963 Bake URL in as the location for the contents page
10964 --test-log TEMPLATE
10966 Log all test suite results to file (name template can use
10967 $pkgid, $compiler, $os, $arch, $test-suite, $result)
10968 --test-machine-log TEMPLATE
10970 Produce a machine-readable log file (name template can
10971 use $pkgid, $compiler, $os, $arch, $result)
10972 --test-show-details FILTER
10974 --test-keep-tix-files
10976 keep .tix files for HPC between test runs
10977 --test-wrapper FILE
10979 Run test through a wrapper.
10980 --test-fail-when-no-test-suites
10982 Exit with failure when no test suites are found.
10983 --test-options TEMPLATES
10985 give extra options to test executables (name templates
10986 can use $pkgid, $compiler, $os, $arch, $test-suite)
10987 --test-option TEMPLATE
10989 give extra option to test executables (no need to quote
10990 options containing spaces, name template can use $pkgid,
10991 $compiler, $os, $arch, $test-suite)
10992 --benchmark-options TEMPLATES
10994 give extra options to benchmark executables (name tem‐
10995 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
10996 --benchmark-option TEMPLATE
10998 give extra option to benchmark executables (no need to
10999 quote options containing spaces, name template can use
11000 $pkgid, $compiler, $os, $arch, $benchmark)
11001 cabal new-freeze
11004 Usage: cabal new-freeze [FLAGS]
11006 The project configuration is frozen so that it will be reproducible in
11009 future.
11010 The precise dependency configuration for the project is written to the
11012 specified). This file extends the configuration from the 'ca‐
11013 bal.project' file and thus is used as the project configuration for all
11014 other commands (such as
11015 The freeze file can be kept in source control. To make small adjust‐
11017 ments it may be edited manually, or to make bigger changes you may wish
11018 to delete the file and re-freeze. For more control, one approach is to
11019 try variations using once you have a satisfactory solution to freeze it
11020 using the 'new-freeze' command with the same set of flags.
11021 The project configuration is frozen so that it will be reproducible in
11024 future.
11025 The precise dependency configuration for the project is written to the
11027 specified). This file extends the configuration from the 'ca‐
11028 bal.project' file and thus is used as the project configuration for all
11029 other commands (such as
11030 The freeze file can be kept in source control. To make small adjust‐
11032 ments it may be edited manually, or to make bigger changes you may wish
11033 to delete the file and re-freeze. For more control, one approach is to
11034 try variations using once you have a satisfactory solution to freeze it
11035 using the 'new-freeze' command with the same set of flags.
11036 Flags:
11039 -v, --verbose [n]
11040 Control verbosity (n is 0--3, default verbosity level is
11041 1)
11042 --builddir, --distdir, --distpref DIR
11044 The directory where Cabal puts generated build files (de‐
11045 fault dist)
11046 -g, --ghc
11048 compile with GHC
11049 --ghcjs
11051 compile with GHCJS
11052 --uhc
11054 compile with UHC
11055 --haskell-suite
11057 compile with a haskell-suite compiler
11058 --cabal-file PATH
11060 use this Cabal file
11061 -w, --with-compiler PATH
11063 give the path to a particular compiler
11064 --with-hc-pkg PATH
11066 give the path to the package tool
11067 --prefix DIR
11069 bake this prefix in preparation of installation
11070 --bindir DIR
11072 installation directory for executables
11073 --libdir DIR
11075 installation directory for libraries
11076 --libsubdir DIR
11078 subdirectory of libdir in which libs are installed
11079 --dynlibdir DIR
11081 installation directory for dynamic libraries
11082 --libexecdir DIR
11084 installation directory for program executables
11085 --libexecsubdir DIR
11087 subdirectory of libexecdir in which private executables
11088 are installed
11089 --datadir DIR
11091 installation directory for read-only data
11092 --datasubdir DIR
11094 subdirectory of datadir in which data files are installed
11095 --docdir DIR
11097 installation directory for documentation
11098 --htmldir DIR
11100 installation directory for HTML documentation
11101 --haddockdir DIR
11103 installation directory for haddock interfaces
11104 --sysconfdir DIR
11106 installation directory for configuration files
11107 --program-prefix PREFIX
11109 prefix to be applied to installed executables
11110 --program-suffix SUFFIX
11112 suffix to be applied to installed executables
11113 --enable-library-vanilla
11115 --disable-library-vanilla
11116 Vanilla libraries
11117 -p, --enable-library-profiling
11119 --disable-library-profiling
11120 Library profiling
11121 --enable-shared
11123 --disable-shared
11124 Shared library
11125 --enable-static
11127 --disable-static
11128 Static library
11129 --enable-executable-dynamic
11131 --disable-executable-dynamic
11132 Executable dynamic linking
11133 --enable-executable-static
11135 --disable-executable-static
11136 Executable fully static linking
11137 --enable-profiling
11139 --disable-profiling
11140 Executable and library profiling
11141 --enable-executable-profiling
11143 --disable-executable-profiling
11144 Executable profiling (DEPRECATED)
11145 --profiling-detail level
11147 Profiling detail level for executable and library (de‐
11148 fault, none, exported-functions, toplevel-functions,
11149 all-functions).
11150 --library-profiling-detail level
11152 Profiling detail level for libraries only.
11153 -O, --enable-optimization, --enable-optimisation [n]
11155 Build with optimization (n is 0--2, default is 1)
11156 --disable-optimization, --disable-optimisation
11158 Build without optimization
11159 --enable-debug-info [n]
11161 Emit debug info (n is 0--3, default is 0)
11162 --disable-debug-info
11164 Don't emit debug info
11165 --enable-library-for-ghci
11167 --disable-library-for-ghci
11168 compile library for use with GHCi
11169 --enable-split-sections
11171 --disable-split-sections
11172 compile library code such that unneeded definitions can
11173 be dropped from the final executable (GHC 7.8+)
11174 --enable-split-objs
11176 --disable-split-objs
11177 split library into smaller objects to reduce binary sizes
11178 (GHC 6.6+)
11179 --enable-executable-stripping
11181 --disable-executable-stripping
11182 strip executables upon installation to reduce binary
11183 sizes
11184 --enable-library-stripping
11186 --disable-library-stripping
11187 strip libraries upon installation to reduce binary sizes
11188 --configure-option OPT
11190 Extra option for configure
11191 --user
11193 --global
11194 doing a per-user installation
11195 --package-db DB
11197 Append the given package database to the list of package
11198 databases used (to satisfy dependencies and register
11199 into). May be a specific file, 'global' or 'user'. The
11200 initial list is ['global'], ['global', 'user'], or
11201 ['global', $sandbox], depending on context. Use 'clear'
11202 to reset the list to empty. See the user guide for de‐
11203 tails.
11204 -f, --flags FLAGS
11206 Force values for the given flags in Cabal conditionals in
11207 the .cabal file. E.g., --flags="debug -usebytestrings"
11208 forces the flag "debug" to true and "usebytestrings" to
11209 false.
11210 --extra-include-dirs PATH
11212 A list of directories to search for header files
11213 --enable-deterministic
11215 --disable-deterministic
11216 Try to be as deterministic as possible (used by the test
11217 suite)
11218 --ipid IPID
11220 Installed package ID to compile this package as
11221 --cid CID
11223 Installed component ID to compile this component as
11224 --extra-lib-dirs PATH
11226 A list of directories to search for external libraries
11227 --extra-framework-dirs PATH
11229 A list of directories to search for external frameworks
11230 (OS X only)
11231 --extra-prog-path PATH
11233 A list of directories to search for required programs (in
11234 addition to the normal search locations)
11235 --instantiate-with NAME=MOD
11237 A mapping of signature names to concrete module instanti‐
11238 ations.
11239 --enable-tests
11241 --disable-tests
11242 dependency checking and compilation for test suites
11243 listed in the package description file.
11244 --enable-coverage
11246 --disable-coverage
11247 build package with Haskell Program Coverage. (GHC only)
11248 --enable-library-coverage
11250 --disable-library-coverage
11251 build package with Haskell Program Coverage. (GHC only)
11252 (DEPRECATED)
11253 --enable-benchmarks
11255 --disable-benchmarks
11256 dependency checking and compilation for benchmarks listed
11257 in the package description file.
11258 --enable-relocatable
11260 --disable-relocatable
11261 building a package that is relocatable. (GHC only)
11262 --disable-response-files
11264 enable workaround for old versions of programs like "ar"
11265 that do not support @file arguments
11266 --allow-depending-on-private-libs
11268 Allow depending on private libraries. If set, the library
11269 visibility check MUST be done externally.
11270 --with-alex PATH
11272 give the path to alex
11273 --with-ar PATH
11275 give the path to ar
11276 --with-c2hs PATH
11278 give the path to c2hs
11279 --with-cpphs PATH
11281 give the path to cpphs
11282 --with-doctest PATH
11284 give the path to doctest
11285 --with-gcc PATH
11287 give the path to gcc
11288 --with-ghc PATH
11290 give the path to ghc
11291 --with-ghc-pkg PATH
11293 give the path to ghc-pkg
11294 --with-ghcjs PATH
11296 give the path to ghcjs
11297 --with-ghcjs-pkg PATH
11299 give the path to ghcjs-pkg
11300 --with-greencard PATH
11302 give the path to greencard
11303 --with-haddock PATH
11305 give the path to haddock
11306 --with-happy PATH
11308 give the path to happy
11309 --with-haskell-suite PATH
11311 give the path to haskell-suite
11312 --with-haskell-suite-pkg PATH
11314 give the path to haskell-suite-pkg
11315 --with-hmake PATH
11317 give the path to hmake
11318 --with-hpc PATH
11320 give the path to hpc
11321 --with-hsc2hs PATH
11323 give the path to hsc2hs
11324 --with-hscolour PATH
11326 give the path to hscolour
11327 --with-jhc PATH
11329 give the path to jhc
11330 --with-ld PATH
11332 give the path to ld
11333 --with-pkg-config PATH
11335 give the path to pkg-config
11336 --with-runghc PATH
11338 give the path to runghc
11339 --with-strip PATH
11341 give the path to strip
11342 --with-tar PATH
11344 give the path to tar
11345 --with-uhc PATH
11347 give the path to uhc
11348 --alex-option OPT
11350 give an extra option to alex (no need to quote options
11351 containing spaces)
11352 --ar-option OPT
11354 give an extra option to ar (no need to quote options con‐
11355 taining spaces)
11356 --c2hs-option OPT
11358 give an extra option to c2hs (no need to quote options
11359 containing spaces)
11360 --cpphs-option OPT
11362 give an extra option to cpphs (no need to quote options
11363 containing spaces)
11364 --doctest-option OPT
11366 give an extra option to doctest (no need to quote options
11367 containing spaces)
11368 --gcc-option OPT
11370 give an extra option to gcc (no need to quote options
11371 containing spaces)
11372 --ghc-option OPT
11374 give an extra option to ghc (no need to quote options
11375 containing spaces)
11376 --ghc-pkg-option OPT
11378 give an extra option to ghc-pkg (no need to quote options
11379 containing spaces)
11380 --ghcjs-option OPT
11382 give an extra option to ghcjs (no need to quote options
11383 containing spaces)
11384 --ghcjs-pkg-option OPT
11386 give an extra option to ghcjs-pkg (no need to quote op‐
11387 tions containing spaces)
11388 --greencard-option OPT
11390 give an extra option to greencard (no need to quote op‐
11391 tions containing spaces)
11392 --haddock-option OPT
11394 give an extra option to haddock (no need to quote options
11395 containing spaces)
11396 --happy-option OPT
11398 give an extra option to happy (no need to quote options
11399 containing spaces)
11400 --haskell-suite-option OPT
11402 give an extra option to haskell-suite (no need to quote
11403 options containing spaces)
11404 --haskell-suite-pkg-option OPT
11406 give an extra option to haskell-suite-pkg (no need to
11407 quote options containing spaces)
11408 --hmake-option OPT
11410 give an extra option to hmake (no need to quote options
11411 containing spaces)
11412 --hpc-option OPT
11414 give an extra option to hpc (no need to quote options
11415 containing spaces)
11416 --hsc2hs-option OPT
11418 give an extra option to hsc2hs (no need to quote options
11419 containing spaces)
11420 --hscolour-option OPT
11422 give an extra option to hscolour (no need to quote op‐
11423 tions containing spaces)
11424 --jhc-option OPT
11426 give an extra option to jhc (no need to quote options
11427 containing spaces)
11428 --ld-option OPT
11430 give an extra option to ld (no need to quote options con‐
11431 taining spaces)
11432 --pkg-config-option OPT
11434 give an extra option to pkg-config (no need to quote op‐
11435 tions containing spaces)
11436 --runghc-option OPT
11438 give an extra option to runghc (no need to quote options
11439 containing spaces)
11440 --strip-option OPT
11442 give an extra option to strip (no need to quote options
11443 containing spaces)
11444 --tar-option OPT
11446 give an extra option to tar (no need to quote options
11447 containing spaces)
11448 --uhc-option OPT
11450 give an extra option to uhc (no need to quote options
11451 containing spaces)
11452 --alex-options OPTS
11454 give extra options to alex
11455 --ar-options OPTS
11457 give extra options to ar
11458 --c2hs-options OPTS
11460 give extra options to c2hs
11461 --cpphs-options OPTS
11463 give extra options to cpphs
11464 --doctest-options OPTS
11466 give extra options to doctest
11467 --gcc-options OPTS
11469 give extra options to gcc
11470 --ghc-options OPTS
11472 give extra options to ghc
11473 --ghc-pkg-options OPTS
11475 give extra options to ghc-pkg
11476 --ghcjs-options OPTS
11478 give extra options to ghcjs
11479 --ghcjs-pkg-options OPTS
11481 give extra options to ghcjs-pkg
11482 --greencard-options OPTS
11484 give extra options to greencard
11485 --haddock-options OPTS
11487 give extra options to haddock
11488 --happy-options OPTS
11490 give extra options to happy
11491 --haskell-suite-options OPTS
11493 give extra options to haskell-suite
11494 --haskell-suite-pkg-options OPTS
11496 give extra options to haskell-suite-pkg
11497 --hmake-options OPTS
11499 give extra options to hmake
11500 --hpc-options OPTS
11502 give extra options to hpc
11503 --hsc2hs-options OPTS
11505 give extra options to hsc2hs
11506 --hscolour-options OPTS
11508 give extra options to hscolour
11509 --jhc-options OPTS
11511 give extra options to jhc
11512 --ld-options OPTS
11514 give extra options to ld
11515 --pkg-config-options OPTS
11517 give extra options to pkg-config
11518 --runghc-options OPTS
11520 give extra options to runghc
11521 --strip-options OPTS
11523 give extra options to strip
11524 --tar-options OPTS
11526 give extra options to tar
11527 --uhc-options OPTS
11529 give extra options to uhc
11530 --cabal-lib-version VERSION
11532 Select which version of the Cabal lib to use to build
11533 packages (useful for testing).
11534 --constraint CONSTRAINT
11536 Specify constraints on a package (version, in‐
11537 stalled/source, flags)
11538 --preference CONSTRAINT
11540 Specify preferences (soft constraints) on the version of
11541 a package
11542 --solver SOLVER
11544 Select dependency solver to use (default: modular).
11545 Choices: modular.
11546 --allow-older [DEPS]
11548 Ignore lower bounds in all dependencies or DEPS
11549 --allow-newer [DEPS]
11551 Ignore upper bounds in all dependencies or DEPS
11552 --write-ghc-environment-files always|never|ghc8.4.4+
11554 Whether to create a .ghc.environment file after a suc‐
11555 cessful build (v2-build only)
11556 --enable-documentation
11558 --disable-documentation
11559 building of documentation
11560 --doc-index-file TEMPLATE
11562 A central index of haddock API documentation (template
11563 cannot use $pkgid)
11564 --dry-run
11566 Do not install anything, only print what would be in‐
11567 stalled.
11568 --max-backjumps NUM
11570 Maximum number of backjumps allowed while solving (de‐
11571 fault: 4000). Use a negative number to enable unlimited
11572 backtracking. Use 0 to disable backtracking completely.
11573 --reorder-goals
11575 --no-reorder-goals
11576 Try to reorder goals according to certain heuristics.
11577 Slows things down on average, but may make backtracking
11578 faster for some packages.
11579 --count-conflicts
11581 --no-count-conflicts
11582 Try to speed up solving by preferring goals that are in‐
11583 volved in a lot of conflicts (default).
11584 --fine-grained-conflicts
11586 --no-fine-grained-conflicts
11587 Skip a version of a package if it does not resolve the
11588 conflicts encountered in the last version, as a solver
11589 optimization (default).
11590 --minimize-conflict-set
11592 --no-minimize-conflict-set
11593 When there is no solution, try to improve the error mes‐
11594 sage by finding a minimal conflict set (default: false).
11595 May increase run time significantly.
11596 --independent-goals
11598 --no-independent-goals
11599 Treat several goals on the command line as independent.
11600 If several goals depend on the same package, different
11601 versions can be chosen.
11602 --shadow-installed-packages
11604 --no-shadow-installed-packages
11605 If multiple package instances of the same version are in‐
11606 stalled, treat all but one as shadowed.
11607 --strong-flags
11609 --no-strong-flags
11610 Do not defer flag choices (this used to be the default in
11611 cabal-install <= 1.20).
11612 --allow-boot-library-installs
11614 --no-allow-boot-library-installs
11615 Allow cabal to install base, ghc-prim, integer-simple,
11616 integer-gmp, and template-haskell.
11617 --reject-unconstrained-dependencies none|all
11619 Require these packages to have constraints on them if
11620 they are to be selected (default: none).
11621 --reinstall
11623 --no-reinstall
11624 Install even if it means installing the same version
11625 again.
11626 --avoid-reinstalls
11628 --no-avoid-reinstalls
11629 Do not select versions that would destructively overwrite
11630 installed packages.
11631 --force-reinstalls
11633 --no-force-reinstalls
11634 Reinstall packages even if they will most likely break
11635 other installed packages.
11636 --upgrade-dependencies
11638 --no-upgrade-dependencies
11639 Pick the latest version for all dependencies, rather than
11640 trying to pick an installed version.
11641 --only-dependencies
11643 --no-only-dependencies
11644 Install only the dependencies necessary to build the
11645 given packages
11646 --dependencies-only
11648 --no-dependencies-only
11649 A synonym for --only-dependencies
11650 --index-state STATE
11652 Use source package index state as it existed at a previ‐
11653 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
11654 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
11655 'HEAD' (default: 'HEAD').
11656 --root-cmd COMMAND
11658 (No longer supported, do not use.)
11659 --symlink-bindir DIR
11661 Add symlinks to installed executables into this direc‐
11662 tory.
11663 --build-summary TEMPLATE
11665 Save build summaries to file (name template can use
11666 $pkgid, $compiler, $os, $arch)
11667 --build-log TEMPLATE
11669 Log all builds to file (name template can use $pkgid,
11670 $compiler, $os, $arch)
11671 --remote-build-reporting LEVEL
11673 Generate build reports to send to a remote server (none,
11674 anonymous or detailed).
11675 --report-planning-failure
11677 Generate build reports when the dependency solver fails.
11678 This is used by the Hackage build bot.
11679 --enable-per-component
11681 --disable-per-component
11682 Per-component builds when possible
11683 --one-shot
11685 --no-one-shot
11686 Do not record the packages in the world file.
11687 --run-tests
11689 Run package test suites during installation.
11690 -j, --jobs [NUM]
11692 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
11693 given).
11694 --keep-going
11696 After a build failure, continue to build other unaffected
11697 packages.
11698 --offline
11700 --no-offline
11701 Don't download packages from the Internet.
11702 --project-file FILE
11704 Set the name of the cabal.project file to search for in
11705 parent directories
11706 --only
11708 Only installs the package in the current directory.
11709 --haddock-hoogle
11711 Generate a hoogle database
11712 --haddock-html
11714 Generate HTML documentation (the default)
11715 --haddock-html-location URL
11717 Location of HTML documentation for pre-requisite packages
11718 --haddock-for-hackage
11720 Collection of flags to generate documentation suitable
11721 for upload to hackage
11722 --haddock-executables
11724 Run haddock for Executables targets
11725 --haddock-tests
11727 Run haddock for Test Suite targets
11728 --haddock-benchmarks
11730 Run haddock for Benchmark targets
11731 --haddock-all
11733 Run haddock for all targets
11734 --haddock-internal
11736 Run haddock for internal modules and include all symbols
11737 --haddock-css PATH
11739 Use PATH as the haddock stylesheet
11740 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
11742 dock-hyperlinked-source
11743 Hyperlink the documentation to the source code
11744 --haddock-quickjump
11746 Generate an index for interactive documentation naviga‐
11747 tion
11748 --haddock-hscolour-css PATH
11750 Use PATH as the HsColour stylesheet
11751 --haddock-contents-location URL
11753 Bake URL in as the location for the contents page
11754 --test-log TEMPLATE
11756 Log all test suite results to file (name template can use
11757 $pkgid, $compiler, $os, $arch, $test-suite, $result)
11758 --test-machine-log TEMPLATE
11760 Produce a machine-readable log file (name template can
11761 use $pkgid, $compiler, $os, $arch, $result)
11762 --test-show-details FILTER
11764 --test-keep-tix-files
11766 keep .tix files for HPC between test runs
11767 --test-wrapper FILE
11769 Run test through a wrapper.
11770 --test-fail-when-no-test-suites
11772 Exit with failure when no test suites are found.
11773 --test-options TEMPLATES
11775 give extra options to test executables (name templates
11776 can use $pkgid, $compiler, $os, $arch, $test-suite)
11777 --test-option TEMPLATE
11779 give extra option to test executables (no need to quote
11780 options containing spaces, name template can use $pkgid,
11781 $compiler, $os, $arch, $test-suite)
11782 --benchmark-options TEMPLATES
11784 give extra options to benchmark executables (name tem‐
11785 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
11786 --benchmark-option TEMPLATE
11788 give extra option to benchmark executables (no need to
11789 quote options containing spaces, name template can use
11790 $pkgid, $compiler, $os, $arch, $benchmark)
11791 cabal v2-freeze
11794 Usage: cabal v2-freeze [FLAGS]
11796 The project configuration is frozen so that it will be reproducible in
11799 future.
11800 The precise dependency configuration for the project is written to the
11802 specified). This file extends the configuration from the 'ca‐
11803 bal.project' file and thus is used as the project configuration for all
11804 other commands (such as
11805 The freeze file can be kept in source control. To make small adjust‐
11807 ments it may be edited manually, or to make bigger changes you may wish
11808 to delete the file and re-freeze. For more control, one approach is to
11809 try variations using once you have a satisfactory solution to freeze it
11810 using the 'v2-freeze' command with the same set of flags.
11811 Examples:
11814 cabal v2-freeze
11815 Freeze the configuration of the current project
11816 cabal v2-build --dry-run --constraint="aeson < 1"
11818 Check what a solution with the given constraints would look like
11819 cabal v2-freeze --constraint="aeson < 1"
11820 Freeze a solution using the given constraints
11821 Note: this command is part of the new project-based system (aka nix-
11823 style local builds). These features are currently in beta. Please see
11824 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
11825 details and advice on what you can expect to work. If you encounter
11826 problems please file issues at https://github.com/haskell/cabal/issues
11827 and if you have any time to get involved and help with testing, fixing
11828 bugs etc then that is very much appreciated.
11829 Flags:
11832 -v, --verbose [n]
11833 Control verbosity (n is 0--3, default verbosity level is
11834 1)
11835 --builddir, --distdir, --distpref DIR
11837 The directory where Cabal puts generated build files (de‐
11838 fault dist)
11839 -g, --ghc
11841 compile with GHC
11842 --ghcjs
11844 compile with GHCJS
11845 --uhc
11847 compile with UHC
11848 --haskell-suite
11850 compile with a haskell-suite compiler
11851 --cabal-file PATH
11853 use this Cabal file
11854 -w, --with-compiler PATH
11856 give the path to a particular compiler
11857 --with-hc-pkg PATH
11859 give the path to the package tool
11860 --prefix DIR
11862 bake this prefix in preparation of installation
11863 --bindir DIR
11865 installation directory for executables
11866 --libdir DIR
11868 installation directory for libraries
11869 --libsubdir DIR
11871 subdirectory of libdir in which libs are installed
11872 --dynlibdir DIR
11874 installation directory for dynamic libraries
11875 --libexecdir DIR
11877 installation directory for program executables
11878 --libexecsubdir DIR
11880 subdirectory of libexecdir in which private executables
11881 are installed
11882 --datadir DIR
11884 installation directory for read-only data
11885 --datasubdir DIR
11887 subdirectory of datadir in which data files are installed
11888 --docdir DIR
11890 installation directory for documentation
11891 --htmldir DIR
11893 installation directory for HTML documentation
11894 --haddockdir DIR
11896 installation directory for haddock interfaces
11897 --sysconfdir DIR
11899 installation directory for configuration files
11900 --program-prefix PREFIX
11902 prefix to be applied to installed executables
11903 --program-suffix SUFFIX
11905 suffix to be applied to installed executables
11906 --enable-library-vanilla
11908 --disable-library-vanilla
11909 Vanilla libraries
11910 -p, --enable-library-profiling
11912 --disable-library-profiling
11913 Library profiling
11914 --enable-shared
11916 --disable-shared
11917 Shared library
11918 --enable-static
11920 --disable-static
11921 Static library
11922 --enable-executable-dynamic
11924 --disable-executable-dynamic
11925 Executable dynamic linking
11926 --enable-executable-static
11928 --disable-executable-static
11929 Executable fully static linking
11930 --enable-profiling
11932 --disable-profiling
11933 Executable and library profiling
11934 --enable-executable-profiling
11936 --disable-executable-profiling
11937 Executable profiling (DEPRECATED)
11938 --profiling-detail level
11940 Profiling detail level for executable and library (de‐
11941 fault, none, exported-functions, toplevel-functions,
11942 all-functions).
11943 --library-profiling-detail level
11945 Profiling detail level for libraries only.
11946 -O, --enable-optimization, --enable-optimisation [n]
11948 Build with optimization (n is 0--2, default is 1)
11949 --disable-optimization, --disable-optimisation
11951 Build without optimization
11952 --enable-debug-info [n]
11954 Emit debug info (n is 0--3, default is 0)
11955 --disable-debug-info
11957 Don't emit debug info
11958 --enable-library-for-ghci
11960 --disable-library-for-ghci
11961 compile library for use with GHCi
11962 --enable-split-sections
11964 --disable-split-sections
11965 compile library code such that unneeded definitions can
11966 be dropped from the final executable (GHC 7.8+)
11967 --enable-split-objs
11969 --disable-split-objs
11970 split library into smaller objects to reduce binary sizes
11971 (GHC 6.6+)
11972 --enable-executable-stripping
11974 --disable-executable-stripping
11975 strip executables upon installation to reduce binary
11976 sizes
11977 --enable-library-stripping
11979 --disable-library-stripping
11980 strip libraries upon installation to reduce binary sizes
11981 --configure-option OPT
11983 Extra option for configure
11984 --user
11986 --global
11987 doing a per-user installation
11988 --package-db DB
11990 Append the given package database to the list of package
11991 databases used (to satisfy dependencies and register
11992 into). May be a specific file, 'global' or 'user'. The
11993 initial list is ['global'], ['global', 'user'], or
11994 ['global', $sandbox], depending on context. Use 'clear'
11995 to reset the list to empty. See the user guide for de‐
11996 tails.
11997 -f, --flags FLAGS
11999 Force values for the given flags in Cabal conditionals in
12000 the .cabal file. E.g., --flags="debug -usebytestrings"
12001 forces the flag "debug" to true and "usebytestrings" to
12002 false.
12003 --extra-include-dirs PATH
12005 A list of directories to search for header files
12006 --enable-deterministic
12008 --disable-deterministic
12009 Try to be as deterministic as possible (used by the test
12010 suite)
12011 --ipid IPID
12013 Installed package ID to compile this package as
12014 --cid CID
12016 Installed component ID to compile this component as
12017 --extra-lib-dirs PATH
12019 A list of directories to search for external libraries
12020 --extra-framework-dirs PATH
12022 A list of directories to search for external frameworks
12023 (OS X only)
12024 --extra-prog-path PATH
12026 A list of directories to search for required programs (in
12027 addition to the normal search locations)
12028 --instantiate-with NAME=MOD
12030 A mapping of signature names to concrete module instanti‐
12031 ations.
12032 --enable-tests
12034 --disable-tests
12035 dependency checking and compilation for test suites
12036 listed in the package description file.
12037 --enable-coverage
12039 --disable-coverage
12040 build package with Haskell Program Coverage. (GHC only)
12041 --enable-library-coverage
12043 --disable-library-coverage
12044 build package with Haskell Program Coverage. (GHC only)
12045 (DEPRECATED)
12046 --enable-benchmarks
12048 --disable-benchmarks
12049 dependency checking and compilation for benchmarks listed
12050 in the package description file.
12051 --enable-relocatable
12053 --disable-relocatable
12054 building a package that is relocatable. (GHC only)
12055 --disable-response-files
12057 enable workaround for old versions of programs like "ar"
12058 that do not support @file arguments
12059 --allow-depending-on-private-libs
12061 Allow depending on private libraries. If set, the library
12062 visibility check MUST be done externally.
12063 --with-alex PATH
12065 give the path to alex
12066 --with-ar PATH
12068 give the path to ar
12069 --with-c2hs PATH
12071 give the path to c2hs
12072 --with-cpphs PATH
12074 give the path to cpphs
12075 --with-doctest PATH
12077 give the path to doctest
12078 --with-gcc PATH
12080 give the path to gcc
12081 --with-ghc PATH
12083 give the path to ghc
12084 --with-ghc-pkg PATH
12086 give the path to ghc-pkg
12087 --with-ghcjs PATH
12089 give the path to ghcjs
12090 --with-ghcjs-pkg PATH
12092 give the path to ghcjs-pkg
12093 --with-greencard PATH
12095 give the path to greencard
12096 --with-haddock PATH
12098 give the path to haddock
12099 --with-happy PATH
12101 give the path to happy
12102 --with-haskell-suite PATH
12104 give the path to haskell-suite
12105 --with-haskell-suite-pkg PATH
12107 give the path to haskell-suite-pkg
12108 --with-hmake PATH
12110 give the path to hmake
12111 --with-hpc PATH
12113 give the path to hpc
12114 --with-hsc2hs PATH
12116 give the path to hsc2hs
12117 --with-hscolour PATH
12119 give the path to hscolour
12120 --with-jhc PATH
12122 give the path to jhc
12123 --with-ld PATH
12125 give the path to ld
12126 --with-pkg-config PATH
12128 give the path to pkg-config
12129 --with-runghc PATH
12131 give the path to runghc
12132 --with-strip PATH
12134 give the path to strip
12135 --with-tar PATH
12137 give the path to tar
12138 --with-uhc PATH
12140 give the path to uhc
12141 --alex-option OPT
12143 give an extra option to alex (no need to quote options
12144 containing spaces)
12145 --ar-option OPT
12147 give an extra option to ar (no need to quote options con‐
12148 taining spaces)
12149 --c2hs-option OPT
12151 give an extra option to c2hs (no need to quote options
12152 containing spaces)
12153 --cpphs-option OPT
12155 give an extra option to cpphs (no need to quote options
12156 containing spaces)
12157 --doctest-option OPT
12159 give an extra option to doctest (no need to quote options
12160 containing spaces)
12161 --gcc-option OPT
12163 give an extra option to gcc (no need to quote options
12164 containing spaces)
12165 --ghc-option OPT
12167 give an extra option to ghc (no need to quote options
12168 containing spaces)
12169 --ghc-pkg-option OPT
12171 give an extra option to ghc-pkg (no need to quote options
12172 containing spaces)
12173 --ghcjs-option OPT
12175 give an extra option to ghcjs (no need to quote options
12176 containing spaces)
12177 --ghcjs-pkg-option OPT
12179 give an extra option to ghcjs-pkg (no need to quote op‐
12180 tions containing spaces)
12181 --greencard-option OPT
12183 give an extra option to greencard (no need to quote op‐
12184 tions containing spaces)
12185 --haddock-option OPT
12187 give an extra option to haddock (no need to quote options
12188 containing spaces)
12189 --happy-option OPT
12191 give an extra option to happy (no need to quote options
12192 containing spaces)
12193 --haskell-suite-option OPT
12195 give an extra option to haskell-suite (no need to quote
12196 options containing spaces)
12197 --haskell-suite-pkg-option OPT
12199 give an extra option to haskell-suite-pkg (no need to
12200 quote options containing spaces)
12201 --hmake-option OPT
12203 give an extra option to hmake (no need to quote options
12204 containing spaces)
12205 --hpc-option OPT
12207 give an extra option to hpc (no need to quote options
12208 containing spaces)
12209 --hsc2hs-option OPT
12211 give an extra option to hsc2hs (no need to quote options
12212 containing spaces)
12213 --hscolour-option OPT
12215 give an extra option to hscolour (no need to quote op‐
12216 tions containing spaces)
12217 --jhc-option OPT
12219 give an extra option to jhc (no need to quote options
12220 containing spaces)
12221 --ld-option OPT
12223 give an extra option to ld (no need to quote options con‐
12224 taining spaces)
12225 --pkg-config-option OPT
12227 give an extra option to pkg-config (no need to quote op‐
12228 tions containing spaces)
12229 --runghc-option OPT
12231 give an extra option to runghc (no need to quote options
12232 containing spaces)
12233 --strip-option OPT
12235 give an extra option to strip (no need to quote options
12236 containing spaces)
12237 --tar-option OPT
12239 give an extra option to tar (no need to quote options
12240 containing spaces)
12241 --uhc-option OPT
12243 give an extra option to uhc (no need to quote options
12244 containing spaces)
12245 --alex-options OPTS
12247 give extra options to alex
12248 --ar-options OPTS
12250 give extra options to ar
12251 --c2hs-options OPTS
12253 give extra options to c2hs
12254 --cpphs-options OPTS
12256 give extra options to cpphs
12257 --doctest-options OPTS
12259 give extra options to doctest
12260 --gcc-options OPTS
12262 give extra options to gcc
12263 --ghc-options OPTS
12265 give extra options to ghc
12266 --ghc-pkg-options OPTS
12268 give extra options to ghc-pkg
12269 --ghcjs-options OPTS
12271 give extra options to ghcjs
12272 --ghcjs-pkg-options OPTS
12274 give extra options to ghcjs-pkg
12275 --greencard-options OPTS
12277 give extra options to greencard
12278 --haddock-options OPTS
12280 give extra options to haddock
12281 --happy-options OPTS
12283 give extra options to happy
12284 --haskell-suite-options OPTS
12286 give extra options to haskell-suite
12287 --haskell-suite-pkg-options OPTS
12289 give extra options to haskell-suite-pkg
12290 --hmake-options OPTS
12292 give extra options to hmake
12293 --hpc-options OPTS
12295 give extra options to hpc
12296 --hsc2hs-options OPTS
12298 give extra options to hsc2hs
12299 --hscolour-options OPTS
12301 give extra options to hscolour
12302 --jhc-options OPTS
12304 give extra options to jhc
12305 --ld-options OPTS
12307 give extra options to ld
12308 --pkg-config-options OPTS
12310 give extra options to pkg-config
12311 --runghc-options OPTS
12313 give extra options to runghc
12314 --strip-options OPTS
12316 give extra options to strip
12317 --tar-options OPTS
12319 give extra options to tar
12320 --uhc-options OPTS
12322 give extra options to uhc
12323 --cabal-lib-version VERSION
12325 Select which version of the Cabal lib to use to build
12326 packages (useful for testing).
12327 --constraint CONSTRAINT
12329 Specify constraints on a package (version, in‐
12330 stalled/source, flags)
12331 --preference CONSTRAINT
12333 Specify preferences (soft constraints) on the version of
12334 a package
12335 --solver SOLVER
12337 Select dependency solver to use (default: modular).
12338 Choices: modular.
12339 --allow-older [DEPS]
12341 Ignore lower bounds in all dependencies or DEPS
12342 --allow-newer [DEPS]
12344 Ignore upper bounds in all dependencies or DEPS
12345 --write-ghc-environment-files always|never|ghc8.4.4+
12347 Whether to create a .ghc.environment file after a suc‐
12348 cessful build (v2-build only)
12349 --enable-documentation
12351 --disable-documentation
12352 building of documentation
12353 --doc-index-file TEMPLATE
12355 A central index of haddock API documentation (template
12356 cannot use $pkgid)
12357 --dry-run
12359 Do not install anything, only print what would be in‐
12360 stalled.
12361 --max-backjumps NUM
12363 Maximum number of backjumps allowed while solving (de‐
12364 fault: 4000). Use a negative number to enable unlimited
12365 backtracking. Use 0 to disable backtracking completely.
12366 --reorder-goals
12368 --no-reorder-goals
12369 Try to reorder goals according to certain heuristics.
12370 Slows things down on average, but may make backtracking
12371 faster for some packages.
12372 --count-conflicts
12374 --no-count-conflicts
12375 Try to speed up solving by preferring goals that are in‐
12376 volved in a lot of conflicts (default).
12377 --fine-grained-conflicts
12379 --no-fine-grained-conflicts
12380 Skip a version of a package if it does not resolve the
12381 conflicts encountered in the last version, as a solver
12382 optimization (default).
12383 --minimize-conflict-set
12385 --no-minimize-conflict-set
12386 When there is no solution, try to improve the error mes‐
12387 sage by finding a minimal conflict set (default: false).
12388 May increase run time significantly.
12389 --independent-goals
12391 --no-independent-goals
12392 Treat several goals on the command line as independent.
12393 If several goals depend on the same package, different
12394 versions can be chosen.
12395 --shadow-installed-packages
12397 --no-shadow-installed-packages
12398 If multiple package instances of the same version are in‐
12399 stalled, treat all but one as shadowed.
12400 --strong-flags
12402 --no-strong-flags
12403 Do not defer flag choices (this used to be the default in
12404 cabal-install <= 1.20).
12405 --allow-boot-library-installs
12407 --no-allow-boot-library-installs
12408 Allow cabal to install base, ghc-prim, integer-simple,
12409 integer-gmp, and template-haskell.
12410 --reject-unconstrained-dependencies none|all
12412 Require these packages to have constraints on them if
12413 they are to be selected (default: none).
12414 --reinstall
12416 --no-reinstall
12417 Install even if it means installing the same version
12418 again.
12419 --avoid-reinstalls
12421 --no-avoid-reinstalls
12422 Do not select versions that would destructively overwrite
12423 installed packages.
12424 --force-reinstalls
12426 --no-force-reinstalls
12427 Reinstall packages even if they will most likely break
12428 other installed packages.
12429 --upgrade-dependencies
12431 --no-upgrade-dependencies
12432 Pick the latest version for all dependencies, rather than
12433 trying to pick an installed version.
12434 --only-dependencies
12436 --no-only-dependencies
12437 Install only the dependencies necessary to build the
12438 given packages
12439 --dependencies-only
12441 --no-dependencies-only
12442 A synonym for --only-dependencies
12443 --index-state STATE
12445 Use source package index state as it existed at a previ‐
12446 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
12447 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
12448 'HEAD' (default: 'HEAD').
12449 --root-cmd COMMAND
12451 (No longer supported, do not use.)
12452 --symlink-bindir DIR
12454 Add symlinks to installed executables into this direc‐
12455 tory.
12456 --build-summary TEMPLATE
12458 Save build summaries to file (name template can use
12459 $pkgid, $compiler, $os, $arch)
12460 --build-log TEMPLATE
12462 Log all builds to file (name template can use $pkgid,
12463 $compiler, $os, $arch)
12464 --remote-build-reporting LEVEL
12466 Generate build reports to send to a remote server (none,
12467 anonymous or detailed).
12468 --report-planning-failure
12470 Generate build reports when the dependency solver fails.
12471 This is used by the Hackage build bot.
12472 --enable-per-component
12474 --disable-per-component
12475 Per-component builds when possible
12476 --one-shot
12478 --no-one-shot
12479 Do not record the packages in the world file.
12480 --run-tests
12482 Run package test suites during installation.
12483 -j, --jobs [NUM]
12485 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
12486 given).
12487 --keep-going
12489 After a build failure, continue to build other unaffected
12490 packages.
12491 --offline
12493 --no-offline
12494 Don't download packages from the Internet.
12495 --project-file FILE
12497 Set the name of the cabal.project file to search for in
12498 parent directories
12499 --only
12501 Only installs the package in the current directory.
12502 --haddock-hoogle
12504 Generate a hoogle database
12505 --haddock-html
12507 Generate HTML documentation (the default)
12508 --haddock-html-location URL
12510 Location of HTML documentation for pre-requisite packages
12511 --haddock-for-hackage
12513 Collection of flags to generate documentation suitable
12514 for upload to hackage
12515 --haddock-executables
12517 Run haddock for Executables targets
12518 --haddock-tests
12520 Run haddock for Test Suite targets
12521 --haddock-benchmarks
12523 Run haddock for Benchmark targets
12524 --haddock-all
12526 Run haddock for all targets
12527 --haddock-internal
12529 Run haddock for internal modules and include all symbols
12530 --haddock-css PATH
12532 Use PATH as the haddock stylesheet
12533 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
12535 dock-hyperlinked-source
12536 Hyperlink the documentation to the source code
12537 --haddock-quickjump
12539 Generate an index for interactive documentation naviga‐
12540 tion
12541 --haddock-hscolour-css PATH
12543 Use PATH as the HsColour stylesheet
12544 --haddock-contents-location URL
12546 Bake URL in as the location for the contents page
12547 --test-log TEMPLATE
12549 Log all test suite results to file (name template can use
12550 $pkgid, $compiler, $os, $arch, $test-suite, $result)
12551 --test-machine-log TEMPLATE
12553 Produce a machine-readable log file (name template can
12554 use $pkgid, $compiler, $os, $arch, $result)
12555 --test-show-details FILTER
12557 --test-keep-tix-files
12559 keep .tix files for HPC between test runs
12560 --test-wrapper FILE
12562 Run test through a wrapper.
12563 --test-fail-when-no-test-suites
12565 Exit with failure when no test suites are found.
12566 --test-options TEMPLATES
12568 give extra options to test executables (name templates
12569 can use $pkgid, $compiler, $os, $arch, $test-suite)
12570 --test-option TEMPLATE
12572 give extra option to test executables (no need to quote
12573 options containing spaces, name template can use $pkgid,
12574 $compiler, $os, $arch, $test-suite)
12575 --benchmark-options TEMPLATES
12577 give extra options to benchmark executables (name tem‐
12578 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
12579 --benchmark-option TEMPLATE
12581 give extra option to benchmark executables (no need to
12582 quote options containing spaces, name template can use
12583 $pkgid, $compiler, $os, $arch, $benchmark)
12584 cabal haddock
12587 Usage: cabal haddock [FLAGS] TARGET
12589 Build Haddock documentation for the specified packages within the
12592 project.
12593 Any package in the project can be specified. If no package is speci‐
12595 fied, the default is to build the documentation for the package in the
12596 current directory. The default behaviour is to build documentation for
12597 the exposed modules of the library component (if any). This can be
12598 changed with the
12599 Currently, documentation for dependencies is NOT built. This behavior
12601 may change in future.
12602 Additional configuration flags can be specified on the command line and
12604 these extend the project configuration from the 'cabal.project',
12605 Build Haddock documentation for the specified packages within the
12608 project.
12609 Any package in the project can be specified. If no package is speci‐
12611 fied, the default is to build the documentation for the package in the
12612 current directory. The default behaviour is to build documentation for
12613 the exposed modules of the library component (if any). This can be
12614 changed with the
12615 Currently, documentation for dependencies is NOT built. This behavior
12617 may change in future.
12618 Additional configuration flags can be specified on the command line and
12620 these extend the project configuration from the 'cabal.project',
12621 Flags:
12624 -v, --verbose [n]
12625 Control verbosity (n is 0--3, default verbosity level is
12626 1)
12627 --builddir, --distdir, --distpref DIR
12629 The directory where Cabal puts generated build files (de‐
12630 fault dist)
12631 -g, --ghc
12633 compile with GHC
12634 --ghcjs
12636 compile with GHCJS
12637 --uhc
12639 compile with UHC
12640 --haskell-suite
12642 compile with a haskell-suite compiler
12643 --cabal-file PATH
12645 use this Cabal file
12646 -w, --with-compiler PATH
12648 give the path to a particular compiler
12649 --with-hc-pkg PATH
12651 give the path to the package tool
12652 --prefix DIR
12654 bake this prefix in preparation of installation
12655 --bindir DIR
12657 installation directory for executables
12658 --libdir DIR
12660 installation directory for libraries
12661 --libsubdir DIR
12663 subdirectory of libdir in which libs are installed
12664 --dynlibdir DIR
12666 installation directory for dynamic libraries
12667 --libexecdir DIR
12669 installation directory for program executables
12670 --libexecsubdir DIR
12672 subdirectory of libexecdir in which private executables
12673 are installed
12674 --datadir DIR
12676 installation directory for read-only data
12677 --datasubdir DIR
12679 subdirectory of datadir in which data files are installed
12680 --docdir DIR
12682 installation directory for documentation
12683 --htmldir DIR
12685 installation directory for HTML documentation
12686 --haddockdir DIR
12688 installation directory for haddock interfaces
12689 --sysconfdir DIR
12691 installation directory for configuration files
12692 --program-prefix PREFIX
12694 prefix to be applied to installed executables
12695 --program-suffix SUFFIX
12697 suffix to be applied to installed executables
12698 --enable-library-vanilla
12700 --disable-library-vanilla
12701 Vanilla libraries
12702 -p, --enable-library-profiling
12704 --disable-library-profiling
12705 Library profiling
12706 --enable-shared
12708 --disable-shared
12709 Shared library
12710 --enable-static
12712 --disable-static
12713 Static library
12714 --enable-executable-dynamic
12716 --disable-executable-dynamic
12717 Executable dynamic linking
12718 --enable-executable-static
12720 --disable-executable-static
12721 Executable fully static linking
12722 --enable-profiling
12724 --disable-profiling
12725 Executable and library profiling
12726 --enable-executable-profiling
12728 --disable-executable-profiling
12729 Executable profiling (DEPRECATED)
12730 --profiling-detail level
12732 Profiling detail level for executable and library (de‐
12733 fault, none, exported-functions, toplevel-functions,
12734 all-functions).
12735 --library-profiling-detail level
12737 Profiling detail level for libraries only.
12738 -O, --enable-optimization, --enable-optimisation [n]
12740 Build with optimization (n is 0--2, default is 1)
12741 --disable-optimization, --disable-optimisation
12743 Build without optimization
12744 --enable-debug-info [n]
12746 Emit debug info (n is 0--3, default is 0)
12747 --disable-debug-info
12749 Don't emit debug info
12750 --enable-library-for-ghci
12752 --disable-library-for-ghci
12753 compile library for use with GHCi
12754 --enable-split-sections
12756 --disable-split-sections
12757 compile library code such that unneeded definitions can
12758 be dropped from the final executable (GHC 7.8+)
12759 --enable-split-objs
12761 --disable-split-objs
12762 split library into smaller objects to reduce binary sizes
12763 (GHC 6.6+)
12764 --enable-executable-stripping
12766 --disable-executable-stripping
12767 strip executables upon installation to reduce binary
12768 sizes
12769 --enable-library-stripping
12771 --disable-library-stripping
12772 strip libraries upon installation to reduce binary sizes
12773 --configure-option OPT
12775 Extra option for configure
12776 --user
12778 --global
12779 doing a per-user installation
12780 --package-db DB
12782 Append the given package database to the list of package
12783 databases used (to satisfy dependencies and register
12784 into). May be a specific file, 'global' or 'user'. The
12785 initial list is ['global'], ['global', 'user'], or
12786 ['global', $sandbox], depending on context. Use 'clear'
12787 to reset the list to empty. See the user guide for de‐
12788 tails.
12789 -f, --flags FLAGS
12791 Force values for the given flags in Cabal conditionals in
12792 the .cabal file. E.g., --flags="debug -usebytestrings"
12793 forces the flag "debug" to true and "usebytestrings" to
12794 false.
12795 --extra-include-dirs PATH
12797 A list of directories to search for header files
12798 --enable-deterministic
12800 --disable-deterministic
12801 Try to be as deterministic as possible (used by the test
12802 suite)
12803 --ipid IPID
12805 Installed package ID to compile this package as
12806 --cid CID
12808 Installed component ID to compile this component as
12809 --extra-lib-dirs PATH
12811 A list of directories to search for external libraries
12812 --extra-framework-dirs PATH
12814 A list of directories to search for external frameworks
12815 (OS X only)
12816 --extra-prog-path PATH
12818 A list of directories to search for required programs (in
12819 addition to the normal search locations)
12820 --instantiate-with NAME=MOD
12822 A mapping of signature names to concrete module instanti‐
12823 ations.
12824 --enable-tests
12826 --disable-tests
12827 dependency checking and compilation for test suites
12828 listed in the package description file.
12829 --enable-coverage
12831 --disable-coverage
12832 build package with Haskell Program Coverage. (GHC only)
12833 --enable-library-coverage
12835 --disable-library-coverage
12836 build package with Haskell Program Coverage. (GHC only)
12837 (DEPRECATED)
12838 --enable-benchmarks
12840 --disable-benchmarks
12841 dependency checking and compilation for benchmarks listed
12842 in the package description file.
12843 --enable-relocatable
12845 --disable-relocatable
12846 building a package that is relocatable. (GHC only)
12847 --disable-response-files
12849 enable workaround for old versions of programs like "ar"
12850 that do not support @file arguments
12851 --allow-depending-on-private-libs
12853 Allow depending on private libraries. If set, the library
12854 visibility check MUST be done externally.
12855 --with-alex PATH
12857 give the path to alex
12858 --with-ar PATH
12860 give the path to ar
12861 --with-c2hs PATH
12863 give the path to c2hs
12864 --with-cpphs PATH
12866 give the path to cpphs
12867 --with-doctest PATH
12869 give the path to doctest
12870 --with-gcc PATH
12872 give the path to gcc
12873 --with-ghc PATH
12875 give the path to ghc
12876 --with-ghc-pkg PATH
12878 give the path to ghc-pkg
12879 --with-ghcjs PATH
12881 give the path to ghcjs
12882 --with-ghcjs-pkg PATH
12884 give the path to ghcjs-pkg
12885 --with-greencard PATH
12887 give the path to greencard
12888 --with-haddock PATH
12890 give the path to haddock
12891 --with-happy PATH
12893 give the path to happy
12894 --with-haskell-suite PATH
12896 give the path to haskell-suite
12897 --with-haskell-suite-pkg PATH
12899 give the path to haskell-suite-pkg
12900 --with-hmake PATH
12902 give the path to hmake
12903 --with-hpc PATH
12905 give the path to hpc
12906 --with-hsc2hs PATH
12908 give the path to hsc2hs
12909 --with-hscolour PATH
12911 give the path to hscolour
12912 --with-jhc PATH
12914 give the path to jhc
12915 --with-ld PATH
12917 give the path to ld
12918 --with-pkg-config PATH
12920 give the path to pkg-config
12921 --with-runghc PATH
12923 give the path to runghc
12924 --with-strip PATH
12926 give the path to strip
12927 --with-tar PATH
12929 give the path to tar
12930 --with-uhc PATH
12932 give the path to uhc
12933 --alex-option OPT
12935 give an extra option to alex (no need to quote options
12936 containing spaces)
12937 --ar-option OPT
12939 give an extra option to ar (no need to quote options con‐
12940 taining spaces)
12941 --c2hs-option OPT
12943 give an extra option to c2hs (no need to quote options
12944 containing spaces)
12945 --cpphs-option OPT
12947 give an extra option to cpphs (no need to quote options
12948 containing spaces)
12949 --doctest-option OPT
12951 give an extra option to doctest (no need to quote options
12952 containing spaces)
12953 --gcc-option OPT
12955 give an extra option to gcc (no need to quote options
12956 containing spaces)
12957 --ghc-option OPT
12959 give an extra option to ghc (no need to quote options
12960 containing spaces)
12961 --ghc-pkg-option OPT
12963 give an extra option to ghc-pkg (no need to quote options
12964 containing spaces)
12965 --ghcjs-option OPT
12967 give an extra option to ghcjs (no need to quote options
12968 containing spaces)
12969 --ghcjs-pkg-option OPT
12971 give an extra option to ghcjs-pkg (no need to quote op‐
12972 tions containing spaces)
12973 --greencard-option OPT
12975 give an extra option to greencard (no need to quote op‐
12976 tions containing spaces)
12977 --haddock-option OPT
12979 give an extra option to haddock (no need to quote options
12980 containing spaces)
12981 --happy-option OPT
12983 give an extra option to happy (no need to quote options
12984 containing spaces)
12985 --haskell-suite-option OPT
12987 give an extra option to haskell-suite (no need to quote
12988 options containing spaces)
12989 --haskell-suite-pkg-option OPT
12991 give an extra option to haskell-suite-pkg (no need to
12992 quote options containing spaces)
12993 --hmake-option OPT
12995 give an extra option to hmake (no need to quote options
12996 containing spaces)
12997 --hpc-option OPT
12999 give an extra option to hpc (no need to quote options
13000 containing spaces)
13001 --hsc2hs-option OPT
13003 give an extra option to hsc2hs (no need to quote options
13004 containing spaces)
13005 --hscolour-option OPT
13007 give an extra option to hscolour (no need to quote op‐
13008 tions containing spaces)
13009 --jhc-option OPT
13011 give an extra option to jhc (no need to quote options
13012 containing spaces)
13013 --ld-option OPT
13015 give an extra option to ld (no need to quote options con‐
13016 taining spaces)
13017 --pkg-config-option OPT
13019 give an extra option to pkg-config (no need to quote op‐
13020 tions containing spaces)
13021 --runghc-option OPT
13023 give an extra option to runghc (no need to quote options
13024 containing spaces)
13025 --strip-option OPT
13027 give an extra option to strip (no need to quote options
13028 containing spaces)
13029 --tar-option OPT
13031 give an extra option to tar (no need to quote options
13032 containing spaces)
13033 --uhc-option OPT
13035 give an extra option to uhc (no need to quote options
13036 containing spaces)
13037 --alex-options OPTS
13039 give extra options to alex
13040 --ar-options OPTS
13042 give extra options to ar
13043 --c2hs-options OPTS
13045 give extra options to c2hs
13046 --cpphs-options OPTS
13048 give extra options to cpphs
13049 --doctest-options OPTS
13051 give extra options to doctest
13052 --gcc-options OPTS
13054 give extra options to gcc
13055 --ghc-options OPTS
13057 give extra options to ghc
13058 --ghc-pkg-options OPTS
13060 give extra options to ghc-pkg
13061 --ghcjs-options OPTS
13063 give extra options to ghcjs
13064 --ghcjs-pkg-options OPTS
13066 give extra options to ghcjs-pkg
13067 --greencard-options OPTS
13069 give extra options to greencard
13070 --haddock-options OPTS
13072 give extra options to haddock
13073 --happy-options OPTS
13075 give extra options to happy
13076 --haskell-suite-options OPTS
13078 give extra options to haskell-suite
13079 --haskell-suite-pkg-options OPTS
13081 give extra options to haskell-suite-pkg
13082 --hmake-options OPTS
13084 give extra options to hmake
13085 --hpc-options OPTS
13087 give extra options to hpc
13088 --hsc2hs-options OPTS
13090 give extra options to hsc2hs
13091 --hscolour-options OPTS
13093 give extra options to hscolour
13094 --jhc-options OPTS
13096 give extra options to jhc
13097 --ld-options OPTS
13099 give extra options to ld
13100 --pkg-config-options OPTS
13102 give extra options to pkg-config
13103 --runghc-options OPTS
13105 give extra options to runghc
13106 --strip-options OPTS
13108 give extra options to strip
13109 --tar-options OPTS
13111 give extra options to tar
13112 --uhc-options OPTS
13114 give extra options to uhc
13115 --cabal-lib-version VERSION
13117 Select which version of the Cabal lib to use to build
13118 packages (useful for testing).
13119 --constraint CONSTRAINT
13121 Specify constraints on a package (version, in‐
13122 stalled/source, flags)
13123 --preference CONSTRAINT
13125 Specify preferences (soft constraints) on the version of
13126 a package
13127 --solver SOLVER
13129 Select dependency solver to use (default: modular).
13130 Choices: modular.
13131 --allow-older [DEPS]
13133 Ignore lower bounds in all dependencies or DEPS
13134 --allow-newer [DEPS]
13136 Ignore upper bounds in all dependencies or DEPS
13137 --write-ghc-environment-files always|never|ghc8.4.4+
13139 Whether to create a .ghc.environment file after a suc‐
13140 cessful build (v2-build only)
13141 --enable-documentation
13143 --disable-documentation
13144 building of documentation
13145 --doc-index-file TEMPLATE
13147 A central index of haddock API documentation (template
13148 cannot use $pkgid)
13149 --dry-run
13151 Do not install anything, only print what would be in‐
13152 stalled.
13153 --max-backjumps NUM
13155 Maximum number of backjumps allowed while solving (de‐
13156 fault: 4000). Use a negative number to enable unlimited
13157 backtracking. Use 0 to disable backtracking completely.
13158 --reorder-goals
13160 --no-reorder-goals
13161 Try to reorder goals according to certain heuristics.
13162 Slows things down on average, but may make backtracking
13163 faster for some packages.
13164 --count-conflicts
13166 --no-count-conflicts
13167 Try to speed up solving by preferring goals that are in‐
13168 volved in a lot of conflicts (default).
13169 --fine-grained-conflicts
13171 --no-fine-grained-conflicts
13172 Skip a version of a package if it does not resolve the
13173 conflicts encountered in the last version, as a solver
13174 optimization (default).
13175 --minimize-conflict-set
13177 --no-minimize-conflict-set
13178 When there is no solution, try to improve the error mes‐
13179 sage by finding a minimal conflict set (default: false).
13180 May increase run time significantly.
13181 --independent-goals
13183 --no-independent-goals
13184 Treat several goals on the command line as independent.
13185 If several goals depend on the same package, different
13186 versions can be chosen.
13187 --shadow-installed-packages
13189 --no-shadow-installed-packages
13190 If multiple package instances of the same version are in‐
13191 stalled, treat all but one as shadowed.
13192 --strong-flags
13194 --no-strong-flags
13195 Do not defer flag choices (this used to be the default in
13196 cabal-install <= 1.20).
13197 --allow-boot-library-installs
13199 --no-allow-boot-library-installs
13200 Allow cabal to install base, ghc-prim, integer-simple,
13201 integer-gmp, and template-haskell.
13202 --reject-unconstrained-dependencies none|all
13204 Require these packages to have constraints on them if
13205 they are to be selected (default: none).
13206 --reinstall
13208 --no-reinstall
13209 Install even if it means installing the same version
13210 again.
13211 --avoid-reinstalls
13213 --no-avoid-reinstalls
13214 Do not select versions that would destructively overwrite
13215 installed packages.
13216 --force-reinstalls
13218 --no-force-reinstalls
13219 Reinstall packages even if they will most likely break
13220 other installed packages.
13221 --upgrade-dependencies
13223 --no-upgrade-dependencies
13224 Pick the latest version for all dependencies, rather than
13225 trying to pick an installed version.
13226 --only-dependencies
13228 --no-only-dependencies
13229 Install only the dependencies necessary to build the
13230 given packages
13231 --dependencies-only
13233 --no-dependencies-only
13234 A synonym for --only-dependencies
13235 --index-state STATE
13237 Use source package index state as it existed at a previ‐
13238 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
13239 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
13240 'HEAD' (default: 'HEAD').
13241 --root-cmd COMMAND
13243 (No longer supported, do not use.)
13244 --symlink-bindir DIR
13246 Add symlinks to installed executables into this direc‐
13247 tory.
13248 --build-summary TEMPLATE
13250 Save build summaries to file (name template can use
13251 $pkgid, $compiler, $os, $arch)
13252 --build-log TEMPLATE
13254 Log all builds to file (name template can use $pkgid,
13255 $compiler, $os, $arch)
13256 --remote-build-reporting LEVEL
13258 Generate build reports to send to a remote server (none,
13259 anonymous or detailed).
13260 --report-planning-failure
13262 Generate build reports when the dependency solver fails.
13263 This is used by the Hackage build bot.
13264 --enable-per-component
13266 --disable-per-component
13267 Per-component builds when possible
13268 --one-shot
13270 --no-one-shot
13271 Do not record the packages in the world file.
13272 --run-tests
13274 Run package test suites during installation.
13275 -j, --jobs [NUM]
13277 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
13278 given).
13279 --keep-going
13281 After a build failure, continue to build other unaffected
13282 packages.
13283 --offline
13285 --no-offline
13286 Don't download packages from the Internet.
13287 --project-file FILE
13289 Set the name of the cabal.project file to search for in
13290 parent directories
13291 --only
13293 Only installs the package in the current directory.
13294 --haddock-hoogle
13296 Generate a hoogle database
13297 --haddock-html
13299 Generate HTML documentation (the default)
13300 --haddock-html-location URL
13302 Location of HTML documentation for pre-requisite packages
13303 --haddock-for-hackage
13305 Collection of flags to generate documentation suitable
13306 for upload to hackage
13307 --haddock-executables
13309 Run haddock for Executables targets
13310 --haddock-tests
13312 Run haddock for Test Suite targets
13313 --haddock-benchmarks
13315 Run haddock for Benchmark targets
13316 --haddock-all
13318 Run haddock for all targets
13319 --haddock-internal
13321 Run haddock for internal modules and include all symbols
13322 --haddock-css PATH
13324 Use PATH as the haddock stylesheet
13325 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
13327 dock-hyperlinked-source
13328 Hyperlink the documentation to the source code
13329 --haddock-quickjump
13331 Generate an index for interactive documentation naviga‐
13332 tion
13333 --haddock-hscolour-css PATH
13335 Use PATH as the HsColour stylesheet
13336 --haddock-contents-location URL
13338 Bake URL in as the location for the contents page
13339 --test-log TEMPLATE
13341 Log all test suite results to file (name template can use
13342 $pkgid, $compiler, $os, $arch, $test-suite, $result)
13343 --test-machine-log TEMPLATE
13345 Produce a machine-readable log file (name template can
13346 use $pkgid, $compiler, $os, $arch, $result)
13347 --test-show-details FILTER
13349 --test-keep-tix-files
13351 keep .tix files for HPC between test runs
13352 --test-wrapper FILE
13354 Run test through a wrapper.
13355 --test-fail-when-no-test-suites
13357 Exit with failure when no test suites are found.
13358 --test-options TEMPLATES
13360 give extra options to test executables (name templates
13361 can use $pkgid, $compiler, $os, $arch, $test-suite)
13362 --test-option TEMPLATE
13364 give extra option to test executables (no need to quote
13365 options containing spaces, name template can use $pkgid,
13366 $compiler, $os, $arch, $test-suite)
13367 --benchmark-options TEMPLATES
13369 give extra options to benchmark executables (name tem‐
13370 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
13371 --benchmark-option TEMPLATE
13373 give extra option to benchmark executables (no need to
13374 quote options containing spaces, name template can use
13375 $pkgid, $compiler, $os, $arch, $benchmark)
13376 cabal new-haddock
13379 Usage: cabal new-haddock [FLAGS] TARGET
13381 Build Haddock documentation for the specified packages within the
13384 project.
13385 Any package in the project can be specified. If no package is speci‐
13387 fied, the default is to build the documentation for the package in the
13388 current directory. The default behaviour is to build documentation for
13389 the exposed modules of the library component (if any). This can be
13390 changed with the
13391 Currently, documentation for dependencies is NOT built. This behavior
13393 may change in future.
13394 Additional configuration flags can be specified on the command line and
13396 these extend the project configuration from the 'cabal.project',
13397 Build Haddock documentation for the specified packages within the
13400 project.
13401 Any package in the project can be specified. If no package is speci‐
13403 fied, the default is to build the documentation for the package in the
13404 current directory. The default behaviour is to build documentation for
13405 the exposed modules of the library component (if any). This can be
13406 changed with the
13407 Currently, documentation for dependencies is NOT built. This behavior
13409 may change in future.
13410 Additional configuration flags can be specified on the command line and
13412 these extend the project configuration from the 'cabal.project',
13413 Flags:
13416 -v, --verbose [n]
13417 Control verbosity (n is 0--3, default verbosity level is
13418 1)
13419 --builddir, --distdir, --distpref DIR
13421 The directory where Cabal puts generated build files (de‐
13422 fault dist)
13423 -g, --ghc
13425 compile with GHC
13426 --ghcjs
13428 compile with GHCJS
13429 --uhc
13431 compile with UHC
13432 --haskell-suite
13434 compile with a haskell-suite compiler
13435 --cabal-file PATH
13437 use this Cabal file
13438 -w, --with-compiler PATH
13440 give the path to a particular compiler
13441 --with-hc-pkg PATH
13443 give the path to the package tool
13444 --prefix DIR
13446 bake this prefix in preparation of installation
13447 --bindir DIR
13449 installation directory for executables
13450 --libdir DIR
13452 installation directory for libraries
13453 --libsubdir DIR
13455 subdirectory of libdir in which libs are installed
13456 --dynlibdir DIR
13458 installation directory for dynamic libraries
13459 --libexecdir DIR
13461 installation directory for program executables
13462 --libexecsubdir DIR
13464 subdirectory of libexecdir in which private executables
13465 are installed
13466 --datadir DIR
13468 installation directory for read-only data
13469 --datasubdir DIR
13471 subdirectory of datadir in which data files are installed
13472 --docdir DIR
13474 installation directory for documentation
13475 --htmldir DIR
13477 installation directory for HTML documentation
13478 --haddockdir DIR
13480 installation directory for haddock interfaces
13481 --sysconfdir DIR
13483 installation directory for configuration files
13484 --program-prefix PREFIX
13486 prefix to be applied to installed executables
13487 --program-suffix SUFFIX
13489 suffix to be applied to installed executables
13490 --enable-library-vanilla
13492 --disable-library-vanilla
13493 Vanilla libraries
13494 -p, --enable-library-profiling
13496 --disable-library-profiling
13497 Library profiling
13498 --enable-shared
13500 --disable-shared
13501 Shared library
13502 --enable-static
13504 --disable-static
13505 Static library
13506 --enable-executable-dynamic
13508 --disable-executable-dynamic
13509 Executable dynamic linking
13510 --enable-executable-static
13512 --disable-executable-static
13513 Executable fully static linking
13514 --enable-profiling
13516 --disable-profiling
13517 Executable and library profiling
13518 --enable-executable-profiling
13520 --disable-executable-profiling
13521 Executable profiling (DEPRECATED)
13522 --profiling-detail level
13524 Profiling detail level for executable and library (de‐
13525 fault, none, exported-functions, toplevel-functions,
13526 all-functions).
13527 --library-profiling-detail level
13529 Profiling detail level for libraries only.
13530 -O, --enable-optimization, --enable-optimisation [n]
13532 Build with optimization (n is 0--2, default is 1)
13533 --disable-optimization, --disable-optimisation
13535 Build without optimization
13536 --enable-debug-info [n]
13538 Emit debug info (n is 0--3, default is 0)
13539 --disable-debug-info
13541 Don't emit debug info
13542 --enable-library-for-ghci
13544 --disable-library-for-ghci
13545 compile library for use with GHCi
13546 --enable-split-sections
13548 --disable-split-sections
13549 compile library code such that unneeded definitions can
13550 be dropped from the final executable (GHC 7.8+)
13551 --enable-split-objs
13553 --disable-split-objs
13554 split library into smaller objects to reduce binary sizes
13555 (GHC 6.6+)
13556 --enable-executable-stripping
13558 --disable-executable-stripping
13559 strip executables upon installation to reduce binary
13560 sizes
13561 --enable-library-stripping
13563 --disable-library-stripping
13564 strip libraries upon installation to reduce binary sizes
13565 --configure-option OPT
13567 Extra option for configure
13568 --user
13570 --global
13571 doing a per-user installation
13572 --package-db DB
13574 Append the given package database to the list of package
13575 databases used (to satisfy dependencies and register
13576 into). May be a specific file, 'global' or 'user'. The
13577 initial list is ['global'], ['global', 'user'], or
13578 ['global', $sandbox], depending on context. Use 'clear'
13579 to reset the list to empty. See the user guide for de‐
13580 tails.
13581 -f, --flags FLAGS
13583 Force values for the given flags in Cabal conditionals in
13584 the .cabal file. E.g., --flags="debug -usebytestrings"
13585 forces the flag "debug" to true and "usebytestrings" to
13586 false.
13587 --extra-include-dirs PATH
13589 A list of directories to search for header files
13590 --enable-deterministic
13592 --disable-deterministic
13593 Try to be as deterministic as possible (used by the test
13594 suite)
13595 --ipid IPID
13597 Installed package ID to compile this package as
13598 --cid CID
13600 Installed component ID to compile this component as
13601 --extra-lib-dirs PATH
13603 A list of directories to search for external libraries
13604 --extra-framework-dirs PATH
13606 A list of directories to search for external frameworks
13607 (OS X only)
13608 --extra-prog-path PATH
13610 A list of directories to search for required programs (in
13611 addition to the normal search locations)
13612 --instantiate-with NAME=MOD
13614 A mapping of signature names to concrete module instanti‐
13615 ations.
13616 --enable-tests
13618 --disable-tests
13619 dependency checking and compilation for test suites
13620 listed in the package description file.
13621 --enable-coverage
13623 --disable-coverage
13624 build package with Haskell Program Coverage. (GHC only)
13625 --enable-library-coverage
13627 --disable-library-coverage
13628 build package with Haskell Program Coverage. (GHC only)
13629 (DEPRECATED)
13630 --enable-benchmarks
13632 --disable-benchmarks
13633 dependency checking and compilation for benchmarks listed
13634 in the package description file.
13635 --enable-relocatable
13637 --disable-relocatable
13638 building a package that is relocatable. (GHC only)
13639 --disable-response-files
13641 enable workaround for old versions of programs like "ar"
13642 that do not support @file arguments
13643 --allow-depending-on-private-libs
13645 Allow depending on private libraries. If set, the library
13646 visibility check MUST be done externally.
13647 --with-alex PATH
13649 give the path to alex
13650 --with-ar PATH
13652 give the path to ar
13653 --with-c2hs PATH
13655 give the path to c2hs
13656 --with-cpphs PATH
13658 give the path to cpphs
13659 --with-doctest PATH
13661 give the path to doctest
13662 --with-gcc PATH
13664 give the path to gcc
13665 --with-ghc PATH
13667 give the path to ghc
13668 --with-ghc-pkg PATH
13670 give the path to ghc-pkg
13671 --with-ghcjs PATH
13673 give the path to ghcjs
13674 --with-ghcjs-pkg PATH
13676 give the path to ghcjs-pkg
13677 --with-greencard PATH
13679 give the path to greencard
13680 --with-haddock PATH
13682 give the path to haddock
13683 --with-happy PATH
13685 give the path to happy
13686 --with-haskell-suite PATH
13688 give the path to haskell-suite
13689 --with-haskell-suite-pkg PATH
13691 give the path to haskell-suite-pkg
13692 --with-hmake PATH
13694 give the path to hmake
13695 --with-hpc PATH
13697 give the path to hpc
13698 --with-hsc2hs PATH
13700 give the path to hsc2hs
13701 --with-hscolour PATH
13703 give the path to hscolour
13704 --with-jhc PATH
13706 give the path to jhc
13707 --with-ld PATH
13709 give the path to ld
13710 --with-pkg-config PATH
13712 give the path to pkg-config
13713 --with-runghc PATH
13715 give the path to runghc
13716 --with-strip PATH
13718 give the path to strip
13719 --with-tar PATH
13721 give the path to tar
13722 --with-uhc PATH
13724 give the path to uhc
13725 --alex-option OPT
13727 give an extra option to alex (no need to quote options
13728 containing spaces)
13729 --ar-option OPT
13731 give an extra option to ar (no need to quote options con‐
13732 taining spaces)
13733 --c2hs-option OPT
13735 give an extra option to c2hs (no need to quote options
13736 containing spaces)
13737 --cpphs-option OPT
13739 give an extra option to cpphs (no need to quote options
13740 containing spaces)
13741 --doctest-option OPT
13743 give an extra option to doctest (no need to quote options
13744 containing spaces)
13745 --gcc-option OPT
13747 give an extra option to gcc (no need to quote options
13748 containing spaces)
13749 --ghc-option OPT
13751 give an extra option to ghc (no need to quote options
13752 containing spaces)
13753 --ghc-pkg-option OPT
13755 give an extra option to ghc-pkg (no need to quote options
13756 containing spaces)
13757 --ghcjs-option OPT
13759 give an extra option to ghcjs (no need to quote options
13760 containing spaces)
13761 --ghcjs-pkg-option OPT
13763 give an extra option to ghcjs-pkg (no need to quote op‐
13764 tions containing spaces)
13765 --greencard-option OPT
13767 give an extra option to greencard (no need to quote op‐
13768 tions containing spaces)
13769 --haddock-option OPT
13771 give an extra option to haddock (no need to quote options
13772 containing spaces)
13773 --happy-option OPT
13775 give an extra option to happy (no need to quote options
13776 containing spaces)
13777 --haskell-suite-option OPT
13779 give an extra option to haskell-suite (no need to quote
13780 options containing spaces)
13781 --haskell-suite-pkg-option OPT
13783 give an extra option to haskell-suite-pkg (no need to
13784 quote options containing spaces)
13785 --hmake-option OPT
13787 give an extra option to hmake (no need to quote options
13788 containing spaces)
13789 --hpc-option OPT
13791 give an extra option to hpc (no need to quote options
13792 containing spaces)
13793 --hsc2hs-option OPT
13795 give an extra option to hsc2hs (no need to quote options
13796 containing spaces)
13797 --hscolour-option OPT
13799 give an extra option to hscolour (no need to quote op‐
13800 tions containing spaces)
13801 --jhc-option OPT
13803 give an extra option to jhc (no need to quote options
13804 containing spaces)
13805 --ld-option OPT
13807 give an extra option to ld (no need to quote options con‐
13808 taining spaces)
13809 --pkg-config-option OPT
13811 give an extra option to pkg-config (no need to quote op‐
13812 tions containing spaces)
13813 --runghc-option OPT
13815 give an extra option to runghc (no need to quote options
13816 containing spaces)
13817 --strip-option OPT
13819 give an extra option to strip (no need to quote options
13820 containing spaces)
13821 --tar-option OPT
13823 give an extra option to tar (no need to quote options
13824 containing spaces)
13825 --uhc-option OPT
13827 give an extra option to uhc (no need to quote options
13828 containing spaces)
13829 --alex-options OPTS
13831 give extra options to alex
13832 --ar-options OPTS
13834 give extra options to ar
13835 --c2hs-options OPTS
13837 give extra options to c2hs
13838 --cpphs-options OPTS
13840 give extra options to cpphs
13841 --doctest-options OPTS
13843 give extra options to doctest
13844 --gcc-options OPTS
13846 give extra options to gcc
13847 --ghc-options OPTS
13849 give extra options to ghc
13850 --ghc-pkg-options OPTS
13852 give extra options to ghc-pkg
13853 --ghcjs-options OPTS
13855 give extra options to ghcjs
13856 --ghcjs-pkg-options OPTS
13858 give extra options to ghcjs-pkg
13859 --greencard-options OPTS
13861 give extra options to greencard
13862 --haddock-options OPTS
13864 give extra options to haddock
13865 --happy-options OPTS
13867 give extra options to happy
13868 --haskell-suite-options OPTS
13870 give extra options to haskell-suite
13871 --haskell-suite-pkg-options OPTS
13873 give extra options to haskell-suite-pkg
13874 --hmake-options OPTS
13876 give extra options to hmake
13877 --hpc-options OPTS
13879 give extra options to hpc
13880 --hsc2hs-options OPTS
13882 give extra options to hsc2hs
13883 --hscolour-options OPTS
13885 give extra options to hscolour
13886 --jhc-options OPTS
13888 give extra options to jhc
13889 --ld-options OPTS
13891 give extra options to ld
13892 --pkg-config-options OPTS
13894 give extra options to pkg-config
13895 --runghc-options OPTS
13897 give extra options to runghc
13898 --strip-options OPTS
13900 give extra options to strip
13901 --tar-options OPTS
13903 give extra options to tar
13904 --uhc-options OPTS
13906 give extra options to uhc
13907 --cabal-lib-version VERSION
13909 Select which version of the Cabal lib to use to build
13910 packages (useful for testing).
13911 --constraint CONSTRAINT
13913 Specify constraints on a package (version, in‐
13914 stalled/source, flags)
13915 --preference CONSTRAINT
13917 Specify preferences (soft constraints) on the version of
13918 a package
13919 --solver SOLVER
13921 Select dependency solver to use (default: modular).
13922 Choices: modular.
13923 --allow-older [DEPS]
13925 Ignore lower bounds in all dependencies or DEPS
13926 --allow-newer [DEPS]
13928 Ignore upper bounds in all dependencies or DEPS
13929 --write-ghc-environment-files always|never|ghc8.4.4+
13931 Whether to create a .ghc.environment file after a suc‐
13932 cessful build (v2-build only)
13933 --enable-documentation
13935 --disable-documentation
13936 building of documentation
13937 --doc-index-file TEMPLATE
13939 A central index of haddock API documentation (template
13940 cannot use $pkgid)
13941 --dry-run
13943 Do not install anything, only print what would be in‐
13944 stalled.
13945 --max-backjumps NUM
13947 Maximum number of backjumps allowed while solving (de‐
13948 fault: 4000). Use a negative number to enable unlimited
13949 backtracking. Use 0 to disable backtracking completely.
13950 --reorder-goals
13952 --no-reorder-goals
13953 Try to reorder goals according to certain heuristics.
13954 Slows things down on average, but may make backtracking
13955 faster for some packages.
13956 --count-conflicts
13958 --no-count-conflicts
13959 Try to speed up solving by preferring goals that are in‐
13960 volved in a lot of conflicts (default).
13961 --fine-grained-conflicts
13963 --no-fine-grained-conflicts
13964 Skip a version of a package if it does not resolve the
13965 conflicts encountered in the last version, as a solver
13966 optimization (default).
13967 --minimize-conflict-set
13969 --no-minimize-conflict-set
13970 When there is no solution, try to improve the error mes‐
13971 sage by finding a minimal conflict set (default: false).
13972 May increase run time significantly.
13973 --independent-goals
13975 --no-independent-goals
13976 Treat several goals on the command line as independent.
13977 If several goals depend on the same package, different
13978 versions can be chosen.
13979 --shadow-installed-packages
13981 --no-shadow-installed-packages
13982 If multiple package instances of the same version are in‐
13983 stalled, treat all but one as shadowed.
13984 --strong-flags
13986 --no-strong-flags
13987 Do not defer flag choices (this used to be the default in
13988 cabal-install <= 1.20).
13989 --allow-boot-library-installs
13991 --no-allow-boot-library-installs
13992 Allow cabal to install base, ghc-prim, integer-simple,
13993 integer-gmp, and template-haskell.
13994 --reject-unconstrained-dependencies none|all
13996 Require these packages to have constraints on them if
13997 they are to be selected (default: none).
13998 --reinstall
14000 --no-reinstall
14001 Install even if it means installing the same version
14002 again.
14003 --avoid-reinstalls
14005 --no-avoid-reinstalls
14006 Do not select versions that would destructively overwrite
14007 installed packages.
14008 --force-reinstalls
14010 --no-force-reinstalls
14011 Reinstall packages even if they will most likely break
14012 other installed packages.
14013 --upgrade-dependencies
14015 --no-upgrade-dependencies
14016 Pick the latest version for all dependencies, rather than
14017 trying to pick an installed version.
14018 --only-dependencies
14020 --no-only-dependencies
14021 Install only the dependencies necessary to build the
14022 given packages
14023 --dependencies-only
14025 --no-dependencies-only
14026 A synonym for --only-dependencies
14027 --index-state STATE
14029 Use source package index state as it existed at a previ‐
14030 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
14031 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
14032 'HEAD' (default: 'HEAD').
14033 --root-cmd COMMAND
14035 (No longer supported, do not use.)
14036 --symlink-bindir DIR
14038 Add symlinks to installed executables into this direc‐
14039 tory.
14040 --build-summary TEMPLATE
14042 Save build summaries to file (name template can use
14043 $pkgid, $compiler, $os, $arch)
14044 --build-log TEMPLATE
14046 Log all builds to file (name template can use $pkgid,
14047 $compiler, $os, $arch)
14048 --remote-build-reporting LEVEL
14050 Generate build reports to send to a remote server (none,
14051 anonymous or detailed).
14052 --report-planning-failure
14054 Generate build reports when the dependency solver fails.
14055 This is used by the Hackage build bot.
14056 --enable-per-component
14058 --disable-per-component
14059 Per-component builds when possible
14060 --one-shot
14062 --no-one-shot
14063 Do not record the packages in the world file.
14064 --run-tests
14066 Run package test suites during installation.
14067 -j, --jobs [NUM]
14069 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
14070 given).
14071 --keep-going
14073 After a build failure, continue to build other unaffected
14074 packages.
14075 --offline
14077 --no-offline
14078 Don't download packages from the Internet.
14079 --project-file FILE
14081 Set the name of the cabal.project file to search for in
14082 parent directories
14083 --only
14085 Only installs the package in the current directory.
14086 --haddock-hoogle
14088 Generate a hoogle database
14089 --haddock-html
14091 Generate HTML documentation (the default)
14092 --haddock-html-location URL
14094 Location of HTML documentation for pre-requisite packages
14095 --haddock-for-hackage
14097 Collection of flags to generate documentation suitable
14098 for upload to hackage
14099 --haddock-executables
14101 Run haddock for Executables targets
14102 --haddock-tests
14104 Run haddock for Test Suite targets
14105 --haddock-benchmarks
14107 Run haddock for Benchmark targets
14108 --haddock-all
14110 Run haddock for all targets
14111 --haddock-internal
14113 Run haddock for internal modules and include all symbols
14114 --haddock-css PATH
14116 Use PATH as the haddock stylesheet
14117 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
14119 dock-hyperlinked-source
14120 Hyperlink the documentation to the source code
14121 --haddock-quickjump
14123 Generate an index for interactive documentation naviga‐
14124 tion
14125 --haddock-hscolour-css PATH
14127 Use PATH as the HsColour stylesheet
14128 --haddock-contents-location URL
14130 Bake URL in as the location for the contents page
14131 --test-log TEMPLATE
14133 Log all test suite results to file (name template can use
14134 $pkgid, $compiler, $os, $arch, $test-suite, $result)
14135 --test-machine-log TEMPLATE
14137 Produce a machine-readable log file (name template can
14138 use $pkgid, $compiler, $os, $arch, $result)
14139 --test-show-details FILTER
14141 --test-keep-tix-files
14143 keep .tix files for HPC between test runs
14144 --test-wrapper FILE
14146 Run test through a wrapper.
14147 --test-fail-when-no-test-suites
14149 Exit with failure when no test suites are found.
14150 --test-options TEMPLATES
14152 give extra options to test executables (name templates
14153 can use $pkgid, $compiler, $os, $arch, $test-suite)
14154 --test-option TEMPLATE
14156 give extra option to test executables (no need to quote
14157 options containing spaces, name template can use $pkgid,
14158 $compiler, $os, $arch, $test-suite)
14159 --benchmark-options TEMPLATES
14161 give extra options to benchmark executables (name tem‐
14162 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
14163 --benchmark-option TEMPLATE
14165 give extra option to benchmark executables (no need to
14166 quote options containing spaces, name template can use
14167 $pkgid, $compiler, $os, $arch, $benchmark)
14168 cabal v2-haddock
14171 Usage: cabal v2-haddock [FLAGS] TARGET
14173 Build Haddock documentation for the specified packages within the
14176 project.
14177 Any package in the project can be specified. If no package is speci‐
14179 fied, the default is to build the documentation for the package in the
14180 current directory. The default behaviour is to build documentation for
14181 the exposed modules of the library component (if any). This can be
14182 changed with the
14183 Currently, documentation for dependencies is NOT built. This behavior
14185 may change in future.
14186 Additional configuration flags can be specified on the command line and
14188 these extend the project configuration from the 'cabal.project',
14189 Examples:
14192 cabal v2-haddock pkgname Build documentation for the package named
14193 pkgname
14194 Note: this command is part of the new project-based system (aka nix-
14196 style local builds). These features are currently in beta. Please see
14197 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
14198 details and advice on what you can expect to work. If you encounter
14199 problems please file issues at https://github.com/haskell/cabal/issues
14200 and if you have any time to get involved and help with testing, fixing
14201 bugs etc then that is very much appreciated.
14202 Flags:
14205 -v, --verbose [n]
14206 Control verbosity (n is 0--3, default verbosity level is
14207 1)
14208 --builddir, --distdir, --distpref DIR
14210 The directory where Cabal puts generated build files (de‐
14211 fault dist)
14212 -g, --ghc
14214 compile with GHC
14215 --ghcjs
14217 compile with GHCJS
14218 --uhc
14220 compile with UHC
14221 --haskell-suite
14223 compile with a haskell-suite compiler
14224 --cabal-file PATH
14226 use this Cabal file
14227 -w, --with-compiler PATH
14229 give the path to a particular compiler
14230 --with-hc-pkg PATH
14232 give the path to the package tool
14233 --prefix DIR
14235 bake this prefix in preparation of installation
14236 --bindir DIR
14238 installation directory for executables
14239 --libdir DIR
14241 installation directory for libraries
14242 --libsubdir DIR
14244 subdirectory of libdir in which libs are installed
14245 --dynlibdir DIR
14247 installation directory for dynamic libraries
14248 --libexecdir DIR
14250 installation directory for program executables
14251 --libexecsubdir DIR
14253 subdirectory of libexecdir in which private executables
14254 are installed
14255 --datadir DIR
14257 installation directory for read-only data
14258 --datasubdir DIR
14260 subdirectory of datadir in which data files are installed
14261 --docdir DIR
14263 installation directory for documentation
14264 --htmldir DIR
14266 installation directory for HTML documentation
14267 --haddockdir DIR
14269 installation directory for haddock interfaces
14270 --sysconfdir DIR
14272 installation directory for configuration files
14273 --program-prefix PREFIX
14275 prefix to be applied to installed executables
14276 --program-suffix SUFFIX
14278 suffix to be applied to installed executables
14279 --enable-library-vanilla
14281 --disable-library-vanilla
14282 Vanilla libraries
14283 -p, --enable-library-profiling
14285 --disable-library-profiling
14286 Library profiling
14287 --enable-shared
14289 --disable-shared
14290 Shared library
14291 --enable-static
14293 --disable-static
14294 Static library
14295 --enable-executable-dynamic
14297 --disable-executable-dynamic
14298 Executable dynamic linking
14299 --enable-executable-static
14301 --disable-executable-static
14302 Executable fully static linking
14303 --enable-profiling
14305 --disable-profiling
14306 Executable and library profiling
14307 --enable-executable-profiling
14309 --disable-executable-profiling
14310 Executable profiling (DEPRECATED)
14311 --profiling-detail level
14313 Profiling detail level for executable and library (de‐
14314 fault, none, exported-functions, toplevel-functions,
14315 all-functions).
14316 --library-profiling-detail level
14318 Profiling detail level for libraries only.
14319 -O, --enable-optimization, --enable-optimisation [n]
14321 Build with optimization (n is 0--2, default is 1)
14322 --disable-optimization, --disable-optimisation
14324 Build without optimization
14325 --enable-debug-info [n]
14327 Emit debug info (n is 0--3, default is 0)
14328 --disable-debug-info
14330 Don't emit debug info
14331 --enable-library-for-ghci
14333 --disable-library-for-ghci
14334 compile library for use with GHCi
14335 --enable-split-sections
14337 --disable-split-sections
14338 compile library code such that unneeded definitions can
14339 be dropped from the final executable (GHC 7.8+)
14340 --enable-split-objs
14342 --disable-split-objs
14343 split library into smaller objects to reduce binary sizes
14344 (GHC 6.6+)
14345 --enable-executable-stripping
14347 --disable-executable-stripping
14348 strip executables upon installation to reduce binary
14349 sizes
14350 --enable-library-stripping
14352 --disable-library-stripping
14353 strip libraries upon installation to reduce binary sizes
14354 --configure-option OPT
14356 Extra option for configure
14357 --user
14359 --global
14360 doing a per-user installation
14361 --package-db DB
14363 Append the given package database to the list of package
14364 databases used (to satisfy dependencies and register
14365 into). May be a specific file, 'global' or 'user'. The
14366 initial list is ['global'], ['global', 'user'], or
14367 ['global', $sandbox], depending on context. Use 'clear'
14368 to reset the list to empty. See the user guide for de‐
14369 tails.
14370 -f, --flags FLAGS
14372 Force values for the given flags in Cabal conditionals in
14373 the .cabal file. E.g., --flags="debug -usebytestrings"
14374 forces the flag "debug" to true and "usebytestrings" to
14375 false.
14376 --extra-include-dirs PATH
14378 A list of directories to search for header files
14379 --enable-deterministic
14381 --disable-deterministic
14382 Try to be as deterministic as possible (used by the test
14383 suite)
14384 --ipid IPID
14386 Installed package ID to compile this package as
14387 --cid CID
14389 Installed component ID to compile this component as
14390 --extra-lib-dirs PATH
14392 A list of directories to search for external libraries
14393 --extra-framework-dirs PATH
14395 A list of directories to search for external frameworks
14396 (OS X only)
14397 --extra-prog-path PATH
14399 A list of directories to search for required programs (in
14400 addition to the normal search locations)
14401 --instantiate-with NAME=MOD
14403 A mapping of signature names to concrete module instanti‐
14404 ations.
14405 --enable-tests
14407 --disable-tests
14408 dependency checking and compilation for test suites
14409 listed in the package description file.
14410 --enable-coverage
14412 --disable-coverage
14413 build package with Haskell Program Coverage. (GHC only)
14414 --enable-library-coverage
14416 --disable-library-coverage
14417 build package with Haskell Program Coverage. (GHC only)
14418 (DEPRECATED)
14419 --enable-benchmarks
14421 --disable-benchmarks
14422 dependency checking and compilation for benchmarks listed
14423 in the package description file.
14424 --enable-relocatable
14426 --disable-relocatable
14427 building a package that is relocatable. (GHC only)
14428 --disable-response-files
14430 enable workaround for old versions of programs like "ar"
14431 that do not support @file arguments
14432 --allow-depending-on-private-libs
14434 Allow depending on private libraries. If set, the library
14435 visibility check MUST be done externally.
14436 --with-alex PATH
14438 give the path to alex
14439 --with-ar PATH
14441 give the path to ar
14442 --with-c2hs PATH
14444 give the path to c2hs
14445 --with-cpphs PATH
14447 give the path to cpphs
14448 --with-doctest PATH
14450 give the path to doctest
14451 --with-gcc PATH
14453 give the path to gcc
14454 --with-ghc PATH
14456 give the path to ghc
14457 --with-ghc-pkg PATH
14459 give the path to ghc-pkg
14460 --with-ghcjs PATH
14462 give the path to ghcjs
14463 --with-ghcjs-pkg PATH
14465 give the path to ghcjs-pkg
14466 --with-greencard PATH
14468 give the path to greencard
14469 --with-haddock PATH
14471 give the path to haddock
14472 --with-happy PATH
14474 give the path to happy
14475 --with-haskell-suite PATH
14477 give the path to haskell-suite
14478 --with-haskell-suite-pkg PATH
14480 give the path to haskell-suite-pkg
14481 --with-hmake PATH
14483 give the path to hmake
14484 --with-hpc PATH
14486 give the path to hpc
14487 --with-hsc2hs PATH
14489 give the path to hsc2hs
14490 --with-hscolour PATH
14492 give the path to hscolour
14493 --with-jhc PATH
14495 give the path to jhc
14496 --with-ld PATH
14498 give the path to ld
14499 --with-pkg-config PATH
14501 give the path to pkg-config
14502 --with-runghc PATH
14504 give the path to runghc
14505 --with-strip PATH
14507 give the path to strip
14508 --with-tar PATH
14510 give the path to tar
14511 --with-uhc PATH
14513 give the path to uhc
14514 --alex-option OPT
14516 give an extra option to alex (no need to quote options
14517 containing spaces)
14518 --ar-option OPT
14520 give an extra option to ar (no need to quote options con‐
14521 taining spaces)
14522 --c2hs-option OPT
14524 give an extra option to c2hs (no need to quote options
14525 containing spaces)
14526 --cpphs-option OPT
14528 give an extra option to cpphs (no need to quote options
14529 containing spaces)
14530 --doctest-option OPT
14532 give an extra option to doctest (no need to quote options
14533 containing spaces)
14534 --gcc-option OPT
14536 give an extra option to gcc (no need to quote options
14537 containing spaces)
14538 --ghc-option OPT
14540 give an extra option to ghc (no need to quote options
14541 containing spaces)
14542 --ghc-pkg-option OPT
14544 give an extra option to ghc-pkg (no need to quote options
14545 containing spaces)
14546 --ghcjs-option OPT
14548 give an extra option to ghcjs (no need to quote options
14549 containing spaces)
14550 --ghcjs-pkg-option OPT
14552 give an extra option to ghcjs-pkg (no need to quote op‐
14553 tions containing spaces)
14554 --greencard-option OPT
14556 give an extra option to greencard (no need to quote op‐
14557 tions containing spaces)
14558 --haddock-option OPT
14560 give an extra option to haddock (no need to quote options
14561 containing spaces)
14562 --happy-option OPT
14564 give an extra option to happy (no need to quote options
14565 containing spaces)
14566 --haskell-suite-option OPT
14568 give an extra option to haskell-suite (no need to quote
14569 options containing spaces)
14570 --haskell-suite-pkg-option OPT
14572 give an extra option to haskell-suite-pkg (no need to
14573 quote options containing spaces)
14574 --hmake-option OPT
14576 give an extra option to hmake (no need to quote options
14577 containing spaces)
14578 --hpc-option OPT
14580 give an extra option to hpc (no need to quote options
14581 containing spaces)
14582 --hsc2hs-option OPT
14584 give an extra option to hsc2hs (no need to quote options
14585 containing spaces)
14586 --hscolour-option OPT
14588 give an extra option to hscolour (no need to quote op‐
14589 tions containing spaces)
14590 --jhc-option OPT
14592 give an extra option to jhc (no need to quote options
14593 containing spaces)
14594 --ld-option OPT
14596 give an extra option to ld (no need to quote options con‐
14597 taining spaces)
14598 --pkg-config-option OPT
14600 give an extra option to pkg-config (no need to quote op‐
14601 tions containing spaces)
14602 --runghc-option OPT
14604 give an extra option to runghc (no need to quote options
14605 containing spaces)
14606 --strip-option OPT
14608 give an extra option to strip (no need to quote options
14609 containing spaces)
14610 --tar-option OPT
14612 give an extra option to tar (no need to quote options
14613 containing spaces)
14614 --uhc-option OPT
14616 give an extra option to uhc (no need to quote options
14617 containing spaces)
14618 --alex-options OPTS
14620 give extra options to alex
14621 --ar-options OPTS
14623 give extra options to ar
14624 --c2hs-options OPTS
14626 give extra options to c2hs
14627 --cpphs-options OPTS
14629 give extra options to cpphs
14630 --doctest-options OPTS
14632 give extra options to doctest
14633 --gcc-options OPTS
14635 give extra options to gcc
14636 --ghc-options OPTS
14638 give extra options to ghc
14639 --ghc-pkg-options OPTS
14641 give extra options to ghc-pkg
14642 --ghcjs-options OPTS
14644 give extra options to ghcjs
14645 --ghcjs-pkg-options OPTS
14647 give extra options to ghcjs-pkg
14648 --greencard-options OPTS
14650 give extra options to greencard
14651 --haddock-options OPTS
14653 give extra options to haddock
14654 --happy-options OPTS
14656 give extra options to happy
14657 --haskell-suite-options OPTS
14659 give extra options to haskell-suite
14660 --haskell-suite-pkg-options OPTS
14662 give extra options to haskell-suite-pkg
14663 --hmake-options OPTS
14665 give extra options to hmake
14666 --hpc-options OPTS
14668 give extra options to hpc
14669 --hsc2hs-options OPTS
14671 give extra options to hsc2hs
14672 --hscolour-options OPTS
14674 give extra options to hscolour
14675 --jhc-options OPTS
14677 give extra options to jhc
14678 --ld-options OPTS
14680 give extra options to ld
14681 --pkg-config-options OPTS
14683 give extra options to pkg-config
14684 --runghc-options OPTS
14686 give extra options to runghc
14687 --strip-options OPTS
14689 give extra options to strip
14690 --tar-options OPTS
14692 give extra options to tar
14693 --uhc-options OPTS
14695 give extra options to uhc
14696 --cabal-lib-version VERSION
14698 Select which version of the Cabal lib to use to build
14699 packages (useful for testing).
14700 --constraint CONSTRAINT
14702 Specify constraints on a package (version, in‐
14703 stalled/source, flags)
14704 --preference CONSTRAINT
14706 Specify preferences (soft constraints) on the version of
14707 a package
14708 --solver SOLVER
14710 Select dependency solver to use (default: modular).
14711 Choices: modular.
14712 --allow-older [DEPS]
14714 Ignore lower bounds in all dependencies or DEPS
14715 --allow-newer [DEPS]
14717 Ignore upper bounds in all dependencies or DEPS
14718 --write-ghc-environment-files always|never|ghc8.4.4+
14720 Whether to create a .ghc.environment file after a suc‐
14721 cessful build (v2-build only)
14722 --enable-documentation
14724 --disable-documentation
14725 building of documentation
14726 --doc-index-file TEMPLATE
14728 A central index of haddock API documentation (template
14729 cannot use $pkgid)
14730 --dry-run
14732 Do not install anything, only print what would be in‐
14733 stalled.
14734 --max-backjumps NUM
14736 Maximum number of backjumps allowed while solving (de‐
14737 fault: 4000). Use a negative number to enable unlimited
14738 backtracking. Use 0 to disable backtracking completely.
14739 --reorder-goals
14741 --no-reorder-goals
14742 Try to reorder goals according to certain heuristics.
14743 Slows things down on average, but may make backtracking
14744 faster for some packages.
14745 --count-conflicts
14747 --no-count-conflicts
14748 Try to speed up solving by preferring goals that are in‐
14749 volved in a lot of conflicts (default).
14750 --fine-grained-conflicts
14752 --no-fine-grained-conflicts
14753 Skip a version of a package if it does not resolve the
14754 conflicts encountered in the last version, as a solver
14755 optimization (default).
14756 --minimize-conflict-set
14758 --no-minimize-conflict-set
14759 When there is no solution, try to improve the error mes‐
14760 sage by finding a minimal conflict set (default: false).
14761 May increase run time significantly.
14762 --independent-goals
14764 --no-independent-goals
14765 Treat several goals on the command line as independent.
14766 If several goals depend on the same package, different
14767 versions can be chosen.
14768 --shadow-installed-packages
14770 --no-shadow-installed-packages
14771 If multiple package instances of the same version are in‐
14772 stalled, treat all but one as shadowed.
14773 --strong-flags
14775 --no-strong-flags
14776 Do not defer flag choices (this used to be the default in
14777 cabal-install <= 1.20).
14778 --allow-boot-library-installs
14780 --no-allow-boot-library-installs
14781 Allow cabal to install base, ghc-prim, integer-simple,
14782 integer-gmp, and template-haskell.
14783 --reject-unconstrained-dependencies none|all
14785 Require these packages to have constraints on them if
14786 they are to be selected (default: none).
14787 --reinstall
14789 --no-reinstall
14790 Install even if it means installing the same version
14791 again.
14792 --avoid-reinstalls
14794 --no-avoid-reinstalls
14795 Do not select versions that would destructively overwrite
14796 installed packages.
14797 --force-reinstalls
14799 --no-force-reinstalls
14800 Reinstall packages even if they will most likely break
14801 other installed packages.
14802 --upgrade-dependencies
14804 --no-upgrade-dependencies
14805 Pick the latest version for all dependencies, rather than
14806 trying to pick an installed version.
14807 --only-dependencies
14809 --no-only-dependencies
14810 Install only the dependencies necessary to build the
14811 given packages
14812 --dependencies-only
14814 --no-dependencies-only
14815 A synonym for --only-dependencies
14816 --index-state STATE
14818 Use source package index state as it existed at a previ‐
14819 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
14820 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
14821 'HEAD' (default: 'HEAD').
14822 --root-cmd COMMAND
14824 (No longer supported, do not use.)
14825 --symlink-bindir DIR
14827 Add symlinks to installed executables into this direc‐
14828 tory.
14829 --build-summary TEMPLATE
14831 Save build summaries to file (name template can use
14832 $pkgid, $compiler, $os, $arch)
14833 --build-log TEMPLATE
14835 Log all builds to file (name template can use $pkgid,
14836 $compiler, $os, $arch)
14837 --remote-build-reporting LEVEL
14839 Generate build reports to send to a remote server (none,
14840 anonymous or detailed).
14841 --report-planning-failure
14843 Generate build reports when the dependency solver fails.
14844 This is used by the Hackage build bot.
14845 --enable-per-component
14847 --disable-per-component
14848 Per-component builds when possible
14849 --one-shot
14851 --no-one-shot
14852 Do not record the packages in the world file.
14853 --run-tests
14855 Run package test suites during installation.
14856 -j, --jobs [NUM]
14858 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
14859 given).
14860 --keep-going
14862 After a build failure, continue to build other unaffected
14863 packages.
14864 --offline
14866 --no-offline
14867 Don't download packages from the Internet.
14868 --project-file FILE
14870 Set the name of the cabal.project file to search for in
14871 parent directories
14872 --only
14874 Only installs the package in the current directory.
14875 --haddock-hoogle
14877 Generate a hoogle database
14878 --haddock-html
14880 Generate HTML documentation (the default)
14881 --haddock-html-location URL
14883 Location of HTML documentation for pre-requisite packages
14884 --haddock-for-hackage
14886 Collection of flags to generate documentation suitable
14887 for upload to hackage
14888 --haddock-executables
14890 Run haddock for Executables targets
14891 --haddock-tests
14893 Run haddock for Test Suite targets
14894 --haddock-benchmarks
14896 Run haddock for Benchmark targets
14897 --haddock-all
14899 Run haddock for all targets
14900 --haddock-internal
14902 Run haddock for internal modules and include all symbols
14903 --haddock-css PATH
14905 Use PATH as the haddock stylesheet
14906 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
14908 dock-hyperlinked-source
14909 Hyperlink the documentation to the source code
14910 --haddock-quickjump
14912 Generate an index for interactive documentation naviga‐
14913 tion
14914 --haddock-hscolour-css PATH
14916 Use PATH as the HsColour stylesheet
14917 --haddock-contents-location URL
14919 Bake URL in as the location for the contents page
14920 --test-log TEMPLATE
14922 Log all test suite results to file (name template can use
14923 $pkgid, $compiler, $os, $arch, $test-suite, $result)
14924 --test-machine-log TEMPLATE
14926 Produce a machine-readable log file (name template can
14927 use $pkgid, $compiler, $os, $arch, $result)
14928 --test-show-details FILTER
14930 --test-keep-tix-files
14932 keep .tix files for HPC between test runs
14933 --test-wrapper FILE
14935 Run test through a wrapper.
14936 --test-fail-when-no-test-suites
14938 Exit with failure when no test suites are found.
14939 --test-options TEMPLATES
14941 give extra options to test executables (name templates
14942 can use $pkgid, $compiler, $os, $arch, $test-suite)
14943 --test-option TEMPLATE
14945 give extra option to test executables (no need to quote
14946 options containing spaces, name template can use $pkgid,
14947 $compiler, $os, $arch, $test-suite)
14948 --benchmark-options TEMPLATES
14950 give extra options to benchmark executables (name tem‐
14951 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
14952 --benchmark-option TEMPLATE
14954 give extra option to benchmark executables (no need to
14955 quote options containing spaces, name template can use
14956 $pkgid, $compiler, $os, $arch, $benchmark)
14957 cabal install
14960 Usage: cabal install [TARGETS] [FLAGS]
14962 Installs one or more packages. This is done by installing them in the
14965 store and symlinking/copying the executables in the directory specified
14966 by the --installdir flag (`~/.cabal/bin/` by default). If you want the
14967 installed executables to be available globally, make sure that the PATH
14968 environment variable contains that directory.
14969 If TARGET is a library, it will be added to the global environment.
14971 When doing this, cabal will try to build a plan that includes all the
14972 previously installed libraries. This is currently not implemented.
14973 Installs one or more packages. This is done by installing them in the
14976 store and symlinking/copying the executables in the directory specified
14977 by the --installdir flag (`~/.cabal/bin/` by default). If you want the
14978 installed executables to be available globally, make sure that the PATH
14979 environment variable contains that directory.
14980 If TARGET is a library, it will be added to the global environment.
14982 When doing this, cabal will try to build a plan that includes all the
14983 previously installed libraries. This is currently not implemented.
14984 Flags:
14987 -v, --verbose [n]
14988 Control verbosity (n is 0--3, default verbosity level is
14989 1)
14990 --builddir, --distdir, --distpref DIR
14992 The directory where Cabal puts generated build files (de‐
14993 fault dist)
14994 -g, --ghc
14996 compile with GHC
14997 --ghcjs
14999 compile with GHCJS
15000 --uhc
15002 compile with UHC
15003 --haskell-suite
15005 compile with a haskell-suite compiler
15006 --cabal-file PATH
15008 use this Cabal file
15009 -w, --with-compiler PATH
15011 give the path to a particular compiler
15012 --with-hc-pkg PATH
15014 give the path to the package tool
15015 --prefix DIR
15017 bake this prefix in preparation of installation
15018 --bindir DIR
15020 installation directory for executables
15021 --libdir DIR
15023 installation directory for libraries
15024 --libsubdir DIR
15026 subdirectory of libdir in which libs are installed
15027 --dynlibdir DIR
15029 installation directory for dynamic libraries
15030 --libexecdir DIR
15032 installation directory for program executables
15033 --libexecsubdir DIR
15035 subdirectory of libexecdir in which private executables
15036 are installed
15037 --datadir DIR
15039 installation directory for read-only data
15040 --datasubdir DIR
15042 subdirectory of datadir in which data files are installed
15043 --docdir DIR
15045 installation directory for documentation
15046 --htmldir DIR
15048 installation directory for HTML documentation
15049 --haddockdir DIR
15051 installation directory for haddock interfaces
15052 --sysconfdir DIR
15054 installation directory for configuration files
15055 --program-prefix PREFIX
15057 prefix to be applied to installed executables
15058 --program-suffix SUFFIX
15060 suffix to be applied to installed executables
15061 --enable-library-vanilla
15063 --disable-library-vanilla
15064 Vanilla libraries
15065 -p, --enable-library-profiling
15067 --disable-library-profiling
15068 Library profiling
15069 --enable-shared
15071 --disable-shared
15072 Shared library
15073 --enable-static
15075 --disable-static
15076 Static library
15077 --enable-executable-dynamic
15079 --disable-executable-dynamic
15080 Executable dynamic linking
15081 --enable-executable-static
15083 --disable-executable-static
15084 Executable fully static linking
15085 --enable-profiling
15087 --disable-profiling
15088 Executable and library profiling
15089 --enable-executable-profiling
15091 --disable-executable-profiling
15092 Executable profiling (DEPRECATED)
15093 --profiling-detail level
15095 Profiling detail level for executable and library (de‐
15096 fault, none, exported-functions, toplevel-functions,
15097 all-functions).
15098 --library-profiling-detail level
15100 Profiling detail level for libraries only.
15101 -O, --enable-optimization, --enable-optimisation [n]
15103 Build with optimization (n is 0--2, default is 1)
15104 --disable-optimization, --disable-optimisation
15106 Build without optimization
15107 --enable-debug-info [n]
15109 Emit debug info (n is 0--3, default is 0)
15110 --disable-debug-info
15112 Don't emit debug info
15113 --enable-library-for-ghci
15115 --disable-library-for-ghci
15116 compile library for use with GHCi
15117 --enable-split-sections
15119 --disable-split-sections
15120 compile library code such that unneeded definitions can
15121 be dropped from the final executable (GHC 7.8+)
15122 --enable-split-objs
15124 --disable-split-objs
15125 split library into smaller objects to reduce binary sizes
15126 (GHC 6.6+)
15127 --enable-executable-stripping
15129 --disable-executable-stripping
15130 strip executables upon installation to reduce binary
15131 sizes
15132 --enable-library-stripping
15134 --disable-library-stripping
15135 strip libraries upon installation to reduce binary sizes
15136 --configure-option OPT
15138 Extra option for configure
15139 --user
15141 --global
15142 doing a per-user installation
15143 --package-db DB
15145 Append the given package database to the list of package
15146 databases used (to satisfy dependencies and register
15147 into). May be a specific file, 'global' or 'user'. The
15148 initial list is ['global'], ['global', 'user'], or
15149 ['global', $sandbox], depending on context. Use 'clear'
15150 to reset the list to empty. See the user guide for de‐
15151 tails.
15152 -f, --flags FLAGS
15154 Force values for the given flags in Cabal conditionals in
15155 the .cabal file. E.g., --flags="debug -usebytestrings"
15156 forces the flag "debug" to true and "usebytestrings" to
15157 false.
15158 --extra-include-dirs PATH
15160 A list of directories to search for header files
15161 --enable-deterministic
15163 --disable-deterministic
15164 Try to be as deterministic as possible (used by the test
15165 suite)
15166 --ipid IPID
15168 Installed package ID to compile this package as
15169 --cid CID
15171 Installed component ID to compile this component as
15172 --extra-lib-dirs PATH
15174 A list of directories to search for external libraries
15175 --extra-framework-dirs PATH
15177 A list of directories to search for external frameworks
15178 (OS X only)
15179 --extra-prog-path PATH
15181 A list of directories to search for required programs (in
15182 addition to the normal search locations)
15183 --instantiate-with NAME=MOD
15185 A mapping of signature names to concrete module instanti‐
15186 ations.
15187 --enable-tests
15189 --disable-tests
15190 dependency checking and compilation for test suites
15191 listed in the package description file.
15192 --enable-coverage
15194 --disable-coverage
15195 build package with Haskell Program Coverage. (GHC only)
15196 --enable-library-coverage
15198 --disable-library-coverage
15199 build package with Haskell Program Coverage. (GHC only)
15200 (DEPRECATED)
15201 --enable-benchmarks
15203 --disable-benchmarks
15204 dependency checking and compilation for benchmarks listed
15205 in the package description file.
15206 --enable-relocatable
15208 --disable-relocatable
15209 building a package that is relocatable. (GHC only)
15210 --disable-response-files
15212 enable workaround for old versions of programs like "ar"
15213 that do not support @file arguments
15214 --allow-depending-on-private-libs
15216 Allow depending on private libraries. If set, the library
15217 visibility check MUST be done externally.
15218 --with-alex PATH
15220 give the path to alex
15221 --with-ar PATH
15223 give the path to ar
15224 --with-c2hs PATH
15226 give the path to c2hs
15227 --with-cpphs PATH
15229 give the path to cpphs
15230 --with-doctest PATH
15232 give the path to doctest
15233 --with-gcc PATH
15235 give the path to gcc
15236 --with-ghc PATH
15238 give the path to ghc
15239 --with-ghc-pkg PATH
15241 give the path to ghc-pkg
15242 --with-ghcjs PATH
15244 give the path to ghcjs
15245 --with-ghcjs-pkg PATH
15247 give the path to ghcjs-pkg
15248 --with-greencard PATH
15250 give the path to greencard
15251 --with-haddock PATH
15253 give the path to haddock
15254 --with-happy PATH
15256 give the path to happy
15257 --with-haskell-suite PATH
15259 give the path to haskell-suite
15260 --with-haskell-suite-pkg PATH
15262 give the path to haskell-suite-pkg
15263 --with-hmake PATH
15265 give the path to hmake
15266 --with-hpc PATH
15268 give the path to hpc
15269 --with-hsc2hs PATH
15271 give the path to hsc2hs
15272 --with-hscolour PATH
15274 give the path to hscolour
15275 --with-jhc PATH
15277 give the path to jhc
15278 --with-ld PATH
15280 give the path to ld
15281 --with-pkg-config PATH
15283 give the path to pkg-config
15284 --with-runghc PATH
15286 give the path to runghc
15287 --with-strip PATH
15289 give the path to strip
15290 --with-tar PATH
15292 give the path to tar
15293 --with-uhc PATH
15295 give the path to uhc
15296 --alex-option OPT
15298 give an extra option to alex (no need to quote options
15299 containing spaces)
15300 --ar-option OPT
15302 give an extra option to ar (no need to quote options con‐
15303 taining spaces)
15304 --c2hs-option OPT
15306 give an extra option to c2hs (no need to quote options
15307 containing spaces)
15308 --cpphs-option OPT
15310 give an extra option to cpphs (no need to quote options
15311 containing spaces)
15312 --doctest-option OPT
15314 give an extra option to doctest (no need to quote options
15315 containing spaces)
15316 --gcc-option OPT
15318 give an extra option to gcc (no need to quote options
15319 containing spaces)
15320 --ghc-option OPT
15322 give an extra option to ghc (no need to quote options
15323 containing spaces)
15324 --ghc-pkg-option OPT
15326 give an extra option to ghc-pkg (no need to quote options
15327 containing spaces)
15328 --ghcjs-option OPT
15330 give an extra option to ghcjs (no need to quote options
15331 containing spaces)
15332 --ghcjs-pkg-option OPT
15334 give an extra option to ghcjs-pkg (no need to quote op‐
15335 tions containing spaces)
15336 --greencard-option OPT
15338 give an extra option to greencard (no need to quote op‐
15339 tions containing spaces)
15340 --haddock-option OPT
15342 give an extra option to haddock (no need to quote options
15343 containing spaces)
15344 --happy-option OPT
15346 give an extra option to happy (no need to quote options
15347 containing spaces)
15348 --haskell-suite-option OPT
15350 give an extra option to haskell-suite (no need to quote
15351 options containing spaces)
15352 --haskell-suite-pkg-option OPT
15354 give an extra option to haskell-suite-pkg (no need to
15355 quote options containing spaces)
15356 --hmake-option OPT
15358 give an extra option to hmake (no need to quote options
15359 containing spaces)
15360 --hpc-option OPT
15362 give an extra option to hpc (no need to quote options
15363 containing spaces)
15364 --hsc2hs-option OPT
15366 give an extra option to hsc2hs (no need to quote options
15367 containing spaces)
15368 --hscolour-option OPT
15370 give an extra option to hscolour (no need to quote op‐
15371 tions containing spaces)
15372 --jhc-option OPT
15374 give an extra option to jhc (no need to quote options
15375 containing spaces)
15376 --ld-option OPT
15378 give an extra option to ld (no need to quote options con‐
15379 taining spaces)
15380 --pkg-config-option OPT
15382 give an extra option to pkg-config (no need to quote op‐
15383 tions containing spaces)
15384 --runghc-option OPT
15386 give an extra option to runghc (no need to quote options
15387 containing spaces)
15388 --strip-option OPT
15390 give an extra option to strip (no need to quote options
15391 containing spaces)
15392 --tar-option OPT
15394 give an extra option to tar (no need to quote options
15395 containing spaces)
15396 --uhc-option OPT
15398 give an extra option to uhc (no need to quote options
15399 containing spaces)
15400 --alex-options OPTS
15402 give extra options to alex
15403 --ar-options OPTS
15405 give extra options to ar
15406 --c2hs-options OPTS
15408 give extra options to c2hs
15409 --cpphs-options OPTS
15411 give extra options to cpphs
15412 --doctest-options OPTS
15414 give extra options to doctest
15415 --gcc-options OPTS
15417 give extra options to gcc
15418 --ghc-options OPTS
15420 give extra options to ghc
15421 --ghc-pkg-options OPTS
15423 give extra options to ghc-pkg
15424 --ghcjs-options OPTS
15426 give extra options to ghcjs
15427 --ghcjs-pkg-options OPTS
15429 give extra options to ghcjs-pkg
15430 --greencard-options OPTS
15432 give extra options to greencard
15433 --haddock-options OPTS
15435 give extra options to haddock
15436 --happy-options OPTS
15438 give extra options to happy
15439 --haskell-suite-options OPTS
15441 give extra options to haskell-suite
15442 --haskell-suite-pkg-options OPTS
15444 give extra options to haskell-suite-pkg
15445 --hmake-options OPTS
15447 give extra options to hmake
15448 --hpc-options OPTS
15450 give extra options to hpc
15451 --hsc2hs-options OPTS
15453 give extra options to hsc2hs
15454 --hscolour-options OPTS
15456 give extra options to hscolour
15457 --jhc-options OPTS
15459 give extra options to jhc
15460 --ld-options OPTS
15462 give extra options to ld
15463 --pkg-config-options OPTS
15465 give extra options to pkg-config
15466 --runghc-options OPTS
15468 give extra options to runghc
15469 --strip-options OPTS
15471 give extra options to strip
15472 --tar-options OPTS
15474 give extra options to tar
15475 --uhc-options OPTS
15477 give extra options to uhc
15478 --cabal-lib-version VERSION
15480 Select which version of the Cabal lib to use to build
15481 packages (useful for testing).
15482 --constraint CONSTRAINT
15484 Specify constraints on a package (version, in‐
15485 stalled/source, flags)
15486 --preference CONSTRAINT
15488 Specify preferences (soft constraints) on the version of
15489 a package
15490 --solver SOLVER
15492 Select dependency solver to use (default: modular).
15493 Choices: modular.
15494 --allow-older [DEPS]
15496 Ignore lower bounds in all dependencies or DEPS
15497 --allow-newer [DEPS]
15499 Ignore upper bounds in all dependencies or DEPS
15500 --write-ghc-environment-files always|never|ghc8.4.4+
15502 Whether to create a .ghc.environment file after a suc‐
15503 cessful build (v2-build only)
15504 --enable-documentation
15506 --disable-documentation
15507 building of documentation
15508 --doc-index-file TEMPLATE
15510 A central index of haddock API documentation (template
15511 cannot use $pkgid)
15512 --dry-run
15514 Do not install anything, only print what would be in‐
15515 stalled.
15516 --max-backjumps NUM
15518 Maximum number of backjumps allowed while solving (de‐
15519 fault: 4000). Use a negative number to enable unlimited
15520 backtracking. Use 0 to disable backtracking completely.
15521 --reorder-goals
15523 --no-reorder-goals
15524 Try to reorder goals according to certain heuristics.
15525 Slows things down on average, but may make backtracking
15526 faster for some packages.
15527 --count-conflicts
15529 --no-count-conflicts
15530 Try to speed up solving by preferring goals that are in‐
15531 volved in a lot of conflicts (default).
15532 --fine-grained-conflicts
15534 --no-fine-grained-conflicts
15535 Skip a version of a package if it does not resolve the
15536 conflicts encountered in the last version, as a solver
15537 optimization (default).
15538 --minimize-conflict-set
15540 --no-minimize-conflict-set
15541 When there is no solution, try to improve the error mes‐
15542 sage by finding a minimal conflict set (default: false).
15543 May increase run time significantly.
15544 --independent-goals
15546 --no-independent-goals
15547 Treat several goals on the command line as independent.
15548 If several goals depend on the same package, different
15549 versions can be chosen.
15550 --shadow-installed-packages
15552 --no-shadow-installed-packages
15553 If multiple package instances of the same version are in‐
15554 stalled, treat all but one as shadowed.
15555 --strong-flags
15557 --no-strong-flags
15558 Do not defer flag choices (this used to be the default in
15559 cabal-install <= 1.20).
15560 --allow-boot-library-installs
15562 --no-allow-boot-library-installs
15563 Allow cabal to install base, ghc-prim, integer-simple,
15564 integer-gmp, and template-haskell.
15565 --reject-unconstrained-dependencies none|all
15567 Require these packages to have constraints on them if
15568 they are to be selected (default: none).
15569 --reinstall
15571 --no-reinstall
15572 Install even if it means installing the same version
15573 again.
15574 --avoid-reinstalls
15576 --no-avoid-reinstalls
15577 Do not select versions that would destructively overwrite
15578 installed packages.
15579 --force-reinstalls
15581 --no-force-reinstalls
15582 Reinstall packages even if they will most likely break
15583 other installed packages.
15584 --upgrade-dependencies
15586 --no-upgrade-dependencies
15587 Pick the latest version for all dependencies, rather than
15588 trying to pick an installed version.
15589 --only-dependencies
15591 --no-only-dependencies
15592 Install only the dependencies necessary to build the
15593 given packages
15594 --dependencies-only
15596 --no-dependencies-only
15597 A synonym for --only-dependencies
15598 --index-state STATE
15600 Use source package index state as it existed at a previ‐
15601 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
15602 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
15603 'HEAD' (default: 'HEAD').
15604 --root-cmd COMMAND
15606 (No longer supported, do not use.)
15607 --build-summary TEMPLATE
15609 Save build summaries to file (name template can use
15610 $pkgid, $compiler, $os, $arch)
15611 --build-log TEMPLATE
15613 Log all builds to file (name template can use $pkgid,
15614 $compiler, $os, $arch)
15615 --remote-build-reporting LEVEL
15617 Generate build reports to send to a remote server (none,
15618 anonymous or detailed).
15619 --report-planning-failure
15621 Generate build reports when the dependency solver fails.
15622 This is used by the Hackage build bot.
15623 --enable-per-component
15625 --disable-per-component
15626 Per-component builds when possible
15627 --one-shot
15629 --no-one-shot
15630 Do not record the packages in the world file.
15631 --run-tests
15633 Run package test suites during installation.
15634 -j, --jobs [NUM]
15636 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
15637 given).
15638 --keep-going
15640 After a build failure, continue to build other unaffected
15641 packages.
15642 --offline
15644 --no-offline
15645 Don't download packages from the Internet.
15646 --project-file FILE
15648 Set the name of the cabal.project file to search for in
15649 parent directories
15650 --only
15652 Only installs the package in the current directory.
15653 --haddock-hoogle
15655 Generate a hoogle database
15656 --haddock-html
15658 Generate HTML documentation (the default)
15659 --haddock-html-location URL
15661 Location of HTML documentation for pre-requisite packages
15662 --haddock-for-hackage
15664 Collection of flags to generate documentation suitable
15665 for upload to hackage
15666 --haddock-executables
15668 Run haddock for Executables targets
15669 --haddock-tests
15671 Run haddock for Test Suite targets
15672 --haddock-benchmarks
15674 Run haddock for Benchmark targets
15675 --haddock-all
15677 Run haddock for all targets
15678 --haddock-internal
15680 Run haddock for internal modules and include all symbols
15681 --haddock-css PATH
15683 Use PATH as the haddock stylesheet
15684 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
15686 dock-hyperlinked-source
15687 Hyperlink the documentation to the source code
15688 --haddock-quickjump
15690 Generate an index for interactive documentation naviga‐
15691 tion
15692 --haddock-hscolour-css PATH
15694 Use PATH as the HsColour stylesheet
15695 --haddock-contents-location URL
15697 Bake URL in as the location for the contents page
15698 --test-log TEMPLATE
15700 Log all test suite results to file (name template can use
15701 $pkgid, $compiler, $os, $arch, $test-suite, $result)
15702 --test-machine-log TEMPLATE
15704 Produce a machine-readable log file (name template can
15705 use $pkgid, $compiler, $os, $arch, $result)
15706 --test-show-details FILTER
15708 --test-keep-tix-files
15710 keep .tix files for HPC between test runs
15711 --test-wrapper FILE
15713 Run test through a wrapper.
15714 --test-fail-when-no-test-suites
15716 Exit with failure when no test suites are found.
15717 --test-options TEMPLATES
15719 give extra options to test executables (name templates
15720 can use $pkgid, $compiler, $os, $arch, $test-suite)
15721 --test-option TEMPLATE
15723 give extra option to test executables (no need to quote
15724 options containing spaces, name template can use $pkgid,
15725 $compiler, $os, $arch, $test-suite)
15726 --benchmark-options TEMPLATES
15728 give extra options to benchmark executables (name tem‐
15729 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
15730 --benchmark-option TEMPLATE
15732 give extra option to benchmark executables (no need to
15733 quote options containing spaces, name template can use
15734 $pkgid, $compiler, $os, $arch, $benchmark)
15735 --lib
15737 Install libraries rather than executables from the target
15738 package.
15739 -z, --ignore-project
15741 Ignore local project configuration
15742 --package-env, --env ENV
15744 Set the environment file that may be modified.
15745 --overwrite-policy always|never
15747 How to handle already existing symlinks.
15748 --install-method copy|symlink
15750 How to install the executables.
15751 --installdir DIR
15753 Where to install (by symlinking or copying) the executa‐
15754 bles in.
15755 cabal new-install
15758 Usage: cabal new-install [TARGETS] [FLAGS]
15760 Installs one or more packages. This is done by installing them in the
15763 store and symlinking/copying the executables in the directory specified
15764 by the --installdir flag (`~/.cabal/bin/` by default). If you want the
15765 installed executables to be available globally, make sure that the PATH
15766 environment variable contains that directory.
15767 If TARGET is a library, it will be added to the global environment.
15769 When doing this, cabal will try to build a plan that includes all the
15770 previously installed libraries. This is currently not implemented.
15771 Installs one or more packages. This is done by installing them in the
15774 store and symlinking/copying the executables in the directory specified
15775 by the --installdir flag (`~/.cabal/bin/` by default). If you want the
15776 installed executables to be available globally, make sure that the PATH
15777 environment variable contains that directory.
15778 If TARGET is a library, it will be added to the global environment.
15780 When doing this, cabal will try to build a plan that includes all the
15781 previously installed libraries. This is currently not implemented.
15782 Flags:
15785 -v, --verbose [n]
15786 Control verbosity (n is 0--3, default verbosity level is
15787 1)
15788 --builddir, --distdir, --distpref DIR
15790 The directory where Cabal puts generated build files (de‐
15791 fault dist)
15792 -g, --ghc
15794 compile with GHC
15795 --ghcjs
15797 compile with GHCJS
15798 --uhc
15800 compile with UHC
15801 --haskell-suite
15803 compile with a haskell-suite compiler
15804 --cabal-file PATH
15806 use this Cabal file
15807 -w, --with-compiler PATH
15809 give the path to a particular compiler
15810 --with-hc-pkg PATH
15812 give the path to the package tool
15813 --prefix DIR
15815 bake this prefix in preparation of installation
15816 --bindir DIR
15818 installation directory for executables
15819 --libdir DIR
15821 installation directory for libraries
15822 --libsubdir DIR
15824 subdirectory of libdir in which libs are installed
15825 --dynlibdir DIR
15827 installation directory for dynamic libraries
15828 --libexecdir DIR
15830 installation directory for program executables
15831 --libexecsubdir DIR
15833 subdirectory of libexecdir in which private executables
15834 are installed
15835 --datadir DIR
15837 installation directory for read-only data
15838 --datasubdir DIR
15840 subdirectory of datadir in which data files are installed
15841 --docdir DIR
15843 installation directory for documentation
15844 --htmldir DIR
15846 installation directory for HTML documentation
15847 --haddockdir DIR
15849 installation directory for haddock interfaces
15850 --sysconfdir DIR
15852 installation directory for configuration files
15853 --program-prefix PREFIX
15855 prefix to be applied to installed executables
15856 --program-suffix SUFFIX
15858 suffix to be applied to installed executables
15859 --enable-library-vanilla
15861 --disable-library-vanilla
15862 Vanilla libraries
15863 -p, --enable-library-profiling
15865 --disable-library-profiling
15866 Library profiling
15867 --enable-shared
15869 --disable-shared
15870 Shared library
15871 --enable-static
15873 --disable-static
15874 Static library
15875 --enable-executable-dynamic
15877 --disable-executable-dynamic
15878 Executable dynamic linking
15879 --enable-executable-static
15881 --disable-executable-static
15882 Executable fully static linking
15883 --enable-profiling
15885 --disable-profiling
15886 Executable and library profiling
15887 --enable-executable-profiling
15889 --disable-executable-profiling
15890 Executable profiling (DEPRECATED)
15891 --profiling-detail level
15893 Profiling detail level for executable and library (de‐
15894 fault, none, exported-functions, toplevel-functions,
15895 all-functions).
15896 --library-profiling-detail level
15898 Profiling detail level for libraries only.
15899 -O, --enable-optimization, --enable-optimisation [n]
15901 Build with optimization (n is 0--2, default is 1)
15902 --disable-optimization, --disable-optimisation
15904 Build without optimization
15905 --enable-debug-info [n]
15907 Emit debug info (n is 0--3, default is 0)
15908 --disable-debug-info
15910 Don't emit debug info
15911 --enable-library-for-ghci
15913 --disable-library-for-ghci
15914 compile library for use with GHCi
15915 --enable-split-sections
15917 --disable-split-sections
15918 compile library code such that unneeded definitions can
15919 be dropped from the final executable (GHC 7.8+)
15920 --enable-split-objs
15922 --disable-split-objs
15923 split library into smaller objects to reduce binary sizes
15924 (GHC 6.6+)
15925 --enable-executable-stripping
15927 --disable-executable-stripping
15928 strip executables upon installation to reduce binary
15929 sizes
15930 --enable-library-stripping
15932 --disable-library-stripping
15933 strip libraries upon installation to reduce binary sizes
15934 --configure-option OPT
15936 Extra option for configure
15937 --user
15939 --global
15940 doing a per-user installation
15941 --package-db DB
15943 Append the given package database to the list of package
15944 databases used (to satisfy dependencies and register
15945 into). May be a specific file, 'global' or 'user'. The
15946 initial list is ['global'], ['global', 'user'], or
15947 ['global', $sandbox], depending on context. Use 'clear'
15948 to reset the list to empty. See the user guide for de‐
15949 tails.
15950 -f, --flags FLAGS
15952 Force values for the given flags in Cabal conditionals in
15953 the .cabal file. E.g., --flags="debug -usebytestrings"
15954 forces the flag "debug" to true and "usebytestrings" to
15955 false.
15956 --extra-include-dirs PATH
15958 A list of directories to search for header files
15959 --enable-deterministic
15961 --disable-deterministic
15962 Try to be as deterministic as possible (used by the test
15963 suite)
15964 --ipid IPID
15966 Installed package ID to compile this package as
15967 --cid CID
15969 Installed component ID to compile this component as
15970 --extra-lib-dirs PATH
15972 A list of directories to search for external libraries
15973 --extra-framework-dirs PATH
15975 A list of directories to search for external frameworks
15976 (OS X only)
15977 --extra-prog-path PATH
15979 A list of directories to search for required programs (in
15980 addition to the normal search locations)
15981 --instantiate-with NAME=MOD
15983 A mapping of signature names to concrete module instanti‐
15984 ations.
15985 --enable-tests
15987 --disable-tests
15988 dependency checking and compilation for test suites
15989 listed in the package description file.
15990 --enable-coverage
15992 --disable-coverage
15993 build package with Haskell Program Coverage. (GHC only)
15994 --enable-library-coverage
15996 --disable-library-coverage
15997 build package with Haskell Program Coverage. (GHC only)
15998 (DEPRECATED)
15999 --enable-benchmarks
16001 --disable-benchmarks
16002 dependency checking and compilation for benchmarks listed
16003 in the package description file.
16004 --enable-relocatable
16006 --disable-relocatable
16007 building a package that is relocatable. (GHC only)
16008 --disable-response-files
16010 enable workaround for old versions of programs like "ar"
16011 that do not support @file arguments
16012 --allow-depending-on-private-libs
16014 Allow depending on private libraries. If set, the library
16015 visibility check MUST be done externally.
16016 --with-alex PATH
16018 give the path to alex
16019 --with-ar PATH
16021 give the path to ar
16022 --with-c2hs PATH
16024 give the path to c2hs
16025 --with-cpphs PATH
16027 give the path to cpphs
16028 --with-doctest PATH
16030 give the path to doctest
16031 --with-gcc PATH
16033 give the path to gcc
16034 --with-ghc PATH
16036 give the path to ghc
16037 --with-ghc-pkg PATH
16039 give the path to ghc-pkg
16040 --with-ghcjs PATH
16042 give the path to ghcjs
16043 --with-ghcjs-pkg PATH
16045 give the path to ghcjs-pkg
16046 --with-greencard PATH
16048 give the path to greencard
16049 --with-haddock PATH
16051 give the path to haddock
16052 --with-happy PATH
16054 give the path to happy
16055 --with-haskell-suite PATH
16057 give the path to haskell-suite
16058 --with-haskell-suite-pkg PATH
16060 give the path to haskell-suite-pkg
16061 --with-hmake PATH
16063 give the path to hmake
16064 --with-hpc PATH
16066 give the path to hpc
16067 --with-hsc2hs PATH
16069 give the path to hsc2hs
16070 --with-hscolour PATH
16072 give the path to hscolour
16073 --with-jhc PATH
16075 give the path to jhc
16076 --with-ld PATH
16078 give the path to ld
16079 --with-pkg-config PATH
16081 give the path to pkg-config
16082 --with-runghc PATH
16084 give the path to runghc
16085 --with-strip PATH
16087 give the path to strip
16088 --with-tar PATH
16090 give the path to tar
16091 --with-uhc PATH
16093 give the path to uhc
16094 --alex-option OPT
16096 give an extra option to alex (no need to quote options
16097 containing spaces)
16098 --ar-option OPT
16100 give an extra option to ar (no need to quote options con‐
16101 taining spaces)
16102 --c2hs-option OPT
16104 give an extra option to c2hs (no need to quote options
16105 containing spaces)
16106 --cpphs-option OPT
16108 give an extra option to cpphs (no need to quote options
16109 containing spaces)
16110 --doctest-option OPT
16112 give an extra option to doctest (no need to quote options
16113 containing spaces)
16114 --gcc-option OPT
16116 give an extra option to gcc (no need to quote options
16117 containing spaces)
16118 --ghc-option OPT
16120 give an extra option to ghc (no need to quote options
16121 containing spaces)
16122 --ghc-pkg-option OPT
16124 give an extra option to ghc-pkg (no need to quote options
16125 containing spaces)
16126 --ghcjs-option OPT
16128 give an extra option to ghcjs (no need to quote options
16129 containing spaces)
16130 --ghcjs-pkg-option OPT
16132 give an extra option to ghcjs-pkg (no need to quote op‐
16133 tions containing spaces)
16134 --greencard-option OPT
16136 give an extra option to greencard (no need to quote op‐
16137 tions containing spaces)
16138 --haddock-option OPT
16140 give an extra option to haddock (no need to quote options
16141 containing spaces)
16142 --happy-option OPT
16144 give an extra option to happy (no need to quote options
16145 containing spaces)
16146 --haskell-suite-option OPT
16148 give an extra option to haskell-suite (no need to quote
16149 options containing spaces)
16150 --haskell-suite-pkg-option OPT
16152 give an extra option to haskell-suite-pkg (no need to
16153 quote options containing spaces)
16154 --hmake-option OPT
16156 give an extra option to hmake (no need to quote options
16157 containing spaces)
16158 --hpc-option OPT
16160 give an extra option to hpc (no need to quote options
16161 containing spaces)
16162 --hsc2hs-option OPT
16164 give an extra option to hsc2hs (no need to quote options
16165 containing spaces)
16166 --hscolour-option OPT
16168 give an extra option to hscolour (no need to quote op‐
16169 tions containing spaces)
16170 --jhc-option OPT
16172 give an extra option to jhc (no need to quote options
16173 containing spaces)
16174 --ld-option OPT
16176 give an extra option to ld (no need to quote options con‐
16177 taining spaces)
16178 --pkg-config-option OPT
16180 give an extra option to pkg-config (no need to quote op‐
16181 tions containing spaces)
16182 --runghc-option OPT
16184 give an extra option to runghc (no need to quote options
16185 containing spaces)
16186 --strip-option OPT
16188 give an extra option to strip (no need to quote options
16189 containing spaces)
16190 --tar-option OPT
16192 give an extra option to tar (no need to quote options
16193 containing spaces)
16194 --uhc-option OPT
16196 give an extra option to uhc (no need to quote options
16197 containing spaces)
16198 --alex-options OPTS
16200 give extra options to alex
16201 --ar-options OPTS
16203 give extra options to ar
16204 --c2hs-options OPTS
16206 give extra options to c2hs
16207 --cpphs-options OPTS
16209 give extra options to cpphs
16210 --doctest-options OPTS
16212 give extra options to doctest
16213 --gcc-options OPTS
16215 give extra options to gcc
16216 --ghc-options OPTS
16218 give extra options to ghc
16219 --ghc-pkg-options OPTS
16221 give extra options to ghc-pkg
16222 --ghcjs-options OPTS
16224 give extra options to ghcjs
16225 --ghcjs-pkg-options OPTS
16227 give extra options to ghcjs-pkg
16228 --greencard-options OPTS
16230 give extra options to greencard
16231 --haddock-options OPTS
16233 give extra options to haddock
16234 --happy-options OPTS
16236 give extra options to happy
16237 --haskell-suite-options OPTS
16239 give extra options to haskell-suite
16240 --haskell-suite-pkg-options OPTS
16242 give extra options to haskell-suite-pkg
16243 --hmake-options OPTS
16245 give extra options to hmake
16246 --hpc-options OPTS
16248 give extra options to hpc
16249 --hsc2hs-options OPTS
16251 give extra options to hsc2hs
16252 --hscolour-options OPTS
16254 give extra options to hscolour
16255 --jhc-options OPTS
16257 give extra options to jhc
16258 --ld-options OPTS
16260 give extra options to ld
16261 --pkg-config-options OPTS
16263 give extra options to pkg-config
16264 --runghc-options OPTS
16266 give extra options to runghc
16267 --strip-options OPTS
16269 give extra options to strip
16270 --tar-options OPTS
16272 give extra options to tar
16273 --uhc-options OPTS
16275 give extra options to uhc
16276 --cabal-lib-version VERSION
16278 Select which version of the Cabal lib to use to build
16279 packages (useful for testing).
16280 --constraint CONSTRAINT
16282 Specify constraints on a package (version, in‐
16283 stalled/source, flags)
16284 --preference CONSTRAINT
16286 Specify preferences (soft constraints) on the version of
16287 a package
16288 --solver SOLVER
16290 Select dependency solver to use (default: modular).
16291 Choices: modular.
16292 --allow-older [DEPS]
16294 Ignore lower bounds in all dependencies or DEPS
16295 --allow-newer [DEPS]
16297 Ignore upper bounds in all dependencies or DEPS
16298 --write-ghc-environment-files always|never|ghc8.4.4+
16300 Whether to create a .ghc.environment file after a suc‐
16301 cessful build (v2-build only)
16302 --enable-documentation
16304 --disable-documentation
16305 building of documentation
16306 --doc-index-file TEMPLATE
16308 A central index of haddock API documentation (template
16309 cannot use $pkgid)
16310 --dry-run
16312 Do not install anything, only print what would be in‐
16313 stalled.
16314 --max-backjumps NUM
16316 Maximum number of backjumps allowed while solving (de‐
16317 fault: 4000). Use a negative number to enable unlimited
16318 backtracking. Use 0 to disable backtracking completely.
16319 --reorder-goals
16321 --no-reorder-goals
16322 Try to reorder goals according to certain heuristics.
16323 Slows things down on average, but may make backtracking
16324 faster for some packages.
16325 --count-conflicts
16327 --no-count-conflicts
16328 Try to speed up solving by preferring goals that are in‐
16329 volved in a lot of conflicts (default).
16330 --fine-grained-conflicts
16332 --no-fine-grained-conflicts
16333 Skip a version of a package if it does not resolve the
16334 conflicts encountered in the last version, as a solver
16335 optimization (default).
16336 --minimize-conflict-set
16338 --no-minimize-conflict-set
16339 When there is no solution, try to improve the error mes‐
16340 sage by finding a minimal conflict set (default: false).
16341 May increase run time significantly.
16342 --independent-goals
16344 --no-independent-goals
16345 Treat several goals on the command line as independent.
16346 If several goals depend on the same package, different
16347 versions can be chosen.
16348 --shadow-installed-packages
16350 --no-shadow-installed-packages
16351 If multiple package instances of the same version are in‐
16352 stalled, treat all but one as shadowed.
16353 --strong-flags
16355 --no-strong-flags
16356 Do not defer flag choices (this used to be the default in
16357 cabal-install <= 1.20).
16358 --allow-boot-library-installs
16360 --no-allow-boot-library-installs
16361 Allow cabal to install base, ghc-prim, integer-simple,
16362 integer-gmp, and template-haskell.
16363 --reject-unconstrained-dependencies none|all
16365 Require these packages to have constraints on them if
16366 they are to be selected (default: none).
16367 --reinstall
16369 --no-reinstall
16370 Install even if it means installing the same version
16371 again.
16372 --avoid-reinstalls
16374 --no-avoid-reinstalls
16375 Do not select versions that would destructively overwrite
16376 installed packages.
16377 --force-reinstalls
16379 --no-force-reinstalls
16380 Reinstall packages even if they will most likely break
16381 other installed packages.
16382 --upgrade-dependencies
16384 --no-upgrade-dependencies
16385 Pick the latest version for all dependencies, rather than
16386 trying to pick an installed version.
16387 --only-dependencies
16389 --no-only-dependencies
16390 Install only the dependencies necessary to build the
16391 given packages
16392 --dependencies-only
16394 --no-dependencies-only
16395 A synonym for --only-dependencies
16396 --index-state STATE
16398 Use source package index state as it existed at a previ‐
16399 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
16400 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
16401 'HEAD' (default: 'HEAD').
16402 --root-cmd COMMAND
16404 (No longer supported, do not use.)
16405 --build-summary TEMPLATE
16407 Save build summaries to file (name template can use
16408 $pkgid, $compiler, $os, $arch)
16409 --build-log TEMPLATE
16411 Log all builds to file (name template can use $pkgid,
16412 $compiler, $os, $arch)
16413 --remote-build-reporting LEVEL
16415 Generate build reports to send to a remote server (none,
16416 anonymous or detailed).
16417 --report-planning-failure
16419 Generate build reports when the dependency solver fails.
16420 This is used by the Hackage build bot.
16421 --enable-per-component
16423 --disable-per-component
16424 Per-component builds when possible
16425 --one-shot
16427 --no-one-shot
16428 Do not record the packages in the world file.
16429 --run-tests
16431 Run package test suites during installation.
16432 -j, --jobs [NUM]
16434 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
16435 given).
16436 --keep-going
16438 After a build failure, continue to build other unaffected
16439 packages.
16440 --offline
16442 --no-offline
16443 Don't download packages from the Internet.
16444 --project-file FILE
16446 Set the name of the cabal.project file to search for in
16447 parent directories
16448 --only
16450 Only installs the package in the current directory.
16451 --haddock-hoogle
16453 Generate a hoogle database
16454 --haddock-html
16456 Generate HTML documentation (the default)
16457 --haddock-html-location URL
16459 Location of HTML documentation for pre-requisite packages
16460 --haddock-for-hackage
16462 Collection of flags to generate documentation suitable
16463 for upload to hackage
16464 --haddock-executables
16466 Run haddock for Executables targets
16467 --haddock-tests
16469 Run haddock for Test Suite targets
16470 --haddock-benchmarks
16472 Run haddock for Benchmark targets
16473 --haddock-all
16475 Run haddock for all targets
16476 --haddock-internal
16478 Run haddock for internal modules and include all symbols
16479 --haddock-css PATH
16481 Use PATH as the haddock stylesheet
16482 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
16484 dock-hyperlinked-source
16485 Hyperlink the documentation to the source code
16486 --haddock-quickjump
16488 Generate an index for interactive documentation naviga‐
16489 tion
16490 --haddock-hscolour-css PATH
16492 Use PATH as the HsColour stylesheet
16493 --haddock-contents-location URL
16495 Bake URL in as the location for the contents page
16496 --test-log TEMPLATE
16498 Log all test suite results to file (name template can use
16499 $pkgid, $compiler, $os, $arch, $test-suite, $result)
16500 --test-machine-log TEMPLATE
16502 Produce a machine-readable log file (name template can
16503 use $pkgid, $compiler, $os, $arch, $result)
16504 --test-show-details FILTER
16506 --test-keep-tix-files
16508 keep .tix files for HPC between test runs
16509 --test-wrapper FILE
16511 Run test through a wrapper.
16512 --test-fail-when-no-test-suites
16514 Exit with failure when no test suites are found.
16515 --test-options TEMPLATES
16517 give extra options to test executables (name templates
16518 can use $pkgid, $compiler, $os, $arch, $test-suite)
16519 --test-option TEMPLATE
16521 give extra option to test executables (no need to quote
16522 options containing spaces, name template can use $pkgid,
16523 $compiler, $os, $arch, $test-suite)
16524 --benchmark-options TEMPLATES
16526 give extra options to benchmark executables (name tem‐
16527 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
16528 --benchmark-option TEMPLATE
16530 give extra option to benchmark executables (no need to
16531 quote options containing spaces, name template can use
16532 $pkgid, $compiler, $os, $arch, $benchmark)
16533 --lib
16535 Install libraries rather than executables from the target
16536 package.
16537 -z, --ignore-project
16539 Ignore local project configuration
16540 --package-env, --env ENV
16542 Set the environment file that may be modified.
16543 --overwrite-policy always|never
16545 How to handle already existing symlinks.
16546 --install-method copy|symlink
16548 How to install the executables.
16549 --installdir DIR
16551 Where to install (by symlinking or copying) the executa‐
16552 bles in.
16553 cabal v2-install
16556 Usage: cabal v2-install [TARGETS] [FLAGS]
16558 Installs one or more packages. This is done by installing them in the
16561 store and symlinking/copying the executables in the directory specified
16562 by the --installdir flag (`~/.cabal/bin/` by default). If you want the
16563 installed executables to be available globally, make sure that the PATH
16564 environment variable contains that directory.
16565 If TARGET is a library, it will be added to the global environment.
16567 When doing this, cabal will try to build a plan that includes all the
16568 previously installed libraries. This is currently not implemented.
16569 Examples:
16572 cabal v2-install
16573 Install the package in the current directory
16574 cabal v2-install pkgname
16575 Install the package named pkgname (fetching it from hackage if nec‐
16576 essary)
16577 cabal v2-install ./pkgfoo
16578 Install the package in the ./pkgfoo directory Note: this command is
16579 part of the new project-based system (aka nix-style local builds).
16580 These features are currently in beta. Please see http://cabal.readthe‐
16581 docs.io/en/latest/nix-local-build-overview.html for details and advice
16582 on what you can expect to work. If you encounter problems please file
16583 issues at https://github.com/haskell/cabal/issues and if you have any
16584 time to get involved and help with testing, fixing bugs etc then that
16585 is very much appreciated.
16586 Flags:
16589 -v, --verbose [n]
16590 Control verbosity (n is 0--3, default verbosity level is
16591 1)
16592 --builddir, --distdir, --distpref DIR
16594 The directory where Cabal puts generated build files (de‐
16595 fault dist)
16596 -g, --ghc
16598 compile with GHC
16599 --ghcjs
16601 compile with GHCJS
16602 --uhc
16604 compile with UHC
16605 --haskell-suite
16607 compile with a haskell-suite compiler
16608 --cabal-file PATH
16610 use this Cabal file
16611 -w, --with-compiler PATH
16613 give the path to a particular compiler
16614 --with-hc-pkg PATH
16616 give the path to the package tool
16617 --prefix DIR
16619 bake this prefix in preparation of installation
16620 --bindir DIR
16622 installation directory for executables
16623 --libdir DIR
16625 installation directory for libraries
16626 --libsubdir DIR
16628 subdirectory of libdir in which libs are installed
16629 --dynlibdir DIR
16631 installation directory for dynamic libraries
16632 --libexecdir DIR
16634 installation directory for program executables
16635 --libexecsubdir DIR
16637 subdirectory of libexecdir in which private executables
16638 are installed
16639 --datadir DIR
16641 installation directory for read-only data
16642 --datasubdir DIR
16644 subdirectory of datadir in which data files are installed
16645 --docdir DIR
16647 installation directory for documentation
16648 --htmldir DIR
16650 installation directory for HTML documentation
16651 --haddockdir DIR
16653 installation directory for haddock interfaces
16654 --sysconfdir DIR
16656 installation directory for configuration files
16657 --program-prefix PREFIX
16659 prefix to be applied to installed executables
16660 --program-suffix SUFFIX
16662 suffix to be applied to installed executables
16663 --enable-library-vanilla
16665 --disable-library-vanilla
16666 Vanilla libraries
16667 -p, --enable-library-profiling
16669 --disable-library-profiling
16670 Library profiling
16671 --enable-shared
16673 --disable-shared
16674 Shared library
16675 --enable-static
16677 --disable-static
16678 Static library
16679 --enable-executable-dynamic
16681 --disable-executable-dynamic
16682 Executable dynamic linking
16683 --enable-executable-static
16685 --disable-executable-static
16686 Executable fully static linking
16687 --enable-profiling
16689 --disable-profiling
16690 Executable and library profiling
16691 --enable-executable-profiling
16693 --disable-executable-profiling
16694 Executable profiling (DEPRECATED)
16695 --profiling-detail level
16697 Profiling detail level for executable and library (de‐
16698 fault, none, exported-functions, toplevel-functions,
16699 all-functions).
16700 --library-profiling-detail level
16702 Profiling detail level for libraries only.
16703 -O, --enable-optimization, --enable-optimisation [n]
16705 Build with optimization (n is 0--2, default is 1)
16706 --disable-optimization, --disable-optimisation
16708 Build without optimization
16709 --enable-debug-info [n]
16711 Emit debug info (n is 0--3, default is 0)
16712 --disable-debug-info
16714 Don't emit debug info
16715 --enable-library-for-ghci
16717 --disable-library-for-ghci
16718 compile library for use with GHCi
16719 --enable-split-sections
16721 --disable-split-sections
16722 compile library code such that unneeded definitions can
16723 be dropped from the final executable (GHC 7.8+)
16724 --enable-split-objs
16726 --disable-split-objs
16727 split library into smaller objects to reduce binary sizes
16728 (GHC 6.6+)
16729 --enable-executable-stripping
16731 --disable-executable-stripping
16732 strip executables upon installation to reduce binary
16733 sizes
16734 --enable-library-stripping
16736 --disable-library-stripping
16737 strip libraries upon installation to reduce binary sizes
16738 --configure-option OPT
16740 Extra option for configure
16741 --user
16743 --global
16744 doing a per-user installation
16745 --package-db DB
16747 Append the given package database to the list of package
16748 databases used (to satisfy dependencies and register
16749 into). May be a specific file, 'global' or 'user'. The
16750 initial list is ['global'], ['global', 'user'], or
16751 ['global', $sandbox], depending on context. Use 'clear'
16752 to reset the list to empty. See the user guide for de‐
16753 tails.
16754 -f, --flags FLAGS
16756 Force values for the given flags in Cabal conditionals in
16757 the .cabal file. E.g., --flags="debug -usebytestrings"
16758 forces the flag "debug" to true and "usebytestrings" to
16759 false.
16760 --extra-include-dirs PATH
16762 A list of directories to search for header files
16763 --enable-deterministic
16765 --disable-deterministic
16766 Try to be as deterministic as possible (used by the test
16767 suite)
16768 --ipid IPID
16770 Installed package ID to compile this package as
16771 --cid CID
16773 Installed component ID to compile this component as
16774 --extra-lib-dirs PATH
16776 A list of directories to search for external libraries
16777 --extra-framework-dirs PATH
16779 A list of directories to search for external frameworks
16780 (OS X only)
16781 --extra-prog-path PATH
16783 A list of directories to search for required programs (in
16784 addition to the normal search locations)
16785 --instantiate-with NAME=MOD
16787 A mapping of signature names to concrete module instanti‐
16788 ations.
16789 --enable-tests
16791 --disable-tests
16792 dependency checking and compilation for test suites
16793 listed in the package description file.
16794 --enable-coverage
16796 --disable-coverage
16797 build package with Haskell Program Coverage. (GHC only)
16798 --enable-library-coverage
16800 --disable-library-coverage
16801 build package with Haskell Program Coverage. (GHC only)
16802 (DEPRECATED)
16803 --enable-benchmarks
16805 --disable-benchmarks
16806 dependency checking and compilation for benchmarks listed
16807 in the package description file.
16808 --enable-relocatable
16810 --disable-relocatable
16811 building a package that is relocatable. (GHC only)
16812 --disable-response-files
16814 enable workaround for old versions of programs like "ar"
16815 that do not support @file arguments
16816 --allow-depending-on-private-libs
16818 Allow depending on private libraries. If set, the library
16819 visibility check MUST be done externally.
16820 --with-alex PATH
16822 give the path to alex
16823 --with-ar PATH
16825 give the path to ar
16826 --with-c2hs PATH
16828 give the path to c2hs
16829 --with-cpphs PATH
16831 give the path to cpphs
16832 --with-doctest PATH
16834 give the path to doctest
16835 --with-gcc PATH
16837 give the path to gcc
16838 --with-ghc PATH
16840 give the path to ghc
16841 --with-ghc-pkg PATH
16843 give the path to ghc-pkg
16844 --with-ghcjs PATH
16846 give the path to ghcjs
16847 --with-ghcjs-pkg PATH
16849 give the path to ghcjs-pkg
16850 --with-greencard PATH
16852 give the path to greencard
16853 --with-haddock PATH
16855 give the path to haddock
16856 --with-happy PATH
16858 give the path to happy
16859 --with-haskell-suite PATH
16861 give the path to haskell-suite
16862 --with-haskell-suite-pkg PATH
16864 give the path to haskell-suite-pkg
16865 --with-hmake PATH
16867 give the path to hmake
16868 --with-hpc PATH
16870 give the path to hpc
16871 --with-hsc2hs PATH
16873 give the path to hsc2hs
16874 --with-hscolour PATH
16876 give the path to hscolour
16877 --with-jhc PATH
16879 give the path to jhc
16880 --with-ld PATH
16882 give the path to ld
16883 --with-pkg-config PATH
16885 give the path to pkg-config
16886 --with-runghc PATH
16888 give the path to runghc
16889 --with-strip PATH
16891 give the path to strip
16892 --with-tar PATH
16894 give the path to tar
16895 --with-uhc PATH
16897 give the path to uhc
16898 --alex-option OPT
16900 give an extra option to alex (no need to quote options
16901 containing spaces)
16902 --ar-option OPT
16904 give an extra option to ar (no need to quote options con‐
16905 taining spaces)
16906 --c2hs-option OPT
16908 give an extra option to c2hs (no need to quote options
16909 containing spaces)
16910 --cpphs-option OPT
16912 give an extra option to cpphs (no need to quote options
16913 containing spaces)
16914 --doctest-option OPT
16916 give an extra option to doctest (no need to quote options
16917 containing spaces)
16918 --gcc-option OPT
16920 give an extra option to gcc (no need to quote options
16921 containing spaces)
16922 --ghc-option OPT
16924 give an extra option to ghc (no need to quote options
16925 containing spaces)
16926 --ghc-pkg-option OPT
16928 give an extra option to ghc-pkg (no need to quote options
16929 containing spaces)
16930 --ghcjs-option OPT
16932 give an extra option to ghcjs (no need to quote options
16933 containing spaces)
16934 --ghcjs-pkg-option OPT
16936 give an extra option to ghcjs-pkg (no need to quote op‐
16937 tions containing spaces)
16938 --greencard-option OPT
16940 give an extra option to greencard (no need to quote op‐
16941 tions containing spaces)
16942 --haddock-option OPT
16944 give an extra option to haddock (no need to quote options
16945 containing spaces)
16946 --happy-option OPT
16948 give an extra option to happy (no need to quote options
16949 containing spaces)
16950 --haskell-suite-option OPT
16952 give an extra option to haskell-suite (no need to quote
16953 options containing spaces)
16954 --haskell-suite-pkg-option OPT
16956 give an extra option to haskell-suite-pkg (no need to
16957 quote options containing spaces)
16958 --hmake-option OPT
16960 give an extra option to hmake (no need to quote options
16961 containing spaces)
16962 --hpc-option OPT
16964 give an extra option to hpc (no need to quote options
16965 containing spaces)
16966 --hsc2hs-option OPT
16968 give an extra option to hsc2hs (no need to quote options
16969 containing spaces)
16970 --hscolour-option OPT
16972 give an extra option to hscolour (no need to quote op‐
16973 tions containing spaces)
16974 --jhc-option OPT
16976 give an extra option to jhc (no need to quote options
16977 containing spaces)
16978 --ld-option OPT
16980 give an extra option to ld (no need to quote options con‐
16981 taining spaces)
16982 --pkg-config-option OPT
16984 give an extra option to pkg-config (no need to quote op‐
16985 tions containing spaces)
16986 --runghc-option OPT
16988 give an extra option to runghc (no need to quote options
16989 containing spaces)
16990 --strip-option OPT
16992 give an extra option to strip (no need to quote options
16993 containing spaces)
16994 --tar-option OPT
16996 give an extra option to tar (no need to quote options
16997 containing spaces)
16998 --uhc-option OPT
17000 give an extra option to uhc (no need to quote options
17001 containing spaces)
17002 --alex-options OPTS
17004 give extra options to alex
17005 --ar-options OPTS
17007 give extra options to ar
17008 --c2hs-options OPTS
17010 give extra options to c2hs
17011 --cpphs-options OPTS
17013 give extra options to cpphs
17014 --doctest-options OPTS
17016 give extra options to doctest
17017 --gcc-options OPTS
17019 give extra options to gcc
17020 --ghc-options OPTS
17022 give extra options to ghc
17023 --ghc-pkg-options OPTS
17025 give extra options to ghc-pkg
17026 --ghcjs-options OPTS
17028 give extra options to ghcjs
17029 --ghcjs-pkg-options OPTS
17031 give extra options to ghcjs-pkg
17032 --greencard-options OPTS
17034 give extra options to greencard
17035 --haddock-options OPTS
17037 give extra options to haddock
17038 --happy-options OPTS
17040 give extra options to happy
17041 --haskell-suite-options OPTS
17043 give extra options to haskell-suite
17044 --haskell-suite-pkg-options OPTS
17046 give extra options to haskell-suite-pkg
17047 --hmake-options OPTS
17049 give extra options to hmake
17050 --hpc-options OPTS
17052 give extra options to hpc
17053 --hsc2hs-options OPTS
17055 give extra options to hsc2hs
17056 --hscolour-options OPTS
17058 give extra options to hscolour
17059 --jhc-options OPTS
17061 give extra options to jhc
17062 --ld-options OPTS
17064 give extra options to ld
17065 --pkg-config-options OPTS
17067 give extra options to pkg-config
17068 --runghc-options OPTS
17070 give extra options to runghc
17071 --strip-options OPTS
17073 give extra options to strip
17074 --tar-options OPTS
17076 give extra options to tar
17077 --uhc-options OPTS
17079 give extra options to uhc
17080 --cabal-lib-version VERSION
17082 Select which version of the Cabal lib to use to build
17083 packages (useful for testing).
17084 --constraint CONSTRAINT
17086 Specify constraints on a package (version, in‐
17087 stalled/source, flags)
17088 --preference CONSTRAINT
17090 Specify preferences (soft constraints) on the version of
17091 a package
17092 --solver SOLVER
17094 Select dependency solver to use (default: modular).
17095 Choices: modular.
17096 --allow-older [DEPS]
17098 Ignore lower bounds in all dependencies or DEPS
17099 --allow-newer [DEPS]
17101 Ignore upper bounds in all dependencies or DEPS
17102 --write-ghc-environment-files always|never|ghc8.4.4+
17104 Whether to create a .ghc.environment file after a suc‐
17105 cessful build (v2-build only)
17106 --enable-documentation
17108 --disable-documentation
17109 building of documentation
17110 --doc-index-file TEMPLATE
17112 A central index of haddock API documentation (template
17113 cannot use $pkgid)
17114 --dry-run
17116 Do not install anything, only print what would be in‐
17117 stalled.
17118 --max-backjumps NUM
17120 Maximum number of backjumps allowed while solving (de‐
17121 fault: 4000). Use a negative number to enable unlimited
17122 backtracking. Use 0 to disable backtracking completely.
17123 --reorder-goals
17125 --no-reorder-goals
17126 Try to reorder goals according to certain heuristics.
17127 Slows things down on average, but may make backtracking
17128 faster for some packages.
17129 --count-conflicts
17131 --no-count-conflicts
17132 Try to speed up solving by preferring goals that are in‐
17133 volved in a lot of conflicts (default).
17134 --fine-grained-conflicts
17136 --no-fine-grained-conflicts
17137 Skip a version of a package if it does not resolve the
17138 conflicts encountered in the last version, as a solver
17139 optimization (default).
17140 --minimize-conflict-set
17142 --no-minimize-conflict-set
17143 When there is no solution, try to improve the error mes‐
17144 sage by finding a minimal conflict set (default: false).
17145 May increase run time significantly.
17146 --independent-goals
17148 --no-independent-goals
17149 Treat several goals on the command line as independent.
17150 If several goals depend on the same package, different
17151 versions can be chosen.
17152 --shadow-installed-packages
17154 --no-shadow-installed-packages
17155 If multiple package instances of the same version are in‐
17156 stalled, treat all but one as shadowed.
17157 --strong-flags
17159 --no-strong-flags
17160 Do not defer flag choices (this used to be the default in
17161 cabal-install <= 1.20).
17162 --allow-boot-library-installs
17164 --no-allow-boot-library-installs
17165 Allow cabal to install base, ghc-prim, integer-simple,
17166 integer-gmp, and template-haskell.
17167 --reject-unconstrained-dependencies none|all
17169 Require these packages to have constraints on them if
17170 they are to be selected (default: none).
17171 --reinstall
17173 --no-reinstall
17174 Install even if it means installing the same version
17175 again.
17176 --avoid-reinstalls
17178 --no-avoid-reinstalls
17179 Do not select versions that would destructively overwrite
17180 installed packages.
17181 --force-reinstalls
17183 --no-force-reinstalls
17184 Reinstall packages even if they will most likely break
17185 other installed packages.
17186 --upgrade-dependencies
17188 --no-upgrade-dependencies
17189 Pick the latest version for all dependencies, rather than
17190 trying to pick an installed version.
17191 --only-dependencies
17193 --no-only-dependencies
17194 Install only the dependencies necessary to build the
17195 given packages
17196 --dependencies-only
17198 --no-dependencies-only
17199 A synonym for --only-dependencies
17200 --index-state STATE
17202 Use source package index state as it existed at a previ‐
17203 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
17204 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
17205 'HEAD' (default: 'HEAD').
17206 --root-cmd COMMAND
17208 (No longer supported, do not use.)
17209 --build-summary TEMPLATE
17211 Save build summaries to file (name template can use
17212 $pkgid, $compiler, $os, $arch)
17213 --build-log TEMPLATE
17215 Log all builds to file (name template can use $pkgid,
17216 $compiler, $os, $arch)
17217 --remote-build-reporting LEVEL
17219 Generate build reports to send to a remote server (none,
17220 anonymous or detailed).
17221 --report-planning-failure
17223 Generate build reports when the dependency solver fails.
17224 This is used by the Hackage build bot.
17225 --enable-per-component
17227 --disable-per-component
17228 Per-component builds when possible
17229 --one-shot
17231 --no-one-shot
17232 Do not record the packages in the world file.
17233 --run-tests
17235 Run package test suites during installation.
17236 -j, --jobs [NUM]
17238 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
17239 given).
17240 --keep-going
17242 After a build failure, continue to build other unaffected
17243 packages.
17244 --offline
17246 --no-offline
17247 Don't download packages from the Internet.
17248 --project-file FILE
17250 Set the name of the cabal.project file to search for in
17251 parent directories
17252 --only
17254 Only installs the package in the current directory.
17255 --haddock-hoogle
17257 Generate a hoogle database
17258 --haddock-html
17260 Generate HTML documentation (the default)
17261 --haddock-html-location URL
17263 Location of HTML documentation for pre-requisite packages
17264 --haddock-for-hackage
17266 Collection of flags to generate documentation suitable
17267 for upload to hackage
17268 --haddock-executables
17270 Run haddock for Executables targets
17271 --haddock-tests
17273 Run haddock for Test Suite targets
17274 --haddock-benchmarks
17276 Run haddock for Benchmark targets
17277 --haddock-all
17279 Run haddock for all targets
17280 --haddock-internal
17282 Run haddock for internal modules and include all symbols
17283 --haddock-css PATH
17285 Use PATH as the haddock stylesheet
17286 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
17288 dock-hyperlinked-source
17289 Hyperlink the documentation to the source code
17290 --haddock-quickjump
17292 Generate an index for interactive documentation naviga‐
17293 tion
17294 --haddock-hscolour-css PATH
17296 Use PATH as the HsColour stylesheet
17297 --haddock-contents-location URL
17299 Bake URL in as the location for the contents page
17300 --test-log TEMPLATE
17302 Log all test suite results to file (name template can use
17303 $pkgid, $compiler, $os, $arch, $test-suite, $result)
17304 --test-machine-log TEMPLATE
17306 Produce a machine-readable log file (name template can
17307 use $pkgid, $compiler, $os, $arch, $result)
17308 --test-show-details FILTER
17310 --test-keep-tix-files
17312 keep .tix files for HPC between test runs
17313 --test-wrapper FILE
17315 Run test through a wrapper.
17316 --test-fail-when-no-test-suites
17318 Exit with failure when no test suites are found.
17319 --test-options TEMPLATES
17321 give extra options to test executables (name templates
17322 can use $pkgid, $compiler, $os, $arch, $test-suite)
17323 --test-option TEMPLATE
17325 give extra option to test executables (no need to quote
17326 options containing spaces, name template can use $pkgid,
17327 $compiler, $os, $arch, $test-suite)
17328 --benchmark-options TEMPLATES
17330 give extra options to benchmark executables (name tem‐
17331 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
17332 --benchmark-option TEMPLATE
17334 give extra option to benchmark executables (no need to
17335 quote options containing spaces, name template can use
17336 $pkgid, $compiler, $os, $arch, $benchmark)
17337 --lib
17339 Install libraries rather than executables from the target
17340 package.
17341 -z, --ignore-project
17343 Ignore local project configuration
17344 --package-env, --env ENV
17346 Set the environment file that may be modified.
17347 --overwrite-policy always|never
17349 How to handle already existing symlinks.
17350 --install-method copy|symlink
17352 How to install the executables.
17353 --installdir DIR
17355 Where to install (by symlinking or copying) the executa‐
17356 bles in.
17357 cabal run
17360 Usage: cabal run [TARGET] [FLAGS] [-- EXECUTABLE_FLAGS]
17362 Runs the specified executable-like component (an executable, a test, or
17365 a benchmark), first ensuring it is up to date.
17366 Any executable-like component in any package in the project can be
17368 specified. A package can be specified if contains just one executable-
17369 like. The default is to use the package in the current directory if it
17370 contains just one executable-like.
17371 Extra arguments can be passed to the program, but use '--' to separate
17373 arguments for the program from arguments for cabal. The executable is
17374 run in an environment where it can find its data files inplace in the
17375 build tree.
17376 Dependencies are built or rebuilt as necessary. Additional configura‐
17378 tion flags can be specified on the command line and these extend the
17379 project configuration from the 'cabal.project', 'cabal.project.local'
17380 and other files.
17381 Runs the specified executable-like component (an executable, a test, or
17384 a benchmark), first ensuring it is up to date.
17385 Any executable-like component in any package in the project can be
17387 specified. A package can be specified if contains just one executable-
17388 like. The default is to use the package in the current directory if it
17389 contains just one executable-like.
17390 Extra arguments can be passed to the program, but use '--' to separate
17392 arguments for the program from arguments for cabal. The executable is
17393 run in an environment where it can find its data files inplace in the
17394 build tree.
17395 Dependencies are built or rebuilt as necessary. Additional configura‐
17397 tion flags can be specified on the command line and these extend the
17398 project configuration from the 'cabal.project', 'cabal.project.local'
17399 and other files.
17400 Flags:
17403 -v, --verbose [n]
17404 Control verbosity (n is 0--3, default verbosity level is
17405 1)
17406 --builddir, --distdir, --distpref DIR
17408 The directory where Cabal puts generated build files (de‐
17409 fault dist)
17410 -g, --ghc
17412 compile with GHC
17413 --ghcjs
17415 compile with GHCJS
17416 --uhc
17418 compile with UHC
17419 --haskell-suite
17421 compile with a haskell-suite compiler
17422 --cabal-file PATH
17424 use this Cabal file
17425 -w, --with-compiler PATH
17427 give the path to a particular compiler
17428 --with-hc-pkg PATH
17430 give the path to the package tool
17431 --prefix DIR
17433 bake this prefix in preparation of installation
17434 --bindir DIR
17436 installation directory for executables
17437 --libdir DIR
17439 installation directory for libraries
17440 --libsubdir DIR
17442 subdirectory of libdir in which libs are installed
17443 --dynlibdir DIR
17445 installation directory for dynamic libraries
17446 --libexecdir DIR
17448 installation directory for program executables
17449 --libexecsubdir DIR
17451 subdirectory of libexecdir in which private executables
17452 are installed
17453 --datadir DIR
17455 installation directory for read-only data
17456 --datasubdir DIR
17458 subdirectory of datadir in which data files are installed
17459 --docdir DIR
17461 installation directory for documentation
17462 --htmldir DIR
17464 installation directory for HTML documentation
17465 --haddockdir DIR
17467 installation directory for haddock interfaces
17468 --sysconfdir DIR
17470 installation directory for configuration files
17471 --program-prefix PREFIX
17473 prefix to be applied to installed executables
17474 --program-suffix SUFFIX
17476 suffix to be applied to installed executables
17477 --enable-library-vanilla
17479 --disable-library-vanilla
17480 Vanilla libraries
17481 -p, --enable-library-profiling
17483 --disable-library-profiling
17484 Library profiling
17485 --enable-shared
17487 --disable-shared
17488 Shared library
17489 --enable-static
17491 --disable-static
17492 Static library
17493 --enable-executable-dynamic
17495 --disable-executable-dynamic
17496 Executable dynamic linking
17497 --enable-executable-static
17499 --disable-executable-static
17500 Executable fully static linking
17501 --enable-profiling
17503 --disable-profiling
17504 Executable and library profiling
17505 --enable-executable-profiling
17507 --disable-executable-profiling
17508 Executable profiling (DEPRECATED)
17509 --profiling-detail level
17511 Profiling detail level for executable and library (de‐
17512 fault, none, exported-functions, toplevel-functions,
17513 all-functions).
17514 --library-profiling-detail level
17516 Profiling detail level for libraries only.
17517 -O, --enable-optimization, --enable-optimisation [n]
17519 Build with optimization (n is 0--2, default is 1)
17520 --disable-optimization, --disable-optimisation
17522 Build without optimization
17523 --enable-debug-info [n]
17525 Emit debug info (n is 0--3, default is 0)
17526 --disable-debug-info
17528 Don't emit debug info
17529 --enable-library-for-ghci
17531 --disable-library-for-ghci
17532 compile library for use with GHCi
17533 --enable-split-sections
17535 --disable-split-sections
17536 compile library code such that unneeded definitions can
17537 be dropped from the final executable (GHC 7.8+)
17538 --enable-split-objs
17540 --disable-split-objs
17541 split library into smaller objects to reduce binary sizes
17542 (GHC 6.6+)
17543 --enable-executable-stripping
17545 --disable-executable-stripping
17546 strip executables upon installation to reduce binary
17547 sizes
17548 --enable-library-stripping
17550 --disable-library-stripping
17551 strip libraries upon installation to reduce binary sizes
17552 --configure-option OPT
17554 Extra option for configure
17555 --user
17557 --global
17558 doing a per-user installation
17559 --package-db DB
17561 Append the given package database to the list of package
17562 databases used (to satisfy dependencies and register
17563 into). May be a specific file, 'global' or 'user'. The
17564 initial list is ['global'], ['global', 'user'], or
17565 ['global', $sandbox], depending on context. Use 'clear'
17566 to reset the list to empty. See the user guide for de‐
17567 tails.
17568 -f, --flags FLAGS
17570 Force values for the given flags in Cabal conditionals in
17571 the .cabal file. E.g., --flags="debug -usebytestrings"
17572 forces the flag "debug" to true and "usebytestrings" to
17573 false.
17574 --extra-include-dirs PATH
17576 A list of directories to search for header files
17577 --enable-deterministic
17579 --disable-deterministic
17580 Try to be as deterministic as possible (used by the test
17581 suite)
17582 --ipid IPID
17584 Installed package ID to compile this package as
17585 --cid CID
17587 Installed component ID to compile this component as
17588 --extra-lib-dirs PATH
17590 A list of directories to search for external libraries
17591 --extra-framework-dirs PATH
17593 A list of directories to search for external frameworks
17594 (OS X only)
17595 --extra-prog-path PATH
17597 A list of directories to search for required programs (in
17598 addition to the normal search locations)
17599 --instantiate-with NAME=MOD
17601 A mapping of signature names to concrete module instanti‐
17602 ations.
17603 --enable-tests
17605 --disable-tests
17606 dependency checking and compilation for test suites
17607 listed in the package description file.
17608 --enable-coverage
17610 --disable-coverage
17611 build package with Haskell Program Coverage. (GHC only)
17612 --enable-library-coverage
17614 --disable-library-coverage
17615 build package with Haskell Program Coverage. (GHC only)
17616 (DEPRECATED)
17617 --enable-benchmarks
17619 --disable-benchmarks
17620 dependency checking and compilation for benchmarks listed
17621 in the package description file.
17622 --enable-relocatable
17624 --disable-relocatable
17625 building a package that is relocatable. (GHC only)
17626 --disable-response-files
17628 enable workaround for old versions of programs like "ar"
17629 that do not support @file arguments
17630 --allow-depending-on-private-libs
17632 Allow depending on private libraries. If set, the library
17633 visibility check MUST be done externally.
17634 --with-alex PATH
17636 give the path to alex
17637 --with-ar PATH
17639 give the path to ar
17640 --with-c2hs PATH
17642 give the path to c2hs
17643 --with-cpphs PATH
17645 give the path to cpphs
17646 --with-doctest PATH
17648 give the path to doctest
17649 --with-gcc PATH
17651 give the path to gcc
17652 --with-ghc PATH
17654 give the path to ghc
17655 --with-ghc-pkg PATH
17657 give the path to ghc-pkg
17658 --with-ghcjs PATH
17660 give the path to ghcjs
17661 --with-ghcjs-pkg PATH
17663 give the path to ghcjs-pkg
17664 --with-greencard PATH
17666 give the path to greencard
17667 --with-haddock PATH
17669 give the path to haddock
17670 --with-happy PATH
17672 give the path to happy
17673 --with-haskell-suite PATH
17675 give the path to haskell-suite
17676 --with-haskell-suite-pkg PATH
17678 give the path to haskell-suite-pkg
17679 --with-hmake PATH
17681 give the path to hmake
17682 --with-hpc PATH
17684 give the path to hpc
17685 --with-hsc2hs PATH
17687 give the path to hsc2hs
17688 --with-hscolour PATH
17690 give the path to hscolour
17691 --with-jhc PATH
17693 give the path to jhc
17694 --with-ld PATH
17696 give the path to ld
17697 --with-pkg-config PATH
17699 give the path to pkg-config
17700 --with-runghc PATH
17702 give the path to runghc
17703 --with-strip PATH
17705 give the path to strip
17706 --with-tar PATH
17708 give the path to tar
17709 --with-uhc PATH
17711 give the path to uhc
17712 --alex-option OPT
17714 give an extra option to alex (no need to quote options
17715 containing spaces)
17716 --ar-option OPT
17718 give an extra option to ar (no need to quote options con‐
17719 taining spaces)
17720 --c2hs-option OPT
17722 give an extra option to c2hs (no need to quote options
17723 containing spaces)
17724 --cpphs-option OPT
17726 give an extra option to cpphs (no need to quote options
17727 containing spaces)
17728 --doctest-option OPT
17730 give an extra option to doctest (no need to quote options
17731 containing spaces)
17732 --gcc-option OPT
17734 give an extra option to gcc (no need to quote options
17735 containing spaces)
17736 --ghc-option OPT
17738 give an extra option to ghc (no need to quote options
17739 containing spaces)
17740 --ghc-pkg-option OPT
17742 give an extra option to ghc-pkg (no need to quote options
17743 containing spaces)
17744 --ghcjs-option OPT
17746 give an extra option to ghcjs (no need to quote options
17747 containing spaces)
17748 --ghcjs-pkg-option OPT
17750 give an extra option to ghcjs-pkg (no need to quote op‐
17751 tions containing spaces)
17752 --greencard-option OPT
17754 give an extra option to greencard (no need to quote op‐
17755 tions containing spaces)
17756 --haddock-option OPT
17758 give an extra option to haddock (no need to quote options
17759 containing spaces)
17760 --happy-option OPT
17762 give an extra option to happy (no need to quote options
17763 containing spaces)
17764 --haskell-suite-option OPT
17766 give an extra option to haskell-suite (no need to quote
17767 options containing spaces)
17768 --haskell-suite-pkg-option OPT
17770 give an extra option to haskell-suite-pkg (no need to
17771 quote options containing spaces)
17772 --hmake-option OPT
17774 give an extra option to hmake (no need to quote options
17775 containing spaces)
17776 --hpc-option OPT
17778 give an extra option to hpc (no need to quote options
17779 containing spaces)
17780 --hsc2hs-option OPT
17782 give an extra option to hsc2hs (no need to quote options
17783 containing spaces)
17784 --hscolour-option OPT
17786 give an extra option to hscolour (no need to quote op‐
17787 tions containing spaces)
17788 --jhc-option OPT
17790 give an extra option to jhc (no need to quote options
17791 containing spaces)
17792 --ld-option OPT
17794 give an extra option to ld (no need to quote options con‐
17795 taining spaces)
17796 --pkg-config-option OPT
17798 give an extra option to pkg-config (no need to quote op‐
17799 tions containing spaces)
17800 --runghc-option OPT
17802 give an extra option to runghc (no need to quote options
17803 containing spaces)
17804 --strip-option OPT
17806 give an extra option to strip (no need to quote options
17807 containing spaces)
17808 --tar-option OPT
17810 give an extra option to tar (no need to quote options
17811 containing spaces)
17812 --uhc-option OPT
17814 give an extra option to uhc (no need to quote options
17815 containing spaces)
17816 --alex-options OPTS
17818 give extra options to alex
17819 --ar-options OPTS
17821 give extra options to ar
17822 --c2hs-options OPTS
17824 give extra options to c2hs
17825 --cpphs-options OPTS
17827 give extra options to cpphs
17828 --doctest-options OPTS
17830 give extra options to doctest
17831 --gcc-options OPTS
17833 give extra options to gcc
17834 --ghc-options OPTS
17836 give extra options to ghc
17837 --ghc-pkg-options OPTS
17839 give extra options to ghc-pkg
17840 --ghcjs-options OPTS
17842 give extra options to ghcjs
17843 --ghcjs-pkg-options OPTS
17845 give extra options to ghcjs-pkg
17846 --greencard-options OPTS
17848 give extra options to greencard
17849 --haddock-options OPTS
17851 give extra options to haddock
17852 --happy-options OPTS
17854 give extra options to happy
17855 --haskell-suite-options OPTS
17857 give extra options to haskell-suite
17858 --haskell-suite-pkg-options OPTS
17860 give extra options to haskell-suite-pkg
17861 --hmake-options OPTS
17863 give extra options to hmake
17864 --hpc-options OPTS
17866 give extra options to hpc
17867 --hsc2hs-options OPTS
17869 give extra options to hsc2hs
17870 --hscolour-options OPTS
17872 give extra options to hscolour
17873 --jhc-options OPTS
17875 give extra options to jhc
17876 --ld-options OPTS
17878 give extra options to ld
17879 --pkg-config-options OPTS
17881 give extra options to pkg-config
17882 --runghc-options OPTS
17884 give extra options to runghc
17885 --strip-options OPTS
17887 give extra options to strip
17888 --tar-options OPTS
17890 give extra options to tar
17891 --uhc-options OPTS
17893 give extra options to uhc
17894 --cabal-lib-version VERSION
17896 Select which version of the Cabal lib to use to build
17897 packages (useful for testing).
17898 --constraint CONSTRAINT
17900 Specify constraints on a package (version, in‐
17901 stalled/source, flags)
17902 --preference CONSTRAINT
17904 Specify preferences (soft constraints) on the version of
17905 a package
17906 --solver SOLVER
17908 Select dependency solver to use (default: modular).
17909 Choices: modular.
17910 --allow-older [DEPS]
17912 Ignore lower bounds in all dependencies or DEPS
17913 --allow-newer [DEPS]
17915 Ignore upper bounds in all dependencies or DEPS
17916 --write-ghc-environment-files always|never|ghc8.4.4+
17918 Whether to create a .ghc.environment file after a suc‐
17919 cessful build (v2-build only)
17920 --enable-documentation
17922 --disable-documentation
17923 building of documentation
17924 --doc-index-file TEMPLATE
17926 A central index of haddock API documentation (template
17927 cannot use $pkgid)
17928 --dry-run
17930 Do not install anything, only print what would be in‐
17931 stalled.
17932 --max-backjumps NUM
17934 Maximum number of backjumps allowed while solving (de‐
17935 fault: 4000). Use a negative number to enable unlimited
17936 backtracking. Use 0 to disable backtracking completely.
17937 --reorder-goals
17939 --no-reorder-goals
17940 Try to reorder goals according to certain heuristics.
17941 Slows things down on average, but may make backtracking
17942 faster for some packages.
17943 --count-conflicts
17945 --no-count-conflicts
17946 Try to speed up solving by preferring goals that are in‐
17947 volved in a lot of conflicts (default).
17948 --fine-grained-conflicts
17950 --no-fine-grained-conflicts
17951 Skip a version of a package if it does not resolve the
17952 conflicts encountered in the last version, as a solver
17953 optimization (default).
17954 --minimize-conflict-set
17956 --no-minimize-conflict-set
17957 When there is no solution, try to improve the error mes‐
17958 sage by finding a minimal conflict set (default: false).
17959 May increase run time significantly.
17960 --independent-goals
17962 --no-independent-goals
17963 Treat several goals on the command line as independent.
17964 If several goals depend on the same package, different
17965 versions can be chosen.
17966 --shadow-installed-packages
17968 --no-shadow-installed-packages
17969 If multiple package instances of the same version are in‐
17970 stalled, treat all but one as shadowed.
17971 --strong-flags
17973 --no-strong-flags
17974 Do not defer flag choices (this used to be the default in
17975 cabal-install <= 1.20).
17976 --allow-boot-library-installs
17978 --no-allow-boot-library-installs
17979 Allow cabal to install base, ghc-prim, integer-simple,
17980 integer-gmp, and template-haskell.
17981 --reject-unconstrained-dependencies none|all
17983 Require these packages to have constraints on them if
17984 they are to be selected (default: none).
17985 --reinstall
17987 --no-reinstall
17988 Install even if it means installing the same version
17989 again.
17990 --avoid-reinstalls
17992 --no-avoid-reinstalls
17993 Do not select versions that would destructively overwrite
17994 installed packages.
17995 --force-reinstalls
17997 --no-force-reinstalls
17998 Reinstall packages even if they will most likely break
17999 other installed packages.
18000 --upgrade-dependencies
18002 --no-upgrade-dependencies
18003 Pick the latest version for all dependencies, rather than
18004 trying to pick an installed version.
18005 --only-dependencies
18007 --no-only-dependencies
18008 Install only the dependencies necessary to build the
18009 given packages
18010 --dependencies-only
18012 --no-dependencies-only
18013 A synonym for --only-dependencies
18014 --index-state STATE
18016 Use source package index state as it existed at a previ‐
18017 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
18018 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
18019 'HEAD' (default: 'HEAD').
18020 --root-cmd COMMAND
18022 (No longer supported, do not use.)
18023 --symlink-bindir DIR
18025 Add symlinks to installed executables into this direc‐
18026 tory.
18027 --build-summary TEMPLATE
18029 Save build summaries to file (name template can use
18030 $pkgid, $compiler, $os, $arch)
18031 --build-log TEMPLATE
18033 Log all builds to file (name template can use $pkgid,
18034 $compiler, $os, $arch)
18035 --remote-build-reporting LEVEL
18037 Generate build reports to send to a remote server (none,
18038 anonymous or detailed).
18039 --report-planning-failure
18041 Generate build reports when the dependency solver fails.
18042 This is used by the Hackage build bot.
18043 --enable-per-component
18045 --disable-per-component
18046 Per-component builds when possible
18047 --one-shot
18049 --no-one-shot
18050 Do not record the packages in the world file.
18051 --run-tests
18053 Run package test suites during installation.
18054 -j, --jobs [NUM]
18056 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
18057 given).
18058 --keep-going
18060 After a build failure, continue to build other unaffected
18061 packages.
18062 --offline
18064 --no-offline
18065 Don't download packages from the Internet.
18066 --project-file FILE
18068 Set the name of the cabal.project file to search for in
18069 parent directories
18070 --only
18072 Only installs the package in the current directory.
18073 --haddock-hoogle
18075 Generate a hoogle database
18076 --haddock-html
18078 Generate HTML documentation (the default)
18079 --haddock-html-location URL
18081 Location of HTML documentation for pre-requisite packages
18082 --haddock-for-hackage
18084 Collection of flags to generate documentation suitable
18085 for upload to hackage
18086 --haddock-executables
18088 Run haddock for Executables targets
18089 --haddock-tests
18091 Run haddock for Test Suite targets
18092 --haddock-benchmarks
18094 Run haddock for Benchmark targets
18095 --haddock-all
18097 Run haddock for all targets
18098 --haddock-internal
18100 Run haddock for internal modules and include all symbols
18101 --haddock-css PATH
18103 Use PATH as the haddock stylesheet
18104 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
18106 dock-hyperlinked-source
18107 Hyperlink the documentation to the source code
18108 --haddock-quickjump
18110 Generate an index for interactive documentation naviga‐
18111 tion
18112 --haddock-hscolour-css PATH
18114 Use PATH as the HsColour stylesheet
18115 --haddock-contents-location URL
18117 Bake URL in as the location for the contents page
18118 --test-log TEMPLATE
18120 Log all test suite results to file (name template can use
18121 $pkgid, $compiler, $os, $arch, $test-suite, $result)
18122 --test-machine-log TEMPLATE
18124 Produce a machine-readable log file (name template can
18125 use $pkgid, $compiler, $os, $arch, $result)
18126 --test-show-details FILTER
18128 --test-keep-tix-files
18130 keep .tix files for HPC between test runs
18131 --test-wrapper FILE
18133 Run test through a wrapper.
18134 --test-fail-when-no-test-suites
18136 Exit with failure when no test suites are found.
18137 --test-options TEMPLATES
18139 give extra options to test executables (name templates
18140 can use $pkgid, $compiler, $os, $arch, $test-suite)
18141 --test-option TEMPLATE
18143 give extra option to test executables (no need to quote
18144 options containing spaces, name template can use $pkgid,
18145 $compiler, $os, $arch, $test-suite)
18146 --benchmark-options TEMPLATES
18148 give extra options to benchmark executables (name tem‐
18149 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
18150 --benchmark-option TEMPLATE
18152 give extra option to benchmark executables (no need to
18153 quote options containing spaces, name template can use
18154 $pkgid, $compiler, $os, $arch, $benchmark)
18155 -z, --ignore-project
18157 Ignore local project configuration
18158 cabal new-run
18161 Usage: cabal new-run [TARGET] [FLAGS] [-- EXECUTABLE_FLAGS]
18163 Runs the specified executable-like component (an executable, a test, or
18166 a benchmark), first ensuring it is up to date.
18167 Any executable-like component in any package in the project can be
18169 specified. A package can be specified if contains just one executable-
18170 like. The default is to use the package in the current directory if it
18171 contains just one executable-like.
18172 Extra arguments can be passed to the program, but use '--' to separate
18174 arguments for the program from arguments for cabal. The executable is
18175 run in an environment where it can find its data files inplace in the
18176 build tree.
18177 Dependencies are built or rebuilt as necessary. Additional configura‐
18179 tion flags can be specified on the command line and these extend the
18180 project configuration from the 'cabal.project', 'cabal.project.local'
18181 and other files.
18182 Runs the specified executable-like component (an executable, a test, or
18185 a benchmark), first ensuring it is up to date.
18186 Any executable-like component in any package in the project can be
18188 specified. A package can be specified if contains just one executable-
18189 like. The default is to use the package in the current directory if it
18190 contains just one executable-like.
18191 Extra arguments can be passed to the program, but use '--' to separate
18193 arguments for the program from arguments for cabal. The executable is
18194 run in an environment where it can find its data files inplace in the
18195 build tree.
18196 Dependencies are built or rebuilt as necessary. Additional configura‐
18198 tion flags can be specified on the command line and these extend the
18199 project configuration from the 'cabal.project', 'cabal.project.local'
18200 and other files.
18201 Flags:
18204 -v, --verbose [n]
18205 Control verbosity (n is 0--3, default verbosity level is
18206 1)
18207 --builddir, --distdir, --distpref DIR
18209 The directory where Cabal puts generated build files (de‐
18210 fault dist)
18211 -g, --ghc
18213 compile with GHC
18214 --ghcjs
18216 compile with GHCJS
18217 --uhc
18219 compile with UHC
18220 --haskell-suite
18222 compile with a haskell-suite compiler
18223 --cabal-file PATH
18225 use this Cabal file
18226 -w, --with-compiler PATH
18228 give the path to a particular compiler
18229 --with-hc-pkg PATH
18231 give the path to the package tool
18232 --prefix DIR
18234 bake this prefix in preparation of installation
18235 --bindir DIR
18237 installation directory for executables
18238 --libdir DIR
18240 installation directory for libraries
18241 --libsubdir DIR
18243 subdirectory of libdir in which libs are installed
18244 --dynlibdir DIR
18246 installation directory for dynamic libraries
18247 --libexecdir DIR
18249 installation directory for program executables
18250 --libexecsubdir DIR
18252 subdirectory of libexecdir in which private executables
18253 are installed
18254 --datadir DIR
18256 installation directory for read-only data
18257 --datasubdir DIR
18259 subdirectory of datadir in which data files are installed
18260 --docdir DIR
18262 installation directory for documentation
18263 --htmldir DIR
18265 installation directory for HTML documentation
18266 --haddockdir DIR
18268 installation directory for haddock interfaces
18269 --sysconfdir DIR
18271 installation directory for configuration files
18272 --program-prefix PREFIX
18274 prefix to be applied to installed executables
18275 --program-suffix SUFFIX
18277 suffix to be applied to installed executables
18278 --enable-library-vanilla
18280 --disable-library-vanilla
18281 Vanilla libraries
18282 -p, --enable-library-profiling
18284 --disable-library-profiling
18285 Library profiling
18286 --enable-shared
18288 --disable-shared
18289 Shared library
18290 --enable-static
18292 --disable-static
18293 Static library
18294 --enable-executable-dynamic
18296 --disable-executable-dynamic
18297 Executable dynamic linking
18298 --enable-executable-static
18300 --disable-executable-static
18301 Executable fully static linking
18302 --enable-profiling
18304 --disable-profiling
18305 Executable and library profiling
18306 --enable-executable-profiling
18308 --disable-executable-profiling
18309 Executable profiling (DEPRECATED)
18310 --profiling-detail level
18312 Profiling detail level for executable and library (de‐
18313 fault, none, exported-functions, toplevel-functions,
18314 all-functions).
18315 --library-profiling-detail level
18317 Profiling detail level for libraries only.
18318 -O, --enable-optimization, --enable-optimisation [n]
18320 Build with optimization (n is 0--2, default is 1)
18321 --disable-optimization, --disable-optimisation
18323 Build without optimization
18324 --enable-debug-info [n]
18326 Emit debug info (n is 0--3, default is 0)
18327 --disable-debug-info
18329 Don't emit debug info
18330 --enable-library-for-ghci
18332 --disable-library-for-ghci
18333 compile library for use with GHCi
18334 --enable-split-sections
18336 --disable-split-sections
18337 compile library code such that unneeded definitions can
18338 be dropped from the final executable (GHC 7.8+)
18339 --enable-split-objs
18341 --disable-split-objs
18342 split library into smaller objects to reduce binary sizes
18343 (GHC 6.6+)
18344 --enable-executable-stripping
18346 --disable-executable-stripping
18347 strip executables upon installation to reduce binary
18348 sizes
18349 --enable-library-stripping
18351 --disable-library-stripping
18352 strip libraries upon installation to reduce binary sizes
18353 --configure-option OPT
18355 Extra option for configure
18356 --user
18358 --global
18359 doing a per-user installation
18360 --package-db DB
18362 Append the given package database to the list of package
18363 databases used (to satisfy dependencies and register
18364 into). May be a specific file, 'global' or 'user'. The
18365 initial list is ['global'], ['global', 'user'], or
18366 ['global', $sandbox], depending on context. Use 'clear'
18367 to reset the list to empty. See the user guide for de‐
18368 tails.
18369 -f, --flags FLAGS
18371 Force values for the given flags in Cabal conditionals in
18372 the .cabal file. E.g., --flags="debug -usebytestrings"
18373 forces the flag "debug" to true and "usebytestrings" to
18374 false.
18375 --extra-include-dirs PATH
18377 A list of directories to search for header files
18378 --enable-deterministic
18380 --disable-deterministic
18381 Try to be as deterministic as possible (used by the test
18382 suite)
18383 --ipid IPID
18385 Installed package ID to compile this package as
18386 --cid CID
18388 Installed component ID to compile this component as
18389 --extra-lib-dirs PATH
18391 A list of directories to search for external libraries
18392 --extra-framework-dirs PATH
18394 A list of directories to search for external frameworks
18395 (OS X only)
18396 --extra-prog-path PATH
18398 A list of directories to search for required programs (in
18399 addition to the normal search locations)
18400 --instantiate-with NAME=MOD
18402 A mapping of signature names to concrete module instanti‐
18403 ations.
18404 --enable-tests
18406 --disable-tests
18407 dependency checking and compilation for test suites
18408 listed in the package description file.
18409 --enable-coverage
18411 --disable-coverage
18412 build package with Haskell Program Coverage. (GHC only)
18413 --enable-library-coverage
18415 --disable-library-coverage
18416 build package with Haskell Program Coverage. (GHC only)
18417 (DEPRECATED)
18418 --enable-benchmarks
18420 --disable-benchmarks
18421 dependency checking and compilation for benchmarks listed
18422 in the package description file.
18423 --enable-relocatable
18425 --disable-relocatable
18426 building a package that is relocatable. (GHC only)
18427 --disable-response-files
18429 enable workaround for old versions of programs like "ar"
18430 that do not support @file arguments
18431 --allow-depending-on-private-libs
18433 Allow depending on private libraries. If set, the library
18434 visibility check MUST be done externally.
18435 --with-alex PATH
18437 give the path to alex
18438 --with-ar PATH
18440 give the path to ar
18441 --with-c2hs PATH
18443 give the path to c2hs
18444 --with-cpphs PATH
18446 give the path to cpphs
18447 --with-doctest PATH
18449 give the path to doctest
18450 --with-gcc PATH
18452 give the path to gcc
18453 --with-ghc PATH
18455 give the path to ghc
18456 --with-ghc-pkg PATH
18458 give the path to ghc-pkg
18459 --with-ghcjs PATH
18461 give the path to ghcjs
18462 --with-ghcjs-pkg PATH
18464 give the path to ghcjs-pkg
18465 --with-greencard PATH
18467 give the path to greencard
18468 --with-haddock PATH
18470 give the path to haddock
18471 --with-happy PATH
18473 give the path to happy
18474 --with-haskell-suite PATH
18476 give the path to haskell-suite
18477 --with-haskell-suite-pkg PATH
18479 give the path to haskell-suite-pkg
18480 --with-hmake PATH
18482 give the path to hmake
18483 --with-hpc PATH
18485 give the path to hpc
18486 --with-hsc2hs PATH
18488 give the path to hsc2hs
18489 --with-hscolour PATH
18491 give the path to hscolour
18492 --with-jhc PATH
18494 give the path to jhc
18495 --with-ld PATH
18497 give the path to ld
18498 --with-pkg-config PATH
18500 give the path to pkg-config
18501 --with-runghc PATH
18503 give the path to runghc
18504 --with-strip PATH
18506 give the path to strip
18507 --with-tar PATH
18509 give the path to tar
18510 --with-uhc PATH
18512 give the path to uhc
18513 --alex-option OPT
18515 give an extra option to alex (no need to quote options
18516 containing spaces)
18517 --ar-option OPT
18519 give an extra option to ar (no need to quote options con‐
18520 taining spaces)
18521 --c2hs-option OPT
18523 give an extra option to c2hs (no need to quote options
18524 containing spaces)
18525 --cpphs-option OPT
18527 give an extra option to cpphs (no need to quote options
18528 containing spaces)
18529 --doctest-option OPT
18531 give an extra option to doctest (no need to quote options
18532 containing spaces)
18533 --gcc-option OPT
18535 give an extra option to gcc (no need to quote options
18536 containing spaces)
18537 --ghc-option OPT
18539 give an extra option to ghc (no need to quote options
18540 containing spaces)
18541 --ghc-pkg-option OPT
18543 give an extra option to ghc-pkg (no need to quote options
18544 containing spaces)
18545 --ghcjs-option OPT
18547 give an extra option to ghcjs (no need to quote options
18548 containing spaces)
18549 --ghcjs-pkg-option OPT
18551 give an extra option to ghcjs-pkg (no need to quote op‐
18552 tions containing spaces)
18553 --greencard-option OPT
18555 give an extra option to greencard (no need to quote op‐
18556 tions containing spaces)
18557 --haddock-option OPT
18559 give an extra option to haddock (no need to quote options
18560 containing spaces)
18561 --happy-option OPT
18563 give an extra option to happy (no need to quote options
18564 containing spaces)
18565 --haskell-suite-option OPT
18567 give an extra option to haskell-suite (no need to quote
18568 options containing spaces)
18569 --haskell-suite-pkg-option OPT
18571 give an extra option to haskell-suite-pkg (no need to
18572 quote options containing spaces)
18573 --hmake-option OPT
18575 give an extra option to hmake (no need to quote options
18576 containing spaces)
18577 --hpc-option OPT
18579 give an extra option to hpc (no need to quote options
18580 containing spaces)
18581 --hsc2hs-option OPT
18583 give an extra option to hsc2hs (no need to quote options
18584 containing spaces)
18585 --hscolour-option OPT
18587 give an extra option to hscolour (no need to quote op‐
18588 tions containing spaces)
18589 --jhc-option OPT
18591 give an extra option to jhc (no need to quote options
18592 containing spaces)
18593 --ld-option OPT
18595 give an extra option to ld (no need to quote options con‐
18596 taining spaces)
18597 --pkg-config-option OPT
18599 give an extra option to pkg-config (no need to quote op‐
18600 tions containing spaces)
18601 --runghc-option OPT
18603 give an extra option to runghc (no need to quote options
18604 containing spaces)
18605 --strip-option OPT
18607 give an extra option to strip (no need to quote options
18608 containing spaces)
18609 --tar-option OPT
18611 give an extra option to tar (no need to quote options
18612 containing spaces)
18613 --uhc-option OPT
18615 give an extra option to uhc (no need to quote options
18616 containing spaces)
18617 --alex-options OPTS
18619 give extra options to alex
18620 --ar-options OPTS
18622 give extra options to ar
18623 --c2hs-options OPTS
18625 give extra options to c2hs
18626 --cpphs-options OPTS
18628 give extra options to cpphs
18629 --doctest-options OPTS
18631 give extra options to doctest
18632 --gcc-options OPTS
18634 give extra options to gcc
18635 --ghc-options OPTS
18637 give extra options to ghc
18638 --ghc-pkg-options OPTS
18640 give extra options to ghc-pkg
18641 --ghcjs-options OPTS
18643 give extra options to ghcjs
18644 --ghcjs-pkg-options OPTS
18646 give extra options to ghcjs-pkg
18647 --greencard-options OPTS
18649 give extra options to greencard
18650 --haddock-options OPTS
18652 give extra options to haddock
18653 --happy-options OPTS
18655 give extra options to happy
18656 --haskell-suite-options OPTS
18658 give extra options to haskell-suite
18659 --haskell-suite-pkg-options OPTS
18661 give extra options to haskell-suite-pkg
18662 --hmake-options OPTS
18664 give extra options to hmake
18665 --hpc-options OPTS
18667 give extra options to hpc
18668 --hsc2hs-options OPTS
18670 give extra options to hsc2hs
18671 --hscolour-options OPTS
18673 give extra options to hscolour
18674 --jhc-options OPTS
18676 give extra options to jhc
18677 --ld-options OPTS
18679 give extra options to ld
18680 --pkg-config-options OPTS
18682 give extra options to pkg-config
18683 --runghc-options OPTS
18685 give extra options to runghc
18686 --strip-options OPTS
18688 give extra options to strip
18689 --tar-options OPTS
18691 give extra options to tar
18692 --uhc-options OPTS
18694 give extra options to uhc
18695 --cabal-lib-version VERSION
18697 Select which version of the Cabal lib to use to build
18698 packages (useful for testing).
18699 --constraint CONSTRAINT
18701 Specify constraints on a package (version, in‐
18702 stalled/source, flags)
18703 --preference CONSTRAINT
18705 Specify preferences (soft constraints) on the version of
18706 a package
18707 --solver SOLVER
18709 Select dependency solver to use (default: modular).
18710 Choices: modular.
18711 --allow-older [DEPS]
18713 Ignore lower bounds in all dependencies or DEPS
18714 --allow-newer [DEPS]
18716 Ignore upper bounds in all dependencies or DEPS
18717 --write-ghc-environment-files always|never|ghc8.4.4+
18719 Whether to create a .ghc.environment file after a suc‐
18720 cessful build (v2-build only)
18721 --enable-documentation
18723 --disable-documentation
18724 building of documentation
18725 --doc-index-file TEMPLATE
18727 A central index of haddock API documentation (template
18728 cannot use $pkgid)
18729 --dry-run
18731 Do not install anything, only print what would be in‐
18732 stalled.
18733 --max-backjumps NUM
18735 Maximum number of backjumps allowed while solving (de‐
18736 fault: 4000). Use a negative number to enable unlimited
18737 backtracking. Use 0 to disable backtracking completely.
18738 --reorder-goals
18740 --no-reorder-goals
18741 Try to reorder goals according to certain heuristics.
18742 Slows things down on average, but may make backtracking
18743 faster for some packages.
18744 --count-conflicts
18746 --no-count-conflicts
18747 Try to speed up solving by preferring goals that are in‐
18748 volved in a lot of conflicts (default).
18749 --fine-grained-conflicts
18751 --no-fine-grained-conflicts
18752 Skip a version of a package if it does not resolve the
18753 conflicts encountered in the last version, as a solver
18754 optimization (default).
18755 --minimize-conflict-set
18757 --no-minimize-conflict-set
18758 When there is no solution, try to improve the error mes‐
18759 sage by finding a minimal conflict set (default: false).
18760 May increase run time significantly.
18761 --independent-goals
18763 --no-independent-goals
18764 Treat several goals on the command line as independent.
18765 If several goals depend on the same package, different
18766 versions can be chosen.
18767 --shadow-installed-packages
18769 --no-shadow-installed-packages
18770 If multiple package instances of the same version are in‐
18771 stalled, treat all but one as shadowed.
18772 --strong-flags
18774 --no-strong-flags
18775 Do not defer flag choices (this used to be the default in
18776 cabal-install <= 1.20).
18777 --allow-boot-library-installs
18779 --no-allow-boot-library-installs
18780 Allow cabal to install base, ghc-prim, integer-simple,
18781 integer-gmp, and template-haskell.
18782 --reject-unconstrained-dependencies none|all
18784 Require these packages to have constraints on them if
18785 they are to be selected (default: none).
18786 --reinstall
18788 --no-reinstall
18789 Install even if it means installing the same version
18790 again.
18791 --avoid-reinstalls
18793 --no-avoid-reinstalls
18794 Do not select versions that would destructively overwrite
18795 installed packages.
18796 --force-reinstalls
18798 --no-force-reinstalls
18799 Reinstall packages even if they will most likely break
18800 other installed packages.
18801 --upgrade-dependencies
18803 --no-upgrade-dependencies
18804 Pick the latest version for all dependencies, rather than
18805 trying to pick an installed version.
18806 --only-dependencies
18808 --no-only-dependencies
18809 Install only the dependencies necessary to build the
18810 given packages
18811 --dependencies-only
18813 --no-dependencies-only
18814 A synonym for --only-dependencies
18815 --index-state STATE
18817 Use source package index state as it existed at a previ‐
18818 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
18819 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
18820 'HEAD' (default: 'HEAD').
18821 --root-cmd COMMAND
18823 (No longer supported, do not use.)
18824 --symlink-bindir DIR
18826 Add symlinks to installed executables into this direc‐
18827 tory.
18828 --build-summary TEMPLATE
18830 Save build summaries to file (name template can use
18831 $pkgid, $compiler, $os, $arch)
18832 --build-log TEMPLATE
18834 Log all builds to file (name template can use $pkgid,
18835 $compiler, $os, $arch)
18836 --remote-build-reporting LEVEL
18838 Generate build reports to send to a remote server (none,
18839 anonymous or detailed).
18840 --report-planning-failure
18842 Generate build reports when the dependency solver fails.
18843 This is used by the Hackage build bot.
18844 --enable-per-component
18846 --disable-per-component
18847 Per-component builds when possible
18848 --one-shot
18850 --no-one-shot
18851 Do not record the packages in the world file.
18852 --run-tests
18854 Run package test suites during installation.
18855 -j, --jobs [NUM]
18857 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
18858 given).
18859 --keep-going
18861 After a build failure, continue to build other unaffected
18862 packages.
18863 --offline
18865 --no-offline
18866 Don't download packages from the Internet.
18867 --project-file FILE
18869 Set the name of the cabal.project file to search for in
18870 parent directories
18871 --only
18873 Only installs the package in the current directory.
18874 --haddock-hoogle
18876 Generate a hoogle database
18877 --haddock-html
18879 Generate HTML documentation (the default)
18880 --haddock-html-location URL
18882 Location of HTML documentation for pre-requisite packages
18883 --haddock-for-hackage
18885 Collection of flags to generate documentation suitable
18886 for upload to hackage
18887 --haddock-executables
18889 Run haddock for Executables targets
18890 --haddock-tests
18892 Run haddock for Test Suite targets
18893 --haddock-benchmarks
18895 Run haddock for Benchmark targets
18896 --haddock-all
18898 Run haddock for all targets
18899 --haddock-internal
18901 Run haddock for internal modules and include all symbols
18902 --haddock-css PATH
18904 Use PATH as the haddock stylesheet
18905 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
18907 dock-hyperlinked-source
18908 Hyperlink the documentation to the source code
18909 --haddock-quickjump
18911 Generate an index for interactive documentation naviga‐
18912 tion
18913 --haddock-hscolour-css PATH
18915 Use PATH as the HsColour stylesheet
18916 --haddock-contents-location URL
18918 Bake URL in as the location for the contents page
18919 --test-log TEMPLATE
18921 Log all test suite results to file (name template can use
18922 $pkgid, $compiler, $os, $arch, $test-suite, $result)
18923 --test-machine-log TEMPLATE
18925 Produce a machine-readable log file (name template can
18926 use $pkgid, $compiler, $os, $arch, $result)
18927 --test-show-details FILTER
18929 --test-keep-tix-files
18931 keep .tix files for HPC between test runs
18932 --test-wrapper FILE
18934 Run test through a wrapper.
18935 --test-fail-when-no-test-suites
18937 Exit with failure when no test suites are found.
18938 --test-options TEMPLATES
18940 give extra options to test executables (name templates
18941 can use $pkgid, $compiler, $os, $arch, $test-suite)
18942 --test-option TEMPLATE
18944 give extra option to test executables (no need to quote
18945 options containing spaces, name template can use $pkgid,
18946 $compiler, $os, $arch, $test-suite)
18947 --benchmark-options TEMPLATES
18949 give extra options to benchmark executables (name tem‐
18950 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
18951 --benchmark-option TEMPLATE
18953 give extra option to benchmark executables (no need to
18954 quote options containing spaces, name template can use
18955 $pkgid, $compiler, $os, $arch, $benchmark)
18956 -z, --ignore-project
18958 Ignore local project configuration
18959 cabal v2-run
18962 Usage: cabal v2-run [TARGET] [FLAGS] [-- EXECUTABLE_FLAGS]
18964 Runs the specified executable-like component (an executable, a test, or
18967 a benchmark), first ensuring it is up to date.
18968 Any executable-like component in any package in the project can be
18970 specified. A package can be specified if contains just one executable-
18971 like. The default is to use the package in the current directory if it
18972 contains just one executable-like.
18973 Extra arguments can be passed to the program, but use '--' to separate
18975 arguments for the program from arguments for cabal. The executable is
18976 run in an environment where it can find its data files inplace in the
18977 build tree.
18978 Dependencies are built or rebuilt as necessary. Additional configura‐
18980 tion flags can be specified on the command line and these extend the
18981 project configuration from the 'cabal.project', 'cabal.project.local'
18982 and other files.
18983 Examples:
18986 cabal v2-run
18987 Run the executable-like in the package in the current directory
18988 cabal v2-run foo-tool
18989 Run the named executable-like (in any package in the project)
18990 cabal v2-run pkgfoo:foo-tool
18991 Run the executable-like 'foo-tool' in the package 'pkgfoo'
18992 cabal v2-run foo -O2 -- dothing --fooflag
18993 Build with '-O2' and run the program, passing it extra arguments.
18994 Note: this command is part of the new project-based system (aka nix-
18996 style local builds). These features are currently in beta. Please see
18997 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
18998 details and advice on what you can expect to work. If you encounter
18999 problems please file issues at https://github.com/haskell/cabal/issues
19000 and if you have any time to get involved and help with testing, fixing
19001 bugs etc then that is very much appreciated.
19002 Flags:
19005 -v, --verbose [n]
19006 Control verbosity (n is 0--3, default verbosity level is
19007 1)
19008 --builddir, --distdir, --distpref DIR
19010 The directory where Cabal puts generated build files (de‐
19011 fault dist)
19012 -g, --ghc
19014 compile with GHC
19015 --ghcjs
19017 compile with GHCJS
19018 --uhc
19020 compile with UHC
19021 --haskell-suite
19023 compile with a haskell-suite compiler
19024 --cabal-file PATH
19026 use this Cabal file
19027 -w, --with-compiler PATH
19029 give the path to a particular compiler
19030 --with-hc-pkg PATH
19032 give the path to the package tool
19033 --prefix DIR
19035 bake this prefix in preparation of installation
19036 --bindir DIR
19038 installation directory for executables
19039 --libdir DIR
19041 installation directory for libraries
19042 --libsubdir DIR
19044 subdirectory of libdir in which libs are installed
19045 --dynlibdir DIR
19047 installation directory for dynamic libraries
19048 --libexecdir DIR
19050 installation directory for program executables
19051 --libexecsubdir DIR
19053 subdirectory of libexecdir in which private executables
19054 are installed
19055 --datadir DIR
19057 installation directory for read-only data
19058 --datasubdir DIR
19060 subdirectory of datadir in which data files are installed
19061 --docdir DIR
19063 installation directory for documentation
19064 --htmldir DIR
19066 installation directory for HTML documentation
19067 --haddockdir DIR
19069 installation directory for haddock interfaces
19070 --sysconfdir DIR
19072 installation directory for configuration files
19073 --program-prefix PREFIX
19075 prefix to be applied to installed executables
19076 --program-suffix SUFFIX
19078 suffix to be applied to installed executables
19079 --enable-library-vanilla
19081 --disable-library-vanilla
19082 Vanilla libraries
19083 -p, --enable-library-profiling
19085 --disable-library-profiling
19086 Library profiling
19087 --enable-shared
19089 --disable-shared
19090 Shared library
19091 --enable-static
19093 --disable-static
19094 Static library
19095 --enable-executable-dynamic
19097 --disable-executable-dynamic
19098 Executable dynamic linking
19099 --enable-executable-static
19101 --disable-executable-static
19102 Executable fully static linking
19103 --enable-profiling
19105 --disable-profiling
19106 Executable and library profiling
19107 --enable-executable-profiling
19109 --disable-executable-profiling
19110 Executable profiling (DEPRECATED)
19111 --profiling-detail level
19113 Profiling detail level for executable and library (de‐
19114 fault, none, exported-functions, toplevel-functions,
19115 all-functions).
19116 --library-profiling-detail level
19118 Profiling detail level for libraries only.
19119 -O, --enable-optimization, --enable-optimisation [n]
19121 Build with optimization (n is 0--2, default is 1)
19122 --disable-optimization, --disable-optimisation
19124 Build without optimization
19125 --enable-debug-info [n]
19127 Emit debug info (n is 0--3, default is 0)
19128 --disable-debug-info
19130 Don't emit debug info
19131 --enable-library-for-ghci
19133 --disable-library-for-ghci
19134 compile library for use with GHCi
19135 --enable-split-sections
19137 --disable-split-sections
19138 compile library code such that unneeded definitions can
19139 be dropped from the final executable (GHC 7.8+)
19140 --enable-split-objs
19142 --disable-split-objs
19143 split library into smaller objects to reduce binary sizes
19144 (GHC 6.6+)
19145 --enable-executable-stripping
19147 --disable-executable-stripping
19148 strip executables upon installation to reduce binary
19149 sizes
19150 --enable-library-stripping
19152 --disable-library-stripping
19153 strip libraries upon installation to reduce binary sizes
19154 --configure-option OPT
19156 Extra option for configure
19157 --user
19159 --global
19160 doing a per-user installation
19161 --package-db DB
19163 Append the given package database to the list of package
19164 databases used (to satisfy dependencies and register
19165 into). May be a specific file, 'global' or 'user'. The
19166 initial list is ['global'], ['global', 'user'], or
19167 ['global', $sandbox], depending on context. Use 'clear'
19168 to reset the list to empty. See the user guide for de‐
19169 tails.
19170 -f, --flags FLAGS
19172 Force values for the given flags in Cabal conditionals in
19173 the .cabal file. E.g., --flags="debug -usebytestrings"
19174 forces the flag "debug" to true and "usebytestrings" to
19175 false.
19176 --extra-include-dirs PATH
19178 A list of directories to search for header files
19179 --enable-deterministic
19181 --disable-deterministic
19182 Try to be as deterministic as possible (used by the test
19183 suite)
19184 --ipid IPID
19186 Installed package ID to compile this package as
19187 --cid CID
19189 Installed component ID to compile this component as
19190 --extra-lib-dirs PATH
19192 A list of directories to search for external libraries
19193 --extra-framework-dirs PATH
19195 A list of directories to search for external frameworks
19196 (OS X only)
19197 --extra-prog-path PATH
19199 A list of directories to search for required programs (in
19200 addition to the normal search locations)
19201 --instantiate-with NAME=MOD
19203 A mapping of signature names to concrete module instanti‐
19204 ations.
19205 --enable-tests
19207 --disable-tests
19208 dependency checking and compilation for test suites
19209 listed in the package description file.
19210 --enable-coverage
19212 --disable-coverage
19213 build package with Haskell Program Coverage. (GHC only)
19214 --enable-library-coverage
19216 --disable-library-coverage
19217 build package with Haskell Program Coverage. (GHC only)
19218 (DEPRECATED)
19219 --enable-benchmarks
19221 --disable-benchmarks
19222 dependency checking and compilation for benchmarks listed
19223 in the package description file.
19224 --enable-relocatable
19226 --disable-relocatable
19227 building a package that is relocatable. (GHC only)
19228 --disable-response-files
19230 enable workaround for old versions of programs like "ar"
19231 that do not support @file arguments
19232 --allow-depending-on-private-libs
19234 Allow depending on private libraries. If set, the library
19235 visibility check MUST be done externally.
19236 --with-alex PATH
19238 give the path to alex
19239 --with-ar PATH
19241 give the path to ar
19242 --with-c2hs PATH
19244 give the path to c2hs
19245 --with-cpphs PATH
19247 give the path to cpphs
19248 --with-doctest PATH
19250 give the path to doctest
19251 --with-gcc PATH
19253 give the path to gcc
19254 --with-ghc PATH
19256 give the path to ghc
19257 --with-ghc-pkg PATH
19259 give the path to ghc-pkg
19260 --with-ghcjs PATH
19262 give the path to ghcjs
19263 --with-ghcjs-pkg PATH
19265 give the path to ghcjs-pkg
19266 --with-greencard PATH
19268 give the path to greencard
19269 --with-haddock PATH
19271 give the path to haddock
19272 --with-happy PATH
19274 give the path to happy
19275 --with-haskell-suite PATH
19277 give the path to haskell-suite
19278 --with-haskell-suite-pkg PATH
19280 give the path to haskell-suite-pkg
19281 --with-hmake PATH
19283 give the path to hmake
19284 --with-hpc PATH
19286 give the path to hpc
19287 --with-hsc2hs PATH
19289 give the path to hsc2hs
19290 --with-hscolour PATH
19292 give the path to hscolour
19293 --with-jhc PATH
19295 give the path to jhc
19296 --with-ld PATH
19298 give the path to ld
19299 --with-pkg-config PATH
19301 give the path to pkg-config
19302 --with-runghc PATH
19304 give the path to runghc
19305 --with-strip PATH
19307 give the path to strip
19308 --with-tar PATH
19310 give the path to tar
19311 --with-uhc PATH
19313 give the path to uhc
19314 --alex-option OPT
19316 give an extra option to alex (no need to quote options
19317 containing spaces)
19318 --ar-option OPT
19320 give an extra option to ar (no need to quote options con‐
19321 taining spaces)
19322 --c2hs-option OPT
19324 give an extra option to c2hs (no need to quote options
19325 containing spaces)
19326 --cpphs-option OPT
19328 give an extra option to cpphs (no need to quote options
19329 containing spaces)
19330 --doctest-option OPT
19332 give an extra option to doctest (no need to quote options
19333 containing spaces)
19334 --gcc-option OPT
19336 give an extra option to gcc (no need to quote options
19337 containing spaces)
19338 --ghc-option OPT
19340 give an extra option to ghc (no need to quote options
19341 containing spaces)
19342 --ghc-pkg-option OPT
19344 give an extra option to ghc-pkg (no need to quote options
19345 containing spaces)
19346 --ghcjs-option OPT
19348 give an extra option to ghcjs (no need to quote options
19349 containing spaces)
19350 --ghcjs-pkg-option OPT
19352 give an extra option to ghcjs-pkg (no need to quote op‐
19353 tions containing spaces)
19354 --greencard-option OPT
19356 give an extra option to greencard (no need to quote op‐
19357 tions containing spaces)
19358 --haddock-option OPT
19360 give an extra option to haddock (no need to quote options
19361 containing spaces)
19362 --happy-option OPT
19364 give an extra option to happy (no need to quote options
19365 containing spaces)
19366 --haskell-suite-option OPT
19368 give an extra option to haskell-suite (no need to quote
19369 options containing spaces)
19370 --haskell-suite-pkg-option OPT
19372 give an extra option to haskell-suite-pkg (no need to
19373 quote options containing spaces)
19374 --hmake-option OPT
19376 give an extra option to hmake (no need to quote options
19377 containing spaces)
19378 --hpc-option OPT
19380 give an extra option to hpc (no need to quote options
19381 containing spaces)
19382 --hsc2hs-option OPT
19384 give an extra option to hsc2hs (no need to quote options
19385 containing spaces)
19386 --hscolour-option OPT
19388 give an extra option to hscolour (no need to quote op‐
19389 tions containing spaces)
19390 --jhc-option OPT
19392 give an extra option to jhc (no need to quote options
19393 containing spaces)
19394 --ld-option OPT
19396 give an extra option to ld (no need to quote options con‐
19397 taining spaces)
19398 --pkg-config-option OPT
19400 give an extra option to pkg-config (no need to quote op‐
19401 tions containing spaces)
19402 --runghc-option OPT
19404 give an extra option to runghc (no need to quote options
19405 containing spaces)
19406 --strip-option OPT
19408 give an extra option to strip (no need to quote options
19409 containing spaces)
19410 --tar-option OPT
19412 give an extra option to tar (no need to quote options
19413 containing spaces)
19414 --uhc-option OPT
19416 give an extra option to uhc (no need to quote options
19417 containing spaces)
19418 --alex-options OPTS
19420 give extra options to alex
19421 --ar-options OPTS
19423 give extra options to ar
19424 --c2hs-options OPTS
19426 give extra options to c2hs
19427 --cpphs-options OPTS
19429 give extra options to cpphs
19430 --doctest-options OPTS
19432 give extra options to doctest
19433 --gcc-options OPTS
19435 give extra options to gcc
19436 --ghc-options OPTS
19438 give extra options to ghc
19439 --ghc-pkg-options OPTS
19441 give extra options to ghc-pkg
19442 --ghcjs-options OPTS
19444 give extra options to ghcjs
19445 --ghcjs-pkg-options OPTS
19447 give extra options to ghcjs-pkg
19448 --greencard-options OPTS
19450 give extra options to greencard
19451 --haddock-options OPTS
19453 give extra options to haddock
19454 --happy-options OPTS
19456 give extra options to happy
19457 --haskell-suite-options OPTS
19459 give extra options to haskell-suite
19460 --haskell-suite-pkg-options OPTS
19462 give extra options to haskell-suite-pkg
19463 --hmake-options OPTS
19465 give extra options to hmake
19466 --hpc-options OPTS
19468 give extra options to hpc
19469 --hsc2hs-options OPTS
19471 give extra options to hsc2hs
19472 --hscolour-options OPTS
19474 give extra options to hscolour
19475 --jhc-options OPTS
19477 give extra options to jhc
19478 --ld-options OPTS
19480 give extra options to ld
19481 --pkg-config-options OPTS
19483 give extra options to pkg-config
19484 --runghc-options OPTS
19486 give extra options to runghc
19487 --strip-options OPTS
19489 give extra options to strip
19490 --tar-options OPTS
19492 give extra options to tar
19493 --uhc-options OPTS
19495 give extra options to uhc
19496 --cabal-lib-version VERSION
19498 Select which version of the Cabal lib to use to build
19499 packages (useful for testing).
19500 --constraint CONSTRAINT
19502 Specify constraints on a package (version, in‐
19503 stalled/source, flags)
19504 --preference CONSTRAINT
19506 Specify preferences (soft constraints) on the version of
19507 a package
19508 --solver SOLVER
19510 Select dependency solver to use (default: modular).
19511 Choices: modular.
19512 --allow-older [DEPS]
19514 Ignore lower bounds in all dependencies or DEPS
19515 --allow-newer [DEPS]
19517 Ignore upper bounds in all dependencies or DEPS
19518 --write-ghc-environment-files always|never|ghc8.4.4+
19520 Whether to create a .ghc.environment file after a suc‐
19521 cessful build (v2-build only)
19522 --enable-documentation
19524 --disable-documentation
19525 building of documentation
19526 --doc-index-file TEMPLATE
19528 A central index of haddock API documentation (template
19529 cannot use $pkgid)
19530 --dry-run
19532 Do not install anything, only print what would be in‐
19533 stalled.
19534 --max-backjumps NUM
19536 Maximum number of backjumps allowed while solving (de‐
19537 fault: 4000). Use a negative number to enable unlimited
19538 backtracking. Use 0 to disable backtracking completely.
19539 --reorder-goals
19541 --no-reorder-goals
19542 Try to reorder goals according to certain heuristics.
19543 Slows things down on average, but may make backtracking
19544 faster for some packages.
19545 --count-conflicts
19547 --no-count-conflicts
19548 Try to speed up solving by preferring goals that are in‐
19549 volved in a lot of conflicts (default).
19550 --fine-grained-conflicts
19552 --no-fine-grained-conflicts
19553 Skip a version of a package if it does not resolve the
19554 conflicts encountered in the last version, as a solver
19555 optimization (default).
19556 --minimize-conflict-set
19558 --no-minimize-conflict-set
19559 When there is no solution, try to improve the error mes‐
19560 sage by finding a minimal conflict set (default: false).
19561 May increase run time significantly.
19562 --independent-goals
19564 --no-independent-goals
19565 Treat several goals on the command line as independent.
19566 If several goals depend on the same package, different
19567 versions can be chosen.
19568 --shadow-installed-packages
19570 --no-shadow-installed-packages
19571 If multiple package instances of the same version are in‐
19572 stalled, treat all but one as shadowed.
19573 --strong-flags
19575 --no-strong-flags
19576 Do not defer flag choices (this used to be the default in
19577 cabal-install <= 1.20).
19578 --allow-boot-library-installs
19580 --no-allow-boot-library-installs
19581 Allow cabal to install base, ghc-prim, integer-simple,
19582 integer-gmp, and template-haskell.
19583 --reject-unconstrained-dependencies none|all
19585 Require these packages to have constraints on them if
19586 they are to be selected (default: none).
19587 --reinstall
19589 --no-reinstall
19590 Install even if it means installing the same version
19591 again.
19592 --avoid-reinstalls
19594 --no-avoid-reinstalls
19595 Do not select versions that would destructively overwrite
19596 installed packages.
19597 --force-reinstalls
19599 --no-force-reinstalls
19600 Reinstall packages even if they will most likely break
19601 other installed packages.
19602 --upgrade-dependencies
19604 --no-upgrade-dependencies
19605 Pick the latest version for all dependencies, rather than
19606 trying to pick an installed version.
19607 --only-dependencies
19609 --no-only-dependencies
19610 Install only the dependencies necessary to build the
19611 given packages
19612 --dependencies-only
19614 --no-dependencies-only
19615 A synonym for --only-dependencies
19616 --index-state STATE
19618 Use source package index state as it existed at a previ‐
19619 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
19620 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
19621 'HEAD' (default: 'HEAD').
19622 --root-cmd COMMAND
19624 (No longer supported, do not use.)
19625 --symlink-bindir DIR
19627 Add symlinks to installed executables into this direc‐
19628 tory.
19629 --build-summary TEMPLATE
19631 Save build summaries to file (name template can use
19632 $pkgid, $compiler, $os, $arch)
19633 --build-log TEMPLATE
19635 Log all builds to file (name template can use $pkgid,
19636 $compiler, $os, $arch)
19637 --remote-build-reporting LEVEL
19639 Generate build reports to send to a remote server (none,
19640 anonymous or detailed).
19641 --report-planning-failure
19643 Generate build reports when the dependency solver fails.
19644 This is used by the Hackage build bot.
19645 --enable-per-component
19647 --disable-per-component
19648 Per-component builds when possible
19649 --one-shot
19651 --no-one-shot
19652 Do not record the packages in the world file.
19653 --run-tests
19655 Run package test suites during installation.
19656 -j, --jobs [NUM]
19658 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
19659 given).
19660 --keep-going
19662 After a build failure, continue to build other unaffected
19663 packages.
19664 --offline
19666 --no-offline
19667 Don't download packages from the Internet.
19668 --project-file FILE
19670 Set the name of the cabal.project file to search for in
19671 parent directories
19672 --only
19674 Only installs the package in the current directory.
19675 --haddock-hoogle
19677 Generate a hoogle database
19678 --haddock-html
19680 Generate HTML documentation (the default)
19681 --haddock-html-location URL
19683 Location of HTML documentation for pre-requisite packages
19684 --haddock-for-hackage
19686 Collection of flags to generate documentation suitable
19687 for upload to hackage
19688 --haddock-executables
19690 Run haddock for Executables targets
19691 --haddock-tests
19693 Run haddock for Test Suite targets
19694 --haddock-benchmarks
19696 Run haddock for Benchmark targets
19697 --haddock-all
19699 Run haddock for all targets
19700 --haddock-internal
19702 Run haddock for internal modules and include all symbols
19703 --haddock-css PATH
19705 Use PATH as the haddock stylesheet
19706 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
19708 dock-hyperlinked-source
19709 Hyperlink the documentation to the source code
19710 --haddock-quickjump
19712 Generate an index for interactive documentation naviga‐
19713 tion
19714 --haddock-hscolour-css PATH
19716 Use PATH as the HsColour stylesheet
19717 --haddock-contents-location URL
19719 Bake URL in as the location for the contents page
19720 --test-log TEMPLATE
19722 Log all test suite results to file (name template can use
19723 $pkgid, $compiler, $os, $arch, $test-suite, $result)
19724 --test-machine-log TEMPLATE
19726 Produce a machine-readable log file (name template can
19727 use $pkgid, $compiler, $os, $arch, $result)
19728 --test-show-details FILTER
19730 --test-keep-tix-files
19732 keep .tix files for HPC between test runs
19733 --test-wrapper FILE
19735 Run test through a wrapper.
19736 --test-fail-when-no-test-suites
19738 Exit with failure when no test suites are found.
19739 --test-options TEMPLATES
19741 give extra options to test executables (name templates
19742 can use $pkgid, $compiler, $os, $arch, $test-suite)
19743 --test-option TEMPLATE
19745 give extra option to test executables (no need to quote
19746 options containing spaces, name template can use $pkgid,
19747 $compiler, $os, $arch, $test-suite)
19748 --benchmark-options TEMPLATES
19750 give extra options to benchmark executables (name tem‐
19751 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
19752 --benchmark-option TEMPLATE
19754 give extra option to benchmark executables (no need to
19755 quote options containing spaces, name template can use
19756 $pkgid, $compiler, $os, $arch, $benchmark)
19757 -z, --ignore-project
19759 Ignore local project configuration
19760 cabal test
19763 Usage: cabal test [TARGETS] [FLAGS]
19765 Runs the specified test-suites, first ensuring they are up to date.
19768 Any test-suite in any package in the project can be specified. A pack‐
19770 age can be specified in which case all the test-suites in the package
19771 are run. The default is to run all the test-suites in the package in
19772 the current directory.
19773 Dependencies are built or rebuilt as necessary. Additional configura‐
19775 tion flags can be specified on the command line and these extend the
19776 project configuration from the 'cabal.project', 'cabal.project.local'
19777 and other files.
19778 To pass command-line arguments to a test suite, see the run command.
19780 Runs the specified test-suites, first ensuring they are up to date.
19783 Any test-suite in any package in the project can be specified. A pack‐
19785 age can be specified in which case all the test-suites in the package
19786 are run. The default is to run all the test-suites in the package in
19787 the current directory.
19788 Dependencies are built or rebuilt as necessary. Additional configura‐
19790 tion flags can be specified on the command line and these extend the
19791 project configuration from the 'cabal.project', 'cabal.project.local'
19792 and other files.
19793 To pass command-line arguments to a test suite, see the run command.
19795 Flags:
19798 -v, --verbose [n]
19799 Control verbosity (n is 0--3, default verbosity level is
19800 1)
19801 --builddir, --distdir, --distpref DIR
19803 The directory where Cabal puts generated build files (de‐
19804 fault dist)
19805 -g, --ghc
19807 compile with GHC
19808 --ghcjs
19810 compile with GHCJS
19811 --uhc
19813 compile with UHC
19814 --haskell-suite
19816 compile with a haskell-suite compiler
19817 --cabal-file PATH
19819 use this Cabal file
19820 -w, --with-compiler PATH
19822 give the path to a particular compiler
19823 --with-hc-pkg PATH
19825 give the path to the package tool
19826 --prefix DIR
19828 bake this prefix in preparation of installation
19829 --bindir DIR
19831 installation directory for executables
19832 --libdir DIR
19834 installation directory for libraries
19835 --libsubdir DIR
19837 subdirectory of libdir in which libs are installed
19838 --dynlibdir DIR
19840 installation directory for dynamic libraries
19841 --libexecdir DIR
19843 installation directory for program executables
19844 --libexecsubdir DIR
19846 subdirectory of libexecdir in which private executables
19847 are installed
19848 --datadir DIR
19850 installation directory for read-only data
19851 --datasubdir DIR
19853 subdirectory of datadir in which data files are installed
19854 --docdir DIR
19856 installation directory for documentation
19857 --htmldir DIR
19859 installation directory for HTML documentation
19860 --haddockdir DIR
19862 installation directory for haddock interfaces
19863 --sysconfdir DIR
19865 installation directory for configuration files
19866 --program-prefix PREFIX
19868 prefix to be applied to installed executables
19869 --program-suffix SUFFIX
19871 suffix to be applied to installed executables
19872 --enable-library-vanilla
19874 --disable-library-vanilla
19875 Vanilla libraries
19876 -p, --enable-library-profiling
19878 --disable-library-profiling
19879 Library profiling
19880 --enable-shared
19882 --disable-shared
19883 Shared library
19884 --enable-static
19886 --disable-static
19887 Static library
19888 --enable-executable-dynamic
19890 --disable-executable-dynamic
19891 Executable dynamic linking
19892 --enable-executable-static
19894 --disable-executable-static
19895 Executable fully static linking
19896 --enable-profiling
19898 --disable-profiling
19899 Executable and library profiling
19900 --enable-executable-profiling
19902 --disable-executable-profiling
19903 Executable profiling (DEPRECATED)
19904 --profiling-detail level
19906 Profiling detail level for executable and library (de‐
19907 fault, none, exported-functions, toplevel-functions,
19908 all-functions).
19909 --library-profiling-detail level
19911 Profiling detail level for libraries only.
19912 -O, --enable-optimization, --enable-optimisation [n]
19914 Build with optimization (n is 0--2, default is 1)
19915 --disable-optimization, --disable-optimisation
19917 Build without optimization
19918 --enable-debug-info [n]
19920 Emit debug info (n is 0--3, default is 0)
19921 --disable-debug-info
19923 Don't emit debug info
19924 --enable-library-for-ghci
19926 --disable-library-for-ghci
19927 compile library for use with GHCi
19928 --enable-split-sections
19930 --disable-split-sections
19931 compile library code such that unneeded definitions can
19932 be dropped from the final executable (GHC 7.8+)
19933 --enable-split-objs
19935 --disable-split-objs
19936 split library into smaller objects to reduce binary sizes
19937 (GHC 6.6+)
19938 --enable-executable-stripping
19940 --disable-executable-stripping
19941 strip executables upon installation to reduce binary
19942 sizes
19943 --enable-library-stripping
19945 --disable-library-stripping
19946 strip libraries upon installation to reduce binary sizes
19947 --configure-option OPT
19949 Extra option for configure
19950 --user
19952 --global
19953 doing a per-user installation
19954 --package-db DB
19956 Append the given package database to the list of package
19957 databases used (to satisfy dependencies and register
19958 into). May be a specific file, 'global' or 'user'. The
19959 initial list is ['global'], ['global', 'user'], or
19960 ['global', $sandbox], depending on context. Use 'clear'
19961 to reset the list to empty. See the user guide for de‐
19962 tails.
19963 -f, --flags FLAGS
19965 Force values for the given flags in Cabal conditionals in
19966 the .cabal file. E.g., --flags="debug -usebytestrings"
19967 forces the flag "debug" to true and "usebytestrings" to
19968 false.
19969 --extra-include-dirs PATH
19971 A list of directories to search for header files
19972 --enable-deterministic
19974 --disable-deterministic
19975 Try to be as deterministic as possible (used by the test
19976 suite)
19977 --ipid IPID
19979 Installed package ID to compile this package as
19980 --cid CID
19982 Installed component ID to compile this component as
19983 --extra-lib-dirs PATH
19985 A list of directories to search for external libraries
19986 --extra-framework-dirs PATH
19988 A list of directories to search for external frameworks
19989 (OS X only)
19990 --extra-prog-path PATH
19992 A list of directories to search for required programs (in
19993 addition to the normal search locations)
19994 --instantiate-with NAME=MOD
19996 A mapping of signature names to concrete module instanti‐
19997 ations.
19998 --enable-tests
20000 --disable-tests
20001 dependency checking and compilation for test suites
20002 listed in the package description file.
20003 --enable-coverage
20005 --disable-coverage
20006 build package with Haskell Program Coverage. (GHC only)
20007 --enable-library-coverage
20009 --disable-library-coverage
20010 build package with Haskell Program Coverage. (GHC only)
20011 (DEPRECATED)
20012 --enable-benchmarks
20014 --disable-benchmarks
20015 dependency checking and compilation for benchmarks listed
20016 in the package description file.
20017 --enable-relocatable
20019 --disable-relocatable
20020 building a package that is relocatable. (GHC only)
20021 --disable-response-files
20023 enable workaround for old versions of programs like "ar"
20024 that do not support @file arguments
20025 --allow-depending-on-private-libs
20027 Allow depending on private libraries. If set, the library
20028 visibility check MUST be done externally.
20029 --with-alex PATH
20031 give the path to alex
20032 --with-ar PATH
20034 give the path to ar
20035 --with-c2hs PATH
20037 give the path to c2hs
20038 --with-cpphs PATH
20040 give the path to cpphs
20041 --with-doctest PATH
20043 give the path to doctest
20044 --with-gcc PATH
20046 give the path to gcc
20047 --with-ghc PATH
20049 give the path to ghc
20050 --with-ghc-pkg PATH
20052 give the path to ghc-pkg
20053 --with-ghcjs PATH
20055 give the path to ghcjs
20056 --with-ghcjs-pkg PATH
20058 give the path to ghcjs-pkg
20059 --with-greencard PATH
20061 give the path to greencard
20062 --with-haddock PATH
20064 give the path to haddock
20065 --with-happy PATH
20067 give the path to happy
20068 --with-haskell-suite PATH
20070 give the path to haskell-suite
20071 --with-haskell-suite-pkg PATH
20073 give the path to haskell-suite-pkg
20074 --with-hmake PATH
20076 give the path to hmake
20077 --with-hpc PATH
20079 give the path to hpc
20080 --with-hsc2hs PATH
20082 give the path to hsc2hs
20083 --with-hscolour PATH
20085 give the path to hscolour
20086 --with-jhc PATH
20088 give the path to jhc
20089 --with-ld PATH
20091 give the path to ld
20092 --with-pkg-config PATH
20094 give the path to pkg-config
20095 --with-runghc PATH
20097 give the path to runghc
20098 --with-strip PATH
20100 give the path to strip
20101 --with-tar PATH
20103 give the path to tar
20104 --with-uhc PATH
20106 give the path to uhc
20107 --alex-option OPT
20109 give an extra option to alex (no need to quote options
20110 containing spaces)
20111 --ar-option OPT
20113 give an extra option to ar (no need to quote options con‐
20114 taining spaces)
20115 --c2hs-option OPT
20117 give an extra option to c2hs (no need to quote options
20118 containing spaces)
20119 --cpphs-option OPT
20121 give an extra option to cpphs (no need to quote options
20122 containing spaces)
20123 --doctest-option OPT
20125 give an extra option to doctest (no need to quote options
20126 containing spaces)
20127 --gcc-option OPT
20129 give an extra option to gcc (no need to quote options
20130 containing spaces)
20131 --ghc-option OPT
20133 give an extra option to ghc (no need to quote options
20134 containing spaces)
20135 --ghc-pkg-option OPT
20137 give an extra option to ghc-pkg (no need to quote options
20138 containing spaces)
20139 --ghcjs-option OPT
20141 give an extra option to ghcjs (no need to quote options
20142 containing spaces)
20143 --ghcjs-pkg-option OPT
20145 give an extra option to ghcjs-pkg (no need to quote op‐
20146 tions containing spaces)
20147 --greencard-option OPT
20149 give an extra option to greencard (no need to quote op‐
20150 tions containing spaces)
20151 --haddock-option OPT
20153 give an extra option to haddock (no need to quote options
20154 containing spaces)
20155 --happy-option OPT
20157 give an extra option to happy (no need to quote options
20158 containing spaces)
20159 --haskell-suite-option OPT
20161 give an extra option to haskell-suite (no need to quote
20162 options containing spaces)
20163 --haskell-suite-pkg-option OPT
20165 give an extra option to haskell-suite-pkg (no need to
20166 quote options containing spaces)
20167 --hmake-option OPT
20169 give an extra option to hmake (no need to quote options
20170 containing spaces)
20171 --hpc-option OPT
20173 give an extra option to hpc (no need to quote options
20174 containing spaces)
20175 --hsc2hs-option OPT
20177 give an extra option to hsc2hs (no need to quote options
20178 containing spaces)
20179 --hscolour-option OPT
20181 give an extra option to hscolour (no need to quote op‐
20182 tions containing spaces)
20183 --jhc-option OPT
20185 give an extra option to jhc (no need to quote options
20186 containing spaces)
20187 --ld-option OPT
20189 give an extra option to ld (no need to quote options con‐
20190 taining spaces)
20191 --pkg-config-option OPT
20193 give an extra option to pkg-config (no need to quote op‐
20194 tions containing spaces)
20195 --runghc-option OPT
20197 give an extra option to runghc (no need to quote options
20198 containing spaces)
20199 --strip-option OPT
20201 give an extra option to strip (no need to quote options
20202 containing spaces)
20203 --tar-option OPT
20205 give an extra option to tar (no need to quote options
20206 containing spaces)
20207 --uhc-option OPT
20209 give an extra option to uhc (no need to quote options
20210 containing spaces)
20211 --alex-options OPTS
20213 give extra options to alex
20214 --ar-options OPTS
20216 give extra options to ar
20217 --c2hs-options OPTS
20219 give extra options to c2hs
20220 --cpphs-options OPTS
20222 give extra options to cpphs
20223 --doctest-options OPTS
20225 give extra options to doctest
20226 --gcc-options OPTS
20228 give extra options to gcc
20229 --ghc-options OPTS
20231 give extra options to ghc
20232 --ghc-pkg-options OPTS
20234 give extra options to ghc-pkg
20235 --ghcjs-options OPTS
20237 give extra options to ghcjs
20238 --ghcjs-pkg-options OPTS
20240 give extra options to ghcjs-pkg
20241 --greencard-options OPTS
20243 give extra options to greencard
20244 --haddock-options OPTS
20246 give extra options to haddock
20247 --happy-options OPTS
20249 give extra options to happy
20250 --haskell-suite-options OPTS
20252 give extra options to haskell-suite
20253 --haskell-suite-pkg-options OPTS
20255 give extra options to haskell-suite-pkg
20256 --hmake-options OPTS
20258 give extra options to hmake
20259 --hpc-options OPTS
20261 give extra options to hpc
20262 --hsc2hs-options OPTS
20264 give extra options to hsc2hs
20265 --hscolour-options OPTS
20267 give extra options to hscolour
20268 --jhc-options OPTS
20270 give extra options to jhc
20271 --ld-options OPTS
20273 give extra options to ld
20274 --pkg-config-options OPTS
20276 give extra options to pkg-config
20277 --runghc-options OPTS
20279 give extra options to runghc
20280 --strip-options OPTS
20282 give extra options to strip
20283 --tar-options OPTS
20285 give extra options to tar
20286 --uhc-options OPTS
20288 give extra options to uhc
20289 --cabal-lib-version VERSION
20291 Select which version of the Cabal lib to use to build
20292 packages (useful for testing).
20293 --constraint CONSTRAINT
20295 Specify constraints on a package (version, in‐
20296 stalled/source, flags)
20297 --preference CONSTRAINT
20299 Specify preferences (soft constraints) on the version of
20300 a package
20301 --solver SOLVER
20303 Select dependency solver to use (default: modular).
20304 Choices: modular.
20305 --allow-older [DEPS]
20307 Ignore lower bounds in all dependencies or DEPS
20308 --allow-newer [DEPS]
20310 Ignore upper bounds in all dependencies or DEPS
20311 --write-ghc-environment-files always|never|ghc8.4.4+
20313 Whether to create a .ghc.environment file after a suc‐
20314 cessful build (v2-build only)
20315 --enable-documentation
20317 --disable-documentation
20318 building of documentation
20319 --doc-index-file TEMPLATE
20321 A central index of haddock API documentation (template
20322 cannot use $pkgid)
20323 --dry-run
20325 Do not install anything, only print what would be in‐
20326 stalled.
20327 --max-backjumps NUM
20329 Maximum number of backjumps allowed while solving (de‐
20330 fault: 4000). Use a negative number to enable unlimited
20331 backtracking. Use 0 to disable backtracking completely.
20332 --reorder-goals
20334 --no-reorder-goals
20335 Try to reorder goals according to certain heuristics.
20336 Slows things down on average, but may make backtracking
20337 faster for some packages.
20338 --count-conflicts
20340 --no-count-conflicts
20341 Try to speed up solving by preferring goals that are in‐
20342 volved in a lot of conflicts (default).
20343 --fine-grained-conflicts
20345 --no-fine-grained-conflicts
20346 Skip a version of a package if it does not resolve the
20347 conflicts encountered in the last version, as a solver
20348 optimization (default).
20349 --minimize-conflict-set
20351 --no-minimize-conflict-set
20352 When there is no solution, try to improve the error mes‐
20353 sage by finding a minimal conflict set (default: false).
20354 May increase run time significantly.
20355 --independent-goals
20357 --no-independent-goals
20358 Treat several goals on the command line as independent.
20359 If several goals depend on the same package, different
20360 versions can be chosen.
20361 --shadow-installed-packages
20363 --no-shadow-installed-packages
20364 If multiple package instances of the same version are in‐
20365 stalled, treat all but one as shadowed.
20366 --strong-flags
20368 --no-strong-flags
20369 Do not defer flag choices (this used to be the default in
20370 cabal-install <= 1.20).
20371 --allow-boot-library-installs
20373 --no-allow-boot-library-installs
20374 Allow cabal to install base, ghc-prim, integer-simple,
20375 integer-gmp, and template-haskell.
20376 --reject-unconstrained-dependencies none|all
20378 Require these packages to have constraints on them if
20379 they are to be selected (default: none).
20380 --reinstall
20382 --no-reinstall
20383 Install even if it means installing the same version
20384 again.
20385 --avoid-reinstalls
20387 --no-avoid-reinstalls
20388 Do not select versions that would destructively overwrite
20389 installed packages.
20390 --force-reinstalls
20392 --no-force-reinstalls
20393 Reinstall packages even if they will most likely break
20394 other installed packages.
20395 --upgrade-dependencies
20397 --no-upgrade-dependencies
20398 Pick the latest version for all dependencies, rather than
20399 trying to pick an installed version.
20400 --only-dependencies
20402 --no-only-dependencies
20403 Install only the dependencies necessary to build the
20404 given packages
20405 --dependencies-only
20407 --no-dependencies-only
20408 A synonym for --only-dependencies
20409 --index-state STATE
20411 Use source package index state as it existed at a previ‐
20412 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
20413 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
20414 'HEAD' (default: 'HEAD').
20415 --root-cmd COMMAND
20417 (No longer supported, do not use.)
20418 --symlink-bindir DIR
20420 Add symlinks to installed executables into this direc‐
20421 tory.
20422 --build-summary TEMPLATE
20424 Save build summaries to file (name template can use
20425 $pkgid, $compiler, $os, $arch)
20426 --build-log TEMPLATE
20428 Log all builds to file (name template can use $pkgid,
20429 $compiler, $os, $arch)
20430 --remote-build-reporting LEVEL
20432 Generate build reports to send to a remote server (none,
20433 anonymous or detailed).
20434 --report-planning-failure
20436 Generate build reports when the dependency solver fails.
20437 This is used by the Hackage build bot.
20438 --enable-per-component
20440 --disable-per-component
20441 Per-component builds when possible
20442 --one-shot
20444 --no-one-shot
20445 Do not record the packages in the world file.
20446 --run-tests
20448 Run package test suites during installation.
20449 -j, --jobs [NUM]
20451 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
20452 given).
20453 --keep-going
20455 After a build failure, continue to build other unaffected
20456 packages.
20457 --offline
20459 --no-offline
20460 Don't download packages from the Internet.
20461 --project-file FILE
20463 Set the name of the cabal.project file to search for in
20464 parent directories
20465 --only
20467 Only installs the package in the current directory.
20468 --haddock-hoogle
20470 Generate a hoogle database
20471 --haddock-html
20473 Generate HTML documentation (the default)
20474 --haddock-html-location URL
20476 Location of HTML documentation for pre-requisite packages
20477 --haddock-for-hackage
20479 Collection of flags to generate documentation suitable
20480 for upload to hackage
20481 --haddock-executables
20483 Run haddock for Executables targets
20484 --haddock-tests
20486 Run haddock for Test Suite targets
20487 --haddock-benchmarks
20489 Run haddock for Benchmark targets
20490 --haddock-all
20492 Run haddock for all targets
20493 --haddock-internal
20495 Run haddock for internal modules and include all symbols
20496 --haddock-css PATH
20498 Use PATH as the haddock stylesheet
20499 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
20501 dock-hyperlinked-source
20502 Hyperlink the documentation to the source code
20503 --haddock-quickjump
20505 Generate an index for interactive documentation naviga‐
20506 tion
20507 --haddock-hscolour-css PATH
20509 Use PATH as the HsColour stylesheet
20510 --haddock-contents-location URL
20512 Bake URL in as the location for the contents page
20513 --test-log TEMPLATE
20515 Log all test suite results to file (name template can use
20516 $pkgid, $compiler, $os, $arch, $test-suite, $result)
20517 --test-machine-log TEMPLATE
20519 Produce a machine-readable log file (name template can
20520 use $pkgid, $compiler, $os, $arch, $result)
20521 --test-show-details FILTER
20523 --test-keep-tix-files
20525 keep .tix files for HPC between test runs
20526 --test-wrapper FILE
20528 Run test through a wrapper.
20529 --test-fail-when-no-test-suites
20531 Exit with failure when no test suites are found.
20532 --test-options TEMPLATES
20534 give extra options to test executables (name templates
20535 can use $pkgid, $compiler, $os, $arch, $test-suite)
20536 --test-option TEMPLATE
20538 give extra option to test executables (no need to quote
20539 options containing spaces, name template can use $pkgid,
20540 $compiler, $os, $arch, $test-suite)
20541 --benchmark-options TEMPLATES
20543 give extra options to benchmark executables (name tem‐
20544 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
20545 --benchmark-option TEMPLATE
20547 give extra option to benchmark executables (no need to
20548 quote options containing spaces, name template can use
20549 $pkgid, $compiler, $os, $arch, $benchmark)
20550 cabal new-test
20553 Usage: cabal new-test [TARGETS] [FLAGS]
20555 Runs the specified test-suites, first ensuring they are up to date.
20558 Any test-suite in any package in the project can be specified. A pack‐
20560 age can be specified in which case all the test-suites in the package
20561 are run. The default is to run all the test-suites in the package in
20562 the current directory.
20563 Dependencies are built or rebuilt as necessary. Additional configura‐
20565 tion flags can be specified on the command line and these extend the
20566 project configuration from the 'cabal.project', 'cabal.project.local'
20567 and other files.
20568 To pass command-line arguments to a test suite, see the new-run com‐
20570 mand.
20571 Runs the specified test-suites, first ensuring they are up to date.
20574 Any test-suite in any package in the project can be specified. A pack‐
20576 age can be specified in which case all the test-suites in the package
20577 are run. The default is to run all the test-suites in the package in
20578 the current directory.
20579 Dependencies are built or rebuilt as necessary. Additional configura‐
20581 tion flags can be specified on the command line and these extend the
20582 project configuration from the 'cabal.project', 'cabal.project.local'
20583 and other files.
20584 To pass command-line arguments to a test suite, see the new-run com‐
20586 mand.
20587 Flags:
20590 -v, --verbose [n]
20591 Control verbosity (n is 0--3, default verbosity level is
20592 1)
20593 --builddir, --distdir, --distpref DIR
20595 The directory where Cabal puts generated build files (de‐
20596 fault dist)
20597 -g, --ghc
20599 compile with GHC
20600 --ghcjs
20602 compile with GHCJS
20603 --uhc
20605 compile with UHC
20606 --haskell-suite
20608 compile with a haskell-suite compiler
20609 --cabal-file PATH
20611 use this Cabal file
20612 -w, --with-compiler PATH
20614 give the path to a particular compiler
20615 --with-hc-pkg PATH
20617 give the path to the package tool
20618 --prefix DIR
20620 bake this prefix in preparation of installation
20621 --bindir DIR
20623 installation directory for executables
20624 --libdir DIR
20626 installation directory for libraries
20627 --libsubdir DIR
20629 subdirectory of libdir in which libs are installed
20630 --dynlibdir DIR
20632 installation directory for dynamic libraries
20633 --libexecdir DIR
20635 installation directory for program executables
20636 --libexecsubdir DIR
20638 subdirectory of libexecdir in which private executables
20639 are installed
20640 --datadir DIR
20642 installation directory for read-only data
20643 --datasubdir DIR
20645 subdirectory of datadir in which data files are installed
20646 --docdir DIR
20648 installation directory for documentation
20649 --htmldir DIR
20651 installation directory for HTML documentation
20652 --haddockdir DIR
20654 installation directory for haddock interfaces
20655 --sysconfdir DIR
20657 installation directory for configuration files
20658 --program-prefix PREFIX
20660 prefix to be applied to installed executables
20661 --program-suffix SUFFIX
20663 suffix to be applied to installed executables
20664 --enable-library-vanilla
20666 --disable-library-vanilla
20667 Vanilla libraries
20668 -p, --enable-library-profiling
20670 --disable-library-profiling
20671 Library profiling
20672 --enable-shared
20674 --disable-shared
20675 Shared library
20676 --enable-static
20678 --disable-static
20679 Static library
20680 --enable-executable-dynamic
20682 --disable-executable-dynamic
20683 Executable dynamic linking
20684 --enable-executable-static
20686 --disable-executable-static
20687 Executable fully static linking
20688 --enable-profiling
20690 --disable-profiling
20691 Executable and library profiling
20692 --enable-executable-profiling
20694 --disable-executable-profiling
20695 Executable profiling (DEPRECATED)
20696 --profiling-detail level
20698 Profiling detail level for executable and library (de‐
20699 fault, none, exported-functions, toplevel-functions,
20700 all-functions).
20701 --library-profiling-detail level
20703 Profiling detail level for libraries only.
20704 -O, --enable-optimization, --enable-optimisation [n]
20706 Build with optimization (n is 0--2, default is 1)
20707 --disable-optimization, --disable-optimisation
20709 Build without optimization
20710 --enable-debug-info [n]
20712 Emit debug info (n is 0--3, default is 0)
20713 --disable-debug-info
20715 Don't emit debug info
20716 --enable-library-for-ghci
20718 --disable-library-for-ghci
20719 compile library for use with GHCi
20720 --enable-split-sections
20722 --disable-split-sections
20723 compile library code such that unneeded definitions can
20724 be dropped from the final executable (GHC 7.8+)
20725 --enable-split-objs
20727 --disable-split-objs
20728 split library into smaller objects to reduce binary sizes
20729 (GHC 6.6+)
20730 --enable-executable-stripping
20732 --disable-executable-stripping
20733 strip executables upon installation to reduce binary
20734 sizes
20735 --enable-library-stripping
20737 --disable-library-stripping
20738 strip libraries upon installation to reduce binary sizes
20739 --configure-option OPT
20741 Extra option for configure
20742 --user
20744 --global
20745 doing a per-user installation
20746 --package-db DB
20748 Append the given package database to the list of package
20749 databases used (to satisfy dependencies and register
20750 into). May be a specific file, 'global' or 'user'. The
20751 initial list is ['global'], ['global', 'user'], or
20752 ['global', $sandbox], depending on context. Use 'clear'
20753 to reset the list to empty. See the user guide for de‐
20754 tails.
20755 -f, --flags FLAGS
20757 Force values for the given flags in Cabal conditionals in
20758 the .cabal file. E.g., --flags="debug -usebytestrings"
20759 forces the flag "debug" to true and "usebytestrings" to
20760 false.
20761 --extra-include-dirs PATH
20763 A list of directories to search for header files
20764 --enable-deterministic
20766 --disable-deterministic
20767 Try to be as deterministic as possible (used by the test
20768 suite)
20769 --ipid IPID
20771 Installed package ID to compile this package as
20772 --cid CID
20774 Installed component ID to compile this component as
20775 --extra-lib-dirs PATH
20777 A list of directories to search for external libraries
20778 --extra-framework-dirs PATH
20780 A list of directories to search for external frameworks
20781 (OS X only)
20782 --extra-prog-path PATH
20784 A list of directories to search for required programs (in
20785 addition to the normal search locations)
20786 --instantiate-with NAME=MOD
20788 A mapping of signature names to concrete module instanti‐
20789 ations.
20790 --enable-tests
20792 --disable-tests
20793 dependency checking and compilation for test suites
20794 listed in the package description file.
20795 --enable-coverage
20797 --disable-coverage
20798 build package with Haskell Program Coverage. (GHC only)
20799 --enable-library-coverage
20801 --disable-library-coverage
20802 build package with Haskell Program Coverage. (GHC only)
20803 (DEPRECATED)
20804 --enable-benchmarks
20806 --disable-benchmarks
20807 dependency checking and compilation for benchmarks listed
20808 in the package description file.
20809 --enable-relocatable
20811 --disable-relocatable
20812 building a package that is relocatable. (GHC only)
20813 --disable-response-files
20815 enable workaround for old versions of programs like "ar"
20816 that do not support @file arguments
20817 --allow-depending-on-private-libs
20819 Allow depending on private libraries. If set, the library
20820 visibility check MUST be done externally.
20821 --with-alex PATH
20823 give the path to alex
20824 --with-ar PATH
20826 give the path to ar
20827 --with-c2hs PATH
20829 give the path to c2hs
20830 --with-cpphs PATH
20832 give the path to cpphs
20833 --with-doctest PATH
20835 give the path to doctest
20836 --with-gcc PATH
20838 give the path to gcc
20839 --with-ghc PATH
20841 give the path to ghc
20842 --with-ghc-pkg PATH
20844 give the path to ghc-pkg
20845 --with-ghcjs PATH
20847 give the path to ghcjs
20848 --with-ghcjs-pkg PATH
20850 give the path to ghcjs-pkg
20851 --with-greencard PATH
20853 give the path to greencard
20854 --with-haddock PATH
20856 give the path to haddock
20857 --with-happy PATH
20859 give the path to happy
20860 --with-haskell-suite PATH
20862 give the path to haskell-suite
20863 --with-haskell-suite-pkg PATH
20865 give the path to haskell-suite-pkg
20866 --with-hmake PATH
20868 give the path to hmake
20869 --with-hpc PATH
20871 give the path to hpc
20872 --with-hsc2hs PATH
20874 give the path to hsc2hs
20875 --with-hscolour PATH
20877 give the path to hscolour
20878 --with-jhc PATH
20880 give the path to jhc
20881 --with-ld PATH
20883 give the path to ld
20884 --with-pkg-config PATH
20886 give the path to pkg-config
20887 --with-runghc PATH
20889 give the path to runghc
20890 --with-strip PATH
20892 give the path to strip
20893 --with-tar PATH
20895 give the path to tar
20896 --with-uhc PATH
20898 give the path to uhc
20899 --alex-option OPT
20901 give an extra option to alex (no need to quote options
20902 containing spaces)
20903 --ar-option OPT
20905 give an extra option to ar (no need to quote options con‐
20906 taining spaces)
20907 --c2hs-option OPT
20909 give an extra option to c2hs (no need to quote options
20910 containing spaces)
20911 --cpphs-option OPT
20913 give an extra option to cpphs (no need to quote options
20914 containing spaces)
20915 --doctest-option OPT
20917 give an extra option to doctest (no need to quote options
20918 containing spaces)
20919 --gcc-option OPT
20921 give an extra option to gcc (no need to quote options
20922 containing spaces)
20923 --ghc-option OPT
20925 give an extra option to ghc (no need to quote options
20926 containing spaces)
20927 --ghc-pkg-option OPT
20929 give an extra option to ghc-pkg (no need to quote options
20930 containing spaces)
20931 --ghcjs-option OPT
20933 give an extra option to ghcjs (no need to quote options
20934 containing spaces)
20935 --ghcjs-pkg-option OPT
20937 give an extra option to ghcjs-pkg (no need to quote op‐
20938 tions containing spaces)
20939 --greencard-option OPT
20941 give an extra option to greencard (no need to quote op‐
20942 tions containing spaces)
20943 --haddock-option OPT
20945 give an extra option to haddock (no need to quote options
20946 containing spaces)
20947 --happy-option OPT
20949 give an extra option to happy (no need to quote options
20950 containing spaces)
20951 --haskell-suite-option OPT
20953 give an extra option to haskell-suite (no need to quote
20954 options containing spaces)
20955 --haskell-suite-pkg-option OPT
20957 give an extra option to haskell-suite-pkg (no need to
20958 quote options containing spaces)
20959 --hmake-option OPT
20961 give an extra option to hmake (no need to quote options
20962 containing spaces)
20963 --hpc-option OPT
20965 give an extra option to hpc (no need to quote options
20966 containing spaces)
20967 --hsc2hs-option OPT
20969 give an extra option to hsc2hs (no need to quote options
20970 containing spaces)
20971 --hscolour-option OPT
20973 give an extra option to hscolour (no need to quote op‐
20974 tions containing spaces)
20975 --jhc-option OPT
20977 give an extra option to jhc (no need to quote options
20978 containing spaces)
20979 --ld-option OPT
20981 give an extra option to ld (no need to quote options con‐
20982 taining spaces)
20983 --pkg-config-option OPT
20985 give an extra option to pkg-config (no need to quote op‐
20986 tions containing spaces)
20987 --runghc-option OPT
20989 give an extra option to runghc (no need to quote options
20990 containing spaces)
20991 --strip-option OPT
20993 give an extra option to strip (no need to quote options
20994 containing spaces)
20995 --tar-option OPT
20997 give an extra option to tar (no need to quote options
20998 containing spaces)
20999 --uhc-option OPT
21001 give an extra option to uhc (no need to quote options
21002 containing spaces)
21003 --alex-options OPTS
21005 give extra options to alex
21006 --ar-options OPTS
21008 give extra options to ar
21009 --c2hs-options OPTS
21011 give extra options to c2hs
21012 --cpphs-options OPTS
21014 give extra options to cpphs
21015 --doctest-options OPTS
21017 give extra options to doctest
21018 --gcc-options OPTS
21020 give extra options to gcc
21021 --ghc-options OPTS
21023 give extra options to ghc
21024 --ghc-pkg-options OPTS
21026 give extra options to ghc-pkg
21027 --ghcjs-options OPTS
21029 give extra options to ghcjs
21030 --ghcjs-pkg-options OPTS
21032 give extra options to ghcjs-pkg
21033 --greencard-options OPTS
21035 give extra options to greencard
21036 --haddock-options OPTS
21038 give extra options to haddock
21039 --happy-options OPTS
21041 give extra options to happy
21042 --haskell-suite-options OPTS
21044 give extra options to haskell-suite
21045 --haskell-suite-pkg-options OPTS
21047 give extra options to haskell-suite-pkg
21048 --hmake-options OPTS
21050 give extra options to hmake
21051 --hpc-options OPTS
21053 give extra options to hpc
21054 --hsc2hs-options OPTS
21056 give extra options to hsc2hs
21057 --hscolour-options OPTS
21059 give extra options to hscolour
21060 --jhc-options OPTS
21062 give extra options to jhc
21063 --ld-options OPTS
21065 give extra options to ld
21066 --pkg-config-options OPTS
21068 give extra options to pkg-config
21069 --runghc-options OPTS
21071 give extra options to runghc
21072 --strip-options OPTS
21074 give extra options to strip
21075 --tar-options OPTS
21077 give extra options to tar
21078 --uhc-options OPTS
21080 give extra options to uhc
21081 --cabal-lib-version VERSION
21083 Select which version of the Cabal lib to use to build
21084 packages (useful for testing).
21085 --constraint CONSTRAINT
21087 Specify constraints on a package (version, in‐
21088 stalled/source, flags)
21089 --preference CONSTRAINT
21091 Specify preferences (soft constraints) on the version of
21092 a package
21093 --solver SOLVER
21095 Select dependency solver to use (default: modular).
21096 Choices: modular.
21097 --allow-older [DEPS]
21099 Ignore lower bounds in all dependencies or DEPS
21100 --allow-newer [DEPS]
21102 Ignore upper bounds in all dependencies or DEPS
21103 --write-ghc-environment-files always|never|ghc8.4.4+
21105 Whether to create a .ghc.environment file after a suc‐
21106 cessful build (v2-build only)
21107 --enable-documentation
21109 --disable-documentation
21110 building of documentation
21111 --doc-index-file TEMPLATE
21113 A central index of haddock API documentation (template
21114 cannot use $pkgid)
21115 --dry-run
21117 Do not install anything, only print what would be in‐
21118 stalled.
21119 --max-backjumps NUM
21121 Maximum number of backjumps allowed while solving (de‐
21122 fault: 4000). Use a negative number to enable unlimited
21123 backtracking. Use 0 to disable backtracking completely.
21124 --reorder-goals
21126 --no-reorder-goals
21127 Try to reorder goals according to certain heuristics.
21128 Slows things down on average, but may make backtracking
21129 faster for some packages.
21130 --count-conflicts
21132 --no-count-conflicts
21133 Try to speed up solving by preferring goals that are in‐
21134 volved in a lot of conflicts (default).
21135 --fine-grained-conflicts
21137 --no-fine-grained-conflicts
21138 Skip a version of a package if it does not resolve the
21139 conflicts encountered in the last version, as a solver
21140 optimization (default).
21141 --minimize-conflict-set
21143 --no-minimize-conflict-set
21144 When there is no solution, try to improve the error mes‐
21145 sage by finding a minimal conflict set (default: false).
21146 May increase run time significantly.
21147 --independent-goals
21149 --no-independent-goals
21150 Treat several goals on the command line as independent.
21151 If several goals depend on the same package, different
21152 versions can be chosen.
21153 --shadow-installed-packages
21155 --no-shadow-installed-packages
21156 If multiple package instances of the same version are in‐
21157 stalled, treat all but one as shadowed.
21158 --strong-flags
21160 --no-strong-flags
21161 Do not defer flag choices (this used to be the default in
21162 cabal-install <= 1.20).
21163 --allow-boot-library-installs
21165 --no-allow-boot-library-installs
21166 Allow cabal to install base, ghc-prim, integer-simple,
21167 integer-gmp, and template-haskell.
21168 --reject-unconstrained-dependencies none|all
21170 Require these packages to have constraints on them if
21171 they are to be selected (default: none).
21172 --reinstall
21174 --no-reinstall
21175 Install even if it means installing the same version
21176 again.
21177 --avoid-reinstalls
21179 --no-avoid-reinstalls
21180 Do not select versions that would destructively overwrite
21181 installed packages.
21182 --force-reinstalls
21184 --no-force-reinstalls
21185 Reinstall packages even if they will most likely break
21186 other installed packages.
21187 --upgrade-dependencies
21189 --no-upgrade-dependencies
21190 Pick the latest version for all dependencies, rather than
21191 trying to pick an installed version.
21192 --only-dependencies
21194 --no-only-dependencies
21195 Install only the dependencies necessary to build the
21196 given packages
21197 --dependencies-only
21199 --no-dependencies-only
21200 A synonym for --only-dependencies
21201 --index-state STATE
21203 Use source package index state as it existed at a previ‐
21204 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
21205 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
21206 'HEAD' (default: 'HEAD').
21207 --root-cmd COMMAND
21209 (No longer supported, do not use.)
21210 --symlink-bindir DIR
21212 Add symlinks to installed executables into this direc‐
21213 tory.
21214 --build-summary TEMPLATE
21216 Save build summaries to file (name template can use
21217 $pkgid, $compiler, $os, $arch)
21218 --build-log TEMPLATE
21220 Log all builds to file (name template can use $pkgid,
21221 $compiler, $os, $arch)
21222 --remote-build-reporting LEVEL
21224 Generate build reports to send to a remote server (none,
21225 anonymous or detailed).
21226 --report-planning-failure
21228 Generate build reports when the dependency solver fails.
21229 This is used by the Hackage build bot.
21230 --enable-per-component
21232 --disable-per-component
21233 Per-component builds when possible
21234 --one-shot
21236 --no-one-shot
21237 Do not record the packages in the world file.
21238 --run-tests
21240 Run package test suites during installation.
21241 -j, --jobs [NUM]
21243 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
21244 given).
21245 --keep-going
21247 After a build failure, continue to build other unaffected
21248 packages.
21249 --offline
21251 --no-offline
21252 Don't download packages from the Internet.
21253 --project-file FILE
21255 Set the name of the cabal.project file to search for in
21256 parent directories
21257 --only
21259 Only installs the package in the current directory.
21260 --haddock-hoogle
21262 Generate a hoogle database
21263 --haddock-html
21265 Generate HTML documentation (the default)
21266 --haddock-html-location URL
21268 Location of HTML documentation for pre-requisite packages
21269 --haddock-for-hackage
21271 Collection of flags to generate documentation suitable
21272 for upload to hackage
21273 --haddock-executables
21275 Run haddock for Executables targets
21276 --haddock-tests
21278 Run haddock for Test Suite targets
21279 --haddock-benchmarks
21281 Run haddock for Benchmark targets
21282 --haddock-all
21284 Run haddock for all targets
21285 --haddock-internal
21287 Run haddock for internal modules and include all symbols
21288 --haddock-css PATH
21290 Use PATH as the haddock stylesheet
21291 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
21293 dock-hyperlinked-source
21294 Hyperlink the documentation to the source code
21295 --haddock-quickjump
21297 Generate an index for interactive documentation naviga‐
21298 tion
21299 --haddock-hscolour-css PATH
21301 Use PATH as the HsColour stylesheet
21302 --haddock-contents-location URL
21304 Bake URL in as the location for the contents page
21305 --test-log TEMPLATE
21307 Log all test suite results to file (name template can use
21308 $pkgid, $compiler, $os, $arch, $test-suite, $result)
21309 --test-machine-log TEMPLATE
21311 Produce a machine-readable log file (name template can
21312 use $pkgid, $compiler, $os, $arch, $result)
21313 --test-show-details FILTER
21315 --test-keep-tix-files
21317 keep .tix files for HPC between test runs
21318 --test-wrapper FILE
21320 Run test through a wrapper.
21321 --test-fail-when-no-test-suites
21323 Exit with failure when no test suites are found.
21324 --test-options TEMPLATES
21326 give extra options to test executables (name templates
21327 can use $pkgid, $compiler, $os, $arch, $test-suite)
21328 --test-option TEMPLATE
21330 give extra option to test executables (no need to quote
21331 options containing spaces, name template can use $pkgid,
21332 $compiler, $os, $arch, $test-suite)
21333 --benchmark-options TEMPLATES
21335 give extra options to benchmark executables (name tem‐
21336 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
21337 --benchmark-option TEMPLATE
21339 give extra option to benchmark executables (no need to
21340 quote options containing spaces, name template can use
21341 $pkgid, $compiler, $os, $arch, $benchmark)
21342 cabal v2-test
21345 Usage: cabal v2-test [TARGETS] [FLAGS]
21347 Runs the specified test-suites, first ensuring they are up to date.
21350 Any test-suite in any package in the project can be specified. A pack‐
21352 age can be specified in which case all the test-suites in the package
21353 are run. The default is to run all the test-suites in the package in
21354 the current directory.
21355 Dependencies are built or rebuilt as necessary. Additional configura‐
21357 tion flags can be specified on the command line and these extend the
21358 project configuration from the 'cabal.project', 'cabal.project.local'
21359 and other files.
21360 To pass command-line arguments to a test suite, see the v2-run command.
21362 Examples:
21365 cabal v2-test
21366 Run all the test-suites in the package in the current directory
21367 cabal v2-test pkgname
21368 Run all the test-suites in the package named pkgname
21369 cabal v2-test cname
21370 Run the test-suite named cname
21371 cabal v2-test cname --enable-coverage
21372 Run the test-suite built with code coverage (including local libs
21373 used)
21374 Note: this command is part of the new project-based system (aka nix-
21376 style local builds). These features are currently in beta. Please see
21377 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
21378 details and advice on what you can expect to work. If you encounter
21379 problems please file issues at https://github.com/haskell/cabal/issues
21380 and if you have any time to get involved and help with testing, fixing
21381 bugs etc then that is very much appreciated.
21382 Flags:
21385 -v, --verbose [n]
21386 Control verbosity (n is 0--3, default verbosity level is
21387 1)
21388 --builddir, --distdir, --distpref DIR
21390 The directory where Cabal puts generated build files (de‐
21391 fault dist)
21392 -g, --ghc
21394 compile with GHC
21395 --ghcjs
21397 compile with GHCJS
21398 --uhc
21400 compile with UHC
21401 --haskell-suite
21403 compile with a haskell-suite compiler
21404 --cabal-file PATH
21406 use this Cabal file
21407 -w, --with-compiler PATH
21409 give the path to a particular compiler
21410 --with-hc-pkg PATH
21412 give the path to the package tool
21413 --prefix DIR
21415 bake this prefix in preparation of installation
21416 --bindir DIR
21418 installation directory for executables
21419 --libdir DIR
21421 installation directory for libraries
21422 --libsubdir DIR
21424 subdirectory of libdir in which libs are installed
21425 --dynlibdir DIR
21427 installation directory for dynamic libraries
21428 --libexecdir DIR
21430 installation directory for program executables
21431 --libexecsubdir DIR
21433 subdirectory of libexecdir in which private executables
21434 are installed
21435 --datadir DIR
21437 installation directory for read-only data
21438 --datasubdir DIR
21440 subdirectory of datadir in which data files are installed
21441 --docdir DIR
21443 installation directory for documentation
21444 --htmldir DIR
21446 installation directory for HTML documentation
21447 --haddockdir DIR
21449 installation directory for haddock interfaces
21450 --sysconfdir DIR
21452 installation directory for configuration files
21453 --program-prefix PREFIX
21455 prefix to be applied to installed executables
21456 --program-suffix SUFFIX
21458 suffix to be applied to installed executables
21459 --enable-library-vanilla
21461 --disable-library-vanilla
21462 Vanilla libraries
21463 -p, --enable-library-profiling
21465 --disable-library-profiling
21466 Library profiling
21467 --enable-shared
21469 --disable-shared
21470 Shared library
21471 --enable-static
21473 --disable-static
21474 Static library
21475 --enable-executable-dynamic
21477 --disable-executable-dynamic
21478 Executable dynamic linking
21479 --enable-executable-static
21481 --disable-executable-static
21482 Executable fully static linking
21483 --enable-profiling
21485 --disable-profiling
21486 Executable and library profiling
21487 --enable-executable-profiling
21489 --disable-executable-profiling
21490 Executable profiling (DEPRECATED)
21491 --profiling-detail level
21493 Profiling detail level for executable and library (de‐
21494 fault, none, exported-functions, toplevel-functions,
21495 all-functions).
21496 --library-profiling-detail level
21498 Profiling detail level for libraries only.
21499 -O, --enable-optimization, --enable-optimisation [n]
21501 Build with optimization (n is 0--2, default is 1)
21502 --disable-optimization, --disable-optimisation
21504 Build without optimization
21505 --enable-debug-info [n]
21507 Emit debug info (n is 0--3, default is 0)
21508 --disable-debug-info
21510 Don't emit debug info
21511 --enable-library-for-ghci
21513 --disable-library-for-ghci
21514 compile library for use with GHCi
21515 --enable-split-sections
21517 --disable-split-sections
21518 compile library code such that unneeded definitions can
21519 be dropped from the final executable (GHC 7.8+)
21520 --enable-split-objs
21522 --disable-split-objs
21523 split library into smaller objects to reduce binary sizes
21524 (GHC 6.6+)
21525 --enable-executable-stripping
21527 --disable-executable-stripping
21528 strip executables upon installation to reduce binary
21529 sizes
21530 --enable-library-stripping
21532 --disable-library-stripping
21533 strip libraries upon installation to reduce binary sizes
21534 --configure-option OPT
21536 Extra option for configure
21537 --user
21539 --global
21540 doing a per-user installation
21541 --package-db DB
21543 Append the given package database to the list of package
21544 databases used (to satisfy dependencies and register
21545 into). May be a specific file, 'global' or 'user'. The
21546 initial list is ['global'], ['global', 'user'], or
21547 ['global', $sandbox], depending on context. Use 'clear'
21548 to reset the list to empty. See the user guide for de‐
21549 tails.
21550 -f, --flags FLAGS
21552 Force values for the given flags in Cabal conditionals in
21553 the .cabal file. E.g., --flags="debug -usebytestrings"
21554 forces the flag "debug" to true and "usebytestrings" to
21555 false.
21556 --extra-include-dirs PATH
21558 A list of directories to search for header files
21559 --enable-deterministic
21561 --disable-deterministic
21562 Try to be as deterministic as possible (used by the test
21563 suite)
21564 --ipid IPID
21566 Installed package ID to compile this package as
21567 --cid CID
21569 Installed component ID to compile this component as
21570 --extra-lib-dirs PATH
21572 A list of directories to search for external libraries
21573 --extra-framework-dirs PATH
21575 A list of directories to search for external frameworks
21576 (OS X only)
21577 --extra-prog-path PATH
21579 A list of directories to search for required programs (in
21580 addition to the normal search locations)
21581 --instantiate-with NAME=MOD
21583 A mapping of signature names to concrete module instanti‐
21584 ations.
21585 --enable-tests
21587 --disable-tests
21588 dependency checking and compilation for test suites
21589 listed in the package description file.
21590 --enable-coverage
21592 --disable-coverage
21593 build package with Haskell Program Coverage. (GHC only)
21594 --enable-library-coverage
21596 --disable-library-coverage
21597 build package with Haskell Program Coverage. (GHC only)
21598 (DEPRECATED)
21599 --enable-benchmarks
21601 --disable-benchmarks
21602 dependency checking and compilation for benchmarks listed
21603 in the package description file.
21604 --enable-relocatable
21606 --disable-relocatable
21607 building a package that is relocatable. (GHC only)
21608 --disable-response-files
21610 enable workaround for old versions of programs like "ar"
21611 that do not support @file arguments
21612 --allow-depending-on-private-libs
21614 Allow depending on private libraries. If set, the library
21615 visibility check MUST be done externally.
21616 --with-alex PATH
21618 give the path to alex
21619 --with-ar PATH
21621 give the path to ar
21622 --with-c2hs PATH
21624 give the path to c2hs
21625 --with-cpphs PATH
21627 give the path to cpphs
21628 --with-doctest PATH
21630 give the path to doctest
21631 --with-gcc PATH
21633 give the path to gcc
21634 --with-ghc PATH
21636 give the path to ghc
21637 --with-ghc-pkg PATH
21639 give the path to ghc-pkg
21640 --with-ghcjs PATH
21642 give the path to ghcjs
21643 --with-ghcjs-pkg PATH
21645 give the path to ghcjs-pkg
21646 --with-greencard PATH
21648 give the path to greencard
21649 --with-haddock PATH
21651 give the path to haddock
21652 --with-happy PATH
21654 give the path to happy
21655 --with-haskell-suite PATH
21657 give the path to haskell-suite
21658 --with-haskell-suite-pkg PATH
21660 give the path to haskell-suite-pkg
21661 --with-hmake PATH
21663 give the path to hmake
21664 --with-hpc PATH
21666 give the path to hpc
21667 --with-hsc2hs PATH
21669 give the path to hsc2hs
21670 --with-hscolour PATH
21672 give the path to hscolour
21673 --with-jhc PATH
21675 give the path to jhc
21676 --with-ld PATH
21678 give the path to ld
21679 --with-pkg-config PATH
21681 give the path to pkg-config
21682 --with-runghc PATH
21684 give the path to runghc
21685 --with-strip PATH
21687 give the path to strip
21688 --with-tar PATH
21690 give the path to tar
21691 --with-uhc PATH
21693 give the path to uhc
21694 --alex-option OPT
21696 give an extra option to alex (no need to quote options
21697 containing spaces)
21698 --ar-option OPT
21700 give an extra option to ar (no need to quote options con‐
21701 taining spaces)
21702 --c2hs-option OPT
21704 give an extra option to c2hs (no need to quote options
21705 containing spaces)
21706 --cpphs-option OPT
21708 give an extra option to cpphs (no need to quote options
21709 containing spaces)
21710 --doctest-option OPT
21712 give an extra option to doctest (no need to quote options
21713 containing spaces)
21714 --gcc-option OPT
21716 give an extra option to gcc (no need to quote options
21717 containing spaces)
21718 --ghc-option OPT
21720 give an extra option to ghc (no need to quote options
21721 containing spaces)
21722 --ghc-pkg-option OPT
21724 give an extra option to ghc-pkg (no need to quote options
21725 containing spaces)
21726 --ghcjs-option OPT
21728 give an extra option to ghcjs (no need to quote options
21729 containing spaces)
21730 --ghcjs-pkg-option OPT
21732 give an extra option to ghcjs-pkg (no need to quote op‐
21733 tions containing spaces)
21734 --greencard-option OPT
21736 give an extra option to greencard (no need to quote op‐
21737 tions containing spaces)
21738 --haddock-option OPT
21740 give an extra option to haddock (no need to quote options
21741 containing spaces)
21742 --happy-option OPT
21744 give an extra option to happy (no need to quote options
21745 containing spaces)
21746 --haskell-suite-option OPT
21748 give an extra option to haskell-suite (no need to quote
21749 options containing spaces)
21750 --haskell-suite-pkg-option OPT
21752 give an extra option to haskell-suite-pkg (no need to
21753 quote options containing spaces)
21754 --hmake-option OPT
21756 give an extra option to hmake (no need to quote options
21757 containing spaces)
21758 --hpc-option OPT
21760 give an extra option to hpc (no need to quote options
21761 containing spaces)
21762 --hsc2hs-option OPT
21764 give an extra option to hsc2hs (no need to quote options
21765 containing spaces)
21766 --hscolour-option OPT
21768 give an extra option to hscolour (no need to quote op‐
21769 tions containing spaces)
21770 --jhc-option OPT
21772 give an extra option to jhc (no need to quote options
21773 containing spaces)
21774 --ld-option OPT
21776 give an extra option to ld (no need to quote options con‐
21777 taining spaces)
21778 --pkg-config-option OPT
21780 give an extra option to pkg-config (no need to quote op‐
21781 tions containing spaces)
21782 --runghc-option OPT
21784 give an extra option to runghc (no need to quote options
21785 containing spaces)
21786 --strip-option OPT
21788 give an extra option to strip (no need to quote options
21789 containing spaces)
21790 --tar-option OPT
21792 give an extra option to tar (no need to quote options
21793 containing spaces)
21794 --uhc-option OPT
21796 give an extra option to uhc (no need to quote options
21797 containing spaces)
21798 --alex-options OPTS
21800 give extra options to alex
21801 --ar-options OPTS
21803 give extra options to ar
21804 --c2hs-options OPTS
21806 give extra options to c2hs
21807 --cpphs-options OPTS
21809 give extra options to cpphs
21810 --doctest-options OPTS
21812 give extra options to doctest
21813 --gcc-options OPTS
21815 give extra options to gcc
21816 --ghc-options OPTS
21818 give extra options to ghc
21819 --ghc-pkg-options OPTS
21821 give extra options to ghc-pkg
21822 --ghcjs-options OPTS
21824 give extra options to ghcjs
21825 --ghcjs-pkg-options OPTS
21827 give extra options to ghcjs-pkg
21828 --greencard-options OPTS
21830 give extra options to greencard
21831 --haddock-options OPTS
21833 give extra options to haddock
21834 --happy-options OPTS
21836 give extra options to happy
21837 --haskell-suite-options OPTS
21839 give extra options to haskell-suite
21840 --haskell-suite-pkg-options OPTS
21842 give extra options to haskell-suite-pkg
21843 --hmake-options OPTS
21845 give extra options to hmake
21846 --hpc-options OPTS
21848 give extra options to hpc
21849 --hsc2hs-options OPTS
21851 give extra options to hsc2hs
21852 --hscolour-options OPTS
21854 give extra options to hscolour
21855 --jhc-options OPTS
21857 give extra options to jhc
21858 --ld-options OPTS
21860 give extra options to ld
21861 --pkg-config-options OPTS
21863 give extra options to pkg-config
21864 --runghc-options OPTS
21866 give extra options to runghc
21867 --strip-options OPTS
21869 give extra options to strip
21870 --tar-options OPTS
21872 give extra options to tar
21873 --uhc-options OPTS
21875 give extra options to uhc
21876 --cabal-lib-version VERSION
21878 Select which version of the Cabal lib to use to build
21879 packages (useful for testing).
21880 --constraint CONSTRAINT
21882 Specify constraints on a package (version, in‐
21883 stalled/source, flags)
21884 --preference CONSTRAINT
21886 Specify preferences (soft constraints) on the version of
21887 a package
21888 --solver SOLVER
21890 Select dependency solver to use (default: modular).
21891 Choices: modular.
21892 --allow-older [DEPS]
21894 Ignore lower bounds in all dependencies or DEPS
21895 --allow-newer [DEPS]
21897 Ignore upper bounds in all dependencies or DEPS
21898 --write-ghc-environment-files always|never|ghc8.4.4+
21900 Whether to create a .ghc.environment file after a suc‐
21901 cessful build (v2-build only)
21902 --enable-documentation
21904 --disable-documentation
21905 building of documentation
21906 --doc-index-file TEMPLATE
21908 A central index of haddock API documentation (template
21909 cannot use $pkgid)
21910 --dry-run
21912 Do not install anything, only print what would be in‐
21913 stalled.
21914 --max-backjumps NUM
21916 Maximum number of backjumps allowed while solving (de‐
21917 fault: 4000). Use a negative number to enable unlimited
21918 backtracking. Use 0 to disable backtracking completely.
21919 --reorder-goals
21921 --no-reorder-goals
21922 Try to reorder goals according to certain heuristics.
21923 Slows things down on average, but may make backtracking
21924 faster for some packages.
21925 --count-conflicts
21927 --no-count-conflicts
21928 Try to speed up solving by preferring goals that are in‐
21929 volved in a lot of conflicts (default).
21930 --fine-grained-conflicts
21932 --no-fine-grained-conflicts
21933 Skip a version of a package if it does not resolve the
21934 conflicts encountered in the last version, as a solver
21935 optimization (default).
21936 --minimize-conflict-set
21938 --no-minimize-conflict-set
21939 When there is no solution, try to improve the error mes‐
21940 sage by finding a minimal conflict set (default: false).
21941 May increase run time significantly.
21942 --independent-goals
21944 --no-independent-goals
21945 Treat several goals on the command line as independent.
21946 If several goals depend on the same package, different
21947 versions can be chosen.
21948 --shadow-installed-packages
21950 --no-shadow-installed-packages
21951 If multiple package instances of the same version are in‐
21952 stalled, treat all but one as shadowed.
21953 --strong-flags
21955 --no-strong-flags
21956 Do not defer flag choices (this used to be the default in
21957 cabal-install <= 1.20).
21958 --allow-boot-library-installs
21960 --no-allow-boot-library-installs
21961 Allow cabal to install base, ghc-prim, integer-simple,
21962 integer-gmp, and template-haskell.
21963 --reject-unconstrained-dependencies none|all
21965 Require these packages to have constraints on them if
21966 they are to be selected (default: none).
21967 --reinstall
21969 --no-reinstall
21970 Install even if it means installing the same version
21971 again.
21972 --avoid-reinstalls
21974 --no-avoid-reinstalls
21975 Do not select versions that would destructively overwrite
21976 installed packages.
21977 --force-reinstalls
21979 --no-force-reinstalls
21980 Reinstall packages even if they will most likely break
21981 other installed packages.
21982 --upgrade-dependencies
21984 --no-upgrade-dependencies
21985 Pick the latest version for all dependencies, rather than
21986 trying to pick an installed version.
21987 --only-dependencies
21989 --no-only-dependencies
21990 Install only the dependencies necessary to build the
21991 given packages
21992 --dependencies-only
21994 --no-dependencies-only
21995 A synonym for --only-dependencies
21996 --index-state STATE
21998 Use source package index state as it existed at a previ‐
21999 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
22000 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
22001 'HEAD' (default: 'HEAD').
22002 --root-cmd COMMAND
22004 (No longer supported, do not use.)
22005 --symlink-bindir DIR
22007 Add symlinks to installed executables into this direc‐
22008 tory.
22009 --build-summary TEMPLATE
22011 Save build summaries to file (name template can use
22012 $pkgid, $compiler, $os, $arch)
22013 --build-log TEMPLATE
22015 Log all builds to file (name template can use $pkgid,
22016 $compiler, $os, $arch)
22017 --remote-build-reporting LEVEL
22019 Generate build reports to send to a remote server (none,
22020 anonymous or detailed).
22021 --report-planning-failure
22023 Generate build reports when the dependency solver fails.
22024 This is used by the Hackage build bot.
22025 --enable-per-component
22027 --disable-per-component
22028 Per-component builds when possible
22029 --one-shot
22031 --no-one-shot
22032 Do not record the packages in the world file.
22033 --run-tests
22035 Run package test suites during installation.
22036 -j, --jobs [NUM]
22038 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
22039 given).
22040 --keep-going
22042 After a build failure, continue to build other unaffected
22043 packages.
22044 --offline
22046 --no-offline
22047 Don't download packages from the Internet.
22048 --project-file FILE
22050 Set the name of the cabal.project file to search for in
22051 parent directories
22052 --only
22054 Only installs the package in the current directory.
22055 --haddock-hoogle
22057 Generate a hoogle database
22058 --haddock-html
22060 Generate HTML documentation (the default)
22061 --haddock-html-location URL
22063 Location of HTML documentation for pre-requisite packages
22064 --haddock-for-hackage
22066 Collection of flags to generate documentation suitable
22067 for upload to hackage
22068 --haddock-executables
22070 Run haddock for Executables targets
22071 --haddock-tests
22073 Run haddock for Test Suite targets
22074 --haddock-benchmarks
22076 Run haddock for Benchmark targets
22077 --haddock-all
22079 Run haddock for all targets
22080 --haddock-internal
22082 Run haddock for internal modules and include all symbols
22083 --haddock-css PATH
22085 Use PATH as the haddock stylesheet
22086 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
22088 dock-hyperlinked-source
22089 Hyperlink the documentation to the source code
22090 --haddock-quickjump
22092 Generate an index for interactive documentation naviga‐
22093 tion
22094 --haddock-hscolour-css PATH
22096 Use PATH as the HsColour stylesheet
22097 --haddock-contents-location URL
22099 Bake URL in as the location for the contents page
22100 --test-log TEMPLATE
22102 Log all test suite results to file (name template can use
22103 $pkgid, $compiler, $os, $arch, $test-suite, $result)
22104 --test-machine-log TEMPLATE
22106 Produce a machine-readable log file (name template can
22107 use $pkgid, $compiler, $os, $arch, $result)
22108 --test-show-details FILTER
22110 --test-keep-tix-files
22112 keep .tix files for HPC between test runs
22113 --test-wrapper FILE
22115 Run test through a wrapper.
22116 --test-fail-when-no-test-suites
22118 Exit with failure when no test suites are found.
22119 --test-options TEMPLATES
22121 give extra options to test executables (name templates
22122 can use $pkgid, $compiler, $os, $arch, $test-suite)
22123 --test-option TEMPLATE
22125 give extra option to test executables (no need to quote
22126 options containing spaces, name template can use $pkgid,
22127 $compiler, $os, $arch, $test-suite)
22128 --benchmark-options TEMPLATES
22130 give extra options to benchmark executables (name tem‐
22131 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
22132 --benchmark-option TEMPLATE
22134 give extra option to benchmark executables (no need to
22135 quote options containing spaces, name template can use
22136 $pkgid, $compiler, $os, $arch, $benchmark)
22137 cabal bench
22140 Usage: cabal bench [TARGETS] [FLAGS]
22142 Runs the specified benchmarks, first ensuring they are up to date.
22145 Any benchmark in any package in the project can be specified. A package
22147 can be specified in which case all the benchmarks in the package are
22148 run. The default is to run all the benchmarks in the package in the
22149 current directory.
22150 Dependencies are built or rebuilt as necessary. Additional configura‐
22152 tion flags can be specified on the command line and these extend the
22153 project configuration from the 'cabal.project', 'cabal.project.local'
22154 and other files.
22155 Runs the specified benchmarks, first ensuring they are up to date.
22158 Any benchmark in any package in the project can be specified. A package
22160 can be specified in which case all the benchmarks in the package are
22161 run. The default is to run all the benchmarks in the package in the
22162 current directory.
22163 Dependencies are built or rebuilt as necessary. Additional configura‐
22165 tion flags can be specified on the command line and these extend the
22166 project configuration from the 'cabal.project', 'cabal.project.local'
22167 and other files.
22168 Flags:
22171 -v, --verbose [n]
22172 Control verbosity (n is 0--3, default verbosity level is
22173 1)
22174 --builddir, --distdir, --distpref DIR
22176 The directory where Cabal puts generated build files (de‐
22177 fault dist)
22178 -g, --ghc
22180 compile with GHC
22181 --ghcjs
22183 compile with GHCJS
22184 --uhc
22186 compile with UHC
22187 --haskell-suite
22189 compile with a haskell-suite compiler
22190 --cabal-file PATH
22192 use this Cabal file
22193 -w, --with-compiler PATH
22195 give the path to a particular compiler
22196 --with-hc-pkg PATH
22198 give the path to the package tool
22199 --prefix DIR
22201 bake this prefix in preparation of installation
22202 --bindir DIR
22204 installation directory for executables
22205 --libdir DIR
22207 installation directory for libraries
22208 --libsubdir DIR
22210 subdirectory of libdir in which libs are installed
22211 --dynlibdir DIR
22213 installation directory for dynamic libraries
22214 --libexecdir DIR
22216 installation directory for program executables
22217 --libexecsubdir DIR
22219 subdirectory of libexecdir in which private executables
22220 are installed
22221 --datadir DIR
22223 installation directory for read-only data
22224 --datasubdir DIR
22226 subdirectory of datadir in which data files are installed
22227 --docdir DIR
22229 installation directory for documentation
22230 --htmldir DIR
22232 installation directory for HTML documentation
22233 --haddockdir DIR
22235 installation directory for haddock interfaces
22236 --sysconfdir DIR
22238 installation directory for configuration files
22239 --program-prefix PREFIX
22241 prefix to be applied to installed executables
22242 --program-suffix SUFFIX
22244 suffix to be applied to installed executables
22245 --enable-library-vanilla
22247 --disable-library-vanilla
22248 Vanilla libraries
22249 -p, --enable-library-profiling
22251 --disable-library-profiling
22252 Library profiling
22253 --enable-shared
22255 --disable-shared
22256 Shared library
22257 --enable-static
22259 --disable-static
22260 Static library
22261 --enable-executable-dynamic
22263 --disable-executable-dynamic
22264 Executable dynamic linking
22265 --enable-executable-static
22267 --disable-executable-static
22268 Executable fully static linking
22269 --enable-profiling
22271 --disable-profiling
22272 Executable and library profiling
22273 --enable-executable-profiling
22275 --disable-executable-profiling
22276 Executable profiling (DEPRECATED)
22277 --profiling-detail level
22279 Profiling detail level for executable and library (de‐
22280 fault, none, exported-functions, toplevel-functions,
22281 all-functions).
22282 --library-profiling-detail level
22284 Profiling detail level for libraries only.
22285 -O, --enable-optimization, --enable-optimisation [n]
22287 Build with optimization (n is 0--2, default is 1)
22288 --disable-optimization, --disable-optimisation
22290 Build without optimization
22291 --enable-debug-info [n]
22293 Emit debug info (n is 0--3, default is 0)
22294 --disable-debug-info
22296 Don't emit debug info
22297 --enable-library-for-ghci
22299 --disable-library-for-ghci
22300 compile library for use with GHCi
22301 --enable-split-sections
22303 --disable-split-sections
22304 compile library code such that unneeded definitions can
22305 be dropped from the final executable (GHC 7.8+)
22306 --enable-split-objs
22308 --disable-split-objs
22309 split library into smaller objects to reduce binary sizes
22310 (GHC 6.6+)
22311 --enable-executable-stripping
22313 --disable-executable-stripping
22314 strip executables upon installation to reduce binary
22315 sizes
22316 --enable-library-stripping
22318 --disable-library-stripping
22319 strip libraries upon installation to reduce binary sizes
22320 --configure-option OPT
22322 Extra option for configure
22323 --user
22325 --global
22326 doing a per-user installation
22327 --package-db DB
22329 Append the given package database to the list of package
22330 databases used (to satisfy dependencies and register
22331 into). May be a specific file, 'global' or 'user'. The
22332 initial list is ['global'], ['global', 'user'], or
22333 ['global', $sandbox], depending on context. Use 'clear'
22334 to reset the list to empty. See the user guide for de‐
22335 tails.
22336 -f, --flags FLAGS
22338 Force values for the given flags in Cabal conditionals in
22339 the .cabal file. E.g., --flags="debug -usebytestrings"
22340 forces the flag "debug" to true and "usebytestrings" to
22341 false.
22342 --extra-include-dirs PATH
22344 A list of directories to search for header files
22345 --enable-deterministic
22347 --disable-deterministic
22348 Try to be as deterministic as possible (used by the test
22349 suite)
22350 --ipid IPID
22352 Installed package ID to compile this package as
22353 --cid CID
22355 Installed component ID to compile this component as
22356 --extra-lib-dirs PATH
22358 A list of directories to search for external libraries
22359 --extra-framework-dirs PATH
22361 A list of directories to search for external frameworks
22362 (OS X only)
22363 --extra-prog-path PATH
22365 A list of directories to search for required programs (in
22366 addition to the normal search locations)
22367 --instantiate-with NAME=MOD
22369 A mapping of signature names to concrete module instanti‐
22370 ations.
22371 --enable-tests
22373 --disable-tests
22374 dependency checking and compilation for test suites
22375 listed in the package description file.
22376 --enable-coverage
22378 --disable-coverage
22379 build package with Haskell Program Coverage. (GHC only)
22380 --enable-library-coverage
22382 --disable-library-coverage
22383 build package with Haskell Program Coverage. (GHC only)
22384 (DEPRECATED)
22385 --enable-benchmarks
22387 --disable-benchmarks
22388 dependency checking and compilation for benchmarks listed
22389 in the package description file.
22390 --enable-relocatable
22392 --disable-relocatable
22393 building a package that is relocatable. (GHC only)
22394 --disable-response-files
22396 enable workaround for old versions of programs like "ar"
22397 that do not support @file arguments
22398 --allow-depending-on-private-libs
22400 Allow depending on private libraries. If set, the library
22401 visibility check MUST be done externally.
22402 --with-alex PATH
22404 give the path to alex
22405 --with-ar PATH
22407 give the path to ar
22408 --with-c2hs PATH
22410 give the path to c2hs
22411 --with-cpphs PATH
22413 give the path to cpphs
22414 --with-doctest PATH
22416 give the path to doctest
22417 --with-gcc PATH
22419 give the path to gcc
22420 --with-ghc PATH
22422 give the path to ghc
22423 --with-ghc-pkg PATH
22425 give the path to ghc-pkg
22426 --with-ghcjs PATH
22428 give the path to ghcjs
22429 --with-ghcjs-pkg PATH
22431 give the path to ghcjs-pkg
22432 --with-greencard PATH
22434 give the path to greencard
22435 --with-haddock PATH
22437 give the path to haddock
22438 --with-happy PATH
22440 give the path to happy
22441 --with-haskell-suite PATH
22443 give the path to haskell-suite
22444 --with-haskell-suite-pkg PATH
22446 give the path to haskell-suite-pkg
22447 --with-hmake PATH
22449 give the path to hmake
22450 --with-hpc PATH
22452 give the path to hpc
22453 --with-hsc2hs PATH
22455 give the path to hsc2hs
22456 --with-hscolour PATH
22458 give the path to hscolour
22459 --with-jhc PATH
22461 give the path to jhc
22462 --with-ld PATH
22464 give the path to ld
22465 --with-pkg-config PATH
22467 give the path to pkg-config
22468 --with-runghc PATH
22470 give the path to runghc
22471 --with-strip PATH
22473 give the path to strip
22474 --with-tar PATH
22476 give the path to tar
22477 --with-uhc PATH
22479 give the path to uhc
22480 --alex-option OPT
22482 give an extra option to alex (no need to quote options
22483 containing spaces)
22484 --ar-option OPT
22486 give an extra option to ar (no need to quote options con‐
22487 taining spaces)
22488 --c2hs-option OPT
22490 give an extra option to c2hs (no need to quote options
22491 containing spaces)
22492 --cpphs-option OPT
22494 give an extra option to cpphs (no need to quote options
22495 containing spaces)
22496 --doctest-option OPT
22498 give an extra option to doctest (no need to quote options
22499 containing spaces)
22500 --gcc-option OPT
22502 give an extra option to gcc (no need to quote options
22503 containing spaces)
22504 --ghc-option OPT
22506 give an extra option to ghc (no need to quote options
22507 containing spaces)
22508 --ghc-pkg-option OPT
22510 give an extra option to ghc-pkg (no need to quote options
22511 containing spaces)
22512 --ghcjs-option OPT
22514 give an extra option to ghcjs (no need to quote options
22515 containing spaces)
22516 --ghcjs-pkg-option OPT
22518 give an extra option to ghcjs-pkg (no need to quote op‐
22519 tions containing spaces)
22520 --greencard-option OPT
22522 give an extra option to greencard (no need to quote op‐
22523 tions containing spaces)
22524 --haddock-option OPT
22526 give an extra option to haddock (no need to quote options
22527 containing spaces)
22528 --happy-option OPT
22530 give an extra option to happy (no need to quote options
22531 containing spaces)
22532 --haskell-suite-option OPT
22534 give an extra option to haskell-suite (no need to quote
22535 options containing spaces)
22536 --haskell-suite-pkg-option OPT
22538 give an extra option to haskell-suite-pkg (no need to
22539 quote options containing spaces)
22540 --hmake-option OPT
22542 give an extra option to hmake (no need to quote options
22543 containing spaces)
22544 --hpc-option OPT
22546 give an extra option to hpc (no need to quote options
22547 containing spaces)
22548 --hsc2hs-option OPT
22550 give an extra option to hsc2hs (no need to quote options
22551 containing spaces)
22552 --hscolour-option OPT
22554 give an extra option to hscolour (no need to quote op‐
22555 tions containing spaces)
22556 --jhc-option OPT
22558 give an extra option to jhc (no need to quote options
22559 containing spaces)
22560 --ld-option OPT
22562 give an extra option to ld (no need to quote options con‐
22563 taining spaces)
22564 --pkg-config-option OPT
22566 give an extra option to pkg-config (no need to quote op‐
22567 tions containing spaces)
22568 --runghc-option OPT
22570 give an extra option to runghc (no need to quote options
22571 containing spaces)
22572 --strip-option OPT
22574 give an extra option to strip (no need to quote options
22575 containing spaces)
22576 --tar-option OPT
22578 give an extra option to tar (no need to quote options
22579 containing spaces)
22580 --uhc-option OPT
22582 give an extra option to uhc (no need to quote options
22583 containing spaces)
22584 --alex-options OPTS
22586 give extra options to alex
22587 --ar-options OPTS
22589 give extra options to ar
22590 --c2hs-options OPTS
22592 give extra options to c2hs
22593 --cpphs-options OPTS
22595 give extra options to cpphs
22596 --doctest-options OPTS
22598 give extra options to doctest
22599 --gcc-options OPTS
22601 give extra options to gcc
22602 --ghc-options OPTS
22604 give extra options to ghc
22605 --ghc-pkg-options OPTS
22607 give extra options to ghc-pkg
22608 --ghcjs-options OPTS
22610 give extra options to ghcjs
22611 --ghcjs-pkg-options OPTS
22613 give extra options to ghcjs-pkg
22614 --greencard-options OPTS
22616 give extra options to greencard
22617 --haddock-options OPTS
22619 give extra options to haddock
22620 --happy-options OPTS
22622 give extra options to happy
22623 --haskell-suite-options OPTS
22625 give extra options to haskell-suite
22626 --haskell-suite-pkg-options OPTS
22628 give extra options to haskell-suite-pkg
22629 --hmake-options OPTS
22631 give extra options to hmake
22632 --hpc-options OPTS
22634 give extra options to hpc
22635 --hsc2hs-options OPTS
22637 give extra options to hsc2hs
22638 --hscolour-options OPTS
22640 give extra options to hscolour
22641 --jhc-options OPTS
22643 give extra options to jhc
22644 --ld-options OPTS
22646 give extra options to ld
22647 --pkg-config-options OPTS
22649 give extra options to pkg-config
22650 --runghc-options OPTS
22652 give extra options to runghc
22653 --strip-options OPTS
22655 give extra options to strip
22656 --tar-options OPTS
22658 give extra options to tar
22659 --uhc-options OPTS
22661 give extra options to uhc
22662 --cabal-lib-version VERSION
22664 Select which version of the Cabal lib to use to build
22665 packages (useful for testing).
22666 --constraint CONSTRAINT
22668 Specify constraints on a package (version, in‐
22669 stalled/source, flags)
22670 --preference CONSTRAINT
22672 Specify preferences (soft constraints) on the version of
22673 a package
22674 --solver SOLVER
22676 Select dependency solver to use (default: modular).
22677 Choices: modular.
22678 --allow-older [DEPS]
22680 Ignore lower bounds in all dependencies or DEPS
22681 --allow-newer [DEPS]
22683 Ignore upper bounds in all dependencies or DEPS
22684 --write-ghc-environment-files always|never|ghc8.4.4+
22686 Whether to create a .ghc.environment file after a suc‐
22687 cessful build (v2-build only)
22688 --enable-documentation
22690 --disable-documentation
22691 building of documentation
22692 --doc-index-file TEMPLATE
22694 A central index of haddock API documentation (template
22695 cannot use $pkgid)
22696 --dry-run
22698 Do not install anything, only print what would be in‐
22699 stalled.
22700 --max-backjumps NUM
22702 Maximum number of backjumps allowed while solving (de‐
22703 fault: 4000). Use a negative number to enable unlimited
22704 backtracking. Use 0 to disable backtracking completely.
22705 --reorder-goals
22707 --no-reorder-goals
22708 Try to reorder goals according to certain heuristics.
22709 Slows things down on average, but may make backtracking
22710 faster for some packages.
22711 --count-conflicts
22713 --no-count-conflicts
22714 Try to speed up solving by preferring goals that are in‐
22715 volved in a lot of conflicts (default).
22716 --fine-grained-conflicts
22718 --no-fine-grained-conflicts
22719 Skip a version of a package if it does not resolve the
22720 conflicts encountered in the last version, as a solver
22721 optimization (default).
22722 --minimize-conflict-set
22724 --no-minimize-conflict-set
22725 When there is no solution, try to improve the error mes‐
22726 sage by finding a minimal conflict set (default: false).
22727 May increase run time significantly.
22728 --independent-goals
22730 --no-independent-goals
22731 Treat several goals on the command line as independent.
22732 If several goals depend on the same package, different
22733 versions can be chosen.
22734 --shadow-installed-packages
22736 --no-shadow-installed-packages
22737 If multiple package instances of the same version are in‐
22738 stalled, treat all but one as shadowed.
22739 --strong-flags
22741 --no-strong-flags
22742 Do not defer flag choices (this used to be the default in
22743 cabal-install <= 1.20).
22744 --allow-boot-library-installs
22746 --no-allow-boot-library-installs
22747 Allow cabal to install base, ghc-prim, integer-simple,
22748 integer-gmp, and template-haskell.
22749 --reject-unconstrained-dependencies none|all
22751 Require these packages to have constraints on them if
22752 they are to be selected (default: none).
22753 --reinstall
22755 --no-reinstall
22756 Install even if it means installing the same version
22757 again.
22758 --avoid-reinstalls
22760 --no-avoid-reinstalls
22761 Do not select versions that would destructively overwrite
22762 installed packages.
22763 --force-reinstalls
22765 --no-force-reinstalls
22766 Reinstall packages even if they will most likely break
22767 other installed packages.
22768 --upgrade-dependencies
22770 --no-upgrade-dependencies
22771 Pick the latest version for all dependencies, rather than
22772 trying to pick an installed version.
22773 --only-dependencies
22775 --no-only-dependencies
22776 Install only the dependencies necessary to build the
22777 given packages
22778 --dependencies-only
22780 --no-dependencies-only
22781 A synonym for --only-dependencies
22782 --index-state STATE
22784 Use source package index state as it existed at a previ‐
22785 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
22786 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
22787 'HEAD' (default: 'HEAD').
22788 --root-cmd COMMAND
22790 (No longer supported, do not use.)
22791 --symlink-bindir DIR
22793 Add symlinks to installed executables into this direc‐
22794 tory.
22795 --build-summary TEMPLATE
22797 Save build summaries to file (name template can use
22798 $pkgid, $compiler, $os, $arch)
22799 --build-log TEMPLATE
22801 Log all builds to file (name template can use $pkgid,
22802 $compiler, $os, $arch)
22803 --remote-build-reporting LEVEL
22805 Generate build reports to send to a remote server (none,
22806 anonymous or detailed).
22807 --report-planning-failure
22809 Generate build reports when the dependency solver fails.
22810 This is used by the Hackage build bot.
22811 --enable-per-component
22813 --disable-per-component
22814 Per-component builds when possible
22815 --one-shot
22817 --no-one-shot
22818 Do not record the packages in the world file.
22819 --run-tests
22821 Run package test suites during installation.
22822 -j, --jobs [NUM]
22824 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
22825 given).
22826 --keep-going
22828 After a build failure, continue to build other unaffected
22829 packages.
22830 --offline
22832 --no-offline
22833 Don't download packages from the Internet.
22834 --project-file FILE
22836 Set the name of the cabal.project file to search for in
22837 parent directories
22838 --only
22840 Only installs the package in the current directory.
22841 --haddock-hoogle
22843 Generate a hoogle database
22844 --haddock-html
22846 Generate HTML documentation (the default)
22847 --haddock-html-location URL
22849 Location of HTML documentation for pre-requisite packages
22850 --haddock-for-hackage
22852 Collection of flags to generate documentation suitable
22853 for upload to hackage
22854 --haddock-executables
22856 Run haddock for Executables targets
22857 --haddock-tests
22859 Run haddock for Test Suite targets
22860 --haddock-benchmarks
22862 Run haddock for Benchmark targets
22863 --haddock-all
22865 Run haddock for all targets
22866 --haddock-internal
22868 Run haddock for internal modules and include all symbols
22869 --haddock-css PATH
22871 Use PATH as the haddock stylesheet
22872 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
22874 dock-hyperlinked-source
22875 Hyperlink the documentation to the source code
22876 --haddock-quickjump
22878 Generate an index for interactive documentation naviga‐
22879 tion
22880 --haddock-hscolour-css PATH
22882 Use PATH as the HsColour stylesheet
22883 --haddock-contents-location URL
22885 Bake URL in as the location for the contents page
22886 --test-log TEMPLATE
22888 Log all test suite results to file (name template can use
22889 $pkgid, $compiler, $os, $arch, $test-suite, $result)
22890 --test-machine-log TEMPLATE
22892 Produce a machine-readable log file (name template can
22893 use $pkgid, $compiler, $os, $arch, $result)
22894 --test-show-details FILTER
22896 --test-keep-tix-files
22898 keep .tix files for HPC between test runs
22899 --test-wrapper FILE
22901 Run test through a wrapper.
22902 --test-fail-when-no-test-suites
22904 Exit with failure when no test suites are found.
22905 --test-options TEMPLATES
22907 give extra options to test executables (name templates
22908 can use $pkgid, $compiler, $os, $arch, $test-suite)
22909 --test-option TEMPLATE
22911 give extra option to test executables (no need to quote
22912 options containing spaces, name template can use $pkgid,
22913 $compiler, $os, $arch, $test-suite)
22914 --benchmark-options TEMPLATES
22916 give extra options to benchmark executables (name tem‐
22917 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
22918 --benchmark-option TEMPLATE
22920 give extra option to benchmark executables (no need to
22921 quote options containing spaces, name template can use
22922 $pkgid, $compiler, $os, $arch, $benchmark)
22923 cabal new-bench
22926 Usage: cabal new-bench [TARGETS] [FLAGS]
22928 Runs the specified benchmarks, first ensuring they are up to date.
22931 Any benchmark in any package in the project can be specified. A package
22933 can be specified in which case all the benchmarks in the package are
22934 run. The default is to run all the benchmarks in the package in the
22935 current directory.
22936 Dependencies are built or rebuilt as necessary. Additional configura‐
22938 tion flags can be specified on the command line and these extend the
22939 project configuration from the 'cabal.project', 'cabal.project.local'
22940 and other files.
22941 Runs the specified benchmarks, first ensuring they are up to date.
22944 Any benchmark in any package in the project can be specified. A package
22946 can be specified in which case all the benchmarks in the package are
22947 run. The default is to run all the benchmarks in the package in the
22948 current directory.
22949 Dependencies are built or rebuilt as necessary. Additional configura‐
22951 tion flags can be specified on the command line and these extend the
22952 project configuration from the 'cabal.project', 'cabal.project.local'
22953 and other files.
22954 Flags:
22957 -v, --verbose [n]
22958 Control verbosity (n is 0--3, default verbosity level is
22959 1)
22960 --builddir, --distdir, --distpref DIR
22962 The directory where Cabal puts generated build files (de‐
22963 fault dist)
22964 -g, --ghc
22966 compile with GHC
22967 --ghcjs
22969 compile with GHCJS
22970 --uhc
22972 compile with UHC
22973 --haskell-suite
22975 compile with a haskell-suite compiler
22976 --cabal-file PATH
22978 use this Cabal file
22979 -w, --with-compiler PATH
22981 give the path to a particular compiler
22982 --with-hc-pkg PATH
22984 give the path to the package tool
22985 --prefix DIR
22987 bake this prefix in preparation of installation
22988 --bindir DIR
22990 installation directory for executables
22991 --libdir DIR
22993 installation directory for libraries
22994 --libsubdir DIR
22996 subdirectory of libdir in which libs are installed
22997 --dynlibdir DIR
22999 installation directory for dynamic libraries
23000 --libexecdir DIR
23002 installation directory for program executables
23003 --libexecsubdir DIR
23005 subdirectory of libexecdir in which private executables
23006 are installed
23007 --datadir DIR
23009 installation directory for read-only data
23010 --datasubdir DIR
23012 subdirectory of datadir in which data files are installed
23013 --docdir DIR
23015 installation directory for documentation
23016 --htmldir DIR
23018 installation directory for HTML documentation
23019 --haddockdir DIR
23021 installation directory for haddock interfaces
23022 --sysconfdir DIR
23024 installation directory for configuration files
23025 --program-prefix PREFIX
23027 prefix to be applied to installed executables
23028 --program-suffix SUFFIX
23030 suffix to be applied to installed executables
23031 --enable-library-vanilla
23033 --disable-library-vanilla
23034 Vanilla libraries
23035 -p, --enable-library-profiling
23037 --disable-library-profiling
23038 Library profiling
23039 --enable-shared
23041 --disable-shared
23042 Shared library
23043 --enable-static
23045 --disable-static
23046 Static library
23047 --enable-executable-dynamic
23049 --disable-executable-dynamic
23050 Executable dynamic linking
23051 --enable-executable-static
23053 --disable-executable-static
23054 Executable fully static linking
23055 --enable-profiling
23057 --disable-profiling
23058 Executable and library profiling
23059 --enable-executable-profiling
23061 --disable-executable-profiling
23062 Executable profiling (DEPRECATED)
23063 --profiling-detail level
23065 Profiling detail level for executable and library (de‐
23066 fault, none, exported-functions, toplevel-functions,
23067 all-functions).
23068 --library-profiling-detail level
23070 Profiling detail level for libraries only.
23071 -O, --enable-optimization, --enable-optimisation [n]
23073 Build with optimization (n is 0--2, default is 1)
23074 --disable-optimization, --disable-optimisation
23076 Build without optimization
23077 --enable-debug-info [n]
23079 Emit debug info (n is 0--3, default is 0)
23080 --disable-debug-info
23082 Don't emit debug info
23083 --enable-library-for-ghci
23085 --disable-library-for-ghci
23086 compile library for use with GHCi
23087 --enable-split-sections
23089 --disable-split-sections
23090 compile library code such that unneeded definitions can
23091 be dropped from the final executable (GHC 7.8+)
23092 --enable-split-objs
23094 --disable-split-objs
23095 split library into smaller objects to reduce binary sizes
23096 (GHC 6.6+)
23097 --enable-executable-stripping
23099 --disable-executable-stripping
23100 strip executables upon installation to reduce binary
23101 sizes
23102 --enable-library-stripping
23104 --disable-library-stripping
23105 strip libraries upon installation to reduce binary sizes
23106 --configure-option OPT
23108 Extra option for configure
23109 --user
23111 --global
23112 doing a per-user installation
23113 --package-db DB
23115 Append the given package database to the list of package
23116 databases used (to satisfy dependencies and register
23117 into). May be a specific file, 'global' or 'user'. The
23118 initial list is ['global'], ['global', 'user'], or
23119 ['global', $sandbox], depending on context. Use 'clear'
23120 to reset the list to empty. See the user guide for de‐
23121 tails.
23122 -f, --flags FLAGS
23124 Force values for the given flags in Cabal conditionals in
23125 the .cabal file. E.g., --flags="debug -usebytestrings"
23126 forces the flag "debug" to true and "usebytestrings" to
23127 false.
23128 --extra-include-dirs PATH
23130 A list of directories to search for header files
23131 --enable-deterministic
23133 --disable-deterministic
23134 Try to be as deterministic as possible (used by the test
23135 suite)
23136 --ipid IPID
23138 Installed package ID to compile this package as
23139 --cid CID
23141 Installed component ID to compile this component as
23142 --extra-lib-dirs PATH
23144 A list of directories to search for external libraries
23145 --extra-framework-dirs PATH
23147 A list of directories to search for external frameworks
23148 (OS X only)
23149 --extra-prog-path PATH
23151 A list of directories to search for required programs (in
23152 addition to the normal search locations)
23153 --instantiate-with NAME=MOD
23155 A mapping of signature names to concrete module instanti‐
23156 ations.
23157 --enable-tests
23159 --disable-tests
23160 dependency checking and compilation for test suites
23161 listed in the package description file.
23162 --enable-coverage
23164 --disable-coverage
23165 build package with Haskell Program Coverage. (GHC only)
23166 --enable-library-coverage
23168 --disable-library-coverage
23169 build package with Haskell Program Coverage. (GHC only)
23170 (DEPRECATED)
23171 --enable-benchmarks
23173 --disable-benchmarks
23174 dependency checking and compilation for benchmarks listed
23175 in the package description file.
23176 --enable-relocatable
23178 --disable-relocatable
23179 building a package that is relocatable. (GHC only)
23180 --disable-response-files
23182 enable workaround for old versions of programs like "ar"
23183 that do not support @file arguments
23184 --allow-depending-on-private-libs
23186 Allow depending on private libraries. If set, the library
23187 visibility check MUST be done externally.
23188 --with-alex PATH
23190 give the path to alex
23191 --with-ar PATH
23193 give the path to ar
23194 --with-c2hs PATH
23196 give the path to c2hs
23197 --with-cpphs PATH
23199 give the path to cpphs
23200 --with-doctest PATH
23202 give the path to doctest
23203 --with-gcc PATH
23205 give the path to gcc
23206 --with-ghc PATH
23208 give the path to ghc
23209 --with-ghc-pkg PATH
23211 give the path to ghc-pkg
23212 --with-ghcjs PATH
23214 give the path to ghcjs
23215 --with-ghcjs-pkg PATH
23217 give the path to ghcjs-pkg
23218 --with-greencard PATH
23220 give the path to greencard
23221 --with-haddock PATH
23223 give the path to haddock
23224 --with-happy PATH
23226 give the path to happy
23227 --with-haskell-suite PATH
23229 give the path to haskell-suite
23230 --with-haskell-suite-pkg PATH
23232 give the path to haskell-suite-pkg
23233 --with-hmake PATH
23235 give the path to hmake
23236 --with-hpc PATH
23238 give the path to hpc
23239 --with-hsc2hs PATH
23241 give the path to hsc2hs
23242 --with-hscolour PATH
23244 give the path to hscolour
23245 --with-jhc PATH
23247 give the path to jhc
23248 --with-ld PATH
23250 give the path to ld
23251 --with-pkg-config PATH
23253 give the path to pkg-config
23254 --with-runghc PATH
23256 give the path to runghc
23257 --with-strip PATH
23259 give the path to strip
23260 --with-tar PATH
23262 give the path to tar
23263 --with-uhc PATH
23265 give the path to uhc
23266 --alex-option OPT
23268 give an extra option to alex (no need to quote options
23269 containing spaces)
23270 --ar-option OPT
23272 give an extra option to ar (no need to quote options con‐
23273 taining spaces)
23274 --c2hs-option OPT
23276 give an extra option to c2hs (no need to quote options
23277 containing spaces)
23278 --cpphs-option OPT
23280 give an extra option to cpphs (no need to quote options
23281 containing spaces)
23282 --doctest-option OPT
23284 give an extra option to doctest (no need to quote options
23285 containing spaces)
23286 --gcc-option OPT
23288 give an extra option to gcc (no need to quote options
23289 containing spaces)
23290 --ghc-option OPT
23292 give an extra option to ghc (no need to quote options
23293 containing spaces)
23294 --ghc-pkg-option OPT
23296 give an extra option to ghc-pkg (no need to quote options
23297 containing spaces)
23298 --ghcjs-option OPT
23300 give an extra option to ghcjs (no need to quote options
23301 containing spaces)
23302 --ghcjs-pkg-option OPT
23304 give an extra option to ghcjs-pkg (no need to quote op‐
23305 tions containing spaces)
23306 --greencard-option OPT
23308 give an extra option to greencard (no need to quote op‐
23309 tions containing spaces)
23310 --haddock-option OPT
23312 give an extra option to haddock (no need to quote options
23313 containing spaces)
23314 --happy-option OPT
23316 give an extra option to happy (no need to quote options
23317 containing spaces)
23318 --haskell-suite-option OPT
23320 give an extra option to haskell-suite (no need to quote
23321 options containing spaces)
23322 --haskell-suite-pkg-option OPT
23324 give an extra option to haskell-suite-pkg (no need to
23325 quote options containing spaces)
23326 --hmake-option OPT
23328 give an extra option to hmake (no need to quote options
23329 containing spaces)
23330 --hpc-option OPT
23332 give an extra option to hpc (no need to quote options
23333 containing spaces)
23334 --hsc2hs-option OPT
23336 give an extra option to hsc2hs (no need to quote options
23337 containing spaces)
23338 --hscolour-option OPT
23340 give an extra option to hscolour (no need to quote op‐
23341 tions containing spaces)
23342 --jhc-option OPT
23344 give an extra option to jhc (no need to quote options
23345 containing spaces)
23346 --ld-option OPT
23348 give an extra option to ld (no need to quote options con‐
23349 taining spaces)
23350 --pkg-config-option OPT
23352 give an extra option to pkg-config (no need to quote op‐
23353 tions containing spaces)
23354 --runghc-option OPT
23356 give an extra option to runghc (no need to quote options
23357 containing spaces)
23358 --strip-option OPT
23360 give an extra option to strip (no need to quote options
23361 containing spaces)
23362 --tar-option OPT
23364 give an extra option to tar (no need to quote options
23365 containing spaces)
23366 --uhc-option OPT
23368 give an extra option to uhc (no need to quote options
23369 containing spaces)
23370 --alex-options OPTS
23372 give extra options to alex
23373 --ar-options OPTS
23375 give extra options to ar
23376 --c2hs-options OPTS
23378 give extra options to c2hs
23379 --cpphs-options OPTS
23381 give extra options to cpphs
23382 --doctest-options OPTS
23384 give extra options to doctest
23385 --gcc-options OPTS
23387 give extra options to gcc
23388 --ghc-options OPTS
23390 give extra options to ghc
23391 --ghc-pkg-options OPTS
23393 give extra options to ghc-pkg
23394 --ghcjs-options OPTS
23396 give extra options to ghcjs
23397 --ghcjs-pkg-options OPTS
23399 give extra options to ghcjs-pkg
23400 --greencard-options OPTS
23402 give extra options to greencard
23403 --haddock-options OPTS
23405 give extra options to haddock
23406 --happy-options OPTS
23408 give extra options to happy
23409 --haskell-suite-options OPTS
23411 give extra options to haskell-suite
23412 --haskell-suite-pkg-options OPTS
23414 give extra options to haskell-suite-pkg
23415 --hmake-options OPTS
23417 give extra options to hmake
23418 --hpc-options OPTS
23420 give extra options to hpc
23421 --hsc2hs-options OPTS
23423 give extra options to hsc2hs
23424 --hscolour-options OPTS
23426 give extra options to hscolour
23427 --jhc-options OPTS
23429 give extra options to jhc
23430 --ld-options OPTS
23432 give extra options to ld
23433 --pkg-config-options OPTS
23435 give extra options to pkg-config
23436 --runghc-options OPTS
23438 give extra options to runghc
23439 --strip-options OPTS
23441 give extra options to strip
23442 --tar-options OPTS
23444 give extra options to tar
23445 --uhc-options OPTS
23447 give extra options to uhc
23448 --cabal-lib-version VERSION
23450 Select which version of the Cabal lib to use to build
23451 packages (useful for testing).
23452 --constraint CONSTRAINT
23454 Specify constraints on a package (version, in‐
23455 stalled/source, flags)
23456 --preference CONSTRAINT
23458 Specify preferences (soft constraints) on the version of
23459 a package
23460 --solver SOLVER
23462 Select dependency solver to use (default: modular).
23463 Choices: modular.
23464 --allow-older [DEPS]
23466 Ignore lower bounds in all dependencies or DEPS
23467 --allow-newer [DEPS]
23469 Ignore upper bounds in all dependencies or DEPS
23470 --write-ghc-environment-files always|never|ghc8.4.4+
23472 Whether to create a .ghc.environment file after a suc‐
23473 cessful build (v2-build only)
23474 --enable-documentation
23476 --disable-documentation
23477 building of documentation
23478 --doc-index-file TEMPLATE
23480 A central index of haddock API documentation (template
23481 cannot use $pkgid)
23482 --dry-run
23484 Do not install anything, only print what would be in‐
23485 stalled.
23486 --max-backjumps NUM
23488 Maximum number of backjumps allowed while solving (de‐
23489 fault: 4000). Use a negative number to enable unlimited
23490 backtracking. Use 0 to disable backtracking completely.
23491 --reorder-goals
23493 --no-reorder-goals
23494 Try to reorder goals according to certain heuristics.
23495 Slows things down on average, but may make backtracking
23496 faster for some packages.
23497 --count-conflicts
23499 --no-count-conflicts
23500 Try to speed up solving by preferring goals that are in‐
23501 volved in a lot of conflicts (default).
23502 --fine-grained-conflicts
23504 --no-fine-grained-conflicts
23505 Skip a version of a package if it does not resolve the
23506 conflicts encountered in the last version, as a solver
23507 optimization (default).
23508 --minimize-conflict-set
23510 --no-minimize-conflict-set
23511 When there is no solution, try to improve the error mes‐
23512 sage by finding a minimal conflict set (default: false).
23513 May increase run time significantly.
23514 --independent-goals
23516 --no-independent-goals
23517 Treat several goals on the command line as independent.
23518 If several goals depend on the same package, different
23519 versions can be chosen.
23520 --shadow-installed-packages
23522 --no-shadow-installed-packages
23523 If multiple package instances of the same version are in‐
23524 stalled, treat all but one as shadowed.
23525 --strong-flags
23527 --no-strong-flags
23528 Do not defer flag choices (this used to be the default in
23529 cabal-install <= 1.20).
23530 --allow-boot-library-installs
23532 --no-allow-boot-library-installs
23533 Allow cabal to install base, ghc-prim, integer-simple,
23534 integer-gmp, and template-haskell.
23535 --reject-unconstrained-dependencies none|all
23537 Require these packages to have constraints on them if
23538 they are to be selected (default: none).
23539 --reinstall
23541 --no-reinstall
23542 Install even if it means installing the same version
23543 again.
23544 --avoid-reinstalls
23546 --no-avoid-reinstalls
23547 Do not select versions that would destructively overwrite
23548 installed packages.
23549 --force-reinstalls
23551 --no-force-reinstalls
23552 Reinstall packages even if they will most likely break
23553 other installed packages.
23554 --upgrade-dependencies
23556 --no-upgrade-dependencies
23557 Pick the latest version for all dependencies, rather than
23558 trying to pick an installed version.
23559 --only-dependencies
23561 --no-only-dependencies
23562 Install only the dependencies necessary to build the
23563 given packages
23564 --dependencies-only
23566 --no-dependencies-only
23567 A synonym for --only-dependencies
23568 --index-state STATE
23570 Use source package index state as it existed at a previ‐
23571 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
23572 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
23573 'HEAD' (default: 'HEAD').
23574 --root-cmd COMMAND
23576 (No longer supported, do not use.)
23577 --symlink-bindir DIR
23579 Add symlinks to installed executables into this direc‐
23580 tory.
23581 --build-summary TEMPLATE
23583 Save build summaries to file (name template can use
23584 $pkgid, $compiler, $os, $arch)
23585 --build-log TEMPLATE
23587 Log all builds to file (name template can use $pkgid,
23588 $compiler, $os, $arch)
23589 --remote-build-reporting LEVEL
23591 Generate build reports to send to a remote server (none,
23592 anonymous or detailed).
23593 --report-planning-failure
23595 Generate build reports when the dependency solver fails.
23596 This is used by the Hackage build bot.
23597 --enable-per-component
23599 --disable-per-component
23600 Per-component builds when possible
23601 --one-shot
23603 --no-one-shot
23604 Do not record the packages in the world file.
23605 --run-tests
23607 Run package test suites during installation.
23608 -j, --jobs [NUM]
23610 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
23611 given).
23612 --keep-going
23614 After a build failure, continue to build other unaffected
23615 packages.
23616 --offline
23618 --no-offline
23619 Don't download packages from the Internet.
23620 --project-file FILE
23622 Set the name of the cabal.project file to search for in
23623 parent directories
23624 --only
23626 Only installs the package in the current directory.
23627 --haddock-hoogle
23629 Generate a hoogle database
23630 --haddock-html
23632 Generate HTML documentation (the default)
23633 --haddock-html-location URL
23635 Location of HTML documentation for pre-requisite packages
23636 --haddock-for-hackage
23638 Collection of flags to generate documentation suitable
23639 for upload to hackage
23640 --haddock-executables
23642 Run haddock for Executables targets
23643 --haddock-tests
23645 Run haddock for Test Suite targets
23646 --haddock-benchmarks
23648 Run haddock for Benchmark targets
23649 --haddock-all
23651 Run haddock for all targets
23652 --haddock-internal
23654 Run haddock for internal modules and include all symbols
23655 --haddock-css PATH
23657 Use PATH as the haddock stylesheet
23658 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
23660 dock-hyperlinked-source
23661 Hyperlink the documentation to the source code
23662 --haddock-quickjump
23664 Generate an index for interactive documentation naviga‐
23665 tion
23666 --haddock-hscolour-css PATH
23668 Use PATH as the HsColour stylesheet
23669 --haddock-contents-location URL
23671 Bake URL in as the location for the contents page
23672 --test-log TEMPLATE
23674 Log all test suite results to file (name template can use
23675 $pkgid, $compiler, $os, $arch, $test-suite, $result)
23676 --test-machine-log TEMPLATE
23678 Produce a machine-readable log file (name template can
23679 use $pkgid, $compiler, $os, $arch, $result)
23680 --test-show-details FILTER
23682 --test-keep-tix-files
23684 keep .tix files for HPC between test runs
23685 --test-wrapper FILE
23687 Run test through a wrapper.
23688 --test-fail-when-no-test-suites
23690 Exit with failure when no test suites are found.
23691 --test-options TEMPLATES
23693 give extra options to test executables (name templates
23694 can use $pkgid, $compiler, $os, $arch, $test-suite)
23695 --test-option TEMPLATE
23697 give extra option to test executables (no need to quote
23698 options containing spaces, name template can use $pkgid,
23699 $compiler, $os, $arch, $test-suite)
23700 --benchmark-options TEMPLATES
23702 give extra options to benchmark executables (name tem‐
23703 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
23704 --benchmark-option TEMPLATE
23706 give extra option to benchmark executables (no need to
23707 quote options containing spaces, name template can use
23708 $pkgid, $compiler, $os, $arch, $benchmark)
23709 cabal v2-bench
23712 Usage: cabal v2-bench [TARGETS] [FLAGS]
23714 Runs the specified benchmarks, first ensuring they are up to date.
23717 Any benchmark in any package in the project can be specified. A package
23719 can be specified in which case all the benchmarks in the package are
23720 run. The default is to run all the benchmarks in the package in the
23721 current directory.
23722 Dependencies are built or rebuilt as necessary. Additional configura‐
23724 tion flags can be specified on the command line and these extend the
23725 project configuration from the 'cabal.project', 'cabal.project.local'
23726 and other files.
23727 Examples:
23730 cabal v2-bench
23731 Run all the benchmarks in the package in the current directory
23732 cabal v2-bench pkgname
23733 Run all the benchmarks in the package named pkgname
23734 cabal v2-bench cname
23735 Run the benchmark named cname
23736 cabal v2-bench cname -O2
23737 Run the benchmark built with '-O2' (including local libs used)
23738 Note: this command is part of the new project-based system (aka nix-
23740 style local builds). These features are currently in beta. Please see
23741 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
23742 details and advice on what you can expect to work. If you encounter
23743 problems please file issues at https://github.com/haskell/cabal/issues
23744 and if you have any time to get involved and help with testing, fixing
23745 bugs etc then that is very much appreciated.
23746 Flags:
23749 -v, --verbose [n]
23750 Control verbosity (n is 0--3, default verbosity level is
23751 1)
23752 --builddir, --distdir, --distpref DIR
23754 The directory where Cabal puts generated build files (de‐
23755 fault dist)
23756 -g, --ghc
23758 compile with GHC
23759 --ghcjs
23761 compile with GHCJS
23762 --uhc
23764 compile with UHC
23765 --haskell-suite
23767 compile with a haskell-suite compiler
23768 --cabal-file PATH
23770 use this Cabal file
23771 -w, --with-compiler PATH
23773 give the path to a particular compiler
23774 --with-hc-pkg PATH
23776 give the path to the package tool
23777 --prefix DIR
23779 bake this prefix in preparation of installation
23780 --bindir DIR
23782 installation directory for executables
23783 --libdir DIR
23785 installation directory for libraries
23786 --libsubdir DIR
23788 subdirectory of libdir in which libs are installed
23789 --dynlibdir DIR
23791 installation directory for dynamic libraries
23792 --libexecdir DIR
23794 installation directory for program executables
23795 --libexecsubdir DIR
23797 subdirectory of libexecdir in which private executables
23798 are installed
23799 --datadir DIR
23801 installation directory for read-only data
23802 --datasubdir DIR
23804 subdirectory of datadir in which data files are installed
23805 --docdir DIR
23807 installation directory for documentation
23808 --htmldir DIR
23810 installation directory for HTML documentation
23811 --haddockdir DIR
23813 installation directory for haddock interfaces
23814 --sysconfdir DIR
23816 installation directory for configuration files
23817 --program-prefix PREFIX
23819 prefix to be applied to installed executables
23820 --program-suffix SUFFIX
23822 suffix to be applied to installed executables
23823 --enable-library-vanilla
23825 --disable-library-vanilla
23826 Vanilla libraries
23827 -p, --enable-library-profiling
23829 --disable-library-profiling
23830 Library profiling
23831 --enable-shared
23833 --disable-shared
23834 Shared library
23835 --enable-static
23837 --disable-static
23838 Static library
23839 --enable-executable-dynamic
23841 --disable-executable-dynamic
23842 Executable dynamic linking
23843 --enable-executable-static
23845 --disable-executable-static
23846 Executable fully static linking
23847 --enable-profiling
23849 --disable-profiling
23850 Executable and library profiling
23851 --enable-executable-profiling
23853 --disable-executable-profiling
23854 Executable profiling (DEPRECATED)
23855 --profiling-detail level
23857 Profiling detail level for executable and library (de‐
23858 fault, none, exported-functions, toplevel-functions,
23859 all-functions).
23860 --library-profiling-detail level
23862 Profiling detail level for libraries only.
23863 -O, --enable-optimization, --enable-optimisation [n]
23865 Build with optimization (n is 0--2, default is 1)
23866 --disable-optimization, --disable-optimisation
23868 Build without optimization
23869 --enable-debug-info [n]
23871 Emit debug info (n is 0--3, default is 0)
23872 --disable-debug-info
23874 Don't emit debug info
23875 --enable-library-for-ghci
23877 --disable-library-for-ghci
23878 compile library for use with GHCi
23879 --enable-split-sections
23881 --disable-split-sections
23882 compile library code such that unneeded definitions can
23883 be dropped from the final executable (GHC 7.8+)
23884 --enable-split-objs
23886 --disable-split-objs
23887 split library into smaller objects to reduce binary sizes
23888 (GHC 6.6+)
23889 --enable-executable-stripping
23891 --disable-executable-stripping
23892 strip executables upon installation to reduce binary
23893 sizes
23894 --enable-library-stripping
23896 --disable-library-stripping
23897 strip libraries upon installation to reduce binary sizes
23898 --configure-option OPT
23900 Extra option for configure
23901 --user
23903 --global
23904 doing a per-user installation
23905 --package-db DB
23907 Append the given package database to the list of package
23908 databases used (to satisfy dependencies and register
23909 into). May be a specific file, 'global' or 'user'. The
23910 initial list is ['global'], ['global', 'user'], or
23911 ['global', $sandbox], depending on context. Use 'clear'
23912 to reset the list to empty. See the user guide for de‐
23913 tails.
23914 -f, --flags FLAGS
23916 Force values for the given flags in Cabal conditionals in
23917 the .cabal file. E.g., --flags="debug -usebytestrings"
23918 forces the flag "debug" to true and "usebytestrings" to
23919 false.
23920 --extra-include-dirs PATH
23922 A list of directories to search for header files
23923 --enable-deterministic
23925 --disable-deterministic
23926 Try to be as deterministic as possible (used by the test
23927 suite)
23928 --ipid IPID
23930 Installed package ID to compile this package as
23931 --cid CID
23933 Installed component ID to compile this component as
23934 --extra-lib-dirs PATH
23936 A list of directories to search for external libraries
23937 --extra-framework-dirs PATH
23939 A list of directories to search for external frameworks
23940 (OS X only)
23941 --extra-prog-path PATH
23943 A list of directories to search for required programs (in
23944 addition to the normal search locations)
23945 --instantiate-with NAME=MOD
23947 A mapping of signature names to concrete module instanti‐
23948 ations.
23949 --enable-tests
23951 --disable-tests
23952 dependency checking and compilation for test suites
23953 listed in the package description file.
23954 --enable-coverage
23956 --disable-coverage
23957 build package with Haskell Program Coverage. (GHC only)
23958 --enable-library-coverage
23960 --disable-library-coverage
23961 build package with Haskell Program Coverage. (GHC only)
23962 (DEPRECATED)
23963 --enable-benchmarks
23965 --disable-benchmarks
23966 dependency checking and compilation for benchmarks listed
23967 in the package description file.
23968 --enable-relocatable
23970 --disable-relocatable
23971 building a package that is relocatable. (GHC only)
23972 --disable-response-files
23974 enable workaround for old versions of programs like "ar"
23975 that do not support @file arguments
23976 --allow-depending-on-private-libs
23978 Allow depending on private libraries. If set, the library
23979 visibility check MUST be done externally.
23980 --with-alex PATH
23982 give the path to alex
23983 --with-ar PATH
23985 give the path to ar
23986 --with-c2hs PATH
23988 give the path to c2hs
23989 --with-cpphs PATH
23991 give the path to cpphs
23992 --with-doctest PATH
23994 give the path to doctest
23995 --with-gcc PATH
23997 give the path to gcc
23998 --with-ghc PATH
24000 give the path to ghc
24001 --with-ghc-pkg PATH
24003 give the path to ghc-pkg
24004 --with-ghcjs PATH
24006 give the path to ghcjs
24007 --with-ghcjs-pkg PATH
24009 give the path to ghcjs-pkg
24010 --with-greencard PATH
24012 give the path to greencard
24013 --with-haddock PATH
24015 give the path to haddock
24016 --with-happy PATH
24018 give the path to happy
24019 --with-haskell-suite PATH
24021 give the path to haskell-suite
24022 --with-haskell-suite-pkg PATH
24024 give the path to haskell-suite-pkg
24025 --with-hmake PATH
24027 give the path to hmake
24028 --with-hpc PATH
24030 give the path to hpc
24031 --with-hsc2hs PATH
24033 give the path to hsc2hs
24034 --with-hscolour PATH
24036 give the path to hscolour
24037 --with-jhc PATH
24039 give the path to jhc
24040 --with-ld PATH
24042 give the path to ld
24043 --with-pkg-config PATH
24045 give the path to pkg-config
24046 --with-runghc PATH
24048 give the path to runghc
24049 --with-strip PATH
24051 give the path to strip
24052 --with-tar PATH
24054 give the path to tar
24055 --with-uhc PATH
24057 give the path to uhc
24058 --alex-option OPT
24060 give an extra option to alex (no need to quote options
24061 containing spaces)
24062 --ar-option OPT
24064 give an extra option to ar (no need to quote options con‐
24065 taining spaces)
24066 --c2hs-option OPT
24068 give an extra option to c2hs (no need to quote options
24069 containing spaces)
24070 --cpphs-option OPT
24072 give an extra option to cpphs (no need to quote options
24073 containing spaces)
24074 --doctest-option OPT
24076 give an extra option to doctest (no need to quote options
24077 containing spaces)
24078 --gcc-option OPT
24080 give an extra option to gcc (no need to quote options
24081 containing spaces)
24082 --ghc-option OPT
24084 give an extra option to ghc (no need to quote options
24085 containing spaces)
24086 --ghc-pkg-option OPT
24088 give an extra option to ghc-pkg (no need to quote options
24089 containing spaces)
24090 --ghcjs-option OPT
24092 give an extra option to ghcjs (no need to quote options
24093 containing spaces)
24094 --ghcjs-pkg-option OPT
24096 give an extra option to ghcjs-pkg (no need to quote op‐
24097 tions containing spaces)
24098 --greencard-option OPT
24100 give an extra option to greencard (no need to quote op‐
24101 tions containing spaces)
24102 --haddock-option OPT
24104 give an extra option to haddock (no need to quote options
24105 containing spaces)
24106 --happy-option OPT
24108 give an extra option to happy (no need to quote options
24109 containing spaces)
24110 --haskell-suite-option OPT
24112 give an extra option to haskell-suite (no need to quote
24113 options containing spaces)
24114 --haskell-suite-pkg-option OPT
24116 give an extra option to haskell-suite-pkg (no need to
24117 quote options containing spaces)
24118 --hmake-option OPT
24120 give an extra option to hmake (no need to quote options
24121 containing spaces)
24122 --hpc-option OPT
24124 give an extra option to hpc (no need to quote options
24125 containing spaces)
24126 --hsc2hs-option OPT
24128 give an extra option to hsc2hs (no need to quote options
24129 containing spaces)
24130 --hscolour-option OPT
24132 give an extra option to hscolour (no need to quote op‐
24133 tions containing spaces)
24134 --jhc-option OPT
24136 give an extra option to jhc (no need to quote options
24137 containing spaces)
24138 --ld-option OPT
24140 give an extra option to ld (no need to quote options con‐
24141 taining spaces)
24142 --pkg-config-option OPT
24144 give an extra option to pkg-config (no need to quote op‐
24145 tions containing spaces)
24146 --runghc-option OPT
24148 give an extra option to runghc (no need to quote options
24149 containing spaces)
24150 --strip-option OPT
24152 give an extra option to strip (no need to quote options
24153 containing spaces)
24154 --tar-option OPT
24156 give an extra option to tar (no need to quote options
24157 containing spaces)
24158 --uhc-option OPT
24160 give an extra option to uhc (no need to quote options
24161 containing spaces)
24162 --alex-options OPTS
24164 give extra options to alex
24165 --ar-options OPTS
24167 give extra options to ar
24168 --c2hs-options OPTS
24170 give extra options to c2hs
24171 --cpphs-options OPTS
24173 give extra options to cpphs
24174 --doctest-options OPTS
24176 give extra options to doctest
24177 --gcc-options OPTS
24179 give extra options to gcc
24180 --ghc-options OPTS
24182 give extra options to ghc
24183 --ghc-pkg-options OPTS
24185 give extra options to ghc-pkg
24186 --ghcjs-options OPTS
24188 give extra options to ghcjs
24189 --ghcjs-pkg-options OPTS
24191 give extra options to ghcjs-pkg
24192 --greencard-options OPTS
24194 give extra options to greencard
24195 --haddock-options OPTS
24197 give extra options to haddock
24198 --happy-options OPTS
24200 give extra options to happy
24201 --haskell-suite-options OPTS
24203 give extra options to haskell-suite
24204 --haskell-suite-pkg-options OPTS
24206 give extra options to haskell-suite-pkg
24207 --hmake-options OPTS
24209 give extra options to hmake
24210 --hpc-options OPTS
24212 give extra options to hpc
24213 --hsc2hs-options OPTS
24215 give extra options to hsc2hs
24216 --hscolour-options OPTS
24218 give extra options to hscolour
24219 --jhc-options OPTS
24221 give extra options to jhc
24222 --ld-options OPTS
24224 give extra options to ld
24225 --pkg-config-options OPTS
24227 give extra options to pkg-config
24228 --runghc-options OPTS
24230 give extra options to runghc
24231 --strip-options OPTS
24233 give extra options to strip
24234 --tar-options OPTS
24236 give extra options to tar
24237 --uhc-options OPTS
24239 give extra options to uhc
24240 --cabal-lib-version VERSION
24242 Select which version of the Cabal lib to use to build
24243 packages (useful for testing).
24244 --constraint CONSTRAINT
24246 Specify constraints on a package (version, in‐
24247 stalled/source, flags)
24248 --preference CONSTRAINT
24250 Specify preferences (soft constraints) on the version of
24251 a package
24252 --solver SOLVER
24254 Select dependency solver to use (default: modular).
24255 Choices: modular.
24256 --allow-older [DEPS]
24258 Ignore lower bounds in all dependencies or DEPS
24259 --allow-newer [DEPS]
24261 Ignore upper bounds in all dependencies or DEPS
24262 --write-ghc-environment-files always|never|ghc8.4.4+
24264 Whether to create a .ghc.environment file after a suc‐
24265 cessful build (v2-build only)
24266 --enable-documentation
24268 --disable-documentation
24269 building of documentation
24270 --doc-index-file TEMPLATE
24272 A central index of haddock API documentation (template
24273 cannot use $pkgid)
24274 --dry-run
24276 Do not install anything, only print what would be in‐
24277 stalled.
24278 --max-backjumps NUM
24280 Maximum number of backjumps allowed while solving (de‐
24281 fault: 4000). Use a negative number to enable unlimited
24282 backtracking. Use 0 to disable backtracking completely.
24283 --reorder-goals
24285 --no-reorder-goals
24286 Try to reorder goals according to certain heuristics.
24287 Slows things down on average, but may make backtracking
24288 faster for some packages.
24289 --count-conflicts
24291 --no-count-conflicts
24292 Try to speed up solving by preferring goals that are in‐
24293 volved in a lot of conflicts (default).
24294 --fine-grained-conflicts
24296 --no-fine-grained-conflicts
24297 Skip a version of a package if it does not resolve the
24298 conflicts encountered in the last version, as a solver
24299 optimization (default).
24300 --minimize-conflict-set
24302 --no-minimize-conflict-set
24303 When there is no solution, try to improve the error mes‐
24304 sage by finding a minimal conflict set (default: false).
24305 May increase run time significantly.
24306 --independent-goals
24308 --no-independent-goals
24309 Treat several goals on the command line as independent.
24310 If several goals depend on the same package, different
24311 versions can be chosen.
24312 --shadow-installed-packages
24314 --no-shadow-installed-packages
24315 If multiple package instances of the same version are in‐
24316 stalled, treat all but one as shadowed.
24317 --strong-flags
24319 --no-strong-flags
24320 Do not defer flag choices (this used to be the default in
24321 cabal-install <= 1.20).
24322 --allow-boot-library-installs
24324 --no-allow-boot-library-installs
24325 Allow cabal to install base, ghc-prim, integer-simple,
24326 integer-gmp, and template-haskell.
24327 --reject-unconstrained-dependencies none|all
24329 Require these packages to have constraints on them if
24330 they are to be selected (default: none).
24331 --reinstall
24333 --no-reinstall
24334 Install even if it means installing the same version
24335 again.
24336 --avoid-reinstalls
24338 --no-avoid-reinstalls
24339 Do not select versions that would destructively overwrite
24340 installed packages.
24341 --force-reinstalls
24343 --no-force-reinstalls
24344 Reinstall packages even if they will most likely break
24345 other installed packages.
24346 --upgrade-dependencies
24348 --no-upgrade-dependencies
24349 Pick the latest version for all dependencies, rather than
24350 trying to pick an installed version.
24351 --only-dependencies
24353 --no-only-dependencies
24354 Install only the dependencies necessary to build the
24355 given packages
24356 --dependencies-only
24358 --no-dependencies-only
24359 A synonym for --only-dependencies
24360 --index-state STATE
24362 Use source package index state as it existed at a previ‐
24363 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
24364 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
24365 'HEAD' (default: 'HEAD').
24366 --root-cmd COMMAND
24368 (No longer supported, do not use.)
24369 --symlink-bindir DIR
24371 Add symlinks to installed executables into this direc‐
24372 tory.
24373 --build-summary TEMPLATE
24375 Save build summaries to file (name template can use
24376 $pkgid, $compiler, $os, $arch)
24377 --build-log TEMPLATE
24379 Log all builds to file (name template can use $pkgid,
24380 $compiler, $os, $arch)
24381 --remote-build-reporting LEVEL
24383 Generate build reports to send to a remote server (none,
24384 anonymous or detailed).
24385 --report-planning-failure
24387 Generate build reports when the dependency solver fails.
24388 This is used by the Hackage build bot.
24389 --enable-per-component
24391 --disable-per-component
24392 Per-component builds when possible
24393 --one-shot
24395 --no-one-shot
24396 Do not record the packages in the world file.
24397 --run-tests
24399 Run package test suites during installation.
24400 -j, --jobs [NUM]
24402 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
24403 given).
24404 --keep-going
24406 After a build failure, continue to build other unaffected
24407 packages.
24408 --offline
24410 --no-offline
24411 Don't download packages from the Internet.
24412 --project-file FILE
24414 Set the name of the cabal.project file to search for in
24415 parent directories
24416 --only
24418 Only installs the package in the current directory.
24419 --haddock-hoogle
24421 Generate a hoogle database
24422 --haddock-html
24424 Generate HTML documentation (the default)
24425 --haddock-html-location URL
24427 Location of HTML documentation for pre-requisite packages
24428 --haddock-for-hackage
24430 Collection of flags to generate documentation suitable
24431 for upload to hackage
24432 --haddock-executables
24434 Run haddock for Executables targets
24435 --haddock-tests
24437 Run haddock for Test Suite targets
24438 --haddock-benchmarks
24440 Run haddock for Benchmark targets
24441 --haddock-all
24443 Run haddock for all targets
24444 --haddock-internal
24446 Run haddock for internal modules and include all symbols
24447 --haddock-css PATH
24449 Use PATH as the haddock stylesheet
24450 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
24452 dock-hyperlinked-source
24453 Hyperlink the documentation to the source code
24454 --haddock-quickjump
24456 Generate an index for interactive documentation naviga‐
24457 tion
24458 --haddock-hscolour-css PATH
24460 Use PATH as the HsColour stylesheet
24461 --haddock-contents-location URL
24463 Bake URL in as the location for the contents page
24464 --test-log TEMPLATE
24466 Log all test suite results to file (name template can use
24467 $pkgid, $compiler, $os, $arch, $test-suite, $result)
24468 --test-machine-log TEMPLATE
24470 Produce a machine-readable log file (name template can
24471 use $pkgid, $compiler, $os, $arch, $result)
24472 --test-show-details FILTER
24474 --test-keep-tix-files
24476 keep .tix files for HPC between test runs
24477 --test-wrapper FILE
24479 Run test through a wrapper.
24480 --test-fail-when-no-test-suites
24482 Exit with failure when no test suites are found.
24483 --test-options TEMPLATES
24485 give extra options to test executables (name templates
24486 can use $pkgid, $compiler, $os, $arch, $test-suite)
24487 --test-option TEMPLATE
24489 give extra option to test executables (no need to quote
24490 options containing spaces, name template can use $pkgid,
24491 $compiler, $os, $arch, $test-suite)
24492 --benchmark-options TEMPLATES
24494 give extra options to benchmark executables (name tem‐
24495 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
24496 --benchmark-option TEMPLATE
24498 give extra option to benchmark executables (no need to
24499 quote options containing spaces, name template can use
24500 $pkgid, $compiler, $os, $arch, $benchmark)
24501 cabal exec
24504 Usage: cabal exec [FLAGS] [--] COMMAND [--] [ARGS]
24506 During development it is often useful to run build tasks and perform
24509 one-off program executions to experiment with the behavior of build
24510 tools. It is convenient to run these tools in the same way cabal itself
24511 would. The `cabal exec` command provides a way to do so.
24512 Compiler tools will be configured to see the same subset of the store
24514 that builds would see. The PATH is modified to make all executables in
24515 the dependency tree available (provided they have been built already).
24516 Commands are also rewritten in the way cabal itself would. For example,
24517 `cabal exec ghc` will consult the configuration to choose an appropri‐
24518 ate version of ghc and to include any ghc-specific flags requested.
24519 During development it is often useful to run build tasks and perform
24522 one-off program executions to experiment with the behavior of build
24523 tools. It is convenient to run these tools in the same way cabal itself
24524 would. The `cabal exec` command provides a way to do so.
24525 Compiler tools will be configured to see the same subset of the store
24527 that builds would see. The PATH is modified to make all executables in
24528 the dependency tree available (provided they have been built already).
24529 Commands are also rewritten in the way cabal itself would. For example,
24530 `cabal exec ghc` will consult the configuration to choose an appropri‐
24531 ate version of ghc and to include any ghc-specific flags requested.
24532 Flags:
24535 -v, --verbose [n]
24536 Control verbosity (n is 0--3, default verbosity level is
24537 1)
24538 --builddir, --distdir, --distpref DIR
24540 The directory where Cabal puts generated build files (de‐
24541 fault dist)
24542 -g, --ghc
24544 compile with GHC
24545 --ghcjs
24547 compile with GHCJS
24548 --uhc
24550 compile with UHC
24551 --haskell-suite
24553 compile with a haskell-suite compiler
24554 --cabal-file PATH
24556 use this Cabal file
24557 -w, --with-compiler PATH
24559 give the path to a particular compiler
24560 --with-hc-pkg PATH
24562 give the path to the package tool
24563 --prefix DIR
24565 bake this prefix in preparation of installation
24566 --bindir DIR
24568 installation directory for executables
24569 --libdir DIR
24571 installation directory for libraries
24572 --libsubdir DIR
24574 subdirectory of libdir in which libs are installed
24575 --dynlibdir DIR
24577 installation directory for dynamic libraries
24578 --libexecdir DIR
24580 installation directory for program executables
24581 --libexecsubdir DIR
24583 subdirectory of libexecdir in which private executables
24584 are installed
24585 --datadir DIR
24587 installation directory for read-only data
24588 --datasubdir DIR
24590 subdirectory of datadir in which data files are installed
24591 --docdir DIR
24593 installation directory for documentation
24594 --htmldir DIR
24596 installation directory for HTML documentation
24597 --haddockdir DIR
24599 installation directory for haddock interfaces
24600 --sysconfdir DIR
24602 installation directory for configuration files
24603 --program-prefix PREFIX
24605 prefix to be applied to installed executables
24606 --program-suffix SUFFIX
24608 suffix to be applied to installed executables
24609 --enable-library-vanilla
24611 --disable-library-vanilla
24612 Vanilla libraries
24613 -p, --enable-library-profiling
24615 --disable-library-profiling
24616 Library profiling
24617 --enable-shared
24619 --disable-shared
24620 Shared library
24621 --enable-static
24623 --disable-static
24624 Static library
24625 --enable-executable-dynamic
24627 --disable-executable-dynamic
24628 Executable dynamic linking
24629 --enable-executable-static
24631 --disable-executable-static
24632 Executable fully static linking
24633 --enable-profiling
24635 --disable-profiling
24636 Executable and library profiling
24637 --enable-executable-profiling
24639 --disable-executable-profiling
24640 Executable profiling (DEPRECATED)
24641 --profiling-detail level
24643 Profiling detail level for executable and library (de‐
24644 fault, none, exported-functions, toplevel-functions,
24645 all-functions).
24646 --library-profiling-detail level
24648 Profiling detail level for libraries only.
24649 -O, --enable-optimization, --enable-optimisation [n]
24651 Build with optimization (n is 0--2, default is 1)
24652 --disable-optimization, --disable-optimisation
24654 Build without optimization
24655 --enable-debug-info [n]
24657 Emit debug info (n is 0--3, default is 0)
24658 --disable-debug-info
24660 Don't emit debug info
24661 --enable-library-for-ghci
24663 --disable-library-for-ghci
24664 compile library for use with GHCi
24665 --enable-split-sections
24667 --disable-split-sections
24668 compile library code such that unneeded definitions can
24669 be dropped from the final executable (GHC 7.8+)
24670 --enable-split-objs
24672 --disable-split-objs
24673 split library into smaller objects to reduce binary sizes
24674 (GHC 6.6+)
24675 --enable-executable-stripping
24677 --disable-executable-stripping
24678 strip executables upon installation to reduce binary
24679 sizes
24680 --enable-library-stripping
24682 --disable-library-stripping
24683 strip libraries upon installation to reduce binary sizes
24684 --configure-option OPT
24686 Extra option for configure
24687 --user
24689 --global
24690 doing a per-user installation
24691 --package-db DB
24693 Append the given package database to the list of package
24694 databases used (to satisfy dependencies and register
24695 into). May be a specific file, 'global' or 'user'. The
24696 initial list is ['global'], ['global', 'user'], or
24697 ['global', $sandbox], depending on context. Use 'clear'
24698 to reset the list to empty. See the user guide for de‐
24699 tails.
24700 -f, --flags FLAGS
24702 Force values for the given flags in Cabal conditionals in
24703 the .cabal file. E.g., --flags="debug -usebytestrings"
24704 forces the flag "debug" to true and "usebytestrings" to
24705 false.
24706 --extra-include-dirs PATH
24708 A list of directories to search for header files
24709 --enable-deterministic
24711 --disable-deterministic
24712 Try to be as deterministic as possible (used by the test
24713 suite)
24714 --ipid IPID
24716 Installed package ID to compile this package as
24717 --cid CID
24719 Installed component ID to compile this component as
24720 --extra-lib-dirs PATH
24722 A list of directories to search for external libraries
24723 --extra-framework-dirs PATH
24725 A list of directories to search for external frameworks
24726 (OS X only)
24727 --extra-prog-path PATH
24729 A list of directories to search for required programs (in
24730 addition to the normal search locations)
24731 --instantiate-with NAME=MOD
24733 A mapping of signature names to concrete module instanti‐
24734 ations.
24735 --enable-tests
24737 --disable-tests
24738 dependency checking and compilation for test suites
24739 listed in the package description file.
24740 --enable-coverage
24742 --disable-coverage
24743 build package with Haskell Program Coverage. (GHC only)
24744 --enable-library-coverage
24746 --disable-library-coverage
24747 build package with Haskell Program Coverage. (GHC only)
24748 (DEPRECATED)
24749 --enable-benchmarks
24751 --disable-benchmarks
24752 dependency checking and compilation for benchmarks listed
24753 in the package description file.
24754 --enable-relocatable
24756 --disable-relocatable
24757 building a package that is relocatable. (GHC only)
24758 --disable-response-files
24760 enable workaround for old versions of programs like "ar"
24761 that do not support @file arguments
24762 --allow-depending-on-private-libs
24764 Allow depending on private libraries. If set, the library
24765 visibility check MUST be done externally.
24766 --with-alex PATH
24768 give the path to alex
24769 --with-ar PATH
24771 give the path to ar
24772 --with-c2hs PATH
24774 give the path to c2hs
24775 --with-cpphs PATH
24777 give the path to cpphs
24778 --with-doctest PATH
24780 give the path to doctest
24781 --with-gcc PATH
24783 give the path to gcc
24784 --with-ghc PATH
24786 give the path to ghc
24787 --with-ghc-pkg PATH
24789 give the path to ghc-pkg
24790 --with-ghcjs PATH
24792 give the path to ghcjs
24793 --with-ghcjs-pkg PATH
24795 give the path to ghcjs-pkg
24796 --with-greencard PATH
24798 give the path to greencard
24799 --with-haddock PATH
24801 give the path to haddock
24802 --with-happy PATH
24804 give the path to happy
24805 --with-haskell-suite PATH
24807 give the path to haskell-suite
24808 --with-haskell-suite-pkg PATH
24810 give the path to haskell-suite-pkg
24811 --with-hmake PATH
24813 give the path to hmake
24814 --with-hpc PATH
24816 give the path to hpc
24817 --with-hsc2hs PATH
24819 give the path to hsc2hs
24820 --with-hscolour PATH
24822 give the path to hscolour
24823 --with-jhc PATH
24825 give the path to jhc
24826 --with-ld PATH
24828 give the path to ld
24829 --with-pkg-config PATH
24831 give the path to pkg-config
24832 --with-runghc PATH
24834 give the path to runghc
24835 --with-strip PATH
24837 give the path to strip
24838 --with-tar PATH
24840 give the path to tar
24841 --with-uhc PATH
24843 give the path to uhc
24844 --alex-option OPT
24846 give an extra option to alex (no need to quote options
24847 containing spaces)
24848 --ar-option OPT
24850 give an extra option to ar (no need to quote options con‐
24851 taining spaces)
24852 --c2hs-option OPT
24854 give an extra option to c2hs (no need to quote options
24855 containing spaces)
24856 --cpphs-option OPT
24858 give an extra option to cpphs (no need to quote options
24859 containing spaces)
24860 --doctest-option OPT
24862 give an extra option to doctest (no need to quote options
24863 containing spaces)
24864 --gcc-option OPT
24866 give an extra option to gcc (no need to quote options
24867 containing spaces)
24868 --ghc-option OPT
24870 give an extra option to ghc (no need to quote options
24871 containing spaces)
24872 --ghc-pkg-option OPT
24874 give an extra option to ghc-pkg (no need to quote options
24875 containing spaces)
24876 --ghcjs-option OPT
24878 give an extra option to ghcjs (no need to quote options
24879 containing spaces)
24880 --ghcjs-pkg-option OPT
24882 give an extra option to ghcjs-pkg (no need to quote op‐
24883 tions containing spaces)
24884 --greencard-option OPT
24886 give an extra option to greencard (no need to quote op‐
24887 tions containing spaces)
24888 --haddock-option OPT
24890 give an extra option to haddock (no need to quote options
24891 containing spaces)
24892 --happy-option OPT
24894 give an extra option to happy (no need to quote options
24895 containing spaces)
24896 --haskell-suite-option OPT
24898 give an extra option to haskell-suite (no need to quote
24899 options containing spaces)
24900 --haskell-suite-pkg-option OPT
24902 give an extra option to haskell-suite-pkg (no need to
24903 quote options containing spaces)
24904 --hmake-option OPT
24906 give an extra option to hmake (no need to quote options
24907 containing spaces)
24908 --hpc-option OPT
24910 give an extra option to hpc (no need to quote options
24911 containing spaces)
24912 --hsc2hs-option OPT
24914 give an extra option to hsc2hs (no need to quote options
24915 containing spaces)
24916 --hscolour-option OPT
24918 give an extra option to hscolour (no need to quote op‐
24919 tions containing spaces)
24920 --jhc-option OPT
24922 give an extra option to jhc (no need to quote options
24923 containing spaces)
24924 --ld-option OPT
24926 give an extra option to ld (no need to quote options con‐
24927 taining spaces)
24928 --pkg-config-option OPT
24930 give an extra option to pkg-config (no need to quote op‐
24931 tions containing spaces)
24932 --runghc-option OPT
24934 give an extra option to runghc (no need to quote options
24935 containing spaces)
24936 --strip-option OPT
24938 give an extra option to strip (no need to quote options
24939 containing spaces)
24940 --tar-option OPT
24942 give an extra option to tar (no need to quote options
24943 containing spaces)
24944 --uhc-option OPT
24946 give an extra option to uhc (no need to quote options
24947 containing spaces)
24948 --alex-options OPTS
24950 give extra options to alex
24951 --ar-options OPTS
24953 give extra options to ar
24954 --c2hs-options OPTS
24956 give extra options to c2hs
24957 --cpphs-options OPTS
24959 give extra options to cpphs
24960 --doctest-options OPTS
24962 give extra options to doctest
24963 --gcc-options OPTS
24965 give extra options to gcc
24966 --ghc-options OPTS
24968 give extra options to ghc
24969 --ghc-pkg-options OPTS
24971 give extra options to ghc-pkg
24972 --ghcjs-options OPTS
24974 give extra options to ghcjs
24975 --ghcjs-pkg-options OPTS
24977 give extra options to ghcjs-pkg
24978 --greencard-options OPTS
24980 give extra options to greencard
24981 --haddock-options OPTS
24983 give extra options to haddock
24984 --happy-options OPTS
24986 give extra options to happy
24987 --haskell-suite-options OPTS
24989 give extra options to haskell-suite
24990 --haskell-suite-pkg-options OPTS
24992 give extra options to haskell-suite-pkg
24993 --hmake-options OPTS
24995 give extra options to hmake
24996 --hpc-options OPTS
24998 give extra options to hpc
24999 --hsc2hs-options OPTS
25001 give extra options to hsc2hs
25002 --hscolour-options OPTS
25004 give extra options to hscolour
25005 --jhc-options OPTS
25007 give extra options to jhc
25008 --ld-options OPTS
25010 give extra options to ld
25011 --pkg-config-options OPTS
25013 give extra options to pkg-config
25014 --runghc-options OPTS
25016 give extra options to runghc
25017 --strip-options OPTS
25019 give extra options to strip
25020 --tar-options OPTS
25022 give extra options to tar
25023 --uhc-options OPTS
25025 give extra options to uhc
25026 --cabal-lib-version VERSION
25028 Select which version of the Cabal lib to use to build
25029 packages (useful for testing).
25030 --constraint CONSTRAINT
25032 Specify constraints on a package (version, in‐
25033 stalled/source, flags)
25034 --preference CONSTRAINT
25036 Specify preferences (soft constraints) on the version of
25037 a package
25038 --solver SOLVER
25040 Select dependency solver to use (default: modular).
25041 Choices: modular.
25042 --allow-older [DEPS]
25044 Ignore lower bounds in all dependencies or DEPS
25045 --allow-newer [DEPS]
25047 Ignore upper bounds in all dependencies or DEPS
25048 --write-ghc-environment-files always|never|ghc8.4.4+
25050 Whether to create a .ghc.environment file after a suc‐
25051 cessful build (v2-build only)
25052 --enable-documentation
25054 --disable-documentation
25055 building of documentation
25056 --doc-index-file TEMPLATE
25058 A central index of haddock API documentation (template
25059 cannot use $pkgid)
25060 --dry-run
25062 Do not install anything, only print what would be in‐
25063 stalled.
25064 --max-backjumps NUM
25066 Maximum number of backjumps allowed while solving (de‐
25067 fault: 4000). Use a negative number to enable unlimited
25068 backtracking. Use 0 to disable backtracking completely.
25069 --reorder-goals
25071 --no-reorder-goals
25072 Try to reorder goals according to certain heuristics.
25073 Slows things down on average, but may make backtracking
25074 faster for some packages.
25075 --count-conflicts
25077 --no-count-conflicts
25078 Try to speed up solving by preferring goals that are in‐
25079 volved in a lot of conflicts (default).
25080 --fine-grained-conflicts
25082 --no-fine-grained-conflicts
25083 Skip a version of a package if it does not resolve the
25084 conflicts encountered in the last version, as a solver
25085 optimization (default).
25086 --minimize-conflict-set
25088 --no-minimize-conflict-set
25089 When there is no solution, try to improve the error mes‐
25090 sage by finding a minimal conflict set (default: false).
25091 May increase run time significantly.
25092 --independent-goals
25094 --no-independent-goals
25095 Treat several goals on the command line as independent.
25096 If several goals depend on the same package, different
25097 versions can be chosen.
25098 --shadow-installed-packages
25100 --no-shadow-installed-packages
25101 If multiple package instances of the same version are in‐
25102 stalled, treat all but one as shadowed.
25103 --strong-flags
25105 --no-strong-flags
25106 Do not defer flag choices (this used to be the default in
25107 cabal-install <= 1.20).
25108 --allow-boot-library-installs
25110 --no-allow-boot-library-installs
25111 Allow cabal to install base, ghc-prim, integer-simple,
25112 integer-gmp, and template-haskell.
25113 --reject-unconstrained-dependencies none|all
25115 Require these packages to have constraints on them if
25116 they are to be selected (default: none).
25117 --reinstall
25119 --no-reinstall
25120 Install even if it means installing the same version
25121 again.
25122 --avoid-reinstalls
25124 --no-avoid-reinstalls
25125 Do not select versions that would destructively overwrite
25126 installed packages.
25127 --force-reinstalls
25129 --no-force-reinstalls
25130 Reinstall packages even if they will most likely break
25131 other installed packages.
25132 --upgrade-dependencies
25134 --no-upgrade-dependencies
25135 Pick the latest version for all dependencies, rather than
25136 trying to pick an installed version.
25137 --only-dependencies
25139 --no-only-dependencies
25140 Install only the dependencies necessary to build the
25141 given packages
25142 --dependencies-only
25144 --no-dependencies-only
25145 A synonym for --only-dependencies
25146 --index-state STATE
25148 Use source package index state as it existed at a previ‐
25149 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
25150 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
25151 'HEAD' (default: 'HEAD').
25152 --root-cmd COMMAND
25154 (No longer supported, do not use.)
25155 --symlink-bindir DIR
25157 Add symlinks to installed executables into this direc‐
25158 tory.
25159 --build-summary TEMPLATE
25161 Save build summaries to file (name template can use
25162 $pkgid, $compiler, $os, $arch)
25163 --build-log TEMPLATE
25165 Log all builds to file (name template can use $pkgid,
25166 $compiler, $os, $arch)
25167 --remote-build-reporting LEVEL
25169 Generate build reports to send to a remote server (none,
25170 anonymous or detailed).
25171 --report-planning-failure
25173 Generate build reports when the dependency solver fails.
25174 This is used by the Hackage build bot.
25175 --enable-per-component
25177 --disable-per-component
25178 Per-component builds when possible
25179 --one-shot
25181 --no-one-shot
25182 Do not record the packages in the world file.
25183 --run-tests
25185 Run package test suites during installation.
25186 -j, --jobs [NUM]
25188 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
25189 given).
25190 --keep-going
25192 After a build failure, continue to build other unaffected
25193 packages.
25194 --offline
25196 --no-offline
25197 Don't download packages from the Internet.
25198 --project-file FILE
25200 Set the name of the cabal.project file to search for in
25201 parent directories
25202 --only
25204 Only installs the package in the current directory.
25205 --haddock-hoogle
25207 Generate a hoogle database
25208 --haddock-html
25210 Generate HTML documentation (the default)
25211 --haddock-html-location URL
25213 Location of HTML documentation for pre-requisite packages
25214 --haddock-for-hackage
25216 Collection of flags to generate documentation suitable
25217 for upload to hackage
25218 --haddock-executables
25220 Run haddock for Executables targets
25221 --haddock-tests
25223 Run haddock for Test Suite targets
25224 --haddock-benchmarks
25226 Run haddock for Benchmark targets
25227 --haddock-all
25229 Run haddock for all targets
25230 --haddock-internal
25232 Run haddock for internal modules and include all symbols
25233 --haddock-css PATH
25235 Use PATH as the haddock stylesheet
25236 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
25238 dock-hyperlinked-source
25239 Hyperlink the documentation to the source code
25240 --haddock-quickjump
25242 Generate an index for interactive documentation naviga‐
25243 tion
25244 --haddock-hscolour-css PATH
25246 Use PATH as the HsColour stylesheet
25247 --haddock-contents-location URL
25249 Bake URL in as the location for the contents page
25250 --test-log TEMPLATE
25252 Log all test suite results to file (name template can use
25253 $pkgid, $compiler, $os, $arch, $test-suite, $result)
25254 --test-machine-log TEMPLATE
25256 Produce a machine-readable log file (name template can
25257 use $pkgid, $compiler, $os, $arch, $result)
25258 --test-show-details FILTER
25260 --test-keep-tix-files
25262 keep .tix files for HPC between test runs
25263 --test-wrapper FILE
25265 Run test through a wrapper.
25266 --test-fail-when-no-test-suites
25268 Exit with failure when no test suites are found.
25269 --test-options TEMPLATES
25271 give extra options to test executables (name templates
25272 can use $pkgid, $compiler, $os, $arch, $test-suite)
25273 --test-option TEMPLATE
25275 give extra option to test executables (no need to quote
25276 options containing spaces, name template can use $pkgid,
25277 $compiler, $os, $arch, $test-suite)
25278 --benchmark-options TEMPLATES
25280 give extra options to benchmark executables (name tem‐
25281 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
25282 --benchmark-option TEMPLATE
25284 give extra option to benchmark executables (no need to
25285 quote options containing spaces, name template can use
25286 $pkgid, $compiler, $os, $arch, $benchmark)
25287 cabal new-exec
25290 Usage: cabal new-exec [FLAGS] [--] COMMAND [--] [ARGS]
25292 During development it is often useful to run build tasks and perform
25295 one-off program executions to experiment with the behavior of build
25296 tools. It is convenient to run these tools in the same way cabal itself
25297 would. The `cabal new-exec` command provides a way to do so.
25298 Compiler tools will be configured to see the same subset of the store
25300 that builds would see. The PATH is modified to make all executables in
25301 the dependency tree available (provided they have been built already).
25302 Commands are also rewritten in the way cabal itself would. For example,
25303 `cabal new-exec ghc` will consult the configuration to choose an appro‐
25304 priate version of ghc and to include any ghc-specific flags requested.
25305 During development it is often useful to run build tasks and perform
25308 one-off program executions to experiment with the behavior of build
25309 tools. It is convenient to run these tools in the same way cabal itself
25310 would. The `cabal new-exec` command provides a way to do so.
25311 Compiler tools will be configured to see the same subset of the store
25313 that builds would see. The PATH is modified to make all executables in
25314 the dependency tree available (provided they have been built already).
25315 Commands are also rewritten in the way cabal itself would. For example,
25316 `cabal new-exec ghc` will consult the configuration to choose an appro‐
25317 priate version of ghc and to include any ghc-specific flags requested.
25318 Flags:
25321 -v, --verbose [n]
25322 Control verbosity (n is 0--3, default verbosity level is
25323 1)
25324 --builddir, --distdir, --distpref DIR
25326 The directory where Cabal puts generated build files (de‐
25327 fault dist)
25328 -g, --ghc
25330 compile with GHC
25331 --ghcjs
25333 compile with GHCJS
25334 --uhc
25336 compile with UHC
25337 --haskell-suite
25339 compile with a haskell-suite compiler
25340 --cabal-file PATH
25342 use this Cabal file
25343 -w, --with-compiler PATH
25345 give the path to a particular compiler
25346 --with-hc-pkg PATH
25348 give the path to the package tool
25349 --prefix DIR
25351 bake this prefix in preparation of installation
25352 --bindir DIR
25354 installation directory for executables
25355 --libdir DIR
25357 installation directory for libraries
25358 --libsubdir DIR
25360 subdirectory of libdir in which libs are installed
25361 --dynlibdir DIR
25363 installation directory for dynamic libraries
25364 --libexecdir DIR
25366 installation directory for program executables
25367 --libexecsubdir DIR
25369 subdirectory of libexecdir in which private executables
25370 are installed
25371 --datadir DIR
25373 installation directory for read-only data
25374 --datasubdir DIR
25376 subdirectory of datadir in which data files are installed
25377 --docdir DIR
25379 installation directory for documentation
25380 --htmldir DIR
25382 installation directory for HTML documentation
25383 --haddockdir DIR
25385 installation directory for haddock interfaces
25386 --sysconfdir DIR
25388 installation directory for configuration files
25389 --program-prefix PREFIX
25391 prefix to be applied to installed executables
25392 --program-suffix SUFFIX
25394 suffix to be applied to installed executables
25395 --enable-library-vanilla
25397 --disable-library-vanilla
25398 Vanilla libraries
25399 -p, --enable-library-profiling
25401 --disable-library-profiling
25402 Library profiling
25403 --enable-shared
25405 --disable-shared
25406 Shared library
25407 --enable-static
25409 --disable-static
25410 Static library
25411 --enable-executable-dynamic
25413 --disable-executable-dynamic
25414 Executable dynamic linking
25415 --enable-executable-static
25417 --disable-executable-static
25418 Executable fully static linking
25419 --enable-profiling
25421 --disable-profiling
25422 Executable and library profiling
25423 --enable-executable-profiling
25425 --disable-executable-profiling
25426 Executable profiling (DEPRECATED)
25427 --profiling-detail level
25429 Profiling detail level for executable and library (de‐
25430 fault, none, exported-functions, toplevel-functions,
25431 all-functions).
25432 --library-profiling-detail level
25434 Profiling detail level for libraries only.
25435 -O, --enable-optimization, --enable-optimisation [n]
25437 Build with optimization (n is 0--2, default is 1)
25438 --disable-optimization, --disable-optimisation
25440 Build without optimization
25441 --enable-debug-info [n]
25443 Emit debug info (n is 0--3, default is 0)
25444 --disable-debug-info
25446 Don't emit debug info
25447 --enable-library-for-ghci
25449 --disable-library-for-ghci
25450 compile library for use with GHCi
25451 --enable-split-sections
25453 --disable-split-sections
25454 compile library code such that unneeded definitions can
25455 be dropped from the final executable (GHC 7.8+)
25456 --enable-split-objs
25458 --disable-split-objs
25459 split library into smaller objects to reduce binary sizes
25460 (GHC 6.6+)
25461 --enable-executable-stripping
25463 --disable-executable-stripping
25464 strip executables upon installation to reduce binary
25465 sizes
25466 --enable-library-stripping
25468 --disable-library-stripping
25469 strip libraries upon installation to reduce binary sizes
25470 --configure-option OPT
25472 Extra option for configure
25473 --user
25475 --global
25476 doing a per-user installation
25477 --package-db DB
25479 Append the given package database to the list of package
25480 databases used (to satisfy dependencies and register
25481 into). May be a specific file, 'global' or 'user'. The
25482 initial list is ['global'], ['global', 'user'], or
25483 ['global', $sandbox], depending on context. Use 'clear'
25484 to reset the list to empty. See the user guide for de‐
25485 tails.
25486 -f, --flags FLAGS
25488 Force values for the given flags in Cabal conditionals in
25489 the .cabal file. E.g., --flags="debug -usebytestrings"
25490 forces the flag "debug" to true and "usebytestrings" to
25491 false.
25492 --extra-include-dirs PATH
25494 A list of directories to search for header files
25495 --enable-deterministic
25497 --disable-deterministic
25498 Try to be as deterministic as possible (used by the test
25499 suite)
25500 --ipid IPID
25502 Installed package ID to compile this package as
25503 --cid CID
25505 Installed component ID to compile this component as
25506 --extra-lib-dirs PATH
25508 A list of directories to search for external libraries
25509 --extra-framework-dirs PATH
25511 A list of directories to search for external frameworks
25512 (OS X only)
25513 --extra-prog-path PATH
25515 A list of directories to search for required programs (in
25516 addition to the normal search locations)
25517 --instantiate-with NAME=MOD
25519 A mapping of signature names to concrete module instanti‐
25520 ations.
25521 --enable-tests
25523 --disable-tests
25524 dependency checking and compilation for test suites
25525 listed in the package description file.
25526 --enable-coverage
25528 --disable-coverage
25529 build package with Haskell Program Coverage. (GHC only)
25530 --enable-library-coverage
25532 --disable-library-coverage
25533 build package with Haskell Program Coverage. (GHC only)
25534 (DEPRECATED)
25535 --enable-benchmarks
25537 --disable-benchmarks
25538 dependency checking and compilation for benchmarks listed
25539 in the package description file.
25540 --enable-relocatable
25542 --disable-relocatable
25543 building a package that is relocatable. (GHC only)
25544 --disable-response-files
25546 enable workaround for old versions of programs like "ar"
25547 that do not support @file arguments
25548 --allow-depending-on-private-libs
25550 Allow depending on private libraries. If set, the library
25551 visibility check MUST be done externally.
25552 --with-alex PATH
25554 give the path to alex
25555 --with-ar PATH
25557 give the path to ar
25558 --with-c2hs PATH
25560 give the path to c2hs
25561 --with-cpphs PATH
25563 give the path to cpphs
25564 --with-doctest PATH
25566 give the path to doctest
25567 --with-gcc PATH
25569 give the path to gcc
25570 --with-ghc PATH
25572 give the path to ghc
25573 --with-ghc-pkg PATH
25575 give the path to ghc-pkg
25576 --with-ghcjs PATH
25578 give the path to ghcjs
25579 --with-ghcjs-pkg PATH
25581 give the path to ghcjs-pkg
25582 --with-greencard PATH
25584 give the path to greencard
25585 --with-haddock PATH
25587 give the path to haddock
25588 --with-happy PATH
25590 give the path to happy
25591 --with-haskell-suite PATH
25593 give the path to haskell-suite
25594 --with-haskell-suite-pkg PATH
25596 give the path to haskell-suite-pkg
25597 --with-hmake PATH
25599 give the path to hmake
25600 --with-hpc PATH
25602 give the path to hpc
25603 --with-hsc2hs PATH
25605 give the path to hsc2hs
25606 --with-hscolour PATH
25608 give the path to hscolour
25609 --with-jhc PATH
25611 give the path to jhc
25612 --with-ld PATH
25614 give the path to ld
25615 --with-pkg-config PATH
25617 give the path to pkg-config
25618 --with-runghc PATH
25620 give the path to runghc
25621 --with-strip PATH
25623 give the path to strip
25624 --with-tar PATH
25626 give the path to tar
25627 --with-uhc PATH
25629 give the path to uhc
25630 --alex-option OPT
25632 give an extra option to alex (no need to quote options
25633 containing spaces)
25634 --ar-option OPT
25636 give an extra option to ar (no need to quote options con‐
25637 taining spaces)
25638 --c2hs-option OPT
25640 give an extra option to c2hs (no need to quote options
25641 containing spaces)
25642 --cpphs-option OPT
25644 give an extra option to cpphs (no need to quote options
25645 containing spaces)
25646 --doctest-option OPT
25648 give an extra option to doctest (no need to quote options
25649 containing spaces)
25650 --gcc-option OPT
25652 give an extra option to gcc (no need to quote options
25653 containing spaces)
25654 --ghc-option OPT
25656 give an extra option to ghc (no need to quote options
25657 containing spaces)
25658 --ghc-pkg-option OPT
25660 give an extra option to ghc-pkg (no need to quote options
25661 containing spaces)
25662 --ghcjs-option OPT
25664 give an extra option to ghcjs (no need to quote options
25665 containing spaces)
25666 --ghcjs-pkg-option OPT
25668 give an extra option to ghcjs-pkg (no need to quote op‐
25669 tions containing spaces)
25670 --greencard-option OPT
25672 give an extra option to greencard (no need to quote op‐
25673 tions containing spaces)
25674 --haddock-option OPT
25676 give an extra option to haddock (no need to quote options
25677 containing spaces)
25678 --happy-option OPT
25680 give an extra option to happy (no need to quote options
25681 containing spaces)
25682 --haskell-suite-option OPT
25684 give an extra option to haskell-suite (no need to quote
25685 options containing spaces)
25686 --haskell-suite-pkg-option OPT
25688 give an extra option to haskell-suite-pkg (no need to
25689 quote options containing spaces)
25690 --hmake-option OPT
25692 give an extra option to hmake (no need to quote options
25693 containing spaces)
25694 --hpc-option OPT
25696 give an extra option to hpc (no need to quote options
25697 containing spaces)
25698 --hsc2hs-option OPT
25700 give an extra option to hsc2hs (no need to quote options
25701 containing spaces)
25702 --hscolour-option OPT
25704 give an extra option to hscolour (no need to quote op‐
25705 tions containing spaces)
25706 --jhc-option OPT
25708 give an extra option to jhc (no need to quote options
25709 containing spaces)
25710 --ld-option OPT
25712 give an extra option to ld (no need to quote options con‐
25713 taining spaces)
25714 --pkg-config-option OPT
25716 give an extra option to pkg-config (no need to quote op‐
25717 tions containing spaces)
25718 --runghc-option OPT
25720 give an extra option to runghc (no need to quote options
25721 containing spaces)
25722 --strip-option OPT
25724 give an extra option to strip (no need to quote options
25725 containing spaces)
25726 --tar-option OPT
25728 give an extra option to tar (no need to quote options
25729 containing spaces)
25730 --uhc-option OPT
25732 give an extra option to uhc (no need to quote options
25733 containing spaces)
25734 --alex-options OPTS
25736 give extra options to alex
25737 --ar-options OPTS
25739 give extra options to ar
25740 --c2hs-options OPTS
25742 give extra options to c2hs
25743 --cpphs-options OPTS
25745 give extra options to cpphs
25746 --doctest-options OPTS
25748 give extra options to doctest
25749 --gcc-options OPTS
25751 give extra options to gcc
25752 --ghc-options OPTS
25754 give extra options to ghc
25755 --ghc-pkg-options OPTS
25757 give extra options to ghc-pkg
25758 --ghcjs-options OPTS
25760 give extra options to ghcjs
25761 --ghcjs-pkg-options OPTS
25763 give extra options to ghcjs-pkg
25764 --greencard-options OPTS
25766 give extra options to greencard
25767 --haddock-options OPTS
25769 give extra options to haddock
25770 --happy-options OPTS
25772 give extra options to happy
25773 --haskell-suite-options OPTS
25775 give extra options to haskell-suite
25776 --haskell-suite-pkg-options OPTS
25778 give extra options to haskell-suite-pkg
25779 --hmake-options OPTS
25781 give extra options to hmake
25782 --hpc-options OPTS
25784 give extra options to hpc
25785 --hsc2hs-options OPTS
25787 give extra options to hsc2hs
25788 --hscolour-options OPTS
25790 give extra options to hscolour
25791 --jhc-options OPTS
25793 give extra options to jhc
25794 --ld-options OPTS
25796 give extra options to ld
25797 --pkg-config-options OPTS
25799 give extra options to pkg-config
25800 --runghc-options OPTS
25802 give extra options to runghc
25803 --strip-options OPTS
25805 give extra options to strip
25806 --tar-options OPTS
25808 give extra options to tar
25809 --uhc-options OPTS
25811 give extra options to uhc
25812 --cabal-lib-version VERSION
25814 Select which version of the Cabal lib to use to build
25815 packages (useful for testing).
25816 --constraint CONSTRAINT
25818 Specify constraints on a package (version, in‐
25819 stalled/source, flags)
25820 --preference CONSTRAINT
25822 Specify preferences (soft constraints) on the version of
25823 a package
25824 --solver SOLVER
25826 Select dependency solver to use (default: modular).
25827 Choices: modular.
25828 --allow-older [DEPS]
25830 Ignore lower bounds in all dependencies or DEPS
25831 --allow-newer [DEPS]
25833 Ignore upper bounds in all dependencies or DEPS
25834 --write-ghc-environment-files always|never|ghc8.4.4+
25836 Whether to create a .ghc.environment file after a suc‐
25837 cessful build (v2-build only)
25838 --enable-documentation
25840 --disable-documentation
25841 building of documentation
25842 --doc-index-file TEMPLATE
25844 A central index of haddock API documentation (template
25845 cannot use $pkgid)
25846 --dry-run
25848 Do not install anything, only print what would be in‐
25849 stalled.
25850 --max-backjumps NUM
25852 Maximum number of backjumps allowed while solving (de‐
25853 fault: 4000). Use a negative number to enable unlimited
25854 backtracking. Use 0 to disable backtracking completely.
25855 --reorder-goals
25857 --no-reorder-goals
25858 Try to reorder goals according to certain heuristics.
25859 Slows things down on average, but may make backtracking
25860 faster for some packages.
25861 --count-conflicts
25863 CABAL(1)