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 (interactively).
22 cabal user-config - Display and update the user's global cabal configu‐
23 ration.
24 cabal gen-bounds - Generate dependency bounds.
25 cabal outdated - Check for outdated dependencies
26 cabal hscolour - Generate HsColour colourised code, in HTML format.
27 cabal v2-configure - Add extra project configuration
28 cabal new-configure - Add extra project configuration
29 cabal v2-update - Updates list of known packages.
30 cabal new-update - Updates list of known packages.
31 cabal v2-build - Compile targets within the project.
32 cabal new-build - Compile targets within the project.
33 cabal v2-repl - Open an interactive session for the given component.
34 cabal new-repl - Open an interactive session for the given component.
35 cabal v2-freeze - Freeze dependencies.
36 cabal new-freeze - Freeze dependencies.
37 cabal v2-haddock - Build Haddock documentation
38 cabal new-haddock - Build Haddock documentation
39 cabal v2-install - Install packages.
40 cabal new-install - Install packages.
41 cabal v2-run - Run an executable.
42 cabal new-run - Run an executable.
43 cabal v2-test - Run test-suites
44 cabal new-test - Run test-suites
45 cabal v2-bench - Run benchmarks
46 cabal new-bench - Run benchmarks
47 cabal v2-exec - Give a command access to the store.
48 cabal new-exec - Give a command access to the store.
49 cabal v2-clean - Clean the package store and remove temporary files.
50 cabal new-clean - Clean the package store and remove temporary files.
51 cabal v2-sdist - Generate a source distribution file (.tar.gz).
52 cabal new-sdist - Generate a source distribution file (.tar.gz).
53 cabal configure - Prepare to build the package.
54 cabal v1-configure - Prepare to build the package.
55 cabal update - Updates list of known packages.
56 cabal v1-update - Updates list of known packages.
57 cabal build - Compile all/specific components.
58 cabal v1-build - Compile all/specific components.
59 cabal repl - Open an interpreter session for the given component.
60 cabal v1-repl - Open an interpreter session for the given component.
61 cabal freeze - Freeze dependencies.
62 cabal v1-freeze - Freeze dependencies.
63 cabal haddock - Generate Haddock HTML documentation.
64 cabal v1-haddock - Generate Haddock HTML documentation.
65 cabal install - Install packages.
66 cabal v1-install - Install packages.
67 cabal run - Builds and runs an executable.
68 cabal v1-run - Builds and runs an executable.
69 cabal test - Run all/specific tests in the test suite.
70 cabal v1-test - Run all/specific tests in the test suite.
71 cabal bench - Run all/specific benchmarks.
72 cabal v1-bench - Run all/specific benchmarks.
73 cabal exec - Give a command access to the sandbox package repository.
74 cabal v1-exec - Give a command access to the sandbox package reposi‐
75 tory.
76 cabal clean - Clean up after a build.
77 cabal v1-clean - Clean up after a build.
78 cabal sdist - Generate a source distribution file (.tar.gz).
79 cabal v1-sdist - Generate a source distribution file (.tar.gz).
80 cabal doctest - Run doctest tests.
81 cabal v1-doctest - Run doctest tests.
82 cabal copy - Copy the files of all/specific components to install loca‐
83 tions.
84 cabal v1-copy - Copy the files of all/specific components to install
85 locations.
86 cabal register - Register this package with the compiler.
87 cabal v1-register - Register this package with the compiler.
88 cabal reconfigure - Reconfigure the package if necessary.
89 cabal v1-reconfigure - Reconfigure the package if necessary.
90 cabal sandbox - Create/modify/delete a sandbox.
91 cabal v1-sandbox - Create/modify/delete a sandbox.
92
94 Cabal is the standard package system for Haskell software. It helps
95 people to configure, build and install Haskell software and to distrib‐
96 ute it easily to other users and developers.
97 The command line cabal tool (also referred to as cabal-install) helps
99 with installing existing packages and developing new packages. It can
100 be used to work with local packages or to install packages from online
101 package archives, including automatically installing dependencies. By
102 default it is configured to use Hackage, which is Haskell's central
103 package archive that contains thousands of libraries and applications
104 in the Cabal package format.
105
107 Global options:
108 -V, --version
110 Print version information
111 --numeric-version
113 Print just the version number
114 --config-file FILE
116 Set an alternate location for the config file
117 --sandbox-config-file FILE
119 Set an alternate location for the sandbox config file (default:
120 './cabal.sandbox.config')
121 --default-user-config FILE
123 Set a location for a cabal.config file for projects without
124 their own cabal.config freeze file.
125 --require-sandbox
127 --no-require-sandbox
128 requiring the presence of a sandbox for sandbox-aware commands
129 --ignore-sandbox
131 Ignore any existing sandbox
132 --ignore-expiry
134 Ignore expiry dates on signed metadata (use only in exceptional
135 circumstances)
136 --http-transport HttpTransport
138 Set a transport for http(s) requests. Accepts 'curl', 'wget',
139 'powershell', and 'plain-http'. (default: 'curl')
140 --enable-nix
142 --disable-nix
143 Nix integration: run commands through nix-shell if a 'shell.nix'
144 file exists
145 --remote-repo NAME:URL
147 The name and url for a remote repository
148 --remote-repo-cache DIR
150 The location where downloads from all remote repos are cached
151 --local-repo DIR
153 The location of a local repository
154 --logs-dir, --logsdir DIR
156 The location to put log files
157 --world-file FILE
159 The location of the world file
160 --store-dir, --storedir DIR
162 The location of the nix-local-build store
163
166 cabal list
167 Usage: cabal list [FLAGS]
169 or: cabal list [FLAGS] STRINGS
170 List all packages, or all packages matching one of the search strings.
173 If there is a sandbox in the current directory and config:ignore-sand‐
175 box is False, use the sandbox package database. Otherwise, use the
176 package database specified with --package-db. If not specified, use the
177 user package database.
178 Examples:
181 cabal list pandoc
182 Will find pandoc, pandoc-citeproc, pandoc-lens, ...
183 Flags:
186 -v, --verbose [n]
187 Control verbosity (n is 0--3, default verbosity level is
188 1)
189 --installed
191 Only print installed packages
192 --simple-output
194 Print in a easy-to-parse format
195 --package-db DB
197 Append the given package database to the list of package
198 databases used (to satisfy dependencies and register
199 into). May be a specific file, 'global' or 'user'. The
200 initial list is ['global'], ['global', 'user'], or
201 ['global', $sandbox], depending on context. Use 'clear'
202 to reset the list to empty. See the user guide for
203 details.
204 cabal info
207 Usage: cabal info [FLAGS] PACKAGES
209 If there is a sandbox in the current directory and config:ignore-sand‐
212 box is False, use the sandbox package database. Otherwise, use the
213 package database specified with --package-db. If not specified, use the
214 user package database.
215 Flags:
218 -v, --verbose [n]
219 Control verbosity (n is 0--3, default verbosity level is
220 1)
221 --package-db DB
223 Append the given package database to the list of package
224 databases used (to satisfy dependencies and register
225 into). May be a specific file, 'global' or 'user'. The
226 initial list is ['global'], ['global', 'user'], or
227 ['global', $sandbox], depending on context. Use 'clear'
228 to reset the list to empty. See the user guide for
229 details.
230 cabal fetch
233 Usage: cabal fetch [FLAGS] PACKAGES
235 Note that it currently is not possible to fetch the dependencies for a
238 package in the current directory.
239 Flags:
242 -v, --verbose [n]
243 Control verbosity (n is 0--3, default verbosity level is
244 1)
245 --dependencies, --deps
247 Resolve and fetch dependencies (default)
248 --no-dependencies, --no-deps
250 Ignore dependencies
251 --dry-run
253 Do not install anything, only print what would be
254 installed.
255 --enable-tests
257 --disable-tests
258 dependency checking and compilation for test suites
259 listed in the package description file.
260 --enable-benchmarks
262 --disable-benchmarks
263 dependency checking and compilation for benchmarks listed
264 in the package description file.
265 --solver SOLVER
267 Select dependency solver to use (default: modular).
268 Choices: modular.
269 --max-backjumps NUM
271 Maximum number of backjumps allowed while solving
272 (default: 2000). Use a negative number to enable unlim‐
273 ited backtracking. Use 0 to disable backtracking com‐
274 pletely.
275 --reorder-goals
277 --no-reorder-goals
278 Try to reorder goals according to certain heuristics.
279 Slows things down on average, but may make backtracking
280 faster for some packages.
281 --count-conflicts
283 --no-count-conflicts
284 Try to speed up solving by preferring goals that are
285 involved in a lot of conflicts (default).
286 --independent-goals
288 --no-independent-goals
289 Treat several goals on the command line as independent.
290 If several goals depend on the same package, different
291 versions can be chosen.
292 --shadow-installed-packages
294 --no-shadow-installed-packages
295 If multiple package instances of the same version are
296 installed, treat all but one as shadowed.
297 --strong-flags
299 --no-strong-flags
300 Do not defer flag choices (this used to be the default in
301 cabal-install <= 1.20).
302 --allow-boot-library-installs
304 --no-allow-boot-library-installs
305 Allow cabal to install base, ghc-prim, integer-simple,
306 integer-gmp, and template-haskell.
307 cabal get
310 Usage: cabal get [PACKAGES]
312 Creates a local copy of a package's source code. By default it gets the
315 source tarball and unpacks it in a local subdirectory. Alternatively,
316 with -s it will get the code from the source repository specified by
317 the package.
318 Examples:
321 cabal get hlint
322 Download the latest stable version of hlint;
323 cabal get lens --source-repository=head
324 Download the source repository (i.e. git clone from github).
325 Flags:
328 -v, --verbose [n]
329 Control verbosity (n is 0--3, default verbosity level is
330 1)
331 -d, --destdir PATH
333 Where to place the package source, defaults to the cur‐
334 rent directory.
335 -s, --source-repository [[head|this|...]]
337 Copy the package's source repository (ie git clone, darcs
338 get, etc as appropriate).
339 --index-state STATE
341 Use source package index state as it existed at a previ‐
342 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
343 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
344 'HEAD' (default: 'HEAD'). This determines which package
345 versions are available as well as .cabal file revision is
346 selected (unless --pristine is used).
347 --pristine
349 Unpack the original pristine tarball, rather than updat‐
350 ing the .cabal file with the latest revision from the
351 package archive.
352 cabal check
355 Usage: cabal check [FLAGS]
357 Expects a .cabal package file in the current directory.
360 The checks correspond to the requirements to packages on Hackage. If no
362 errors and warnings are reported, Hackage will accept this package.
363 Flags:
366 -v, --verbose [n]
367 Control verbosity (n is 0--3, default verbosity level is
368 1)
369 cabal upload
372 Usage: cabal upload [FLAGS] TARFILES
374 You can store your Hackage login in the ~/.cabal/config file Relevant
377 global configuration keys:
378 username
379 password
380 Flags:
383 -v, --verbose [n]
384 Control verbosity (n is 0--3, default verbosity level is
385 1)
386 --publish
388 Publish the package instead of uploading it as a candi‐
389 date.
390 -d, --documentation
392 Upload documentation instead of a source package. By
393 default, this uploads documentation for a package candi‐
394 date. To upload documentation for a published package,
395 combine with --publish.
396 -u, --username USERNAME
398 Hackage username.
399 -p, --password PASSWORD
401 Hackage password.
402 -P, --password-command PASSWORD
404 Command to get Hackage password.
405 cabal report
408 Usage: cabal report [FLAGS]
410 You can store your Hackage login in the ~/.cabal/config file
413 Flags:
416 -v, --verbose [n]
417 Control verbosity (n is 0--3, default verbosity level is
418 1)
419 -u, --username USERNAME
421 Hackage username.
422 -p, --password PASSWORD
424 Hackage password.
425 cabal init
428 Usage: cabal init [FLAGS]
430 Cabalise a project by creating a .cabal, Setup.hs, and optionally a
433 LICENSE file.
434 Calling init with no arguments (recommended) uses an interactive mode,
436 which will try to guess as much as possible and prompt you for the
437 rest. Command-line arguments are provided for scripting purposes. If
438 you don't want interactive mode, be sure to pass the -n flag.
439 Flags:
442 -n, --non-interactive
443 Non-interactive mode.
444 -q, --quiet
446 Do not generate log messages to stdout.
447 --no-comments
449 Do not generate explanatory comments in the .cabal file.
450 -m, --minimal
452 Generate a minimal .cabal file, that is, do not include
453 extra empty fields. Also implies --no-comments.
454 --overwrite
456 Overwrite any existing .cabal, LICENSE, or Setup.hs files
457 without warning.
458 --package-dir, --packagedir DIRECTORY
460 Root directory of the package (default = current direc‐
461 tory).
462 -p, --package-name PACKAGE
464 Name of the Cabal package to create.
465 --version VERSION
467 Initial version of the package.
468 --cabal-version VERSION_RANGE
470 Required version of the Cabal library.
471 -l, --license LICENSE
473 Project license.
474 -a, --author NAME
476 Name of the project's author.
477 -e, --email EMAIL
479 Email address of the maintainer.
480 -u, --homepage URL
482 Project homepage and/or repository.
483 -s, --synopsis TEXT
485 Short project synopsis.
486 -c, --category CATEGORY
488 Project category.
489 -x, --extra-source-file FILE
491 Extra source file to be distributed with tarball.
492 --is-library
494 Build a library.
495 --is-executable
497 Build an executable.
498 --is-libandexe
500 Build a library and an executable.
501 --main-is FILE
503 Specify the main module.
504 --language LANGUAGE
506 Specify the default language.
507 -o, --expose-module MODULE
509 Export a module from the package.
510 --extension EXTENSION
512 Use a LANGUAGE extension (in the other-extensions field).
513 -d, --dependency PACKAGE
515 Package dependency.
516 --source-dir, --sourcedir DIR
518 Directory containing package source.
519 --build-tool TOOL
521 Required external build tool.
522 -v, --verbose [n]
524 Control verbosity (n is 0--3, default verbosity level is
525 1)
526 cabal user-config
529 Usage: cabal user-config init
531 or: cabal user-config diff
532 or: cabal user-config update
533 When upgrading cabal, the set of configuration keys and their default
536 values may change. This command provides means to merge the existing
537 config in ~/.cabal/config (i.e. all bindings that are actually defined
538 and not commented out) and the default config of the new version.
539 init: Creates a new config file at either ~/.cabal/config or as speci‐
541 fied by --config-file, if given. An existing file won't be overwritten
542 unless -f or --force is given. diff: Shows a pseudo-diff of the user's
543 ~/.cabal/config file and the default configuration that would be cre‐
544 ated by cabal if the config file did not exist. update: Applies the
545 pseudo-diff to the configuration that would be created by default, and
546 write the result back to ~/.cabal/config.
547 Flags:
550 -v, --verbose [n]
551 Control verbosity (n is 0--3, default verbosity level is
552 1)
553 -f, --force
555 Overwrite the config file if it already exists.
556 -a, --augment CONFIGLINE
558 Additional setting to augment the config file (replacing
559 a previous setting if it existed).
560 cabal gen-bounds
563 Usage: cabal gen-bounds [FLAGS]
565 Generates bounds for all dependencies that do not currently have them.
568 Generated bounds are printed to stdout. You can then paste them into
569 your
570 Flags:
574 -v, --verbose [n]
575 Control verbosity (n is 0--3, default verbosity level is
576 1)
577 cabal outdated
580 Usage: cabal outdated [FLAGS]
582 Checks for outdated dependencies in the package description file or
585 freeze file
586 Flags:
589 -v, --verbose [n]
590 Control verbosity (n is 0--3, default verbosity level is
591 1)
592 --freeze-file, --v1-freeze-file
594 Act on the freeze file
595 --new-freeze-file, --v2-freeze-file
597 Act on the new-style freeze file (default:
598 cabal.project.freeze)
599 --project-file PROJECTFILE
601 Act on the new-style freeze file named PROJECTFILE.freeze
602 rather than the default cabal.project.freeze
603 --simple-output
605 Only print names of outdated dependencies, one per line
606 --exit-code
608 Exit with non-zero when there are outdated dependencies
609 -q, --quiet
611 Don't print any output. Implies '--exit-code' and '-v0'
612 --ignore PKGS
614 Packages to ignore
615 --minor [PKGS]
617 Ignore major version bumps for these packages
618 cabal hscolour
621 Usage: cabal hscolour [FLAGS]
623 Requires the hscolour program.
626 Deprecated in favour of 'cabal haddock --hyperlink-source'.
629 Flags:
631 -v, --verbose [n]
632 Control verbosity (n is 0--3, default verbosity level is
633 1)
634 --builddir, --distdir, --distpref DIR
636 The directory where Cabal puts generated build files
637 (default dist)
638 --executables
640 Run hscolour for Executables targets
641 --tests
643 Run hscolour for Test Suite targets
644 --benchmarks
646 Run hscolour for Benchmark targets
647 --foreign-libraries
649 Run hscolour for Foreign Library targets
650 --all
652 Run hscolour for all targets
653 --css PATH
655 Use a cascading style sheet
656 cabal v2-configure
659 Usage: cabal v2-configure [FLAGS]
661 Adjust how the project is built by setting additional package flags and
664 other flags.
665 The configuration options are written to the 'cabal.project.local' file
667 (or configuration from the 'cabal.project' file (if any). This combina‐
668 tion is used as the project configuration for all other commands (such
669 as 'v2-build',
670 The v2-configure command also checks that the project configuration
672 will work. In particular it checks that there is a consistent set of
673 dependencies for the project as a whole.
674 The 'cabal.project.local' file persists across 'v2-clean' but is over‐
676 written on the next use of the 'v2-configure' command. The intention is
677 that the
678 It is never necessary to use the 'v2-configure' command. It is merely a
680 convenience in cases where you do not want to specify flags to
681 'v2-build' (and other commands) every time and yet do not want to alter
682 the
683 Adjust how the project is built by setting additional package flags and
686 other flags.
687 The configuration options are written to the 'cabal.project.local' file
689 (or configuration from the 'cabal.project' file (if any). This combina‐
690 tion is used as the project configuration for all other commands (such
691 as 'v2-build',
692 The v2-configure command also checks that the project configuration
694 will work. In particular it checks that there is a consistent set of
695 dependencies for the project as a whole.
696 The 'cabal.project.local' file persists across 'v2-clean' but is over‐
698 written on the next use of the 'v2-configure' command. The intention is
699 that the
700 It is never necessary to use the 'v2-configure' command. It is merely a
702 convenience in cases where you do not want to specify flags to
703 'v2-build' (and other commands) every time and yet do not want to alter
704 the
705 Flags:
708 -v, --verbose [n]
709 Control verbosity (n is 0--3, default verbosity level is
710 1)
711 --builddir, --distdir, --distpref DIR
713 The directory where Cabal puts generated build files
714 (default dist)
715 -g, --ghc
717 compile with GHC
718 --ghcjs
720 compile with GHCJS
721 --uhc
723 compile with UHC
724 --haskell-suite
726 compile with a haskell-suite compiler
727 --cabal-file PATH
729 use this Cabal file
730 -w, --with-compiler PATH
732 give the path to a particular compiler
733 --with-hc-pkg PATH
735 give the path to the package tool
736 --prefix DIR
738 bake this prefix in preparation of installation
739 --bindir DIR
741 installation directory for executables
742 --libdir DIR
744 installation directory for libraries
745 --libsubdir DIR
747 subdirectory of libdir in which libs are installed
748 --dynlibdir DIR
750 installation directory for dynamic libraries
751 --libexecdir DIR
753 installation directory for program executables
754 --libexecsubdir DIR
756 subdirectory of libexecdir in which private executables
757 are installed
758 --datadir DIR
760 installation directory for read-only data
761 --datasubdir DIR
763 subdirectory of datadir in which data files are installed
764 --docdir DIR
766 installation directory for documentation
767 --htmldir DIR
769 installation directory for HTML documentation
770 --haddockdir DIR
772 installation directory for haddock interfaces
773 --sysconfdir DIR
775 installation directory for configuration files
776 --program-prefix PREFIX
778 prefix to be applied to installed executables
779 --program-suffix SUFFIX
781 suffix to be applied to installed executables
782 --enable-library-vanilla
784 --disable-library-vanilla
785 Vanilla libraries
786 -p, --enable-library-profiling
788 --disable-library-profiling
789 Library profiling
790 --enable-shared
792 --disable-shared
793 Shared library
794 --enable-static
796 --disable-static
797 Static library
798 --enable-executable-dynamic
800 --disable-executable-dynamic
801 Executable dynamic linking
802 --enable-profiling
804 --disable-profiling
805 Executable and library profiling
806 --enable-executable-profiling
808 --disable-executable-profiling
809 Executable profiling (DEPRECATED)
810 --profiling-detail level
812 Profiling detail level for executable and library
813 (default, none, exported-functions, toplevel-functions,
814 all-functions).
815 --library-profiling-detail level
817 Profiling detail level for libraries only.
818 -O, --enable-optimization, --enable-optimisation [n]
820 Build with optimization (n is 0--2, default is 1)
821 --disable-optimization, --disable-optimisation
823 Build without optimization
824 --enable-debug-info [n]
826 Emit debug info (n is 0--3, default is 0)
827 --disable-debug-info
829 Don't emit debug info
830 --enable-library-for-ghci
832 --disable-library-for-ghci
833 compile library for use with GHCi
834 --enable-split-sections
836 --disable-split-sections
837 compile library code such that unneeded definitions can
838 be dropped from the final executable (GHC 7.8+)
839 --enable-split-objs
841 --disable-split-objs
842 split library into smaller objects to reduce binary sizes
843 (GHC 6.6+)
844 --enable-executable-stripping
846 --disable-executable-stripping
847 strip executables upon installation to reduce binary
848 sizes
849 --enable-library-stripping
851 --disable-library-stripping
852 strip libraries upon installation to reduce binary sizes
853 --configure-option OPT
855 Extra option for configure
856 --user
858 --global
859 doing a per-user installation
860 --package-db DB
862 Append the given package database to the list of package
863 databases used (to satisfy dependencies and register
864 into). May be a specific file, 'global' or 'user'. The
865 initial list is ['global'], ['global', 'user'], or
866 ['global', $sandbox], depending on context. Use 'clear'
867 to reset the list to empty. See the user guide for
868 details.
869 -f, --flags FLAGS
871 Force values for the given flags in Cabal conditionals in
872 the .cabal file. E.g., --flags="debug -usebytestrings"
873 forces the flag "debug" to true and "usebytestrings" to
874 false.
875 --extra-include-dirs PATH
877 A list of directories to search for header files
878 --enable-deterministic
880 --disable-deterministic
881 Try to be as deterministic as possible (used by the test
882 suite)
883 --ipid IPID
885 Installed package ID to compile this package as
886 --cid CID
888 Installed component ID to compile this component as
889 --extra-lib-dirs PATH
891 A list of directories to search for external libraries
892 --extra-framework-dirs PATH
894 A list of directories to search for external frameworks
895 (OS X only)
896 --extra-prog-path PATH
898 A list of directories to search for required programs (in
899 addition to the normal search locations)
900 --instantiate-with NAME=MOD
902 A mapping of signature names to concrete module instanti‐
903 ations.
904 --enable-tests
906 --disable-tests
907 dependency checking and compilation for test suites
908 listed in the package description file.
909 --enable-coverage
911 --disable-coverage
912 build package with Haskell Program Coverage. (GHC only)
913 --enable-library-coverage
915 --disable-library-coverage
916 build package with Haskell Program Coverage. (GHC only)
917 (DEPRECATED)
918 --enable-benchmarks
920 --disable-benchmarks
921 dependency checking and compilation for benchmarks listed
922 in the package description file.
923 --enable-relocatable
925 --disable-relocatable
926 building a package that is relocatable. (GHC only)
927 --disable-response-files
929 enable workaround for old versions of programs like "ar"
930 that do not support @file arguments
931 --with-alex PATH
933 give the path to alex
934 --with-ar PATH
936 give the path to ar
937 --with-c2hs PATH
939 give the path to c2hs
940 --with-cpphs PATH
942 give the path to cpphs
943 --with-doctest PATH
945 give the path to doctest
946 --with-gcc PATH
948 give the path to gcc
949 --with-ghc PATH
951 give the path to ghc
952 --with-ghc-pkg PATH
954 give the path to ghc-pkg
955 --with-ghcjs PATH
957 give the path to ghcjs
958 --with-ghcjs-pkg PATH
960 give the path to ghcjs-pkg
961 --with-greencard PATH
963 give the path to greencard
964 --with-haddock PATH
966 give the path to haddock
967 --with-happy PATH
969 give the path to happy
970 --with-haskell-suite PATH
972 give the path to haskell-suite
973 --with-haskell-suite-pkg PATH
975 give the path to haskell-suite-pkg
976 --with-hmake PATH
978 give the path to hmake
979 --with-hpc PATH
981 give the path to hpc
982 --with-hsc2hs PATH
984 give the path to hsc2hs
985 --with-hscolour PATH
987 give the path to hscolour
988 --with-jhc PATH
990 give the path to jhc
991 --with-ld PATH
993 give the path to ld
994 --with-pkg-config PATH
996 give the path to pkg-config
997 --with-runghc PATH
999 give the path to runghc
1000 --with-strip PATH
1002 give the path to strip
1003 --with-tar PATH
1005 give the path to tar
1006 --with-uhc PATH
1008 give the path to uhc
1009 --alex-option OPT
1011 give an extra option to alex (no need to quote options
1012 containing spaces)
1013 --ar-option OPT
1015 give an extra option to ar (no need to quote options con‐
1016 taining spaces)
1017 --c2hs-option OPT
1019 give an extra option to c2hs (no need to quote options
1020 containing spaces)
1021 --cpphs-option OPT
1023 give an extra option to cpphs (no need to quote options
1024 containing spaces)
1025 --doctest-option OPT
1027 give an extra option to doctest (no need to quote options
1028 containing spaces)
1029 --gcc-option OPT
1031 give an extra option to gcc (no need to quote options
1032 containing spaces)
1033 --ghc-option OPT
1035 give an extra option to ghc (no need to quote options
1036 containing spaces)
1037 --ghc-pkg-option OPT
1039 give an extra option to ghc-pkg (no need to quote options
1040 containing spaces)
1041 --ghcjs-option OPT
1043 give an extra option to ghcjs (no need to quote options
1044 containing spaces)
1045 --ghcjs-pkg-option OPT
1047 give an extra option to ghcjs-pkg (no need to quote
1048 options containing spaces)
1049 --greencard-option OPT
1051 give an extra option to greencard (no need to quote
1052 options containing spaces)
1053 --haddock-option OPT
1055 give an extra option to haddock (no need to quote options
1056 containing spaces)
1057 --happy-option OPT
1059 give an extra option to happy (no need to quote options
1060 containing spaces)
1061 --haskell-suite-option OPT
1063 give an extra option to haskell-suite (no need to quote
1064 options containing spaces)
1065 --haskell-suite-pkg-option OPT
1067 give an extra option to haskell-suite-pkg (no need to
1068 quote options containing spaces)
1069 --hmake-option OPT
1071 give an extra option to hmake (no need to quote options
1072 containing spaces)
1073 --hpc-option OPT
1075 give an extra option to hpc (no need to quote options
1076 containing spaces)
1077 --hsc2hs-option OPT
1079 give an extra option to hsc2hs (no need to quote options
1080 containing spaces)
1081 --hscolour-option OPT
1083 give an extra option to hscolour (no need to quote
1084 options containing spaces)
1085 --jhc-option OPT
1087 give an extra option to jhc (no need to quote options
1088 containing spaces)
1089 --ld-option OPT
1091 give an extra option to ld (no need to quote options con‐
1092 taining spaces)
1093 --pkg-config-option OPT
1095 give an extra option to pkg-config (no need to quote
1096 options containing spaces)
1097 --runghc-option OPT
1099 give an extra option to runghc (no need to quote options
1100 containing spaces)
1101 --strip-option OPT
1103 give an extra option to strip (no need to quote options
1104 containing spaces)
1105 --tar-option OPT
1107 give an extra option to tar (no need to quote options
1108 containing spaces)
1109 --uhc-option OPT
1111 give an extra option to uhc (no need to quote options
1112 containing spaces)
1113 --alex-options OPTS
1115 give extra options to alex
1116 --ar-options OPTS
1118 give extra options to ar
1119 --c2hs-options OPTS
1121 give extra options to c2hs
1122 --cpphs-options OPTS
1124 give extra options to cpphs
1125 --doctest-options OPTS
1127 give extra options to doctest
1128 --gcc-options OPTS
1130 give extra options to gcc
1131 --ghc-options OPTS
1133 give extra options to ghc
1134 --ghc-pkg-options OPTS
1136 give extra options to ghc-pkg
1137 --ghcjs-options OPTS
1139 give extra options to ghcjs
1140 --ghcjs-pkg-options OPTS
1142 give extra options to ghcjs-pkg
1143 --greencard-options OPTS
1145 give extra options to greencard
1146 --haddock-options OPTS
1148 give extra options to haddock
1149 --happy-options OPTS
1151 give extra options to happy
1152 --haskell-suite-options OPTS
1154 give extra options to haskell-suite
1155 --haskell-suite-pkg-options OPTS
1157 give extra options to haskell-suite-pkg
1158 --hmake-options OPTS
1160 give extra options to hmake
1161 --hpc-options OPTS
1163 give extra options to hpc
1164 --hsc2hs-options OPTS
1166 give extra options to hsc2hs
1167 --hscolour-options OPTS
1169 give extra options to hscolour
1170 --jhc-options OPTS
1172 give extra options to jhc
1173 --ld-options OPTS
1175 give extra options to ld
1176 --pkg-config-options OPTS
1178 give extra options to pkg-config
1179 --runghc-options OPTS
1181 give extra options to runghc
1182 --strip-options OPTS
1184 give extra options to strip
1185 --tar-options OPTS
1187 give extra options to tar
1188 --uhc-options OPTS
1190 give extra options to uhc
1191 --cabal-lib-version VERSION
1193 Select which version of the Cabal lib to use to build
1194 packages (useful for testing).
1195 --constraint CONSTRAINT
1197 Specify constraints on a package (version,
1198 installed/source, flags)
1199 --preference CONSTRAINT
1201 Specify preferences (soft constraints) on the version of
1202 a package
1203 --solver SOLVER
1205 Select dependency solver to use (default: modular).
1206 Choices: modular.
1207 --allow-older [DEPS]
1209 Ignore lower bounds in all dependencies or DEPS
1210 --allow-newer [DEPS]
1212 Ignore upper bounds in all dependencies or DEPS
1213 --enable-documentation
1215 --disable-documentation
1216 building of documentation
1217 --doc-index-file TEMPLATE
1219 A central index of haddock API documentation (template
1220 cannot use $pkgid)
1221 --dry-run
1223 Do not install anything, only print what would be
1224 installed.
1225 --max-backjumps NUM
1227 Maximum number of backjumps allowed while solving
1228 (default: 2000). Use a negative number to enable unlim‐
1229 ited backtracking. Use 0 to disable backtracking com‐
1230 pletely.
1231 --reorder-goals
1233 --no-reorder-goals
1234 Try to reorder goals according to certain heuristics.
1235 Slows things down on average, but may make backtracking
1236 faster for some packages.
1237 --count-conflicts
1239 --no-count-conflicts
1240 Try to speed up solving by preferring goals that are
1241 involved in a lot of conflicts (default).
1242 --independent-goals
1244 --no-independent-goals
1245 Treat several goals on the command line as independent.
1246 If several goals depend on the same package, different
1247 versions can be chosen.
1248 --shadow-installed-packages
1250 --no-shadow-installed-packages
1251 If multiple package instances of the same version are
1252 installed, treat all but one as shadowed.
1253 --strong-flags
1255 --no-strong-flags
1256 Do not defer flag choices (this used to be the default in
1257 cabal-install <= 1.20).
1258 --allow-boot-library-installs
1260 --no-allow-boot-library-installs
1261 Allow cabal to install base, ghc-prim, integer-simple,
1262 integer-gmp, and template-haskell.
1263 --reinstall
1265 --no-reinstall
1266 Install even if it means installing the same version
1267 again.
1268 --avoid-reinstalls
1270 --no-avoid-reinstalls
1271 Do not select versions that would destructively overwrite
1272 installed packages.
1273 --force-reinstalls
1275 --no-force-reinstalls
1276 Reinstall packages even if they will most likely break
1277 other installed packages.
1278 --upgrade-dependencies
1280 --no-upgrade-dependencies
1281 Pick the latest version for all dependencies, rather than
1282 trying to pick an installed version.
1283 --only-dependencies
1285 --no-only-dependencies
1286 Install only the dependencies necessary to build the
1287 given packages
1288 --dependencies-only
1290 --no-dependencies-only
1291 A synonym for --only-dependencies
1292 --index-state STATE
1294 Use source package index state as it existed at a previ‐
1295 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
1296 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
1297 'HEAD' (default: 'HEAD').
1298 --root-cmd COMMAND
1300 (No longer supported, do not use.)
1301 --symlink-bindir DIR
1303 Add symlinks to installed executables into this direc‐
1304 tory.
1305 --build-summary TEMPLATE
1307 Save build summaries to file (name template can use
1308 $pkgid, $compiler, $os, $arch)
1309 --build-log TEMPLATE
1311 Log all builds to file (name template can use $pkgid,
1312 $compiler, $os, $arch)
1313 --remote-build-reporting LEVEL
1315 Generate build reports to send to a remote server (none,
1316 anonymous or detailed).
1317 --report-planning-failure
1319 Generate build reports when the dependency solver fails.
1320 This is used by the Hackage build bot.
1321 --enable-per-component
1323 --disable-per-component
1324 Per-component builds when possible
1325 --one-shot
1327 --no-one-shot
1328 Do not record the packages in the world file.
1329 --run-tests
1331 Run package test suites during installation.
1332 -j, --jobs [NUM]
1334 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
1335 given).
1336 --keep-going
1338 After a build failure, continue to build other unaffected
1339 packages.
1340 --offline
1342 --no-offline
1343 Don't download packages from the Internet.
1344 --project-file FILE
1346 Set the name of the cabal.project file to search for in
1347 parent directories
1348 --only
1350 Only installs the package in the current directory.
1351 --haddock-hoogle
1353 Generate a hoogle database
1354 --haddock-html
1356 Generate HTML documentation (the default)
1357 --haddock-html-location URL
1359 Location of HTML documentation for pre-requisite packages
1360 --haddock-for-hackage
1362 Collection of flags to generate documentation suitable
1363 for upload to hackage
1364 --haddock-executables
1366 Run haddock for Executables targets
1367 --haddock-tests
1369 Run haddock for Test Suite targets
1370 --haddock-benchmarks
1372 Run haddock for Benchmark targets
1373 --haddock-all
1375 Run haddock for all targets
1376 --haddock-internal
1378 Run haddock for internal modules and include all symbols
1379 --haddock-css PATH
1381 Use PATH as the haddock stylesheet
1382 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
1384 dock-hyperlinked-source
1385 Hyperlink the documentation to the source code
1386 --haddock-quickjump
1388 Generate an index for interactive documentation naviga‐
1389 tion
1390 --haddock-hscolour-css PATH
1392 Use PATH as the HsColour stylesheet
1393 --haddock-contents-location URL
1395 Bake URL in as the location for the contents page
1396 cabal new-configure
1399 Usage: cabal new-configure [FLAGS]
1401 Adjust how the project is built by setting additional package flags and
1404 other flags.
1405 The configuration options are written to the 'cabal.project.local' file
1407 (or configuration from the 'cabal.project' file (if any). This combina‐
1408 tion is used as the project configuration for all other commands (such
1409 as 'new-build',
1410 The new-configure command also checks that the project configuration
1412 will work. In particular it checks that there is a consistent set of
1413 dependencies for the project as a whole.
1414 The 'cabal.project.local' file persists across 'new-clean' but is over‐
1416 written on the next use of the 'new-configure' command. The intention
1417 is that the
1418 It is never necessary to use the 'new-configure' command. It is merely
1420 a convenience in cases where you do not want to specify flags to 'new-
1421 build' (and other commands) every time and yet do not want to alter the
1422 Examples:
1425 cabal new-configure --with-compiler ghc-7.10.3
1426 Adjust the project configuration to use the given compiler
1427 program and check the resulting configuration works.
1428 cabal new-configure
1429 Reset the local configuration to empty and check the overall
1430 project configuration works.
1431 Note: this command is part of the new project-based system (aka nix-
1433 style local builds). These features are currently in beta. Please see
1434 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
1435 details and advice on what you can expect to work. If you encounter
1436 problems please file issues at https://github.com/haskell/cabal/issues
1437 and if you have any time to get involved and help with testing, fixing
1438 bugs etc then that is very much appreciated.
1439 Flags:
1442 -v, --verbose [n]
1443 Control verbosity (n is 0--3, default verbosity level is
1444 1)
1445 --builddir, --distdir, --distpref DIR
1447 The directory where Cabal puts generated build files
1448 (default dist)
1449 -g, --ghc
1451 compile with GHC
1452 --ghcjs
1454 compile with GHCJS
1455 --uhc
1457 compile with UHC
1458 --haskell-suite
1460 compile with a haskell-suite compiler
1461 --cabal-file PATH
1463 use this Cabal file
1464 -w, --with-compiler PATH
1466 give the path to a particular compiler
1467 --with-hc-pkg PATH
1469 give the path to the package tool
1470 --prefix DIR
1472 bake this prefix in preparation of installation
1473 --bindir DIR
1475 installation directory for executables
1476 --libdir DIR
1478 installation directory for libraries
1479 --libsubdir DIR
1481 subdirectory of libdir in which libs are installed
1482 --dynlibdir DIR
1484 installation directory for dynamic libraries
1485 --libexecdir DIR
1487 installation directory for program executables
1488 --libexecsubdir DIR
1490 subdirectory of libexecdir in which private executables
1491 are installed
1492 --datadir DIR
1494 installation directory for read-only data
1495 --datasubdir DIR
1497 subdirectory of datadir in which data files are installed
1498 --docdir DIR
1500 installation directory for documentation
1501 --htmldir DIR
1503 installation directory for HTML documentation
1504 --haddockdir DIR
1506 installation directory for haddock interfaces
1507 --sysconfdir DIR
1509 installation directory for configuration files
1510 --program-prefix PREFIX
1512 prefix to be applied to installed executables
1513 --program-suffix SUFFIX
1515 suffix to be applied to installed executables
1516 --enable-library-vanilla
1518 --disable-library-vanilla
1519 Vanilla libraries
1520 -p, --enable-library-profiling
1522 --disable-library-profiling
1523 Library profiling
1524 --enable-shared
1526 --disable-shared
1527 Shared library
1528 --enable-static
1530 --disable-static
1531 Static library
1532 --enable-executable-dynamic
1534 --disable-executable-dynamic
1535 Executable dynamic linking
1536 --enable-profiling
1538 --disable-profiling
1539 Executable and library profiling
1540 --enable-executable-profiling
1542 --disable-executable-profiling
1543 Executable profiling (DEPRECATED)
1544 --profiling-detail level
1546 Profiling detail level for executable and library
1547 (default, none, exported-functions, toplevel-functions,
1548 all-functions).
1549 --library-profiling-detail level
1551 Profiling detail level for libraries only.
1552 -O, --enable-optimization, --enable-optimisation [n]
1554 Build with optimization (n is 0--2, default is 1)
1555 --disable-optimization, --disable-optimisation
1557 Build without optimization
1558 --enable-debug-info [n]
1560 Emit debug info (n is 0--3, default is 0)
1561 --disable-debug-info
1563 Don't emit debug info
1564 --enable-library-for-ghci
1566 --disable-library-for-ghci
1567 compile library for use with GHCi
1568 --enable-split-sections
1570 --disable-split-sections
1571 compile library code such that unneeded definitions can
1572 be dropped from the final executable (GHC 7.8+)
1573 --enable-split-objs
1575 --disable-split-objs
1576 split library into smaller objects to reduce binary sizes
1577 (GHC 6.6+)
1578 --enable-executable-stripping
1580 --disable-executable-stripping
1581 strip executables upon installation to reduce binary
1582 sizes
1583 --enable-library-stripping
1585 --disable-library-stripping
1586 strip libraries upon installation to reduce binary sizes
1587 --configure-option OPT
1589 Extra option for configure
1590 --user
1592 --global
1593 doing a per-user installation
1594 --package-db DB
1596 Append the given package database to the list of package
1597 databases used (to satisfy dependencies and register
1598 into). May be a specific file, 'global' or 'user'. The
1599 initial list is ['global'], ['global', 'user'], or
1600 ['global', $sandbox], depending on context. Use 'clear'
1601 to reset the list to empty. See the user guide for
1602 details.
1603 -f, --flags FLAGS
1605 Force values for the given flags in Cabal conditionals in
1606 the .cabal file. E.g., --flags="debug -usebytestrings"
1607 forces the flag "debug" to true and "usebytestrings" to
1608 false.
1609 --extra-include-dirs PATH
1611 A list of directories to search for header files
1612 --enable-deterministic
1614 --disable-deterministic
1615 Try to be as deterministic as possible (used by the test
1616 suite)
1617 --ipid IPID
1619 Installed package ID to compile this package as
1620 --cid CID
1622 Installed component ID to compile this component as
1623 --extra-lib-dirs PATH
1625 A list of directories to search for external libraries
1626 --extra-framework-dirs PATH
1628 A list of directories to search for external frameworks
1629 (OS X only)
1630 --extra-prog-path PATH
1632 A list of directories to search for required programs (in
1633 addition to the normal search locations)
1634 --instantiate-with NAME=MOD
1636 A mapping of signature names to concrete module instanti‐
1637 ations.
1638 --enable-tests
1640 --disable-tests
1641 dependency checking and compilation for test suites
1642 listed in the package description file.
1643 --enable-coverage
1645 --disable-coverage
1646 build package with Haskell Program Coverage. (GHC only)
1647 --enable-library-coverage
1649 --disable-library-coverage
1650 build package with Haskell Program Coverage. (GHC only)
1651 (DEPRECATED)
1652 --enable-benchmarks
1654 --disable-benchmarks
1655 dependency checking and compilation for benchmarks listed
1656 in the package description file.
1657 --enable-relocatable
1659 --disable-relocatable
1660 building a package that is relocatable. (GHC only)
1661 --disable-response-files
1663 enable workaround for old versions of programs like "ar"
1664 that do not support @file arguments
1665 --with-alex PATH
1667 give the path to alex
1668 --with-ar PATH
1670 give the path to ar
1671 --with-c2hs PATH
1673 give the path to c2hs
1674 --with-cpphs PATH
1676 give the path to cpphs
1677 --with-doctest PATH
1679 give the path to doctest
1680 --with-gcc PATH
1682 give the path to gcc
1683 --with-ghc PATH
1685 give the path to ghc
1686 --with-ghc-pkg PATH
1688 give the path to ghc-pkg
1689 --with-ghcjs PATH
1691 give the path to ghcjs
1692 --with-ghcjs-pkg PATH
1694 give the path to ghcjs-pkg
1695 --with-greencard PATH
1697 give the path to greencard
1698 --with-haddock PATH
1700 give the path to haddock
1701 --with-happy PATH
1703 give the path to happy
1704 --with-haskell-suite PATH
1706 give the path to haskell-suite
1707 --with-haskell-suite-pkg PATH
1709 give the path to haskell-suite-pkg
1710 --with-hmake PATH
1712 give the path to hmake
1713 --with-hpc PATH
1715 give the path to hpc
1716 --with-hsc2hs PATH
1718 give the path to hsc2hs
1719 --with-hscolour PATH
1721 give the path to hscolour
1722 --with-jhc PATH
1724 give the path to jhc
1725 --with-ld PATH
1727 give the path to ld
1728 --with-pkg-config PATH
1730 give the path to pkg-config
1731 --with-runghc PATH
1733 give the path to runghc
1734 --with-strip PATH
1736 give the path to strip
1737 --with-tar PATH
1739 give the path to tar
1740 --with-uhc PATH
1742 give the path to uhc
1743 --alex-option OPT
1745 give an extra option to alex (no need to quote options
1746 containing spaces)
1747 --ar-option OPT
1749 give an extra option to ar (no need to quote options con‐
1750 taining spaces)
1751 --c2hs-option OPT
1753 give an extra option to c2hs (no need to quote options
1754 containing spaces)
1755 --cpphs-option OPT
1757 give an extra option to cpphs (no need to quote options
1758 containing spaces)
1759 --doctest-option OPT
1761 give an extra option to doctest (no need to quote options
1762 containing spaces)
1763 --gcc-option OPT
1765 give an extra option to gcc (no need to quote options
1766 containing spaces)
1767 --ghc-option OPT
1769 give an extra option to ghc (no need to quote options
1770 containing spaces)
1771 --ghc-pkg-option OPT
1773 give an extra option to ghc-pkg (no need to quote options
1774 containing spaces)
1775 --ghcjs-option OPT
1777 give an extra option to ghcjs (no need to quote options
1778 containing spaces)
1779 --ghcjs-pkg-option OPT
1781 give an extra option to ghcjs-pkg (no need to quote
1782 options containing spaces)
1783 --greencard-option OPT
1785 give an extra option to greencard (no need to quote
1786 options containing spaces)
1787 --haddock-option OPT
1789 give an extra option to haddock (no need to quote options
1790 containing spaces)
1791 --happy-option OPT
1793 give an extra option to happy (no need to quote options
1794 containing spaces)
1795 --haskell-suite-option OPT
1797 give an extra option to haskell-suite (no need to quote
1798 options containing spaces)
1799 --haskell-suite-pkg-option OPT
1801 give an extra option to haskell-suite-pkg (no need to
1802 quote options containing spaces)
1803 --hmake-option OPT
1805 give an extra option to hmake (no need to quote options
1806 containing spaces)
1807 --hpc-option OPT
1809 give an extra option to hpc (no need to quote options
1810 containing spaces)
1811 --hsc2hs-option OPT
1813 give an extra option to hsc2hs (no need to quote options
1814 containing spaces)
1815 --hscolour-option OPT
1817 give an extra option to hscolour (no need to quote
1818 options containing spaces)
1819 --jhc-option OPT
1821 give an extra option to jhc (no need to quote options
1822 containing spaces)
1823 --ld-option OPT
1825 give an extra option to ld (no need to quote options con‐
1826 taining spaces)
1827 --pkg-config-option OPT
1829 give an extra option to pkg-config (no need to quote
1830 options containing spaces)
1831 --runghc-option OPT
1833 give an extra option to runghc (no need to quote options
1834 containing spaces)
1835 --strip-option OPT
1837 give an extra option to strip (no need to quote options
1838 containing spaces)
1839 --tar-option OPT
1841 give an extra option to tar (no need to quote options
1842 containing spaces)
1843 --uhc-option OPT
1845 give an extra option to uhc (no need to quote options
1846 containing spaces)
1847 --alex-options OPTS
1849 give extra options to alex
1850 --ar-options OPTS
1852 give extra options to ar
1853 --c2hs-options OPTS
1855 give extra options to c2hs
1856 --cpphs-options OPTS
1858 give extra options to cpphs
1859 --doctest-options OPTS
1861 give extra options to doctest
1862 --gcc-options OPTS
1864 give extra options to gcc
1865 --ghc-options OPTS
1867 give extra options to ghc
1868 --ghc-pkg-options OPTS
1870 give extra options to ghc-pkg
1871 --ghcjs-options OPTS
1873 give extra options to ghcjs
1874 --ghcjs-pkg-options OPTS
1876 give extra options to ghcjs-pkg
1877 --greencard-options OPTS
1879 give extra options to greencard
1880 --haddock-options OPTS
1882 give extra options to haddock
1883 --happy-options OPTS
1885 give extra options to happy
1886 --haskell-suite-options OPTS
1888 give extra options to haskell-suite
1889 --haskell-suite-pkg-options OPTS
1891 give extra options to haskell-suite-pkg
1892 --hmake-options OPTS
1894 give extra options to hmake
1895 --hpc-options OPTS
1897 give extra options to hpc
1898 --hsc2hs-options OPTS
1900 give extra options to hsc2hs
1901 --hscolour-options OPTS
1903 give extra options to hscolour
1904 --jhc-options OPTS
1906 give extra options to jhc
1907 --ld-options OPTS
1909 give extra options to ld
1910 --pkg-config-options OPTS
1912 give extra options to pkg-config
1913 --runghc-options OPTS
1915 give extra options to runghc
1916 --strip-options OPTS
1918 give extra options to strip
1919 --tar-options OPTS
1921 give extra options to tar
1922 --uhc-options OPTS
1924 give extra options to uhc
1925 --cabal-lib-version VERSION
1927 Select which version of the Cabal lib to use to build
1928 packages (useful for testing).
1929 --constraint CONSTRAINT
1931 Specify constraints on a package (version,
1932 installed/source, flags)
1933 --preference CONSTRAINT
1935 Specify preferences (soft constraints) on the version of
1936 a package
1937 --solver SOLVER
1939 Select dependency solver to use (default: modular).
1940 Choices: modular.
1941 --allow-older [DEPS]
1943 Ignore lower bounds in all dependencies or DEPS
1944 --allow-newer [DEPS]
1946 Ignore upper bounds in all dependencies or DEPS
1947 --enable-documentation
1949 --disable-documentation
1950 building of documentation
1951 --doc-index-file TEMPLATE
1953 A central index of haddock API documentation (template
1954 cannot use $pkgid)
1955 --dry-run
1957 Do not install anything, only print what would be
1958 installed.
1959 --max-backjumps NUM
1961 Maximum number of backjumps allowed while solving
1962 (default: 2000). Use a negative number to enable unlim‐
1963 ited backtracking. Use 0 to disable backtracking com‐
1964 pletely.
1965 --reorder-goals
1967 --no-reorder-goals
1968 Try to reorder goals according to certain heuristics.
1969 Slows things down on average, but may make backtracking
1970 faster for some packages.
1971 --count-conflicts
1973 --no-count-conflicts
1974 Try to speed up solving by preferring goals that are
1975 involved in a lot of conflicts (default).
1976 --independent-goals
1978 --no-independent-goals
1979 Treat several goals on the command line as independent.
1980 If several goals depend on the same package, different
1981 versions can be chosen.
1982 --shadow-installed-packages
1984 --no-shadow-installed-packages
1985 If multiple package instances of the same version are
1986 installed, treat all but one as shadowed.
1987 --strong-flags
1989 --no-strong-flags
1990 Do not defer flag choices (this used to be the default in
1991 cabal-install <= 1.20).
1992 --allow-boot-library-installs
1994 --no-allow-boot-library-installs
1995 Allow cabal to install base, ghc-prim, integer-simple,
1996 integer-gmp, and template-haskell.
1997 --reinstall
1999 --no-reinstall
2000 Install even if it means installing the same version
2001 again.
2002 --avoid-reinstalls
2004 --no-avoid-reinstalls
2005 Do not select versions that would destructively overwrite
2006 installed packages.
2007 --force-reinstalls
2009 --no-force-reinstalls
2010 Reinstall packages even if they will most likely break
2011 other installed packages.
2012 --upgrade-dependencies
2014 --no-upgrade-dependencies
2015 Pick the latest version for all dependencies, rather than
2016 trying to pick an installed version.
2017 --only-dependencies
2019 --no-only-dependencies
2020 Install only the dependencies necessary to build the
2021 given packages
2022 --dependencies-only
2024 --no-dependencies-only
2025 A synonym for --only-dependencies
2026 --index-state STATE
2028 Use source package index state as it existed at a previ‐
2029 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
2030 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
2031 'HEAD' (default: 'HEAD').
2032 --root-cmd COMMAND
2034 (No longer supported, do not use.)
2035 --symlink-bindir DIR
2037 Add symlinks to installed executables into this direc‐
2038 tory.
2039 --build-summary TEMPLATE
2041 Save build summaries to file (name template can use
2042 $pkgid, $compiler, $os, $arch)
2043 --build-log TEMPLATE
2045 Log all builds to file (name template can use $pkgid,
2046 $compiler, $os, $arch)
2047 --remote-build-reporting LEVEL
2049 Generate build reports to send to a remote server (none,
2050 anonymous or detailed).
2051 --report-planning-failure
2053 Generate build reports when the dependency solver fails.
2054 This is used by the Hackage build bot.
2055 --enable-per-component
2057 --disable-per-component
2058 Per-component builds when possible
2059 --one-shot
2061 --no-one-shot
2062 Do not record the packages in the world file.
2063 --run-tests
2065 Run package test suites during installation.
2066 -j, --jobs [NUM]
2068 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
2069 given).
2070 --keep-going
2072 After a build failure, continue to build other unaffected
2073 packages.
2074 --offline
2076 --no-offline
2077 Don't download packages from the Internet.
2078 --project-file FILE
2080 Set the name of the cabal.project file to search for in
2081 parent directories
2082 --only
2084 Only installs the package in the current directory.
2085 --haddock-hoogle
2087 Generate a hoogle database
2088 --haddock-html
2090 Generate HTML documentation (the default)
2091 --haddock-html-location URL
2093 Location of HTML documentation for pre-requisite packages
2094 --haddock-for-hackage
2096 Collection of flags to generate documentation suitable
2097 for upload to hackage
2098 --haddock-executables
2100 Run haddock for Executables targets
2101 --haddock-tests
2103 Run haddock for Test Suite targets
2104 --haddock-benchmarks
2106 Run haddock for Benchmark targets
2107 --haddock-all
2109 Run haddock for all targets
2110 --haddock-internal
2112 Run haddock for internal modules and include all symbols
2113 --haddock-css PATH
2115 Use PATH as the haddock stylesheet
2116 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
2118 dock-hyperlinked-source
2119 Hyperlink the documentation to the source code
2120 --haddock-quickjump
2122 Generate an index for interactive documentation naviga‐
2123 tion
2124 --haddock-hscolour-css PATH
2126 Use PATH as the HsColour stylesheet
2127 --haddock-contents-location URL
2129 Bake URL in as the location for the contents page
2130 cabal v2-update
2133 Usage: cabal v2-update [FLAGS] [REPOS]
2135 For all known remote repositories, download the package list.
2138 For all known remote repositories, download the package list.
2141 Flags:
2144 -v, --verbose [n]
2145 Control verbosity (n is 0--3, default verbosity level is
2146 1)
2147 --builddir, --distdir, --distpref DIR
2149 The directory where Cabal puts generated build files
2150 (default dist)
2151 -g, --ghc
2153 compile with GHC
2154 --ghcjs
2156 compile with GHCJS
2157 --uhc
2159 compile with UHC
2160 --haskell-suite
2162 compile with a haskell-suite compiler
2163 --cabal-file PATH
2165 use this Cabal file
2166 -w, --with-compiler PATH
2168 give the path to a particular compiler
2169 --with-hc-pkg PATH
2171 give the path to the package tool
2172 --prefix DIR
2174 bake this prefix in preparation of installation
2175 --bindir DIR
2177 installation directory for executables
2178 --libdir DIR
2180 installation directory for libraries
2181 --libsubdir DIR
2183 subdirectory of libdir in which libs are installed
2184 --dynlibdir DIR
2186 installation directory for dynamic libraries
2187 --libexecdir DIR
2189 installation directory for program executables
2190 --libexecsubdir DIR
2192 subdirectory of libexecdir in which private executables
2193 are installed
2194 --datadir DIR
2196 installation directory for read-only data
2197 --datasubdir DIR
2199 subdirectory of datadir in which data files are installed
2200 --docdir DIR
2202 installation directory for documentation
2203 --htmldir DIR
2205 installation directory for HTML documentation
2206 --haddockdir DIR
2208 installation directory for haddock interfaces
2209 --sysconfdir DIR
2211 installation directory for configuration files
2212 --program-prefix PREFIX
2214 prefix to be applied to installed executables
2215 --program-suffix SUFFIX
2217 suffix to be applied to installed executables
2218 --enable-library-vanilla
2220 --disable-library-vanilla
2221 Vanilla libraries
2222 -p, --enable-library-profiling
2224 --disable-library-profiling
2225 Library profiling
2226 --enable-shared
2228 --disable-shared
2229 Shared library
2230 --enable-static
2232 --disable-static
2233 Static library
2234 --enable-executable-dynamic
2236 --disable-executable-dynamic
2237 Executable dynamic linking
2238 --enable-profiling
2240 --disable-profiling
2241 Executable and library profiling
2242 --enable-executable-profiling
2244 --disable-executable-profiling
2245 Executable profiling (DEPRECATED)
2246 --profiling-detail level
2248 Profiling detail level for executable and library
2249 (default, none, exported-functions, toplevel-functions,
2250 all-functions).
2251 --library-profiling-detail level
2253 Profiling detail level for libraries only.
2254 -O, --enable-optimization, --enable-optimisation [n]
2256 Build with optimization (n is 0--2, default is 1)
2257 --disable-optimization, --disable-optimisation
2259 Build without optimization
2260 --enable-debug-info [n]
2262 Emit debug info (n is 0--3, default is 0)
2263 --disable-debug-info
2265 Don't emit debug info
2266 --enable-library-for-ghci
2268 --disable-library-for-ghci
2269 compile library for use with GHCi
2270 --enable-split-sections
2272 --disable-split-sections
2273 compile library code such that unneeded definitions can
2274 be dropped from the final executable (GHC 7.8+)
2275 --enable-split-objs
2277 --disable-split-objs
2278 split library into smaller objects to reduce binary sizes
2279 (GHC 6.6+)
2280 --enable-executable-stripping
2282 --disable-executable-stripping
2283 strip executables upon installation to reduce binary
2284 sizes
2285 --enable-library-stripping
2287 --disable-library-stripping
2288 strip libraries upon installation to reduce binary sizes
2289 --configure-option OPT
2291 Extra option for configure
2292 --user
2294 --global
2295 doing a per-user installation
2296 --package-db DB
2298 Append the given package database to the list of package
2299 databases used (to satisfy dependencies and register
2300 into). May be a specific file, 'global' or 'user'. The
2301 initial list is ['global'], ['global', 'user'], or
2302 ['global', $sandbox], depending on context. Use 'clear'
2303 to reset the list to empty. See the user guide for
2304 details.
2305 -f, --flags FLAGS
2307 Force values for the given flags in Cabal conditionals in
2308 the .cabal file. E.g., --flags="debug -usebytestrings"
2309 forces the flag "debug" to true and "usebytestrings" to
2310 false.
2311 --extra-include-dirs PATH
2313 A list of directories to search for header files
2314 --enable-deterministic
2316 --disable-deterministic
2317 Try to be as deterministic as possible (used by the test
2318 suite)
2319 --ipid IPID
2321 Installed package ID to compile this package as
2322 --cid CID
2324 Installed component ID to compile this component as
2325 --extra-lib-dirs PATH
2327 A list of directories to search for external libraries
2328 --extra-framework-dirs PATH
2330 A list of directories to search for external frameworks
2331 (OS X only)
2332 --extra-prog-path PATH
2334 A list of directories to search for required programs (in
2335 addition to the normal search locations)
2336 --instantiate-with NAME=MOD
2338 A mapping of signature names to concrete module instanti‐
2339 ations.
2340 --enable-tests
2342 --disable-tests
2343 dependency checking and compilation for test suites
2344 listed in the package description file.
2345 --enable-coverage
2347 --disable-coverage
2348 build package with Haskell Program Coverage. (GHC only)
2349 --enable-library-coverage
2351 --disable-library-coverage
2352 build package with Haskell Program Coverage. (GHC only)
2353 (DEPRECATED)
2354 --enable-benchmarks
2356 --disable-benchmarks
2357 dependency checking and compilation for benchmarks listed
2358 in the package description file.
2359 --enable-relocatable
2361 --disable-relocatable
2362 building a package that is relocatable. (GHC only)
2363 --disable-response-files
2365 enable workaround for old versions of programs like "ar"
2366 that do not support @file arguments
2367 --with-alex PATH
2369 give the path to alex
2370 --with-ar PATH
2372 give the path to ar
2373 --with-c2hs PATH
2375 give the path to c2hs
2376 --with-cpphs PATH
2378 give the path to cpphs
2379 --with-doctest PATH
2381 give the path to doctest
2382 --with-gcc PATH
2384 give the path to gcc
2385 --with-ghc PATH
2387 give the path to ghc
2388 --with-ghc-pkg PATH
2390 give the path to ghc-pkg
2391 --with-ghcjs PATH
2393 give the path to ghcjs
2394 --with-ghcjs-pkg PATH
2396 give the path to ghcjs-pkg
2397 --with-greencard PATH
2399 give the path to greencard
2400 --with-haddock PATH
2402 give the path to haddock
2403 --with-happy PATH
2405 give the path to happy
2406 --with-haskell-suite PATH
2408 give the path to haskell-suite
2409 --with-haskell-suite-pkg PATH
2411 give the path to haskell-suite-pkg
2412 --with-hmake PATH
2414 give the path to hmake
2415 --with-hpc PATH
2417 give the path to hpc
2418 --with-hsc2hs PATH
2420 give the path to hsc2hs
2421 --with-hscolour PATH
2423 give the path to hscolour
2424 --with-jhc PATH
2426 give the path to jhc
2427 --with-ld PATH
2429 give the path to ld
2430 --with-pkg-config PATH
2432 give the path to pkg-config
2433 --with-runghc PATH
2435 give the path to runghc
2436 --with-strip PATH
2438 give the path to strip
2439 --with-tar PATH
2441 give the path to tar
2442 --with-uhc PATH
2444 give the path to uhc
2445 --alex-option OPT
2447 give an extra option to alex (no need to quote options
2448 containing spaces)
2449 --ar-option OPT
2451 give an extra option to ar (no need to quote options con‐
2452 taining spaces)
2453 --c2hs-option OPT
2455 give an extra option to c2hs (no need to quote options
2456 containing spaces)
2457 --cpphs-option OPT
2459 give an extra option to cpphs (no need to quote options
2460 containing spaces)
2461 --doctest-option OPT
2463 give an extra option to doctest (no need to quote options
2464 containing spaces)
2465 --gcc-option OPT
2467 give an extra option to gcc (no need to quote options
2468 containing spaces)
2469 --ghc-option OPT
2471 give an extra option to ghc (no need to quote options
2472 containing spaces)
2473 --ghc-pkg-option OPT
2475 give an extra option to ghc-pkg (no need to quote options
2476 containing spaces)
2477 --ghcjs-option OPT
2479 give an extra option to ghcjs (no need to quote options
2480 containing spaces)
2481 --ghcjs-pkg-option OPT
2483 give an extra option to ghcjs-pkg (no need to quote
2484 options containing spaces)
2485 --greencard-option OPT
2487 give an extra option to greencard (no need to quote
2488 options containing spaces)
2489 --haddock-option OPT
2491 give an extra option to haddock (no need to quote options
2492 containing spaces)
2493 --happy-option OPT
2495 give an extra option to happy (no need to quote options
2496 containing spaces)
2497 --haskell-suite-option OPT
2499 give an extra option to haskell-suite (no need to quote
2500 options containing spaces)
2501 --haskell-suite-pkg-option OPT
2503 give an extra option to haskell-suite-pkg (no need to
2504 quote options containing spaces)
2505 --hmake-option OPT
2507 give an extra option to hmake (no need to quote options
2508 containing spaces)
2509 --hpc-option OPT
2511 give an extra option to hpc (no need to quote options
2512 containing spaces)
2513 --hsc2hs-option OPT
2515 give an extra option to hsc2hs (no need to quote options
2516 containing spaces)
2517 --hscolour-option OPT
2519 give an extra option to hscolour (no need to quote
2520 options containing spaces)
2521 --jhc-option OPT
2523 give an extra option to jhc (no need to quote options
2524 containing spaces)
2525 --ld-option OPT
2527 give an extra option to ld (no need to quote options con‐
2528 taining spaces)
2529 --pkg-config-option OPT
2531 give an extra option to pkg-config (no need to quote
2532 options containing spaces)
2533 --runghc-option OPT
2535 give an extra option to runghc (no need to quote options
2536 containing spaces)
2537 --strip-option OPT
2539 give an extra option to strip (no need to quote options
2540 containing spaces)
2541 --tar-option OPT
2543 give an extra option to tar (no need to quote options
2544 containing spaces)
2545 --uhc-option OPT
2547 give an extra option to uhc (no need to quote options
2548 containing spaces)
2549 --alex-options OPTS
2551 give extra options to alex
2552 --ar-options OPTS
2554 give extra options to ar
2555 --c2hs-options OPTS
2557 give extra options to c2hs
2558 --cpphs-options OPTS
2560 give extra options to cpphs
2561 --doctest-options OPTS
2563 give extra options to doctest
2564 --gcc-options OPTS
2566 give extra options to gcc
2567 --ghc-options OPTS
2569 give extra options to ghc
2570 --ghc-pkg-options OPTS
2572 give extra options to ghc-pkg
2573 --ghcjs-options OPTS
2575 give extra options to ghcjs
2576 --ghcjs-pkg-options OPTS
2578 give extra options to ghcjs-pkg
2579 --greencard-options OPTS
2581 give extra options to greencard
2582 --haddock-options OPTS
2584 give extra options to haddock
2585 --happy-options OPTS
2587 give extra options to happy
2588 --haskell-suite-options OPTS
2590 give extra options to haskell-suite
2591 --haskell-suite-pkg-options OPTS
2593 give extra options to haskell-suite-pkg
2594 --hmake-options OPTS
2596 give extra options to hmake
2597 --hpc-options OPTS
2599 give extra options to hpc
2600 --hsc2hs-options OPTS
2602 give extra options to hsc2hs
2603 --hscolour-options OPTS
2605 give extra options to hscolour
2606 --jhc-options OPTS
2608 give extra options to jhc
2609 --ld-options OPTS
2611 give extra options to ld
2612 --pkg-config-options OPTS
2614 give extra options to pkg-config
2615 --runghc-options OPTS
2617 give extra options to runghc
2618 --strip-options OPTS
2620 give extra options to strip
2621 --tar-options OPTS
2623 give extra options to tar
2624 --uhc-options OPTS
2626 give extra options to uhc
2627 --cabal-lib-version VERSION
2629 Select which version of the Cabal lib to use to build
2630 packages (useful for testing).
2631 --constraint CONSTRAINT
2633 Specify constraints on a package (version,
2634 installed/source, flags)
2635 --preference CONSTRAINT
2637 Specify preferences (soft constraints) on the version of
2638 a package
2639 --solver SOLVER
2641 Select dependency solver to use (default: modular).
2642 Choices: modular.
2643 --allow-older [DEPS]
2645 Ignore lower bounds in all dependencies or DEPS
2646 --allow-newer [DEPS]
2648 Ignore upper bounds in all dependencies or DEPS
2649 --enable-documentation
2651 --disable-documentation
2652 building of documentation
2653 --doc-index-file TEMPLATE
2655 A central index of haddock API documentation (template
2656 cannot use $pkgid)
2657 --dry-run
2659 Do not install anything, only print what would be
2660 installed.
2661 --max-backjumps NUM
2663 Maximum number of backjumps allowed while solving
2664 (default: 2000). Use a negative number to enable unlim‐
2665 ited backtracking. Use 0 to disable backtracking com‐
2666 pletely.
2667 --reorder-goals
2669 --no-reorder-goals
2670 Try to reorder goals according to certain heuristics.
2671 Slows things down on average, but may make backtracking
2672 faster for some packages.
2673 --count-conflicts
2675 --no-count-conflicts
2676 Try to speed up solving by preferring goals that are
2677 involved in a lot of conflicts (default).
2678 --independent-goals
2680 --no-independent-goals
2681 Treat several goals on the command line as independent.
2682 If several goals depend on the same package, different
2683 versions can be chosen.
2684 --shadow-installed-packages
2686 --no-shadow-installed-packages
2687 If multiple package instances of the same version are
2688 installed, treat all but one as shadowed.
2689 --strong-flags
2691 --no-strong-flags
2692 Do not defer flag choices (this used to be the default in
2693 cabal-install <= 1.20).
2694 --allow-boot-library-installs
2696 --no-allow-boot-library-installs
2697 Allow cabal to install base, ghc-prim, integer-simple,
2698 integer-gmp, and template-haskell.
2699 --reinstall
2701 --no-reinstall
2702 Install even if it means installing the same version
2703 again.
2704 --avoid-reinstalls
2706 --no-avoid-reinstalls
2707 Do not select versions that would destructively overwrite
2708 installed packages.
2709 --force-reinstalls
2711 --no-force-reinstalls
2712 Reinstall packages even if they will most likely break
2713 other installed packages.
2714 --upgrade-dependencies
2716 --no-upgrade-dependencies
2717 Pick the latest version for all dependencies, rather than
2718 trying to pick an installed version.
2719 --only-dependencies
2721 --no-only-dependencies
2722 Install only the dependencies necessary to build the
2723 given packages
2724 --dependencies-only
2726 --no-dependencies-only
2727 A synonym for --only-dependencies
2728 --index-state STATE
2730 Use source package index state as it existed at a previ‐
2731 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
2732 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
2733 'HEAD' (default: 'HEAD').
2734 --root-cmd COMMAND
2736 (No longer supported, do not use.)
2737 --symlink-bindir DIR
2739 Add symlinks to installed executables into this direc‐
2740 tory.
2741 --build-summary TEMPLATE
2743 Save build summaries to file (name template can use
2744 $pkgid, $compiler, $os, $arch)
2745 --build-log TEMPLATE
2747 Log all builds to file (name template can use $pkgid,
2748 $compiler, $os, $arch)
2749 --remote-build-reporting LEVEL
2751 Generate build reports to send to a remote server (none,
2752 anonymous or detailed).
2753 --report-planning-failure
2755 Generate build reports when the dependency solver fails.
2756 This is used by the Hackage build bot.
2757 --enable-per-component
2759 --disable-per-component
2760 Per-component builds when possible
2761 --one-shot
2763 --no-one-shot
2764 Do not record the packages in the world file.
2765 --run-tests
2767 Run package test suites during installation.
2768 -j, --jobs [NUM]
2770 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
2771 given).
2772 --keep-going
2774 After a build failure, continue to build other unaffected
2775 packages.
2776 --offline
2778 --no-offline
2779 Don't download packages from the Internet.
2780 --project-file FILE
2782 Set the name of the cabal.project file to search for in
2783 parent directories
2784 --only
2786 Only installs the package in the current directory.
2787 --haddock-hoogle
2789 Generate a hoogle database
2790 --haddock-html
2792 Generate HTML documentation (the default)
2793 --haddock-html-location URL
2795 Location of HTML documentation for pre-requisite packages
2796 --haddock-for-hackage
2798 Collection of flags to generate documentation suitable
2799 for upload to hackage
2800 --haddock-executables
2802 Run haddock for Executables targets
2803 --haddock-tests
2805 Run haddock for Test Suite targets
2806 --haddock-benchmarks
2808 Run haddock for Benchmark targets
2809 --haddock-all
2811 Run haddock for all targets
2812 --haddock-internal
2814 Run haddock for internal modules and include all symbols
2815 --haddock-css PATH
2817 Use PATH as the haddock stylesheet
2818 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
2820 dock-hyperlinked-source
2821 Hyperlink the documentation to the source code
2822 --haddock-quickjump
2824 Generate an index for interactive documentation naviga‐
2825 tion
2826 --haddock-hscolour-css PATH
2828 Use PATH as the HsColour stylesheet
2829 --haddock-contents-location URL
2831 Bake URL in as the location for the contents page
2832 cabal new-update
2835 Usage: cabal new-update [FLAGS] [REPOS]
2837 For all known remote repositories, download the package list.
2840 REPO has the format <repo-id>[,<index-state>] where index-state follows
2843 the same format and syntax that is supported by the --index-state flag.
2844 Examples:
2846 cabal new-update
2847 Download the package list for all known remote repositories.
2848 cabal new-update hackage.haskell.org,@1474732068
2850 cabal new-update hackage.haskell.org,2016-09-24T17:47:48Z
2851 cabal new-update hackage.haskell.org,HEAD
2852 cabal new-update hackage.haskell.org
2853 Download hackage.haskell.org at a specific index state.
2854 cabal new update hackage.haskell.org head.hackage
2856 Download hackage.haskell.org and head.hackage
2857 head.hackage must be a known repo-id. E.g. from
2858 your cabal.project(.local) file.
2859 Note: this command is part of the new project-based system (aka nix-
2861 style local builds). These features are currently in beta. Please see
2862 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
2863 details and advice on what you can expect to work. If you encounter
2864 problems please file issues at https://github.com/haskell/cabal/issues
2865 and if you have any time to get involved and help with testing, fixing
2866 bugs etc then that is very much appreciated.
2867 Flags:
2870 -v, --verbose [n]
2871 Control verbosity (n is 0--3, default verbosity level is
2872 1)
2873 --builddir, --distdir, --distpref DIR
2875 The directory where Cabal puts generated build files
2876 (default dist)
2877 -g, --ghc
2879 compile with GHC
2880 --ghcjs
2882 compile with GHCJS
2883 --uhc
2885 compile with UHC
2886 --haskell-suite
2888 compile with a haskell-suite compiler
2889 --cabal-file PATH
2891 use this Cabal file
2892 -w, --with-compiler PATH
2894 give the path to a particular compiler
2895 --with-hc-pkg PATH
2897 give the path to the package tool
2898 --prefix DIR
2900 bake this prefix in preparation of installation
2901 --bindir DIR
2903 installation directory for executables
2904 --libdir DIR
2906 installation directory for libraries
2907 --libsubdir DIR
2909 subdirectory of libdir in which libs are installed
2910 --dynlibdir DIR
2912 installation directory for dynamic libraries
2913 --libexecdir DIR
2915 installation directory for program executables
2916 --libexecsubdir DIR
2918 subdirectory of libexecdir in which private executables
2919 are installed
2920 --datadir DIR
2922 installation directory for read-only data
2923 --datasubdir DIR
2925 subdirectory of datadir in which data files are installed
2926 --docdir DIR
2928 installation directory for documentation
2929 --htmldir DIR
2931 installation directory for HTML documentation
2932 --haddockdir DIR
2934 installation directory for haddock interfaces
2935 --sysconfdir DIR
2937 installation directory for configuration files
2938 --program-prefix PREFIX
2940 prefix to be applied to installed executables
2941 --program-suffix SUFFIX
2943 suffix to be applied to installed executables
2944 --enable-library-vanilla
2946 --disable-library-vanilla
2947 Vanilla libraries
2948 -p, --enable-library-profiling
2950 --disable-library-profiling
2951 Library profiling
2952 --enable-shared
2954 --disable-shared
2955 Shared library
2956 --enable-static
2958 --disable-static
2959 Static library
2960 --enable-executable-dynamic
2962 --disable-executable-dynamic
2963 Executable dynamic linking
2964 --enable-profiling
2966 --disable-profiling
2967 Executable and library profiling
2968 --enable-executable-profiling
2970 --disable-executable-profiling
2971 Executable profiling (DEPRECATED)
2972 --profiling-detail level
2974 Profiling detail level for executable and library
2975 (default, none, exported-functions, toplevel-functions,
2976 all-functions).
2977 --library-profiling-detail level
2979 Profiling detail level for libraries only.
2980 -O, --enable-optimization, --enable-optimisation [n]
2982 Build with optimization (n is 0--2, default is 1)
2983 --disable-optimization, --disable-optimisation
2985 Build without optimization
2986 --enable-debug-info [n]
2988 Emit debug info (n is 0--3, default is 0)
2989 --disable-debug-info
2991 Don't emit debug info
2992 --enable-library-for-ghci
2994 --disable-library-for-ghci
2995 compile library for use with GHCi
2996 --enable-split-sections
2998 --disable-split-sections
2999 compile library code such that unneeded definitions can
3000 be dropped from the final executable (GHC 7.8+)
3001 --enable-split-objs
3003 --disable-split-objs
3004 split library into smaller objects to reduce binary sizes
3005 (GHC 6.6+)
3006 --enable-executable-stripping
3008 --disable-executable-stripping
3009 strip executables upon installation to reduce binary
3010 sizes
3011 --enable-library-stripping
3013 --disable-library-stripping
3014 strip libraries upon installation to reduce binary sizes
3015 --configure-option OPT
3017 Extra option for configure
3018 --user
3020 --global
3021 doing a per-user installation
3022 --package-db DB
3024 Append the given package database to the list of package
3025 databases used (to satisfy dependencies and register
3026 into). May be a specific file, 'global' or 'user'. The
3027 initial list is ['global'], ['global', 'user'], or
3028 ['global', $sandbox], depending on context. Use 'clear'
3029 to reset the list to empty. See the user guide for
3030 details.
3031 -f, --flags FLAGS
3033 Force values for the given flags in Cabal conditionals in
3034 the .cabal file. E.g., --flags="debug -usebytestrings"
3035 forces the flag "debug" to true and "usebytestrings" to
3036 false.
3037 --extra-include-dirs PATH
3039 A list of directories to search for header files
3040 --enable-deterministic
3042 --disable-deterministic
3043 Try to be as deterministic as possible (used by the test
3044 suite)
3045 --ipid IPID
3047 Installed package ID to compile this package as
3048 --cid CID
3050 Installed component ID to compile this component as
3051 --extra-lib-dirs PATH
3053 A list of directories to search for external libraries
3054 --extra-framework-dirs PATH
3056 A list of directories to search for external frameworks
3057 (OS X only)
3058 --extra-prog-path PATH
3060 A list of directories to search for required programs (in
3061 addition to the normal search locations)
3062 --instantiate-with NAME=MOD
3064 A mapping of signature names to concrete module instanti‐
3065 ations.
3066 --enable-tests
3068 --disable-tests
3069 dependency checking and compilation for test suites
3070 listed in the package description file.
3071 --enable-coverage
3073 --disable-coverage
3074 build package with Haskell Program Coverage. (GHC only)
3075 --enable-library-coverage
3077 --disable-library-coverage
3078 build package with Haskell Program Coverage. (GHC only)
3079 (DEPRECATED)
3080 --enable-benchmarks
3082 --disable-benchmarks
3083 dependency checking and compilation for benchmarks listed
3084 in the package description file.
3085 --enable-relocatable
3087 --disable-relocatable
3088 building a package that is relocatable. (GHC only)
3089 --disable-response-files
3091 enable workaround for old versions of programs like "ar"
3092 that do not support @file arguments
3093 --with-alex PATH
3095 give the path to alex
3096 --with-ar PATH
3098 give the path to ar
3099 --with-c2hs PATH
3101 give the path to c2hs
3102 --with-cpphs PATH
3104 give the path to cpphs
3105 --with-doctest PATH
3107 give the path to doctest
3108 --with-gcc PATH
3110 give the path to gcc
3111 --with-ghc PATH
3113 give the path to ghc
3114 --with-ghc-pkg PATH
3116 give the path to ghc-pkg
3117 --with-ghcjs PATH
3119 give the path to ghcjs
3120 --with-ghcjs-pkg PATH
3122 give the path to ghcjs-pkg
3123 --with-greencard PATH
3125 give the path to greencard
3126 --with-haddock PATH
3128 give the path to haddock
3129 --with-happy PATH
3131 give the path to happy
3132 --with-haskell-suite PATH
3134 give the path to haskell-suite
3135 --with-haskell-suite-pkg PATH
3137 give the path to haskell-suite-pkg
3138 --with-hmake PATH
3140 give the path to hmake
3141 --with-hpc PATH
3143 give the path to hpc
3144 --with-hsc2hs PATH
3146 give the path to hsc2hs
3147 --with-hscolour PATH
3149 give the path to hscolour
3150 --with-jhc PATH
3152 give the path to jhc
3153 --with-ld PATH
3155 give the path to ld
3156 --with-pkg-config PATH
3158 give the path to pkg-config
3159 --with-runghc PATH
3161 give the path to runghc
3162 --with-strip PATH
3164 give the path to strip
3165 --with-tar PATH
3167 give the path to tar
3168 --with-uhc PATH
3170 give the path to uhc
3171 --alex-option OPT
3173 give an extra option to alex (no need to quote options
3174 containing spaces)
3175 --ar-option OPT
3177 give an extra option to ar (no need to quote options con‐
3178 taining spaces)
3179 --c2hs-option OPT
3181 give an extra option to c2hs (no need to quote options
3182 containing spaces)
3183 --cpphs-option OPT
3185 give an extra option to cpphs (no need to quote options
3186 containing spaces)
3187 --doctest-option OPT
3189 give an extra option to doctest (no need to quote options
3190 containing spaces)
3191 --gcc-option OPT
3193 give an extra option to gcc (no need to quote options
3194 containing spaces)
3195 --ghc-option OPT
3197 give an extra option to ghc (no need to quote options
3198 containing spaces)
3199 --ghc-pkg-option OPT
3201 give an extra option to ghc-pkg (no need to quote options
3202 containing spaces)
3203 --ghcjs-option OPT
3205 give an extra option to ghcjs (no need to quote options
3206 containing spaces)
3207 --ghcjs-pkg-option OPT
3209 give an extra option to ghcjs-pkg (no need to quote
3210 options containing spaces)
3211 --greencard-option OPT
3213 give an extra option to greencard (no need to quote
3214 options containing spaces)
3215 --haddock-option OPT
3217 give an extra option to haddock (no need to quote options
3218 containing spaces)
3219 --happy-option OPT
3221 give an extra option to happy (no need to quote options
3222 containing spaces)
3223 --haskell-suite-option OPT
3225 give an extra option to haskell-suite (no need to quote
3226 options containing spaces)
3227 --haskell-suite-pkg-option OPT
3229 give an extra option to haskell-suite-pkg (no need to
3230 quote options containing spaces)
3231 --hmake-option OPT
3233 give an extra option to hmake (no need to quote options
3234 containing spaces)
3235 --hpc-option OPT
3237 give an extra option to hpc (no need to quote options
3238 containing spaces)
3239 --hsc2hs-option OPT
3241 give an extra option to hsc2hs (no need to quote options
3242 containing spaces)
3243 --hscolour-option OPT
3245 give an extra option to hscolour (no need to quote
3246 options containing spaces)
3247 --jhc-option OPT
3249 give an extra option to jhc (no need to quote options
3250 containing spaces)
3251 --ld-option OPT
3253 give an extra option to ld (no need to quote options con‐
3254 taining spaces)
3255 --pkg-config-option OPT
3257 give an extra option to pkg-config (no need to quote
3258 options containing spaces)
3259 --runghc-option OPT
3261 give an extra option to runghc (no need to quote options
3262 containing spaces)
3263 --strip-option OPT
3265 give an extra option to strip (no need to quote options
3266 containing spaces)
3267 --tar-option OPT
3269 give an extra option to tar (no need to quote options
3270 containing spaces)
3271 --uhc-option OPT
3273 give an extra option to uhc (no need to quote options
3274 containing spaces)
3275 --alex-options OPTS
3277 give extra options to alex
3278 --ar-options OPTS
3280 give extra options to ar
3281 --c2hs-options OPTS
3283 give extra options to c2hs
3284 --cpphs-options OPTS
3286 give extra options to cpphs
3287 --doctest-options OPTS
3289 give extra options to doctest
3290 --gcc-options OPTS
3292 give extra options to gcc
3293 --ghc-options OPTS
3295 give extra options to ghc
3296 --ghc-pkg-options OPTS
3298 give extra options to ghc-pkg
3299 --ghcjs-options OPTS
3301 give extra options to ghcjs
3302 --ghcjs-pkg-options OPTS
3304 give extra options to ghcjs-pkg
3305 --greencard-options OPTS
3307 give extra options to greencard
3308 --haddock-options OPTS
3310 give extra options to haddock
3311 --happy-options OPTS
3313 give extra options to happy
3314 --haskell-suite-options OPTS
3316 give extra options to haskell-suite
3317 --haskell-suite-pkg-options OPTS
3319 give extra options to haskell-suite-pkg
3320 --hmake-options OPTS
3322 give extra options to hmake
3323 --hpc-options OPTS
3325 give extra options to hpc
3326 --hsc2hs-options OPTS
3328 give extra options to hsc2hs
3329 --hscolour-options OPTS
3331 give extra options to hscolour
3332 --jhc-options OPTS
3334 give extra options to jhc
3335 --ld-options OPTS
3337 give extra options to ld
3338 --pkg-config-options OPTS
3340 give extra options to pkg-config
3341 --runghc-options OPTS
3343 give extra options to runghc
3344 --strip-options OPTS
3346 give extra options to strip
3347 --tar-options OPTS
3349 give extra options to tar
3350 --uhc-options OPTS
3352 give extra options to uhc
3353 --cabal-lib-version VERSION
3355 Select which version of the Cabal lib to use to build
3356 packages (useful for testing).
3357 --constraint CONSTRAINT
3359 Specify constraints on a package (version,
3360 installed/source, flags)
3361 --preference CONSTRAINT
3363 Specify preferences (soft constraints) on the version of
3364 a package
3365 --solver SOLVER
3367 Select dependency solver to use (default: modular).
3368 Choices: modular.
3369 --allow-older [DEPS]
3371 Ignore lower bounds in all dependencies or DEPS
3372 --allow-newer [DEPS]
3374 Ignore upper bounds in all dependencies or DEPS
3375 --enable-documentation
3377 --disable-documentation
3378 building of documentation
3379 --doc-index-file TEMPLATE
3381 A central index of haddock API documentation (template
3382 cannot use $pkgid)
3383 --dry-run
3385 Do not install anything, only print what would be
3386 installed.
3387 --max-backjumps NUM
3389 Maximum number of backjumps allowed while solving
3390 (default: 2000). Use a negative number to enable unlim‐
3391 ited backtracking. Use 0 to disable backtracking com‐
3392 pletely.
3393 --reorder-goals
3395 --no-reorder-goals
3396 Try to reorder goals according to certain heuristics.
3397 Slows things down on average, but may make backtracking
3398 faster for some packages.
3399 --count-conflicts
3401 --no-count-conflicts
3402 Try to speed up solving by preferring goals that are
3403 involved in a lot of conflicts (default).
3404 --independent-goals
3406 --no-independent-goals
3407 Treat several goals on the command line as independent.
3408 If several goals depend on the same package, different
3409 versions can be chosen.
3410 --shadow-installed-packages
3412 --no-shadow-installed-packages
3413 If multiple package instances of the same version are
3414 installed, treat all but one as shadowed.
3415 --strong-flags
3417 --no-strong-flags
3418 Do not defer flag choices (this used to be the default in
3419 cabal-install <= 1.20).
3420 --allow-boot-library-installs
3422 --no-allow-boot-library-installs
3423 Allow cabal to install base, ghc-prim, integer-simple,
3424 integer-gmp, and template-haskell.
3425 --reinstall
3427 --no-reinstall
3428 Install even if it means installing the same version
3429 again.
3430 --avoid-reinstalls
3432 --no-avoid-reinstalls
3433 Do not select versions that would destructively overwrite
3434 installed packages.
3435 --force-reinstalls
3437 --no-force-reinstalls
3438 Reinstall packages even if they will most likely break
3439 other installed packages.
3440 --upgrade-dependencies
3442 --no-upgrade-dependencies
3443 Pick the latest version for all dependencies, rather than
3444 trying to pick an installed version.
3445 --only-dependencies
3447 --no-only-dependencies
3448 Install only the dependencies necessary to build the
3449 given packages
3450 --dependencies-only
3452 --no-dependencies-only
3453 A synonym for --only-dependencies
3454 --index-state STATE
3456 Use source package index state as it existed at a previ‐
3457 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
3458 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
3459 'HEAD' (default: 'HEAD').
3460 --root-cmd COMMAND
3462 (No longer supported, do not use.)
3463 --symlink-bindir DIR
3465 Add symlinks to installed executables into this direc‐
3466 tory.
3467 --build-summary TEMPLATE
3469 Save build summaries to file (name template can use
3470 $pkgid, $compiler, $os, $arch)
3471 --build-log TEMPLATE
3473 Log all builds to file (name template can use $pkgid,
3474 $compiler, $os, $arch)
3475 --remote-build-reporting LEVEL
3477 Generate build reports to send to a remote server (none,
3478 anonymous or detailed).
3479 --report-planning-failure
3481 Generate build reports when the dependency solver fails.
3482 This is used by the Hackage build bot.
3483 --enable-per-component
3485 --disable-per-component
3486 Per-component builds when possible
3487 --one-shot
3489 --no-one-shot
3490 Do not record the packages in the world file.
3491 --run-tests
3493 Run package test suites during installation.
3494 -j, --jobs [NUM]
3496 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
3497 given).
3498 --keep-going
3500 After a build failure, continue to build other unaffected
3501 packages.
3502 --offline
3504 --no-offline
3505 Don't download packages from the Internet.
3506 --project-file FILE
3508 Set the name of the cabal.project file to search for in
3509 parent directories
3510 --only
3512 Only installs the package in the current directory.
3513 --haddock-hoogle
3515 Generate a hoogle database
3516 --haddock-html
3518 Generate HTML documentation (the default)
3519 --haddock-html-location URL
3521 Location of HTML documentation for pre-requisite packages
3522 --haddock-for-hackage
3524 Collection of flags to generate documentation suitable
3525 for upload to hackage
3526 --haddock-executables
3528 Run haddock for Executables targets
3529 --haddock-tests
3531 Run haddock for Test Suite targets
3532 --haddock-benchmarks
3534 Run haddock for Benchmark targets
3535 --haddock-all
3537 Run haddock for all targets
3538 --haddock-internal
3540 Run haddock for internal modules and include all symbols
3541 --haddock-css PATH
3543 Use PATH as the haddock stylesheet
3544 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
3546 dock-hyperlinked-source
3547 Hyperlink the documentation to the source code
3548 --haddock-quickjump
3550 Generate an index for interactive documentation naviga‐
3551 tion
3552 --haddock-hscolour-css PATH
3554 Use PATH as the HsColour stylesheet
3555 --haddock-contents-location URL
3557 Bake URL in as the location for the contents page
3558 cabal v2-build
3561 Usage: cabal v2-build [TARGETS] [FLAGS]
3563 Build one or more targets from within the project. The available tar‐
3566 gets are the packages in the project as well as individual components
3567 within those packages, including libraries, executables, test-suites or
3568 benchmarks. Targets can be specified by name or location. If no target
3569 is specified then the default is to build the package in the current
3570 directory.
3571 Dependencies are built or rebuilt as necessary. Additional configura‐
3573 tion flags can be specified on the command line and these extend the
3574 project configuration from the 'cabal.project', 'cabal.project.local'
3575 and other files.
3576 Build one or more targets from within the project. The available tar‐
3579 gets are the packages in the project as well as individual components
3580 within those packages, including libraries, executables, test-suites or
3581 benchmarks. Targets can be specified by name or location. If no target
3582 is specified then the default is to build the package in the current
3583 directory.
3584 Dependencies are built or rebuilt as necessary. Additional configura‐
3586 tion flags can be specified on the command line and these extend the
3587 project configuration from the 'cabal.project', 'cabal.project.local'
3588 and other files.
3589 Flags:
3592 -v, --verbose [n]
3593 Control verbosity (n is 0--3, default verbosity level is
3594 1)
3595 --builddir, --distdir, --distpref DIR
3597 The directory where Cabal puts generated build files
3598 (default dist)
3599 -g, --ghc
3601 compile with GHC
3602 --ghcjs
3604 compile with GHCJS
3605 --uhc
3607 compile with UHC
3608 --haskell-suite
3610 compile with a haskell-suite compiler
3611 --cabal-file PATH
3613 use this Cabal file
3614 -w, --with-compiler PATH
3616 give the path to a particular compiler
3617 --with-hc-pkg PATH
3619 give the path to the package tool
3620 --prefix DIR
3622 bake this prefix in preparation of installation
3623 --bindir DIR
3625 installation directory for executables
3626 --libdir DIR
3628 installation directory for libraries
3629 --libsubdir DIR
3631 subdirectory of libdir in which libs are installed
3632 --dynlibdir DIR
3634 installation directory for dynamic libraries
3635 --libexecdir DIR
3637 installation directory for program executables
3638 --libexecsubdir DIR
3640 subdirectory of libexecdir in which private executables
3641 are installed
3642 --datadir DIR
3644 installation directory for read-only data
3645 --datasubdir DIR
3647 subdirectory of datadir in which data files are installed
3648 --docdir DIR
3650 installation directory for documentation
3651 --htmldir DIR
3653 installation directory for HTML documentation
3654 --haddockdir DIR
3656 installation directory for haddock interfaces
3657 --sysconfdir DIR
3659 installation directory for configuration files
3660 --program-prefix PREFIX
3662 prefix to be applied to installed executables
3663 --program-suffix SUFFIX
3665 suffix to be applied to installed executables
3666 --enable-library-vanilla
3668 --disable-library-vanilla
3669 Vanilla libraries
3670 -p, --enable-library-profiling
3672 --disable-library-profiling
3673 Library profiling
3674 --enable-shared
3676 --disable-shared
3677 Shared library
3678 --enable-static
3680 --disable-static
3681 Static library
3682 --enable-executable-dynamic
3684 --disable-executable-dynamic
3685 Executable dynamic linking
3686 --enable-profiling
3688 --disable-profiling
3689 Executable and library profiling
3690 --enable-executable-profiling
3692 --disable-executable-profiling
3693 Executable profiling (DEPRECATED)
3694 --profiling-detail level
3696 Profiling detail level for executable and library
3697 (default, none, exported-functions, toplevel-functions,
3698 all-functions).
3699 --library-profiling-detail level
3701 Profiling detail level for libraries only.
3702 -O, --enable-optimization, --enable-optimisation [n]
3704 Build with optimization (n is 0--2, default is 1)
3705 --disable-optimization, --disable-optimisation
3707 Build without optimization
3708 --enable-debug-info [n]
3710 Emit debug info (n is 0--3, default is 0)
3711 --disable-debug-info
3713 Don't emit debug info
3714 --enable-library-for-ghci
3716 --disable-library-for-ghci
3717 compile library for use with GHCi
3718 --enable-split-sections
3720 --disable-split-sections
3721 compile library code such that unneeded definitions can
3722 be dropped from the final executable (GHC 7.8+)
3723 --enable-split-objs
3725 --disable-split-objs
3726 split library into smaller objects to reduce binary sizes
3727 (GHC 6.6+)
3728 --enable-executable-stripping
3730 --disable-executable-stripping
3731 strip executables upon installation to reduce binary
3732 sizes
3733 --enable-library-stripping
3735 --disable-library-stripping
3736 strip libraries upon installation to reduce binary sizes
3737 --configure-option OPT
3739 Extra option for configure
3740 --user
3742 --global
3743 doing a per-user installation
3744 --package-db DB
3746 Append the given package database to the list of package
3747 databases used (to satisfy dependencies and register
3748 into). May be a specific file, 'global' or 'user'. The
3749 initial list is ['global'], ['global', 'user'], or
3750 ['global', $sandbox], depending on context. Use 'clear'
3751 to reset the list to empty. See the user guide for
3752 details.
3753 -f, --flags FLAGS
3755 Force values for the given flags in Cabal conditionals in
3756 the .cabal file. E.g., --flags="debug -usebytestrings"
3757 forces the flag "debug" to true and "usebytestrings" to
3758 false.
3759 --extra-include-dirs PATH
3761 A list of directories to search for header files
3762 --enable-deterministic
3764 --disable-deterministic
3765 Try to be as deterministic as possible (used by the test
3766 suite)
3767 --ipid IPID
3769 Installed package ID to compile this package as
3770 --cid CID
3772 Installed component ID to compile this component as
3773 --extra-lib-dirs PATH
3775 A list of directories to search for external libraries
3776 --extra-framework-dirs PATH
3778 A list of directories to search for external frameworks
3779 (OS X only)
3780 --extra-prog-path PATH
3782 A list of directories to search for required programs (in
3783 addition to the normal search locations)
3784 --instantiate-with NAME=MOD
3786 A mapping of signature names to concrete module instanti‐
3787 ations.
3788 --enable-tests
3790 --disable-tests
3791 dependency checking and compilation for test suites
3792 listed in the package description file.
3793 --enable-coverage
3795 --disable-coverage
3796 build package with Haskell Program Coverage. (GHC only)
3797 --enable-library-coverage
3799 --disable-library-coverage
3800 build package with Haskell Program Coverage. (GHC only)
3801 (DEPRECATED)
3802 --enable-benchmarks
3804 --disable-benchmarks
3805 dependency checking and compilation for benchmarks listed
3806 in the package description file.
3807 --enable-relocatable
3809 --disable-relocatable
3810 building a package that is relocatable. (GHC only)
3811 --disable-response-files
3813 enable workaround for old versions of programs like "ar"
3814 that do not support @file arguments
3815 --with-alex PATH
3817 give the path to alex
3818 --with-ar PATH
3820 give the path to ar
3821 --with-c2hs PATH
3823 give the path to c2hs
3824 --with-cpphs PATH
3826 give the path to cpphs
3827 --with-doctest PATH
3829 give the path to doctest
3830 --with-gcc PATH
3832 give the path to gcc
3833 --with-ghc PATH
3835 give the path to ghc
3836 --with-ghc-pkg PATH
3838 give the path to ghc-pkg
3839 --with-ghcjs PATH
3841 give the path to ghcjs
3842 --with-ghcjs-pkg PATH
3844 give the path to ghcjs-pkg
3845 --with-greencard PATH
3847 give the path to greencard
3848 --with-haddock PATH
3850 give the path to haddock
3851 --with-happy PATH
3853 give the path to happy
3854 --with-haskell-suite PATH
3856 give the path to haskell-suite
3857 --with-haskell-suite-pkg PATH
3859 give the path to haskell-suite-pkg
3860 --with-hmake PATH
3862 give the path to hmake
3863 --with-hpc PATH
3865 give the path to hpc
3866 --with-hsc2hs PATH
3868 give the path to hsc2hs
3869 --with-hscolour PATH
3871 give the path to hscolour
3872 --with-jhc PATH
3874 give the path to jhc
3875 --with-ld PATH
3877 give the path to ld
3878 --with-pkg-config PATH
3880 give the path to pkg-config
3881 --with-runghc PATH
3883 give the path to runghc
3884 --with-strip PATH
3886 give the path to strip
3887 --with-tar PATH
3889 give the path to tar
3890 --with-uhc PATH
3892 give the path to uhc
3893 --alex-option OPT
3895 give an extra option to alex (no need to quote options
3896 containing spaces)
3897 --ar-option OPT
3899 give an extra option to ar (no need to quote options con‐
3900 taining spaces)
3901 --c2hs-option OPT
3903 give an extra option to c2hs (no need to quote options
3904 containing spaces)
3905 --cpphs-option OPT
3907 give an extra option to cpphs (no need to quote options
3908 containing spaces)
3909 --doctest-option OPT
3911 give an extra option to doctest (no need to quote options
3912 containing spaces)
3913 --gcc-option OPT
3915 give an extra option to gcc (no need to quote options
3916 containing spaces)
3917 --ghc-option OPT
3919 give an extra option to ghc (no need to quote options
3920 containing spaces)
3921 --ghc-pkg-option OPT
3923 give an extra option to ghc-pkg (no need to quote options
3924 containing spaces)
3925 --ghcjs-option OPT
3927 give an extra option to ghcjs (no need to quote options
3928 containing spaces)
3929 --ghcjs-pkg-option OPT
3931 give an extra option to ghcjs-pkg (no need to quote
3932 options containing spaces)
3933 --greencard-option OPT
3935 give an extra option to greencard (no need to quote
3936 options containing spaces)
3937 --haddock-option OPT
3939 give an extra option to haddock (no need to quote options
3940 containing spaces)
3941 --happy-option OPT
3943 give an extra option to happy (no need to quote options
3944 containing spaces)
3945 --haskell-suite-option OPT
3947 give an extra option to haskell-suite (no need to quote
3948 options containing spaces)
3949 --haskell-suite-pkg-option OPT
3951 give an extra option to haskell-suite-pkg (no need to
3952 quote options containing spaces)
3953 --hmake-option OPT
3955 give an extra option to hmake (no need to quote options
3956 containing spaces)
3957 --hpc-option OPT
3959 give an extra option to hpc (no need to quote options
3960 containing spaces)
3961 --hsc2hs-option OPT
3963 give an extra option to hsc2hs (no need to quote options
3964 containing spaces)
3965 --hscolour-option OPT
3967 give an extra option to hscolour (no need to quote
3968 options containing spaces)
3969 --jhc-option OPT
3971 give an extra option to jhc (no need to quote options
3972 containing spaces)
3973 --ld-option OPT
3975 give an extra option to ld (no need to quote options con‐
3976 taining spaces)
3977 --pkg-config-option OPT
3979 give an extra option to pkg-config (no need to quote
3980 options containing spaces)
3981 --runghc-option OPT
3983 give an extra option to runghc (no need to quote options
3984 containing spaces)
3985 --strip-option OPT
3987 give an extra option to strip (no need to quote options
3988 containing spaces)
3989 --tar-option OPT
3991 give an extra option to tar (no need to quote options
3992 containing spaces)
3993 --uhc-option OPT
3995 give an extra option to uhc (no need to quote options
3996 containing spaces)
3997 --alex-options OPTS
3999 give extra options to alex
4000 --ar-options OPTS
4002 give extra options to ar
4003 --c2hs-options OPTS
4005 give extra options to c2hs
4006 --cpphs-options OPTS
4008 give extra options to cpphs
4009 --doctest-options OPTS
4011 give extra options to doctest
4012 --gcc-options OPTS
4014 give extra options to gcc
4015 --ghc-options OPTS
4017 give extra options to ghc
4018 --ghc-pkg-options OPTS
4020 give extra options to ghc-pkg
4021 --ghcjs-options OPTS
4023 give extra options to ghcjs
4024 --ghcjs-pkg-options OPTS
4026 give extra options to ghcjs-pkg
4027 --greencard-options OPTS
4029 give extra options to greencard
4030 --haddock-options OPTS
4032 give extra options to haddock
4033 --happy-options OPTS
4035 give extra options to happy
4036 --haskell-suite-options OPTS
4038 give extra options to haskell-suite
4039 --haskell-suite-pkg-options OPTS
4041 give extra options to haskell-suite-pkg
4042 --hmake-options OPTS
4044 give extra options to hmake
4045 --hpc-options OPTS
4047 give extra options to hpc
4048 --hsc2hs-options OPTS
4050 give extra options to hsc2hs
4051 --hscolour-options OPTS
4053 give extra options to hscolour
4054 --jhc-options OPTS
4056 give extra options to jhc
4057 --ld-options OPTS
4059 give extra options to ld
4060 --pkg-config-options OPTS
4062 give extra options to pkg-config
4063 --runghc-options OPTS
4065 give extra options to runghc
4066 --strip-options OPTS
4068 give extra options to strip
4069 --tar-options OPTS
4071 give extra options to tar
4072 --uhc-options OPTS
4074 give extra options to uhc
4075 --cabal-lib-version VERSION
4077 Select which version of the Cabal lib to use to build
4078 packages (useful for testing).
4079 --constraint CONSTRAINT
4081 Specify constraints on a package (version,
4082 installed/source, flags)
4083 --preference CONSTRAINT
4085 Specify preferences (soft constraints) on the version of
4086 a package
4087 --solver SOLVER
4089 Select dependency solver to use (default: modular).
4090 Choices: modular.
4091 --allow-older [DEPS]
4093 Ignore lower bounds in all dependencies or DEPS
4094 --allow-newer [DEPS]
4096 Ignore upper bounds in all dependencies or DEPS
4097 --enable-documentation
4099 --disable-documentation
4100 building of documentation
4101 --doc-index-file TEMPLATE
4103 A central index of haddock API documentation (template
4104 cannot use $pkgid)
4105 --dry-run
4107 Do not install anything, only print what would be
4108 installed.
4109 --max-backjumps NUM
4111 Maximum number of backjumps allowed while solving
4112 (default: 2000). Use a negative number to enable unlim‐
4113 ited backtracking. Use 0 to disable backtracking com‐
4114 pletely.
4115 --reorder-goals
4117 --no-reorder-goals
4118 Try to reorder goals according to certain heuristics.
4119 Slows things down on average, but may make backtracking
4120 faster for some packages.
4121 --count-conflicts
4123 --no-count-conflicts
4124 Try to speed up solving by preferring goals that are
4125 involved in a lot of conflicts (default).
4126 --independent-goals
4128 --no-independent-goals
4129 Treat several goals on the command line as independent.
4130 If several goals depend on the same package, different
4131 versions can be chosen.
4132 --shadow-installed-packages
4134 --no-shadow-installed-packages
4135 If multiple package instances of the same version are
4136 installed, treat all but one as shadowed.
4137 --strong-flags
4139 --no-strong-flags
4140 Do not defer flag choices (this used to be the default in
4141 cabal-install <= 1.20).
4142 --allow-boot-library-installs
4144 --no-allow-boot-library-installs
4145 Allow cabal to install base, ghc-prim, integer-simple,
4146 integer-gmp, and template-haskell.
4147 --reinstall
4149 --no-reinstall
4150 Install even if it means installing the same version
4151 again.
4152 --avoid-reinstalls
4154 --no-avoid-reinstalls
4155 Do not select versions that would destructively overwrite
4156 installed packages.
4157 --force-reinstalls
4159 --no-force-reinstalls
4160 Reinstall packages even if they will most likely break
4161 other installed packages.
4162 --upgrade-dependencies
4164 --no-upgrade-dependencies
4165 Pick the latest version for all dependencies, rather than
4166 trying to pick an installed version.
4167 --only-dependencies
4169 --no-only-dependencies
4170 Install only the dependencies necessary to build the
4171 given packages
4172 --dependencies-only
4174 --no-dependencies-only
4175 A synonym for --only-dependencies
4176 --index-state STATE
4178 Use source package index state as it existed at a previ‐
4179 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
4180 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
4181 'HEAD' (default: 'HEAD').
4182 --root-cmd COMMAND
4184 (No longer supported, do not use.)
4185 --symlink-bindir DIR
4187 Add symlinks to installed executables into this direc‐
4188 tory.
4189 --build-summary TEMPLATE
4191 Save build summaries to file (name template can use
4192 $pkgid, $compiler, $os, $arch)
4193 --build-log TEMPLATE
4195 Log all builds to file (name template can use $pkgid,
4196 $compiler, $os, $arch)
4197 --remote-build-reporting LEVEL
4199 Generate build reports to send to a remote server (none,
4200 anonymous or detailed).
4201 --report-planning-failure
4203 Generate build reports when the dependency solver fails.
4204 This is used by the Hackage build bot.
4205 --enable-per-component
4207 --disable-per-component
4208 Per-component builds when possible
4209 --one-shot
4211 --no-one-shot
4212 Do not record the packages in the world file.
4213 --run-tests
4215 Run package test suites during installation.
4216 -j, --jobs [NUM]
4218 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
4219 given).
4220 --keep-going
4222 After a build failure, continue to build other unaffected
4223 packages.
4224 --offline
4226 --no-offline
4227 Don't download packages from the Internet.
4228 --project-file FILE
4230 Set the name of the cabal.project file to search for in
4231 parent directories
4232 --only
4234 Only installs the package in the current directory.
4235 --haddock-hoogle
4237 Generate a hoogle database
4238 --haddock-html
4240 Generate HTML documentation (the default)
4241 --haddock-html-location URL
4243 Location of HTML documentation for pre-requisite packages
4244 --haddock-for-hackage
4246 Collection of flags to generate documentation suitable
4247 for upload to hackage
4248 --haddock-executables
4250 Run haddock for Executables targets
4251 --haddock-tests
4253 Run haddock for Test Suite targets
4254 --haddock-benchmarks
4256 Run haddock for Benchmark targets
4257 --haddock-all
4259 Run haddock for all targets
4260 --haddock-internal
4262 Run haddock for internal modules and include all symbols
4263 --haddock-css PATH
4265 Use PATH as the haddock stylesheet
4266 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
4268 dock-hyperlinked-source
4269 Hyperlink the documentation to the source code
4270 --haddock-quickjump
4272 Generate an index for interactive documentation naviga‐
4273 tion
4274 --haddock-hscolour-css PATH
4276 Use PATH as the HsColour stylesheet
4277 --haddock-contents-location URL
4279 Bake URL in as the location for the contents page
4280 cabal new-build
4283 Usage: cabal new-build [TARGETS] [FLAGS]
4285 Build one or more targets from within the project. The available tar‐
4288 gets are the packages in the project as well as individual components
4289 within those packages, including libraries, executables, test-suites or
4290 benchmarks. Targets can be specified by name or location. If no target
4291 is specified then the default is to build the package in the current
4292 directory.
4293 Dependencies are built or rebuilt as necessary. Additional configura‐
4295 tion flags can be specified on the command line and these extend the
4296 project configuration from the 'cabal.project', 'cabal.project.local'
4297 and other files.
4298 Examples:
4301 cabal new-build
4302 Build the package in the current directory or all packages in the
4303 project
4304 cabal new-build pkgname
4305 Build the package named pkgname in the project
4306 cabal new-build ./pkgfoo
4307 Build the package in the ./pkgfoo directory
4308 cabal new-build cname
4309 Build the component named cname in the project
4310 cabal new-build cname --enable-profiling
4311 Build the component in profiling mode (including dependencies as
4312 needed)
4313 Note: this command is part of the new project-based system (aka nix-
4315 style local builds). These features are currently in beta. Please see
4316 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
4317 details and advice on what you can expect to work. If you encounter
4318 problems please file issues at https://github.com/haskell/cabal/issues
4319 and if you have any time to get involved and help with testing, fixing
4320 bugs etc then that is very much appreciated.
4321 Flags:
4324 -v, --verbose [n]
4325 Control verbosity (n is 0--3, default verbosity level is
4326 1)
4327 --builddir, --distdir, --distpref DIR
4329 The directory where Cabal puts generated build files
4330 (default dist)
4331 -g, --ghc
4333 compile with GHC
4334 --ghcjs
4336 compile with GHCJS
4337 --uhc
4339 compile with UHC
4340 --haskell-suite
4342 compile with a haskell-suite compiler
4343 --cabal-file PATH
4345 use this Cabal file
4346 -w, --with-compiler PATH
4348 give the path to a particular compiler
4349 --with-hc-pkg PATH
4351 give the path to the package tool
4352 --prefix DIR
4354 bake this prefix in preparation of installation
4355 --bindir DIR
4357 installation directory for executables
4358 --libdir DIR
4360 installation directory for libraries
4361 --libsubdir DIR
4363 subdirectory of libdir in which libs are installed
4364 --dynlibdir DIR
4366 installation directory for dynamic libraries
4367 --libexecdir DIR
4369 installation directory for program executables
4370 --libexecsubdir DIR
4372 subdirectory of libexecdir in which private executables
4373 are installed
4374 --datadir DIR
4376 installation directory for read-only data
4377 --datasubdir DIR
4379 subdirectory of datadir in which data files are installed
4380 --docdir DIR
4382 installation directory for documentation
4383 --htmldir DIR
4385 installation directory for HTML documentation
4386 --haddockdir DIR
4388 installation directory for haddock interfaces
4389 --sysconfdir DIR
4391 installation directory for configuration files
4392 --program-prefix PREFIX
4394 prefix to be applied to installed executables
4395 --program-suffix SUFFIX
4397 suffix to be applied to installed executables
4398 --enable-library-vanilla
4400 --disable-library-vanilla
4401 Vanilla libraries
4402 -p, --enable-library-profiling
4404 --disable-library-profiling
4405 Library profiling
4406 --enable-shared
4408 --disable-shared
4409 Shared library
4410 --enable-static
4412 --disable-static
4413 Static library
4414 --enable-executable-dynamic
4416 --disable-executable-dynamic
4417 Executable dynamic linking
4418 --enable-profiling
4420 --disable-profiling
4421 Executable and library profiling
4422 --enable-executable-profiling
4424 --disable-executable-profiling
4425 Executable profiling (DEPRECATED)
4426 --profiling-detail level
4428 Profiling detail level for executable and library
4429 (default, none, exported-functions, toplevel-functions,
4430 all-functions).
4431 --library-profiling-detail level
4433 Profiling detail level for libraries only.
4434 -O, --enable-optimization, --enable-optimisation [n]
4436 Build with optimization (n is 0--2, default is 1)
4437 --disable-optimization, --disable-optimisation
4439 Build without optimization
4440 --enable-debug-info [n]
4442 Emit debug info (n is 0--3, default is 0)
4443 --disable-debug-info
4445 Don't emit debug info
4446 --enable-library-for-ghci
4448 --disable-library-for-ghci
4449 compile library for use with GHCi
4450 --enable-split-sections
4452 --disable-split-sections
4453 compile library code such that unneeded definitions can
4454 be dropped from the final executable (GHC 7.8+)
4455 --enable-split-objs
4457 --disable-split-objs
4458 split library into smaller objects to reduce binary sizes
4459 (GHC 6.6+)
4460 --enable-executable-stripping
4462 --disable-executable-stripping
4463 strip executables upon installation to reduce binary
4464 sizes
4465 --enable-library-stripping
4467 --disable-library-stripping
4468 strip libraries upon installation to reduce binary sizes
4469 --configure-option OPT
4471 Extra option for configure
4472 --user
4474 --global
4475 doing a per-user installation
4476 --package-db DB
4478 Append the given package database to the list of package
4479 databases used (to satisfy dependencies and register
4480 into). May be a specific file, 'global' or 'user'. The
4481 initial list is ['global'], ['global', 'user'], or
4482 ['global', $sandbox], depending on context. Use 'clear'
4483 to reset the list to empty. See the user guide for
4484 details.
4485 -f, --flags FLAGS
4487 Force values for the given flags in Cabal conditionals in
4488 the .cabal file. E.g., --flags="debug -usebytestrings"
4489 forces the flag "debug" to true and "usebytestrings" to
4490 false.
4491 --extra-include-dirs PATH
4493 A list of directories to search for header files
4494 --enable-deterministic
4496 --disable-deterministic
4497 Try to be as deterministic as possible (used by the test
4498 suite)
4499 --ipid IPID
4501 Installed package ID to compile this package as
4502 --cid CID
4504 Installed component ID to compile this component as
4505 --extra-lib-dirs PATH
4507 A list of directories to search for external libraries
4508 --extra-framework-dirs PATH
4510 A list of directories to search for external frameworks
4511 (OS X only)
4512 --extra-prog-path PATH
4514 A list of directories to search for required programs (in
4515 addition to the normal search locations)
4516 --instantiate-with NAME=MOD
4518 A mapping of signature names to concrete module instanti‐
4519 ations.
4520 --enable-tests
4522 --disable-tests
4523 dependency checking and compilation for test suites
4524 listed in the package description file.
4525 --enable-coverage
4527 --disable-coverage
4528 build package with Haskell Program Coverage. (GHC only)
4529 --enable-library-coverage
4531 --disable-library-coverage
4532 build package with Haskell Program Coverage. (GHC only)
4533 (DEPRECATED)
4534 --enable-benchmarks
4536 --disable-benchmarks
4537 dependency checking and compilation for benchmarks listed
4538 in the package description file.
4539 --enable-relocatable
4541 --disable-relocatable
4542 building a package that is relocatable. (GHC only)
4543 --disable-response-files
4545 enable workaround for old versions of programs like "ar"
4546 that do not support @file arguments
4547 --with-alex PATH
4549 give the path to alex
4550 --with-ar PATH
4552 give the path to ar
4553 --with-c2hs PATH
4555 give the path to c2hs
4556 --with-cpphs PATH
4558 give the path to cpphs
4559 --with-doctest PATH
4561 give the path to doctest
4562 --with-gcc PATH
4564 give the path to gcc
4565 --with-ghc PATH
4567 give the path to ghc
4568 --with-ghc-pkg PATH
4570 give the path to ghc-pkg
4571 --with-ghcjs PATH
4573 give the path to ghcjs
4574 --with-ghcjs-pkg PATH
4576 give the path to ghcjs-pkg
4577 --with-greencard PATH
4579 give the path to greencard
4580 --with-haddock PATH
4582 give the path to haddock
4583 --with-happy PATH
4585 give the path to happy
4586 --with-haskell-suite PATH
4588 give the path to haskell-suite
4589 --with-haskell-suite-pkg PATH
4591 give the path to haskell-suite-pkg
4592 --with-hmake PATH
4594 give the path to hmake
4595 --with-hpc PATH
4597 give the path to hpc
4598 --with-hsc2hs PATH
4600 give the path to hsc2hs
4601 --with-hscolour PATH
4603 give the path to hscolour
4604 --with-jhc PATH
4606 give the path to jhc
4607 --with-ld PATH
4609 give the path to ld
4610 --with-pkg-config PATH
4612 give the path to pkg-config
4613 --with-runghc PATH
4615 give the path to runghc
4616 --with-strip PATH
4618 give the path to strip
4619 --with-tar PATH
4621 give the path to tar
4622 --with-uhc PATH
4624 give the path to uhc
4625 --alex-option OPT
4627 give an extra option to alex (no need to quote options
4628 containing spaces)
4629 --ar-option OPT
4631 give an extra option to ar (no need to quote options con‐
4632 taining spaces)
4633 --c2hs-option OPT
4635 give an extra option to c2hs (no need to quote options
4636 containing spaces)
4637 --cpphs-option OPT
4639 give an extra option to cpphs (no need to quote options
4640 containing spaces)
4641 --doctest-option OPT
4643 give an extra option to doctest (no need to quote options
4644 containing spaces)
4645 --gcc-option OPT
4647 give an extra option to gcc (no need to quote options
4648 containing spaces)
4649 --ghc-option OPT
4651 give an extra option to ghc (no need to quote options
4652 containing spaces)
4653 --ghc-pkg-option OPT
4655 give an extra option to ghc-pkg (no need to quote options
4656 containing spaces)
4657 --ghcjs-option OPT
4659 give an extra option to ghcjs (no need to quote options
4660 containing spaces)
4661 --ghcjs-pkg-option OPT
4663 give an extra option to ghcjs-pkg (no need to quote
4664 options containing spaces)
4665 --greencard-option OPT
4667 give an extra option to greencard (no need to quote
4668 options containing spaces)
4669 --haddock-option OPT
4671 give an extra option to haddock (no need to quote options
4672 containing spaces)
4673 --happy-option OPT
4675 give an extra option to happy (no need to quote options
4676 containing spaces)
4677 --haskell-suite-option OPT
4679 give an extra option to haskell-suite (no need to quote
4680 options containing spaces)
4681 --haskell-suite-pkg-option OPT
4683 give an extra option to haskell-suite-pkg (no need to
4684 quote options containing spaces)
4685 --hmake-option OPT
4687 give an extra option to hmake (no need to quote options
4688 containing spaces)
4689 --hpc-option OPT
4691 give an extra option to hpc (no need to quote options
4692 containing spaces)
4693 --hsc2hs-option OPT
4695 give an extra option to hsc2hs (no need to quote options
4696 containing spaces)
4697 --hscolour-option OPT
4699 give an extra option to hscolour (no need to quote
4700 options containing spaces)
4701 --jhc-option OPT
4703 give an extra option to jhc (no need to quote options
4704 containing spaces)
4705 --ld-option OPT
4707 give an extra option to ld (no need to quote options con‐
4708 taining spaces)
4709 --pkg-config-option OPT
4711 give an extra option to pkg-config (no need to quote
4712 options containing spaces)
4713 --runghc-option OPT
4715 give an extra option to runghc (no need to quote options
4716 containing spaces)
4717 --strip-option OPT
4719 give an extra option to strip (no need to quote options
4720 containing spaces)
4721 --tar-option OPT
4723 give an extra option to tar (no need to quote options
4724 containing spaces)
4725 --uhc-option OPT
4727 give an extra option to uhc (no need to quote options
4728 containing spaces)
4729 --alex-options OPTS
4731 give extra options to alex
4732 --ar-options OPTS
4734 give extra options to ar
4735 --c2hs-options OPTS
4737 give extra options to c2hs
4738 --cpphs-options OPTS
4740 give extra options to cpphs
4741 --doctest-options OPTS
4743 give extra options to doctest
4744 --gcc-options OPTS
4746 give extra options to gcc
4747 --ghc-options OPTS
4749 give extra options to ghc
4750 --ghc-pkg-options OPTS
4752 give extra options to ghc-pkg
4753 --ghcjs-options OPTS
4755 give extra options to ghcjs
4756 --ghcjs-pkg-options OPTS
4758 give extra options to ghcjs-pkg
4759 --greencard-options OPTS
4761 give extra options to greencard
4762 --haddock-options OPTS
4764 give extra options to haddock
4765 --happy-options OPTS
4767 give extra options to happy
4768 --haskell-suite-options OPTS
4770 give extra options to haskell-suite
4771 --haskell-suite-pkg-options OPTS
4773 give extra options to haskell-suite-pkg
4774 --hmake-options OPTS
4776 give extra options to hmake
4777 --hpc-options OPTS
4779 give extra options to hpc
4780 --hsc2hs-options OPTS
4782 give extra options to hsc2hs
4783 --hscolour-options OPTS
4785 give extra options to hscolour
4786 --jhc-options OPTS
4788 give extra options to jhc
4789 --ld-options OPTS
4791 give extra options to ld
4792 --pkg-config-options OPTS
4794 give extra options to pkg-config
4795 --runghc-options OPTS
4797 give extra options to runghc
4798 --strip-options OPTS
4800 give extra options to strip
4801 --tar-options OPTS
4803 give extra options to tar
4804 --uhc-options OPTS
4806 give extra options to uhc
4807 --cabal-lib-version VERSION
4809 Select which version of the Cabal lib to use to build
4810 packages (useful for testing).
4811 --constraint CONSTRAINT
4813 Specify constraints on a package (version,
4814 installed/source, flags)
4815 --preference CONSTRAINT
4817 Specify preferences (soft constraints) on the version of
4818 a package
4819 --solver SOLVER
4821 Select dependency solver to use (default: modular).
4822 Choices: modular.
4823 --allow-older [DEPS]
4825 Ignore lower bounds in all dependencies or DEPS
4826 --allow-newer [DEPS]
4828 Ignore upper bounds in all dependencies or DEPS
4829 --enable-documentation
4831 --disable-documentation
4832 building of documentation
4833 --doc-index-file TEMPLATE
4835 A central index of haddock API documentation (template
4836 cannot use $pkgid)
4837 --dry-run
4839 Do not install anything, only print what would be
4840 installed.
4841 --max-backjumps NUM
4843 Maximum number of backjumps allowed while solving
4844 (default: 2000). Use a negative number to enable unlim‐
4845 ited backtracking. Use 0 to disable backtracking com‐
4846 pletely.
4847 --reorder-goals
4849 --no-reorder-goals
4850 Try to reorder goals according to certain heuristics.
4851 Slows things down on average, but may make backtracking
4852 faster for some packages.
4853 --count-conflicts
4855 --no-count-conflicts
4856 Try to speed up solving by preferring goals that are
4857 involved in a lot of conflicts (default).
4858 --independent-goals
4860 --no-independent-goals
4861 Treat several goals on the command line as independent.
4862 If several goals depend on the same package, different
4863 versions can be chosen.
4864 --shadow-installed-packages
4866 --no-shadow-installed-packages
4867 If multiple package instances of the same version are
4868 installed, treat all but one as shadowed.
4869 --strong-flags
4871 --no-strong-flags
4872 Do not defer flag choices (this used to be the default in
4873 cabal-install <= 1.20).
4874 --allow-boot-library-installs
4876 --no-allow-boot-library-installs
4877 Allow cabal to install base, ghc-prim, integer-simple,
4878 integer-gmp, and template-haskell.
4879 --reinstall
4881 --no-reinstall
4882 Install even if it means installing the same version
4883 again.
4884 --avoid-reinstalls
4886 --no-avoid-reinstalls
4887 Do not select versions that would destructively overwrite
4888 installed packages.
4889 --force-reinstalls
4891 --no-force-reinstalls
4892 Reinstall packages even if they will most likely break
4893 other installed packages.
4894 --upgrade-dependencies
4896 --no-upgrade-dependencies
4897 Pick the latest version for all dependencies, rather than
4898 trying to pick an installed version.
4899 --only-dependencies
4901 --no-only-dependencies
4902 Install only the dependencies necessary to build the
4903 given packages
4904 --dependencies-only
4906 --no-dependencies-only
4907 A synonym for --only-dependencies
4908 --index-state STATE
4910 Use source package index state as it existed at a previ‐
4911 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
4912 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
4913 'HEAD' (default: 'HEAD').
4914 --root-cmd COMMAND
4916 (No longer supported, do not use.)
4917 --symlink-bindir DIR
4919 Add symlinks to installed executables into this direc‐
4920 tory.
4921 --build-summary TEMPLATE
4923 Save build summaries to file (name template can use
4924 $pkgid, $compiler, $os, $arch)
4925 --build-log TEMPLATE
4927 Log all builds to file (name template can use $pkgid,
4928 $compiler, $os, $arch)
4929 --remote-build-reporting LEVEL
4931 Generate build reports to send to a remote server (none,
4932 anonymous or detailed).
4933 --report-planning-failure
4935 Generate build reports when the dependency solver fails.
4936 This is used by the Hackage build bot.
4937 --enable-per-component
4939 --disable-per-component
4940 Per-component builds when possible
4941 --one-shot
4943 --no-one-shot
4944 Do not record the packages in the world file.
4945 --run-tests
4947 Run package test suites during installation.
4948 -j, --jobs [NUM]
4950 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
4951 given).
4952 --keep-going
4954 After a build failure, continue to build other unaffected
4955 packages.
4956 --offline
4958 --no-offline
4959 Don't download packages from the Internet.
4960 --project-file FILE
4962 Set the name of the cabal.project file to search for in
4963 parent directories
4964 --only
4966 Only installs the package in the current directory.
4967 --haddock-hoogle
4969 Generate a hoogle database
4970 --haddock-html
4972 Generate HTML documentation (the default)
4973 --haddock-html-location URL
4975 Location of HTML documentation for pre-requisite packages
4976 --haddock-for-hackage
4978 Collection of flags to generate documentation suitable
4979 for upload to hackage
4980 --haddock-executables
4982 Run haddock for Executables targets
4983 --haddock-tests
4985 Run haddock for Test Suite targets
4986 --haddock-benchmarks
4988 Run haddock for Benchmark targets
4989 --haddock-all
4991 Run haddock for all targets
4992 --haddock-internal
4994 Run haddock for internal modules and include all symbols
4995 --haddock-css PATH
4997 Use PATH as the haddock stylesheet
4998 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
5000 dock-hyperlinked-source
5001 Hyperlink the documentation to the source code
5002 --haddock-quickjump
5004 Generate an index for interactive documentation naviga‐
5005 tion
5006 --haddock-hscolour-css PATH
5008 Use PATH as the HsColour stylesheet
5009 --haddock-contents-location URL
5011 Bake URL in as the location for the contents page
5012 cabal v2-repl
5015 Usage: cabal v2-repl [TARGET] [FLAGS]
5017 Open an interactive session for a component within the project. The
5020 available targets are the same as for the 'v2-build' command: individ‐
5021 ual components within packages in the project, including libraries,
5022 executables, test-suites or benchmarks. Packages can also be specified
5023 in which case the library component in the package will be used, or the
5024 (first listed) executable in the package if there is no library.
5025 Dependencies are built or rebuilt as necessary. Additional configura‐
5027 tion flags can be specified on the command line and these extend the
5028 project configuration from the 'cabal.project', 'cabal.project.local'
5029 and other files.
5030 Open an interactive session for a component within the project. The
5033 available targets are the same as for the 'v2-build' command: individ‐
5034 ual components within packages in the project, including libraries,
5035 executables, test-suites or benchmarks. Packages can also be specified
5036 in which case the library component in the package will be used, or the
5037 (first listed) executable in the package if there is no library.
5038 Dependencies are built or rebuilt as necessary. Additional configura‐
5040 tion flags can be specified on the command line and these extend the
5041 project configuration from the 'cabal.project', 'cabal.project.local'
5042 and other files.
5043 Flags:
5046 -v, --verbose [n]
5047 Control verbosity (n is 0--3, default verbosity level is
5048 1)
5049 --builddir, --distdir, --distpref DIR
5051 The directory where Cabal puts generated build files
5052 (default dist)
5053 -g, --ghc
5055 compile with GHC
5056 --ghcjs
5058 compile with GHCJS
5059 --uhc
5061 compile with UHC
5062 --haskell-suite
5064 compile with a haskell-suite compiler
5065 --cabal-file PATH
5067 use this Cabal file
5068 -w, --with-compiler PATH
5070 give the path to a particular compiler
5071 --with-hc-pkg PATH
5073 give the path to the package tool
5074 --prefix DIR
5076 bake this prefix in preparation of installation
5077 --bindir DIR
5079 installation directory for executables
5080 --libdir DIR
5082 installation directory for libraries
5083 --libsubdir DIR
5085 subdirectory of libdir in which libs are installed
5086 --dynlibdir DIR
5088 installation directory for dynamic libraries
5089 --libexecdir DIR
5091 installation directory for program executables
5092 --libexecsubdir DIR
5094 subdirectory of libexecdir in which private executables
5095 are installed
5096 --datadir DIR
5098 installation directory for read-only data
5099 --datasubdir DIR
5101 subdirectory of datadir in which data files are installed
5102 --docdir DIR
5104 installation directory for documentation
5105 --htmldir DIR
5107 installation directory for HTML documentation
5108 --haddockdir DIR
5110 installation directory for haddock interfaces
5111 --sysconfdir DIR
5113 installation directory for configuration files
5114 --program-prefix PREFIX
5116 prefix to be applied to installed executables
5117 --program-suffix SUFFIX
5119 suffix to be applied to installed executables
5120 --enable-library-vanilla
5122 --disable-library-vanilla
5123 Vanilla libraries
5124 -p, --enable-library-profiling
5126 --disable-library-profiling
5127 Library profiling
5128 --enable-shared
5130 --disable-shared
5131 Shared library
5132 --enable-static
5134 --disable-static
5135 Static library
5136 --enable-executable-dynamic
5138 --disable-executable-dynamic
5139 Executable dynamic linking
5140 --enable-profiling
5142 --disable-profiling
5143 Executable and library profiling
5144 --enable-executable-profiling
5146 --disable-executable-profiling
5147 Executable profiling (DEPRECATED)
5148 --profiling-detail level
5150 Profiling detail level for executable and library
5151 (default, none, exported-functions, toplevel-functions,
5152 all-functions).
5153 --library-profiling-detail level
5155 Profiling detail level for libraries only.
5156 -O, --enable-optimization, --enable-optimisation [n]
5158 Build with optimization (n is 0--2, default is 1)
5159 --disable-optimization, --disable-optimisation
5161 Build without optimization
5162 --enable-debug-info [n]
5164 Emit debug info (n is 0--3, default is 0)
5165 --disable-debug-info
5167 Don't emit debug info
5168 --enable-library-for-ghci
5170 --disable-library-for-ghci
5171 compile library for use with GHCi
5172 --enable-split-sections
5174 --disable-split-sections
5175 compile library code such that unneeded definitions can
5176 be dropped from the final executable (GHC 7.8+)
5177 --enable-split-objs
5179 --disable-split-objs
5180 split library into smaller objects to reduce binary sizes
5181 (GHC 6.6+)
5182 --enable-executable-stripping
5184 --disable-executable-stripping
5185 strip executables upon installation to reduce binary
5186 sizes
5187 --enable-library-stripping
5189 --disable-library-stripping
5190 strip libraries upon installation to reduce binary sizes
5191 --configure-option OPT
5193 Extra option for configure
5194 --user
5196 --global
5197 doing a per-user installation
5198 --package-db DB
5200 Append the given package database to the list of package
5201 databases used (to satisfy dependencies and register
5202 into). May be a specific file, 'global' or 'user'. The
5203 initial list is ['global'], ['global', 'user'], or
5204 ['global', $sandbox], depending on context. Use 'clear'
5205 to reset the list to empty. See the user guide for
5206 details.
5207 -f, --flags FLAGS
5209 Force values for the given flags in Cabal conditionals in
5210 the .cabal file. E.g., --flags="debug -usebytestrings"
5211 forces the flag "debug" to true and "usebytestrings" to
5212 false.
5213 --extra-include-dirs PATH
5215 A list of directories to search for header files
5216 --enable-deterministic
5218 --disable-deterministic
5219 Try to be as deterministic as possible (used by the test
5220 suite)
5221 --ipid IPID
5223 Installed package ID to compile this package as
5224 --cid CID
5226 Installed component ID to compile this component as
5227 --extra-lib-dirs PATH
5229 A list of directories to search for external libraries
5230 --extra-framework-dirs PATH
5232 A list of directories to search for external frameworks
5233 (OS X only)
5234 --extra-prog-path PATH
5236 A list of directories to search for required programs (in
5237 addition to the normal search locations)
5238 --instantiate-with NAME=MOD
5240 A mapping of signature names to concrete module instanti‐
5241 ations.
5242 --enable-tests
5244 --disable-tests
5245 dependency checking and compilation for test suites
5246 listed in the package description file.
5247 --enable-coverage
5249 --disable-coverage
5250 build package with Haskell Program Coverage. (GHC only)
5251 --enable-library-coverage
5253 --disable-library-coverage
5254 build package with Haskell Program Coverage. (GHC only)
5255 (DEPRECATED)
5256 --enable-benchmarks
5258 --disable-benchmarks
5259 dependency checking and compilation for benchmarks listed
5260 in the package description file.
5261 --enable-relocatable
5263 --disable-relocatable
5264 building a package that is relocatable. (GHC only)
5265 --disable-response-files
5267 enable workaround for old versions of programs like "ar"
5268 that do not support @file arguments
5269 --with-alex PATH
5271 give the path to alex
5272 --with-ar PATH
5274 give the path to ar
5275 --with-c2hs PATH
5277 give the path to c2hs
5278 --with-cpphs PATH
5280 give the path to cpphs
5281 --with-doctest PATH
5283 give the path to doctest
5284 --with-gcc PATH
5286 give the path to gcc
5287 --with-ghc PATH
5289 give the path to ghc
5290 --with-ghc-pkg PATH
5292 give the path to ghc-pkg
5293 --with-ghcjs PATH
5295 give the path to ghcjs
5296 --with-ghcjs-pkg PATH
5298 give the path to ghcjs-pkg
5299 --with-greencard PATH
5301 give the path to greencard
5302 --with-haddock PATH
5304 give the path to haddock
5305 --with-happy PATH
5307 give the path to happy
5308 --with-haskell-suite PATH
5310 give the path to haskell-suite
5311 --with-haskell-suite-pkg PATH
5313 give the path to haskell-suite-pkg
5314 --with-hmake PATH
5316 give the path to hmake
5317 --with-hpc PATH
5319 give the path to hpc
5320 --with-hsc2hs PATH
5322 give the path to hsc2hs
5323 --with-hscolour PATH
5325 give the path to hscolour
5326 --with-jhc PATH
5328 give the path to jhc
5329 --with-ld PATH
5331 give the path to ld
5332 --with-pkg-config PATH
5334 give the path to pkg-config
5335 --with-runghc PATH
5337 give the path to runghc
5338 --with-strip PATH
5340 give the path to strip
5341 --with-tar PATH
5343 give the path to tar
5344 --with-uhc PATH
5346 give the path to uhc
5347 --alex-option OPT
5349 give an extra option to alex (no need to quote options
5350 containing spaces)
5351 --ar-option OPT
5353 give an extra option to ar (no need to quote options con‐
5354 taining spaces)
5355 --c2hs-option OPT
5357 give an extra option to c2hs (no need to quote options
5358 containing spaces)
5359 --cpphs-option OPT
5361 give an extra option to cpphs (no need to quote options
5362 containing spaces)
5363 --doctest-option OPT
5365 give an extra option to doctest (no need to quote options
5366 containing spaces)
5367 --gcc-option OPT
5369 give an extra option to gcc (no need to quote options
5370 containing spaces)
5371 --ghc-option OPT
5373 give an extra option to ghc (no need to quote options
5374 containing spaces)
5375 --ghc-pkg-option OPT
5377 give an extra option to ghc-pkg (no need to quote options
5378 containing spaces)
5379 --ghcjs-option OPT
5381 give an extra option to ghcjs (no need to quote options
5382 containing spaces)
5383 --ghcjs-pkg-option OPT
5385 give an extra option to ghcjs-pkg (no need to quote
5386 options containing spaces)
5387 --greencard-option OPT
5389 give an extra option to greencard (no need to quote
5390 options containing spaces)
5391 --haddock-option OPT
5393 give an extra option to haddock (no need to quote options
5394 containing spaces)
5395 --happy-option OPT
5397 give an extra option to happy (no need to quote options
5398 containing spaces)
5399 --haskell-suite-option OPT
5401 give an extra option to haskell-suite (no need to quote
5402 options containing spaces)
5403 --haskell-suite-pkg-option OPT
5405 give an extra option to haskell-suite-pkg (no need to
5406 quote options containing spaces)
5407 --hmake-option OPT
5409 give an extra option to hmake (no need to quote options
5410 containing spaces)
5411 --hpc-option OPT
5413 give an extra option to hpc (no need to quote options
5414 containing spaces)
5415 --hsc2hs-option OPT
5417 give an extra option to hsc2hs (no need to quote options
5418 containing spaces)
5419 --hscolour-option OPT
5421 give an extra option to hscolour (no need to quote
5422 options containing spaces)
5423 --jhc-option OPT
5425 give an extra option to jhc (no need to quote options
5426 containing spaces)
5427 --ld-option OPT
5429 give an extra option to ld (no need to quote options con‐
5430 taining spaces)
5431 --pkg-config-option OPT
5433 give an extra option to pkg-config (no need to quote
5434 options containing spaces)
5435 --runghc-option OPT
5437 give an extra option to runghc (no need to quote options
5438 containing spaces)
5439 --strip-option OPT
5441 give an extra option to strip (no need to quote options
5442 containing spaces)
5443 --tar-option OPT
5445 give an extra option to tar (no need to quote options
5446 containing spaces)
5447 --uhc-option OPT
5449 give an extra option to uhc (no need to quote options
5450 containing spaces)
5451 --alex-options OPTS
5453 give extra options to alex
5454 --ar-options OPTS
5456 give extra options to ar
5457 --c2hs-options OPTS
5459 give extra options to c2hs
5460 --cpphs-options OPTS
5462 give extra options to cpphs
5463 --doctest-options OPTS
5465 give extra options to doctest
5466 --gcc-options OPTS
5468 give extra options to gcc
5469 --ghc-options OPTS
5471 give extra options to ghc
5472 --ghc-pkg-options OPTS
5474 give extra options to ghc-pkg
5475 --ghcjs-options OPTS
5477 give extra options to ghcjs
5478 --ghcjs-pkg-options OPTS
5480 give extra options to ghcjs-pkg
5481 --greencard-options OPTS
5483 give extra options to greencard
5484 --haddock-options OPTS
5486 give extra options to haddock
5487 --happy-options OPTS
5489 give extra options to happy
5490 --haskell-suite-options OPTS
5492 give extra options to haskell-suite
5493 --haskell-suite-pkg-options OPTS
5495 give extra options to haskell-suite-pkg
5496 --hmake-options OPTS
5498 give extra options to hmake
5499 --hpc-options OPTS
5501 give extra options to hpc
5502 --hsc2hs-options OPTS
5504 give extra options to hsc2hs
5505 --hscolour-options OPTS
5507 give extra options to hscolour
5508 --jhc-options OPTS
5510 give extra options to jhc
5511 --ld-options OPTS
5513 give extra options to ld
5514 --pkg-config-options OPTS
5516 give extra options to pkg-config
5517 --runghc-options OPTS
5519 give extra options to runghc
5520 --strip-options OPTS
5522 give extra options to strip
5523 --tar-options OPTS
5525 give extra options to tar
5526 --uhc-options OPTS
5528 give extra options to uhc
5529 --cabal-lib-version VERSION
5531 Select which version of the Cabal lib to use to build
5532 packages (useful for testing).
5533 --constraint CONSTRAINT
5535 Specify constraints on a package (version,
5536 installed/source, flags)
5537 --preference CONSTRAINT
5539 Specify preferences (soft constraints) on the version of
5540 a package
5541 --solver SOLVER
5543 Select dependency solver to use (default: modular).
5544 Choices: modular.
5545 --allow-older [DEPS]
5547 Ignore lower bounds in all dependencies or DEPS
5548 --allow-newer [DEPS]
5550 Ignore upper bounds in all dependencies or DEPS
5551 --enable-documentation
5553 --disable-documentation
5554 building of documentation
5555 --doc-index-file TEMPLATE
5557 A central index of haddock API documentation (template
5558 cannot use $pkgid)
5559 --dry-run
5561 Do not install anything, only print what would be
5562 installed.
5563 --max-backjumps NUM
5565 Maximum number of backjumps allowed while solving
5566 (default: 2000). Use a negative number to enable unlim‐
5567 ited backtracking. Use 0 to disable backtracking com‐
5568 pletely.
5569 --reorder-goals
5571 --no-reorder-goals
5572 Try to reorder goals according to certain heuristics.
5573 Slows things down on average, but may make backtracking
5574 faster for some packages.
5575 --count-conflicts
5577 --no-count-conflicts
5578 Try to speed up solving by preferring goals that are
5579 involved in a lot of conflicts (default).
5580 --independent-goals
5582 --no-independent-goals
5583 Treat several goals on the command line as independent.
5584 If several goals depend on the same package, different
5585 versions can be chosen.
5586 --shadow-installed-packages
5588 --no-shadow-installed-packages
5589 If multiple package instances of the same version are
5590 installed, treat all but one as shadowed.
5591 --strong-flags
5593 --no-strong-flags
5594 Do not defer flag choices (this used to be the default in
5595 cabal-install <= 1.20).
5596 --allow-boot-library-installs
5598 --no-allow-boot-library-installs
5599 Allow cabal to install base, ghc-prim, integer-simple,
5600 integer-gmp, and template-haskell.
5601 --reinstall
5603 --no-reinstall
5604 Install even if it means installing the same version
5605 again.
5606 --avoid-reinstalls
5608 --no-avoid-reinstalls
5609 Do not select versions that would destructively overwrite
5610 installed packages.
5611 --force-reinstalls
5613 --no-force-reinstalls
5614 Reinstall packages even if they will most likely break
5615 other installed packages.
5616 --upgrade-dependencies
5618 --no-upgrade-dependencies
5619 Pick the latest version for all dependencies, rather than
5620 trying to pick an installed version.
5621 --only-dependencies
5623 --no-only-dependencies
5624 Install only the dependencies necessary to build the
5625 given packages
5626 --dependencies-only
5628 --no-dependencies-only
5629 A synonym for --only-dependencies
5630 --index-state STATE
5632 Use source package index state as it existed at a previ‐
5633 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
5634 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
5635 'HEAD' (default: 'HEAD').
5636 --root-cmd COMMAND
5638 (No longer supported, do not use.)
5639 --symlink-bindir DIR
5641 Add symlinks to installed executables into this direc‐
5642 tory.
5643 --build-summary TEMPLATE
5645 Save build summaries to file (name template can use
5646 $pkgid, $compiler, $os, $arch)
5647 --build-log TEMPLATE
5649 Log all builds to file (name template can use $pkgid,
5650 $compiler, $os, $arch)
5651 --remote-build-reporting LEVEL
5653 Generate build reports to send to a remote server (none,
5654 anonymous or detailed).
5655 --report-planning-failure
5657 Generate build reports when the dependency solver fails.
5658 This is used by the Hackage build bot.
5659 --enable-per-component
5661 --disable-per-component
5662 Per-component builds when possible
5663 --one-shot
5665 --no-one-shot
5666 Do not record the packages in the world file.
5667 --run-tests
5669 Run package test suites during installation.
5670 -j, --jobs [NUM]
5672 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
5673 given).
5674 --keep-going
5676 After a build failure, continue to build other unaffected
5677 packages.
5678 --offline
5680 --no-offline
5681 Don't download packages from the Internet.
5682 --project-file FILE
5684 Set the name of the cabal.project file to search for in
5685 parent directories
5686 --only
5688 Only installs the package in the current directory.
5689 --haddock-hoogle
5691 Generate a hoogle database
5692 --haddock-html
5694 Generate HTML documentation (the default)
5695 --haddock-html-location URL
5697 Location of HTML documentation for pre-requisite packages
5698 --haddock-for-hackage
5700 Collection of flags to generate documentation suitable
5701 for upload to hackage
5702 --haddock-executables
5704 Run haddock for Executables targets
5705 --haddock-tests
5707 Run haddock for Test Suite targets
5708 --haddock-benchmarks
5710 Run haddock for Benchmark targets
5711 --haddock-all
5713 Run haddock for all targets
5714 --haddock-internal
5716 Run haddock for internal modules and include all symbols
5717 --haddock-css PATH
5719 Use PATH as the haddock stylesheet
5720 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
5722 dock-hyperlinked-source
5723 Hyperlink the documentation to the source code
5724 --haddock-quickjump
5726 Generate an index for interactive documentation naviga‐
5727 tion
5728 --haddock-hscolour-css PATH
5730 Use PATH as the HsColour stylesheet
5731 --haddock-contents-location URL
5733 Bake URL in as the location for the contents page
5734 --repl-options FLAG
5736 use this option for the repl
5737 -b, --build-depends DEPENDENCY
5739 Include an additional package in the environment pre‐
5740 sented to GHCi.
5741 --no-transitive-deps
5743 Don't automatically include transitive dependencies of
5744 requested packages.
5745 -z, --ignore-project
5747 Only include explicitly specified packages (and 'base').
5748 cabal new-repl
5751 Usage: cabal new-repl [TARGET] [FLAGS]
5753 Open an interactive session for a component within the project. The
5756 available targets are the same as for the 'new-build' command: individ‐
5757 ual components within packages in the project, including libraries,
5758 executables, test-suites or benchmarks. Packages can also be specified
5759 in which case the library component in the package will be used, or the
5760 (first listed) executable in the package if there is no library.
5761 Dependencies are built or rebuilt as necessary. Additional configura‐
5763 tion flags can be specified on the command line and these extend the
5764 project configuration from the 'cabal.project', 'cabal.project.local'
5765 and other files.
5766 Examples, open an interactive session:
5769 cabal new-repl
5770 for the default component in the package in the current directory
5771 cabal new-repl pkgname
5772 for the default component in the package named 'pkgname'
5773 cabal new-repl ./pkgfoo
5774 for the default component in the package in the ./pkgfoo directory
5775 cabal new-repl cname
5776 for the component named 'cname'
5777 cabal new-repl pkgname:cname
5778 for the component 'cname' in the package 'pkgname'
5779 cabal new-repl --build-depends lens
5781 add the latest version of the library 'lens' to the default compo‐
5782 nent (or no componentif there is no project present)
5783 cabal new-repl --build-depends "lens >= 4.15 && < 4.18"
5784 add a version (constrained between 4.15 and 4.18) of the library
5785 'lens' to the default component (or no component if there is no project
5786 present) Note: this command is part of the new project-based system
5787 (aka nix-style local builds). These features are currently in beta.
5788 Please see http://cabal.readthedocs.io/en/latest/nix-local-build-over‐
5789 view.html for details and advice on what you can expect to work. If you
5790 encounter problems please file issues at
5791 https://github.com/haskell/cabal/issues and if you have any time to get
5792 involved and help with testing, fixing bugs etc then that is very much
5793 appreciated.
5794 Flags:
5797 -v, --verbose [n]
5798 Control verbosity (n is 0--3, default verbosity level is
5799 1)
5800 --builddir, --distdir, --distpref DIR
5802 The directory where Cabal puts generated build files
5803 (default dist)
5804 -g, --ghc
5806 compile with GHC
5807 --ghcjs
5809 compile with GHCJS
5810 --uhc
5812 compile with UHC
5813 --haskell-suite
5815 compile with a haskell-suite compiler
5816 --cabal-file PATH
5818 use this Cabal file
5819 -w, --with-compiler PATH
5821 give the path to a particular compiler
5822 --with-hc-pkg PATH
5824 give the path to the package tool
5825 --prefix DIR
5827 bake this prefix in preparation of installation
5828 --bindir DIR
5830 installation directory for executables
5831 --libdir DIR
5833 installation directory for libraries
5834 --libsubdir DIR
5836 subdirectory of libdir in which libs are installed
5837 --dynlibdir DIR
5839 installation directory for dynamic libraries
5840 --libexecdir DIR
5842 installation directory for program executables
5843 --libexecsubdir DIR
5845 subdirectory of libexecdir in which private executables
5846 are installed
5847 --datadir DIR
5849 installation directory for read-only data
5850 --datasubdir DIR
5852 subdirectory of datadir in which data files are installed
5853 --docdir DIR
5855 installation directory for documentation
5856 --htmldir DIR
5858 installation directory for HTML documentation
5859 --haddockdir DIR
5861 installation directory for haddock interfaces
5862 --sysconfdir DIR
5864 installation directory for configuration files
5865 --program-prefix PREFIX
5867 prefix to be applied to installed executables
5868 --program-suffix SUFFIX
5870 suffix to be applied to installed executables
5871 --enable-library-vanilla
5873 --disable-library-vanilla
5874 Vanilla libraries
5875 -p, --enable-library-profiling
5877 --disable-library-profiling
5878 Library profiling
5879 --enable-shared
5881 --disable-shared
5882 Shared library
5883 --enable-static
5885 --disable-static
5886 Static library
5887 --enable-executable-dynamic
5889 --disable-executable-dynamic
5890 Executable dynamic linking
5891 --enable-profiling
5893 --disable-profiling
5894 Executable and library profiling
5895 --enable-executable-profiling
5897 --disable-executable-profiling
5898 Executable profiling (DEPRECATED)
5899 --profiling-detail level
5901 Profiling detail level for executable and library
5902 (default, none, exported-functions, toplevel-functions,
5903 all-functions).
5904 --library-profiling-detail level
5906 Profiling detail level for libraries only.
5907 -O, --enable-optimization, --enable-optimisation [n]
5909 Build with optimization (n is 0--2, default is 1)
5910 --disable-optimization, --disable-optimisation
5912 Build without optimization
5913 --enable-debug-info [n]
5915 Emit debug info (n is 0--3, default is 0)
5916 --disable-debug-info
5918 Don't emit debug info
5919 --enable-library-for-ghci
5921 --disable-library-for-ghci
5922 compile library for use with GHCi
5923 --enable-split-sections
5925 --disable-split-sections
5926 compile library code such that unneeded definitions can
5927 be dropped from the final executable (GHC 7.8+)
5928 --enable-split-objs
5930 --disable-split-objs
5931 split library into smaller objects to reduce binary sizes
5932 (GHC 6.6+)
5933 --enable-executable-stripping
5935 --disable-executable-stripping
5936 strip executables upon installation to reduce binary
5937 sizes
5938 --enable-library-stripping
5940 --disable-library-stripping
5941 strip libraries upon installation to reduce binary sizes
5942 --configure-option OPT
5944 Extra option for configure
5945 --user
5947 --global
5948 doing a per-user installation
5949 --package-db DB
5951 Append the given package database to the list of package
5952 databases used (to satisfy dependencies and register
5953 into). May be a specific file, 'global' or 'user'. The
5954 initial list is ['global'], ['global', 'user'], or
5955 ['global', $sandbox], depending on context. Use 'clear'
5956 to reset the list to empty. See the user guide for
5957 details.
5958 -f, --flags FLAGS
5960 Force values for the given flags in Cabal conditionals in
5961 the .cabal file. E.g., --flags="debug -usebytestrings"
5962 forces the flag "debug" to true and "usebytestrings" to
5963 false.
5964 --extra-include-dirs PATH
5966 A list of directories to search for header files
5967 --enable-deterministic
5969 --disable-deterministic
5970 Try to be as deterministic as possible (used by the test
5971 suite)
5972 --ipid IPID
5974 Installed package ID to compile this package as
5975 --cid CID
5977 Installed component ID to compile this component as
5978 --extra-lib-dirs PATH
5980 A list of directories to search for external libraries
5981 --extra-framework-dirs PATH
5983 A list of directories to search for external frameworks
5984 (OS X only)
5985 --extra-prog-path PATH
5987 A list of directories to search for required programs (in
5988 addition to the normal search locations)
5989 --instantiate-with NAME=MOD
5991 A mapping of signature names to concrete module instanti‐
5992 ations.
5993 --enable-tests
5995 --disable-tests
5996 dependency checking and compilation for test suites
5997 listed in the package description file.
5998 --enable-coverage
6000 --disable-coverage
6001 build package with Haskell Program Coverage. (GHC only)
6002 --enable-library-coverage
6004 --disable-library-coverage
6005 build package with Haskell Program Coverage. (GHC only)
6006 (DEPRECATED)
6007 --enable-benchmarks
6009 --disable-benchmarks
6010 dependency checking and compilation for benchmarks listed
6011 in the package description file.
6012 --enable-relocatable
6014 --disable-relocatable
6015 building a package that is relocatable. (GHC only)
6016 --disable-response-files
6018 enable workaround for old versions of programs like "ar"
6019 that do not support @file arguments
6020 --with-alex PATH
6022 give the path to alex
6023 --with-ar PATH
6025 give the path to ar
6026 --with-c2hs PATH
6028 give the path to c2hs
6029 --with-cpphs PATH
6031 give the path to cpphs
6032 --with-doctest PATH
6034 give the path to doctest
6035 --with-gcc PATH
6037 give the path to gcc
6038 --with-ghc PATH
6040 give the path to ghc
6041 --with-ghc-pkg PATH
6043 give the path to ghc-pkg
6044 --with-ghcjs PATH
6046 give the path to ghcjs
6047 --with-ghcjs-pkg PATH
6049 give the path to ghcjs-pkg
6050 --with-greencard PATH
6052 give the path to greencard
6053 --with-haddock PATH
6055 give the path to haddock
6056 --with-happy PATH
6058 give the path to happy
6059 --with-haskell-suite PATH
6061 give the path to haskell-suite
6062 --with-haskell-suite-pkg PATH
6064 give the path to haskell-suite-pkg
6065 --with-hmake PATH
6067 give the path to hmake
6068 --with-hpc PATH
6070 give the path to hpc
6071 --with-hsc2hs PATH
6073 give the path to hsc2hs
6074 --with-hscolour PATH
6076 give the path to hscolour
6077 --with-jhc PATH
6079 give the path to jhc
6080 --with-ld PATH
6082 give the path to ld
6083 --with-pkg-config PATH
6085 give the path to pkg-config
6086 --with-runghc PATH
6088 give the path to runghc
6089 --with-strip PATH
6091 give the path to strip
6092 --with-tar PATH
6094 give the path to tar
6095 --with-uhc PATH
6097 give the path to uhc
6098 --alex-option OPT
6100 give an extra option to alex (no need to quote options
6101 containing spaces)
6102 --ar-option OPT
6104 give an extra option to ar (no need to quote options con‐
6105 taining spaces)
6106 --c2hs-option OPT
6108 give an extra option to c2hs (no need to quote options
6109 containing spaces)
6110 --cpphs-option OPT
6112 give an extra option to cpphs (no need to quote options
6113 containing spaces)
6114 --doctest-option OPT
6116 give an extra option to doctest (no need to quote options
6117 containing spaces)
6118 --gcc-option OPT
6120 give an extra option to gcc (no need to quote options
6121 containing spaces)
6122 --ghc-option OPT
6124 give an extra option to ghc (no need to quote options
6125 containing spaces)
6126 --ghc-pkg-option OPT
6128 give an extra option to ghc-pkg (no need to quote options
6129 containing spaces)
6130 --ghcjs-option OPT
6132 give an extra option to ghcjs (no need to quote options
6133 containing spaces)
6134 --ghcjs-pkg-option OPT
6136 give an extra option to ghcjs-pkg (no need to quote
6137 options containing spaces)
6138 --greencard-option OPT
6140 give an extra option to greencard (no need to quote
6141 options containing spaces)
6142 --haddock-option OPT
6144 give an extra option to haddock (no need to quote options
6145 containing spaces)
6146 --happy-option OPT
6148 give an extra option to happy (no need to quote options
6149 containing spaces)
6150 --haskell-suite-option OPT
6152 give an extra option to haskell-suite (no need to quote
6153 options containing spaces)
6154 --haskell-suite-pkg-option OPT
6156 give an extra option to haskell-suite-pkg (no need to
6157 quote options containing spaces)
6158 --hmake-option OPT
6160 give an extra option to hmake (no need to quote options
6161 containing spaces)
6162 --hpc-option OPT
6164 give an extra option to hpc (no need to quote options
6165 containing spaces)
6166 --hsc2hs-option OPT
6168 give an extra option to hsc2hs (no need to quote options
6169 containing spaces)
6170 --hscolour-option OPT
6172 give an extra option to hscolour (no need to quote
6173 options containing spaces)
6174 --jhc-option OPT
6176 give an extra option to jhc (no need to quote options
6177 containing spaces)
6178 --ld-option OPT
6180 give an extra option to ld (no need to quote options con‐
6181 taining spaces)
6182 --pkg-config-option OPT
6184 give an extra option to pkg-config (no need to quote
6185 options containing spaces)
6186 --runghc-option OPT
6188 give an extra option to runghc (no need to quote options
6189 containing spaces)
6190 --strip-option OPT
6192 give an extra option to strip (no need to quote options
6193 containing spaces)
6194 --tar-option OPT
6196 give an extra option to tar (no need to quote options
6197 containing spaces)
6198 --uhc-option OPT
6200 give an extra option to uhc (no need to quote options
6201 containing spaces)
6202 --alex-options OPTS
6204 give extra options to alex
6205 --ar-options OPTS
6207 give extra options to ar
6208 --c2hs-options OPTS
6210 give extra options to c2hs
6211 --cpphs-options OPTS
6213 give extra options to cpphs
6214 --doctest-options OPTS
6216 give extra options to doctest
6217 --gcc-options OPTS
6219 give extra options to gcc
6220 --ghc-options OPTS
6222 give extra options to ghc
6223 --ghc-pkg-options OPTS
6225 give extra options to ghc-pkg
6226 --ghcjs-options OPTS
6228 give extra options to ghcjs
6229 --ghcjs-pkg-options OPTS
6231 give extra options to ghcjs-pkg
6232 --greencard-options OPTS
6234 give extra options to greencard
6235 --haddock-options OPTS
6237 give extra options to haddock
6238 --happy-options OPTS
6240 give extra options to happy
6241 --haskell-suite-options OPTS
6243 give extra options to haskell-suite
6244 --haskell-suite-pkg-options OPTS
6246 give extra options to haskell-suite-pkg
6247 --hmake-options OPTS
6249 give extra options to hmake
6250 --hpc-options OPTS
6252 give extra options to hpc
6253 --hsc2hs-options OPTS
6255 give extra options to hsc2hs
6256 --hscolour-options OPTS
6258 give extra options to hscolour
6259 --jhc-options OPTS
6261 give extra options to jhc
6262 --ld-options OPTS
6264 give extra options to ld
6265 --pkg-config-options OPTS
6267 give extra options to pkg-config
6268 --runghc-options OPTS
6270 give extra options to runghc
6271 --strip-options OPTS
6273 give extra options to strip
6274 --tar-options OPTS
6276 give extra options to tar
6277 --uhc-options OPTS
6279 give extra options to uhc
6280 --cabal-lib-version VERSION
6282 Select which version of the Cabal lib to use to build
6283 packages (useful for testing).
6284 --constraint CONSTRAINT
6286 Specify constraints on a package (version,
6287 installed/source, flags)
6288 --preference CONSTRAINT
6290 Specify preferences (soft constraints) on the version of
6291 a package
6292 --solver SOLVER
6294 Select dependency solver to use (default: modular).
6295 Choices: modular.
6296 --allow-older [DEPS]
6298 Ignore lower bounds in all dependencies or DEPS
6299 --allow-newer [DEPS]
6301 Ignore upper bounds in all dependencies or DEPS
6302 --enable-documentation
6304 --disable-documentation
6305 building of documentation
6306 --doc-index-file TEMPLATE
6308 A central index of haddock API documentation (template
6309 cannot use $pkgid)
6310 --dry-run
6312 Do not install anything, only print what would be
6313 installed.
6314 --max-backjumps NUM
6316 Maximum number of backjumps allowed while solving
6317 (default: 2000). Use a negative number to enable unlim‐
6318 ited backtracking. Use 0 to disable backtracking com‐
6319 pletely.
6320 --reorder-goals
6322 --no-reorder-goals
6323 Try to reorder goals according to certain heuristics.
6324 Slows things down on average, but may make backtracking
6325 faster for some packages.
6326 --count-conflicts
6328 --no-count-conflicts
6329 Try to speed up solving by preferring goals that are
6330 involved in a lot of conflicts (default).
6331 --independent-goals
6333 --no-independent-goals
6334 Treat several goals on the command line as independent.
6335 If several goals depend on the same package, different
6336 versions can be chosen.
6337 --shadow-installed-packages
6339 --no-shadow-installed-packages
6340 If multiple package instances of the same version are
6341 installed, treat all but one as shadowed.
6342 --strong-flags
6344 --no-strong-flags
6345 Do not defer flag choices (this used to be the default in
6346 cabal-install <= 1.20).
6347 --allow-boot-library-installs
6349 --no-allow-boot-library-installs
6350 Allow cabal to install base, ghc-prim, integer-simple,
6351 integer-gmp, and template-haskell.
6352 --reinstall
6354 --no-reinstall
6355 Install even if it means installing the same version
6356 again.
6357 --avoid-reinstalls
6359 --no-avoid-reinstalls
6360 Do not select versions that would destructively overwrite
6361 installed packages.
6362 --force-reinstalls
6364 --no-force-reinstalls
6365 Reinstall packages even if they will most likely break
6366 other installed packages.
6367 --upgrade-dependencies
6369 --no-upgrade-dependencies
6370 Pick the latest version for all dependencies, rather than
6371 trying to pick an installed version.
6372 --only-dependencies
6374 --no-only-dependencies
6375 Install only the dependencies necessary to build the
6376 given packages
6377 --dependencies-only
6379 --no-dependencies-only
6380 A synonym for --only-dependencies
6381 --index-state STATE
6383 Use source package index state as it existed at a previ‐
6384 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
6385 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
6386 'HEAD' (default: 'HEAD').
6387 --root-cmd COMMAND
6389 (No longer supported, do not use.)
6390 --symlink-bindir DIR
6392 Add symlinks to installed executables into this direc‐
6393 tory.
6394 --build-summary TEMPLATE
6396 Save build summaries to file (name template can use
6397 $pkgid, $compiler, $os, $arch)
6398 --build-log TEMPLATE
6400 Log all builds to file (name template can use $pkgid,
6401 $compiler, $os, $arch)
6402 --remote-build-reporting LEVEL
6404 Generate build reports to send to a remote server (none,
6405 anonymous or detailed).
6406 --report-planning-failure
6408 Generate build reports when the dependency solver fails.
6409 This is used by the Hackage build bot.
6410 --enable-per-component
6412 --disable-per-component
6413 Per-component builds when possible
6414 --one-shot
6416 --no-one-shot
6417 Do not record the packages in the world file.
6418 --run-tests
6420 Run package test suites during installation.
6421 -j, --jobs [NUM]
6423 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
6424 given).
6425 --keep-going
6427 After a build failure, continue to build other unaffected
6428 packages.
6429 --offline
6431 --no-offline
6432 Don't download packages from the Internet.
6433 --project-file FILE
6435 Set the name of the cabal.project file to search for in
6436 parent directories
6437 --only
6439 Only installs the package in the current directory.
6440 --haddock-hoogle
6442 Generate a hoogle database
6443 --haddock-html
6445 Generate HTML documentation (the default)
6446 --haddock-html-location URL
6448 Location of HTML documentation for pre-requisite packages
6449 --haddock-for-hackage
6451 Collection of flags to generate documentation suitable
6452 for upload to hackage
6453 --haddock-executables
6455 Run haddock for Executables targets
6456 --haddock-tests
6458 Run haddock for Test Suite targets
6459 --haddock-benchmarks
6461 Run haddock for Benchmark targets
6462 --haddock-all
6464 Run haddock for all targets
6465 --haddock-internal
6467 Run haddock for internal modules and include all symbols
6468 --haddock-css PATH
6470 Use PATH as the haddock stylesheet
6471 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
6473 dock-hyperlinked-source
6474 Hyperlink the documentation to the source code
6475 --haddock-quickjump
6477 Generate an index for interactive documentation naviga‐
6478 tion
6479 --haddock-hscolour-css PATH
6481 Use PATH as the HsColour stylesheet
6482 --haddock-contents-location URL
6484 Bake URL in as the location for the contents page
6485 --repl-options FLAG
6487 use this option for the repl
6488 -b, --build-depends DEPENDENCY
6490 Include an additional package in the environment pre‐
6491 sented to GHCi.
6492 --no-transitive-deps
6494 Don't automatically include transitive dependencies of
6495 requested packages.
6496 -z, --ignore-project
6498 Only include explicitly specified packages (and 'base').
6499 cabal v2-freeze
6502 Usage: cabal v2-freeze [FLAGS]
6504 The project configuration is frozen so that it will be reproducible in
6507 future.
6508 The precise dependency configuration for the project is written to the
6510 specified). This file extends the configuration from the
6511 'cabal.project' file and thus is used as the project configuration for
6512 all other commands (such as
6513 The freeze file can be kept in source control. To make small adjust‐
6515 ments it may be edited manually, or to make bigger changes you may wish
6516 to delete the file and re-freeze. For more control, one approach is to
6517 try variations using once you have a satisfactory solution to freeze it
6518 using the 'v2-freeze' command with the same set of flags.
6519 The project configuration is frozen so that it will be reproducible in
6522 future.
6523 The precise dependency configuration for the project is written to the
6525 specified). This file extends the configuration from the
6526 'cabal.project' file and thus is used as the project configuration for
6527 all other commands (such as
6528 The freeze file can be kept in source control. To make small adjust‐
6530 ments it may be edited manually, or to make bigger changes you may wish
6531 to delete the file and re-freeze. For more control, one approach is to
6532 try variations using once you have a satisfactory solution to freeze it
6533 using the 'v2-freeze' command with the same set of flags.
6534 Flags:
6537 -v, --verbose [n]
6538 Control verbosity (n is 0--3, default verbosity level is
6539 1)
6540 --builddir, --distdir, --distpref DIR
6542 The directory where Cabal puts generated build files
6543 (default dist)
6544 -g, --ghc
6546 compile with GHC
6547 --ghcjs
6549 compile with GHCJS
6550 --uhc
6552 compile with UHC
6553 --haskell-suite
6555 compile with a haskell-suite compiler
6556 --cabal-file PATH
6558 use this Cabal file
6559 -w, --with-compiler PATH
6561 give the path to a particular compiler
6562 --with-hc-pkg PATH
6564 give the path to the package tool
6565 --prefix DIR
6567 bake this prefix in preparation of installation
6568 --bindir DIR
6570 installation directory for executables
6571 --libdir DIR
6573 installation directory for libraries
6574 --libsubdir DIR
6576 subdirectory of libdir in which libs are installed
6577 --dynlibdir DIR
6579 installation directory for dynamic libraries
6580 --libexecdir DIR
6582 installation directory for program executables
6583 --libexecsubdir DIR
6585 subdirectory of libexecdir in which private executables
6586 are installed
6587 --datadir DIR
6589 installation directory for read-only data
6590 --datasubdir DIR
6592 subdirectory of datadir in which data files are installed
6593 --docdir DIR
6595 installation directory for documentation
6596 --htmldir DIR
6598 installation directory for HTML documentation
6599 --haddockdir DIR
6601 installation directory for haddock interfaces
6602 --sysconfdir DIR
6604 installation directory for configuration files
6605 --program-prefix PREFIX
6607 prefix to be applied to installed executables
6608 --program-suffix SUFFIX
6610 suffix to be applied to installed executables
6611 --enable-library-vanilla
6613 --disable-library-vanilla
6614 Vanilla libraries
6615 -p, --enable-library-profiling
6617 --disable-library-profiling
6618 Library profiling
6619 --enable-shared
6621 --disable-shared
6622 Shared library
6623 --enable-static
6625 --disable-static
6626 Static library
6627 --enable-executable-dynamic
6629 --disable-executable-dynamic
6630 Executable dynamic linking
6631 --enable-profiling
6633 --disable-profiling
6634 Executable and library profiling
6635 --enable-executable-profiling
6637 --disable-executable-profiling
6638 Executable profiling (DEPRECATED)
6639 --profiling-detail level
6641 Profiling detail level for executable and library
6642 (default, none, exported-functions, toplevel-functions,
6643 all-functions).
6644 --library-profiling-detail level
6646 Profiling detail level for libraries only.
6647 -O, --enable-optimization, --enable-optimisation [n]
6649 Build with optimization (n is 0--2, default is 1)
6650 --disable-optimization, --disable-optimisation
6652 Build without optimization
6653 --enable-debug-info [n]
6655 Emit debug info (n is 0--3, default is 0)
6656 --disable-debug-info
6658 Don't emit debug info
6659 --enable-library-for-ghci
6661 --disable-library-for-ghci
6662 compile library for use with GHCi
6663 --enable-split-sections
6665 --disable-split-sections
6666 compile library code such that unneeded definitions can
6667 be dropped from the final executable (GHC 7.8+)
6668 --enable-split-objs
6670 --disable-split-objs
6671 split library into smaller objects to reduce binary sizes
6672 (GHC 6.6+)
6673 --enable-executable-stripping
6675 --disable-executable-stripping
6676 strip executables upon installation to reduce binary
6677 sizes
6678 --enable-library-stripping
6680 --disable-library-stripping
6681 strip libraries upon installation to reduce binary sizes
6682 --configure-option OPT
6684 Extra option for configure
6685 --user
6687 --global
6688 doing a per-user installation
6689 --package-db DB
6691 Append the given package database to the list of package
6692 databases used (to satisfy dependencies and register
6693 into). May be a specific file, 'global' or 'user'. The
6694 initial list is ['global'], ['global', 'user'], or
6695 ['global', $sandbox], depending on context. Use 'clear'
6696 to reset the list to empty. See the user guide for
6697 details.
6698 -f, --flags FLAGS
6700 Force values for the given flags in Cabal conditionals in
6701 the .cabal file. E.g., --flags="debug -usebytestrings"
6702 forces the flag "debug" to true and "usebytestrings" to
6703 false.
6704 --extra-include-dirs PATH
6706 A list of directories to search for header files
6707 --enable-deterministic
6709 --disable-deterministic
6710 Try to be as deterministic as possible (used by the test
6711 suite)
6712 --ipid IPID
6714 Installed package ID to compile this package as
6715 --cid CID
6717 Installed component ID to compile this component as
6718 --extra-lib-dirs PATH
6720 A list of directories to search for external libraries
6721 --extra-framework-dirs PATH
6723 A list of directories to search for external frameworks
6724 (OS X only)
6725 --extra-prog-path PATH
6727 A list of directories to search for required programs (in
6728 addition to the normal search locations)
6729 --instantiate-with NAME=MOD
6731 A mapping of signature names to concrete module instanti‐
6732 ations.
6733 --enable-tests
6735 --disable-tests
6736 dependency checking and compilation for test suites
6737 listed in the package description file.
6738 --enable-coverage
6740 --disable-coverage
6741 build package with Haskell Program Coverage. (GHC only)
6742 --enable-library-coverage
6744 --disable-library-coverage
6745 build package with Haskell Program Coverage. (GHC only)
6746 (DEPRECATED)
6747 --enable-benchmarks
6749 --disable-benchmarks
6750 dependency checking and compilation for benchmarks listed
6751 in the package description file.
6752 --enable-relocatable
6754 --disable-relocatable
6755 building a package that is relocatable. (GHC only)
6756 --disable-response-files
6758 enable workaround for old versions of programs like "ar"
6759 that do not support @file arguments
6760 --with-alex PATH
6762 give the path to alex
6763 --with-ar PATH
6765 give the path to ar
6766 --with-c2hs PATH
6768 give the path to c2hs
6769 --with-cpphs PATH
6771 give the path to cpphs
6772 --with-doctest PATH
6774 give the path to doctest
6775 --with-gcc PATH
6777 give the path to gcc
6778 --with-ghc PATH
6780 give the path to ghc
6781 --with-ghc-pkg PATH
6783 give the path to ghc-pkg
6784 --with-ghcjs PATH
6786 give the path to ghcjs
6787 --with-ghcjs-pkg PATH
6789 give the path to ghcjs-pkg
6790 --with-greencard PATH
6792 give the path to greencard
6793 --with-haddock PATH
6795 give the path to haddock
6796 --with-happy PATH
6798 give the path to happy
6799 --with-haskell-suite PATH
6801 give the path to haskell-suite
6802 --with-haskell-suite-pkg PATH
6804 give the path to haskell-suite-pkg
6805 --with-hmake PATH
6807 give the path to hmake
6808 --with-hpc PATH
6810 give the path to hpc
6811 --with-hsc2hs PATH
6813 give the path to hsc2hs
6814 --with-hscolour PATH
6816 give the path to hscolour
6817 --with-jhc PATH
6819 give the path to jhc
6820 --with-ld PATH
6822 give the path to ld
6823 --with-pkg-config PATH
6825 give the path to pkg-config
6826 --with-runghc PATH
6828 give the path to runghc
6829 --with-strip PATH
6831 give the path to strip
6832 --with-tar PATH
6834 give the path to tar
6835 --with-uhc PATH
6837 give the path to uhc
6838 --alex-option OPT
6840 give an extra option to alex (no need to quote options
6841 containing spaces)
6842 --ar-option OPT
6844 give an extra option to ar (no need to quote options con‐
6845 taining spaces)
6846 --c2hs-option OPT
6848 give an extra option to c2hs (no need to quote options
6849 containing spaces)
6850 --cpphs-option OPT
6852 give an extra option to cpphs (no need to quote options
6853 containing spaces)
6854 --doctest-option OPT
6856 give an extra option to doctest (no need to quote options
6857 containing spaces)
6858 --gcc-option OPT
6860 give an extra option to gcc (no need to quote options
6861 containing spaces)
6862 --ghc-option OPT
6864 give an extra option to ghc (no need to quote options
6865 containing spaces)
6866 --ghc-pkg-option OPT
6868 give an extra option to ghc-pkg (no need to quote options
6869 containing spaces)
6870 --ghcjs-option OPT
6872 give an extra option to ghcjs (no need to quote options
6873 containing spaces)
6874 --ghcjs-pkg-option OPT
6876 give an extra option to ghcjs-pkg (no need to quote
6877 options containing spaces)
6878 --greencard-option OPT
6880 give an extra option to greencard (no need to quote
6881 options containing spaces)
6882 --haddock-option OPT
6884 give an extra option to haddock (no need to quote options
6885 containing spaces)
6886 --happy-option OPT
6888 give an extra option to happy (no need to quote options
6889 containing spaces)
6890 --haskell-suite-option OPT
6892 give an extra option to haskell-suite (no need to quote
6893 options containing spaces)
6894 --haskell-suite-pkg-option OPT
6896 give an extra option to haskell-suite-pkg (no need to
6897 quote options containing spaces)
6898 --hmake-option OPT
6900 give an extra option to hmake (no need to quote options
6901 containing spaces)
6902 --hpc-option OPT
6904 give an extra option to hpc (no need to quote options
6905 containing spaces)
6906 --hsc2hs-option OPT
6908 give an extra option to hsc2hs (no need to quote options
6909 containing spaces)
6910 --hscolour-option OPT
6912 give an extra option to hscolour (no need to quote
6913 options containing spaces)
6914 --jhc-option OPT
6916 give an extra option to jhc (no need to quote options
6917 containing spaces)
6918 --ld-option OPT
6920 give an extra option to ld (no need to quote options con‐
6921 taining spaces)
6922 --pkg-config-option OPT
6924 give an extra option to pkg-config (no need to quote
6925 options containing spaces)
6926 --runghc-option OPT
6928 give an extra option to runghc (no need to quote options
6929 containing spaces)
6930 --strip-option OPT
6932 give an extra option to strip (no need to quote options
6933 containing spaces)
6934 --tar-option OPT
6936 give an extra option to tar (no need to quote options
6937 containing spaces)
6938 --uhc-option OPT
6940 give an extra option to uhc (no need to quote options
6941 containing spaces)
6942 --alex-options OPTS
6944 give extra options to alex
6945 --ar-options OPTS
6947 give extra options to ar
6948 --c2hs-options OPTS
6950 give extra options to c2hs
6951 --cpphs-options OPTS
6953 give extra options to cpphs
6954 --doctest-options OPTS
6956 give extra options to doctest
6957 --gcc-options OPTS
6959 give extra options to gcc
6960 --ghc-options OPTS
6962 give extra options to ghc
6963 --ghc-pkg-options OPTS
6965 give extra options to ghc-pkg
6966 --ghcjs-options OPTS
6968 give extra options to ghcjs
6969 --ghcjs-pkg-options OPTS
6971 give extra options to ghcjs-pkg
6972 --greencard-options OPTS
6974 give extra options to greencard
6975 --haddock-options OPTS
6977 give extra options to haddock
6978 --happy-options OPTS
6980 give extra options to happy
6981 --haskell-suite-options OPTS
6983 give extra options to haskell-suite
6984 --haskell-suite-pkg-options OPTS
6986 give extra options to haskell-suite-pkg
6987 --hmake-options OPTS
6989 give extra options to hmake
6990 --hpc-options OPTS
6992 give extra options to hpc
6993 --hsc2hs-options OPTS
6995 give extra options to hsc2hs
6996 --hscolour-options OPTS
6998 give extra options to hscolour
6999 --jhc-options OPTS
7001 give extra options to jhc
7002 --ld-options OPTS
7004 give extra options to ld
7005 --pkg-config-options OPTS
7007 give extra options to pkg-config
7008 --runghc-options OPTS
7010 give extra options to runghc
7011 --strip-options OPTS
7013 give extra options to strip
7014 --tar-options OPTS
7016 give extra options to tar
7017 --uhc-options OPTS
7019 give extra options to uhc
7020 --cabal-lib-version VERSION
7022 Select which version of the Cabal lib to use to build
7023 packages (useful for testing).
7024 --constraint CONSTRAINT
7026 Specify constraints on a package (version,
7027 installed/source, flags)
7028 --preference CONSTRAINT
7030 Specify preferences (soft constraints) on the version of
7031 a package
7032 --solver SOLVER
7034 Select dependency solver to use (default: modular).
7035 Choices: modular.
7036 --allow-older [DEPS]
7038 Ignore lower bounds in all dependencies or DEPS
7039 --allow-newer [DEPS]
7041 Ignore upper bounds in all dependencies or DEPS
7042 --enable-documentation
7044 --disable-documentation
7045 building of documentation
7046 --doc-index-file TEMPLATE
7048 A central index of haddock API documentation (template
7049 cannot use $pkgid)
7050 --dry-run
7052 Do not install anything, only print what would be
7053 installed.
7054 --max-backjumps NUM
7056 Maximum number of backjumps allowed while solving
7057 (default: 2000). Use a negative number to enable unlim‐
7058 ited backtracking. Use 0 to disable backtracking com‐
7059 pletely.
7060 --reorder-goals
7062 --no-reorder-goals
7063 Try to reorder goals according to certain heuristics.
7064 Slows things down on average, but may make backtracking
7065 faster for some packages.
7066 --count-conflicts
7068 --no-count-conflicts
7069 Try to speed up solving by preferring goals that are
7070 involved in a lot of conflicts (default).
7071 --independent-goals
7073 --no-independent-goals
7074 Treat several goals on the command line as independent.
7075 If several goals depend on the same package, different
7076 versions can be chosen.
7077 --shadow-installed-packages
7079 --no-shadow-installed-packages
7080 If multiple package instances of the same version are
7081 installed, treat all but one as shadowed.
7082 --strong-flags
7084 --no-strong-flags
7085 Do not defer flag choices (this used to be the default in
7086 cabal-install <= 1.20).
7087 --allow-boot-library-installs
7089 --no-allow-boot-library-installs
7090 Allow cabal to install base, ghc-prim, integer-simple,
7091 integer-gmp, and template-haskell.
7092 --reinstall
7094 --no-reinstall
7095 Install even if it means installing the same version
7096 again.
7097 --avoid-reinstalls
7099 --no-avoid-reinstalls
7100 Do not select versions that would destructively overwrite
7101 installed packages.
7102 --force-reinstalls
7104 --no-force-reinstalls
7105 Reinstall packages even if they will most likely break
7106 other installed packages.
7107 --upgrade-dependencies
7109 --no-upgrade-dependencies
7110 Pick the latest version for all dependencies, rather than
7111 trying to pick an installed version.
7112 --only-dependencies
7114 --no-only-dependencies
7115 Install only the dependencies necessary to build the
7116 given packages
7117 --dependencies-only
7119 --no-dependencies-only
7120 A synonym for --only-dependencies
7121 --index-state STATE
7123 Use source package index state as it existed at a previ‐
7124 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
7125 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
7126 'HEAD' (default: 'HEAD').
7127 --root-cmd COMMAND
7129 (No longer supported, do not use.)
7130 --symlink-bindir DIR
7132 Add symlinks to installed executables into this direc‐
7133 tory.
7134 --build-summary TEMPLATE
7136 Save build summaries to file (name template can use
7137 $pkgid, $compiler, $os, $arch)
7138 --build-log TEMPLATE
7140 Log all builds to file (name template can use $pkgid,
7141 $compiler, $os, $arch)
7142 --remote-build-reporting LEVEL
7144 Generate build reports to send to a remote server (none,
7145 anonymous or detailed).
7146 --report-planning-failure
7148 Generate build reports when the dependency solver fails.
7149 This is used by the Hackage build bot.
7150 --enable-per-component
7152 --disable-per-component
7153 Per-component builds when possible
7154 --one-shot
7156 --no-one-shot
7157 Do not record the packages in the world file.
7158 --run-tests
7160 Run package test suites during installation.
7161 -j, --jobs [NUM]
7163 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
7164 given).
7165 --keep-going
7167 After a build failure, continue to build other unaffected
7168 packages.
7169 --offline
7171 --no-offline
7172 Don't download packages from the Internet.
7173 --project-file FILE
7175 Set the name of the cabal.project file to search for in
7176 parent directories
7177 --only
7179 Only installs the package in the current directory.
7180 --haddock-hoogle
7182 Generate a hoogle database
7183 --haddock-html
7185 Generate HTML documentation (the default)
7186 --haddock-html-location URL
7188 Location of HTML documentation for pre-requisite packages
7189 --haddock-for-hackage
7191 Collection of flags to generate documentation suitable
7192 for upload to hackage
7193 --haddock-executables
7195 Run haddock for Executables targets
7196 --haddock-tests
7198 Run haddock for Test Suite targets
7199 --haddock-benchmarks
7201 Run haddock for Benchmark targets
7202 --haddock-all
7204 Run haddock for all targets
7205 --haddock-internal
7207 Run haddock for internal modules and include all symbols
7208 --haddock-css PATH
7210 Use PATH as the haddock stylesheet
7211 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
7213 dock-hyperlinked-source
7214 Hyperlink the documentation to the source code
7215 --haddock-quickjump
7217 Generate an index for interactive documentation naviga‐
7218 tion
7219 --haddock-hscolour-css PATH
7221 Use PATH as the HsColour stylesheet
7222 --haddock-contents-location URL
7224 Bake URL in as the location for the contents page
7225 cabal new-freeze
7228 Usage: cabal new-freeze [FLAGS]
7230 The project configuration is frozen so that it will be reproducible in
7233 future.
7234 The precise dependency configuration for the project is written to the
7236 specified). This file extends the configuration from the
7237 'cabal.project' file and thus is used as the project configuration for
7238 all other commands (such as
7239 The freeze file can be kept in source control. To make small adjust‐
7241 ments it may be edited manually, or to make bigger changes you may wish
7242 to delete the file and re-freeze. For more control, one approach is to
7243 try variations using once you have a satisfactory solution to freeze it
7244 using the 'new-freeze' command with the same set of flags.
7245 Examples:
7248 cabal new-freeze
7249 Freeze the configuration of the current project
7250 cabal new-build --dry-run --constraint="aeson < 1"
7252 Check what a solution with the given constraints would look like
7253 cabal new-freeze --constraint="aeson < 1"
7254 Freeze a solution using the given constraints
7255 Note: this command is part of the new project-based system (aka nix-
7257 style local builds). These features are currently in beta. Please see
7258 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
7259 details and advice on what you can expect to work. If you encounter
7260 problems please file issues at https://github.com/haskell/cabal/issues
7261 and if you have any time to get involved and help with testing, fixing
7262 bugs etc then that is very much appreciated.
7263 Flags:
7266 -v, --verbose [n]
7267 Control verbosity (n is 0--3, default verbosity level is
7268 1)
7269 --builddir, --distdir, --distpref DIR
7271 The directory where Cabal puts generated build files
7272 (default dist)
7273 -g, --ghc
7275 compile with GHC
7276 --ghcjs
7278 compile with GHCJS
7279 --uhc
7281 compile with UHC
7282 --haskell-suite
7284 compile with a haskell-suite compiler
7285 --cabal-file PATH
7287 use this Cabal file
7288 -w, --with-compiler PATH
7290 give the path to a particular compiler
7291 --with-hc-pkg PATH
7293 give the path to the package tool
7294 --prefix DIR
7296 bake this prefix in preparation of installation
7297 --bindir DIR
7299 installation directory for executables
7300 --libdir DIR
7302 installation directory for libraries
7303 --libsubdir DIR
7305 subdirectory of libdir in which libs are installed
7306 --dynlibdir DIR
7308 installation directory for dynamic libraries
7309 --libexecdir DIR
7311 installation directory for program executables
7312 --libexecsubdir DIR
7314 subdirectory of libexecdir in which private executables
7315 are installed
7316 --datadir DIR
7318 installation directory for read-only data
7319 --datasubdir DIR
7321 subdirectory of datadir in which data files are installed
7322 --docdir DIR
7324 installation directory for documentation
7325 --htmldir DIR
7327 installation directory for HTML documentation
7328 --haddockdir DIR
7330 installation directory for haddock interfaces
7331 --sysconfdir DIR
7333 installation directory for configuration files
7334 --program-prefix PREFIX
7336 prefix to be applied to installed executables
7337 --program-suffix SUFFIX
7339 suffix to be applied to installed executables
7340 --enable-library-vanilla
7342 --disable-library-vanilla
7343 Vanilla libraries
7344 -p, --enable-library-profiling
7346 --disable-library-profiling
7347 Library profiling
7348 --enable-shared
7350 --disable-shared
7351 Shared library
7352 --enable-static
7354 --disable-static
7355 Static library
7356 --enable-executable-dynamic
7358 --disable-executable-dynamic
7359 Executable dynamic linking
7360 --enable-profiling
7362 --disable-profiling
7363 Executable and library profiling
7364 --enable-executable-profiling
7366 --disable-executable-profiling
7367 Executable profiling (DEPRECATED)
7368 --profiling-detail level
7370 Profiling detail level for executable and library
7371 (default, none, exported-functions, toplevel-functions,
7372 all-functions).
7373 --library-profiling-detail level
7375 Profiling detail level for libraries only.
7376 -O, --enable-optimization, --enable-optimisation [n]
7378 Build with optimization (n is 0--2, default is 1)
7379 --disable-optimization, --disable-optimisation
7381 Build without optimization
7382 --enable-debug-info [n]
7384 Emit debug info (n is 0--3, default is 0)
7385 --disable-debug-info
7387 Don't emit debug info
7388 --enable-library-for-ghci
7390 --disable-library-for-ghci
7391 compile library for use with GHCi
7392 --enable-split-sections
7394 --disable-split-sections
7395 compile library code such that unneeded definitions can
7396 be dropped from the final executable (GHC 7.8+)
7397 --enable-split-objs
7399 --disable-split-objs
7400 split library into smaller objects to reduce binary sizes
7401 (GHC 6.6+)
7402 --enable-executable-stripping
7404 --disable-executable-stripping
7405 strip executables upon installation to reduce binary
7406 sizes
7407 --enable-library-stripping
7409 --disable-library-stripping
7410 strip libraries upon installation to reduce binary sizes
7411 --configure-option OPT
7413 Extra option for configure
7414 --user
7416 --global
7417 doing a per-user installation
7418 --package-db DB
7420 Append the given package database to the list of package
7421 databases used (to satisfy dependencies and register
7422 into). May be a specific file, 'global' or 'user'. The
7423 initial list is ['global'], ['global', 'user'], or
7424 ['global', $sandbox], depending on context. Use 'clear'
7425 to reset the list to empty. See the user guide for
7426 details.
7427 -f, --flags FLAGS
7429 Force values for the given flags in Cabal conditionals in
7430 the .cabal file. E.g., --flags="debug -usebytestrings"
7431 forces the flag "debug" to true and "usebytestrings" to
7432 false.
7433 --extra-include-dirs PATH
7435 A list of directories to search for header files
7436 --enable-deterministic
7438 --disable-deterministic
7439 Try to be as deterministic as possible (used by the test
7440 suite)
7441 --ipid IPID
7443 Installed package ID to compile this package as
7444 --cid CID
7446 Installed component ID to compile this component as
7447 --extra-lib-dirs PATH
7449 A list of directories to search for external libraries
7450 --extra-framework-dirs PATH
7452 A list of directories to search for external frameworks
7453 (OS X only)
7454 --extra-prog-path PATH
7456 A list of directories to search for required programs (in
7457 addition to the normal search locations)
7458 --instantiate-with NAME=MOD
7460 A mapping of signature names to concrete module instanti‐
7461 ations.
7462 --enable-tests
7464 --disable-tests
7465 dependency checking and compilation for test suites
7466 listed in the package description file.
7467 --enable-coverage
7469 --disable-coverage
7470 build package with Haskell Program Coverage. (GHC only)
7471 --enable-library-coverage
7473 --disable-library-coverage
7474 build package with Haskell Program Coverage. (GHC only)
7475 (DEPRECATED)
7476 --enable-benchmarks
7478 --disable-benchmarks
7479 dependency checking and compilation for benchmarks listed
7480 in the package description file.
7481 --enable-relocatable
7483 --disable-relocatable
7484 building a package that is relocatable. (GHC only)
7485 --disable-response-files
7487 enable workaround for old versions of programs like "ar"
7488 that do not support @file arguments
7489 --with-alex PATH
7491 give the path to alex
7492 --with-ar PATH
7494 give the path to ar
7495 --with-c2hs PATH
7497 give the path to c2hs
7498 --with-cpphs PATH
7500 give the path to cpphs
7501 --with-doctest PATH
7503 give the path to doctest
7504 --with-gcc PATH
7506 give the path to gcc
7507 --with-ghc PATH
7509 give the path to ghc
7510 --with-ghc-pkg PATH
7512 give the path to ghc-pkg
7513 --with-ghcjs PATH
7515 give the path to ghcjs
7516 --with-ghcjs-pkg PATH
7518 give the path to ghcjs-pkg
7519 --with-greencard PATH
7521 give the path to greencard
7522 --with-haddock PATH
7524 give the path to haddock
7525 --with-happy PATH
7527 give the path to happy
7528 --with-haskell-suite PATH
7530 give the path to haskell-suite
7531 --with-haskell-suite-pkg PATH
7533 give the path to haskell-suite-pkg
7534 --with-hmake PATH
7536 give the path to hmake
7537 --with-hpc PATH
7539 give the path to hpc
7540 --with-hsc2hs PATH
7542 give the path to hsc2hs
7543 --with-hscolour PATH
7545 give the path to hscolour
7546 --with-jhc PATH
7548 give the path to jhc
7549 --with-ld PATH
7551 give the path to ld
7552 --with-pkg-config PATH
7554 give the path to pkg-config
7555 --with-runghc PATH
7557 give the path to runghc
7558 --with-strip PATH
7560 give the path to strip
7561 --with-tar PATH
7563 give the path to tar
7564 --with-uhc PATH
7566 give the path to uhc
7567 --alex-option OPT
7569 give an extra option to alex (no need to quote options
7570 containing spaces)
7571 --ar-option OPT
7573 give an extra option to ar (no need to quote options con‐
7574 taining spaces)
7575 --c2hs-option OPT
7577 give an extra option to c2hs (no need to quote options
7578 containing spaces)
7579 --cpphs-option OPT
7581 give an extra option to cpphs (no need to quote options
7582 containing spaces)
7583 --doctest-option OPT
7585 give an extra option to doctest (no need to quote options
7586 containing spaces)
7587 --gcc-option OPT
7589 give an extra option to gcc (no need to quote options
7590 containing spaces)
7591 --ghc-option OPT
7593 give an extra option to ghc (no need to quote options
7594 containing spaces)
7595 --ghc-pkg-option OPT
7597 give an extra option to ghc-pkg (no need to quote options
7598 containing spaces)
7599 --ghcjs-option OPT
7601 give an extra option to ghcjs (no need to quote options
7602 containing spaces)
7603 --ghcjs-pkg-option OPT
7605 give an extra option to ghcjs-pkg (no need to quote
7606 options containing spaces)
7607 --greencard-option OPT
7609 give an extra option to greencard (no need to quote
7610 options containing spaces)
7611 --haddock-option OPT
7613 give an extra option to haddock (no need to quote options
7614 containing spaces)
7615 --happy-option OPT
7617 give an extra option to happy (no need to quote options
7618 containing spaces)
7619 --haskell-suite-option OPT
7621 give an extra option to haskell-suite (no need to quote
7622 options containing spaces)
7623 --haskell-suite-pkg-option OPT
7625 give an extra option to haskell-suite-pkg (no need to
7626 quote options containing spaces)
7627 --hmake-option OPT
7629 give an extra option to hmake (no need to quote options
7630 containing spaces)
7631 --hpc-option OPT
7633 give an extra option to hpc (no need to quote options
7634 containing spaces)
7635 --hsc2hs-option OPT
7637 give an extra option to hsc2hs (no need to quote options
7638 containing spaces)
7639 --hscolour-option OPT
7641 give an extra option to hscolour (no need to quote
7642 options containing spaces)
7643 --jhc-option OPT
7645 give an extra option to jhc (no need to quote options
7646 containing spaces)
7647 --ld-option OPT
7649 give an extra option to ld (no need to quote options con‐
7650 taining spaces)
7651 --pkg-config-option OPT
7653 give an extra option to pkg-config (no need to quote
7654 options containing spaces)
7655 --runghc-option OPT
7657 give an extra option to runghc (no need to quote options
7658 containing spaces)
7659 --strip-option OPT
7661 give an extra option to strip (no need to quote options
7662 containing spaces)
7663 --tar-option OPT
7665 give an extra option to tar (no need to quote options
7666 containing spaces)
7667 --uhc-option OPT
7669 give an extra option to uhc (no need to quote options
7670 containing spaces)
7671 --alex-options OPTS
7673 give extra options to alex
7674 --ar-options OPTS
7676 give extra options to ar
7677 --c2hs-options OPTS
7679 give extra options to c2hs
7680 --cpphs-options OPTS
7682 give extra options to cpphs
7683 --doctest-options OPTS
7685 give extra options to doctest
7686 --gcc-options OPTS
7688 give extra options to gcc
7689 --ghc-options OPTS
7691 give extra options to ghc
7692 --ghc-pkg-options OPTS
7694 give extra options to ghc-pkg
7695 --ghcjs-options OPTS
7697 give extra options to ghcjs
7698 --ghcjs-pkg-options OPTS
7700 give extra options to ghcjs-pkg
7701 --greencard-options OPTS
7703 give extra options to greencard
7704 --haddock-options OPTS
7706 give extra options to haddock
7707 --happy-options OPTS
7709 give extra options to happy
7710 --haskell-suite-options OPTS
7712 give extra options to haskell-suite
7713 --haskell-suite-pkg-options OPTS
7715 give extra options to haskell-suite-pkg
7716 --hmake-options OPTS
7718 give extra options to hmake
7719 --hpc-options OPTS
7721 give extra options to hpc
7722 --hsc2hs-options OPTS
7724 give extra options to hsc2hs
7725 --hscolour-options OPTS
7727 give extra options to hscolour
7728 --jhc-options OPTS
7730 give extra options to jhc
7731 --ld-options OPTS
7733 give extra options to ld
7734 --pkg-config-options OPTS
7736 give extra options to pkg-config
7737 --runghc-options OPTS
7739 give extra options to runghc
7740 --strip-options OPTS
7742 give extra options to strip
7743 --tar-options OPTS
7745 give extra options to tar
7746 --uhc-options OPTS
7748 give extra options to uhc
7749 --cabal-lib-version VERSION
7751 Select which version of the Cabal lib to use to build
7752 packages (useful for testing).
7753 --constraint CONSTRAINT
7755 Specify constraints on a package (version,
7756 installed/source, flags)
7757 --preference CONSTRAINT
7759 Specify preferences (soft constraints) on the version of
7760 a package
7761 --solver SOLVER
7763 Select dependency solver to use (default: modular).
7764 Choices: modular.
7765 --allow-older [DEPS]
7767 Ignore lower bounds in all dependencies or DEPS
7768 --allow-newer [DEPS]
7770 Ignore upper bounds in all dependencies or DEPS
7771 --enable-documentation
7773 --disable-documentation
7774 building of documentation
7775 --doc-index-file TEMPLATE
7777 A central index of haddock API documentation (template
7778 cannot use $pkgid)
7779 --dry-run
7781 Do not install anything, only print what would be
7782 installed.
7783 --max-backjumps NUM
7785 Maximum number of backjumps allowed while solving
7786 (default: 2000). Use a negative number to enable unlim‐
7787 ited backtracking. Use 0 to disable backtracking com‐
7788 pletely.
7789 --reorder-goals
7791 --no-reorder-goals
7792 Try to reorder goals according to certain heuristics.
7793 Slows things down on average, but may make backtracking
7794 faster for some packages.
7795 --count-conflicts
7797 --no-count-conflicts
7798 Try to speed up solving by preferring goals that are
7799 involved in a lot of conflicts (default).
7800 --independent-goals
7802 --no-independent-goals
7803 Treat several goals on the command line as independent.
7804 If several goals depend on the same package, different
7805 versions can be chosen.
7806 --shadow-installed-packages
7808 --no-shadow-installed-packages
7809 If multiple package instances of the same version are
7810 installed, treat all but one as shadowed.
7811 --strong-flags
7813 --no-strong-flags
7814 Do not defer flag choices (this used to be the default in
7815 cabal-install <= 1.20).
7816 --allow-boot-library-installs
7818 --no-allow-boot-library-installs
7819 Allow cabal to install base, ghc-prim, integer-simple,
7820 integer-gmp, and template-haskell.
7821 --reinstall
7823 --no-reinstall
7824 Install even if it means installing the same version
7825 again.
7826 --avoid-reinstalls
7828 --no-avoid-reinstalls
7829 Do not select versions that would destructively overwrite
7830 installed packages.
7831 --force-reinstalls
7833 --no-force-reinstalls
7834 Reinstall packages even if they will most likely break
7835 other installed packages.
7836 --upgrade-dependencies
7838 --no-upgrade-dependencies
7839 Pick the latest version for all dependencies, rather than
7840 trying to pick an installed version.
7841 --only-dependencies
7843 --no-only-dependencies
7844 Install only the dependencies necessary to build the
7845 given packages
7846 --dependencies-only
7848 --no-dependencies-only
7849 A synonym for --only-dependencies
7850 --index-state STATE
7852 Use source package index state as it existed at a previ‐
7853 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
7854 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
7855 'HEAD' (default: 'HEAD').
7856 --root-cmd COMMAND
7858 (No longer supported, do not use.)
7859 --symlink-bindir DIR
7861 Add symlinks to installed executables into this direc‐
7862 tory.
7863 --build-summary TEMPLATE
7865 Save build summaries to file (name template can use
7866 $pkgid, $compiler, $os, $arch)
7867 --build-log TEMPLATE
7869 Log all builds to file (name template can use $pkgid,
7870 $compiler, $os, $arch)
7871 --remote-build-reporting LEVEL
7873 Generate build reports to send to a remote server (none,
7874 anonymous or detailed).
7875 --report-planning-failure
7877 Generate build reports when the dependency solver fails.
7878 This is used by the Hackage build bot.
7879 --enable-per-component
7881 --disable-per-component
7882 Per-component builds when possible
7883 --one-shot
7885 --no-one-shot
7886 Do not record the packages in the world file.
7887 --run-tests
7889 Run package test suites during installation.
7890 -j, --jobs [NUM]
7892 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
7893 given).
7894 --keep-going
7896 After a build failure, continue to build other unaffected
7897 packages.
7898 --offline
7900 --no-offline
7901 Don't download packages from the Internet.
7902 --project-file FILE
7904 Set the name of the cabal.project file to search for in
7905 parent directories
7906 --only
7908 Only installs the package in the current directory.
7909 --haddock-hoogle
7911 Generate a hoogle database
7912 --haddock-html
7914 Generate HTML documentation (the default)
7915 --haddock-html-location URL
7917 Location of HTML documentation for pre-requisite packages
7918 --haddock-for-hackage
7920 Collection of flags to generate documentation suitable
7921 for upload to hackage
7922 --haddock-executables
7924 Run haddock for Executables targets
7925 --haddock-tests
7927 Run haddock for Test Suite targets
7928 --haddock-benchmarks
7930 Run haddock for Benchmark targets
7931 --haddock-all
7933 Run haddock for all targets
7934 --haddock-internal
7936 Run haddock for internal modules and include all symbols
7937 --haddock-css PATH
7939 Use PATH as the haddock stylesheet
7940 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
7942 dock-hyperlinked-source
7943 Hyperlink the documentation to the source code
7944 --haddock-quickjump
7946 Generate an index for interactive documentation naviga‐
7947 tion
7948 --haddock-hscolour-css PATH
7950 Use PATH as the HsColour stylesheet
7951 --haddock-contents-location URL
7953 Bake URL in as the location for the contents page
7954 cabal v2-haddock
7957 Usage: cabal v2-haddock [FLAGS] TARGET
7959 Build Haddock documentation for the specified packages within the
7962 project.
7963 Any package in the project can be specified. If no package is speci‐
7965 fied, the default is to build the documentation for the package in the
7966 current directory. The default behaviour is to build documentation for
7967 the exposed modules of the library component (if any). This can be
7968 changed with the
7969 Currently, documentation for dependencies is NOT built. This behavior
7971 may change in future.
7972 Additional configuration flags can be specified on the command line and
7974 these extend the project configuration from the 'cabal.project',
7975 Build Haddock documentation for the specified packages within the
7978 project.
7979 Any package in the project can be specified. If no package is speci‐
7981 fied, the default is to build the documentation for the package in the
7982 current directory. The default behaviour is to build documentation for
7983 the exposed modules of the library component (if any). This can be
7984 changed with the
7985 Currently, documentation for dependencies is NOT built. This behavior
7987 may change in future.
7988 Additional configuration flags can be specified on the command line and
7990 these extend the project configuration from the 'cabal.project',
7991 Flags:
7994 -v, --verbose [n]
7995 Control verbosity (n is 0--3, default verbosity level is
7996 1)
7997 --builddir, --distdir, --distpref DIR
7999 The directory where Cabal puts generated build files
8000 (default dist)
8001 -g, --ghc
8003 compile with GHC
8004 --ghcjs
8006 compile with GHCJS
8007 --uhc
8009 compile with UHC
8010 --haskell-suite
8012 compile with a haskell-suite compiler
8013 --cabal-file PATH
8015 use this Cabal file
8016 -w, --with-compiler PATH
8018 give the path to a particular compiler
8019 --with-hc-pkg PATH
8021 give the path to the package tool
8022 --prefix DIR
8024 bake this prefix in preparation of installation
8025 --bindir DIR
8027 installation directory for executables
8028 --libdir DIR
8030 installation directory for libraries
8031 --libsubdir DIR
8033 subdirectory of libdir in which libs are installed
8034 --dynlibdir DIR
8036 installation directory for dynamic libraries
8037 --libexecdir DIR
8039 installation directory for program executables
8040 --libexecsubdir DIR
8042 subdirectory of libexecdir in which private executables
8043 are installed
8044 --datadir DIR
8046 installation directory for read-only data
8047 --datasubdir DIR
8049 subdirectory of datadir in which data files are installed
8050 --docdir DIR
8052 installation directory for documentation
8053 --htmldir DIR
8055 installation directory for HTML documentation
8056 --haddockdir DIR
8058 installation directory for haddock interfaces
8059 --sysconfdir DIR
8061 installation directory for configuration files
8062 --program-prefix PREFIX
8064 prefix to be applied to installed executables
8065 --program-suffix SUFFIX
8067 suffix to be applied to installed executables
8068 --enable-library-vanilla
8070 --disable-library-vanilla
8071 Vanilla libraries
8072 -p, --enable-library-profiling
8074 --disable-library-profiling
8075 Library profiling
8076 --enable-shared
8078 --disable-shared
8079 Shared library
8080 --enable-static
8082 --disable-static
8083 Static library
8084 --enable-executable-dynamic
8086 --disable-executable-dynamic
8087 Executable dynamic linking
8088 --enable-profiling
8090 --disable-profiling
8091 Executable and library profiling
8092 --enable-executable-profiling
8094 --disable-executable-profiling
8095 Executable profiling (DEPRECATED)
8096 --profiling-detail level
8098 Profiling detail level for executable and library
8099 (default, none, exported-functions, toplevel-functions,
8100 all-functions).
8101 --library-profiling-detail level
8103 Profiling detail level for libraries only.
8104 -O, --enable-optimization, --enable-optimisation [n]
8106 Build with optimization (n is 0--2, default is 1)
8107 --disable-optimization, --disable-optimisation
8109 Build without optimization
8110 --enable-debug-info [n]
8112 Emit debug info (n is 0--3, default is 0)
8113 --disable-debug-info
8115 Don't emit debug info
8116 --enable-library-for-ghci
8118 --disable-library-for-ghci
8119 compile library for use with GHCi
8120 --enable-split-sections
8122 --disable-split-sections
8123 compile library code such that unneeded definitions can
8124 be dropped from the final executable (GHC 7.8+)
8125 --enable-split-objs
8127 --disable-split-objs
8128 split library into smaller objects to reduce binary sizes
8129 (GHC 6.6+)
8130 --enable-executable-stripping
8132 --disable-executable-stripping
8133 strip executables upon installation to reduce binary
8134 sizes
8135 --enable-library-stripping
8137 --disable-library-stripping
8138 strip libraries upon installation to reduce binary sizes
8139 --configure-option OPT
8141 Extra option for configure
8142 --user
8144 --global
8145 doing a per-user installation
8146 --package-db DB
8148 Append the given package database to the list of package
8149 databases used (to satisfy dependencies and register
8150 into). May be a specific file, 'global' or 'user'. The
8151 initial list is ['global'], ['global', 'user'], or
8152 ['global', $sandbox], depending on context. Use 'clear'
8153 to reset the list to empty. See the user guide for
8154 details.
8155 -f, --flags FLAGS
8157 Force values for the given flags in Cabal conditionals in
8158 the .cabal file. E.g., --flags="debug -usebytestrings"
8159 forces the flag "debug" to true and "usebytestrings" to
8160 false.
8161 --extra-include-dirs PATH
8163 A list of directories to search for header files
8164 --enable-deterministic
8166 --disable-deterministic
8167 Try to be as deterministic as possible (used by the test
8168 suite)
8169 --ipid IPID
8171 Installed package ID to compile this package as
8172 --cid CID
8174 Installed component ID to compile this component as
8175 --extra-lib-dirs PATH
8177 A list of directories to search for external libraries
8178 --extra-framework-dirs PATH
8180 A list of directories to search for external frameworks
8181 (OS X only)
8182 --extra-prog-path PATH
8184 A list of directories to search for required programs (in
8185 addition to the normal search locations)
8186 --instantiate-with NAME=MOD
8188 A mapping of signature names to concrete module instanti‐
8189 ations.
8190 --enable-tests
8192 --disable-tests
8193 dependency checking and compilation for test suites
8194 listed in the package description file.
8195 --enable-coverage
8197 --disable-coverage
8198 build package with Haskell Program Coverage. (GHC only)
8199 --enable-library-coverage
8201 --disable-library-coverage
8202 build package with Haskell Program Coverage. (GHC only)
8203 (DEPRECATED)
8204 --enable-benchmarks
8206 --disable-benchmarks
8207 dependency checking and compilation for benchmarks listed
8208 in the package description file.
8209 --enable-relocatable
8211 --disable-relocatable
8212 building a package that is relocatable. (GHC only)
8213 --disable-response-files
8215 enable workaround for old versions of programs like "ar"
8216 that do not support @file arguments
8217 --with-alex PATH
8219 give the path to alex
8220 --with-ar PATH
8222 give the path to ar
8223 --with-c2hs PATH
8225 give the path to c2hs
8226 --with-cpphs PATH
8228 give the path to cpphs
8229 --with-doctest PATH
8231 give the path to doctest
8232 --with-gcc PATH
8234 give the path to gcc
8235 --with-ghc PATH
8237 give the path to ghc
8238 --with-ghc-pkg PATH
8240 give the path to ghc-pkg
8241 --with-ghcjs PATH
8243 give the path to ghcjs
8244 --with-ghcjs-pkg PATH
8246 give the path to ghcjs-pkg
8247 --with-greencard PATH
8249 give the path to greencard
8250 --with-haddock PATH
8252 give the path to haddock
8253 --with-happy PATH
8255 give the path to happy
8256 --with-haskell-suite PATH
8258 give the path to haskell-suite
8259 --with-haskell-suite-pkg PATH
8261 give the path to haskell-suite-pkg
8262 --with-hmake PATH
8264 give the path to hmake
8265 --with-hpc PATH
8267 give the path to hpc
8268 --with-hsc2hs PATH
8270 give the path to hsc2hs
8271 --with-hscolour PATH
8273 give the path to hscolour
8274 --with-jhc PATH
8276 give the path to jhc
8277 --with-ld PATH
8279 give the path to ld
8280 --with-pkg-config PATH
8282 give the path to pkg-config
8283 --with-runghc PATH
8285 give the path to runghc
8286 --with-strip PATH
8288 give the path to strip
8289 --with-tar PATH
8291 give the path to tar
8292 --with-uhc PATH
8294 give the path to uhc
8295 --alex-option OPT
8297 give an extra option to alex (no need to quote options
8298 containing spaces)
8299 --ar-option OPT
8301 give an extra option to ar (no need to quote options con‐
8302 taining spaces)
8303 --c2hs-option OPT
8305 give an extra option to c2hs (no need to quote options
8306 containing spaces)
8307 --cpphs-option OPT
8309 give an extra option to cpphs (no need to quote options
8310 containing spaces)
8311 --doctest-option OPT
8313 give an extra option to doctest (no need to quote options
8314 containing spaces)
8315 --gcc-option OPT
8317 give an extra option to gcc (no need to quote options
8318 containing spaces)
8319 --ghc-option OPT
8321 give an extra option to ghc (no need to quote options
8322 containing spaces)
8323 --ghc-pkg-option OPT
8325 give an extra option to ghc-pkg (no need to quote options
8326 containing spaces)
8327 --ghcjs-option OPT
8329 give an extra option to ghcjs (no need to quote options
8330 containing spaces)
8331 --ghcjs-pkg-option OPT
8333 give an extra option to ghcjs-pkg (no need to quote
8334 options containing spaces)
8335 --greencard-option OPT
8337 give an extra option to greencard (no need to quote
8338 options containing spaces)
8339 --haddock-option OPT
8341 give an extra option to haddock (no need to quote options
8342 containing spaces)
8343 --happy-option OPT
8345 give an extra option to happy (no need to quote options
8346 containing spaces)
8347 --haskell-suite-option OPT
8349 give an extra option to haskell-suite (no need to quote
8350 options containing spaces)
8351 --haskell-suite-pkg-option OPT
8353 give an extra option to haskell-suite-pkg (no need to
8354 quote options containing spaces)
8355 --hmake-option OPT
8357 give an extra option to hmake (no need to quote options
8358 containing spaces)
8359 --hpc-option OPT
8361 give an extra option to hpc (no need to quote options
8362 containing spaces)
8363 --hsc2hs-option OPT
8365 give an extra option to hsc2hs (no need to quote options
8366 containing spaces)
8367 --hscolour-option OPT
8369 give an extra option to hscolour (no need to quote
8370 options containing spaces)
8371 --jhc-option OPT
8373 give an extra option to jhc (no need to quote options
8374 containing spaces)
8375 --ld-option OPT
8377 give an extra option to ld (no need to quote options con‐
8378 taining spaces)
8379 --pkg-config-option OPT
8381 give an extra option to pkg-config (no need to quote
8382 options containing spaces)
8383 --runghc-option OPT
8385 give an extra option to runghc (no need to quote options
8386 containing spaces)
8387 --strip-option OPT
8389 give an extra option to strip (no need to quote options
8390 containing spaces)
8391 --tar-option OPT
8393 give an extra option to tar (no need to quote options
8394 containing spaces)
8395 --uhc-option OPT
8397 give an extra option to uhc (no need to quote options
8398 containing spaces)
8399 --alex-options OPTS
8401 give extra options to alex
8402 --ar-options OPTS
8404 give extra options to ar
8405 --c2hs-options OPTS
8407 give extra options to c2hs
8408 --cpphs-options OPTS
8410 give extra options to cpphs
8411 --doctest-options OPTS
8413 give extra options to doctest
8414 --gcc-options OPTS
8416 give extra options to gcc
8417 --ghc-options OPTS
8419 give extra options to ghc
8420 --ghc-pkg-options OPTS
8422 give extra options to ghc-pkg
8423 --ghcjs-options OPTS
8425 give extra options to ghcjs
8426 --ghcjs-pkg-options OPTS
8428 give extra options to ghcjs-pkg
8429 --greencard-options OPTS
8431 give extra options to greencard
8432 --haddock-options OPTS
8434 give extra options to haddock
8435 --happy-options OPTS
8437 give extra options to happy
8438 --haskell-suite-options OPTS
8440 give extra options to haskell-suite
8441 --haskell-suite-pkg-options OPTS
8443 give extra options to haskell-suite-pkg
8444 --hmake-options OPTS
8446 give extra options to hmake
8447 --hpc-options OPTS
8449 give extra options to hpc
8450 --hsc2hs-options OPTS
8452 give extra options to hsc2hs
8453 --hscolour-options OPTS
8455 give extra options to hscolour
8456 --jhc-options OPTS
8458 give extra options to jhc
8459 --ld-options OPTS
8461 give extra options to ld
8462 --pkg-config-options OPTS
8464 give extra options to pkg-config
8465 --runghc-options OPTS
8467 give extra options to runghc
8468 --strip-options OPTS
8470 give extra options to strip
8471 --tar-options OPTS
8473 give extra options to tar
8474 --uhc-options OPTS
8476 give extra options to uhc
8477 --cabal-lib-version VERSION
8479 Select which version of the Cabal lib to use to build
8480 packages (useful for testing).
8481 --constraint CONSTRAINT
8483 Specify constraints on a package (version,
8484 installed/source, flags)
8485 --preference CONSTRAINT
8487 Specify preferences (soft constraints) on the version of
8488 a package
8489 --solver SOLVER
8491 Select dependency solver to use (default: modular).
8492 Choices: modular.
8493 --allow-older [DEPS]
8495 Ignore lower bounds in all dependencies or DEPS
8496 --allow-newer [DEPS]
8498 Ignore upper bounds in all dependencies or DEPS
8499 --enable-documentation
8501 --disable-documentation
8502 building of documentation
8503 --doc-index-file TEMPLATE
8505 A central index of haddock API documentation (template
8506 cannot use $pkgid)
8507 --dry-run
8509 Do not install anything, only print what would be
8510 installed.
8511 --max-backjumps NUM
8513 Maximum number of backjumps allowed while solving
8514 (default: 2000). Use a negative number to enable unlim‐
8515 ited backtracking. Use 0 to disable backtracking com‐
8516 pletely.
8517 --reorder-goals
8519 --no-reorder-goals
8520 Try to reorder goals according to certain heuristics.
8521 Slows things down on average, but may make backtracking
8522 faster for some packages.
8523 --count-conflicts
8525 --no-count-conflicts
8526 Try to speed up solving by preferring goals that are
8527 involved in a lot of conflicts (default).
8528 --independent-goals
8530 --no-independent-goals
8531 Treat several goals on the command line as independent.
8532 If several goals depend on the same package, different
8533 versions can be chosen.
8534 --shadow-installed-packages
8536 --no-shadow-installed-packages
8537 If multiple package instances of the same version are
8538 installed, treat all but one as shadowed.
8539 --strong-flags
8541 --no-strong-flags
8542 Do not defer flag choices (this used to be the default in
8543 cabal-install <= 1.20).
8544 --allow-boot-library-installs
8546 --no-allow-boot-library-installs
8547 Allow cabal to install base, ghc-prim, integer-simple,
8548 integer-gmp, and template-haskell.
8549 --reinstall
8551 --no-reinstall
8552 Install even if it means installing the same version
8553 again.
8554 --avoid-reinstalls
8556 --no-avoid-reinstalls
8557 Do not select versions that would destructively overwrite
8558 installed packages.
8559 --force-reinstalls
8561 --no-force-reinstalls
8562 Reinstall packages even if they will most likely break
8563 other installed packages.
8564 --upgrade-dependencies
8566 --no-upgrade-dependencies
8567 Pick the latest version for all dependencies, rather than
8568 trying to pick an installed version.
8569 --only-dependencies
8571 --no-only-dependencies
8572 Install only the dependencies necessary to build the
8573 given packages
8574 --dependencies-only
8576 --no-dependencies-only
8577 A synonym for --only-dependencies
8578 --index-state STATE
8580 Use source package index state as it existed at a previ‐
8581 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
8582 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
8583 'HEAD' (default: 'HEAD').
8584 --root-cmd COMMAND
8586 (No longer supported, do not use.)
8587 --symlink-bindir DIR
8589 Add symlinks to installed executables into this direc‐
8590 tory.
8591 --build-summary TEMPLATE
8593 Save build summaries to file (name template can use
8594 $pkgid, $compiler, $os, $arch)
8595 --build-log TEMPLATE
8597 Log all builds to file (name template can use $pkgid,
8598 $compiler, $os, $arch)
8599 --remote-build-reporting LEVEL
8601 Generate build reports to send to a remote server (none,
8602 anonymous or detailed).
8603 --report-planning-failure
8605 Generate build reports when the dependency solver fails.
8606 This is used by the Hackage build bot.
8607 --enable-per-component
8609 --disable-per-component
8610 Per-component builds when possible
8611 --one-shot
8613 --no-one-shot
8614 Do not record the packages in the world file.
8615 --run-tests
8617 Run package test suites during installation.
8618 -j, --jobs [NUM]
8620 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
8621 given).
8622 --keep-going
8624 After a build failure, continue to build other unaffected
8625 packages.
8626 --offline
8628 --no-offline
8629 Don't download packages from the Internet.
8630 --project-file FILE
8632 Set the name of the cabal.project file to search for in
8633 parent directories
8634 --only
8636 Only installs the package in the current directory.
8637 --haddock-hoogle
8639 Generate a hoogle database
8640 --haddock-html
8642 Generate HTML documentation (the default)
8643 --haddock-html-location URL
8645 Location of HTML documentation for pre-requisite packages
8646 --haddock-for-hackage
8648 Collection of flags to generate documentation suitable
8649 for upload to hackage
8650 --haddock-executables
8652 Run haddock for Executables targets
8653 --haddock-tests
8655 Run haddock for Test Suite targets
8656 --haddock-benchmarks
8658 Run haddock for Benchmark targets
8659 --haddock-all
8661 Run haddock for all targets
8662 --haddock-internal
8664 Run haddock for internal modules and include all symbols
8665 --haddock-css PATH
8667 Use PATH as the haddock stylesheet
8668 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
8670 dock-hyperlinked-source
8671 Hyperlink the documentation to the source code
8672 --haddock-quickjump
8674 Generate an index for interactive documentation naviga‐
8675 tion
8676 --haddock-hscolour-css PATH
8678 Use PATH as the HsColour stylesheet
8679 --haddock-contents-location URL
8681 Bake URL in as the location for the contents page
8682 cabal new-haddock
8685 Usage: cabal new-haddock [FLAGS] TARGET
8687 Build Haddock documentation for the specified packages within the
8690 project.
8691 Any package in the project can be specified. If no package is speci‐
8693 fied, the default is to build the documentation for the package in the
8694 current directory. The default behaviour is to build documentation for
8695 the exposed modules of the library component (if any). This can be
8696 changed with the
8697 Currently, documentation for dependencies is NOT built. This behavior
8699 may change in future.
8700 Additional configuration flags can be specified on the command line and
8702 these extend the project configuration from the 'cabal.project',
8703 Examples:
8706 cabal new-haddock pkgname Build documentation for the package
8707 named pkgname
8708 Note: this command is part of the new project-based system (aka nix-
8710 style local builds). These features are currently in beta. Please see
8711 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
8712 details and advice on what you can expect to work. If you encounter
8713 problems please file issues at https://github.com/haskell/cabal/issues
8714 and if you have any time to get involved and help with testing, fixing
8715 bugs etc then that is very much appreciated.
8716 Flags:
8719 -v, --verbose [n]
8720 Control verbosity (n is 0--3, default verbosity level is
8721 1)
8722 --builddir, --distdir, --distpref DIR
8724 The directory where Cabal puts generated build files
8725 (default dist)
8726 -g, --ghc
8728 compile with GHC
8729 --ghcjs
8731 compile with GHCJS
8732 --uhc
8734 compile with UHC
8735 --haskell-suite
8737 compile with a haskell-suite compiler
8738 --cabal-file PATH
8740 use this Cabal file
8741 -w, --with-compiler PATH
8743 give the path to a particular compiler
8744 --with-hc-pkg PATH
8746 give the path to the package tool
8747 --prefix DIR
8749 bake this prefix in preparation of installation
8750 --bindir DIR
8752 installation directory for executables
8753 --libdir DIR
8755 installation directory for libraries
8756 --libsubdir DIR
8758 subdirectory of libdir in which libs are installed
8759 --dynlibdir DIR
8761 installation directory for dynamic libraries
8762 --libexecdir DIR
8764 installation directory for program executables
8765 --libexecsubdir DIR
8767 subdirectory of libexecdir in which private executables
8768 are installed
8769 --datadir DIR
8771 installation directory for read-only data
8772 --datasubdir DIR
8774 subdirectory of datadir in which data files are installed
8775 --docdir DIR
8777 installation directory for documentation
8778 --htmldir DIR
8780 installation directory for HTML documentation
8781 --haddockdir DIR
8783 installation directory for haddock interfaces
8784 --sysconfdir DIR
8786 installation directory for configuration files
8787 --program-prefix PREFIX
8789 prefix to be applied to installed executables
8790 --program-suffix SUFFIX
8792 suffix to be applied to installed executables
8793 --enable-library-vanilla
8795 --disable-library-vanilla
8796 Vanilla libraries
8797 -p, --enable-library-profiling
8799 --disable-library-profiling
8800 Library profiling
8801 --enable-shared
8803 --disable-shared
8804 Shared library
8805 --enable-static
8807 --disable-static
8808 Static library
8809 --enable-executable-dynamic
8811 --disable-executable-dynamic
8812 Executable dynamic linking
8813 --enable-profiling
8815 --disable-profiling
8816 Executable and library profiling
8817 --enable-executable-profiling
8819 --disable-executable-profiling
8820 Executable profiling (DEPRECATED)
8821 --profiling-detail level
8823 Profiling detail level for executable and library
8824 (default, none, exported-functions, toplevel-functions,
8825 all-functions).
8826 --library-profiling-detail level
8828 Profiling detail level for libraries only.
8829 -O, --enable-optimization, --enable-optimisation [n]
8831 Build with optimization (n is 0--2, default is 1)
8832 --disable-optimization, --disable-optimisation
8834 Build without optimization
8835 --enable-debug-info [n]
8837 Emit debug info (n is 0--3, default is 0)
8838 --disable-debug-info
8840 Don't emit debug info
8841 --enable-library-for-ghci
8843 --disable-library-for-ghci
8844 compile library for use with GHCi
8845 --enable-split-sections
8847 --disable-split-sections
8848 compile library code such that unneeded definitions can
8849 be dropped from the final executable (GHC 7.8+)
8850 --enable-split-objs
8852 --disable-split-objs
8853 split library into smaller objects to reduce binary sizes
8854 (GHC 6.6+)
8855 --enable-executable-stripping
8857 --disable-executable-stripping
8858 strip executables upon installation to reduce binary
8859 sizes
8860 --enable-library-stripping
8862 --disable-library-stripping
8863 strip libraries upon installation to reduce binary sizes
8864 --configure-option OPT
8866 Extra option for configure
8867 --user
8869 --global
8870 doing a per-user installation
8871 --package-db DB
8873 Append the given package database to the list of package
8874 databases used (to satisfy dependencies and register
8875 into). May be a specific file, 'global' or 'user'. The
8876 initial list is ['global'], ['global', 'user'], or
8877 ['global', $sandbox], depending on context. Use 'clear'
8878 to reset the list to empty. See the user guide for
8879 details.
8880 -f, --flags FLAGS
8882 Force values for the given flags in Cabal conditionals in
8883 the .cabal file. E.g., --flags="debug -usebytestrings"
8884 forces the flag "debug" to true and "usebytestrings" to
8885 false.
8886 --extra-include-dirs PATH
8888 A list of directories to search for header files
8889 --enable-deterministic
8891 --disable-deterministic
8892 Try to be as deterministic as possible (used by the test
8893 suite)
8894 --ipid IPID
8896 Installed package ID to compile this package as
8897 --cid CID
8899 Installed component ID to compile this component as
8900 --extra-lib-dirs PATH
8902 A list of directories to search for external libraries
8903 --extra-framework-dirs PATH
8905 A list of directories to search for external frameworks
8906 (OS X only)
8907 --extra-prog-path PATH
8909 A list of directories to search for required programs (in
8910 addition to the normal search locations)
8911 --instantiate-with NAME=MOD
8913 A mapping of signature names to concrete module instanti‐
8914 ations.
8915 --enable-tests
8917 --disable-tests
8918 dependency checking and compilation for test suites
8919 listed in the package description file.
8920 --enable-coverage
8922 --disable-coverage
8923 build package with Haskell Program Coverage. (GHC only)
8924 --enable-library-coverage
8926 --disable-library-coverage
8927 build package with Haskell Program Coverage. (GHC only)
8928 (DEPRECATED)
8929 --enable-benchmarks
8931 --disable-benchmarks
8932 dependency checking and compilation for benchmarks listed
8933 in the package description file.
8934 --enable-relocatable
8936 --disable-relocatable
8937 building a package that is relocatable. (GHC only)
8938 --disable-response-files
8940 enable workaround for old versions of programs like "ar"
8941 that do not support @file arguments
8942 --with-alex PATH
8944 give the path to alex
8945 --with-ar PATH
8947 give the path to ar
8948 --with-c2hs PATH
8950 give the path to c2hs
8951 --with-cpphs PATH
8953 give the path to cpphs
8954 --with-doctest PATH
8956 give the path to doctest
8957 --with-gcc PATH
8959 give the path to gcc
8960 --with-ghc PATH
8962 give the path to ghc
8963 --with-ghc-pkg PATH
8965 give the path to ghc-pkg
8966 --with-ghcjs PATH
8968 give the path to ghcjs
8969 --with-ghcjs-pkg PATH
8971 give the path to ghcjs-pkg
8972 --with-greencard PATH
8974 give the path to greencard
8975 --with-haddock PATH
8977 give the path to haddock
8978 --with-happy PATH
8980 give the path to happy
8981 --with-haskell-suite PATH
8983 give the path to haskell-suite
8984 --with-haskell-suite-pkg PATH
8986 give the path to haskell-suite-pkg
8987 --with-hmake PATH
8989 give the path to hmake
8990 --with-hpc PATH
8992 give the path to hpc
8993 --with-hsc2hs PATH
8995 give the path to hsc2hs
8996 --with-hscolour PATH
8998 give the path to hscolour
8999 --with-jhc PATH
9001 give the path to jhc
9002 --with-ld PATH
9004 give the path to ld
9005 --with-pkg-config PATH
9007 give the path to pkg-config
9008 --with-runghc PATH
9010 give the path to runghc
9011 --with-strip PATH
9013 give the path to strip
9014 --with-tar PATH
9016 give the path to tar
9017 --with-uhc PATH
9019 give the path to uhc
9020 --alex-option OPT
9022 give an extra option to alex (no need to quote options
9023 containing spaces)
9024 --ar-option OPT
9026 give an extra option to ar (no need to quote options con‐
9027 taining spaces)
9028 --c2hs-option OPT
9030 give an extra option to c2hs (no need to quote options
9031 containing spaces)
9032 --cpphs-option OPT
9034 give an extra option to cpphs (no need to quote options
9035 containing spaces)
9036 --doctest-option OPT
9038 give an extra option to doctest (no need to quote options
9039 containing spaces)
9040 --gcc-option OPT
9042 give an extra option to gcc (no need to quote options
9043 containing spaces)
9044 --ghc-option OPT
9046 give an extra option to ghc (no need to quote options
9047 containing spaces)
9048 --ghc-pkg-option OPT
9050 give an extra option to ghc-pkg (no need to quote options
9051 containing spaces)
9052 --ghcjs-option OPT
9054 give an extra option to ghcjs (no need to quote options
9055 containing spaces)
9056 --ghcjs-pkg-option OPT
9058 give an extra option to ghcjs-pkg (no need to quote
9059 options containing spaces)
9060 --greencard-option OPT
9062 give an extra option to greencard (no need to quote
9063 options containing spaces)
9064 --haddock-option OPT
9066 give an extra option to haddock (no need to quote options
9067 containing spaces)
9068 --happy-option OPT
9070 give an extra option to happy (no need to quote options
9071 containing spaces)
9072 --haskell-suite-option OPT
9074 give an extra option to haskell-suite (no need to quote
9075 options containing spaces)
9076 --haskell-suite-pkg-option OPT
9078 give an extra option to haskell-suite-pkg (no need to
9079 quote options containing spaces)
9080 --hmake-option OPT
9082 give an extra option to hmake (no need to quote options
9083 containing spaces)
9084 --hpc-option OPT
9086 give an extra option to hpc (no need to quote options
9087 containing spaces)
9088 --hsc2hs-option OPT
9090 give an extra option to hsc2hs (no need to quote options
9091 containing spaces)
9092 --hscolour-option OPT
9094 give an extra option to hscolour (no need to quote
9095 options containing spaces)
9096 --jhc-option OPT
9098 give an extra option to jhc (no need to quote options
9099 containing spaces)
9100 --ld-option OPT
9102 give an extra option to ld (no need to quote options con‐
9103 taining spaces)
9104 --pkg-config-option OPT
9106 give an extra option to pkg-config (no need to quote
9107 options containing spaces)
9108 --runghc-option OPT
9110 give an extra option to runghc (no need to quote options
9111 containing spaces)
9112 --strip-option OPT
9114 give an extra option to strip (no need to quote options
9115 containing spaces)
9116 --tar-option OPT
9118 give an extra option to tar (no need to quote options
9119 containing spaces)
9120 --uhc-option OPT
9122 give an extra option to uhc (no need to quote options
9123 containing spaces)
9124 --alex-options OPTS
9126 give extra options to alex
9127 --ar-options OPTS
9129 give extra options to ar
9130 --c2hs-options OPTS
9132 give extra options to c2hs
9133 --cpphs-options OPTS
9135 give extra options to cpphs
9136 --doctest-options OPTS
9138 give extra options to doctest
9139 --gcc-options OPTS
9141 give extra options to gcc
9142 --ghc-options OPTS
9144 give extra options to ghc
9145 --ghc-pkg-options OPTS
9147 give extra options to ghc-pkg
9148 --ghcjs-options OPTS
9150 give extra options to ghcjs
9151 --ghcjs-pkg-options OPTS
9153 give extra options to ghcjs-pkg
9154 --greencard-options OPTS
9156 give extra options to greencard
9157 --haddock-options OPTS
9159 give extra options to haddock
9160 --happy-options OPTS
9162 give extra options to happy
9163 --haskell-suite-options OPTS
9165 give extra options to haskell-suite
9166 --haskell-suite-pkg-options OPTS
9168 give extra options to haskell-suite-pkg
9169 --hmake-options OPTS
9171 give extra options to hmake
9172 --hpc-options OPTS
9174 give extra options to hpc
9175 --hsc2hs-options OPTS
9177 give extra options to hsc2hs
9178 --hscolour-options OPTS
9180 give extra options to hscolour
9181 --jhc-options OPTS
9183 give extra options to jhc
9184 --ld-options OPTS
9186 give extra options to ld
9187 --pkg-config-options OPTS
9189 give extra options to pkg-config
9190 --runghc-options OPTS
9192 give extra options to runghc
9193 --strip-options OPTS
9195 give extra options to strip
9196 --tar-options OPTS
9198 give extra options to tar
9199 --uhc-options OPTS
9201 give extra options to uhc
9202 --cabal-lib-version VERSION
9204 Select which version of the Cabal lib to use to build
9205 packages (useful for testing).
9206 --constraint CONSTRAINT
9208 Specify constraints on a package (version,
9209 installed/source, flags)
9210 --preference CONSTRAINT
9212 Specify preferences (soft constraints) on the version of
9213 a package
9214 --solver SOLVER
9216 Select dependency solver to use (default: modular).
9217 Choices: modular.
9218 --allow-older [DEPS]
9220 Ignore lower bounds in all dependencies or DEPS
9221 --allow-newer [DEPS]
9223 Ignore upper bounds in all dependencies or DEPS
9224 --enable-documentation
9226 --disable-documentation
9227 building of documentation
9228 --doc-index-file TEMPLATE
9230 A central index of haddock API documentation (template
9231 cannot use $pkgid)
9232 --dry-run
9234 Do not install anything, only print what would be
9235 installed.
9236 --max-backjumps NUM
9238 Maximum number of backjumps allowed while solving
9239 (default: 2000). Use a negative number to enable unlim‐
9240 ited backtracking. Use 0 to disable backtracking com‐
9241 pletely.
9242 --reorder-goals
9244 --no-reorder-goals
9245 Try to reorder goals according to certain heuristics.
9246 Slows things down on average, but may make backtracking
9247 faster for some packages.
9248 --count-conflicts
9250 --no-count-conflicts
9251 Try to speed up solving by preferring goals that are
9252 involved in a lot of conflicts (default).
9253 --independent-goals
9255 --no-independent-goals
9256 Treat several goals on the command line as independent.
9257 If several goals depend on the same package, different
9258 versions can be chosen.
9259 --shadow-installed-packages
9261 --no-shadow-installed-packages
9262 If multiple package instances of the same version are
9263 installed, treat all but one as shadowed.
9264 --strong-flags
9266 --no-strong-flags
9267 Do not defer flag choices (this used to be the default in
9268 cabal-install <= 1.20).
9269 --allow-boot-library-installs
9271 --no-allow-boot-library-installs
9272 Allow cabal to install base, ghc-prim, integer-simple,
9273 integer-gmp, and template-haskell.
9274 --reinstall
9276 --no-reinstall
9277 Install even if it means installing the same version
9278 again.
9279 --avoid-reinstalls
9281 --no-avoid-reinstalls
9282 Do not select versions that would destructively overwrite
9283 installed packages.
9284 --force-reinstalls
9286 --no-force-reinstalls
9287 Reinstall packages even if they will most likely break
9288 other installed packages.
9289 --upgrade-dependencies
9291 --no-upgrade-dependencies
9292 Pick the latest version for all dependencies, rather than
9293 trying to pick an installed version.
9294 --only-dependencies
9296 --no-only-dependencies
9297 Install only the dependencies necessary to build the
9298 given packages
9299 --dependencies-only
9301 --no-dependencies-only
9302 A synonym for --only-dependencies
9303 --index-state STATE
9305 Use source package index state as it existed at a previ‐
9306 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
9307 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
9308 'HEAD' (default: 'HEAD').
9309 --root-cmd COMMAND
9311 (No longer supported, do not use.)
9312 --symlink-bindir DIR
9314 Add symlinks to installed executables into this direc‐
9315 tory.
9316 --build-summary TEMPLATE
9318 Save build summaries to file (name template can use
9319 $pkgid, $compiler, $os, $arch)
9320 --build-log TEMPLATE
9322 Log all builds to file (name template can use $pkgid,
9323 $compiler, $os, $arch)
9324 --remote-build-reporting LEVEL
9326 Generate build reports to send to a remote server (none,
9327 anonymous or detailed).
9328 --report-planning-failure
9330 Generate build reports when the dependency solver fails.
9331 This is used by the Hackage build bot.
9332 --enable-per-component
9334 --disable-per-component
9335 Per-component builds when possible
9336 --one-shot
9338 --no-one-shot
9339 Do not record the packages in the world file.
9340 --run-tests
9342 Run package test suites during installation.
9343 -j, --jobs [NUM]
9345 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
9346 given).
9347 --keep-going
9349 After a build failure, continue to build other unaffected
9350 packages.
9351 --offline
9353 --no-offline
9354 Don't download packages from the Internet.
9355 --project-file FILE
9357 Set the name of the cabal.project file to search for in
9358 parent directories
9359 --only
9361 Only installs the package in the current directory.
9362 --haddock-hoogle
9364 Generate a hoogle database
9365 --haddock-html
9367 Generate HTML documentation (the default)
9368 --haddock-html-location URL
9370 Location of HTML documentation for pre-requisite packages
9371 --haddock-for-hackage
9373 Collection of flags to generate documentation suitable
9374 for upload to hackage
9375 --haddock-executables
9377 Run haddock for Executables targets
9378 --haddock-tests
9380 Run haddock for Test Suite targets
9381 --haddock-benchmarks
9383 Run haddock for Benchmark targets
9384 --haddock-all
9386 Run haddock for all targets
9387 --haddock-internal
9389 Run haddock for internal modules and include all symbols
9390 --haddock-css PATH
9392 Use PATH as the haddock stylesheet
9393 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
9395 dock-hyperlinked-source
9396 Hyperlink the documentation to the source code
9397 --haddock-quickjump
9399 Generate an index for interactive documentation naviga‐
9400 tion
9401 --haddock-hscolour-css PATH
9403 Use PATH as the HsColour stylesheet
9404 --haddock-contents-location URL
9406 Bake URL in as the location for the contents page
9407 cabal v2-install
9410 Usage: cabal v2-install [TARGETS] [FLAGS]
9412 Installs one or more packages. This is done by installing them in the
9415 store and symlinking the executables in the directory specified by the
9416 --symlink-bindir flag (`~/.cabal/bin/` by default). If you want the
9417 installed executables to be available globally, make sure that the PATH
9418 environment variable contains that directory.
9419 If TARGET is a library, it will be added to the global environment.
9421 When doing this, cabal will try to build a plan that includes all the
9422 previously installed libraries. This is currently not implemented.
9423 Installs one or more packages. This is done by installing them in the
9426 store and symlinking the executables in the directory specified by the
9427 --symlink-bindir flag (`~/.cabal/bin/` by default). If you want the
9428 installed executables to be available globally, make sure that the PATH
9429 environment variable contains that directory.
9430 If TARGET is a library, it will be added to the global environment.
9432 When doing this, cabal will try to build a plan that includes all the
9433 previously installed libraries. This is currently not implemented.
9434 Flags:
9437 -v, --verbose [n]
9438 Control verbosity (n is 0--3, default verbosity level is
9439 1)
9440 --builddir, --distdir, --distpref DIR
9442 The directory where Cabal puts generated build files
9443 (default dist)
9444 -g, --ghc
9446 compile with GHC
9447 --ghcjs
9449 compile with GHCJS
9450 --uhc
9452 compile with UHC
9453 --haskell-suite
9455 compile with a haskell-suite compiler
9456 --cabal-file PATH
9458 use this Cabal file
9459 -w, --with-compiler PATH
9461 give the path to a particular compiler
9462 --with-hc-pkg PATH
9464 give the path to the package tool
9465 --prefix DIR
9467 bake this prefix in preparation of installation
9468 --bindir DIR
9470 installation directory for executables
9471 --libdir DIR
9473 installation directory for libraries
9474 --libsubdir DIR
9476 subdirectory of libdir in which libs are installed
9477 --dynlibdir DIR
9479 installation directory for dynamic libraries
9480 --libexecdir DIR
9482 installation directory for program executables
9483 --libexecsubdir DIR
9485 subdirectory of libexecdir in which private executables
9486 are installed
9487 --datadir DIR
9489 installation directory for read-only data
9490 --datasubdir DIR
9492 subdirectory of datadir in which data files are installed
9493 --docdir DIR
9495 installation directory for documentation
9496 --htmldir DIR
9498 installation directory for HTML documentation
9499 --haddockdir DIR
9501 installation directory for haddock interfaces
9502 --sysconfdir DIR
9504 installation directory for configuration files
9505 --program-prefix PREFIX
9507 prefix to be applied to installed executables
9508 --program-suffix SUFFIX
9510 suffix to be applied to installed executables
9511 --enable-library-vanilla
9513 --disable-library-vanilla
9514 Vanilla libraries
9515 -p, --enable-library-profiling
9517 --disable-library-profiling
9518 Library profiling
9519 --enable-shared
9521 --disable-shared
9522 Shared library
9523 --enable-static
9525 --disable-static
9526 Static library
9527 --enable-executable-dynamic
9529 --disable-executable-dynamic
9530 Executable dynamic linking
9531 --enable-profiling
9533 --disable-profiling
9534 Executable and library profiling
9535 --enable-executable-profiling
9537 --disable-executable-profiling
9538 Executable profiling (DEPRECATED)
9539 --profiling-detail level
9541 Profiling detail level for executable and library
9542 (default, none, exported-functions, toplevel-functions,
9543 all-functions).
9544 --library-profiling-detail level
9546 Profiling detail level for libraries only.
9547 -O, --enable-optimization, --enable-optimisation [n]
9549 Build with optimization (n is 0--2, default is 1)
9550 --disable-optimization, --disable-optimisation
9552 Build without optimization
9553 --enable-debug-info [n]
9555 Emit debug info (n is 0--3, default is 0)
9556 --disable-debug-info
9558 Don't emit debug info
9559 --enable-library-for-ghci
9561 --disable-library-for-ghci
9562 compile library for use with GHCi
9563 --enable-split-sections
9565 --disable-split-sections
9566 compile library code such that unneeded definitions can
9567 be dropped from the final executable (GHC 7.8+)
9568 --enable-split-objs
9570 --disable-split-objs
9571 split library into smaller objects to reduce binary sizes
9572 (GHC 6.6+)
9573 --enable-executable-stripping
9575 --disable-executable-stripping
9576 strip executables upon installation to reduce binary
9577 sizes
9578 --enable-library-stripping
9580 --disable-library-stripping
9581 strip libraries upon installation to reduce binary sizes
9582 --configure-option OPT
9584 Extra option for configure
9585 --user
9587 --global
9588 doing a per-user installation
9589 --package-db DB
9591 Append the given package database to the list of package
9592 databases used (to satisfy dependencies and register
9593 into). May be a specific file, 'global' or 'user'. The
9594 initial list is ['global'], ['global', 'user'], or
9595 ['global', $sandbox], depending on context. Use 'clear'
9596 to reset the list to empty. See the user guide for
9597 details.
9598 -f, --flags FLAGS
9600 Force values for the given flags in Cabal conditionals in
9601 the .cabal file. E.g., --flags="debug -usebytestrings"
9602 forces the flag "debug" to true and "usebytestrings" to
9603 false.
9604 --extra-include-dirs PATH
9606 A list of directories to search for header files
9607 --enable-deterministic
9609 --disable-deterministic
9610 Try to be as deterministic as possible (used by the test
9611 suite)
9612 --ipid IPID
9614 Installed package ID to compile this package as
9615 --cid CID
9617 Installed component ID to compile this component as
9618 --extra-lib-dirs PATH
9620 A list of directories to search for external libraries
9621 --extra-framework-dirs PATH
9623 A list of directories to search for external frameworks
9624 (OS X only)
9625 --extra-prog-path PATH
9627 A list of directories to search for required programs (in
9628 addition to the normal search locations)
9629 --instantiate-with NAME=MOD
9631 A mapping of signature names to concrete module instanti‐
9632 ations.
9633 --enable-tests
9635 --disable-tests
9636 dependency checking and compilation for test suites
9637 listed in the package description file.
9638 --enable-coverage
9640 --disable-coverage
9641 build package with Haskell Program Coverage. (GHC only)
9642 --enable-library-coverage
9644 --disable-library-coverage
9645 build package with Haskell Program Coverage. (GHC only)
9646 (DEPRECATED)
9647 --enable-benchmarks
9649 --disable-benchmarks
9650 dependency checking and compilation for benchmarks listed
9651 in the package description file.
9652 --enable-relocatable
9654 --disable-relocatable
9655 building a package that is relocatable. (GHC only)
9656 --disable-response-files
9658 enable workaround for old versions of programs like "ar"
9659 that do not support @file arguments
9660 --cabal-lib-version VERSION
9662 Select which version of the Cabal lib to use to build
9663 packages (useful for testing).
9664 --constraint CONSTRAINT
9666 Specify constraints on a package (version,
9667 installed/source, flags)
9668 --preference CONSTRAINT
9670 Specify preferences (soft constraints) on the version of
9671 a package
9672 --solver SOLVER
9674 Select dependency solver to use (default: modular).
9675 Choices: modular.
9676 --allow-older [DEPS]
9678 Ignore lower bounds in all dependencies or DEPS
9679 --allow-newer [DEPS]
9681 Ignore upper bounds in all dependencies or DEPS
9682 --enable-documentation
9684 --disable-documentation
9685 building of documentation
9686 --doc-index-file TEMPLATE
9688 A central index of haddock API documentation (template
9689 cannot use $pkgid)
9690 --dry-run
9692 Do not install anything, only print what would be
9693 installed.
9694 --max-backjumps NUM
9696 Maximum number of backjumps allowed while solving
9697 (default: 2000). Use a negative number to enable unlim‐
9698 ited backtracking. Use 0 to disable backtracking com‐
9699 pletely.
9700 --reorder-goals
9702 --no-reorder-goals
9703 Try to reorder goals according to certain heuristics.
9704 Slows things down on average, but may make backtracking
9705 faster for some packages.
9706 --count-conflicts
9708 --no-count-conflicts
9709 Try to speed up solving by preferring goals that are
9710 involved in a lot of conflicts (default).
9711 --independent-goals
9713 --no-independent-goals
9714 Treat several goals on the command line as independent.
9715 If several goals depend on the same package, different
9716 versions can be chosen.
9717 --shadow-installed-packages
9719 --no-shadow-installed-packages
9720 If multiple package instances of the same version are
9721 installed, treat all but one as shadowed.
9722 --strong-flags
9724 --no-strong-flags
9725 Do not defer flag choices (this used to be the default in
9726 cabal-install <= 1.20).
9727 --allow-boot-library-installs
9729 --no-allow-boot-library-installs
9730 Allow cabal to install base, ghc-prim, integer-simple,
9731 integer-gmp, and template-haskell.
9732 --reinstall
9734 --no-reinstall
9735 Install even if it means installing the same version
9736 again.
9737 --avoid-reinstalls
9739 --no-avoid-reinstalls
9740 Do not select versions that would destructively overwrite
9741 installed packages.
9742 --force-reinstalls
9744 --no-force-reinstalls
9745 Reinstall packages even if they will most likely break
9746 other installed packages.
9747 --upgrade-dependencies
9749 --no-upgrade-dependencies
9750 Pick the latest version for all dependencies, rather than
9751 trying to pick an installed version.
9752 --only-dependencies
9754 --no-only-dependencies
9755 Install only the dependencies necessary to build the
9756 given packages
9757 --dependencies-only
9759 --no-dependencies-only
9760 A synonym for --only-dependencies
9761 --index-state STATE
9763 Use source package index state as it existed at a previ‐
9764 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
9765 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
9766 'HEAD' (default: 'HEAD').
9767 --root-cmd COMMAND
9769 (No longer supported, do not use.)
9770 --symlink-bindir DIR
9772 Add symlinks to installed executables into this direc‐
9773 tory.
9774 --build-summary TEMPLATE
9776 Save build summaries to file (name template can use
9777 $pkgid, $compiler, $os, $arch)
9778 --build-log TEMPLATE
9780 Log all builds to file (name template can use $pkgid,
9781 $compiler, $os, $arch)
9782 --remote-build-reporting LEVEL
9784 Generate build reports to send to a remote server (none,
9785 anonymous or detailed).
9786 --report-planning-failure
9788 Generate build reports when the dependency solver fails.
9789 This is used by the Hackage build bot.
9790 --enable-per-component
9792 --disable-per-component
9793 Per-component builds when possible
9794 --one-shot
9796 --no-one-shot
9797 Do not record the packages in the world file.
9798 --run-tests
9800 Run package test suites during installation.
9801 -j, --jobs [NUM]
9803 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
9804 given).
9805 --keep-going
9807 After a build failure, continue to build other unaffected
9808 packages.
9809 --offline
9811 --no-offline
9812 Don't download packages from the Internet.
9813 --project-file FILE
9815 Set the name of the cabal.project file to search for in
9816 parent directories
9817 --only
9819 Only installs the package in the current directory.
9820 --builddir, --distdir, --distpref DIR
9822 The directory where Cabal puts generated build files
9823 (default dist)
9824 --keep-temp-files
9826 Keep temporary files
9827 --hoogle
9829 Generate a hoogle database
9830 --html
9832 Generate HTML documentation (the default)
9833 --html-location URL
9835 Location of HTML documentation for pre-requisite packages
9836 --for-hackage
9838 Collection of flags to generate documentation suitable
9839 for upload to hackage
9840 --executables
9842 Run haddock for Executables targets
9843 --tests
9845 Run haddock for Test Suite targets
9846 --benchmarks
9848 Run haddock for Benchmark targets
9849 --foreign-libraries
9851 Run haddock for Foreign Library targets
9852 --all
9854 Run haddock for all targets
9855 --internal
9857 Run haddock for internal modules and include all symbols
9858 --css PATH
9860 Use PATH as the haddock stylesheet
9861 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
9863 Hyperlink the documentation to the source code
9864 --quickjump
9866 Generate an index for interactive documentation naviga‐
9867 tion
9868 --hscolour-css PATH
9870 Use PATH as the HsColour stylesheet
9871 --contents-location URL
9873 Bake URL in as the location for the contents page
9874 --lib
9876 Install libraries rather than executables from the target
9877 package.
9878 --package-env, --env ENV
9880 Set the environment file that may be modified.
9881 cabal new-install
9884 Usage: cabal new-install [TARGETS] [FLAGS]
9886 Installs one or more packages. This is done by installing them in the
9889 store and symlinking the executables in the directory specified by the
9890 --symlink-bindir flag (`~/.cabal/bin/` by default). If you want the
9891 installed executables to be available globally, make sure that the PATH
9892 environment variable contains that directory.
9893 If TARGET is a library, it will be added to the global environment.
9895 When doing this, cabal will try to build a plan that includes all the
9896 previously installed libraries. This is currently not implemented.
9897 Examples:
9900 cabal new-install
9901 Install the package in the current directory
9902 cabal new-install pkgname
9903 Install the package named pkgname (fetching it from hackage if nec‐
9904 essary)
9905 cabal new-install ./pkgfoo
9906 Install the package in the ./pkgfoo directory Note: this command is
9907 part of the new project-based system (aka nix-style local builds).
9908 These features are currently in beta. Please see http://cabal.readthe‐
9909 docs.io/en/latest/nix-local-build-overview.html for details and advice
9910 on what you can expect to work. If you encounter problems please file
9911 issues at https://github.com/haskell/cabal/issues and if you have any
9912 time to get involved and help with testing, fixing bugs etc then that
9913 is very much appreciated.
9914 Flags:
9917 -v, --verbose [n]
9918 Control verbosity (n is 0--3, default verbosity level is
9919 1)
9920 --builddir, --distdir, --distpref DIR
9922 The directory where Cabal puts generated build files
9923 (default dist)
9924 -g, --ghc
9926 compile with GHC
9927 --ghcjs
9929 compile with GHCJS
9930 --uhc
9932 compile with UHC
9933 --haskell-suite
9935 compile with a haskell-suite compiler
9936 --cabal-file PATH
9938 use this Cabal file
9939 -w, --with-compiler PATH
9941 give the path to a particular compiler
9942 --with-hc-pkg PATH
9944 give the path to the package tool
9945 --prefix DIR
9947 bake this prefix in preparation of installation
9948 --bindir DIR
9950 installation directory for executables
9951 --libdir DIR
9953 installation directory for libraries
9954 --libsubdir DIR
9956 subdirectory of libdir in which libs are installed
9957 --dynlibdir DIR
9959 installation directory for dynamic libraries
9960 --libexecdir DIR
9962 installation directory for program executables
9963 --libexecsubdir DIR
9965 subdirectory of libexecdir in which private executables
9966 are installed
9967 --datadir DIR
9969 installation directory for read-only data
9970 --datasubdir DIR
9972 subdirectory of datadir in which data files are installed
9973 --docdir DIR
9975 installation directory for documentation
9976 --htmldir DIR
9978 installation directory for HTML documentation
9979 --haddockdir DIR
9981 installation directory for haddock interfaces
9982 --sysconfdir DIR
9984 installation directory for configuration files
9985 --program-prefix PREFIX
9987 prefix to be applied to installed executables
9988 --program-suffix SUFFIX
9990 suffix to be applied to installed executables
9991 --enable-library-vanilla
9993 --disable-library-vanilla
9994 Vanilla libraries
9995 -p, --enable-library-profiling
9997 --disable-library-profiling
9998 Library profiling
9999 --enable-shared
10001 --disable-shared
10002 Shared library
10003 --enable-static
10005 --disable-static
10006 Static library
10007 --enable-executable-dynamic
10009 --disable-executable-dynamic
10010 Executable dynamic linking
10011 --enable-profiling
10013 --disable-profiling
10014 Executable and library profiling
10015 --enable-executable-profiling
10017 --disable-executable-profiling
10018 Executable profiling (DEPRECATED)
10019 --profiling-detail level
10021 Profiling detail level for executable and library
10022 (default, none, exported-functions, toplevel-functions,
10023 all-functions).
10024 --library-profiling-detail level
10026 Profiling detail level for libraries only.
10027 -O, --enable-optimization, --enable-optimisation [n]
10029 Build with optimization (n is 0--2, default is 1)
10030 --disable-optimization, --disable-optimisation
10032 Build without optimization
10033 --enable-debug-info [n]
10035 Emit debug info (n is 0--3, default is 0)
10036 --disable-debug-info
10038 Don't emit debug info
10039 --enable-library-for-ghci
10041 --disable-library-for-ghci
10042 compile library for use with GHCi
10043 --enable-split-sections
10045 --disable-split-sections
10046 compile library code such that unneeded definitions can
10047 be dropped from the final executable (GHC 7.8+)
10048 --enable-split-objs
10050 --disable-split-objs
10051 split library into smaller objects to reduce binary sizes
10052 (GHC 6.6+)
10053 --enable-executable-stripping
10055 --disable-executable-stripping
10056 strip executables upon installation to reduce binary
10057 sizes
10058 --enable-library-stripping
10060 --disable-library-stripping
10061 strip libraries upon installation to reduce binary sizes
10062 --configure-option OPT
10064 Extra option for configure
10065 --user
10067 --global
10068 doing a per-user installation
10069 --package-db DB
10071 Append the given package database to the list of package
10072 databases used (to satisfy dependencies and register
10073 into). May be a specific file, 'global' or 'user'. The
10074 initial list is ['global'], ['global', 'user'], or
10075 ['global', $sandbox], depending on context. Use 'clear'
10076 to reset the list to empty. See the user guide for
10077 details.
10078 -f, --flags FLAGS
10080 Force values for the given flags in Cabal conditionals in
10081 the .cabal file. E.g., --flags="debug -usebytestrings"
10082 forces the flag "debug" to true and "usebytestrings" to
10083 false.
10084 --extra-include-dirs PATH
10086 A list of directories to search for header files
10087 --enable-deterministic
10089 --disable-deterministic
10090 Try to be as deterministic as possible (used by the test
10091 suite)
10092 --ipid IPID
10094 Installed package ID to compile this package as
10095 --cid CID
10097 Installed component ID to compile this component as
10098 --extra-lib-dirs PATH
10100 A list of directories to search for external libraries
10101 --extra-framework-dirs PATH
10103 A list of directories to search for external frameworks
10104 (OS X only)
10105 --extra-prog-path PATH
10107 A list of directories to search for required programs (in
10108 addition to the normal search locations)
10109 --instantiate-with NAME=MOD
10111 A mapping of signature names to concrete module instanti‐
10112 ations.
10113 --enable-tests
10115 --disable-tests
10116 dependency checking and compilation for test suites
10117 listed in the package description file.
10118 --enable-coverage
10120 --disable-coverage
10121 build package with Haskell Program Coverage. (GHC only)
10122 --enable-library-coverage
10124 --disable-library-coverage
10125 build package with Haskell Program Coverage. (GHC only)
10126 (DEPRECATED)
10127 --enable-benchmarks
10129 --disable-benchmarks
10130 dependency checking and compilation for benchmarks listed
10131 in the package description file.
10132 --enable-relocatable
10134 --disable-relocatable
10135 building a package that is relocatable. (GHC only)
10136 --disable-response-files
10138 enable workaround for old versions of programs like "ar"
10139 that do not support @file arguments
10140 --cabal-lib-version VERSION
10142 Select which version of the Cabal lib to use to build
10143 packages (useful for testing).
10144 --constraint CONSTRAINT
10146 Specify constraints on a package (version,
10147 installed/source, flags)
10148 --preference CONSTRAINT
10150 Specify preferences (soft constraints) on the version of
10151 a package
10152 --solver SOLVER
10154 Select dependency solver to use (default: modular).
10155 Choices: modular.
10156 --allow-older [DEPS]
10158 Ignore lower bounds in all dependencies or DEPS
10159 --allow-newer [DEPS]
10161 Ignore upper bounds in all dependencies or DEPS
10162 --enable-documentation
10164 --disable-documentation
10165 building of documentation
10166 --doc-index-file TEMPLATE
10168 A central index of haddock API documentation (template
10169 cannot use $pkgid)
10170 --dry-run
10172 Do not install anything, only print what would be
10173 installed.
10174 --max-backjumps NUM
10176 Maximum number of backjumps allowed while solving
10177 (default: 2000). Use a negative number to enable unlim‐
10178 ited backtracking. Use 0 to disable backtracking com‐
10179 pletely.
10180 --reorder-goals
10182 --no-reorder-goals
10183 Try to reorder goals according to certain heuristics.
10184 Slows things down on average, but may make backtracking
10185 faster for some packages.
10186 --count-conflicts
10188 --no-count-conflicts
10189 Try to speed up solving by preferring goals that are
10190 involved in a lot of conflicts (default).
10191 --independent-goals
10193 --no-independent-goals
10194 Treat several goals on the command line as independent.
10195 If several goals depend on the same package, different
10196 versions can be chosen.
10197 --shadow-installed-packages
10199 --no-shadow-installed-packages
10200 If multiple package instances of the same version are
10201 installed, treat all but one as shadowed.
10202 --strong-flags
10204 --no-strong-flags
10205 Do not defer flag choices (this used to be the default in
10206 cabal-install <= 1.20).
10207 --allow-boot-library-installs
10209 --no-allow-boot-library-installs
10210 Allow cabal to install base, ghc-prim, integer-simple,
10211 integer-gmp, and template-haskell.
10212 --reinstall
10214 --no-reinstall
10215 Install even if it means installing the same version
10216 again.
10217 --avoid-reinstalls
10219 --no-avoid-reinstalls
10220 Do not select versions that would destructively overwrite
10221 installed packages.
10222 --force-reinstalls
10224 --no-force-reinstalls
10225 Reinstall packages even if they will most likely break
10226 other installed packages.
10227 --upgrade-dependencies
10229 --no-upgrade-dependencies
10230 Pick the latest version for all dependencies, rather than
10231 trying to pick an installed version.
10232 --only-dependencies
10234 --no-only-dependencies
10235 Install only the dependencies necessary to build the
10236 given packages
10237 --dependencies-only
10239 --no-dependencies-only
10240 A synonym for --only-dependencies
10241 --index-state STATE
10243 Use source package index state as it existed at a previ‐
10244 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
10245 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
10246 'HEAD' (default: 'HEAD').
10247 --root-cmd COMMAND
10249 (No longer supported, do not use.)
10250 --symlink-bindir DIR
10252 Add symlinks to installed executables into this direc‐
10253 tory.
10254 --build-summary TEMPLATE
10256 Save build summaries to file (name template can use
10257 $pkgid, $compiler, $os, $arch)
10258 --build-log TEMPLATE
10260 Log all builds to file (name template can use $pkgid,
10261 $compiler, $os, $arch)
10262 --remote-build-reporting LEVEL
10264 Generate build reports to send to a remote server (none,
10265 anonymous or detailed).
10266 --report-planning-failure
10268 Generate build reports when the dependency solver fails.
10269 This is used by the Hackage build bot.
10270 --enable-per-component
10272 --disable-per-component
10273 Per-component builds when possible
10274 --one-shot
10276 --no-one-shot
10277 Do not record the packages in the world file.
10278 --run-tests
10280 Run package test suites during installation.
10281 -j, --jobs [NUM]
10283 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
10284 given).
10285 --keep-going
10287 After a build failure, continue to build other unaffected
10288 packages.
10289 --offline
10291 --no-offline
10292 Don't download packages from the Internet.
10293 --project-file FILE
10295 Set the name of the cabal.project file to search for in
10296 parent directories
10297 --only
10299 Only installs the package in the current directory.
10300 --builddir, --distdir, --distpref DIR
10302 The directory where Cabal puts generated build files
10303 (default dist)
10304 --keep-temp-files
10306 Keep temporary files
10307 --hoogle
10309 Generate a hoogle database
10310 --html
10312 Generate HTML documentation (the default)
10313 --html-location URL
10315 Location of HTML documentation for pre-requisite packages
10316 --for-hackage
10318 Collection of flags to generate documentation suitable
10319 for upload to hackage
10320 --executables
10322 Run haddock for Executables targets
10323 --tests
10325 Run haddock for Test Suite targets
10326 --benchmarks
10328 Run haddock for Benchmark targets
10329 --foreign-libraries
10331 Run haddock for Foreign Library targets
10332 --all
10334 Run haddock for all targets
10335 --internal
10337 Run haddock for internal modules and include all symbols
10338 --css PATH
10340 Use PATH as the haddock stylesheet
10341 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
10343 Hyperlink the documentation to the source code
10344 --quickjump
10346 Generate an index for interactive documentation naviga‐
10347 tion
10348 --hscolour-css PATH
10350 Use PATH as the HsColour stylesheet
10351 --contents-location URL
10353 Bake URL in as the location for the contents page
10354 --lib
10356 Install libraries rather than executables from the target
10357 package.
10358 --package-env, --env ENV
10360 Set the environment file that may be modified.
10361 cabal v2-run
10364 Usage: cabal v2-run [TARGET] [FLAGS] [-- EXECUTABLE_FLAGS]
10366 Runs the specified executable-like component (an executable, a test, or
10369 a benchmark), first ensuring it is up to date.
10370 Any executable-like component in any package in the project can be
10372 specified. A package can be specified if contains just one executable-
10373 like. The default is to use the package in the current directory if it
10374 contains just one executable-like.
10375 Extra arguments can be passed to the program, but use '--' to separate
10377 arguments for the program from arguments for cabal. The executable is
10378 run in an environment where it can find its data files inplace in the
10379 build tree.
10380 Dependencies are built or rebuilt as necessary. Additional configura‐
10382 tion flags can be specified on the command line and these extend the
10383 project configuration from the 'cabal.project', 'cabal.project.local'
10384 and other files.
10385 Runs the specified executable-like component (an executable, a test, or
10388 a benchmark), first ensuring it is up to date.
10389 Any executable-like component in any package in the project can be
10391 specified. A package can be specified if contains just one executable-
10392 like. The default is to use the package in the current directory if it
10393 contains just one executable-like.
10394 Extra arguments can be passed to the program, but use '--' to separate
10396 arguments for the program from arguments for cabal. The executable is
10397 run in an environment where it can find its data files inplace in the
10398 build tree.
10399 Dependencies are built or rebuilt as necessary. Additional configura‐
10401 tion flags can be specified on the command line and these extend the
10402 project configuration from the 'cabal.project', 'cabal.project.local'
10403 and other files.
10404 Flags:
10407 -v, --verbose [n]
10408 Control verbosity (n is 0--3, default verbosity level is
10409 1)
10410 --builddir, --distdir, --distpref DIR
10412 The directory where Cabal puts generated build files
10413 (default dist)
10414 -g, --ghc
10416 compile with GHC
10417 --ghcjs
10419 compile with GHCJS
10420 --uhc
10422 compile with UHC
10423 --haskell-suite
10425 compile with a haskell-suite compiler
10426 --cabal-file PATH
10428 use this Cabal file
10429 -w, --with-compiler PATH
10431 give the path to a particular compiler
10432 --with-hc-pkg PATH
10434 give the path to the package tool
10435 --prefix DIR
10437 bake this prefix in preparation of installation
10438 --bindir DIR
10440 installation directory for executables
10441 --libdir DIR
10443 installation directory for libraries
10444 --libsubdir DIR
10446 subdirectory of libdir in which libs are installed
10447 --dynlibdir DIR
10449 installation directory for dynamic libraries
10450 --libexecdir DIR
10452 installation directory for program executables
10453 --libexecsubdir DIR
10455 subdirectory of libexecdir in which private executables
10456 are installed
10457 --datadir DIR
10459 installation directory for read-only data
10460 --datasubdir DIR
10462 subdirectory of datadir in which data files are installed
10463 --docdir DIR
10465 installation directory for documentation
10466 --htmldir DIR
10468 installation directory for HTML documentation
10469 --haddockdir DIR
10471 installation directory for haddock interfaces
10472 --sysconfdir DIR
10474 installation directory for configuration files
10475 --program-prefix PREFIX
10477 prefix to be applied to installed executables
10478 --program-suffix SUFFIX
10480 suffix to be applied to installed executables
10481 --enable-library-vanilla
10483 --disable-library-vanilla
10484 Vanilla libraries
10485 -p, --enable-library-profiling
10487 --disable-library-profiling
10488 Library profiling
10489 --enable-shared
10491 --disable-shared
10492 Shared library
10493 --enable-static
10495 --disable-static
10496 Static library
10497 --enable-executable-dynamic
10499 --disable-executable-dynamic
10500 Executable dynamic linking
10501 --enable-profiling
10503 --disable-profiling
10504 Executable and library profiling
10505 --enable-executable-profiling
10507 --disable-executable-profiling
10508 Executable profiling (DEPRECATED)
10509 --profiling-detail level
10511 Profiling detail level for executable and library
10512 (default, none, exported-functions, toplevel-functions,
10513 all-functions).
10514 --library-profiling-detail level
10516 Profiling detail level for libraries only.
10517 -O, --enable-optimization, --enable-optimisation [n]
10519 Build with optimization (n is 0--2, default is 1)
10520 --disable-optimization, --disable-optimisation
10522 Build without optimization
10523 --enable-debug-info [n]
10525 Emit debug info (n is 0--3, default is 0)
10526 --disable-debug-info
10528 Don't emit debug info
10529 --enable-library-for-ghci
10531 --disable-library-for-ghci
10532 compile library for use with GHCi
10533 --enable-split-sections
10535 --disable-split-sections
10536 compile library code such that unneeded definitions can
10537 be dropped from the final executable (GHC 7.8+)
10538 --enable-split-objs
10540 --disable-split-objs
10541 split library into smaller objects to reduce binary sizes
10542 (GHC 6.6+)
10543 --enable-executable-stripping
10545 --disable-executable-stripping
10546 strip executables upon installation to reduce binary
10547 sizes
10548 --enable-library-stripping
10550 --disable-library-stripping
10551 strip libraries upon installation to reduce binary sizes
10552 --configure-option OPT
10554 Extra option for configure
10555 --user
10557 --global
10558 doing a per-user installation
10559 --package-db DB
10561 Append the given package database to the list of package
10562 databases used (to satisfy dependencies and register
10563 into). May be a specific file, 'global' or 'user'. The
10564 initial list is ['global'], ['global', 'user'], or
10565 ['global', $sandbox], depending on context. Use 'clear'
10566 to reset the list to empty. See the user guide for
10567 details.
10568 -f, --flags FLAGS
10570 Force values for the given flags in Cabal conditionals in
10571 the .cabal file. E.g., --flags="debug -usebytestrings"
10572 forces the flag "debug" to true and "usebytestrings" to
10573 false.
10574 --extra-include-dirs PATH
10576 A list of directories to search for header files
10577 --enable-deterministic
10579 --disable-deterministic
10580 Try to be as deterministic as possible (used by the test
10581 suite)
10582 --ipid IPID
10584 Installed package ID to compile this package as
10585 --cid CID
10587 Installed component ID to compile this component as
10588 --extra-lib-dirs PATH
10590 A list of directories to search for external libraries
10591 --extra-framework-dirs PATH
10593 A list of directories to search for external frameworks
10594 (OS X only)
10595 --extra-prog-path PATH
10597 A list of directories to search for required programs (in
10598 addition to the normal search locations)
10599 --instantiate-with NAME=MOD
10601 A mapping of signature names to concrete module instanti‐
10602 ations.
10603 --enable-tests
10605 --disable-tests
10606 dependency checking and compilation for test suites
10607 listed in the package description file.
10608 --enable-coverage
10610 --disable-coverage
10611 build package with Haskell Program Coverage. (GHC only)
10612 --enable-library-coverage
10614 --disable-library-coverage
10615 build package with Haskell Program Coverage. (GHC only)
10616 (DEPRECATED)
10617 --enable-benchmarks
10619 --disable-benchmarks
10620 dependency checking and compilation for benchmarks listed
10621 in the package description file.
10622 --enable-relocatable
10624 --disable-relocatable
10625 building a package that is relocatable. (GHC only)
10626 --disable-response-files
10628 enable workaround for old versions of programs like "ar"
10629 that do not support @file arguments
10630 --with-alex PATH
10632 give the path to alex
10633 --with-ar PATH
10635 give the path to ar
10636 --with-c2hs PATH
10638 give the path to c2hs
10639 --with-cpphs PATH
10641 give the path to cpphs
10642 --with-doctest PATH
10644 give the path to doctest
10645 --with-gcc PATH
10647 give the path to gcc
10648 --with-ghc PATH
10650 give the path to ghc
10651 --with-ghc-pkg PATH
10653 give the path to ghc-pkg
10654 --with-ghcjs PATH
10656 give the path to ghcjs
10657 --with-ghcjs-pkg PATH
10659 give the path to ghcjs-pkg
10660 --with-greencard PATH
10662 give the path to greencard
10663 --with-haddock PATH
10665 give the path to haddock
10666 --with-happy PATH
10668 give the path to happy
10669 --with-haskell-suite PATH
10671 give the path to haskell-suite
10672 --with-haskell-suite-pkg PATH
10674 give the path to haskell-suite-pkg
10675 --with-hmake PATH
10677 give the path to hmake
10678 --with-hpc PATH
10680 give the path to hpc
10681 --with-hsc2hs PATH
10683 give the path to hsc2hs
10684 --with-hscolour PATH
10686 give the path to hscolour
10687 --with-jhc PATH
10689 give the path to jhc
10690 --with-ld PATH
10692 give the path to ld
10693 --with-pkg-config PATH
10695 give the path to pkg-config
10696 --with-runghc PATH
10698 give the path to runghc
10699 --with-strip PATH
10701 give the path to strip
10702 --with-tar PATH
10704 give the path to tar
10705 --with-uhc PATH
10707 give the path to uhc
10708 --alex-option OPT
10710 give an extra option to alex (no need to quote options
10711 containing spaces)
10712 --ar-option OPT
10714 give an extra option to ar (no need to quote options con‐
10715 taining spaces)
10716 --c2hs-option OPT
10718 give an extra option to c2hs (no need to quote options
10719 containing spaces)
10720 --cpphs-option OPT
10722 give an extra option to cpphs (no need to quote options
10723 containing spaces)
10724 --doctest-option OPT
10726 give an extra option to doctest (no need to quote options
10727 containing spaces)
10728 --gcc-option OPT
10730 give an extra option to gcc (no need to quote options
10731 containing spaces)
10732 --ghc-option OPT
10734 give an extra option to ghc (no need to quote options
10735 containing spaces)
10736 --ghc-pkg-option OPT
10738 give an extra option to ghc-pkg (no need to quote options
10739 containing spaces)
10740 --ghcjs-option OPT
10742 give an extra option to ghcjs (no need to quote options
10743 containing spaces)
10744 --ghcjs-pkg-option OPT
10746 give an extra option to ghcjs-pkg (no need to quote
10747 options containing spaces)
10748 --greencard-option OPT
10750 give an extra option to greencard (no need to quote
10751 options containing spaces)
10752 --haddock-option OPT
10754 give an extra option to haddock (no need to quote options
10755 containing spaces)
10756 --happy-option OPT
10758 give an extra option to happy (no need to quote options
10759 containing spaces)
10760 --haskell-suite-option OPT
10762 give an extra option to haskell-suite (no need to quote
10763 options containing spaces)
10764 --haskell-suite-pkg-option OPT
10766 give an extra option to haskell-suite-pkg (no need to
10767 quote options containing spaces)
10768 --hmake-option OPT
10770 give an extra option to hmake (no need to quote options
10771 containing spaces)
10772 --hpc-option OPT
10774 give an extra option to hpc (no need to quote options
10775 containing spaces)
10776 --hsc2hs-option OPT
10778 give an extra option to hsc2hs (no need to quote options
10779 containing spaces)
10780 --hscolour-option OPT
10782 give an extra option to hscolour (no need to quote
10783 options containing spaces)
10784 --jhc-option OPT
10786 give an extra option to jhc (no need to quote options
10787 containing spaces)
10788 --ld-option OPT
10790 give an extra option to ld (no need to quote options con‐
10791 taining spaces)
10792 --pkg-config-option OPT
10794 give an extra option to pkg-config (no need to quote
10795 options containing spaces)
10796 --runghc-option OPT
10798 give an extra option to runghc (no need to quote options
10799 containing spaces)
10800 --strip-option OPT
10802 give an extra option to strip (no need to quote options
10803 containing spaces)
10804 --tar-option OPT
10806 give an extra option to tar (no need to quote options
10807 containing spaces)
10808 --uhc-option OPT
10810 give an extra option to uhc (no need to quote options
10811 containing spaces)
10812 --alex-options OPTS
10814 give extra options to alex
10815 --ar-options OPTS
10817 give extra options to ar
10818 --c2hs-options OPTS
10820 give extra options to c2hs
10821 --cpphs-options OPTS
10823 give extra options to cpphs
10824 --doctest-options OPTS
10826 give extra options to doctest
10827 --gcc-options OPTS
10829 give extra options to gcc
10830 --ghc-options OPTS
10832 give extra options to ghc
10833 --ghc-pkg-options OPTS
10835 give extra options to ghc-pkg
10836 --ghcjs-options OPTS
10838 give extra options to ghcjs
10839 --ghcjs-pkg-options OPTS
10841 give extra options to ghcjs-pkg
10842 --greencard-options OPTS
10844 give extra options to greencard
10845 --haddock-options OPTS
10847 give extra options to haddock
10848 --happy-options OPTS
10850 give extra options to happy
10851 --haskell-suite-options OPTS
10853 give extra options to haskell-suite
10854 --haskell-suite-pkg-options OPTS
10856 give extra options to haskell-suite-pkg
10857 --hmake-options OPTS
10859 give extra options to hmake
10860 --hpc-options OPTS
10862 give extra options to hpc
10863 --hsc2hs-options OPTS
10865 give extra options to hsc2hs
10866 --hscolour-options OPTS
10868 give extra options to hscolour
10869 --jhc-options OPTS
10871 give extra options to jhc
10872 --ld-options OPTS
10874 give extra options to ld
10875 --pkg-config-options OPTS
10877 give extra options to pkg-config
10878 --runghc-options OPTS
10880 give extra options to runghc
10881 --strip-options OPTS
10883 give extra options to strip
10884 --tar-options OPTS
10886 give extra options to tar
10887 --uhc-options OPTS
10889 give extra options to uhc
10890 --cabal-lib-version VERSION
10892 Select which version of the Cabal lib to use to build
10893 packages (useful for testing).
10894 --constraint CONSTRAINT
10896 Specify constraints on a package (version,
10897 installed/source, flags)
10898 --preference CONSTRAINT
10900 Specify preferences (soft constraints) on the version of
10901 a package
10902 --solver SOLVER
10904 Select dependency solver to use (default: modular).
10905 Choices: modular.
10906 --allow-older [DEPS]
10908 Ignore lower bounds in all dependencies or DEPS
10909 --allow-newer [DEPS]
10911 Ignore upper bounds in all dependencies or DEPS
10912 --enable-documentation
10914 --disable-documentation
10915 building of documentation
10916 --doc-index-file TEMPLATE
10918 A central index of haddock API documentation (template
10919 cannot use $pkgid)
10920 --dry-run
10922 Do not install anything, only print what would be
10923 installed.
10924 --max-backjumps NUM
10926 Maximum number of backjumps allowed while solving
10927 (default: 2000). Use a negative number to enable unlim‐
10928 ited backtracking. Use 0 to disable backtracking com‐
10929 pletely.
10930 --reorder-goals
10932 --no-reorder-goals
10933 Try to reorder goals according to certain heuristics.
10934 Slows things down on average, but may make backtracking
10935 faster for some packages.
10936 --count-conflicts
10938 --no-count-conflicts
10939 Try to speed up solving by preferring goals that are
10940 involved in a lot of conflicts (default).
10941 --independent-goals
10943 --no-independent-goals
10944 Treat several goals on the command line as independent.
10945 If several goals depend on the same package, different
10946 versions can be chosen.
10947 --shadow-installed-packages
10949 --no-shadow-installed-packages
10950 If multiple package instances of the same version are
10951 installed, treat all but one as shadowed.
10952 --strong-flags
10954 --no-strong-flags
10955 Do not defer flag choices (this used to be the default in
10956 cabal-install <= 1.20).
10957 --allow-boot-library-installs
10959 --no-allow-boot-library-installs
10960 Allow cabal to install base, ghc-prim, integer-simple,
10961 integer-gmp, and template-haskell.
10962 --reinstall
10964 --no-reinstall
10965 Install even if it means installing the same version
10966 again.
10967 --avoid-reinstalls
10969 --no-avoid-reinstalls
10970 Do not select versions that would destructively overwrite
10971 installed packages.
10972 --force-reinstalls
10974 --no-force-reinstalls
10975 Reinstall packages even if they will most likely break
10976 other installed packages.
10977 --upgrade-dependencies
10979 --no-upgrade-dependencies
10980 Pick the latest version for all dependencies, rather than
10981 trying to pick an installed version.
10982 --only-dependencies
10984 --no-only-dependencies
10985 Install only the dependencies necessary to build the
10986 given packages
10987 --dependencies-only
10989 --no-dependencies-only
10990 A synonym for --only-dependencies
10991 --index-state STATE
10993 Use source package index state as it existed at a previ‐
10994 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
10995 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
10996 'HEAD' (default: 'HEAD').
10997 --root-cmd COMMAND
10999 (No longer supported, do not use.)
11000 --symlink-bindir DIR
11002 Add symlinks to installed executables into this direc‐
11003 tory.
11004 --build-summary TEMPLATE
11006 Save build summaries to file (name template can use
11007 $pkgid, $compiler, $os, $arch)
11008 --build-log TEMPLATE
11010 Log all builds to file (name template can use $pkgid,
11011 $compiler, $os, $arch)
11012 --remote-build-reporting LEVEL
11014 Generate build reports to send to a remote server (none,
11015 anonymous or detailed).
11016 --report-planning-failure
11018 Generate build reports when the dependency solver fails.
11019 This is used by the Hackage build bot.
11020 --enable-per-component
11022 --disable-per-component
11023 Per-component builds when possible
11024 --one-shot
11026 --no-one-shot
11027 Do not record the packages in the world file.
11028 --run-tests
11030 Run package test suites during installation.
11031 -j, --jobs [NUM]
11033 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
11034 given).
11035 --keep-going
11037 After a build failure, continue to build other unaffected
11038 packages.
11039 --offline
11041 --no-offline
11042 Don't download packages from the Internet.
11043 --project-file FILE
11045 Set the name of the cabal.project file to search for in
11046 parent directories
11047 --only
11049 Only installs the package in the current directory.
11050 --haddock-hoogle
11052 Generate a hoogle database
11053 --haddock-html
11055 Generate HTML documentation (the default)
11056 --haddock-html-location URL
11058 Location of HTML documentation for pre-requisite packages
11059 --haddock-for-hackage
11061 Collection of flags to generate documentation suitable
11062 for upload to hackage
11063 --haddock-executables
11065 Run haddock for Executables targets
11066 --haddock-tests
11068 Run haddock for Test Suite targets
11069 --haddock-benchmarks
11071 Run haddock for Benchmark targets
11072 --haddock-all
11074 Run haddock for all targets
11075 --haddock-internal
11077 Run haddock for internal modules and include all symbols
11078 --haddock-css PATH
11080 Use PATH as the haddock stylesheet
11081 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
11083 dock-hyperlinked-source
11084 Hyperlink the documentation to the source code
11085 --haddock-quickjump
11087 Generate an index for interactive documentation naviga‐
11088 tion
11089 --haddock-hscolour-css PATH
11091 Use PATH as the HsColour stylesheet
11092 --haddock-contents-location URL
11094 Bake URL in as the location for the contents page
11095 cabal new-run
11098 Usage: cabal new-run [TARGET] [FLAGS] [-- EXECUTABLE_FLAGS]
11100 Runs the specified executable-like component (an executable, a test, or
11103 a benchmark), first ensuring it is up to date.
11104 Any executable-like component in any package in the project can be
11106 specified. A package can be specified if contains just one executable-
11107 like. The default is to use the package in the current directory if it
11108 contains just one executable-like.
11109 Extra arguments can be passed to the program, but use '--' to separate
11111 arguments for the program from arguments for cabal. The executable is
11112 run in an environment where it can find its data files inplace in the
11113 build tree.
11114 Dependencies are built or rebuilt as necessary. Additional configura‐
11116 tion flags can be specified on the command line and these extend the
11117 project configuration from the 'cabal.project', 'cabal.project.local'
11118 and other files.
11119 Examples:
11122 cabal new-run
11123 Run the executable-like in the package in the current directory
11124 cabal new-run foo-tool
11125 Run the named executable-like (in any package in the project)
11126 cabal new-run pkgfoo:foo-tool
11127 Run the executable-like 'foo-tool' in the package 'pkgfoo'
11128 cabal new-run foo -O2 -- dothing --fooflag
11129 Build with '-O2' and run the program, passing it extra arguments.
11130 Note: this command is part of the new project-based system (aka nix-
11132 style local builds). These features are currently in beta. Please see
11133 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
11134 details and advice on what you can expect to work. If you encounter
11135 problems please file issues at https://github.com/haskell/cabal/issues
11136 and if you have any time to get involved and help with testing, fixing
11137 bugs etc then that is very much appreciated.
11138 Flags:
11141 -v, --verbose [n]
11142 Control verbosity (n is 0--3, default verbosity level is
11143 1)
11144 --builddir, --distdir, --distpref DIR
11146 The directory where Cabal puts generated build files
11147 (default dist)
11148 -g, --ghc
11150 compile with GHC
11151 --ghcjs
11153 compile with GHCJS
11154 --uhc
11156 compile with UHC
11157 --haskell-suite
11159 compile with a haskell-suite compiler
11160 --cabal-file PATH
11162 use this Cabal file
11163 -w, --with-compiler PATH
11165 give the path to a particular compiler
11166 --with-hc-pkg PATH
11168 give the path to the package tool
11169 --prefix DIR
11171 bake this prefix in preparation of installation
11172 --bindir DIR
11174 installation directory for executables
11175 --libdir DIR
11177 installation directory for libraries
11178 --libsubdir DIR
11180 subdirectory of libdir in which libs are installed
11181 --dynlibdir DIR
11183 installation directory for dynamic libraries
11184 --libexecdir DIR
11186 installation directory for program executables
11187 --libexecsubdir DIR
11189 subdirectory of libexecdir in which private executables
11190 are installed
11191 --datadir DIR
11193 installation directory for read-only data
11194 --datasubdir DIR
11196 subdirectory of datadir in which data files are installed
11197 --docdir DIR
11199 installation directory for documentation
11200 --htmldir DIR
11202 installation directory for HTML documentation
11203 --haddockdir DIR
11205 installation directory for haddock interfaces
11206 --sysconfdir DIR
11208 installation directory for configuration files
11209 --program-prefix PREFIX
11211 prefix to be applied to installed executables
11212 --program-suffix SUFFIX
11214 suffix to be applied to installed executables
11215 --enable-library-vanilla
11217 --disable-library-vanilla
11218 Vanilla libraries
11219 -p, --enable-library-profiling
11221 --disable-library-profiling
11222 Library profiling
11223 --enable-shared
11225 --disable-shared
11226 Shared library
11227 --enable-static
11229 --disable-static
11230 Static library
11231 --enable-executable-dynamic
11233 --disable-executable-dynamic
11234 Executable dynamic linking
11235 --enable-profiling
11237 --disable-profiling
11238 Executable and library profiling
11239 --enable-executable-profiling
11241 --disable-executable-profiling
11242 Executable profiling (DEPRECATED)
11243 --profiling-detail level
11245 Profiling detail level for executable and library
11246 (default, none, exported-functions, toplevel-functions,
11247 all-functions).
11248 --library-profiling-detail level
11250 Profiling detail level for libraries only.
11251 -O, --enable-optimization, --enable-optimisation [n]
11253 Build with optimization (n is 0--2, default is 1)
11254 --disable-optimization, --disable-optimisation
11256 Build without optimization
11257 --enable-debug-info [n]
11259 Emit debug info (n is 0--3, default is 0)
11260 --disable-debug-info
11262 Don't emit debug info
11263 --enable-library-for-ghci
11265 --disable-library-for-ghci
11266 compile library for use with GHCi
11267 --enable-split-sections
11269 --disable-split-sections
11270 compile library code such that unneeded definitions can
11271 be dropped from the final executable (GHC 7.8+)
11272 --enable-split-objs
11274 --disable-split-objs
11275 split library into smaller objects to reduce binary sizes
11276 (GHC 6.6+)
11277 --enable-executable-stripping
11279 --disable-executable-stripping
11280 strip executables upon installation to reduce binary
11281 sizes
11282 --enable-library-stripping
11284 --disable-library-stripping
11285 strip libraries upon installation to reduce binary sizes
11286 --configure-option OPT
11288 Extra option for configure
11289 --user
11291 --global
11292 doing a per-user installation
11293 --package-db DB
11295 Append the given package database to the list of package
11296 databases used (to satisfy dependencies and register
11297 into). May be a specific file, 'global' or 'user'. The
11298 initial list is ['global'], ['global', 'user'], or
11299 ['global', $sandbox], depending on context. Use 'clear'
11300 to reset the list to empty. See the user guide for
11301 details.
11302 -f, --flags FLAGS
11304 Force values for the given flags in Cabal conditionals in
11305 the .cabal file. E.g., --flags="debug -usebytestrings"
11306 forces the flag "debug" to true and "usebytestrings" to
11307 false.
11308 --extra-include-dirs PATH
11310 A list of directories to search for header files
11311 --enable-deterministic
11313 --disable-deterministic
11314 Try to be as deterministic as possible (used by the test
11315 suite)
11316 --ipid IPID
11318 Installed package ID to compile this package as
11319 --cid CID
11321 Installed component ID to compile this component as
11322 --extra-lib-dirs PATH
11324 A list of directories to search for external libraries
11325 --extra-framework-dirs PATH
11327 A list of directories to search for external frameworks
11328 (OS X only)
11329 --extra-prog-path PATH
11331 A list of directories to search for required programs (in
11332 addition to the normal search locations)
11333 --instantiate-with NAME=MOD
11335 A mapping of signature names to concrete module instanti‐
11336 ations.
11337 --enable-tests
11339 --disable-tests
11340 dependency checking and compilation for test suites
11341 listed in the package description file.
11342 --enable-coverage
11344 --disable-coverage
11345 build package with Haskell Program Coverage. (GHC only)
11346 --enable-library-coverage
11348 --disable-library-coverage
11349 build package with Haskell Program Coverage. (GHC only)
11350 (DEPRECATED)
11351 --enable-benchmarks
11353 --disable-benchmarks
11354 dependency checking and compilation for benchmarks listed
11355 in the package description file.
11356 --enable-relocatable
11358 --disable-relocatable
11359 building a package that is relocatable. (GHC only)
11360 --disable-response-files
11362 enable workaround for old versions of programs like "ar"
11363 that do not support @file arguments
11364 --with-alex PATH
11366 give the path to alex
11367 --with-ar PATH
11369 give the path to ar
11370 --with-c2hs PATH
11372 give the path to c2hs
11373 --with-cpphs PATH
11375 give the path to cpphs
11376 --with-doctest PATH
11378 give the path to doctest
11379 --with-gcc PATH
11381 give the path to gcc
11382 --with-ghc PATH
11384 give the path to ghc
11385 --with-ghc-pkg PATH
11387 give the path to ghc-pkg
11388 --with-ghcjs PATH
11390 give the path to ghcjs
11391 --with-ghcjs-pkg PATH
11393 give the path to ghcjs-pkg
11394 --with-greencard PATH
11396 give the path to greencard
11397 --with-haddock PATH
11399 give the path to haddock
11400 --with-happy PATH
11402 give the path to happy
11403 --with-haskell-suite PATH
11405 give the path to haskell-suite
11406 --with-haskell-suite-pkg PATH
11408 give the path to haskell-suite-pkg
11409 --with-hmake PATH
11411 give the path to hmake
11412 --with-hpc PATH
11414 give the path to hpc
11415 --with-hsc2hs PATH
11417 give the path to hsc2hs
11418 --with-hscolour PATH
11420 give the path to hscolour
11421 --with-jhc PATH
11423 give the path to jhc
11424 --with-ld PATH
11426 give the path to ld
11427 --with-pkg-config PATH
11429 give the path to pkg-config
11430 --with-runghc PATH
11432 give the path to runghc
11433 --with-strip PATH
11435 give the path to strip
11436 --with-tar PATH
11438 give the path to tar
11439 --with-uhc PATH
11441 give the path to uhc
11442 --alex-option OPT
11444 give an extra option to alex (no need to quote options
11445 containing spaces)
11446 --ar-option OPT
11448 give an extra option to ar (no need to quote options con‐
11449 taining spaces)
11450 --c2hs-option OPT
11452 give an extra option to c2hs (no need to quote options
11453 containing spaces)
11454 --cpphs-option OPT
11456 give an extra option to cpphs (no need to quote options
11457 containing spaces)
11458 --doctest-option OPT
11460 give an extra option to doctest (no need to quote options
11461 containing spaces)
11462 --gcc-option OPT
11464 give an extra option to gcc (no need to quote options
11465 containing spaces)
11466 --ghc-option OPT
11468 give an extra option to ghc (no need to quote options
11469 containing spaces)
11470 --ghc-pkg-option OPT
11472 give an extra option to ghc-pkg (no need to quote options
11473 containing spaces)
11474 --ghcjs-option OPT
11476 give an extra option to ghcjs (no need to quote options
11477 containing spaces)
11478 --ghcjs-pkg-option OPT
11480 give an extra option to ghcjs-pkg (no need to quote
11481 options containing spaces)
11482 --greencard-option OPT
11484 give an extra option to greencard (no need to quote
11485 options containing spaces)
11486 --haddock-option OPT
11488 give an extra option to haddock (no need to quote options
11489 containing spaces)
11490 --happy-option OPT
11492 give an extra option to happy (no need to quote options
11493 containing spaces)
11494 --haskell-suite-option OPT
11496 give an extra option to haskell-suite (no need to quote
11497 options containing spaces)
11498 --haskell-suite-pkg-option OPT
11500 give an extra option to haskell-suite-pkg (no need to
11501 quote options containing spaces)
11502 --hmake-option OPT
11504 give an extra option to hmake (no need to quote options
11505 containing spaces)
11506 --hpc-option OPT
11508 give an extra option to hpc (no need to quote options
11509 containing spaces)
11510 --hsc2hs-option OPT
11512 give an extra option to hsc2hs (no need to quote options
11513 containing spaces)
11514 --hscolour-option OPT
11516 give an extra option to hscolour (no need to quote
11517 options containing spaces)
11518 --jhc-option OPT
11520 give an extra option to jhc (no need to quote options
11521 containing spaces)
11522 --ld-option OPT
11524 give an extra option to ld (no need to quote options con‐
11525 taining spaces)
11526 --pkg-config-option OPT
11528 give an extra option to pkg-config (no need to quote
11529 options containing spaces)
11530 --runghc-option OPT
11532 give an extra option to runghc (no need to quote options
11533 containing spaces)
11534 --strip-option OPT
11536 give an extra option to strip (no need to quote options
11537 containing spaces)
11538 --tar-option OPT
11540 give an extra option to tar (no need to quote options
11541 containing spaces)
11542 --uhc-option OPT
11544 give an extra option to uhc (no need to quote options
11545 containing spaces)
11546 --alex-options OPTS
11548 give extra options to alex
11549 --ar-options OPTS
11551 give extra options to ar
11552 --c2hs-options OPTS
11554 give extra options to c2hs
11555 --cpphs-options OPTS
11557 give extra options to cpphs
11558 --doctest-options OPTS
11560 give extra options to doctest
11561 --gcc-options OPTS
11563 give extra options to gcc
11564 --ghc-options OPTS
11566 give extra options to ghc
11567 --ghc-pkg-options OPTS
11569 give extra options to ghc-pkg
11570 --ghcjs-options OPTS
11572 give extra options to ghcjs
11573 --ghcjs-pkg-options OPTS
11575 give extra options to ghcjs-pkg
11576 --greencard-options OPTS
11578 give extra options to greencard
11579 --haddock-options OPTS
11581 give extra options to haddock
11582 --happy-options OPTS
11584 give extra options to happy
11585 --haskell-suite-options OPTS
11587 give extra options to haskell-suite
11588 --haskell-suite-pkg-options OPTS
11590 give extra options to haskell-suite-pkg
11591 --hmake-options OPTS
11593 give extra options to hmake
11594 --hpc-options OPTS
11596 give extra options to hpc
11597 --hsc2hs-options OPTS
11599 give extra options to hsc2hs
11600 --hscolour-options OPTS
11602 give extra options to hscolour
11603 --jhc-options OPTS
11605 give extra options to jhc
11606 --ld-options OPTS
11608 give extra options to ld
11609 --pkg-config-options OPTS
11611 give extra options to pkg-config
11612 --runghc-options OPTS
11614 give extra options to runghc
11615 --strip-options OPTS
11617 give extra options to strip
11618 --tar-options OPTS
11620 give extra options to tar
11621 --uhc-options OPTS
11623 give extra options to uhc
11624 --cabal-lib-version VERSION
11626 Select which version of the Cabal lib to use to build
11627 packages (useful for testing).
11628 --constraint CONSTRAINT
11630 Specify constraints on a package (version,
11631 installed/source, flags)
11632 --preference CONSTRAINT
11634 Specify preferences (soft constraints) on the version of
11635 a package
11636 --solver SOLVER
11638 Select dependency solver to use (default: modular).
11639 Choices: modular.
11640 --allow-older [DEPS]
11642 Ignore lower bounds in all dependencies or DEPS
11643 --allow-newer [DEPS]
11645 Ignore upper bounds in all dependencies or DEPS
11646 --enable-documentation
11648 --disable-documentation
11649 building of documentation
11650 --doc-index-file TEMPLATE
11652 A central index of haddock API documentation (template
11653 cannot use $pkgid)
11654 --dry-run
11656 Do not install anything, only print what would be
11657 installed.
11658 --max-backjumps NUM
11660 Maximum number of backjumps allowed while solving
11661 (default: 2000). Use a negative number to enable unlim‐
11662 ited backtracking. Use 0 to disable backtracking com‐
11663 pletely.
11664 --reorder-goals
11666 --no-reorder-goals
11667 Try to reorder goals according to certain heuristics.
11668 Slows things down on average, but may make backtracking
11669 faster for some packages.
11670 --count-conflicts
11672 --no-count-conflicts
11673 Try to speed up solving by preferring goals that are
11674 involved in a lot of conflicts (default).
11675 --independent-goals
11677 --no-independent-goals
11678 Treat several goals on the command line as independent.
11679 If several goals depend on the same package, different
11680 versions can be chosen.
11681 --shadow-installed-packages
11683 --no-shadow-installed-packages
11684 If multiple package instances of the same version are
11685 installed, treat all but one as shadowed.
11686 --strong-flags
11688 --no-strong-flags
11689 Do not defer flag choices (this used to be the default in
11690 cabal-install <= 1.20).
11691 --allow-boot-library-installs
11693 --no-allow-boot-library-installs
11694 Allow cabal to install base, ghc-prim, integer-simple,
11695 integer-gmp, and template-haskell.
11696 --reinstall
11698 --no-reinstall
11699 Install even if it means installing the same version
11700 again.
11701 --avoid-reinstalls
11703 --no-avoid-reinstalls
11704 Do not select versions that would destructively overwrite
11705 installed packages.
11706 --force-reinstalls
11708 --no-force-reinstalls
11709 Reinstall packages even if they will most likely break
11710 other installed packages.
11711 --upgrade-dependencies
11713 --no-upgrade-dependencies
11714 Pick the latest version for all dependencies, rather than
11715 trying to pick an installed version.
11716 --only-dependencies
11718 --no-only-dependencies
11719 Install only the dependencies necessary to build the
11720 given packages
11721 --dependencies-only
11723 --no-dependencies-only
11724 A synonym for --only-dependencies
11725 --index-state STATE
11727 Use source package index state as it existed at a previ‐
11728 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
11729 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
11730 'HEAD' (default: 'HEAD').
11731 --root-cmd COMMAND
11733 (No longer supported, do not use.)
11734 --symlink-bindir DIR
11736 Add symlinks to installed executables into this direc‐
11737 tory.
11738 --build-summary TEMPLATE
11740 Save build summaries to file (name template can use
11741 $pkgid, $compiler, $os, $arch)
11742 --build-log TEMPLATE
11744 Log all builds to file (name template can use $pkgid,
11745 $compiler, $os, $arch)
11746 --remote-build-reporting LEVEL
11748 Generate build reports to send to a remote server (none,
11749 anonymous or detailed).
11750 --report-planning-failure
11752 Generate build reports when the dependency solver fails.
11753 This is used by the Hackage build bot.
11754 --enable-per-component
11756 --disable-per-component
11757 Per-component builds when possible
11758 --one-shot
11760 --no-one-shot
11761 Do not record the packages in the world file.
11762 --run-tests
11764 Run package test suites during installation.
11765 -j, --jobs [NUM]
11767 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
11768 given).
11769 --keep-going
11771 After a build failure, continue to build other unaffected
11772 packages.
11773 --offline
11775 --no-offline
11776 Don't download packages from the Internet.
11777 --project-file FILE
11779 Set the name of the cabal.project file to search for in
11780 parent directories
11781 --only
11783 Only installs the package in the current directory.
11784 --haddock-hoogle
11786 Generate a hoogle database
11787 --haddock-html
11789 Generate HTML documentation (the default)
11790 --haddock-html-location URL
11792 Location of HTML documentation for pre-requisite packages
11793 --haddock-for-hackage
11795 Collection of flags to generate documentation suitable
11796 for upload to hackage
11797 --haddock-executables
11799 Run haddock for Executables targets
11800 --haddock-tests
11802 Run haddock for Test Suite targets
11803 --haddock-benchmarks
11805 Run haddock for Benchmark targets
11806 --haddock-all
11808 Run haddock for all targets
11809 --haddock-internal
11811 Run haddock for internal modules and include all symbols
11812 --haddock-css PATH
11814 Use PATH as the haddock stylesheet
11815 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
11817 dock-hyperlinked-source
11818 Hyperlink the documentation to the source code
11819 --haddock-quickjump
11821 Generate an index for interactive documentation naviga‐
11822 tion
11823 --haddock-hscolour-css PATH
11825 Use PATH as the HsColour stylesheet
11826 --haddock-contents-location URL
11828 Bake URL in as the location for the contents page
11829 cabal v2-test
11832 Usage: cabal v2-test [TARGETS] [FLAGS]
11834 Runs the specified test-suites, first ensuring they are up to date.
11837 Any test-suite in any package in the project can be specified. A pack‐
11839 age can be specified in which case all the test-suites in the package
11840 are run. The default is to run all the test-suites in the package in
11841 the current directory.
11842 Dependencies are built or rebuilt as necessary. Additional configura‐
11844 tion flags can be specified on the command line and these extend the
11845 project configuration from the 'cabal.project', 'cabal.project.local'
11846 and other files.
11847 To pass command-line arguments to a test suite, see the v2-run command.
11849 Runs the specified test-suites, first ensuring they are up to date.
11852 Any test-suite in any package in the project can be specified. A pack‐
11854 age can be specified in which case all the test-suites in the package
11855 are run. The default is to run all the test-suites in the package in
11856 the current directory.
11857 Dependencies are built or rebuilt as necessary. Additional configura‐
11859 tion flags can be specified on the command line and these extend the
11860 project configuration from the 'cabal.project', 'cabal.project.local'
11861 and other files.
11862 To pass command-line arguments to a test suite, see the v2-run command.
11864 Flags:
11867 -v, --verbose [n]
11868 Control verbosity (n is 0--3, default verbosity level is
11869 1)
11870 --builddir, --distdir, --distpref DIR
11872 The directory where Cabal puts generated build files
11873 (default dist)
11874 -g, --ghc
11876 compile with GHC
11877 --ghcjs
11879 compile with GHCJS
11880 --uhc
11882 compile with UHC
11883 --haskell-suite
11885 compile with a haskell-suite compiler
11886 --cabal-file PATH
11888 use this Cabal file
11889 -w, --with-compiler PATH
11891 give the path to a particular compiler
11892 --with-hc-pkg PATH
11894 give the path to the package tool
11895 --prefix DIR
11897 bake this prefix in preparation of installation
11898 --bindir DIR
11900 installation directory for executables
11901 --libdir DIR
11903 installation directory for libraries
11904 --libsubdir DIR
11906 subdirectory of libdir in which libs are installed
11907 --dynlibdir DIR
11909 installation directory for dynamic libraries
11910 --libexecdir DIR
11912 installation directory for program executables
11913 --libexecsubdir DIR
11915 subdirectory of libexecdir in which private executables
11916 are installed
11917 --datadir DIR
11919 installation directory for read-only data
11920 --datasubdir DIR
11922 subdirectory of datadir in which data files are installed
11923 --docdir DIR
11925 installation directory for documentation
11926 --htmldir DIR
11928 installation directory for HTML documentation
11929 --haddockdir DIR
11931 installation directory for haddock interfaces
11932 --sysconfdir DIR
11934 installation directory for configuration files
11935 --program-prefix PREFIX
11937 prefix to be applied to installed executables
11938 --program-suffix SUFFIX
11940 suffix to be applied to installed executables
11941 --enable-library-vanilla
11943 --disable-library-vanilla
11944 Vanilla libraries
11945 -p, --enable-library-profiling
11947 --disable-library-profiling
11948 Library profiling
11949 --enable-shared
11951 --disable-shared
11952 Shared library
11953 --enable-static
11955 --disable-static
11956 Static library
11957 --enable-executable-dynamic
11959 --disable-executable-dynamic
11960 Executable dynamic linking
11961 --enable-profiling
11963 --disable-profiling
11964 Executable and library profiling
11965 --enable-executable-profiling
11967 --disable-executable-profiling
11968 Executable profiling (DEPRECATED)
11969 --profiling-detail level
11971 Profiling detail level for executable and library
11972 (default, none, exported-functions, toplevel-functions,
11973 all-functions).
11974 --library-profiling-detail level
11976 Profiling detail level for libraries only.
11977 -O, --enable-optimization, --enable-optimisation [n]
11979 Build with optimization (n is 0--2, default is 1)
11980 --disable-optimization, --disable-optimisation
11982 Build without optimization
11983 --enable-debug-info [n]
11985 Emit debug info (n is 0--3, default is 0)
11986 --disable-debug-info
11988 Don't emit debug info
11989 --enable-library-for-ghci
11991 --disable-library-for-ghci
11992 compile library for use with GHCi
11993 --enable-split-sections
11995 --disable-split-sections
11996 compile library code such that unneeded definitions can
11997 be dropped from the final executable (GHC 7.8+)
11998 --enable-split-objs
12000 --disable-split-objs
12001 split library into smaller objects to reduce binary sizes
12002 (GHC 6.6+)
12003 --enable-executable-stripping
12005 --disable-executable-stripping
12006 strip executables upon installation to reduce binary
12007 sizes
12008 --enable-library-stripping
12010 --disable-library-stripping
12011 strip libraries upon installation to reduce binary sizes
12012 --configure-option OPT
12014 Extra option for configure
12015 --user
12017 --global
12018 doing a per-user installation
12019 --package-db DB
12021 Append the given package database to the list of package
12022 databases used (to satisfy dependencies and register
12023 into). May be a specific file, 'global' or 'user'. The
12024 initial list is ['global'], ['global', 'user'], or
12025 ['global', $sandbox], depending on context. Use 'clear'
12026 to reset the list to empty. See the user guide for
12027 details.
12028 -f, --flags FLAGS
12030 Force values for the given flags in Cabal conditionals in
12031 the .cabal file. E.g., --flags="debug -usebytestrings"
12032 forces the flag "debug" to true and "usebytestrings" to
12033 false.
12034 --extra-include-dirs PATH
12036 A list of directories to search for header files
12037 --enable-deterministic
12039 --disable-deterministic
12040 Try to be as deterministic as possible (used by the test
12041 suite)
12042 --ipid IPID
12044 Installed package ID to compile this package as
12045 --cid CID
12047 Installed component ID to compile this component as
12048 --extra-lib-dirs PATH
12050 A list of directories to search for external libraries
12051 --extra-framework-dirs PATH
12053 A list of directories to search for external frameworks
12054 (OS X only)
12055 --extra-prog-path PATH
12057 A list of directories to search for required programs (in
12058 addition to the normal search locations)
12059 --instantiate-with NAME=MOD
12061 A mapping of signature names to concrete module instanti‐
12062 ations.
12063 --enable-tests
12065 --disable-tests
12066 dependency checking and compilation for test suites
12067 listed in the package description file.
12068 --enable-coverage
12070 --disable-coverage
12071 build package with Haskell Program Coverage. (GHC only)
12072 --enable-library-coverage
12074 --disable-library-coverage
12075 build package with Haskell Program Coverage. (GHC only)
12076 (DEPRECATED)
12077 --enable-benchmarks
12079 --disable-benchmarks
12080 dependency checking and compilation for benchmarks listed
12081 in the package description file.
12082 --enable-relocatable
12084 --disable-relocatable
12085 building a package that is relocatable. (GHC only)
12086 --disable-response-files
12088 enable workaround for old versions of programs like "ar"
12089 that do not support @file arguments
12090 --with-alex PATH
12092 give the path to alex
12093 --with-ar PATH
12095 give the path to ar
12096 --with-c2hs PATH
12098 give the path to c2hs
12099 --with-cpphs PATH
12101 give the path to cpphs
12102 --with-doctest PATH
12104 give the path to doctest
12105 --with-gcc PATH
12107 give the path to gcc
12108 --with-ghc PATH
12110 give the path to ghc
12111 --with-ghc-pkg PATH
12113 give the path to ghc-pkg
12114 --with-ghcjs PATH
12116 give the path to ghcjs
12117 --with-ghcjs-pkg PATH
12119 give the path to ghcjs-pkg
12120 --with-greencard PATH
12122 give the path to greencard
12123 --with-haddock PATH
12125 give the path to haddock
12126 --with-happy PATH
12128 give the path to happy
12129 --with-haskell-suite PATH
12131 give the path to haskell-suite
12132 --with-haskell-suite-pkg PATH
12134 give the path to haskell-suite-pkg
12135 --with-hmake PATH
12137 give the path to hmake
12138 --with-hpc PATH
12140 give the path to hpc
12141 --with-hsc2hs PATH
12143 give the path to hsc2hs
12144 --with-hscolour PATH
12146 give the path to hscolour
12147 --with-jhc PATH
12149 give the path to jhc
12150 --with-ld PATH
12152 give the path to ld
12153 --with-pkg-config PATH
12155 give the path to pkg-config
12156 --with-runghc PATH
12158 give the path to runghc
12159 --with-strip PATH
12161 give the path to strip
12162 --with-tar PATH
12164 give the path to tar
12165 --with-uhc PATH
12167 give the path to uhc
12168 --alex-option OPT
12170 give an extra option to alex (no need to quote options
12171 containing spaces)
12172 --ar-option OPT
12174 give an extra option to ar (no need to quote options con‐
12175 taining spaces)
12176 --c2hs-option OPT
12178 give an extra option to c2hs (no need to quote options
12179 containing spaces)
12180 --cpphs-option OPT
12182 give an extra option to cpphs (no need to quote options
12183 containing spaces)
12184 --doctest-option OPT
12186 give an extra option to doctest (no need to quote options
12187 containing spaces)
12188 --gcc-option OPT
12190 give an extra option to gcc (no need to quote options
12191 containing spaces)
12192 --ghc-option OPT
12194 give an extra option to ghc (no need to quote options
12195 containing spaces)
12196 --ghc-pkg-option OPT
12198 give an extra option to ghc-pkg (no need to quote options
12199 containing spaces)
12200 --ghcjs-option OPT
12202 give an extra option to ghcjs (no need to quote options
12203 containing spaces)
12204 --ghcjs-pkg-option OPT
12206 give an extra option to ghcjs-pkg (no need to quote
12207 options containing spaces)
12208 --greencard-option OPT
12210 give an extra option to greencard (no need to quote
12211 options containing spaces)
12212 --haddock-option OPT
12214 give an extra option to haddock (no need to quote options
12215 containing spaces)
12216 --happy-option OPT
12218 give an extra option to happy (no need to quote options
12219 containing spaces)
12220 --haskell-suite-option OPT
12222 give an extra option to haskell-suite (no need to quote
12223 options containing spaces)
12224 --haskell-suite-pkg-option OPT
12226 give an extra option to haskell-suite-pkg (no need to
12227 quote options containing spaces)
12228 --hmake-option OPT
12230 give an extra option to hmake (no need to quote options
12231 containing spaces)
12232 --hpc-option OPT
12234 give an extra option to hpc (no need to quote options
12235 containing spaces)
12236 --hsc2hs-option OPT
12238 give an extra option to hsc2hs (no need to quote options
12239 containing spaces)
12240 --hscolour-option OPT
12242 give an extra option to hscolour (no need to quote
12243 options containing spaces)
12244 --jhc-option OPT
12246 give an extra option to jhc (no need to quote options
12247 containing spaces)
12248 --ld-option OPT
12250 give an extra option to ld (no need to quote options con‐
12251 taining spaces)
12252 --pkg-config-option OPT
12254 give an extra option to pkg-config (no need to quote
12255 options containing spaces)
12256 --runghc-option OPT
12258 give an extra option to runghc (no need to quote options
12259 containing spaces)
12260 --strip-option OPT
12262 give an extra option to strip (no need to quote options
12263 containing spaces)
12264 --tar-option OPT
12266 give an extra option to tar (no need to quote options
12267 containing spaces)
12268 --uhc-option OPT
12270 give an extra option to uhc (no need to quote options
12271 containing spaces)
12272 --alex-options OPTS
12274 give extra options to alex
12275 --ar-options OPTS
12277 give extra options to ar
12278 --c2hs-options OPTS
12280 give extra options to c2hs
12281 --cpphs-options OPTS
12283 give extra options to cpphs
12284 --doctest-options OPTS
12286 give extra options to doctest
12287 --gcc-options OPTS
12289 give extra options to gcc
12290 --ghc-options OPTS
12292 give extra options to ghc
12293 --ghc-pkg-options OPTS
12295 give extra options to ghc-pkg
12296 --ghcjs-options OPTS
12298 give extra options to ghcjs
12299 --ghcjs-pkg-options OPTS
12301 give extra options to ghcjs-pkg
12302 --greencard-options OPTS
12304 give extra options to greencard
12305 --haddock-options OPTS
12307 give extra options to haddock
12308 --happy-options OPTS
12310 give extra options to happy
12311 --haskell-suite-options OPTS
12313 give extra options to haskell-suite
12314 --haskell-suite-pkg-options OPTS
12316 give extra options to haskell-suite-pkg
12317 --hmake-options OPTS
12319 give extra options to hmake
12320 --hpc-options OPTS
12322 give extra options to hpc
12323 --hsc2hs-options OPTS
12325 give extra options to hsc2hs
12326 --hscolour-options OPTS
12328 give extra options to hscolour
12329 --jhc-options OPTS
12331 give extra options to jhc
12332 --ld-options OPTS
12334 give extra options to ld
12335 --pkg-config-options OPTS
12337 give extra options to pkg-config
12338 --runghc-options OPTS
12340 give extra options to runghc
12341 --strip-options OPTS
12343 give extra options to strip
12344 --tar-options OPTS
12346 give extra options to tar
12347 --uhc-options OPTS
12349 give extra options to uhc
12350 --cabal-lib-version VERSION
12352 Select which version of the Cabal lib to use to build
12353 packages (useful for testing).
12354 --constraint CONSTRAINT
12356 Specify constraints on a package (version,
12357 installed/source, flags)
12358 --preference CONSTRAINT
12360 Specify preferences (soft constraints) on the version of
12361 a package
12362 --solver SOLVER
12364 Select dependency solver to use (default: modular).
12365 Choices: modular.
12366 --allow-older [DEPS]
12368 Ignore lower bounds in all dependencies or DEPS
12369 --allow-newer [DEPS]
12371 Ignore upper bounds in all dependencies or DEPS
12372 --enable-documentation
12374 --disable-documentation
12375 building of documentation
12376 --doc-index-file TEMPLATE
12378 A central index of haddock API documentation (template
12379 cannot use $pkgid)
12380 --dry-run
12382 Do not install anything, only print what would be
12383 installed.
12384 --max-backjumps NUM
12386 Maximum number of backjumps allowed while solving
12387 (default: 2000). Use a negative number to enable unlim‐
12388 ited backtracking. Use 0 to disable backtracking com‐
12389 pletely.
12390 --reorder-goals
12392 --no-reorder-goals
12393 Try to reorder goals according to certain heuristics.
12394 Slows things down on average, but may make backtracking
12395 faster for some packages.
12396 --count-conflicts
12398 --no-count-conflicts
12399 Try to speed up solving by preferring goals that are
12400 involved in a lot of conflicts (default).
12401 --independent-goals
12403 --no-independent-goals
12404 Treat several goals on the command line as independent.
12405 If several goals depend on the same package, different
12406 versions can be chosen.
12407 --shadow-installed-packages
12409 --no-shadow-installed-packages
12410 If multiple package instances of the same version are
12411 installed, treat all but one as shadowed.
12412 --strong-flags
12414 --no-strong-flags
12415 Do not defer flag choices (this used to be the default in
12416 cabal-install <= 1.20).
12417 --allow-boot-library-installs
12419 --no-allow-boot-library-installs
12420 Allow cabal to install base, ghc-prim, integer-simple,
12421 integer-gmp, and template-haskell.
12422 --reinstall
12424 --no-reinstall
12425 Install even if it means installing the same version
12426 again.
12427 --avoid-reinstalls
12429 --no-avoid-reinstalls
12430 Do not select versions that would destructively overwrite
12431 installed packages.
12432 --force-reinstalls
12434 --no-force-reinstalls
12435 Reinstall packages even if they will most likely break
12436 other installed packages.
12437 --upgrade-dependencies
12439 --no-upgrade-dependencies
12440 Pick the latest version for all dependencies, rather than
12441 trying to pick an installed version.
12442 --only-dependencies
12444 --no-only-dependencies
12445 Install only the dependencies necessary to build the
12446 given packages
12447 --dependencies-only
12449 --no-dependencies-only
12450 A synonym for --only-dependencies
12451 --index-state STATE
12453 Use source package index state as it existed at a previ‐
12454 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
12455 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
12456 'HEAD' (default: 'HEAD').
12457 --root-cmd COMMAND
12459 (No longer supported, do not use.)
12460 --symlink-bindir DIR
12462 Add symlinks to installed executables into this direc‐
12463 tory.
12464 --build-summary TEMPLATE
12466 Save build summaries to file (name template can use
12467 $pkgid, $compiler, $os, $arch)
12468 --build-log TEMPLATE
12470 Log all builds to file (name template can use $pkgid,
12471 $compiler, $os, $arch)
12472 --remote-build-reporting LEVEL
12474 Generate build reports to send to a remote server (none,
12475 anonymous or detailed).
12476 --report-planning-failure
12478 Generate build reports when the dependency solver fails.
12479 This is used by the Hackage build bot.
12480 --enable-per-component
12482 --disable-per-component
12483 Per-component builds when possible
12484 --one-shot
12486 --no-one-shot
12487 Do not record the packages in the world file.
12488 --run-tests
12490 Run package test suites during installation.
12491 -j, --jobs [NUM]
12493 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
12494 given).
12495 --keep-going
12497 After a build failure, continue to build other unaffected
12498 packages.
12499 --offline
12501 --no-offline
12502 Don't download packages from the Internet.
12503 --project-file FILE
12505 Set the name of the cabal.project file to search for in
12506 parent directories
12507 --only
12509 Only installs the package in the current directory.
12510 --haddock-hoogle
12512 Generate a hoogle database
12513 --haddock-html
12515 Generate HTML documentation (the default)
12516 --haddock-html-location URL
12518 Location of HTML documentation for pre-requisite packages
12519 --haddock-for-hackage
12521 Collection of flags to generate documentation suitable
12522 for upload to hackage
12523 --haddock-executables
12525 Run haddock for Executables targets
12526 --haddock-tests
12528 Run haddock for Test Suite targets
12529 --haddock-benchmarks
12531 Run haddock for Benchmark targets
12532 --haddock-all
12534 Run haddock for all targets
12535 --haddock-internal
12537 Run haddock for internal modules and include all symbols
12538 --haddock-css PATH
12540 Use PATH as the haddock stylesheet
12541 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
12543 dock-hyperlinked-source
12544 Hyperlink the documentation to the source code
12545 --haddock-quickjump
12547 Generate an index for interactive documentation naviga‐
12548 tion
12549 --haddock-hscolour-css PATH
12551 Use PATH as the HsColour stylesheet
12552 --haddock-contents-location URL
12554 Bake URL in as the location for the contents page
12555 cabal new-test
12558 Usage: cabal new-test [TARGETS] [FLAGS]
12560 Runs the specified test-suites, first ensuring they are up to date.
12563 Any test-suite in any package in the project can be specified. A pack‐
12565 age can be specified in which case all the test-suites in the package
12566 are run. The default is to run all the test-suites in the package in
12567 the current directory.
12568 Dependencies are built or rebuilt as necessary. Additional configura‐
12570 tion flags can be specified on the command line and these extend the
12571 project configuration from the 'cabal.project', 'cabal.project.local'
12572 and other files.
12573 To pass command-line arguments to a test suite, see the new-run com‐
12575 mand.
12576 Examples:
12579 cabal new-test
12580 Run all the test-suites in the package in the current directory
12581 cabal new-test pkgname
12582 Run all the test-suites in the package named pkgname
12583 cabal new-test cname
12584 Run the test-suite named cname
12585 cabal new-test cname --enable-coverage
12586 Run the test-suite built with code coverage (including local libs
12587 used)
12588 Note: this command is part of the new project-based system (aka nix-
12590 style local builds). These features are currently in beta. Please see
12591 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
12592 details and advice on what you can expect to work. If you encounter
12593 problems please file issues at https://github.com/haskell/cabal/issues
12594 and if you have any time to get involved and help with testing, fixing
12595 bugs etc then that is very much appreciated.
12596 Flags:
12599 -v, --verbose [n]
12600 Control verbosity (n is 0--3, default verbosity level is
12601 1)
12602 --builddir, --distdir, --distpref DIR
12604 The directory where Cabal puts generated build files
12605 (default dist)
12606 -g, --ghc
12608 compile with GHC
12609 --ghcjs
12611 compile with GHCJS
12612 --uhc
12614 compile with UHC
12615 --haskell-suite
12617 compile with a haskell-suite compiler
12618 --cabal-file PATH
12620 use this Cabal file
12621 -w, --with-compiler PATH
12623 give the path to a particular compiler
12624 --with-hc-pkg PATH
12626 give the path to the package tool
12627 --prefix DIR
12629 bake this prefix in preparation of installation
12630 --bindir DIR
12632 installation directory for executables
12633 --libdir DIR
12635 installation directory for libraries
12636 --libsubdir DIR
12638 subdirectory of libdir in which libs are installed
12639 --dynlibdir DIR
12641 installation directory for dynamic libraries
12642 --libexecdir DIR
12644 installation directory for program executables
12645 --libexecsubdir DIR
12647 subdirectory of libexecdir in which private executables
12648 are installed
12649 --datadir DIR
12651 installation directory for read-only data
12652 --datasubdir DIR
12654 subdirectory of datadir in which data files are installed
12655 --docdir DIR
12657 installation directory for documentation
12658 --htmldir DIR
12660 installation directory for HTML documentation
12661 --haddockdir DIR
12663 installation directory for haddock interfaces
12664 --sysconfdir DIR
12666 installation directory for configuration files
12667 --program-prefix PREFIX
12669 prefix to be applied to installed executables
12670 --program-suffix SUFFIX
12672 suffix to be applied to installed executables
12673 --enable-library-vanilla
12675 --disable-library-vanilla
12676 Vanilla libraries
12677 -p, --enable-library-profiling
12679 --disable-library-profiling
12680 Library profiling
12681 --enable-shared
12683 --disable-shared
12684 Shared library
12685 --enable-static
12687 --disable-static
12688 Static library
12689 --enable-executable-dynamic
12691 --disable-executable-dynamic
12692 Executable dynamic linking
12693 --enable-profiling
12695 --disable-profiling
12696 Executable and library profiling
12697 --enable-executable-profiling
12699 --disable-executable-profiling
12700 Executable profiling (DEPRECATED)
12701 --profiling-detail level
12703 Profiling detail level for executable and library
12704 (default, none, exported-functions, toplevel-functions,
12705 all-functions).
12706 --library-profiling-detail level
12708 Profiling detail level for libraries only.
12709 -O, --enable-optimization, --enable-optimisation [n]
12711 Build with optimization (n is 0--2, default is 1)
12712 --disable-optimization, --disable-optimisation
12714 Build without optimization
12715 --enable-debug-info [n]
12717 Emit debug info (n is 0--3, default is 0)
12718 --disable-debug-info
12720 Don't emit debug info
12721 --enable-library-for-ghci
12723 --disable-library-for-ghci
12724 compile library for use with GHCi
12725 --enable-split-sections
12727 --disable-split-sections
12728 compile library code such that unneeded definitions can
12729 be dropped from the final executable (GHC 7.8+)
12730 --enable-split-objs
12732 --disable-split-objs
12733 split library into smaller objects to reduce binary sizes
12734 (GHC 6.6+)
12735 --enable-executable-stripping
12737 --disable-executable-stripping
12738 strip executables upon installation to reduce binary
12739 sizes
12740 --enable-library-stripping
12742 --disable-library-stripping
12743 strip libraries upon installation to reduce binary sizes
12744 --configure-option OPT
12746 Extra option for configure
12747 --user
12749 --global
12750 doing a per-user installation
12751 --package-db DB
12753 Append the given package database to the list of package
12754 databases used (to satisfy dependencies and register
12755 into). May be a specific file, 'global' or 'user'. The
12756 initial list is ['global'], ['global', 'user'], or
12757 ['global', $sandbox], depending on context. Use 'clear'
12758 to reset the list to empty. See the user guide for
12759 details.
12760 -f, --flags FLAGS
12762 Force values for the given flags in Cabal conditionals in
12763 the .cabal file. E.g., --flags="debug -usebytestrings"
12764 forces the flag "debug" to true and "usebytestrings" to
12765 false.
12766 --extra-include-dirs PATH
12768 A list of directories to search for header files
12769 --enable-deterministic
12771 --disable-deterministic
12772 Try to be as deterministic as possible (used by the test
12773 suite)
12774 --ipid IPID
12776 Installed package ID to compile this package as
12777 --cid CID
12779 Installed component ID to compile this component as
12780 --extra-lib-dirs PATH
12782 A list of directories to search for external libraries
12783 --extra-framework-dirs PATH
12785 A list of directories to search for external frameworks
12786 (OS X only)
12787 --extra-prog-path PATH
12789 A list of directories to search for required programs (in
12790 addition to the normal search locations)
12791 --instantiate-with NAME=MOD
12793 A mapping of signature names to concrete module instanti‐
12794 ations.
12795 --enable-tests
12797 --disable-tests
12798 dependency checking and compilation for test suites
12799 listed in the package description file.
12800 --enable-coverage
12802 --disable-coverage
12803 build package with Haskell Program Coverage. (GHC only)
12804 --enable-library-coverage
12806 --disable-library-coverage
12807 build package with Haskell Program Coverage. (GHC only)
12808 (DEPRECATED)
12809 --enable-benchmarks
12811 --disable-benchmarks
12812 dependency checking and compilation for benchmarks listed
12813 in the package description file.
12814 --enable-relocatable
12816 --disable-relocatable
12817 building a package that is relocatable. (GHC only)
12818 --disable-response-files
12820 enable workaround for old versions of programs like "ar"
12821 that do not support @file arguments
12822 --with-alex PATH
12824 give the path to alex
12825 --with-ar PATH
12827 give the path to ar
12828 --with-c2hs PATH
12830 give the path to c2hs
12831 --with-cpphs PATH
12833 give the path to cpphs
12834 --with-doctest PATH
12836 give the path to doctest
12837 --with-gcc PATH
12839 give the path to gcc
12840 --with-ghc PATH
12842 give the path to ghc
12843 --with-ghc-pkg PATH
12845 give the path to ghc-pkg
12846 --with-ghcjs PATH
12848 give the path to ghcjs
12849 --with-ghcjs-pkg PATH
12851 give the path to ghcjs-pkg
12852 --with-greencard PATH
12854 give the path to greencard
12855 --with-haddock PATH
12857 give the path to haddock
12858 --with-happy PATH
12860 give the path to happy
12861 --with-haskell-suite PATH
12863 give the path to haskell-suite
12864 --with-haskell-suite-pkg PATH
12866 give the path to haskell-suite-pkg
12867 --with-hmake PATH
12869 give the path to hmake
12870 --with-hpc PATH
12872 give the path to hpc
12873 --with-hsc2hs PATH
12875 give the path to hsc2hs
12876 --with-hscolour PATH
12878 give the path to hscolour
12879 --with-jhc PATH
12881 give the path to jhc
12882 --with-ld PATH
12884 give the path to ld
12885 --with-pkg-config PATH
12887 give the path to pkg-config
12888 --with-runghc PATH
12890 give the path to runghc
12891 --with-strip PATH
12893 give the path to strip
12894 --with-tar PATH
12896 give the path to tar
12897 --with-uhc PATH
12899 give the path to uhc
12900 --alex-option OPT
12902 give an extra option to alex (no need to quote options
12903 containing spaces)
12904 --ar-option OPT
12906 give an extra option to ar (no need to quote options con‐
12907 taining spaces)
12908 --c2hs-option OPT
12910 give an extra option to c2hs (no need to quote options
12911 containing spaces)
12912 --cpphs-option OPT
12914 give an extra option to cpphs (no need to quote options
12915 containing spaces)
12916 --doctest-option OPT
12918 give an extra option to doctest (no need to quote options
12919 containing spaces)
12920 --gcc-option OPT
12922 give an extra option to gcc (no need to quote options
12923 containing spaces)
12924 --ghc-option OPT
12926 give an extra option to ghc (no need to quote options
12927 containing spaces)
12928 --ghc-pkg-option OPT
12930 give an extra option to ghc-pkg (no need to quote options
12931 containing spaces)
12932 --ghcjs-option OPT
12934 give an extra option to ghcjs (no need to quote options
12935 containing spaces)
12936 --ghcjs-pkg-option OPT
12938 give an extra option to ghcjs-pkg (no need to quote
12939 options containing spaces)
12940 --greencard-option OPT
12942 give an extra option to greencard (no need to quote
12943 options containing spaces)
12944 --haddock-option OPT
12946 give an extra option to haddock (no need to quote options
12947 containing spaces)
12948 --happy-option OPT
12950 give an extra option to happy (no need to quote options
12951 containing spaces)
12952 --haskell-suite-option OPT
12954 give an extra option to haskell-suite (no need to quote
12955 options containing spaces)
12956 --haskell-suite-pkg-option OPT
12958 give an extra option to haskell-suite-pkg (no need to
12959 quote options containing spaces)
12960 --hmake-option OPT
12962 give an extra option to hmake (no need to quote options
12963 containing spaces)
12964 --hpc-option OPT
12966 give an extra option to hpc (no need to quote options
12967 containing spaces)
12968 --hsc2hs-option OPT
12970 give an extra option to hsc2hs (no need to quote options
12971 containing spaces)
12972 --hscolour-option OPT
12974 give an extra option to hscolour (no need to quote
12975 options containing spaces)
12976 --jhc-option OPT
12978 give an extra option to jhc (no need to quote options
12979 containing spaces)
12980 --ld-option OPT
12982 give an extra option to ld (no need to quote options con‐
12983 taining spaces)
12984 --pkg-config-option OPT
12986 give an extra option to pkg-config (no need to quote
12987 options containing spaces)
12988 --runghc-option OPT
12990 give an extra option to runghc (no need to quote options
12991 containing spaces)
12992 --strip-option OPT
12994 give an extra option to strip (no need to quote options
12995 containing spaces)
12996 --tar-option OPT
12998 give an extra option to tar (no need to quote options
12999 containing spaces)
13000 --uhc-option OPT
13002 give an extra option to uhc (no need to quote options
13003 containing spaces)
13004 --alex-options OPTS
13006 give extra options to alex
13007 --ar-options OPTS
13009 give extra options to ar
13010 --c2hs-options OPTS
13012 give extra options to c2hs
13013 --cpphs-options OPTS
13015 give extra options to cpphs
13016 --doctest-options OPTS
13018 give extra options to doctest
13019 --gcc-options OPTS
13021 give extra options to gcc
13022 --ghc-options OPTS
13024 give extra options to ghc
13025 --ghc-pkg-options OPTS
13027 give extra options to ghc-pkg
13028 --ghcjs-options OPTS
13030 give extra options to ghcjs
13031 --ghcjs-pkg-options OPTS
13033 give extra options to ghcjs-pkg
13034 --greencard-options OPTS
13036 give extra options to greencard
13037 --haddock-options OPTS
13039 give extra options to haddock
13040 --happy-options OPTS
13042 give extra options to happy
13043 --haskell-suite-options OPTS
13045 give extra options to haskell-suite
13046 --haskell-suite-pkg-options OPTS
13048 give extra options to haskell-suite-pkg
13049 --hmake-options OPTS
13051 give extra options to hmake
13052 --hpc-options OPTS
13054 give extra options to hpc
13055 --hsc2hs-options OPTS
13057 give extra options to hsc2hs
13058 --hscolour-options OPTS
13060 give extra options to hscolour
13061 --jhc-options OPTS
13063 give extra options to jhc
13064 --ld-options OPTS
13066 give extra options to ld
13067 --pkg-config-options OPTS
13069 give extra options to pkg-config
13070 --runghc-options OPTS
13072 give extra options to runghc
13073 --strip-options OPTS
13075 give extra options to strip
13076 --tar-options OPTS
13078 give extra options to tar
13079 --uhc-options OPTS
13081 give extra options to uhc
13082 --cabal-lib-version VERSION
13084 Select which version of the Cabal lib to use to build
13085 packages (useful for testing).
13086 --constraint CONSTRAINT
13088 Specify constraints on a package (version,
13089 installed/source, flags)
13090 --preference CONSTRAINT
13092 Specify preferences (soft constraints) on the version of
13093 a package
13094 --solver SOLVER
13096 Select dependency solver to use (default: modular).
13097 Choices: modular.
13098 --allow-older [DEPS]
13100 Ignore lower bounds in all dependencies or DEPS
13101 --allow-newer [DEPS]
13103 Ignore upper bounds in all dependencies or DEPS
13104 --enable-documentation
13106 --disable-documentation
13107 building of documentation
13108 --doc-index-file TEMPLATE
13110 A central index of haddock API documentation (template
13111 cannot use $pkgid)
13112 --dry-run
13114 Do not install anything, only print what would be
13115 installed.
13116 --max-backjumps NUM
13118 Maximum number of backjumps allowed while solving
13119 (default: 2000). Use a negative number to enable unlim‐
13120 ited backtracking. Use 0 to disable backtracking com‐
13121 pletely.
13122 --reorder-goals
13124 --no-reorder-goals
13125 Try to reorder goals according to certain heuristics.
13126 Slows things down on average, but may make backtracking
13127 faster for some packages.
13128 --count-conflicts
13130 --no-count-conflicts
13131 Try to speed up solving by preferring goals that are
13132 involved in a lot of conflicts (default).
13133 --independent-goals
13135 --no-independent-goals
13136 Treat several goals on the command line as independent.
13137 If several goals depend on the same package, different
13138 versions can be chosen.
13139 --shadow-installed-packages
13141 --no-shadow-installed-packages
13142 If multiple package instances of the same version are
13143 installed, treat all but one as shadowed.
13144 --strong-flags
13146 --no-strong-flags
13147 Do not defer flag choices (this used to be the default in
13148 cabal-install <= 1.20).
13149 --allow-boot-library-installs
13151 --no-allow-boot-library-installs
13152 Allow cabal to install base, ghc-prim, integer-simple,
13153 integer-gmp, and template-haskell.
13154 --reinstall
13156 --no-reinstall
13157 Install even if it means installing the same version
13158 again.
13159 --avoid-reinstalls
13161 --no-avoid-reinstalls
13162 Do not select versions that would destructively overwrite
13163 installed packages.
13164 --force-reinstalls
13166 --no-force-reinstalls
13167 Reinstall packages even if they will most likely break
13168 other installed packages.
13169 --upgrade-dependencies
13171 --no-upgrade-dependencies
13172 Pick the latest version for all dependencies, rather than
13173 trying to pick an installed version.
13174 --only-dependencies
13176 --no-only-dependencies
13177 Install only the dependencies necessary to build the
13178 given packages
13179 --dependencies-only
13181 --no-dependencies-only
13182 A synonym for --only-dependencies
13183 --index-state STATE
13185 Use source package index state as it existed at a previ‐
13186 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
13187 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
13188 'HEAD' (default: 'HEAD').
13189 --root-cmd COMMAND
13191 (No longer supported, do not use.)
13192 --symlink-bindir DIR
13194 Add symlinks to installed executables into this direc‐
13195 tory.
13196 --build-summary TEMPLATE
13198 Save build summaries to file (name template can use
13199 $pkgid, $compiler, $os, $arch)
13200 --build-log TEMPLATE
13202 Log all builds to file (name template can use $pkgid,
13203 $compiler, $os, $arch)
13204 --remote-build-reporting LEVEL
13206 Generate build reports to send to a remote server (none,
13207 anonymous or detailed).
13208 --report-planning-failure
13210 Generate build reports when the dependency solver fails.
13211 This is used by the Hackage build bot.
13212 --enable-per-component
13214 --disable-per-component
13215 Per-component builds when possible
13216 --one-shot
13218 --no-one-shot
13219 Do not record the packages in the world file.
13220 --run-tests
13222 Run package test suites during installation.
13223 -j, --jobs [NUM]
13225 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
13226 given).
13227 --keep-going
13229 After a build failure, continue to build other unaffected
13230 packages.
13231 --offline
13233 --no-offline
13234 Don't download packages from the Internet.
13235 --project-file FILE
13237 Set the name of the cabal.project file to search for in
13238 parent directories
13239 --only
13241 Only installs the package in the current directory.
13242 --haddock-hoogle
13244 Generate a hoogle database
13245 --haddock-html
13247 Generate HTML documentation (the default)
13248 --haddock-html-location URL
13250 Location of HTML documentation for pre-requisite packages
13251 --haddock-for-hackage
13253 Collection of flags to generate documentation suitable
13254 for upload to hackage
13255 --haddock-executables
13257 Run haddock for Executables targets
13258 --haddock-tests
13260 Run haddock for Test Suite targets
13261 --haddock-benchmarks
13263 Run haddock for Benchmark targets
13264 --haddock-all
13266 Run haddock for all targets
13267 --haddock-internal
13269 Run haddock for internal modules and include all symbols
13270 --haddock-css PATH
13272 Use PATH as the haddock stylesheet
13273 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
13275 dock-hyperlinked-source
13276 Hyperlink the documentation to the source code
13277 --haddock-quickjump
13279 Generate an index for interactive documentation naviga‐
13280 tion
13281 --haddock-hscolour-css PATH
13283 Use PATH as the HsColour stylesheet
13284 --haddock-contents-location URL
13286 Bake URL in as the location for the contents page
13287 cabal v2-bench
13290 Usage: cabal v2-bench [TARGETS] [FLAGS]
13292 Runs the specified benchmarks, first ensuring they are up to date.
13295 Any benchmark in any package in the project can be specified. A package
13297 can be specified in which case all the benchmarks in the package are
13298 run. The default is to run all the benchmarks in the package in the
13299 current directory.
13300 Dependencies are built or rebuilt as necessary. Additional configura‐
13302 tion flags can be specified on the command line and these extend the
13303 project configuration from the 'cabal.project', 'cabal.project.local'
13304 and other files.
13305 Runs the specified benchmarks, first ensuring they are up to date.
13308 Any benchmark in any package in the project can be specified. A package
13310 can be specified in which case all the benchmarks in the package are
13311 run. The default is to run all the benchmarks in the package in the
13312 current directory.
13313 Dependencies are built or rebuilt as necessary. Additional configura‐
13315 tion flags can be specified on the command line and these extend the
13316 project configuration from the 'cabal.project', 'cabal.project.local'
13317 and other files.
13318 Flags:
13321 -v, --verbose [n]
13322 Control verbosity (n is 0--3, default verbosity level is
13323 1)
13324 --builddir, --distdir, --distpref DIR
13326 The directory where Cabal puts generated build files
13327 (default dist)
13328 -g, --ghc
13330 compile with GHC
13331 --ghcjs
13333 compile with GHCJS
13334 --uhc
13336 compile with UHC
13337 --haskell-suite
13339 compile with a haskell-suite compiler
13340 --cabal-file PATH
13342 use this Cabal file
13343 -w, --with-compiler PATH
13345 give the path to a particular compiler
13346 --with-hc-pkg PATH
13348 give the path to the package tool
13349 --prefix DIR
13351 bake this prefix in preparation of installation
13352 --bindir DIR
13354 installation directory for executables
13355 --libdir DIR
13357 installation directory for libraries
13358 --libsubdir DIR
13360 subdirectory of libdir in which libs are installed
13361 --dynlibdir DIR
13363 installation directory for dynamic libraries
13364 --libexecdir DIR
13366 installation directory for program executables
13367 --libexecsubdir DIR
13369 subdirectory of libexecdir in which private executables
13370 are installed
13371 --datadir DIR
13373 installation directory for read-only data
13374 --datasubdir DIR
13376 subdirectory of datadir in which data files are installed
13377 --docdir DIR
13379 installation directory for documentation
13380 --htmldir DIR
13382 installation directory for HTML documentation
13383 --haddockdir DIR
13385 installation directory for haddock interfaces
13386 --sysconfdir DIR
13388 installation directory for configuration files
13389 --program-prefix PREFIX
13391 prefix to be applied to installed executables
13392 --program-suffix SUFFIX
13394 suffix to be applied to installed executables
13395 --enable-library-vanilla
13397 --disable-library-vanilla
13398 Vanilla libraries
13399 -p, --enable-library-profiling
13401 --disable-library-profiling
13402 Library profiling
13403 --enable-shared
13405 --disable-shared
13406 Shared library
13407 --enable-static
13409 --disable-static
13410 Static library
13411 --enable-executable-dynamic
13413 --disable-executable-dynamic
13414 Executable dynamic linking
13415 --enable-profiling
13417 --disable-profiling
13418 Executable and library profiling
13419 --enable-executable-profiling
13421 --disable-executable-profiling
13422 Executable profiling (DEPRECATED)
13423 --profiling-detail level
13425 Profiling detail level for executable and library
13426 (default, none, exported-functions, toplevel-functions,
13427 all-functions).
13428 --library-profiling-detail level
13430 Profiling detail level for libraries only.
13431 -O, --enable-optimization, --enable-optimisation [n]
13433 Build with optimization (n is 0--2, default is 1)
13434 --disable-optimization, --disable-optimisation
13436 Build without optimization
13437 --enable-debug-info [n]
13439 Emit debug info (n is 0--3, default is 0)
13440 --disable-debug-info
13442 Don't emit debug info
13443 --enable-library-for-ghci
13445 --disable-library-for-ghci
13446 compile library for use with GHCi
13447 --enable-split-sections
13449 --disable-split-sections
13450 compile library code such that unneeded definitions can
13451 be dropped from the final executable (GHC 7.8+)
13452 --enable-split-objs
13454 --disable-split-objs
13455 split library into smaller objects to reduce binary sizes
13456 (GHC 6.6+)
13457 --enable-executable-stripping
13459 --disable-executable-stripping
13460 strip executables upon installation to reduce binary
13461 sizes
13462 --enable-library-stripping
13464 --disable-library-stripping
13465 strip libraries upon installation to reduce binary sizes
13466 --configure-option OPT
13468 Extra option for configure
13469 --user
13471 --global
13472 doing a per-user installation
13473 --package-db DB
13475 Append the given package database to the list of package
13476 databases used (to satisfy dependencies and register
13477 into). May be a specific file, 'global' or 'user'. The
13478 initial list is ['global'], ['global', 'user'], or
13479 ['global', $sandbox], depending on context. Use 'clear'
13480 to reset the list to empty. See the user guide for
13481 details.
13482 -f, --flags FLAGS
13484 Force values for the given flags in Cabal conditionals in
13485 the .cabal file. E.g., --flags="debug -usebytestrings"
13486 forces the flag "debug" to true and "usebytestrings" to
13487 false.
13488 --extra-include-dirs PATH
13490 A list of directories to search for header files
13491 --enable-deterministic
13493 --disable-deterministic
13494 Try to be as deterministic as possible (used by the test
13495 suite)
13496 --ipid IPID
13498 Installed package ID to compile this package as
13499 --cid CID
13501 Installed component ID to compile this component as
13502 --extra-lib-dirs PATH
13504 A list of directories to search for external libraries
13505 --extra-framework-dirs PATH
13507 A list of directories to search for external frameworks
13508 (OS X only)
13509 --extra-prog-path PATH
13511 A list of directories to search for required programs (in
13512 addition to the normal search locations)
13513 --instantiate-with NAME=MOD
13515 A mapping of signature names to concrete module instanti‐
13516 ations.
13517 --enable-tests
13519 --disable-tests
13520 dependency checking and compilation for test suites
13521 listed in the package description file.
13522 --enable-coverage
13524 --disable-coverage
13525 build package with Haskell Program Coverage. (GHC only)
13526 --enable-library-coverage
13528 --disable-library-coverage
13529 build package with Haskell Program Coverage. (GHC only)
13530 (DEPRECATED)
13531 --enable-benchmarks
13533 --disable-benchmarks
13534 dependency checking and compilation for benchmarks listed
13535 in the package description file.
13536 --enable-relocatable
13538 --disable-relocatable
13539 building a package that is relocatable. (GHC only)
13540 --disable-response-files
13542 enable workaround for old versions of programs like "ar"
13543 that do not support @file arguments
13544 --with-alex PATH
13546 give the path to alex
13547 --with-ar PATH
13549 give the path to ar
13550 --with-c2hs PATH
13552 give the path to c2hs
13553 --with-cpphs PATH
13555 give the path to cpphs
13556 --with-doctest PATH
13558 give the path to doctest
13559 --with-gcc PATH
13561 give the path to gcc
13562 --with-ghc PATH
13564 give the path to ghc
13565 --with-ghc-pkg PATH
13567 give the path to ghc-pkg
13568 --with-ghcjs PATH
13570 give the path to ghcjs
13571 --with-ghcjs-pkg PATH
13573 give the path to ghcjs-pkg
13574 --with-greencard PATH
13576 give the path to greencard
13577 --with-haddock PATH
13579 give the path to haddock
13580 --with-happy PATH
13582 give the path to happy
13583 --with-haskell-suite PATH
13585 give the path to haskell-suite
13586 --with-haskell-suite-pkg PATH
13588 give the path to haskell-suite-pkg
13589 --with-hmake PATH
13591 give the path to hmake
13592 --with-hpc PATH
13594 give the path to hpc
13595 --with-hsc2hs PATH
13597 give the path to hsc2hs
13598 --with-hscolour PATH
13600 give the path to hscolour
13601 --with-jhc PATH
13603 give the path to jhc
13604 --with-ld PATH
13606 give the path to ld
13607 --with-pkg-config PATH
13609 give the path to pkg-config
13610 --with-runghc PATH
13612 give the path to runghc
13613 --with-strip PATH
13615 give the path to strip
13616 --with-tar PATH
13618 give the path to tar
13619 --with-uhc PATH
13621 give the path to uhc
13622 --alex-option OPT
13624 give an extra option to alex (no need to quote options
13625 containing spaces)
13626 --ar-option OPT
13628 give an extra option to ar (no need to quote options con‐
13629 taining spaces)
13630 --c2hs-option OPT
13632 give an extra option to c2hs (no need to quote options
13633 containing spaces)
13634 --cpphs-option OPT
13636 give an extra option to cpphs (no need to quote options
13637 containing spaces)
13638 --doctest-option OPT
13640 give an extra option to doctest (no need to quote options
13641 containing spaces)
13642 --gcc-option OPT
13644 give an extra option to gcc (no need to quote options
13645 containing spaces)
13646 --ghc-option OPT
13648 give an extra option to ghc (no need to quote options
13649 containing spaces)
13650 --ghc-pkg-option OPT
13652 give an extra option to ghc-pkg (no need to quote options
13653 containing spaces)
13654 --ghcjs-option OPT
13656 give an extra option to ghcjs (no need to quote options
13657 containing spaces)
13658 --ghcjs-pkg-option OPT
13660 give an extra option to ghcjs-pkg (no need to quote
13661 options containing spaces)
13662 --greencard-option OPT
13664 give an extra option to greencard (no need to quote
13665 options containing spaces)
13666 --haddock-option OPT
13668 give an extra option to haddock (no need to quote options
13669 containing spaces)
13670 --happy-option OPT
13672 give an extra option to happy (no need to quote options
13673 containing spaces)
13674 --haskell-suite-option OPT
13676 give an extra option to haskell-suite (no need to quote
13677 options containing spaces)
13678 --haskell-suite-pkg-option OPT
13680 give an extra option to haskell-suite-pkg (no need to
13681 quote options containing spaces)
13682 --hmake-option OPT
13684 give an extra option to hmake (no need to quote options
13685 containing spaces)
13686 --hpc-option OPT
13688 give an extra option to hpc (no need to quote options
13689 containing spaces)
13690 --hsc2hs-option OPT
13692 give an extra option to hsc2hs (no need to quote options
13693 containing spaces)
13694 --hscolour-option OPT
13696 give an extra option to hscolour (no need to quote
13697 options containing spaces)
13698 --jhc-option OPT
13700 give an extra option to jhc (no need to quote options
13701 containing spaces)
13702 --ld-option OPT
13704 give an extra option to ld (no need to quote options con‐
13705 taining spaces)
13706 --pkg-config-option OPT
13708 give an extra option to pkg-config (no need to quote
13709 options containing spaces)
13710 --runghc-option OPT
13712 give an extra option to runghc (no need to quote options
13713 containing spaces)
13714 --strip-option OPT
13716 give an extra option to strip (no need to quote options
13717 containing spaces)
13718 --tar-option OPT
13720 give an extra option to tar (no need to quote options
13721 containing spaces)
13722 --uhc-option OPT
13724 give an extra option to uhc (no need to quote options
13725 containing spaces)
13726 --alex-options OPTS
13728 give extra options to alex
13729 --ar-options OPTS
13731 give extra options to ar
13732 --c2hs-options OPTS
13734 give extra options to c2hs
13735 --cpphs-options OPTS
13737 give extra options to cpphs
13738 --doctest-options OPTS
13740 give extra options to doctest
13741 --gcc-options OPTS
13743 give extra options to gcc
13744 --ghc-options OPTS
13746 give extra options to ghc
13747 --ghc-pkg-options OPTS
13749 give extra options to ghc-pkg
13750 --ghcjs-options OPTS
13752 give extra options to ghcjs
13753 --ghcjs-pkg-options OPTS
13755 give extra options to ghcjs-pkg
13756 --greencard-options OPTS
13758 give extra options to greencard
13759 --haddock-options OPTS
13761 give extra options to haddock
13762 --happy-options OPTS
13764 give extra options to happy
13765 --haskell-suite-options OPTS
13767 give extra options to haskell-suite
13768 --haskell-suite-pkg-options OPTS
13770 give extra options to haskell-suite-pkg
13771 --hmake-options OPTS
13773 give extra options to hmake
13774 --hpc-options OPTS
13776 give extra options to hpc
13777 --hsc2hs-options OPTS
13779 give extra options to hsc2hs
13780 --hscolour-options OPTS
13782 give extra options to hscolour
13783 --jhc-options OPTS
13785 give extra options to jhc
13786 --ld-options OPTS
13788 give extra options to ld
13789 --pkg-config-options OPTS
13791 give extra options to pkg-config
13792 --runghc-options OPTS
13794 give extra options to runghc
13795 --strip-options OPTS
13797 give extra options to strip
13798 --tar-options OPTS
13800 give extra options to tar
13801 --uhc-options OPTS
13803 give extra options to uhc
13804 --cabal-lib-version VERSION
13806 Select which version of the Cabal lib to use to build
13807 packages (useful for testing).
13808 --constraint CONSTRAINT
13810 Specify constraints on a package (version,
13811 installed/source, flags)
13812 --preference CONSTRAINT
13814 Specify preferences (soft constraints) on the version of
13815 a package
13816 --solver SOLVER
13818 Select dependency solver to use (default: modular).
13819 Choices: modular.
13820 --allow-older [DEPS]
13822 Ignore lower bounds in all dependencies or DEPS
13823 --allow-newer [DEPS]
13825 Ignore upper bounds in all dependencies or DEPS
13826 --enable-documentation
13828 --disable-documentation
13829 building of documentation
13830 --doc-index-file TEMPLATE
13832 A central index of haddock API documentation (template
13833 cannot use $pkgid)
13834 --dry-run
13836 Do not install anything, only print what would be
13837 installed.
13838 --max-backjumps NUM
13840 Maximum number of backjumps allowed while solving
13841 (default: 2000). Use a negative number to enable unlim‐
13842 ited backtracking. Use 0 to disable backtracking com‐
13843 pletely.
13844 --reorder-goals
13846 --no-reorder-goals
13847 Try to reorder goals according to certain heuristics.
13848 Slows things down on average, but may make backtracking
13849 faster for some packages.
13850 --count-conflicts
13852 --no-count-conflicts
13853 Try to speed up solving by preferring goals that are
13854 involved in a lot of conflicts (default).
13855 --independent-goals
13857 --no-independent-goals
13858 Treat several goals on the command line as independent.
13859 If several goals depend on the same package, different
13860 versions can be chosen.
13861 --shadow-installed-packages
13863 --no-shadow-installed-packages
13864 If multiple package instances of the same version are
13865 installed, treat all but one as shadowed.
13866 --strong-flags
13868 --no-strong-flags
13869 Do not defer flag choices (this used to be the default in
13870 cabal-install <= 1.20).
13871 --allow-boot-library-installs
13873 --no-allow-boot-library-installs
13874 Allow cabal to install base, ghc-prim, integer-simple,
13875 integer-gmp, and template-haskell.
13876 --reinstall
13878 --no-reinstall
13879 Install even if it means installing the same version
13880 again.
13881 --avoid-reinstalls
13883 --no-avoid-reinstalls
13884 Do not select versions that would destructively overwrite
13885 installed packages.
13886 --force-reinstalls
13888 --no-force-reinstalls
13889 Reinstall packages even if they will most likely break
13890 other installed packages.
13891 --upgrade-dependencies
13893 --no-upgrade-dependencies
13894 Pick the latest version for all dependencies, rather than
13895 trying to pick an installed version.
13896 --only-dependencies
13898 --no-only-dependencies
13899 Install only the dependencies necessary to build the
13900 given packages
13901 --dependencies-only
13903 --no-dependencies-only
13904 A synonym for --only-dependencies
13905 --index-state STATE
13907 Use source package index state as it existed at a previ‐
13908 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
13909 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
13910 'HEAD' (default: 'HEAD').
13911 --root-cmd COMMAND
13913 (No longer supported, do not use.)
13914 --symlink-bindir DIR
13916 Add symlinks to installed executables into this direc‐
13917 tory.
13918 --build-summary TEMPLATE
13920 Save build summaries to file (name template can use
13921 $pkgid, $compiler, $os, $arch)
13922 --build-log TEMPLATE
13924 Log all builds to file (name template can use $pkgid,
13925 $compiler, $os, $arch)
13926 --remote-build-reporting LEVEL
13928 Generate build reports to send to a remote server (none,
13929 anonymous or detailed).
13930 --report-planning-failure
13932 Generate build reports when the dependency solver fails.
13933 This is used by the Hackage build bot.
13934 --enable-per-component
13936 --disable-per-component
13937 Per-component builds when possible
13938 --one-shot
13940 --no-one-shot
13941 Do not record the packages in the world file.
13942 --run-tests
13944 Run package test suites during installation.
13945 -j, --jobs [NUM]
13947 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
13948 given).
13949 --keep-going
13951 After a build failure, continue to build other unaffected
13952 packages.
13953 --offline
13955 --no-offline
13956 Don't download packages from the Internet.
13957 --project-file FILE
13959 Set the name of the cabal.project file to search for in
13960 parent directories
13961 --only
13963 Only installs the package in the current directory.
13964 --haddock-hoogle
13966 Generate a hoogle database
13967 --haddock-html
13969 Generate HTML documentation (the default)
13970 --haddock-html-location URL
13972 Location of HTML documentation for pre-requisite packages
13973 --haddock-for-hackage
13975 Collection of flags to generate documentation suitable
13976 for upload to hackage
13977 --haddock-executables
13979 Run haddock for Executables targets
13980 --haddock-tests
13982 Run haddock for Test Suite targets
13983 --haddock-benchmarks
13985 Run haddock for Benchmark targets
13986 --haddock-all
13988 Run haddock for all targets
13989 --haddock-internal
13991 Run haddock for internal modules and include all symbols
13992 --haddock-css PATH
13994 Use PATH as the haddock stylesheet
13995 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
13997 dock-hyperlinked-source
13998 Hyperlink the documentation to the source code
13999 --haddock-quickjump
14001 Generate an index for interactive documentation naviga‐
14002 tion
14003 --haddock-hscolour-css PATH
14005 Use PATH as the HsColour stylesheet
14006 --haddock-contents-location URL
14008 Bake URL in as the location for the contents page
14009 cabal new-bench
14012 Usage: cabal new-bench [TARGETS] [FLAGS]
14014 Runs the specified benchmarks, first ensuring they are up to date.
14017 Any benchmark in any package in the project can be specified. A package
14019 can be specified in which case all the benchmarks in the package are
14020 run. The default is to run all the benchmarks in the package in the
14021 current directory.
14022 Dependencies are built or rebuilt as necessary. Additional configura‐
14024 tion flags can be specified on the command line and these extend the
14025 project configuration from the 'cabal.project', 'cabal.project.local'
14026 and other files.
14027 Examples:
14030 cabal new-bench
14031 Run all the benchmarks in the package in the current directory
14032 cabal new-bench pkgname
14033 Run all the benchmarks in the package named pkgname
14034 cabal new-bench cname
14035 Run the benchmark named cname
14036 cabal new-bench cname -O2
14037 Run the benchmark built with '-O2' (including local libs used)
14038 Note: this command is part of the new project-based system (aka nix-
14040 style local builds). These features are currently in beta. Please see
14041 http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html for
14042 details and advice on what you can expect to work. If you encounter
14043 problems please file issues at https://github.com/haskell/cabal/issues
14044 and if you have any time to get involved and help with testing, fixing
14045 bugs etc then that is very much appreciated.
14046 Flags:
14049 -v, --verbose [n]
14050 Control verbosity (n is 0--3, default verbosity level is
14051 1)
14052 --builddir, --distdir, --distpref DIR
14054 The directory where Cabal puts generated build files
14055 (default dist)
14056 -g, --ghc
14058 compile with GHC
14059 --ghcjs
14061 compile with GHCJS
14062 --uhc
14064 compile with UHC
14065 --haskell-suite
14067 compile with a haskell-suite compiler
14068 --cabal-file PATH
14070 use this Cabal file
14071 -w, --with-compiler PATH
14073 give the path to a particular compiler
14074 --with-hc-pkg PATH
14076 give the path to the package tool
14077 --prefix DIR
14079 bake this prefix in preparation of installation
14080 --bindir DIR
14082 installation directory for executables
14083 --libdir DIR
14085 installation directory for libraries
14086 --libsubdir DIR
14088 subdirectory of libdir in which libs are installed
14089 --dynlibdir DIR
14091 installation directory for dynamic libraries
14092 --libexecdir DIR
14094 installation directory for program executables
14095 --libexecsubdir DIR
14097 subdirectory of libexecdir in which private executables
14098 are installed
14099 --datadir DIR
14101 installation directory for read-only data
14102 --datasubdir DIR
14104 subdirectory of datadir in which data files are installed
14105 --docdir DIR
14107 installation directory for documentation
14108 --htmldir DIR
14110 installation directory for HTML documentation
14111 --haddockdir DIR
14113 installation directory for haddock interfaces
14114 --sysconfdir DIR
14116 installation directory for configuration files
14117 --program-prefix PREFIX
14119 prefix to be applied to installed executables
14120 --program-suffix SUFFIX
14122 suffix to be applied to installed executables
14123 --enable-library-vanilla
14125 --disable-library-vanilla
14126 Vanilla libraries
14127 -p, --enable-library-profiling
14129 --disable-library-profiling
14130 Library profiling
14131 --enable-shared
14133 --disable-shared
14134 Shared library
14135 --enable-static
14137 --disable-static
14138 Static library
14139 --enable-executable-dynamic
14141 --disable-executable-dynamic
14142 Executable dynamic linking
14143 --enable-profiling
14145 --disable-profiling
14146 Executable and library profiling
14147 --enable-executable-profiling
14149 --disable-executable-profiling
14150 Executable profiling (DEPRECATED)
14151 --profiling-detail level
14153 Profiling detail level for executable and library
14154 (default, none, exported-functions, toplevel-functions,
14155 all-functions).
14156 --library-profiling-detail level
14158 Profiling detail level for libraries only.
14159 -O, --enable-optimization, --enable-optimisation [n]
14161 Build with optimization (n is 0--2, default is 1)
14162 --disable-optimization, --disable-optimisation
14164 Build without optimization
14165 --enable-debug-info [n]
14167 Emit debug info (n is 0--3, default is 0)
14168 --disable-debug-info
14170 Don't emit debug info
14171 --enable-library-for-ghci
14173 --disable-library-for-ghci
14174 compile library for use with GHCi
14175 --enable-split-sections
14177 --disable-split-sections
14178 compile library code such that unneeded definitions can
14179 be dropped from the final executable (GHC 7.8+)
14180 --enable-split-objs
14182 --disable-split-objs
14183 split library into smaller objects to reduce binary sizes
14184 (GHC 6.6+)
14185 --enable-executable-stripping
14187 --disable-executable-stripping
14188 strip executables upon installation to reduce binary
14189 sizes
14190 --enable-library-stripping
14192 --disable-library-stripping
14193 strip libraries upon installation to reduce binary sizes
14194 --configure-option OPT
14196 Extra option for configure
14197 --user
14199 --global
14200 doing a per-user installation
14201 --package-db DB
14203 Append the given package database to the list of package
14204 databases used (to satisfy dependencies and register
14205 into). May be a specific file, 'global' or 'user'. The
14206 initial list is ['global'], ['global', 'user'], or
14207 ['global', $sandbox], depending on context. Use 'clear'
14208 to reset the list to empty. See the user guide for
14209 details.
14210 -f, --flags FLAGS
14212 Force values for the given flags in Cabal conditionals in
14213 the .cabal file. E.g., --flags="debug -usebytestrings"
14214 forces the flag "debug" to true and "usebytestrings" to
14215 false.
14216 --extra-include-dirs PATH
14218 A list of directories to search for header files
14219 --enable-deterministic
14221 --disable-deterministic
14222 Try to be as deterministic as possible (used by the test
14223 suite)
14224 --ipid IPID
14226 Installed package ID to compile this package as
14227 --cid CID
14229 Installed component ID to compile this component as
14230 --extra-lib-dirs PATH
14232 A list of directories to search for external libraries
14233 --extra-framework-dirs PATH
14235 A list of directories to search for external frameworks
14236 (OS X only)
14237 --extra-prog-path PATH
14239 A list of directories to search for required programs (in
14240 addition to the normal search locations)
14241 --instantiate-with NAME=MOD
14243 A mapping of signature names to concrete module instanti‐
14244 ations.
14245 --enable-tests
14247 --disable-tests
14248 dependency checking and compilation for test suites
14249 listed in the package description file.
14250 --enable-coverage
14252 --disable-coverage
14253 build package with Haskell Program Coverage. (GHC only)
14254 --enable-library-coverage
14256 --disable-library-coverage
14257 build package with Haskell Program Coverage. (GHC only)
14258 (DEPRECATED)
14259 --enable-benchmarks
14261 --disable-benchmarks
14262 dependency checking and compilation for benchmarks listed
14263 in the package description file.
14264 --enable-relocatable
14266 --disable-relocatable
14267 building a package that is relocatable. (GHC only)
14268 --disable-response-files
14270 enable workaround for old versions of programs like "ar"
14271 that do not support @file arguments
14272 --with-alex PATH
14274 give the path to alex
14275 --with-ar PATH
14277 give the path to ar
14278 --with-c2hs PATH
14280 give the path to c2hs
14281 --with-cpphs PATH
14283 give the path to cpphs
14284 --with-doctest PATH
14286 give the path to doctest
14287 --with-gcc PATH
14289 give the path to gcc
14290 --with-ghc PATH
14292 give the path to ghc
14293 --with-ghc-pkg PATH
14295 give the path to ghc-pkg
14296 --with-ghcjs PATH
14298 give the path to ghcjs
14299 --with-ghcjs-pkg PATH
14301 give the path to ghcjs-pkg
14302 --with-greencard PATH
14304 give the path to greencard
14305 --with-haddock PATH
14307 give the path to haddock
14308 --with-happy PATH
14310 give the path to happy
14311 --with-haskell-suite PATH
14313 give the path to haskell-suite
14314 --with-haskell-suite-pkg PATH
14316 give the path to haskell-suite-pkg
14317 --with-hmake PATH
14319 give the path to hmake
14320 --with-hpc PATH
14322 give the path to hpc
14323 --with-hsc2hs PATH
14325 give the path to hsc2hs
14326 --with-hscolour PATH
14328 give the path to hscolour
14329 --with-jhc PATH
14331 give the path to jhc
14332 --with-ld PATH
14334 give the path to ld
14335 --with-pkg-config PATH
14337 give the path to pkg-config
14338 --with-runghc PATH
14340 give the path to runghc
14341 --with-strip PATH
14343 give the path to strip
14344 --with-tar PATH
14346 give the path to tar
14347 --with-uhc PATH
14349 give the path to uhc
14350 --alex-option OPT
14352 give an extra option to alex (no need to quote options
14353 containing spaces)
14354 --ar-option OPT
14356 give an extra option to ar (no need to quote options con‐
14357 taining spaces)
14358 --c2hs-option OPT
14360 give an extra option to c2hs (no need to quote options
14361 containing spaces)
14362 --cpphs-option OPT
14364 give an extra option to cpphs (no need to quote options
14365 containing spaces)
14366 --doctest-option OPT
14368 give an extra option to doctest (no need to quote options
14369 containing spaces)
14370 --gcc-option OPT
14372 give an extra option to gcc (no need to quote options
14373 containing spaces)
14374 --ghc-option OPT
14376 give an extra option to ghc (no need to quote options
14377 containing spaces)
14378 --ghc-pkg-option OPT
14380 give an extra option to ghc-pkg (no need to quote options
14381 containing spaces)
14382 --ghcjs-option OPT
14384 give an extra option to ghcjs (no need to quote options
14385 containing spaces)
14386 --ghcjs-pkg-option OPT
14388 give an extra option to ghcjs-pkg (no need to quote
14389 options containing spaces)
14390 --greencard-option OPT
14392 give an extra option to greencard (no need to quote
14393 options containing spaces)
14394 --haddock-option OPT
14396 give an extra option to haddock (no need to quote options
14397 containing spaces)
14398 --happy-option OPT
14400 give an extra option to happy (no need to quote options
14401 containing spaces)
14402 --haskell-suite-option OPT
14404 give an extra option to haskell-suite (no need to quote
14405 options containing spaces)
14406 --haskell-suite-pkg-option OPT
14408 give an extra option to haskell-suite-pkg (no need to
14409 quote options containing spaces)
14410 --hmake-option OPT
14412 give an extra option to hmake (no need to quote options
14413 containing spaces)
14414 --hpc-option OPT
14416 give an extra option to hpc (no need to quote options
14417 containing spaces)
14418 --hsc2hs-option OPT
14420 give an extra option to hsc2hs (no need to quote options
14421 containing spaces)
14422 --hscolour-option OPT
14424 give an extra option to hscolour (no need to quote
14425 options containing spaces)
14426 --jhc-option OPT
14428 give an extra option to jhc (no need to quote options
14429 containing spaces)
14430 --ld-option OPT
14432 give an extra option to ld (no need to quote options con‐
14433 taining spaces)
14434 --pkg-config-option OPT
14436 give an extra option to pkg-config (no need to quote
14437 options containing spaces)
14438 --runghc-option OPT
14440 give an extra option to runghc (no need to quote options
14441 containing spaces)
14442 --strip-option OPT
14444 give an extra option to strip (no need to quote options
14445 containing spaces)
14446 --tar-option OPT
14448 give an extra option to tar (no need to quote options
14449 containing spaces)
14450 --uhc-option OPT
14452 give an extra option to uhc (no need to quote options
14453 containing spaces)
14454 --alex-options OPTS
14456 give extra options to alex
14457 --ar-options OPTS
14459 give extra options to ar
14460 --c2hs-options OPTS
14462 give extra options to c2hs
14463 --cpphs-options OPTS
14465 give extra options to cpphs
14466 --doctest-options OPTS
14468 give extra options to doctest
14469 --gcc-options OPTS
14471 give extra options to gcc
14472 --ghc-options OPTS
14474 give extra options to ghc
14475 --ghc-pkg-options OPTS
14477 give extra options to ghc-pkg
14478 --ghcjs-options OPTS
14480 give extra options to ghcjs
14481 --ghcjs-pkg-options OPTS
14483 give extra options to ghcjs-pkg
14484 --greencard-options OPTS
14486 give extra options to greencard
14487 --haddock-options OPTS
14489 give extra options to haddock
14490 --happy-options OPTS
14492 give extra options to happy
14493 --haskell-suite-options OPTS
14495 give extra options to haskell-suite
14496 --haskell-suite-pkg-options OPTS
14498 give extra options to haskell-suite-pkg
14499 --hmake-options OPTS
14501 give extra options to hmake
14502 --hpc-options OPTS
14504 give extra options to hpc
14505 --hsc2hs-options OPTS
14507 give extra options to hsc2hs
14508 --hscolour-options OPTS
14510 give extra options to hscolour
14511 --jhc-options OPTS
14513 give extra options to jhc
14514 --ld-options OPTS
14516 give extra options to ld
14517 --pkg-config-options OPTS
14519 give extra options to pkg-config
14520 --runghc-options OPTS
14522 give extra options to runghc
14523 --strip-options OPTS
14525 give extra options to strip
14526 --tar-options OPTS
14528 give extra options to tar
14529 --uhc-options OPTS
14531 give extra options to uhc
14532 --cabal-lib-version VERSION
14534 Select which version of the Cabal lib to use to build
14535 packages (useful for testing).
14536 --constraint CONSTRAINT
14538 Specify constraints on a package (version,
14539 installed/source, flags)
14540 --preference CONSTRAINT
14542 Specify preferences (soft constraints) on the version of
14543 a package
14544 --solver SOLVER
14546 Select dependency solver to use (default: modular).
14547 Choices: modular.
14548 --allow-older [DEPS]
14550 Ignore lower bounds in all dependencies or DEPS
14551 --allow-newer [DEPS]
14553 Ignore upper bounds in all dependencies or DEPS
14554 --enable-documentation
14556 --disable-documentation
14557 building of documentation
14558 --doc-index-file TEMPLATE
14560 A central index of haddock API documentation (template
14561 cannot use $pkgid)
14562 --dry-run
14564 Do not install anything, only print what would be
14565 installed.
14566 --max-backjumps NUM
14568 Maximum number of backjumps allowed while solving
14569 (default: 2000). Use a negative number to enable unlim‐
14570 ited backtracking. Use 0 to disable backtracking com‐
14571 pletely.
14572 --reorder-goals
14574 --no-reorder-goals
14575 Try to reorder goals according to certain heuristics.
14576 Slows things down on average, but may make backtracking
14577 faster for some packages.
14578 --count-conflicts
14580 --no-count-conflicts
14581 Try to speed up solving by preferring goals that are
14582 involved in a lot of conflicts (default).
14583 --independent-goals
14585 --no-independent-goals
14586 Treat several goals on the command line as independent.
14587 If several goals depend on the same package, different
14588 versions can be chosen.
14589 --shadow-installed-packages
14591 --no-shadow-installed-packages
14592 If multiple package instances of the same version are
14593 installed, treat all but one as shadowed.
14594 --strong-flags
14596 --no-strong-flags
14597 Do not defer flag choices (this used to be the default in
14598 cabal-install <= 1.20).
14599 --allow-boot-library-installs
14601 --no-allow-boot-library-installs
14602 Allow cabal to install base, ghc-prim, integer-simple,
14603 integer-gmp, and template-haskell.
14604 --reinstall
14606 --no-reinstall
14607 Install even if it means installing the same version
14608 again.
14609 --avoid-reinstalls
14611 --no-avoid-reinstalls
14612 Do not select versions that would destructively overwrite
14613 installed packages.
14614 --force-reinstalls
14616 --no-force-reinstalls
14617 Reinstall packages even if they will most likely break
14618 other installed packages.
14619 --upgrade-dependencies
14621 --no-upgrade-dependencies
14622 Pick the latest version for all dependencies, rather than
14623 trying to pick an installed version.
14624 --only-dependencies
14626 --no-only-dependencies
14627 Install only the dependencies necessary to build the
14628 given packages
14629 --dependencies-only
14631 --no-dependencies-only
14632 A synonym for --only-dependencies
14633 --index-state STATE
14635 Use source package index state as it existed at a previ‐
14636 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
14637 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
14638 'HEAD' (default: 'HEAD').
14639 --root-cmd COMMAND
14641 (No longer supported, do not use.)
14642 --symlink-bindir DIR
14644 Add symlinks to installed executables into this direc‐
14645 tory.
14646 --build-summary TEMPLATE
14648 Save build summaries to file (name template can use
14649 $pkgid, $compiler, $os, $arch)
14650 --build-log TEMPLATE
14652 Log all builds to file (name template can use $pkgid,
14653 $compiler, $os, $arch)
14654 --remote-build-reporting LEVEL
14656 Generate build reports to send to a remote server (none,
14657 anonymous or detailed).
14658 --report-planning-failure
14660 Generate build reports when the dependency solver fails.
14661 This is used by the Hackage build bot.
14662 --enable-per-component
14664 --disable-per-component
14665 Per-component builds when possible
14666 --one-shot
14668 --no-one-shot
14669 Do not record the packages in the world file.
14670 --run-tests
14672 Run package test suites during installation.
14673 -j, --jobs [NUM]
14675 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
14676 given).
14677 --keep-going
14679 After a build failure, continue to build other unaffected
14680 packages.
14681 --offline
14683 --no-offline
14684 Don't download packages from the Internet.
14685 --project-file FILE
14687 Set the name of the cabal.project file to search for in
14688 parent directories
14689 --only
14691 Only installs the package in the current directory.
14692 --haddock-hoogle
14694 Generate a hoogle database
14695 --haddock-html
14697 Generate HTML documentation (the default)
14698 --haddock-html-location URL
14700 Location of HTML documentation for pre-requisite packages
14701 --haddock-for-hackage
14703 Collection of flags to generate documentation suitable
14704 for upload to hackage
14705 --haddock-executables
14707 Run haddock for Executables targets
14708 --haddock-tests
14710 Run haddock for Test Suite targets
14711 --haddock-benchmarks
14713 Run haddock for Benchmark targets
14714 --haddock-all
14716 Run haddock for all targets
14717 --haddock-internal
14719 Run haddock for internal modules and include all symbols
14720 --haddock-css PATH
14722 Use PATH as the haddock stylesheet
14723 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
14725 dock-hyperlinked-source
14726 Hyperlink the documentation to the source code
14727 --haddock-quickjump
14729 Generate an index for interactive documentation naviga‐
14730 tion
14731 --haddock-hscolour-css PATH
14733 Use PATH as the HsColour stylesheet
14734 --haddock-contents-location URL
14736 Bake URL in as the location for the contents page
14737 cabal v2-exec
14740 Usage: cabal v2-exec [FLAGS] [--] COMMAND [--] [ARGS]
14742 During development it is often useful to run build tasks and perform
14745 one-off program executions to experiment with the behavior of build
14746 tools. It is convenient to run these tools in the same way cabal itself
14747 would. The `cabal v2-exec` command provides a way to do so.
14748 Compiler tools will be configured to see the same subset of the store
14750 that builds would see. The PATH is modified to make all executables in
14751 the dependency tree available (provided they have been built already).
14752 Commands are also rewritten in the way cabal itself would. For example,
14753 `cabal v2-exec ghc` will consult the configuration to choose an appro‐
14754 priate version of ghc and to include any ghc-specific flags requested.
14755 During development it is often useful to run build tasks and perform
14758 one-off program executions to experiment with the behavior of build
14759 tools. It is convenient to run these tools in the same way cabal itself
14760 would. The `cabal v2-exec` command provides a way to do so.
14761 Compiler tools will be configured to see the same subset of the store
14763 that builds would see. The PATH is modified to make all executables in
14764 the dependency tree available (provided they have been built already).
14765 Commands are also rewritten in the way cabal itself would. For example,
14766 `cabal v2-exec ghc` will consult the configuration to choose an appro‐
14767 priate version of ghc and to include any ghc-specific flags requested.
14768 Flags:
14771 -v, --verbose [n]
14772 Control verbosity (n is 0--3, default verbosity level is
14773 1)
14774 --builddir, --distdir, --distpref DIR
14776 The directory where Cabal puts generated build files
14777 (default dist)
14778 -g, --ghc
14780 compile with GHC
14781 --ghcjs
14783 compile with GHCJS
14784 --uhc
14786 compile with UHC
14787 --haskell-suite
14789 compile with a haskell-suite compiler
14790 --cabal-file PATH
14792 use this Cabal file
14793 -w, --with-compiler PATH
14795 give the path to a particular compiler
14796 --with-hc-pkg PATH
14798 give the path to the package tool
14799 --prefix DIR
14801 bake this prefix in preparation of installation
14802 --bindir DIR
14804 installation directory for executables
14805 --libdir DIR
14807 installation directory for libraries
14808 --libsubdir DIR
14810 subdirectory of libdir in which libs are installed
14811 --dynlibdir DIR
14813 installation directory for dynamic libraries
14814 --libexecdir DIR
14816 installation directory for program executables
14817 --libexecsubdir DIR
14819 subdirectory of libexecdir in which private executables
14820 are installed
14821 --datadir DIR
14823 installation directory for read-only data
14824 --datasubdir DIR
14826 subdirectory of datadir in which data files are installed
14827 --docdir DIR
14829 installation directory for documentation
14830 --htmldir DIR
14832 installation directory for HTML documentation
14833 --haddockdir DIR
14835 installation directory for haddock interfaces
14836 --sysconfdir DIR
14838 installation directory for configuration files
14839 --program-prefix PREFIX
14841 prefix to be applied to installed executables
14842 --program-suffix SUFFIX
14844 suffix to be applied to installed executables
14845 --enable-library-vanilla
14847 --disable-library-vanilla
14848 Vanilla libraries
14849 -p, --enable-library-profiling
14851 --disable-library-profiling
14852 Library profiling
14853 --enable-shared
14855 --disable-shared
14856 Shared library
14857 --enable-static
14859 --disable-static
14860 Static library
14861 --enable-executable-dynamic
14863 --disable-executable-dynamic
14864 Executable dynamic linking
14865 --enable-profiling
14867 --disable-profiling
14868 Executable and library profiling
14869 --enable-executable-profiling
14871 --disable-executable-profiling
14872 Executable profiling (DEPRECATED)
14873 --profiling-detail level
14875 Profiling detail level for executable and library
14876 (default, none, exported-functions, toplevel-functions,
14877 all-functions).
14878 --library-profiling-detail level
14880 Profiling detail level for libraries only.
14881 -O, --enable-optimization, --enable-optimisation [n]
14883 Build with optimization (n is 0--2, default is 1)
14884 --disable-optimization, --disable-optimisation
14886 Build without optimization
14887 --enable-debug-info [n]
14889 Emit debug info (n is 0--3, default is 0)
14890 --disable-debug-info
14892 Don't emit debug info
14893 --enable-library-for-ghci
14895 --disable-library-for-ghci
14896 compile library for use with GHCi
14897 --enable-split-sections
14899 --disable-split-sections
14900 compile library code such that unneeded definitions can
14901 be dropped from the final executable (GHC 7.8+)
14902 --enable-split-objs
14904 --disable-split-objs
14905 split library into smaller objects to reduce binary sizes
14906 (GHC 6.6+)
14907 --enable-executable-stripping
14909 --disable-executable-stripping
14910 strip executables upon installation to reduce binary
14911 sizes
14912 --enable-library-stripping
14914 --disable-library-stripping
14915 strip libraries upon installation to reduce binary sizes
14916 --configure-option OPT
14918 Extra option for configure
14919 --user
14921 --global
14922 doing a per-user installation
14923 --package-db DB
14925 Append the given package database to the list of package
14926 databases used (to satisfy dependencies and register
14927 into). May be a specific file, 'global' or 'user'. The
14928 initial list is ['global'], ['global', 'user'], or
14929 ['global', $sandbox], depending on context. Use 'clear'
14930 to reset the list to empty. See the user guide for
14931 details.
14932 -f, --flags FLAGS
14934 Force values for the given flags in Cabal conditionals in
14935 the .cabal file. E.g., --flags="debug -usebytestrings"
14936 forces the flag "debug" to true and "usebytestrings" to
14937 false.
14938 --extra-include-dirs PATH
14940 A list of directories to search for header files
14941 --enable-deterministic
14943 --disable-deterministic
14944 Try to be as deterministic as possible (used by the test
14945 suite)
14946 --ipid IPID
14948 Installed package ID to compile this package as
14949 --cid CID
14951 Installed component ID to compile this component as
14952 --extra-lib-dirs PATH
14954 A list of directories to search for external libraries
14955 --extra-framework-dirs PATH
14957 A list of directories to search for external frameworks
14958 (OS X only)
14959 --extra-prog-path PATH
14961 A list of directories to search for required programs (in
14962 addition to the normal search locations)
14963 --instantiate-with NAME=MOD
14965 A mapping of signature names to concrete module instanti‐
14966 ations.
14967 --enable-tests
14969 --disable-tests
14970 dependency checking and compilation for test suites
14971 listed in the package description file.
14972 --enable-coverage
14974 --disable-coverage
14975 build package with Haskell Program Coverage. (GHC only)
14976 --enable-library-coverage
14978 --disable-library-coverage
14979 build package with Haskell Program Coverage. (GHC only)
14980 (DEPRECATED)
14981 --enable-benchmarks
14983 --disable-benchmarks
14984 dependency checking and compilation for benchmarks listed
14985 in the package description file.
14986 --enable-relocatable
14988 --disable-relocatable
14989 building a package that is relocatable. (GHC only)
14990 --disable-response-files
14992 enable workaround for old versions of programs like "ar"
14993 that do not support @file arguments
14994 --with-alex PATH
14996 give the path to alex
14997 --with-ar PATH
14999 give the path to ar
15000 --with-c2hs PATH
15002 give the path to c2hs
15003 --with-cpphs PATH
15005 give the path to cpphs
15006 --with-doctest PATH
15008 give the path to doctest
15009 --with-gcc PATH
15011 give the path to gcc
15012 --with-ghc PATH
15014 give the path to ghc
15015 --with-ghc-pkg PATH
15017 give the path to ghc-pkg
15018 --with-ghcjs PATH
15020 give the path to ghcjs
15021 --with-ghcjs-pkg PATH
15023 give the path to ghcjs-pkg
15024 --with-greencard PATH
15026 give the path to greencard
15027 --with-haddock PATH
15029 give the path to haddock
15030 --with-happy PATH
15032 give the path to happy
15033 --with-haskell-suite PATH
15035 give the path to haskell-suite
15036 --with-haskell-suite-pkg PATH
15038 give the path to haskell-suite-pkg
15039 --with-hmake PATH
15041 give the path to hmake
15042 --with-hpc PATH
15044 give the path to hpc
15045 --with-hsc2hs PATH
15047 give the path to hsc2hs
15048 --with-hscolour PATH
15050 give the path to hscolour
15051 --with-jhc PATH
15053 give the path to jhc
15054 --with-ld PATH
15056 give the path to ld
15057 --with-pkg-config PATH
15059 give the path to pkg-config
15060 --with-runghc PATH
15062 give the path to runghc
15063 --with-strip PATH
15065 give the path to strip
15066 --with-tar PATH
15068 give the path to tar
15069 --with-uhc PATH
15071 give the path to uhc
15072 --alex-option OPT
15074 give an extra option to alex (no need to quote options
15075 containing spaces)
15076 --ar-option OPT
15078 give an extra option to ar (no need to quote options con‐
15079 taining spaces)
15080 --c2hs-option OPT
15082 give an extra option to c2hs (no need to quote options
15083 containing spaces)
15084 --cpphs-option OPT
15086 give an extra option to cpphs (no need to quote options
15087 containing spaces)
15088 --doctest-option OPT
15090 give an extra option to doctest (no need to quote options
15091 containing spaces)
15092 --gcc-option OPT
15094 give an extra option to gcc (no need to quote options
15095 containing spaces)
15096 --ghc-option OPT
15098 give an extra option to ghc (no need to quote options
15099 containing spaces)
15100 --ghc-pkg-option OPT
15102 give an extra option to ghc-pkg (no need to quote options
15103 containing spaces)
15104 --ghcjs-option OPT
15106 give an extra option to ghcjs (no need to quote options
15107 containing spaces)
15108 --ghcjs-pkg-option OPT
15110 give an extra option to ghcjs-pkg (no need to quote
15111 options containing spaces)
15112 --greencard-option OPT
15114 give an extra option to greencard (no need to quote
15115 options containing spaces)
15116 --haddock-option OPT
15118 give an extra option to haddock (no need to quote options
15119 containing spaces)
15120 --happy-option OPT
15122 give an extra option to happy (no need to quote options
15123 containing spaces)
15124 --haskell-suite-option OPT
15126 give an extra option to haskell-suite (no need to quote
15127 options containing spaces)
15128 --haskell-suite-pkg-option OPT
15130 give an extra option to haskell-suite-pkg (no need to
15131 quote options containing spaces)
15132 --hmake-option OPT
15134 give an extra option to hmake (no need to quote options
15135 containing spaces)
15136 --hpc-option OPT
15138 give an extra option to hpc (no need to quote options
15139 containing spaces)
15140 --hsc2hs-option OPT
15142 give an extra option to hsc2hs (no need to quote options
15143 containing spaces)
15144 --hscolour-option OPT
15146 give an extra option to hscolour (no need to quote
15147 options containing spaces)
15148 --jhc-option OPT
15150 give an extra option to jhc (no need to quote options
15151 containing spaces)
15152 --ld-option OPT
15154 give an extra option to ld (no need to quote options con‐
15155 taining spaces)
15156 --pkg-config-option OPT
15158 give an extra option to pkg-config (no need to quote
15159 options containing spaces)
15160 --runghc-option OPT
15162 give an extra option to runghc (no need to quote options
15163 containing spaces)
15164 --strip-option OPT
15166 give an extra option to strip (no need to quote options
15167 containing spaces)
15168 --tar-option OPT
15170 give an extra option to tar (no need to quote options
15171 containing spaces)
15172 --uhc-option OPT
15174 give an extra option to uhc (no need to quote options
15175 containing spaces)
15176 --alex-options OPTS
15178 give extra options to alex
15179 --ar-options OPTS
15181 give extra options to ar
15182 --c2hs-options OPTS
15184 give extra options to c2hs
15185 --cpphs-options OPTS
15187 give extra options to cpphs
15188 --doctest-options OPTS
15190 give extra options to doctest
15191 --gcc-options OPTS
15193 give extra options to gcc
15194 --ghc-options OPTS
15196 give extra options to ghc
15197 --ghc-pkg-options OPTS
15199 give extra options to ghc-pkg
15200 --ghcjs-options OPTS
15202 give extra options to ghcjs
15203 --ghcjs-pkg-options OPTS
15205 give extra options to ghcjs-pkg
15206 --greencard-options OPTS
15208 give extra options to greencard
15209 --haddock-options OPTS
15211 give extra options to haddock
15212 --happy-options OPTS
15214 give extra options to happy
15215 --haskell-suite-options OPTS
15217 give extra options to haskell-suite
15218 --haskell-suite-pkg-options OPTS
15220 give extra options to haskell-suite-pkg
15221 --hmake-options OPTS
15223 give extra options to hmake
15224 --hpc-options OPTS
15226 give extra options to hpc
15227 --hsc2hs-options OPTS
15229 give extra options to hsc2hs
15230 --hscolour-options OPTS
15232 give extra options to hscolour
15233 --jhc-options OPTS
15235 give extra options to jhc
15236 --ld-options OPTS
15238 give extra options to ld
15239 --pkg-config-options OPTS
15241 give extra options to pkg-config
15242 --runghc-options OPTS
15244 give extra options to runghc
15245 --strip-options OPTS
15247 give extra options to strip
15248 --tar-options OPTS
15250 give extra options to tar
15251 --uhc-options OPTS
15253 give extra options to uhc
15254 --cabal-lib-version VERSION
15256 Select which version of the Cabal lib to use to build
15257 packages (useful for testing).
15258 --constraint CONSTRAINT
15260 Specify constraints on a package (version,
15261 installed/source, flags)
15262 --preference CONSTRAINT
15264 Specify preferences (soft constraints) on the version of
15265 a package
15266 --solver SOLVER
15268 Select dependency solver to use (default: modular).
15269 Choices: modular.
15270 --allow-older [DEPS]
15272 Ignore lower bounds in all dependencies or DEPS
15273 --allow-newer [DEPS]
15275 Ignore upper bounds in all dependencies or DEPS
15276 --enable-documentation
15278 --disable-documentation
15279 building of documentation
15280 --doc-index-file TEMPLATE
15282 A central index of haddock API documentation (template
15283 cannot use $pkgid)
15284 --dry-run
15286 Do not install anything, only print what would be
15287 installed.
15288 --max-backjumps NUM
15290 Maximum number of backjumps allowed while solving
15291 (default: 2000). Use a negative number to enable unlim‐
15292 ited backtracking. Use 0 to disable backtracking com‐
15293 pletely.
15294 --reorder-goals
15296 --no-reorder-goals
15297 Try to reorder goals according to certain heuristics.
15298 Slows things down on average, but may make backtracking
15299 faster for some packages.
15300 --count-conflicts
15302 --no-count-conflicts
15303 Try to speed up solving by preferring goals that are
15304 involved in a lot of conflicts (default).
15305 --independent-goals
15307 --no-independent-goals
15308 Treat several goals on the command line as independent.
15309 If several goals depend on the same package, different
15310 versions can be chosen.
15311 --shadow-installed-packages
15313 --no-shadow-installed-packages
15314 If multiple package instances of the same version are
15315 installed, treat all but one as shadowed.
15316 --strong-flags
15318 --no-strong-flags
15319 Do not defer flag choices (this used to be the default in
15320 cabal-install <= 1.20).
15321 --allow-boot-library-installs
15323 --no-allow-boot-library-installs
15324 Allow cabal to install base, ghc-prim, integer-simple,
15325 integer-gmp, and template-haskell.
15326 --reinstall
15328 --no-reinstall
15329 Install even if it means installing the same version
15330 again.
15331 --avoid-reinstalls
15333 --no-avoid-reinstalls
15334 Do not select versions that would destructively overwrite
15335 installed packages.
15336 --force-reinstalls
15338 --no-force-reinstalls
15339 Reinstall packages even if they will most likely break
15340 other installed packages.
15341 --upgrade-dependencies
15343 --no-upgrade-dependencies
15344 Pick the latest version for all dependencies, rather than
15345 trying to pick an installed version.
15346 --only-dependencies
15348 --no-only-dependencies
15349 Install only the dependencies necessary to build the
15350 given packages
15351 --dependencies-only
15353 --no-dependencies-only
15354 A synonym for --only-dependencies
15355 --index-state STATE
15357 Use source package index state as it existed at a previ‐
15358 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
15359 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
15360 'HEAD' (default: 'HEAD').
15361 --root-cmd COMMAND
15363 (No longer supported, do not use.)
15364 --symlink-bindir DIR
15366 Add symlinks to installed executables into this direc‐
15367 tory.
15368 --build-summary TEMPLATE
15370 Save build summaries to file (name template can use
15371 $pkgid, $compiler, $os, $arch)
15372 --build-log TEMPLATE
15374 Log all builds to file (name template can use $pkgid,
15375 $compiler, $os, $arch)
15376 --remote-build-reporting LEVEL
15378 Generate build reports to send to a remote server (none,
15379 anonymous or detailed).
15380 --report-planning-failure
15382 Generate build reports when the dependency solver fails.
15383 This is used by the Hackage build bot.
15384 --enable-per-component
15386 --disable-per-component
15387 Per-component builds when possible
15388 --one-shot
15390 --no-one-shot
15391 Do not record the packages in the world file.
15392 --run-tests
15394 Run package test suites during installation.
15395 -j, --jobs [NUM]
15397 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
15398 given).
15399 --keep-going
15401 After a build failure, continue to build other unaffected
15402 packages.
15403 --offline
15405 --no-offline
15406 Don't download packages from the Internet.
15407 --project-file FILE
15409 Set the name of the cabal.project file to search for in
15410 parent directories
15411 --only
15413 Only installs the package in the current directory.
15414 --haddock-hoogle
15416 Generate a hoogle database
15417 --haddock-html
15419 Generate HTML documentation (the default)
15420 --haddock-html-location URL
15422 Location of HTML documentation for pre-requisite packages
15423 --haddock-for-hackage
15425 Collection of flags to generate documentation suitable
15426 for upload to hackage
15427 --haddock-executables
15429 Run haddock for Executables targets
15430 --haddock-tests
15432 Run haddock for Test Suite targets
15433 --haddock-benchmarks
15435 Run haddock for Benchmark targets
15436 --haddock-all
15438 Run haddock for all targets
15439 --haddock-internal
15441 Run haddock for internal modules and include all symbols
15442 --haddock-css PATH
15444 Use PATH as the haddock stylesheet
15445 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
15447 dock-hyperlinked-source
15448 Hyperlink the documentation to the source code
15449 --haddock-quickjump
15451 Generate an index for interactive documentation naviga‐
15452 tion
15453 --haddock-hscolour-css PATH
15455 Use PATH as the HsColour stylesheet
15456 --haddock-contents-location URL
15458 Bake URL in as the location for the contents page
15459 cabal new-exec
15462 Usage: cabal new-exec [FLAGS] [--] COMMAND [--] [ARGS]
15464 During development it is often useful to run build tasks and perform
15467 one-off program executions to experiment with the behavior of build
15468 tools. It is convenient to run these tools in the same way cabal itself
15469 would. The `cabal new-exec` command provides a way to do so.
15470 Compiler tools will be configured to see the same subset of the store
15472 that builds would see. The PATH is modified to make all executables in
15473 the dependency tree available (provided they have been built already).
15474 Commands are also rewritten in the way cabal itself would. For example,
15475 `cabal new-exec ghc` will consult the configuration to choose an appro‐
15476 priate version of ghc and to include any ghc-specific flags requested.
15477 Flags:
15480 -v, --verbose [n]
15481 Control verbosity (n is 0--3, default verbosity level is
15482 1)
15483 --builddir, --distdir, --distpref DIR
15485 The directory where Cabal puts generated build files
15486 (default dist)
15487 -g, --ghc
15489 compile with GHC
15490 --ghcjs
15492 compile with GHCJS
15493 --uhc
15495 compile with UHC
15496 --haskell-suite
15498 compile with a haskell-suite compiler
15499 --cabal-file PATH
15501 use this Cabal file
15502 -w, --with-compiler PATH
15504 give the path to a particular compiler
15505 --with-hc-pkg PATH
15507 give the path to the package tool
15508 --prefix DIR
15510 bake this prefix in preparation of installation
15511 --bindir DIR
15513 installation directory for executables
15514 --libdir DIR
15516 installation directory for libraries
15517 --libsubdir DIR
15519 subdirectory of libdir in which libs are installed
15520 --dynlibdir DIR
15522 installation directory for dynamic libraries
15523 --libexecdir DIR
15525 installation directory for program executables
15526 --libexecsubdir DIR
15528 subdirectory of libexecdir in which private executables
15529 are installed
15530 --datadir DIR
15532 installation directory for read-only data
15533 --datasubdir DIR
15535 subdirectory of datadir in which data files are installed
15536 --docdir DIR
15538 installation directory for documentation
15539 --htmldir DIR
15541 installation directory for HTML documentation
15542 --haddockdir DIR
15544 installation directory for haddock interfaces
15545 --sysconfdir DIR
15547 installation directory for configuration files
15548 --program-prefix PREFIX
15550 prefix to be applied to installed executables
15551 --program-suffix SUFFIX
15553 suffix to be applied to installed executables
15554 --enable-library-vanilla
15556 --disable-library-vanilla
15557 Vanilla libraries
15558 -p, --enable-library-profiling
15560 --disable-library-profiling
15561 Library profiling
15562 --enable-shared
15564 --disable-shared
15565 Shared library
15566 --enable-static
15568 --disable-static
15569 Static library
15570 --enable-executable-dynamic
15572 --disable-executable-dynamic
15573 Executable dynamic linking
15574 --enable-profiling
15576 --disable-profiling
15577 Executable and library profiling
15578 --enable-executable-profiling
15580 --disable-executable-profiling
15581 Executable profiling (DEPRECATED)
15582 --profiling-detail level
15584 Profiling detail level for executable and library
15585 (default, none, exported-functions, toplevel-functions,
15586 all-functions).
15587 --library-profiling-detail level
15589 Profiling detail level for libraries only.
15590 -O, --enable-optimization, --enable-optimisation [n]
15592 Build with optimization (n is 0--2, default is 1)
15593 --disable-optimization, --disable-optimisation
15595 Build without optimization
15596 --enable-debug-info [n]
15598 Emit debug info (n is 0--3, default is 0)
15599 --disable-debug-info
15601 Don't emit debug info
15602 --enable-library-for-ghci
15604 --disable-library-for-ghci
15605 compile library for use with GHCi
15606 --enable-split-sections
15608 --disable-split-sections
15609 compile library code such that unneeded definitions can
15610 be dropped from the final executable (GHC 7.8+)
15611 --enable-split-objs
15613 --disable-split-objs
15614 split library into smaller objects to reduce binary sizes
15615 (GHC 6.6+)
15616 --enable-executable-stripping
15618 --disable-executable-stripping
15619 strip executables upon installation to reduce binary
15620 sizes
15621 --enable-library-stripping
15623 --disable-library-stripping
15624 strip libraries upon installation to reduce binary sizes
15625 --configure-option OPT
15627 Extra option for configure
15628 --user
15630 --global
15631 doing a per-user installation
15632 --package-db DB
15634 Append the given package database to the list of package
15635 databases used (to satisfy dependencies and register
15636 into). May be a specific file, 'global' or 'user'. The
15637 initial list is ['global'], ['global', 'user'], or
15638 ['global', $sandbox], depending on context. Use 'clear'
15639 to reset the list to empty. See the user guide for
15640 details.
15641 -f, --flags FLAGS
15643 Force values for the given flags in Cabal conditionals in
15644 the .cabal file. E.g., --flags="debug -usebytestrings"
15645 forces the flag "debug" to true and "usebytestrings" to
15646 false.
15647 --extra-include-dirs PATH
15649 A list of directories to search for header files
15650 --enable-deterministic
15652 --disable-deterministic
15653 Try to be as deterministic as possible (used by the test
15654 suite)
15655 --ipid IPID
15657 Installed package ID to compile this package as
15658 --cid CID
15660 Installed component ID to compile this component as
15661 --extra-lib-dirs PATH
15663 A list of directories to search for external libraries
15664 --extra-framework-dirs PATH
15666 A list of directories to search for external frameworks
15667 (OS X only)
15668 --extra-prog-path PATH
15670 A list of directories to search for required programs (in
15671 addition to the normal search locations)
15672 --instantiate-with NAME=MOD
15674 A mapping of signature names to concrete module instanti‐
15675 ations.
15676 --enable-tests
15678 --disable-tests
15679 dependency checking and compilation for test suites
15680 listed in the package description file.
15681 --enable-coverage
15683 --disable-coverage
15684 build package with Haskell Program Coverage. (GHC only)
15685 --enable-library-coverage
15687 --disable-library-coverage
15688 build package with Haskell Program Coverage. (GHC only)
15689 (DEPRECATED)
15690 --enable-benchmarks
15692 --disable-benchmarks
15693 dependency checking and compilation for benchmarks listed
15694 in the package description file.
15695 --enable-relocatable
15697 --disable-relocatable
15698 building a package that is relocatable. (GHC only)
15699 --disable-response-files
15701 enable workaround for old versions of programs like "ar"
15702 that do not support @file arguments
15703 --with-alex PATH
15705 give the path to alex
15706 --with-ar PATH
15708 give the path to ar
15709 --with-c2hs PATH
15711 give the path to c2hs
15712 --with-cpphs PATH
15714 give the path to cpphs
15715 --with-doctest PATH
15717 give the path to doctest
15718 --with-gcc PATH
15720 give the path to gcc
15721 --with-ghc PATH
15723 give the path to ghc
15724 --with-ghc-pkg PATH
15726 give the path to ghc-pkg
15727 --with-ghcjs PATH
15729 give the path to ghcjs
15730 --with-ghcjs-pkg PATH
15732 give the path to ghcjs-pkg
15733 --with-greencard PATH
15735 give the path to greencard
15736 --with-haddock PATH
15738 give the path to haddock
15739 --with-happy PATH
15741 give the path to happy
15742 --with-haskell-suite PATH
15744 give the path to haskell-suite
15745 --with-haskell-suite-pkg PATH
15747 give the path to haskell-suite-pkg
15748 --with-hmake PATH
15750 give the path to hmake
15751 --with-hpc PATH
15753 give the path to hpc
15754 --with-hsc2hs PATH
15756 give the path to hsc2hs
15757 --with-hscolour PATH
15759 give the path to hscolour
15760 --with-jhc PATH
15762 give the path to jhc
15763 --with-ld PATH
15765 give the path to ld
15766 --with-pkg-config PATH
15768 give the path to pkg-config
15769 --with-runghc PATH
15771 give the path to runghc
15772 --with-strip PATH
15774 give the path to strip
15775 --with-tar PATH
15777 give the path to tar
15778 --with-uhc PATH
15780 give the path to uhc
15781 --alex-option OPT
15783 give an extra option to alex (no need to quote options
15784 containing spaces)
15785 --ar-option OPT
15787 give an extra option to ar (no need to quote options con‐
15788 taining spaces)
15789 --c2hs-option OPT
15791 give an extra option to c2hs (no need to quote options
15792 containing spaces)
15793 --cpphs-option OPT
15795 give an extra option to cpphs (no need to quote options
15796 containing spaces)
15797 --doctest-option OPT
15799 give an extra option to doctest (no need to quote options
15800 containing spaces)
15801 --gcc-option OPT
15803 give an extra option to gcc (no need to quote options
15804 containing spaces)
15805 --ghc-option OPT
15807 give an extra option to ghc (no need to quote options
15808 containing spaces)
15809 --ghc-pkg-option OPT
15811 give an extra option to ghc-pkg (no need to quote options
15812 containing spaces)
15813 --ghcjs-option OPT
15815 give an extra option to ghcjs (no need to quote options
15816 containing spaces)
15817 --ghcjs-pkg-option OPT
15819 give an extra option to ghcjs-pkg (no need to quote
15820 options containing spaces)
15821 --greencard-option OPT
15823 give an extra option to greencard (no need to quote
15824 options containing spaces)
15825 --haddock-option OPT
15827 give an extra option to haddock (no need to quote options
15828 containing spaces)
15829 --happy-option OPT
15831 give an extra option to happy (no need to quote options
15832 containing spaces)
15833 --haskell-suite-option OPT
15835 give an extra option to haskell-suite (no need to quote
15836 options containing spaces)
15837 --haskell-suite-pkg-option OPT
15839 give an extra option to haskell-suite-pkg (no need to
15840 quote options containing spaces)
15841 --hmake-option OPT
15843 give an extra option to hmake (no need to quote options
15844 containing spaces)
15845 --hpc-option OPT
15847 give an extra option to hpc (no need to quote options
15848 containing spaces)
15849 --hsc2hs-option OPT
15851 give an extra option to hsc2hs (no need to quote options
15852 containing spaces)
15853 --hscolour-option OPT
15855 give an extra option to hscolour (no need to quote
15856 options containing spaces)
15857 --jhc-option OPT
15859 give an extra option to jhc (no need to quote options
15860 containing spaces)
15861 --ld-option OPT
15863 give an extra option to ld (no need to quote options con‐
15864 taining spaces)
15865 --pkg-config-option OPT
15867 give an extra option to pkg-config (no need to quote
15868 options containing spaces)
15869 --runghc-option OPT
15871 give an extra option to runghc (no need to quote options
15872 containing spaces)
15873 --strip-option OPT
15875 give an extra option to strip (no need to quote options
15876 containing spaces)
15877 --tar-option OPT
15879 give an extra option to tar (no need to quote options
15880 containing spaces)
15881 --uhc-option OPT
15883 give an extra option to uhc (no need to quote options
15884 containing spaces)
15885 --alex-options OPTS
15887 give extra options to alex
15888 --ar-options OPTS
15890 give extra options to ar
15891 --c2hs-options OPTS
15893 give extra options to c2hs
15894 --cpphs-options OPTS
15896 give extra options to cpphs
15897 --doctest-options OPTS
15899 give extra options to doctest
15900 --gcc-options OPTS
15902 give extra options to gcc
15903 --ghc-options OPTS
15905 give extra options to ghc
15906 --ghc-pkg-options OPTS
15908 give extra options to ghc-pkg
15909 --ghcjs-options OPTS
15911 give extra options to ghcjs
15912 --ghcjs-pkg-options OPTS
15914 give extra options to ghcjs-pkg
15915 --greencard-options OPTS
15917 give extra options to greencard
15918 --haddock-options OPTS
15920 give extra options to haddock
15921 --happy-options OPTS
15923 give extra options to happy
15924 --haskell-suite-options OPTS
15926 give extra options to haskell-suite
15927 --haskell-suite-pkg-options OPTS
15929 give extra options to haskell-suite-pkg
15930 --hmake-options OPTS
15932 give extra options to hmake
15933 --hpc-options OPTS
15935 give extra options to hpc
15936 --hsc2hs-options OPTS
15938 give extra options to hsc2hs
15939 --hscolour-options OPTS
15941 give extra options to hscolour
15942 --jhc-options OPTS
15944 give extra options to jhc
15945 --ld-options OPTS
15947 give extra options to ld
15948 --pkg-config-options OPTS
15950 give extra options to pkg-config
15951 --runghc-options OPTS
15953 give extra options to runghc
15954 --strip-options OPTS
15956 give extra options to strip
15957 --tar-options OPTS
15959 give extra options to tar
15960 --uhc-options OPTS
15962 give extra options to uhc
15963 --cabal-lib-version VERSION
15965 Select which version of the Cabal lib to use to build
15966 packages (useful for testing).
15967 --constraint CONSTRAINT
15969 Specify constraints on a package (version,
15970 installed/source, flags)
15971 --preference CONSTRAINT
15973 Specify preferences (soft constraints) on the version of
15974 a package
15975 --solver SOLVER
15977 Select dependency solver to use (default: modular).
15978 Choices: modular.
15979 --allow-older [DEPS]
15981 Ignore lower bounds in all dependencies or DEPS
15982 --allow-newer [DEPS]
15984 Ignore upper bounds in all dependencies or DEPS
15985 --enable-documentation
15987 --disable-documentation
15988 building of documentation
15989 --doc-index-file TEMPLATE
15991 A central index of haddock API documentation (template
15992 cannot use $pkgid)
15993 --dry-run
15995 Do not install anything, only print what would be
15996 installed.
15997 --max-backjumps NUM
15999 Maximum number of backjumps allowed while solving
16000 (default: 2000). Use a negative number to enable unlim‐
16001 ited backtracking. Use 0 to disable backtracking com‐
16002 pletely.
16003 --reorder-goals
16005 --no-reorder-goals
16006 Try to reorder goals according to certain heuristics.
16007 Slows things down on average, but may make backtracking
16008 faster for some packages.
16009 --count-conflicts
16011 --no-count-conflicts
16012 Try to speed up solving by preferring goals that are
16013 involved in a lot of conflicts (default).
16014 --independent-goals
16016 --no-independent-goals
16017 Treat several goals on the command line as independent.
16018 If several goals depend on the same package, different
16019 versions can be chosen.
16020 --shadow-installed-packages
16022 --no-shadow-installed-packages
16023 If multiple package instances of the same version are
16024 installed, treat all but one as shadowed.
16025 --strong-flags
16027 --no-strong-flags
16028 Do not defer flag choices (this used to be the default in
16029 cabal-install <= 1.20).
16030 --allow-boot-library-installs
16032 --no-allow-boot-library-installs
16033 Allow cabal to install base, ghc-prim, integer-simple,
16034 integer-gmp, and template-haskell.
16035 --reinstall
16037 --no-reinstall
16038 Install even if it means installing the same version
16039 again.
16040 --avoid-reinstalls
16042 --no-avoid-reinstalls
16043 Do not select versions that would destructively overwrite
16044 installed packages.
16045 --force-reinstalls
16047 --no-force-reinstalls
16048 Reinstall packages even if they will most likely break
16049 other installed packages.
16050 --upgrade-dependencies
16052 --no-upgrade-dependencies
16053 Pick the latest version for all dependencies, rather than
16054 trying to pick an installed version.
16055 --only-dependencies
16057 --no-only-dependencies
16058 Install only the dependencies necessary to build the
16059 given packages
16060 --dependencies-only
16062 --no-dependencies-only
16063 A synonym for --only-dependencies
16064 --index-state STATE
16066 Use source package index state as it existed at a previ‐
16067 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
16068 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
16069 'HEAD' (default: 'HEAD').
16070 --root-cmd COMMAND
16072 (No longer supported, do not use.)
16073 --symlink-bindir DIR
16075 Add symlinks to installed executables into this direc‐
16076 tory.
16077 --build-summary TEMPLATE
16079 Save build summaries to file (name template can use
16080 $pkgid, $compiler, $os, $arch)
16081 --build-log TEMPLATE
16083 Log all builds to file (name template can use $pkgid,
16084 $compiler, $os, $arch)
16085 --remote-build-reporting LEVEL
16087 Generate build reports to send to a remote server (none,
16088 anonymous or detailed).
16089 --report-planning-failure
16091 Generate build reports when the dependency solver fails.
16092 This is used by the Hackage build bot.
16093 --enable-per-component
16095 --disable-per-component
16096 Per-component builds when possible
16097 --one-shot
16099 --no-one-shot
16100 Do not record the packages in the world file.
16101 --run-tests
16103 Run package test suites during installation.
16104 -j, --jobs [NUM]
16106 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
16107 given).
16108 --keep-going
16110 After a build failure, continue to build other unaffected
16111 packages.
16112 --offline
16114 --no-offline
16115 Don't download packages from the Internet.
16116 --project-file FILE
16118 Set the name of the cabal.project file to search for in
16119 parent directories
16120 --only
16122 Only installs the package in the current directory.
16123 --haddock-hoogle
16125 Generate a hoogle database
16126 --haddock-html
16128 Generate HTML documentation (the default)
16129 --haddock-html-location URL
16131 Location of HTML documentation for pre-requisite packages
16132 --haddock-for-hackage
16134 Collection of flags to generate documentation suitable
16135 for upload to hackage
16136 --haddock-executables
16138 Run haddock for Executables targets
16139 --haddock-tests
16141 Run haddock for Test Suite targets
16142 --haddock-benchmarks
16144 Run haddock for Benchmark targets
16145 --haddock-all
16147 Run haddock for all targets
16148 --haddock-internal
16150 Run haddock for internal modules and include all symbols
16151 --haddock-css PATH
16153 Use PATH as the haddock stylesheet
16154 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
16156 dock-hyperlinked-source
16157 Hyperlink the documentation to the source code
16158 --haddock-quickjump
16160 Generate an index for interactive documentation naviga‐
16161 tion
16162 --haddock-hscolour-css PATH
16164 Use PATH as the HsColour stylesheet
16165 --haddock-contents-location URL
16167 Bake URL in as the location for the contents page
16168 cabal v2-clean
16171 Usage: cabal v2-clean [FLAGS]
16173 Removes all temporary files created during the building process (.hi,
16176 .o, preprocessed sources, etc.) and also empties out the local caches
16177 (by default).
16178 Removes all temporary files created during the building process (.hi,
16182 .o, preprocessed sources, etc.) and also empties out the local caches
16183 (by default).
16184 Flags:
16188 -v, --verbose [n]
16189 Control verbosity (n is 0--3, default verbosity level is
16190 1)
16191 --builddir, --distdir, --distpref DIR
16193 The directory where Cabal puts generated build files
16194 (default dist)
16195 --project-file FILE
16197 Set the name of the cabal.project file to search for in
16198 parent directories
16199 -s, --save-config
16201 Save configuration, only remove build artifacts
16202 cabal new-clean
16205 Usage: cabal new-clean [FLAGS]
16207 Removes all temporary files created during the building process (.hi,
16210 .o, preprocessed sources, etc.) and also empties out the local caches
16211 (by default).
16212 Flags:
16216 -v, --verbose [n]
16217 Control verbosity (n is 0--3, default verbosity level is
16218 1)
16219 --builddir, --distdir, --distpref DIR
16221 The directory where Cabal puts generated build files
16222 (default dist)
16223 --project-file FILE
16225 Set the name of the cabal.project file to search for in
16226 parent directories
16227 -s, --save-config
16229 Save configuration, only remove build artifacts
16230 cabal v2-sdist
16233 Usage: cabal v2-sdist [FLAGS] [PACKAGES]
16235 Generates tarballs of project packages suitable for upload to Hackage.
16238 Generates tarballs of project packages suitable for upload to Hackage.
16240 Flags:
16242 -v, --verbose [n]
16243 Control verbosity (n is 0--3, default verbosity level is
16244 1)
16245 --builddir, --distdir, --distpref DIR
16247 The directory where Cabal puts generated build files
16248 (default dist)
16249 --project-file FILE
16251 Set the name of the cabal.project file to search for in
16252 parent directories
16253 -l, --list-only
16255 Just list the sources, do not make a tarball
16256 -z, --null-sep
16258 Separate the source files with NUL bytes rather than new‐
16259 lines.
16260 --targz
16262 Produce a '.tar.gz' format archive (default and required
16263 for uploading to hackage)
16264 --zip
16266 Produce a '.zip' format archive
16267 -o, --output-dir, --outputdir PATH
16269 Choose the output directory of this command. '-' sends
16270 all output to stdout
16271 cabal new-sdist
16274 Usage: cabal new-sdist [FLAGS] [PACKAGES]
16276 Generates tarballs of project packages suitable for upload to Hackage.
16279 Flags:
16281 -v, --verbose [n]
16282 Control verbosity (n is 0--3, default verbosity level is
16283 1)
16284 --builddir, --distdir, --distpref DIR
16286 The directory where Cabal puts generated build files
16287 (default dist)
16288 --project-file FILE
16290 Set the name of the cabal.project file to search for in
16291 parent directories
16292 -l, --list-only
16294 Just list the sources, do not make a tarball
16295 -z, --null-sep
16297 Separate the source files with NUL bytes rather than new‐
16298 lines.
16299 --targz
16301 Produce a '.tar.gz' format archive (default and required
16302 for uploading to hackage)
16303 --zip
16305 Produce a '.zip' format archive
16306 -o, --output-dir, --outputdir PATH
16308 Choose the output directory of this command. '-' sends
16309 all output to stdout
16310 cabal configure
16313 Usage: cabal configure [FLAGS]
16315 Configure how the package is built by setting package (and other)
16318 flags.
16319 The configuration affects several other commands, including build,
16321 test, bench, run, repl.
16322 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
16325 ing programs:
16326 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
16327 haddock
16328 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
16329 ld
16330 pkg-config runghc strip tar uhc
16331 Examples:
16333 cabal configure
16334 Configure with defaults;
16335 cabal configure --enable-tests -fcustomflag
16336 Configure building package including tests,
16337 with some package-specific flag.
16338 The configure command is a part of the legacy v1 style of cabal usage.
16340 Please switch to using either the new project style and the new-config‐
16342 ure command or the legacy v1-configure alias as new-style projects will
16343 become the default in the next version of cabal-install. Please file a
16344 bug if you cannot replicate a working v1- use case with the new-style
16345 commands.
16346 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
16348 Flags:
16351 -v, --verbose [n]
16352 Control verbosity (n is 0--3, default verbosity level is
16353 1)
16354 --builddir, --distdir, --distpref DIR
16356 The directory where Cabal puts generated build files
16357 (default dist)
16358 -g, --ghc
16360 compile with GHC
16361 --ghcjs
16363 compile with GHCJS
16364 --uhc
16366 compile with UHC
16367 --haskell-suite
16369 compile with a haskell-suite compiler
16370 --cabal-file PATH
16372 use this Cabal file
16373 -w, --with-compiler PATH
16375 give the path to a particular compiler
16376 --with-hc-pkg PATH
16378 give the path to the package tool
16379 --prefix DIR
16381 bake this prefix in preparation of installation
16382 --bindir DIR
16384 installation directory for executables
16385 --libdir DIR
16387 installation directory for libraries
16388 --libsubdir DIR
16390 subdirectory of libdir in which libs are installed
16391 --dynlibdir DIR
16393 installation directory for dynamic libraries
16394 --libexecdir DIR
16396 installation directory for program executables
16397 --libexecsubdir DIR
16399 subdirectory of libexecdir in which private executables
16400 are installed
16401 --datadir DIR
16403 installation directory for read-only data
16404 --datasubdir DIR
16406 subdirectory of datadir in which data files are installed
16407 --docdir DIR
16409 installation directory for documentation
16410 --htmldir DIR
16412 installation directory for HTML documentation
16413 --haddockdir DIR
16415 installation directory for haddock interfaces
16416 --sysconfdir DIR
16418 installation directory for configuration files
16419 --program-prefix PREFIX
16421 prefix to be applied to installed executables
16422 --program-suffix SUFFIX
16424 suffix to be applied to installed executables
16425 --enable-library-vanilla
16427 --disable-library-vanilla
16428 Vanilla libraries
16429 -p, --enable-library-profiling
16431 --disable-library-profiling
16432 Library profiling
16433 --enable-shared
16435 --disable-shared
16436 Shared library
16437 --enable-static
16439 --disable-static
16440 Static library
16441 --enable-executable-dynamic
16443 --disable-executable-dynamic
16444 Executable dynamic linking
16445 --enable-profiling
16447 --disable-profiling
16448 Executable and library profiling
16449 --enable-executable-profiling
16451 --disable-executable-profiling
16452 Executable profiling (DEPRECATED)
16453 --profiling-detail level
16455 Profiling detail level for executable and library
16456 (default, none, exported-functions, toplevel-functions,
16457 all-functions).
16458 --library-profiling-detail level
16460 Profiling detail level for libraries only.
16461 -O, --enable-optimization, --enable-optimisation [n]
16463 Build with optimization (n is 0--2, default is 1)
16464 --disable-optimization, --disable-optimisation
16466 Build without optimization
16467 --enable-debug-info [n]
16469 Emit debug info (n is 0--3, default is 0)
16470 --disable-debug-info
16472 Don't emit debug info
16473 --enable-library-for-ghci
16475 --disable-library-for-ghci
16476 compile library for use with GHCi
16477 --enable-split-sections
16479 --disable-split-sections
16480 compile library code such that unneeded definitions can
16481 be dropped from the final executable (GHC 7.8+)
16482 --enable-split-objs
16484 --disable-split-objs
16485 split library into smaller objects to reduce binary sizes
16486 (GHC 6.6+)
16487 --enable-executable-stripping
16489 --disable-executable-stripping
16490 strip executables upon installation to reduce binary
16491 sizes
16492 --enable-library-stripping
16494 --disable-library-stripping
16495 strip libraries upon installation to reduce binary sizes
16496 --configure-option OPT
16498 Extra option for configure
16499 --user
16501 --global
16502 doing a per-user installation
16503 --package-db DB
16505 Append the given package database to the list of package
16506 databases used (to satisfy dependencies and register
16507 into). May be a specific file, 'global' or 'user'. The
16508 initial list is ['global'], ['global', 'user'], or
16509 ['global', $sandbox], depending on context. Use 'clear'
16510 to reset the list to empty. See the user guide for
16511 details.
16512 -f, --flags FLAGS
16514 Force values for the given flags in Cabal conditionals in
16515 the .cabal file. E.g., --flags="debug -usebytestrings"
16516 forces the flag "debug" to true and "usebytestrings" to
16517 false.
16518 --extra-include-dirs PATH
16520 A list of directories to search for header files
16521 --enable-deterministic
16523 --disable-deterministic
16524 Try to be as deterministic as possible (used by the test
16525 suite)
16526 --ipid IPID
16528 Installed package ID to compile this package as
16529 --cid CID
16531 Installed component ID to compile this component as
16532 --extra-lib-dirs PATH
16534 A list of directories to search for external libraries
16535 --extra-framework-dirs PATH
16537 A list of directories to search for external frameworks
16538 (OS X only)
16539 --extra-prog-path PATH
16541 A list of directories to search for required programs (in
16542 addition to the normal search locations)
16543 --instantiate-with NAME=MOD
16545 A mapping of signature names to concrete module instanti‐
16546 ations.
16547 --enable-tests
16549 --disable-tests
16550 dependency checking and compilation for test suites
16551 listed in the package description file.
16552 --enable-coverage
16554 --disable-coverage
16555 build package with Haskell Program Coverage. (GHC only)
16556 --enable-library-coverage
16558 --disable-library-coverage
16559 build package with Haskell Program Coverage. (GHC only)
16560 (DEPRECATED)
16561 --enable-benchmarks
16563 --disable-benchmarks
16564 dependency checking and compilation for benchmarks listed
16565 in the package description file.
16566 --enable-relocatable
16568 --disable-relocatable
16569 building a package that is relocatable. (GHC only)
16570 --disable-response-files
16572 enable workaround for old versions of programs like "ar"
16573 that do not support @file arguments
16574 --with-alex PATH
16576 give the path to alex
16577 --with-ar PATH
16579 give the path to ar
16580 --with-c2hs PATH
16582 give the path to c2hs
16583 --with-cpphs PATH
16585 give the path to cpphs
16586 --with-doctest PATH
16588 give the path to doctest
16589 --with-gcc PATH
16591 give the path to gcc
16592 --with-ghc PATH
16594 give the path to ghc
16595 --with-ghc-pkg PATH
16597 give the path to ghc-pkg
16598 --with-ghcjs PATH
16600 give the path to ghcjs
16601 --with-ghcjs-pkg PATH
16603 give the path to ghcjs-pkg
16604 --with-greencard PATH
16606 give the path to greencard
16607 --with-haddock PATH
16609 give the path to haddock
16610 --with-happy PATH
16612 give the path to happy
16613 --with-haskell-suite PATH
16615 give the path to haskell-suite
16616 --with-haskell-suite-pkg PATH
16618 give the path to haskell-suite-pkg
16619 --with-hmake PATH
16621 give the path to hmake
16622 --with-hpc PATH
16624 give the path to hpc
16625 --with-hsc2hs PATH
16627 give the path to hsc2hs
16628 --with-hscolour PATH
16630 give the path to hscolour
16631 --with-jhc PATH
16633 give the path to jhc
16634 --with-ld PATH
16636 give the path to ld
16637 --with-pkg-config PATH
16639 give the path to pkg-config
16640 --with-runghc PATH
16642 give the path to runghc
16643 --with-strip PATH
16645 give the path to strip
16646 --with-tar PATH
16648 give the path to tar
16649 --with-uhc PATH
16651 give the path to uhc
16652 --alex-option OPT
16654 give an extra option to alex (no need to quote options
16655 containing spaces)
16656 --ar-option OPT
16658 give an extra option to ar (no need to quote options con‐
16659 taining spaces)
16660 --c2hs-option OPT
16662 give an extra option to c2hs (no need to quote options
16663 containing spaces)
16664 --cpphs-option OPT
16666 give an extra option to cpphs (no need to quote options
16667 containing spaces)
16668 --doctest-option OPT
16670 give an extra option to doctest (no need to quote options
16671 containing spaces)
16672 --gcc-option OPT
16674 give an extra option to gcc (no need to quote options
16675 containing spaces)
16676 --ghc-option OPT
16678 give an extra option to ghc (no need to quote options
16679 containing spaces)
16680 --ghc-pkg-option OPT
16682 give an extra option to ghc-pkg (no need to quote options
16683 containing spaces)
16684 --ghcjs-option OPT
16686 give an extra option to ghcjs (no need to quote options
16687 containing spaces)
16688 --ghcjs-pkg-option OPT
16690 give an extra option to ghcjs-pkg (no need to quote
16691 options containing spaces)
16692 --greencard-option OPT
16694 give an extra option to greencard (no need to quote
16695 options containing spaces)
16696 --haddock-option OPT
16698 give an extra option to haddock (no need to quote options
16699 containing spaces)
16700 --happy-option OPT
16702 give an extra option to happy (no need to quote options
16703 containing spaces)
16704 --haskell-suite-option OPT
16706 give an extra option to haskell-suite (no need to quote
16707 options containing spaces)
16708 --haskell-suite-pkg-option OPT
16710 give an extra option to haskell-suite-pkg (no need to
16711 quote options containing spaces)
16712 --hmake-option OPT
16714 give an extra option to hmake (no need to quote options
16715 containing spaces)
16716 --hpc-option OPT
16718 give an extra option to hpc (no need to quote options
16719 containing spaces)
16720 --hsc2hs-option OPT
16722 give an extra option to hsc2hs (no need to quote options
16723 containing spaces)
16724 --hscolour-option OPT
16726 give an extra option to hscolour (no need to quote
16727 options containing spaces)
16728 --jhc-option OPT
16730 give an extra option to jhc (no need to quote options
16731 containing spaces)
16732 --ld-option OPT
16734 give an extra option to ld (no need to quote options con‐
16735 taining spaces)
16736 --pkg-config-option OPT
16738 give an extra option to pkg-config (no need to quote
16739 options containing spaces)
16740 --runghc-option OPT
16742 give an extra option to runghc (no need to quote options
16743 containing spaces)
16744 --strip-option OPT
16746 give an extra option to strip (no need to quote options
16747 containing spaces)
16748 --tar-option OPT
16750 give an extra option to tar (no need to quote options
16751 containing spaces)
16752 --uhc-option OPT
16754 give an extra option to uhc (no need to quote options
16755 containing spaces)
16756 --alex-options OPTS
16758 give extra options to alex
16759 --ar-options OPTS
16761 give extra options to ar
16762 --c2hs-options OPTS
16764 give extra options to c2hs
16765 --cpphs-options OPTS
16767 give extra options to cpphs
16768 --doctest-options OPTS
16770 give extra options to doctest
16771 --gcc-options OPTS
16773 give extra options to gcc
16774 --ghc-options OPTS
16776 give extra options to ghc
16777 --ghc-pkg-options OPTS
16779 give extra options to ghc-pkg
16780 --ghcjs-options OPTS
16782 give extra options to ghcjs
16783 --ghcjs-pkg-options OPTS
16785 give extra options to ghcjs-pkg
16786 --greencard-options OPTS
16788 give extra options to greencard
16789 --haddock-options OPTS
16791 give extra options to haddock
16792 --happy-options OPTS
16794 give extra options to happy
16795 --haskell-suite-options OPTS
16797 give extra options to haskell-suite
16798 --haskell-suite-pkg-options OPTS
16800 give extra options to haskell-suite-pkg
16801 --hmake-options OPTS
16803 give extra options to hmake
16804 --hpc-options OPTS
16806 give extra options to hpc
16807 --hsc2hs-options OPTS
16809 give extra options to hsc2hs
16810 --hscolour-options OPTS
16812 give extra options to hscolour
16813 --jhc-options OPTS
16815 give extra options to jhc
16816 --ld-options OPTS
16818 give extra options to ld
16819 --pkg-config-options OPTS
16821 give extra options to pkg-config
16822 --runghc-options OPTS
16824 give extra options to runghc
16825 --strip-options OPTS
16827 give extra options to strip
16828 --tar-options OPTS
16830 give extra options to tar
16831 --uhc-options OPTS
16833 give extra options to uhc
16834 --cabal-lib-version VERSION
16836 Select which version of the Cabal lib to use to build
16837 packages (useful for testing).
16838 --constraint CONSTRAINT
16840 Specify constraints on a package (version,
16841 installed/source, flags)
16842 --preference CONSTRAINT
16844 Specify preferences (soft constraints) on the version of
16845 a package
16846 --solver SOLVER
16848 Select dependency solver to use (default: modular).
16849 Choices: modular.
16850 --allow-older [DEPS]
16852 Ignore lower bounds in all dependencies or DEPS
16853 --allow-newer [DEPS]
16855 Ignore upper bounds in all dependencies or DEPS
16856 cabal v1-configure
16859 Usage: cabal v1-configure [FLAGS]
16861 Configure how the package is built by setting package (and other)
16864 flags.
16865 The configuration affects several other commands, including v1-build,
16867 v1-test, v1-bench, v1-run, v1-repl.
16868 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
16871 ing programs:
16872 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
16873 haddock
16874 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
16875 ld
16876 pkg-config runghc strip tar uhc
16877 Examples:
16879 cabal v1-configure
16880 Configure with defaults;
16881 cabal v1-configure --enable-tests -fcustomflag
16882 Configure building package including tests,
16883 with some package-specific flag.
16884 The v1-configure command is a part of the legacy v1 style of cabal
16886 usage.
16887 It is a legacy feature and will be removed in a future release of
16889 cabal-install. Please file a bug if you cannot replicate a working v1-
16890 use case with the new-style commands.
16891 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
16893 Flags:
16896 -v, --verbose [n]
16897 Control verbosity (n is 0--3, default verbosity level is
16898 1)
16899 --builddir, --distdir, --distpref DIR
16901 The directory where Cabal puts generated build files
16902 (default dist)
16903 -g, --ghc
16905 compile with GHC
16906 --ghcjs
16908 compile with GHCJS
16909 --uhc
16911 compile with UHC
16912 --haskell-suite
16914 compile with a haskell-suite compiler
16915 --cabal-file PATH
16917 use this Cabal file
16918 -w, --with-compiler PATH
16920 give the path to a particular compiler
16921 --with-hc-pkg PATH
16923 give the path to the package tool
16924 --prefix DIR
16926 bake this prefix in preparation of installation
16927 --bindir DIR
16929 installation directory for executables
16930 --libdir DIR
16932 installation directory for libraries
16933 --libsubdir DIR
16935 subdirectory of libdir in which libs are installed
16936 --dynlibdir DIR
16938 installation directory for dynamic libraries
16939 --libexecdir DIR
16941 installation directory for program executables
16942 --libexecsubdir DIR
16944 subdirectory of libexecdir in which private executables
16945 are installed
16946 --datadir DIR
16948 installation directory for read-only data
16949 --datasubdir DIR
16951 subdirectory of datadir in which data files are installed
16952 --docdir DIR
16954 installation directory for documentation
16955 --htmldir DIR
16957 installation directory for HTML documentation
16958 --haddockdir DIR
16960 installation directory for haddock interfaces
16961 --sysconfdir DIR
16963 installation directory for configuration files
16964 --program-prefix PREFIX
16966 prefix to be applied to installed executables
16967 --program-suffix SUFFIX
16969 suffix to be applied to installed executables
16970 --enable-library-vanilla
16972 --disable-library-vanilla
16973 Vanilla libraries
16974 -p, --enable-library-profiling
16976 --disable-library-profiling
16977 Library profiling
16978 --enable-shared
16980 --disable-shared
16981 Shared library
16982 --enable-static
16984 --disable-static
16985 Static library
16986 --enable-executable-dynamic
16988 --disable-executable-dynamic
16989 Executable dynamic linking
16990 --enable-profiling
16992 --disable-profiling
16993 Executable and library profiling
16994 --enable-executable-profiling
16996 --disable-executable-profiling
16997 Executable profiling (DEPRECATED)
16998 --profiling-detail level
17000 Profiling detail level for executable and library
17001 (default, none, exported-functions, toplevel-functions,
17002 all-functions).
17003 --library-profiling-detail level
17005 Profiling detail level for libraries only.
17006 -O, --enable-optimization, --enable-optimisation [n]
17008 Build with optimization (n is 0--2, default is 1)
17009 --disable-optimization, --disable-optimisation
17011 Build without optimization
17012 --enable-debug-info [n]
17014 Emit debug info (n is 0--3, default is 0)
17015 --disable-debug-info
17017 Don't emit debug info
17018 --enable-library-for-ghci
17020 --disable-library-for-ghci
17021 compile library for use with GHCi
17022 --enable-split-sections
17024 --disable-split-sections
17025 compile library code such that unneeded definitions can
17026 be dropped from the final executable (GHC 7.8+)
17027 --enable-split-objs
17029 --disable-split-objs
17030 split library into smaller objects to reduce binary sizes
17031 (GHC 6.6+)
17032 --enable-executable-stripping
17034 --disable-executable-stripping
17035 strip executables upon installation to reduce binary
17036 sizes
17037 --enable-library-stripping
17039 --disable-library-stripping
17040 strip libraries upon installation to reduce binary sizes
17041 --configure-option OPT
17043 Extra option for configure
17044 --user
17046 --global
17047 doing a per-user installation
17048 --package-db DB
17050 Append the given package database to the list of package
17051 databases used (to satisfy dependencies and register
17052 into). May be a specific file, 'global' or 'user'. The
17053 initial list is ['global'], ['global', 'user'], or
17054 ['global', $sandbox], depending on context. Use 'clear'
17055 to reset the list to empty. See the user guide for
17056 details.
17057 -f, --flags FLAGS
17059 Force values for the given flags in Cabal conditionals in
17060 the .cabal file. E.g., --flags="debug -usebytestrings"
17061 forces the flag "debug" to true and "usebytestrings" to
17062 false.
17063 --extra-include-dirs PATH
17065 A list of directories to search for header files
17066 --enable-deterministic
17068 --disable-deterministic
17069 Try to be as deterministic as possible (used by the test
17070 suite)
17071 --ipid IPID
17073 Installed package ID to compile this package as
17074 --cid CID
17076 Installed component ID to compile this component as
17077 --extra-lib-dirs PATH
17079 A list of directories to search for external libraries
17080 --extra-framework-dirs PATH
17082 A list of directories to search for external frameworks
17083 (OS X only)
17084 --extra-prog-path PATH
17086 A list of directories to search for required programs (in
17087 addition to the normal search locations)
17088 --instantiate-with NAME=MOD
17090 A mapping of signature names to concrete module instanti‐
17091 ations.
17092 --enable-tests
17094 --disable-tests
17095 dependency checking and compilation for test suites
17096 listed in the package description file.
17097 --enable-coverage
17099 --disable-coverage
17100 build package with Haskell Program Coverage. (GHC only)
17101 --enable-library-coverage
17103 --disable-library-coverage
17104 build package with Haskell Program Coverage. (GHC only)
17105 (DEPRECATED)
17106 --enable-benchmarks
17108 --disable-benchmarks
17109 dependency checking and compilation for benchmarks listed
17110 in the package description file.
17111 --enable-relocatable
17113 --disable-relocatable
17114 building a package that is relocatable. (GHC only)
17115 --disable-response-files
17117 enable workaround for old versions of programs like "ar"
17118 that do not support @file arguments
17119 --with-alex PATH
17121 give the path to alex
17122 --with-ar PATH
17124 give the path to ar
17125 --with-c2hs PATH
17127 give the path to c2hs
17128 --with-cpphs PATH
17130 give the path to cpphs
17131 --with-doctest PATH
17133 give the path to doctest
17134 --with-gcc PATH
17136 give the path to gcc
17137 --with-ghc PATH
17139 give the path to ghc
17140 --with-ghc-pkg PATH
17142 give the path to ghc-pkg
17143 --with-ghcjs PATH
17145 give the path to ghcjs
17146 --with-ghcjs-pkg PATH
17148 give the path to ghcjs-pkg
17149 --with-greencard PATH
17151 give the path to greencard
17152 --with-haddock PATH
17154 give the path to haddock
17155 --with-happy PATH
17157 give the path to happy
17158 --with-haskell-suite PATH
17160 give the path to haskell-suite
17161 --with-haskell-suite-pkg PATH
17163 give the path to haskell-suite-pkg
17164 --with-hmake PATH
17166 give the path to hmake
17167 --with-hpc PATH
17169 give the path to hpc
17170 --with-hsc2hs PATH
17172 give the path to hsc2hs
17173 --with-hscolour PATH
17175 give the path to hscolour
17176 --with-jhc PATH
17178 give the path to jhc
17179 --with-ld PATH
17181 give the path to ld
17182 --with-pkg-config PATH
17184 give the path to pkg-config
17185 --with-runghc PATH
17187 give the path to runghc
17188 --with-strip PATH
17190 give the path to strip
17191 --with-tar PATH
17193 give the path to tar
17194 --with-uhc PATH
17196 give the path to uhc
17197 --alex-option OPT
17199 give an extra option to alex (no need to quote options
17200 containing spaces)
17201 --ar-option OPT
17203 give an extra option to ar (no need to quote options con‐
17204 taining spaces)
17205 --c2hs-option OPT
17207 give an extra option to c2hs (no need to quote options
17208 containing spaces)
17209 --cpphs-option OPT
17211 give an extra option to cpphs (no need to quote options
17212 containing spaces)
17213 --doctest-option OPT
17215 give an extra option to doctest (no need to quote options
17216 containing spaces)
17217 --gcc-option OPT
17219 give an extra option to gcc (no need to quote options
17220 containing spaces)
17221 --ghc-option OPT
17223 give an extra option to ghc (no need to quote options
17224 containing spaces)
17225 --ghc-pkg-option OPT
17227 give an extra option to ghc-pkg (no need to quote options
17228 containing spaces)
17229 --ghcjs-option OPT
17231 give an extra option to ghcjs (no need to quote options
17232 containing spaces)
17233 --ghcjs-pkg-option OPT
17235 give an extra option to ghcjs-pkg (no need to quote
17236 options containing spaces)
17237 --greencard-option OPT
17239 give an extra option to greencard (no need to quote
17240 options containing spaces)
17241 --haddock-option OPT
17243 give an extra option to haddock (no need to quote options
17244 containing spaces)
17245 --happy-option OPT
17247 give an extra option to happy (no need to quote options
17248 containing spaces)
17249 --haskell-suite-option OPT
17251 give an extra option to haskell-suite (no need to quote
17252 options containing spaces)
17253 --haskell-suite-pkg-option OPT
17255 give an extra option to haskell-suite-pkg (no need to
17256 quote options containing spaces)
17257 --hmake-option OPT
17259 give an extra option to hmake (no need to quote options
17260 containing spaces)
17261 --hpc-option OPT
17263 give an extra option to hpc (no need to quote options
17264 containing spaces)
17265 --hsc2hs-option OPT
17267 give an extra option to hsc2hs (no need to quote options
17268 containing spaces)
17269 --hscolour-option OPT
17271 give an extra option to hscolour (no need to quote
17272 options containing spaces)
17273 --jhc-option OPT
17275 give an extra option to jhc (no need to quote options
17276 containing spaces)
17277 --ld-option OPT
17279 give an extra option to ld (no need to quote options con‐
17280 taining spaces)
17281 --pkg-config-option OPT
17283 give an extra option to pkg-config (no need to quote
17284 options containing spaces)
17285 --runghc-option OPT
17287 give an extra option to runghc (no need to quote options
17288 containing spaces)
17289 --strip-option OPT
17291 give an extra option to strip (no need to quote options
17292 containing spaces)
17293 --tar-option OPT
17295 give an extra option to tar (no need to quote options
17296 containing spaces)
17297 --uhc-option OPT
17299 give an extra option to uhc (no need to quote options
17300 containing spaces)
17301 --alex-options OPTS
17303 give extra options to alex
17304 --ar-options OPTS
17306 give extra options to ar
17307 --c2hs-options OPTS
17309 give extra options to c2hs
17310 --cpphs-options OPTS
17312 give extra options to cpphs
17313 --doctest-options OPTS
17315 give extra options to doctest
17316 --gcc-options OPTS
17318 give extra options to gcc
17319 --ghc-options OPTS
17321 give extra options to ghc
17322 --ghc-pkg-options OPTS
17324 give extra options to ghc-pkg
17325 --ghcjs-options OPTS
17327 give extra options to ghcjs
17328 --ghcjs-pkg-options OPTS
17330 give extra options to ghcjs-pkg
17331 --greencard-options OPTS
17333 give extra options to greencard
17334 --haddock-options OPTS
17336 give extra options to haddock
17337 --happy-options OPTS
17339 give extra options to happy
17340 --haskell-suite-options OPTS
17342 give extra options to haskell-suite
17343 --haskell-suite-pkg-options OPTS
17345 give extra options to haskell-suite-pkg
17346 --hmake-options OPTS
17348 give extra options to hmake
17349 --hpc-options OPTS
17351 give extra options to hpc
17352 --hsc2hs-options OPTS
17354 give extra options to hsc2hs
17355 --hscolour-options OPTS
17357 give extra options to hscolour
17358 --jhc-options OPTS
17360 give extra options to jhc
17361 --ld-options OPTS
17363 give extra options to ld
17364 --pkg-config-options OPTS
17366 give extra options to pkg-config
17367 --runghc-options OPTS
17369 give extra options to runghc
17370 --strip-options OPTS
17372 give extra options to strip
17373 --tar-options OPTS
17375 give extra options to tar
17376 --uhc-options OPTS
17378 give extra options to uhc
17379 --cabal-lib-version VERSION
17381 Select which version of the Cabal lib to use to build
17382 packages (useful for testing).
17383 --constraint CONSTRAINT
17385 Specify constraints on a package (version,
17386 installed/source, flags)
17387 --preference CONSTRAINT
17389 Specify preferences (soft constraints) on the version of
17390 a package
17391 --solver SOLVER
17393 Select dependency solver to use (default: modular).
17394 Choices: modular.
17395 --allow-older [DEPS]
17397 Ignore lower bounds in all dependencies or DEPS
17398 --allow-newer [DEPS]
17400 Ignore upper bounds in all dependencies or DEPS
17401 cabal update
17404 Usage: cabal update [FLAGS]
17406 For all known remote repositories, download the package list.
17409 Relevant global configuration keys:
17412 remote-repo
17413 remote-repo-cache
17414 local-repo
17415 The update command is a part of the legacy v1 style of cabal usage.
17417 Please switch to using either the new project style and the new-update
17419 command or the legacy v1-update alias as new-style projects will become
17420 the default in the next version of cabal-install. Please file a bug if
17421 you cannot replicate a working v1- use case with the new-style com‐
17422 mands.
17423 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17425 Flags:
17428 -v, --verbose [n]
17429 Control verbosity (n is 0--3, default verbosity level is
17430 1)
17431 --index-state STATE
17433 Update the source package index to its state as it
17434 existed at a previous time. Accepts unix-timestamps (e.g.
17435 '@1474732068'), ISO8601 UTC timestamps (e.g.
17436 '2016-09-24T17:47:48Z'), or 'HEAD' (default: 'HEAD').
17437 cabal v1-update
17440 Usage: cabal v1-update [FLAGS]
17442 For all known remote repositories, download the package list.
17445 Relevant global configuration keys:
17448 remote-repo
17449 remote-repo-cache
17450 local-repo
17451 The v1-update command is a part of the legacy v1 style of cabal usage.
17453 It is a legacy feature and will be removed in a future release of
17455 cabal-install. Please file a bug if you cannot replicate a working v1-
17456 use case with the new-style commands.
17457 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17459 Flags:
17462 -v, --verbose [n]
17463 Control verbosity (n is 0--3, default verbosity level is
17464 1)
17465 --index-state STATE
17467 Update the source package index to its state as it
17468 existed at a previous time. Accepts unix-timestamps (e.g.
17469 '@1474732068'), ISO8601 UTC timestamps (e.g.
17470 '2016-09-24T17:47:48Z'), or 'HEAD' (default: 'HEAD').
17471 cabal build
17474 Usage: cabal build [FLAGS]
17476 or: cabal build COMPONENTS [FLAGS]
17477 Components encompass executables, tests, and benchmarks.
17480 Affected by configuration options, see `configure`.
17482 Examples:
17485 cabal build All the components in the package
17486 cabal build foo A component (i.e. lib, exe, test suite)
17487 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
17489 ing programs:
17490 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
17491 haddock
17492 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
17493 ld
17494 pkg-config runghc strip tar uhc
17495 The build command is a part of the legacy v1 style of cabal usage.
17497 Please switch to using either the new project style and the new-build
17499 command or the legacy v1-build alias as new-style projects will become
17500 the default in the next version of cabal-install. Please file a bug if
17501 you cannot replicate a working v1- use case with the new-style com‐
17502 mands.
17503 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17505 Flags:
17508 -v, --verbose [n]
17509 Control verbosity (n is 0--3, default verbosity level is
17510 1)
17511 --builddir, --distdir, --distpref DIR
17513 The directory where Cabal puts generated build files
17514 (default dist)
17515 -j, --jobs [NUM]
17517 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
17518 given).
17519 --with-alex PATH
17521 give the path to alex
17522 --with-ar PATH
17524 give the path to ar
17525 --with-c2hs PATH
17527 give the path to c2hs
17528 --with-cpphs PATH
17530 give the path to cpphs
17531 --with-doctest PATH
17533 give the path to doctest
17534 --with-gcc PATH
17536 give the path to gcc
17537 --with-ghc PATH
17539 give the path to ghc
17540 --with-ghc-pkg PATH
17542 give the path to ghc-pkg
17543 --with-ghcjs PATH
17545 give the path to ghcjs
17546 --with-ghcjs-pkg PATH
17548 give the path to ghcjs-pkg
17549 --with-greencard PATH
17551 give the path to greencard
17552 --with-haddock PATH
17554 give the path to haddock
17555 --with-happy PATH
17557 give the path to happy
17558 --with-haskell-suite PATH
17560 give the path to haskell-suite
17561 --with-haskell-suite-pkg PATH
17563 give the path to haskell-suite-pkg
17564 --with-hmake PATH
17566 give the path to hmake
17567 --with-hpc PATH
17569 give the path to hpc
17570 --with-hsc2hs PATH
17572 give the path to hsc2hs
17573 --with-hscolour PATH
17575 give the path to hscolour
17576 --with-jhc PATH
17578 give the path to jhc
17579 --with-ld PATH
17581 give the path to ld
17582 --with-pkg-config PATH
17584 give the path to pkg-config
17585 --with-runghc PATH
17587 give the path to runghc
17588 --with-strip PATH
17590 give the path to strip
17591 --with-tar PATH
17593 give the path to tar
17594 --with-uhc PATH
17596 give the path to uhc
17597 --alex-option OPT
17599 give an extra option to alex (no need to quote options
17600 containing spaces)
17601 --ar-option OPT
17603 give an extra option to ar (no need to quote options con‐
17604 taining spaces)
17605 --c2hs-option OPT
17607 give an extra option to c2hs (no need to quote options
17608 containing spaces)
17609 --cpphs-option OPT
17611 give an extra option to cpphs (no need to quote options
17612 containing spaces)
17613 --doctest-option OPT
17615 give an extra option to doctest (no need to quote options
17616 containing spaces)
17617 --gcc-option OPT
17619 give an extra option to gcc (no need to quote options
17620 containing spaces)
17621 --ghc-option OPT
17623 give an extra option to ghc (no need to quote options
17624 containing spaces)
17625 --ghc-pkg-option OPT
17627 give an extra option to ghc-pkg (no need to quote options
17628 containing spaces)
17629 --ghcjs-option OPT
17631 give an extra option to ghcjs (no need to quote options
17632 containing spaces)
17633 --ghcjs-pkg-option OPT
17635 give an extra option to ghcjs-pkg (no need to quote
17636 options containing spaces)
17637 --greencard-option OPT
17639 give an extra option to greencard (no need to quote
17640 options containing spaces)
17641 --haddock-option OPT
17643 give an extra option to haddock (no need to quote options
17644 containing spaces)
17645 --happy-option OPT
17647 give an extra option to happy (no need to quote options
17648 containing spaces)
17649 --haskell-suite-option OPT
17651 give an extra option to haskell-suite (no need to quote
17652 options containing spaces)
17653 --haskell-suite-pkg-option OPT
17655 give an extra option to haskell-suite-pkg (no need to
17656 quote options containing spaces)
17657 --hmake-option OPT
17659 give an extra option to hmake (no need to quote options
17660 containing spaces)
17661 --hpc-option OPT
17663 give an extra option to hpc (no need to quote options
17664 containing spaces)
17665 --hsc2hs-option OPT
17667 give an extra option to hsc2hs (no need to quote options
17668 containing spaces)
17669 --hscolour-option OPT
17671 give an extra option to hscolour (no need to quote
17672 options containing spaces)
17673 --jhc-option OPT
17675 give an extra option to jhc (no need to quote options
17676 containing spaces)
17677 --ld-option OPT
17679 give an extra option to ld (no need to quote options con‐
17680 taining spaces)
17681 --pkg-config-option OPT
17683 give an extra option to pkg-config (no need to quote
17684 options containing spaces)
17685 --runghc-option OPT
17687 give an extra option to runghc (no need to quote options
17688 containing spaces)
17689 --strip-option OPT
17691 give an extra option to strip (no need to quote options
17692 containing spaces)
17693 --tar-option OPT
17695 give an extra option to tar (no need to quote options
17696 containing spaces)
17697 --uhc-option OPT
17699 give an extra option to uhc (no need to quote options
17700 containing spaces)
17701 --alex-options OPTS
17703 give extra options to alex
17704 --ar-options OPTS
17706 give extra options to ar
17707 --c2hs-options OPTS
17709 give extra options to c2hs
17710 --cpphs-options OPTS
17712 give extra options to cpphs
17713 --doctest-options OPTS
17715 give extra options to doctest
17716 --gcc-options OPTS
17718 give extra options to gcc
17719 --ghc-options OPTS
17721 give extra options to ghc
17722 --ghc-pkg-options OPTS
17724 give extra options to ghc-pkg
17725 --ghcjs-options OPTS
17727 give extra options to ghcjs
17728 --ghcjs-pkg-options OPTS
17730 give extra options to ghcjs-pkg
17731 --greencard-options OPTS
17733 give extra options to greencard
17734 --haddock-options OPTS
17736 give extra options to haddock
17737 --happy-options OPTS
17739 give extra options to happy
17740 --haskell-suite-options OPTS
17742 give extra options to haskell-suite
17743 --haskell-suite-pkg-options OPTS
17745 give extra options to haskell-suite-pkg
17746 --hmake-options OPTS
17748 give extra options to hmake
17749 --hpc-options OPTS
17751 give extra options to hpc
17752 --hsc2hs-options OPTS
17754 give extra options to hsc2hs
17755 --hscolour-options OPTS
17757 give extra options to hscolour
17758 --jhc-options OPTS
17760 give extra options to jhc
17761 --ld-options OPTS
17763 give extra options to ld
17764 --pkg-config-options OPTS
17766 give extra options to pkg-config
17767 --runghc-options OPTS
17769 give extra options to runghc
17770 --strip-options OPTS
17772 give extra options to strip
17773 --tar-options OPTS
17775 give extra options to tar
17776 --uhc-options OPTS
17778 give extra options to uhc
17779 --only
17781 Don't reinstall add-source dependencies (sandbox-only)
17782 cabal v1-build
17785 Usage: cabal v1-build [FLAGS]
17787 or: cabal v1-build COMPONENTS [FLAGS]
17788 Components encompass executables, tests, and benchmarks.
17791 Affected by configuration options, see `v1-configure`.
17793 Examples:
17796 cabal v1-build All the components in the package
17797 cabal v1-build foo A component (i.e. lib, exe, test suite)
17798 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
17800 ing programs:
17801 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
17802 haddock
17803 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
17804 ld
17805 pkg-config runghc strip tar uhc
17806 The v1-build command is a part of the legacy v1 style of cabal usage.
17808 It is a legacy feature and will be removed in a future release of
17810 cabal-install. Please file a bug if you cannot replicate a working v1-
17811 use case with the new-style commands.
17812 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
17814 Flags:
17817 -v, --verbose [n]
17818 Control verbosity (n is 0--3, default verbosity level is
17819 1)
17820 --builddir, --distdir, --distpref DIR
17822 The directory where Cabal puts generated build files
17823 (default dist)
17824 -j, --jobs [NUM]
17826 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
17827 given).
17828 --with-alex PATH
17830 give the path to alex
17831 --with-ar PATH
17833 give the path to ar
17834 --with-c2hs PATH
17836 give the path to c2hs
17837 --with-cpphs PATH
17839 give the path to cpphs
17840 --with-doctest PATH
17842 give the path to doctest
17843 --with-gcc PATH
17845 give the path to gcc
17846 --with-ghc PATH
17848 give the path to ghc
17849 --with-ghc-pkg PATH
17851 give the path to ghc-pkg
17852 --with-ghcjs PATH
17854 give the path to ghcjs
17855 --with-ghcjs-pkg PATH
17857 give the path to ghcjs-pkg
17858 --with-greencard PATH
17860 give the path to greencard
17861 --with-haddock PATH
17863 give the path to haddock
17864 --with-happy PATH
17866 give the path to happy
17867 --with-haskell-suite PATH
17869 give the path to haskell-suite
17870 --with-haskell-suite-pkg PATH
17872 give the path to haskell-suite-pkg
17873 --with-hmake PATH
17875 give the path to hmake
17876 --with-hpc PATH
17878 give the path to hpc
17879 --with-hsc2hs PATH
17881 give the path to hsc2hs
17882 --with-hscolour PATH
17884 give the path to hscolour
17885 --with-jhc PATH
17887 give the path to jhc
17888 --with-ld PATH
17890 give the path to ld
17891 --with-pkg-config PATH
17893 give the path to pkg-config
17894 --with-runghc PATH
17896 give the path to runghc
17897 --with-strip PATH
17899 give the path to strip
17900 --with-tar PATH
17902 give the path to tar
17903 --with-uhc PATH
17905 give the path to uhc
17906 --alex-option OPT
17908 give an extra option to alex (no need to quote options
17909 containing spaces)
17910 --ar-option OPT
17912 give an extra option to ar (no need to quote options con‐
17913 taining spaces)
17914 --c2hs-option OPT
17916 give an extra option to c2hs (no need to quote options
17917 containing spaces)
17918 --cpphs-option OPT
17920 give an extra option to cpphs (no need to quote options
17921 containing spaces)
17922 --doctest-option OPT
17924 give an extra option to doctest (no need to quote options
17925 containing spaces)
17926 --gcc-option OPT
17928 give an extra option to gcc (no need to quote options
17929 containing spaces)
17930 --ghc-option OPT
17932 give an extra option to ghc (no need to quote options
17933 containing spaces)
17934 --ghc-pkg-option OPT
17936 give an extra option to ghc-pkg (no need to quote options
17937 containing spaces)
17938 --ghcjs-option OPT
17940 give an extra option to ghcjs (no need to quote options
17941 containing spaces)
17942 --ghcjs-pkg-option OPT
17944 give an extra option to ghcjs-pkg (no need to quote
17945 options containing spaces)
17946 --greencard-option OPT
17948 give an extra option to greencard (no need to quote
17949 options containing spaces)
17950 --haddock-option OPT
17952 give an extra option to haddock (no need to quote options
17953 containing spaces)
17954 --happy-option OPT
17956 give an extra option to happy (no need to quote options
17957 containing spaces)
17958 --haskell-suite-option OPT
17960 give an extra option to haskell-suite (no need to quote
17961 options containing spaces)
17962 --haskell-suite-pkg-option OPT
17964 give an extra option to haskell-suite-pkg (no need to
17965 quote options containing spaces)
17966 --hmake-option OPT
17968 give an extra option to hmake (no need to quote options
17969 containing spaces)
17970 --hpc-option OPT
17972 give an extra option to hpc (no need to quote options
17973 containing spaces)
17974 --hsc2hs-option OPT
17976 give an extra option to hsc2hs (no need to quote options
17977 containing spaces)
17978 --hscolour-option OPT
17980 give an extra option to hscolour (no need to quote
17981 options containing spaces)
17982 --jhc-option OPT
17984 give an extra option to jhc (no need to quote options
17985 containing spaces)
17986 --ld-option OPT
17988 give an extra option to ld (no need to quote options con‐
17989 taining spaces)
17990 --pkg-config-option OPT
17992 give an extra option to pkg-config (no need to quote
17993 options containing spaces)
17994 --runghc-option OPT
17996 give an extra option to runghc (no need to quote options
17997 containing spaces)
17998 --strip-option OPT
18000 give an extra option to strip (no need to quote options
18001 containing spaces)
18002 --tar-option OPT
18004 give an extra option to tar (no need to quote options
18005 containing spaces)
18006 --uhc-option OPT
18008 give an extra option to uhc (no need to quote options
18009 containing spaces)
18010 --alex-options OPTS
18012 give extra options to alex
18013 --ar-options OPTS
18015 give extra options to ar
18016 --c2hs-options OPTS
18018 give extra options to c2hs
18019 --cpphs-options OPTS
18021 give extra options to cpphs
18022 --doctest-options OPTS
18024 give extra options to doctest
18025 --gcc-options OPTS
18027 give extra options to gcc
18028 --ghc-options OPTS
18030 give extra options to ghc
18031 --ghc-pkg-options OPTS
18033 give extra options to ghc-pkg
18034 --ghcjs-options OPTS
18036 give extra options to ghcjs
18037 --ghcjs-pkg-options OPTS
18039 give extra options to ghcjs-pkg
18040 --greencard-options OPTS
18042 give extra options to greencard
18043 --haddock-options OPTS
18045 give extra options to haddock
18046 --happy-options OPTS
18048 give extra options to happy
18049 --haskell-suite-options OPTS
18051 give extra options to haskell-suite
18052 --haskell-suite-pkg-options OPTS
18054 give extra options to haskell-suite-pkg
18055 --hmake-options OPTS
18057 give extra options to hmake
18058 --hpc-options OPTS
18060 give extra options to hpc
18061 --hsc2hs-options OPTS
18063 give extra options to hsc2hs
18064 --hscolour-options OPTS
18066 give extra options to hscolour
18067 --jhc-options OPTS
18069 give extra options to jhc
18070 --ld-options OPTS
18072 give extra options to ld
18073 --pkg-config-options OPTS
18075 give extra options to pkg-config
18076 --runghc-options OPTS
18078 give extra options to runghc
18079 --strip-options OPTS
18081 give extra options to strip
18082 --tar-options OPTS
18084 give extra options to tar
18085 --uhc-options OPTS
18087 give extra options to uhc
18088 --only
18090 Don't reinstall add-source dependencies (sandbox-only)
18091 cabal repl
18094 Usage: cabal repl [COMPONENT] [FLAGS]
18096 If the current directory contains no package, ignores COMPONENT parame‐
18099 ters and opens an interactive interpreter session; if a sandbox is
18100 present, its package database will be used.
18101 Otherwise, (re)configures with the given or default flags, and loads
18103 the interpreter with the relevant modules. For executables, tests and
18104 benchmarks, loads the main module (and its dependencies); for libraries
18105 all exposed/other modules.
18106 The default component is the library itself, or the executable if that
18108 is the only component.
18109 Support for loading specific modules is planned but not implemented
18111 yet. For certain scenarios, `cabal exec -- ghci :l Foo` may be used
18112 instead. Note that `exec` will not (re)configure and you will have to
18113 specify the location of other modules, if required.
18114 Examples:
18117 cabal repl The first component in the package
18118 cabal repl foo A named component (i.e. lib, exe, test
18119 suite)
18120 cabal repl --ghc-options="-lstdc++" Specifying flags for interpreter
18121 The repl command is a part of the legacy v1 style of cabal usage.
18123 Please switch to using either the new project style and the new-repl
18125 command or the legacy v1-repl alias as new-style projects will become
18126 the default in the next version of cabal-install. Please file a bug if
18127 you cannot replicate a working v1- use case with the new-style com‐
18128 mands.
18129 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18131 Flags:
18134 -v, --verbose [n]
18135 Control verbosity (n is 0--3, default verbosity level is
18136 1)
18137 --builddir, --distdir, --distpref DIR
18139 The directory where Cabal puts generated build files
18140 (default dist)
18141 --with-alex PATH
18143 give the path to alex
18144 --with-ar PATH
18146 give the path to ar
18147 --with-c2hs PATH
18149 give the path to c2hs
18150 --with-cpphs PATH
18152 give the path to cpphs
18153 --with-doctest PATH
18155 give the path to doctest
18156 --with-gcc PATH
18158 give the path to gcc
18159 --with-ghc PATH
18161 give the path to ghc
18162 --with-ghc-pkg PATH
18164 give the path to ghc-pkg
18165 --with-ghcjs PATH
18167 give the path to ghcjs
18168 --with-ghcjs-pkg PATH
18170 give the path to ghcjs-pkg
18171 --with-greencard PATH
18173 give the path to greencard
18174 --with-haddock PATH
18176 give the path to haddock
18177 --with-happy PATH
18179 give the path to happy
18180 --with-haskell-suite PATH
18182 give the path to haskell-suite
18183 --with-haskell-suite-pkg PATH
18185 give the path to haskell-suite-pkg
18186 --with-hmake PATH
18188 give the path to hmake
18189 --with-hpc PATH
18191 give the path to hpc
18192 --with-hsc2hs PATH
18194 give the path to hsc2hs
18195 --with-hscolour PATH
18197 give the path to hscolour
18198 --with-jhc PATH
18200 give the path to jhc
18201 --with-ld PATH
18203 give the path to ld
18204 --with-pkg-config PATH
18206 give the path to pkg-config
18207 --with-runghc PATH
18209 give the path to runghc
18210 --with-strip PATH
18212 give the path to strip
18213 --with-tar PATH
18215 give the path to tar
18216 --with-uhc PATH
18218 give the path to uhc
18219 --alex-option OPT
18221 give an extra option to alex (no need to quote options
18222 containing spaces)
18223 --ar-option OPT
18225 give an extra option to ar (no need to quote options con‐
18226 taining spaces)
18227 --c2hs-option OPT
18229 give an extra option to c2hs (no need to quote options
18230 containing spaces)
18231 --cpphs-option OPT
18233 give an extra option to cpphs (no need to quote options
18234 containing spaces)
18235 --doctest-option OPT
18237 give an extra option to doctest (no need to quote options
18238 containing spaces)
18239 --gcc-option OPT
18241 give an extra option to gcc (no need to quote options
18242 containing spaces)
18243 --ghc-option OPT
18245 give an extra option to ghc (no need to quote options
18246 containing spaces)
18247 --ghc-pkg-option OPT
18249 give an extra option to ghc-pkg (no need to quote options
18250 containing spaces)
18251 --ghcjs-option OPT
18253 give an extra option to ghcjs (no need to quote options
18254 containing spaces)
18255 --ghcjs-pkg-option OPT
18257 give an extra option to ghcjs-pkg (no need to quote
18258 options containing spaces)
18259 --greencard-option OPT
18261 give an extra option to greencard (no need to quote
18262 options containing spaces)
18263 --haddock-option OPT
18265 give an extra option to haddock (no need to quote options
18266 containing spaces)
18267 --happy-option OPT
18269 give an extra option to happy (no need to quote options
18270 containing spaces)
18271 --haskell-suite-option OPT
18273 give an extra option to haskell-suite (no need to quote
18274 options containing spaces)
18275 --haskell-suite-pkg-option OPT
18277 give an extra option to haskell-suite-pkg (no need to
18278 quote options containing spaces)
18279 --hmake-option OPT
18281 give an extra option to hmake (no need to quote options
18282 containing spaces)
18283 --hpc-option OPT
18285 give an extra option to hpc (no need to quote options
18286 containing spaces)
18287 --hsc2hs-option OPT
18289 give an extra option to hsc2hs (no need to quote options
18290 containing spaces)
18291 --hscolour-option OPT
18293 give an extra option to hscolour (no need to quote
18294 options containing spaces)
18295 --jhc-option OPT
18297 give an extra option to jhc (no need to quote options
18298 containing spaces)
18299 --ld-option OPT
18301 give an extra option to ld (no need to quote options con‐
18302 taining spaces)
18303 --pkg-config-option OPT
18305 give an extra option to pkg-config (no need to quote
18306 options containing spaces)
18307 --runghc-option OPT
18309 give an extra option to runghc (no need to quote options
18310 containing spaces)
18311 --strip-option OPT
18313 give an extra option to strip (no need to quote options
18314 containing spaces)
18315 --tar-option OPT
18317 give an extra option to tar (no need to quote options
18318 containing spaces)
18319 --uhc-option OPT
18321 give an extra option to uhc (no need to quote options
18322 containing spaces)
18323 --alex-options OPTS
18325 give extra options to alex
18326 --ar-options OPTS
18328 give extra options to ar
18329 --c2hs-options OPTS
18331 give extra options to c2hs
18332 --cpphs-options OPTS
18334 give extra options to cpphs
18335 --doctest-options OPTS
18337 give extra options to doctest
18338 --gcc-options OPTS
18340 give extra options to gcc
18341 --ghc-options OPTS
18343 give extra options to ghc
18344 --ghc-pkg-options OPTS
18346 give extra options to ghc-pkg
18347 --ghcjs-options OPTS
18349 give extra options to ghcjs
18350 --ghcjs-pkg-options OPTS
18352 give extra options to ghcjs-pkg
18353 --greencard-options OPTS
18355 give extra options to greencard
18356 --haddock-options OPTS
18358 give extra options to haddock
18359 --happy-options OPTS
18361 give extra options to happy
18362 --haskell-suite-options OPTS
18364 give extra options to haskell-suite
18365 --haskell-suite-pkg-options OPTS
18367 give extra options to haskell-suite-pkg
18368 --hmake-options OPTS
18370 give extra options to hmake
18371 --hpc-options OPTS
18373 give extra options to hpc
18374 --hsc2hs-options OPTS
18376 give extra options to hsc2hs
18377 --hscolour-options OPTS
18379 give extra options to hscolour
18380 --jhc-options OPTS
18382 give extra options to jhc
18383 --ld-options OPTS
18385 give extra options to ld
18386 --pkg-config-options OPTS
18388 give extra options to pkg-config
18389 --runghc-options OPTS
18391 give extra options to runghc
18392 --strip-options OPTS
18394 give extra options to strip
18395 --tar-options OPTS
18397 give extra options to tar
18398 --uhc-options OPTS
18400 give extra options to uhc
18401 --reload
18403 Used from within an interpreter to update files.
18404 --repl-options FLAG
18406 use this option for the repl
18407 --only
18409 Don't reinstall add-source dependencies (sandbox-only)
18410 cabal v1-repl
18413 Usage: cabal v1-repl [COMPONENT] [FLAGS]
18415 If the current directory contains no package, ignores COMPONENT parame‐
18418 ters and opens an interactive interpreter session; if a sandbox is
18419 present, its package database will be used.
18420 Otherwise, (re)configures with the given or default flags, and loads
18422 the interpreter with the relevant modules. For executables, tests and
18423 benchmarks, loads the main module (and its dependencies); for libraries
18424 all exposed/other modules.
18425 The default component is the library itself, or the executable if that
18427 is the only component.
18428 Support for loading specific modules is planned but not implemented
18430 yet. For certain scenarios, `cabal v1-exec -- ghci :l Foo` may be used
18431 instead. Note that `v1-exec` will not (re)configure and you will have
18432 to specify the location of other modules, if required.
18433 Examples:
18436 cabal v1-repl The first component in the package
18437 cabal v1-repl foo A named component (i.e. lib, exe, test
18438 suite)
18439 cabal v1-repl --ghc-options="-lstdc++" Specifying flags for inter‐
18440 preter
18441 The v1-repl command is a part of the legacy v1 style of cabal usage.
18443 It is a legacy feature and will be removed in a future release of
18445 cabal-install. Please file a bug if you cannot replicate a working v1-
18446 use case with the new-style commands.
18447 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18449 Flags:
18452 -v, --verbose [n]
18453 Control verbosity (n is 0--3, default verbosity level is
18454 1)
18455 --builddir, --distdir, --distpref DIR
18457 The directory where Cabal puts generated build files
18458 (default dist)
18459 --with-alex PATH
18461 give the path to alex
18462 --with-ar PATH
18464 give the path to ar
18465 --with-c2hs PATH
18467 give the path to c2hs
18468 --with-cpphs PATH
18470 give the path to cpphs
18471 --with-doctest PATH
18473 give the path to doctest
18474 --with-gcc PATH
18476 give the path to gcc
18477 --with-ghc PATH
18479 give the path to ghc
18480 --with-ghc-pkg PATH
18482 give the path to ghc-pkg
18483 --with-ghcjs PATH
18485 give the path to ghcjs
18486 --with-ghcjs-pkg PATH
18488 give the path to ghcjs-pkg
18489 --with-greencard PATH
18491 give the path to greencard
18492 --with-haddock PATH
18494 give the path to haddock
18495 --with-happy PATH
18497 give the path to happy
18498 --with-haskell-suite PATH
18500 give the path to haskell-suite
18501 --with-haskell-suite-pkg PATH
18503 give the path to haskell-suite-pkg
18504 --with-hmake PATH
18506 give the path to hmake
18507 --with-hpc PATH
18509 give the path to hpc
18510 --with-hsc2hs PATH
18512 give the path to hsc2hs
18513 --with-hscolour PATH
18515 give the path to hscolour
18516 --with-jhc PATH
18518 give the path to jhc
18519 --with-ld PATH
18521 give the path to ld
18522 --with-pkg-config PATH
18524 give the path to pkg-config
18525 --with-runghc PATH
18527 give the path to runghc
18528 --with-strip PATH
18530 give the path to strip
18531 --with-tar PATH
18533 give the path to tar
18534 --with-uhc PATH
18536 give the path to uhc
18537 --alex-option OPT
18539 give an extra option to alex (no need to quote options
18540 containing spaces)
18541 --ar-option OPT
18543 give an extra option to ar (no need to quote options con‐
18544 taining spaces)
18545 --c2hs-option OPT
18547 give an extra option to c2hs (no need to quote options
18548 containing spaces)
18549 --cpphs-option OPT
18551 give an extra option to cpphs (no need to quote options
18552 containing spaces)
18553 --doctest-option OPT
18555 give an extra option to doctest (no need to quote options
18556 containing spaces)
18557 --gcc-option OPT
18559 give an extra option to gcc (no need to quote options
18560 containing spaces)
18561 --ghc-option OPT
18563 give an extra option to ghc (no need to quote options
18564 containing spaces)
18565 --ghc-pkg-option OPT
18567 give an extra option to ghc-pkg (no need to quote options
18568 containing spaces)
18569 --ghcjs-option OPT
18571 give an extra option to ghcjs (no need to quote options
18572 containing spaces)
18573 --ghcjs-pkg-option OPT
18575 give an extra option to ghcjs-pkg (no need to quote
18576 options containing spaces)
18577 --greencard-option OPT
18579 give an extra option to greencard (no need to quote
18580 options containing spaces)
18581 --haddock-option OPT
18583 give an extra option to haddock (no need to quote options
18584 containing spaces)
18585 --happy-option OPT
18587 give an extra option to happy (no need to quote options
18588 containing spaces)
18589 --haskell-suite-option OPT
18591 give an extra option to haskell-suite (no need to quote
18592 options containing spaces)
18593 --haskell-suite-pkg-option OPT
18595 give an extra option to haskell-suite-pkg (no need to
18596 quote options containing spaces)
18597 --hmake-option OPT
18599 give an extra option to hmake (no need to quote options
18600 containing spaces)
18601 --hpc-option OPT
18603 give an extra option to hpc (no need to quote options
18604 containing spaces)
18605 --hsc2hs-option OPT
18607 give an extra option to hsc2hs (no need to quote options
18608 containing spaces)
18609 --hscolour-option OPT
18611 give an extra option to hscolour (no need to quote
18612 options containing spaces)
18613 --jhc-option OPT
18615 give an extra option to jhc (no need to quote options
18616 containing spaces)
18617 --ld-option OPT
18619 give an extra option to ld (no need to quote options con‐
18620 taining spaces)
18621 --pkg-config-option OPT
18623 give an extra option to pkg-config (no need to quote
18624 options containing spaces)
18625 --runghc-option OPT
18627 give an extra option to runghc (no need to quote options
18628 containing spaces)
18629 --strip-option OPT
18631 give an extra option to strip (no need to quote options
18632 containing spaces)
18633 --tar-option OPT
18635 give an extra option to tar (no need to quote options
18636 containing spaces)
18637 --uhc-option OPT
18639 give an extra option to uhc (no need to quote options
18640 containing spaces)
18641 --alex-options OPTS
18643 give extra options to alex
18644 --ar-options OPTS
18646 give extra options to ar
18647 --c2hs-options OPTS
18649 give extra options to c2hs
18650 --cpphs-options OPTS
18652 give extra options to cpphs
18653 --doctest-options OPTS
18655 give extra options to doctest
18656 --gcc-options OPTS
18658 give extra options to gcc
18659 --ghc-options OPTS
18661 give extra options to ghc
18662 --ghc-pkg-options OPTS
18664 give extra options to ghc-pkg
18665 --ghcjs-options OPTS
18667 give extra options to ghcjs
18668 --ghcjs-pkg-options OPTS
18670 give extra options to ghcjs-pkg
18671 --greencard-options OPTS
18673 give extra options to greencard
18674 --haddock-options OPTS
18676 give extra options to haddock
18677 --happy-options OPTS
18679 give extra options to happy
18680 --haskell-suite-options OPTS
18682 give extra options to haskell-suite
18683 --haskell-suite-pkg-options OPTS
18685 give extra options to haskell-suite-pkg
18686 --hmake-options OPTS
18688 give extra options to hmake
18689 --hpc-options OPTS
18691 give extra options to hpc
18692 --hsc2hs-options OPTS
18694 give extra options to hsc2hs
18695 --hscolour-options OPTS
18697 give extra options to hscolour
18698 --jhc-options OPTS
18700 give extra options to jhc
18701 --ld-options OPTS
18703 give extra options to ld
18704 --pkg-config-options OPTS
18706 give extra options to pkg-config
18707 --runghc-options OPTS
18709 give extra options to runghc
18710 --strip-options OPTS
18712 give extra options to strip
18713 --tar-options OPTS
18715 give extra options to tar
18716 --uhc-options OPTS
18718 give extra options to uhc
18719 --reload
18721 Used from within an interpreter to update files.
18722 --repl-options FLAG
18724 use this option for the repl
18725 --only
18727 Don't reinstall add-source dependencies (sandbox-only)
18728 cabal freeze
18731 Usage: cabal freeze [FLAGS]
18733 Calculates a valid set of dependencies and their exact versions. If
18736 successful, saves the result to the file `cabal.config`.
18737 The package versions specified in `cabal.config` will be used for any
18739 future installs.
18740 An existing `cabal.config` is ignored and overwritten.
18742 The freeze command is a part of the legacy v1 style of cabal usage.
18745 Please switch to using either the new project style and the new-freeze
18747 command or the legacy v1-freeze alias as new-style projects will become
18748 the default in the next version of cabal-install. Please file a bug if
18749 you cannot replicate a working v1- use case with the new-style com‐
18750 mands.
18751 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18753 Flags:
18756 -v, --verbose [n]
18757 Control verbosity (n is 0--3, default verbosity level is
18758 1)
18759 --dry-run
18761 Do not freeze anything, only print what would be frozen
18762 --enable-tests
18764 --disable-tests
18765 freezing of the dependencies of any tests suites in the
18766 package description file.
18767 --enable-benchmarks
18769 --disable-benchmarks
18770 freezing of the dependencies of any benchmarks suites in
18771 the package description file.
18772 --solver SOLVER
18774 Select dependency solver to use (default: modular).
18775 Choices: modular.
18776 --max-backjumps NUM
18778 Maximum number of backjumps allowed while solving
18779 (default: 2000). Use a negative number to enable unlim‐
18780 ited backtracking. Use 0 to disable backtracking com‐
18781 pletely.
18782 --reorder-goals
18784 --no-reorder-goals
18785 Try to reorder goals according to certain heuristics.
18786 Slows things down on average, but may make backtracking
18787 faster for some packages.
18788 --count-conflicts
18790 --no-count-conflicts
18791 Try to speed up solving by preferring goals that are
18792 involved in a lot of conflicts (default).
18793 --independent-goals
18795 --no-independent-goals
18796 Treat several goals on the command line as independent.
18797 If several goals depend on the same package, different
18798 versions can be chosen.
18799 --shadow-installed-packages
18801 --no-shadow-installed-packages
18802 If multiple package instances of the same version are
18803 installed, treat all but one as shadowed.
18804 --strong-flags
18806 --no-strong-flags
18807 Do not defer flag choices (this used to be the default in
18808 cabal-install <= 1.20).
18809 --allow-boot-library-installs
18811 --no-allow-boot-library-installs
18812 Allow cabal to install base, ghc-prim, integer-simple,
18813 integer-gmp, and template-haskell.
18814 cabal v1-freeze
18817 Usage: cabal freeze [FLAGS]
18819 Calculates a valid set of dependencies and their exact versions. If
18822 successful, saves the result to the file `cabal.config`.
18823 The package versions specified in `cabal.config` will be used for any
18825 future installs.
18826 An existing `cabal.config` is ignored and overwritten.
18828 The v1-freeze command is a part of the legacy v1 style of cabal usage.
18831 It is a legacy feature and will be removed in a future release of
18833 cabal-install. Please file a bug if you cannot replicate a working v1-
18834 use case with the new-style commands.
18835 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18837 Flags:
18840 -v, --verbose [n]
18841 Control verbosity (n is 0--3, default verbosity level is
18842 1)
18843 --dry-run
18845 Do not freeze anything, only print what would be frozen
18846 --enable-tests
18848 --disable-tests
18849 freezing of the dependencies of any tests suites in the
18850 package description file.
18851 --enable-benchmarks
18853 --disable-benchmarks
18854 freezing of the dependencies of any benchmarks suites in
18855 the package description file.
18856 --solver SOLVER
18858 Select dependency solver to use (default: modular).
18859 Choices: modular.
18860 --max-backjumps NUM
18862 Maximum number of backjumps allowed while solving
18863 (default: 2000). Use a negative number to enable unlim‐
18864 ited backtracking. Use 0 to disable backtracking com‐
18865 pletely.
18866 --reorder-goals
18868 --no-reorder-goals
18869 Try to reorder goals according to certain heuristics.
18870 Slows things down on average, but may make backtracking
18871 faster for some packages.
18872 --count-conflicts
18874 --no-count-conflicts
18875 Try to speed up solving by preferring goals that are
18876 involved in a lot of conflicts (default).
18877 --independent-goals
18879 --no-independent-goals
18880 Treat several goals on the command line as independent.
18881 If several goals depend on the same package, different
18882 versions can be chosen.
18883 --shadow-installed-packages
18885 --no-shadow-installed-packages
18886 If multiple package instances of the same version are
18887 installed, treat all but one as shadowed.
18888 --strong-flags
18890 --no-strong-flags
18891 Do not defer flag choices (this used to be the default in
18892 cabal-install <= 1.20).
18893 --allow-boot-library-installs
18895 --no-allow-boot-library-installs
18896 Allow cabal to install base, ghc-prim, integer-simple,
18897 integer-gmp, and template-haskell.
18898 cabal haddock
18901 Usage: cabal haddock [FLAGS]
18903 or: cabal haddock COMPONENTS [FLAGS]
18904 Requires the program haddock, version 2.x.
18907 The haddock command is a part of the legacy v1 style of cabal usage.
18910 Please switch to using either the new project style and the new-haddock
18912 command or the legacy v1-haddock alias as new-style projects will
18913 become the default in the next version of cabal-install. Please file a
18914 bug if you cannot replicate a working v1- use case with the new-style
18915 commands.
18916 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
18918 Flags:
18921 -v, --verbose [n]
18922 Control verbosity (n is 0--3, default verbosity level is
18923 1)
18924 --builddir, --distdir, --distpref DIR
18926 The directory where Cabal puts generated build files
18927 (default dist)
18928 --keep-temp-files
18930 Keep temporary files
18931 --hoogle
18933 Generate a hoogle database
18934 --html
18936 Generate HTML documentation (the default)
18937 --html-location URL
18939 Location of HTML documentation for pre-requisite packages
18940 --for-hackage
18942 Collection of flags to generate documentation suitable
18943 for upload to hackage
18944 --executables
18946 Run haddock for Executables targets
18947 --tests
18949 Run haddock for Test Suite targets
18950 --benchmarks
18952 Run haddock for Benchmark targets
18953 --foreign-libraries
18955 Run haddock for Foreign Library targets
18956 --all
18958 Run haddock for all targets
18959 --internal
18961 Run haddock for internal modules and include all symbols
18962 --css PATH
18964 Use PATH as the haddock stylesheet
18965 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
18967 Hyperlink the documentation to the source code
18968 --quickjump
18970 Generate an index for interactive documentation naviga‐
18971 tion
18972 --hscolour-css PATH
18974 Use PATH as the HsColour stylesheet
18975 --contents-location URL
18977 Bake URL in as the location for the contents page
18978 --with-ghc PATH
18980 give the path to ghc
18981 --with-haddock PATH
18983 give the path to haddock
18984 --ghc-option OPT
18986 give an extra option to ghc (no need to quote options
18987 containing spaces)
18988 --haddock-option OPT
18990 give an extra option to haddock (no need to quote options
18991 containing spaces)
18992 --ghc-options OPTS
18994 give extra options to ghc
18995 --haddock-options OPTS
18997 give extra options to haddock
18998 cabal v1-haddock
19001 Usage: cabal v1-haddock [FLAGS]
19003 or: cabal v1-haddock COMPONENTS [FLAGS]
19004 Requires the program haddock, version 2.x.
19007 The v1-haddock command is a part of the legacy v1 style of cabal usage.
19010 It is a legacy feature and will be removed in a future release of
19012 cabal-install. Please file a bug if you cannot replicate a working v1-
19013 use case with the new-style commands.
19014 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
19016 Flags:
19019 -v, --verbose [n]
19020 Control verbosity (n is 0--3, default verbosity level is
19021 1)
19022 --builddir, --distdir, --distpref DIR
19024 The directory where Cabal puts generated build files
19025 (default dist)
19026 --keep-temp-files
19028 Keep temporary files
19029 --hoogle
19031 Generate a hoogle database
19032 --html
19034 Generate HTML documentation (the default)
19035 --html-location URL
19037 Location of HTML documentation for pre-requisite packages
19038 --for-hackage
19040 Collection of flags to generate documentation suitable
19041 for upload to hackage
19042 --executables
19044 Run haddock for Executables targets
19045 --tests
19047 Run haddock for Test Suite targets
19048 --benchmarks
19050 Run haddock for Benchmark targets
19051 --foreign-libraries
19053 Run haddock for Foreign Library targets
19054 --all
19056 Run haddock for all targets
19057 --internal
19059 Run haddock for internal modules and include all symbols
19060 --css PATH
19062 Use PATH as the haddock stylesheet
19063 --hyperlink-source, --hyperlink-sources, --hyperlinked-source
19065 Hyperlink the documentation to the source code
19066 --quickjump
19068 Generate an index for interactive documentation naviga‐
19069 tion
19070 --hscolour-css PATH
19072 Use PATH as the HsColour stylesheet
19073 --contents-location URL
19075 Bake URL in as the location for the contents page
19076 --with-ghc PATH
19078 give the path to ghc
19079 --with-haddock PATH
19081 give the path to haddock
19082 --ghc-option OPT
19084 give an extra option to ghc (no need to quote options
19085 containing spaces)
19086 --haddock-option OPT
19088 give an extra option to haddock (no need to quote options
19089 containing spaces)
19090 --ghc-options OPTS
19092 give extra options to ghc
19093 --haddock-options OPTS
19095 give extra options to haddock
19096 cabal install
19099 Usage: cabal install [FLAGS]
19101 or: cabal install [FLAGS] PACKAGES
19102 Installs one or more packages. By default, the installed package will
19105 be registered in the user's package database or, if a sandbox is
19106 present in the current directory, inside the sandbox.
19107 If PACKAGES are specified, downloads and installs those packages. Oth‐
19109 erwise, install the package in the current directory (and/or its depen‐
19110 dencies) (there must be exactly one .cabal file in the current direc‐
19111 tory).
19112 When using a sandbox, the flags for `install` only affect the current
19114 command and have no effect on future commands. (To achieve that, `con‐
19115 figure` must be used.) In contrast, without a sandbox, the flags to
19116 `install` are saved and affect future commands such as `build` and
19117 `repl`. See the help for `configure` for a list of commands being
19118 affected.
19119 Installed executables will by default (and without a sandbox) be put
19121 into `~/.cabal/bin/`. If you want installed executable to be available
19122 globally, make sure that the PATH environment variable contains that
19123 directory. When using a sandbox, executables will be put into `$SAND‐
19124 BOX/bin/` (by default: `./.cabal-sandbox/bin/`).
19125 When specifying --bindir, consider also specifying --datadir; this way
19127 the sandbox can be deleted and the executable should continue working
19128 as long as bindir and datadir are left untouched.
19129 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
19132 ing programs:
19133 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
19134 haddock
19135 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
19136 ld
19137 pkg-config runghc strip tar uhc
19138 Examples:
19140 cabal install Package in the current directory
19141 cabal install foo Package from the hackage server
19142 cabal install foo-1.0 Specific version of a package
19143 cabal install 'foo < 2' Constrained package version
19144 cabal install haddock --bindir=$HOME/hask-bin/ --datadir=$HOME/hask-
19145 data/
19146 Change installation destination
19147 The install command is a part of the legacy v1 style of cabal usage.
19149 Please switch to using either the new project style and the new-install
19151 command or the legacy v1-install alias as new-style projects will
19152 become the default in the next version of cabal-install. Please file a
19153 bug if you cannot replicate a working v1- use case with the new-style
19154 commands.
19155 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
19157 Flags:
19160 -v, --verbose [n]
19161 Control verbosity (n is 0--3, default verbosity level is
19162 1)
19163 --builddir, --distdir, --distpref DIR
19165 The directory where Cabal puts generated build files
19166 (default dist)
19167 -g, --ghc
19169 compile with GHC
19170 --ghcjs
19172 compile with GHCJS
19173 --uhc
19175 compile with UHC
19176 --haskell-suite
19178 compile with a haskell-suite compiler
19179 --cabal-file PATH
19181 use this Cabal file
19182 -w, --with-compiler PATH
19184 give the path to a particular compiler
19185 --with-hc-pkg PATH
19187 give the path to the package tool
19188 --prefix DIR
19190 bake this prefix in preparation of installation
19191 --bindir DIR
19193 installation directory for executables
19194 --libdir DIR
19196 installation directory for libraries
19197 --libsubdir DIR
19199 subdirectory of libdir in which libs are installed
19200 --dynlibdir DIR
19202 installation directory for dynamic libraries
19203 --libexecdir DIR
19205 installation directory for program executables
19206 --libexecsubdir DIR
19208 subdirectory of libexecdir in which private executables
19209 are installed
19210 --datadir DIR
19212 installation directory for read-only data
19213 --datasubdir DIR
19215 subdirectory of datadir in which data files are installed
19216 --docdir DIR
19218 installation directory for documentation
19219 --htmldir DIR
19221 installation directory for HTML documentation
19222 --haddockdir DIR
19224 installation directory for haddock interfaces
19225 --sysconfdir DIR
19227 installation directory for configuration files
19228 --program-prefix PREFIX
19230 prefix to be applied to installed executables
19231 --program-suffix SUFFIX
19233 suffix to be applied to installed executables
19234 --enable-library-vanilla
19236 --disable-library-vanilla
19237 Vanilla libraries
19238 -p, --enable-library-profiling
19240 --disable-library-profiling
19241 Library profiling
19242 --enable-shared
19244 --disable-shared
19245 Shared library
19246 --enable-static
19248 --disable-static
19249 Static library
19250 --enable-executable-dynamic
19252 --disable-executable-dynamic
19253 Executable dynamic linking
19254 --enable-profiling
19256 --disable-profiling
19257 Executable and library profiling
19258 --enable-executable-profiling
19260 --disable-executable-profiling
19261 Executable profiling (DEPRECATED)
19262 --profiling-detail level
19264 Profiling detail level for executable and library
19265 (default, none, exported-functions, toplevel-functions,
19266 all-functions).
19267 --library-profiling-detail level
19269 Profiling detail level for libraries only.
19270 -O, --enable-optimization, --enable-optimisation [n]
19272 Build with optimization (n is 0--2, default is 1)
19273 --disable-optimization, --disable-optimisation
19275 Build without optimization
19276 --enable-debug-info [n]
19278 Emit debug info (n is 0--3, default is 0)
19279 --disable-debug-info
19281 Don't emit debug info
19282 --enable-library-for-ghci
19284 --disable-library-for-ghci
19285 compile library for use with GHCi
19286 --enable-split-sections
19288 --disable-split-sections
19289 compile library code such that unneeded definitions can
19290 be dropped from the final executable (GHC 7.8+)
19291 --enable-split-objs
19293 --disable-split-objs
19294 split library into smaller objects to reduce binary sizes
19295 (GHC 6.6+)
19296 --enable-executable-stripping
19298 --disable-executable-stripping
19299 strip executables upon installation to reduce binary
19300 sizes
19301 --enable-library-stripping
19303 --disable-library-stripping
19304 strip libraries upon installation to reduce binary sizes
19305 --configure-option OPT
19307 Extra option for configure
19308 --user
19310 --global
19311 doing a per-user installation
19312 --package-db DB
19314 Append the given package database to the list of package
19315 databases used (to satisfy dependencies and register
19316 into). May be a specific file, 'global' or 'user'. The
19317 initial list is ['global'], ['global', 'user'], or
19318 ['global', $sandbox], depending on context. Use 'clear'
19319 to reset the list to empty. See the user guide for
19320 details.
19321 -f, --flags FLAGS
19323 Force values for the given flags in Cabal conditionals in
19324 the .cabal file. E.g., --flags="debug -usebytestrings"
19325 forces the flag "debug" to true and "usebytestrings" to
19326 false.
19327 --extra-include-dirs PATH
19329 A list of directories to search for header files
19330 --enable-deterministic
19332 --disable-deterministic
19333 Try to be as deterministic as possible (used by the test
19334 suite)
19335 --ipid IPID
19337 Installed package ID to compile this package as
19338 --cid CID
19340 Installed component ID to compile this component as
19341 --extra-lib-dirs PATH
19343 A list of directories to search for external libraries
19344 --extra-framework-dirs PATH
19346 A list of directories to search for external frameworks
19347 (OS X only)
19348 --extra-prog-path PATH
19350 A list of directories to search for required programs (in
19351 addition to the normal search locations)
19352 --instantiate-with NAME=MOD
19354 A mapping of signature names to concrete module instanti‐
19355 ations.
19356 --enable-tests
19358 --disable-tests
19359 dependency checking and compilation for test suites
19360 listed in the package description file.
19361 --enable-coverage
19363 --disable-coverage
19364 build package with Haskell Program Coverage. (GHC only)
19365 --enable-library-coverage
19367 --disable-library-coverage
19368 build package with Haskell Program Coverage. (GHC only)
19369 (DEPRECATED)
19370 --enable-benchmarks
19372 --disable-benchmarks
19373 dependency checking and compilation for benchmarks listed
19374 in the package description file.
19375 --enable-relocatable
19377 --disable-relocatable
19378 building a package that is relocatable. (GHC only)
19379 --disable-response-files
19381 enable workaround for old versions of programs like "ar"
19382 that do not support @file arguments
19383 --with-alex PATH
19385 give the path to alex
19386 --with-ar PATH
19388 give the path to ar
19389 --with-c2hs PATH
19391 give the path to c2hs
19392 --with-cpphs PATH
19394 give the path to cpphs
19395 --with-doctest PATH
19397 give the path to doctest
19398 --with-gcc PATH
19400 give the path to gcc
19401 --with-ghc PATH
19403 give the path to ghc
19404 --with-ghc-pkg PATH
19406 give the path to ghc-pkg
19407 --with-ghcjs PATH
19409 give the path to ghcjs
19410 --with-ghcjs-pkg PATH
19412 give the path to ghcjs-pkg
19413 --with-greencard PATH
19415 give the path to greencard
19416 --with-haddock PATH
19418 give the path to haddock
19419 --with-happy PATH
19421 give the path to happy
19422 --with-haskell-suite PATH
19424 give the path to haskell-suite
19425 --with-haskell-suite-pkg PATH
19427 give the path to haskell-suite-pkg
19428 --with-hmake PATH
19430 give the path to hmake
19431 --with-hpc PATH
19433 give the path to hpc
19434 --with-hsc2hs PATH
19436 give the path to hsc2hs
19437 --with-hscolour PATH
19439 give the path to hscolour
19440 --with-jhc PATH
19442 give the path to jhc
19443 --with-ld PATH
19445 give the path to ld
19446 --with-pkg-config PATH
19448 give the path to pkg-config
19449 --with-runghc PATH
19451 give the path to runghc
19452 --with-strip PATH
19454 give the path to strip
19455 --with-tar PATH
19457 give the path to tar
19458 --with-uhc PATH
19460 give the path to uhc
19461 --alex-option OPT
19463 give an extra option to alex (no need to quote options
19464 containing spaces)
19465 --ar-option OPT
19467 give an extra option to ar (no need to quote options con‐
19468 taining spaces)
19469 --c2hs-option OPT
19471 give an extra option to c2hs (no need to quote options
19472 containing spaces)
19473 --cpphs-option OPT
19475 give an extra option to cpphs (no need to quote options
19476 containing spaces)
19477 --doctest-option OPT
19479 give an extra option to doctest (no need to quote options
19480 containing spaces)
19481 --gcc-option OPT
19483 give an extra option to gcc (no need to quote options
19484 containing spaces)
19485 --ghc-option OPT
19487 give an extra option to ghc (no need to quote options
19488 containing spaces)
19489 --ghc-pkg-option OPT
19491 give an extra option to ghc-pkg (no need to quote options
19492 containing spaces)
19493 --ghcjs-option OPT
19495 give an extra option to ghcjs (no need to quote options
19496 containing spaces)
19497 --ghcjs-pkg-option OPT
19499 give an extra option to ghcjs-pkg (no need to quote
19500 options containing spaces)
19501 --greencard-option OPT
19503 give an extra option to greencard (no need to quote
19504 options containing spaces)
19505 --haddock-option OPT
19507 give an extra option to haddock (no need to quote options
19508 containing spaces)
19509 --happy-option OPT
19511 give an extra option to happy (no need to quote options
19512 containing spaces)
19513 --haskell-suite-option OPT
19515 give an extra option to haskell-suite (no need to quote
19516 options containing spaces)
19517 --haskell-suite-pkg-option OPT
19519 give an extra option to haskell-suite-pkg (no need to
19520 quote options containing spaces)
19521 --hmake-option OPT
19523 give an extra option to hmake (no need to quote options
19524 containing spaces)
19525 --hpc-option OPT
19527 give an extra option to hpc (no need to quote options
19528 containing spaces)
19529 --hsc2hs-option OPT
19531 give an extra option to hsc2hs (no need to quote options
19532 containing spaces)
19533 --hscolour-option OPT
19535 give an extra option to hscolour (no need to quote
19536 options containing spaces)
19537 --jhc-option OPT
19539 give an extra option to jhc (no need to quote options
19540 containing spaces)
19541 --ld-option OPT
19543 give an extra option to ld (no need to quote options con‐
19544 taining spaces)
19545 --pkg-config-option OPT
19547 give an extra option to pkg-config (no need to quote
19548 options containing spaces)
19549 --runghc-option OPT
19551 give an extra option to runghc (no need to quote options
19552 containing spaces)
19553 --strip-option OPT
19555 give an extra option to strip (no need to quote options
19556 containing spaces)
19557 --tar-option OPT
19559 give an extra option to tar (no need to quote options
19560 containing spaces)
19561 --uhc-option OPT
19563 give an extra option to uhc (no need to quote options
19564 containing spaces)
19565 --alex-options OPTS
19567 give extra options to alex
19568 --ar-options OPTS
19570 give extra options to ar
19571 --c2hs-options OPTS
19573 give extra options to c2hs
19574 --cpphs-options OPTS
19576 give extra options to cpphs
19577 --doctest-options OPTS
19579 give extra options to doctest
19580 --gcc-options OPTS
19582 give extra options to gcc
19583 --ghc-options OPTS
19585 give extra options to ghc
19586 --ghc-pkg-options OPTS
19588 give extra options to ghc-pkg
19589 --ghcjs-options OPTS
19591 give extra options to ghcjs
19592 --ghcjs-pkg-options OPTS
19594 give extra options to ghcjs-pkg
19595 --greencard-options OPTS
19597 give extra options to greencard
19598 --haddock-options OPTS
19600 give extra options to haddock
19601 --happy-options OPTS
19603 give extra options to happy
19604 --haskell-suite-options OPTS
19606 give extra options to haskell-suite
19607 --haskell-suite-pkg-options OPTS
19609 give extra options to haskell-suite-pkg
19610 --hmake-options OPTS
19612 give extra options to hmake
19613 --hpc-options OPTS
19615 give extra options to hpc
19616 --hsc2hs-options OPTS
19618 give extra options to hsc2hs
19619 --hscolour-options OPTS
19621 give extra options to hscolour
19622 --jhc-options OPTS
19624 give extra options to jhc
19625 --ld-options OPTS
19627 give extra options to ld
19628 --pkg-config-options OPTS
19630 give extra options to pkg-config
19631 --runghc-options OPTS
19633 give extra options to runghc
19634 --strip-options OPTS
19636 give extra options to strip
19637 --tar-options OPTS
19639 give extra options to tar
19640 --uhc-options OPTS
19642 give extra options to uhc
19643 --cabal-lib-version VERSION
19645 Select which version of the Cabal lib to use to build
19646 packages (useful for testing).
19647 --constraint CONSTRAINT
19649 Specify constraints on a package (version,
19650 installed/source, flags)
19651 --preference CONSTRAINT
19653 Specify preferences (soft constraints) on the version of
19654 a package
19655 --solver SOLVER
19657 Select dependency solver to use (default: modular).
19658 Choices: modular.
19659 --allow-older [DEPS]
19661 Ignore lower bounds in all dependencies or DEPS
19662 --allow-newer [DEPS]
19664 Ignore upper bounds in all dependencies or DEPS
19665 --enable-documentation
19667 --disable-documentation
19668 building of documentation
19669 --doc-index-file TEMPLATE
19671 A central index of haddock API documentation (template
19672 cannot use $pkgid)
19673 --dry-run
19675 Do not install anything, only print what would be
19676 installed.
19677 --max-backjumps NUM
19679 Maximum number of backjumps allowed while solving
19680 (default: 2000). Use a negative number to enable unlim‐
19681 ited backtracking. Use 0 to disable backtracking com‐
19682 pletely.
19683 --reorder-goals
19685 --no-reorder-goals
19686 Try to reorder goals according to certain heuristics.
19687 Slows things down on average, but may make backtracking
19688 faster for some packages.
19689 --count-conflicts
19691 --no-count-conflicts
19692 Try to speed up solving by preferring goals that are
19693 involved in a lot of conflicts (default).
19694 --independent-goals
19696 --no-independent-goals
19697 Treat several goals on the command line as independent.
19698 If several goals depend on the same package, different
19699 versions can be chosen.
19700 --shadow-installed-packages
19702 --no-shadow-installed-packages
19703 If multiple package instances of the same version are
19704 installed, treat all but one as shadowed.
19705 --strong-flags
19707 --no-strong-flags
19708 Do not defer flag choices (this used to be the default in
19709 cabal-install <= 1.20).
19710 --allow-boot-library-installs
19712 --no-allow-boot-library-installs
19713 Allow cabal to install base, ghc-prim, integer-simple,
19714 integer-gmp, and template-haskell.
19715 --reinstall
19717 --no-reinstall
19718 Install even if it means installing the same version
19719 again.
19720 --avoid-reinstalls
19722 --no-avoid-reinstalls
19723 Do not select versions that would destructively overwrite
19724 installed packages.
19725 --force-reinstalls
19727 --no-force-reinstalls
19728 Reinstall packages even if they will most likely break
19729 other installed packages.
19730 --upgrade-dependencies
19732 --no-upgrade-dependencies
19733 Pick the latest version for all dependencies, rather than
19734 trying to pick an installed version.
19735 --only-dependencies
19737 --no-only-dependencies
19738 Install only the dependencies necessary to build the
19739 given packages
19740 --dependencies-only
19742 --no-dependencies-only
19743 A synonym for --only-dependencies
19744 --index-state STATE
19746 Use source package index state as it existed at a previ‐
19747 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
19748 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
19749 'HEAD' (default: 'HEAD').
19750 --root-cmd COMMAND
19752 (No longer supported, do not use.)
19753 --symlink-bindir DIR
19755 Add symlinks to installed executables into this direc‐
19756 tory.
19757 --build-summary TEMPLATE
19759 Save build summaries to file (name template can use
19760 $pkgid, $compiler, $os, $arch)
19761 --build-log TEMPLATE
19763 Log all builds to file (name template can use $pkgid,
19764 $compiler, $os, $arch)
19765 --remote-build-reporting LEVEL
19767 Generate build reports to send to a remote server (none,
19768 anonymous or detailed).
19769 --report-planning-failure
19771 Generate build reports when the dependency solver fails.
19772 This is used by the Hackage build bot.
19773 --enable-per-component
19775 --disable-per-component
19776 Per-component builds when possible
19777 --one-shot
19779 --no-one-shot
19780 Do not record the packages in the world file.
19781 --run-tests
19783 Run package test suites during installation.
19784 -j, --jobs [NUM]
19786 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
19787 given).
19788 --keep-going
19790 After a build failure, continue to build other unaffected
19791 packages.
19792 --offline
19794 --no-offline
19795 Don't download packages from the Internet.
19796 --project-file FILE
19798 Set the name of the cabal.project file to search for in
19799 parent directories
19800 --only
19802 Only installs the package in the current directory.
19803 --haddock-hoogle
19805 Generate a hoogle database
19806 --haddock-html
19808 Generate HTML documentation (the default)
19809 --haddock-html-location URL
19811 Location of HTML documentation for pre-requisite packages
19812 --haddock-for-hackage
19814 Collection of flags to generate documentation suitable
19815 for upload to hackage
19816 --haddock-executables
19818 Run haddock for Executables targets
19819 --haddock-tests
19821 Run haddock for Test Suite targets
19822 --haddock-benchmarks
19824 Run haddock for Benchmark targets
19825 --haddock-all
19827 Run haddock for all targets
19828 --haddock-internal
19830 Run haddock for internal modules and include all symbols
19831 --haddock-css PATH
19833 Use PATH as the haddock stylesheet
19834 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
19836 dock-hyperlinked-source
19837 Hyperlink the documentation to the source code
19838 --haddock-quickjump
19840 Generate an index for interactive documentation naviga‐
19841 tion
19842 --haddock-hscolour-css PATH
19844 Use PATH as the HsColour stylesheet
19845 --haddock-contents-location URL
19847 Bake URL in as the location for the contents page
19848 cabal v1-install
19851 Usage: cabal v1-install [FLAGS]
19853 or: cabal v1-install [FLAGS] PACKAGES
19854 Installs one or more packages. By default, the installed package will
19857 be registered in the user's package database or, if a sandbox is
19858 present in the current directory, inside the sandbox.
19859 If PACKAGES are specified, downloads and installs those packages. Oth‐
19861 erwise, install the package in the current directory (and/or its depen‐
19862 dencies) (there must be exactly one .cabal file in the current direc‐
19863 tory).
19864 When using a sandbox, the flags for `v1-install` only affect the cur‐
19866 rent command and have no effect on future commands. (To achieve that,
19867 `v1-configure` must be used.) In contrast, without a sandbox, the
19868 flags to `v1-install` are saved and affect future commands such as
19869 `v1-build` and `v1-repl`. See the help for `v1-configure` for a list of
19870 commands being affected.
19871 Installed executables will by default (and without a sandbox) be put
19873 into `~/.cabal/bin/`. If you want installed executable to be available
19874 globally, make sure that the PATH environment variable contains that
19875 directory. When using a sandbox, executables will be put into `$SAND‐
19876 BOX/bin/` (by default: `./.cabal-sandbox/bin/`).
19877 When specifying --bindir, consider also specifying --datadir; this way
19879 the sandbox can be deleted and the executable should continue working
19880 as long as bindir and datadir are left untouched.
19881 The flags --with-PROG and --PROG-option(s) can be used with the follow‐
19884 ing programs:
19885 alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard
19886 haddock
19887 happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc
19888 ld
19889 pkg-config runghc strip tar uhc
19890 Examples:
19892 cabal v1-install Package in the current directory
19893 cabal v1-install foo Package from the hackage server
19894 cabal v1-install foo-1.0 Specific version of a package
19895 cabal v1-install 'foo < 2' Constrained package version
19896 cabal v1-install haddock --bindir=$HOME/hask-bin/
19897 --datadir=$HOME/hask-data/
19898 Change installation destination
19899 The v1-install command is a part of the legacy v1 style of cabal usage.
19901 It is a legacy feature and will be removed in a future release of
19903 cabal-install. Please file a bug if you cannot replicate a working v1-
19904 use case with the new-style commands.
19905 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
19907 Flags:
19910 -v, --verbose [n]
19911 Control verbosity (n is 0--3, default verbosity level is
19912 1)
19913 --builddir, --distdir, --distpref DIR
19915 The directory where Cabal puts generated build files
19916 (default dist)
19917 -g, --ghc
19919 compile with GHC
19920 --ghcjs
19922 compile with GHCJS
19923 --uhc
19925 compile with UHC
19926 --haskell-suite
19928 compile with a haskell-suite compiler
19929 --cabal-file PATH
19931 use this Cabal file
19932 -w, --with-compiler PATH
19934 give the path to a particular compiler
19935 --with-hc-pkg PATH
19937 give the path to the package tool
19938 --prefix DIR
19940 bake this prefix in preparation of installation
19941 --bindir DIR
19943 installation directory for executables
19944 --libdir DIR
19946 installation directory for libraries
19947 --libsubdir DIR
19949 subdirectory of libdir in which libs are installed
19950 --dynlibdir DIR
19952 installation directory for dynamic libraries
19953 --libexecdir DIR
19955 installation directory for program executables
19956 --libexecsubdir DIR
19958 subdirectory of libexecdir in which private executables
19959 are installed
19960 --datadir DIR
19962 installation directory for read-only data
19963 --datasubdir DIR
19965 subdirectory of datadir in which data files are installed
19966 --docdir DIR
19968 installation directory for documentation
19969 --htmldir DIR
19971 installation directory for HTML documentation
19972 --haddockdir DIR
19974 installation directory for haddock interfaces
19975 --sysconfdir DIR
19977 installation directory for configuration files
19978 --program-prefix PREFIX
19980 prefix to be applied to installed executables
19981 --program-suffix SUFFIX
19983 suffix to be applied to installed executables
19984 --enable-library-vanilla
19986 --disable-library-vanilla
19987 Vanilla libraries
19988 -p, --enable-library-profiling
19990 --disable-library-profiling
19991 Library profiling
19992 --enable-shared
19994 --disable-shared
19995 Shared library
19996 --enable-static
19998 --disable-static
19999 Static library
20000 --enable-executable-dynamic
20002 --disable-executable-dynamic
20003 Executable dynamic linking
20004 --enable-profiling
20006 --disable-profiling
20007 Executable and library profiling
20008 --enable-executable-profiling
20010 --disable-executable-profiling
20011 Executable profiling (DEPRECATED)
20012 --profiling-detail level
20014 Profiling detail level for executable and library
20015 (default, none, exported-functions, toplevel-functions,
20016 all-functions).
20017 --library-profiling-detail level
20019 Profiling detail level for libraries only.
20020 -O, --enable-optimization, --enable-optimisation [n]
20022 Build with optimization (n is 0--2, default is 1)
20023 --disable-optimization, --disable-optimisation
20025 Build without optimization
20026 --enable-debug-info [n]
20028 Emit debug info (n is 0--3, default is 0)
20029 --disable-debug-info
20031 Don't emit debug info
20032 --enable-library-for-ghci
20034 --disable-library-for-ghci
20035 compile library for use with GHCi
20036 --enable-split-sections
20038 --disable-split-sections
20039 compile library code such that unneeded definitions can
20040 be dropped from the final executable (GHC 7.8+)
20041 --enable-split-objs
20043 --disable-split-objs
20044 split library into smaller objects to reduce binary sizes
20045 (GHC 6.6+)
20046 --enable-executable-stripping
20048 --disable-executable-stripping
20049 strip executables upon installation to reduce binary
20050 sizes
20051 --enable-library-stripping
20053 --disable-library-stripping
20054 strip libraries upon installation to reduce binary sizes
20055 --configure-option OPT
20057 Extra option for configure
20058 --user
20060 --global
20061 doing a per-user installation
20062 --package-db DB
20064 Append the given package database to the list of package
20065 databases used (to satisfy dependencies and register
20066 into). May be a specific file, 'global' or 'user'. The
20067 initial list is ['global'], ['global', 'user'], or
20068 ['global', $sandbox], depending on context. Use 'clear'
20069 to reset the list to empty. See the user guide for
20070 details.
20071 -f, --flags FLAGS
20073 Force values for the given flags in Cabal conditionals in
20074 the .cabal file. E.g., --flags="debug -usebytestrings"
20075 forces the flag "debug" to true and "usebytestrings" to
20076 false.
20077 --extra-include-dirs PATH
20079 A list of directories to search for header files
20080 --enable-deterministic
20082 --disable-deterministic
20083 Try to be as deterministic as possible (used by the test
20084 suite)
20085 --ipid IPID
20087 Installed package ID to compile this package as
20088 --cid CID
20090 Installed component ID to compile this component as
20091 --extra-lib-dirs PATH
20093 A list of directories to search for external libraries
20094 --extra-framework-dirs PATH
20096 A list of directories to search for external frameworks
20097 (OS X only)
20098 --extra-prog-path PATH
20100 A list of directories to search for required programs (in
20101 addition to the normal search locations)
20102 --instantiate-with NAME=MOD
20104 A mapping of signature names to concrete module instanti‐
20105 ations.
20106 --enable-tests
20108 --disable-tests
20109 dependency checking and compilation for test suites
20110 listed in the package description file.
20111 --enable-coverage
20113 --disable-coverage
20114 build package with Haskell Program Coverage. (GHC only)
20115 --enable-library-coverage
20117 --disable-library-coverage
20118 build package with Haskell Program Coverage. (GHC only)
20119 (DEPRECATED)
20120 --enable-benchmarks
20122 --disable-benchmarks
20123 dependency checking and compilation for benchmarks listed
20124 in the package description file.
20125 --enable-relocatable
20127 --disable-relocatable
20128 building a package that is relocatable. (GHC only)
20129 --disable-response-files
20131 enable workaround for old versions of programs like "ar"
20132 that do not support @file arguments
20133 --with-alex PATH
20135 give the path to alex
20136 --with-ar PATH
20138 give the path to ar
20139 --with-c2hs PATH
20141 give the path to c2hs
20142 --with-cpphs PATH
20144 give the path to cpphs
20145 --with-doctest PATH
20147 give the path to doctest
20148 --with-gcc PATH
20150 give the path to gcc
20151 --with-ghc PATH
20153 give the path to ghc
20154 --with-ghc-pkg PATH
20156 give the path to ghc-pkg
20157 --with-ghcjs PATH
20159 give the path to ghcjs
20160 --with-ghcjs-pkg PATH
20162 give the path to ghcjs-pkg
20163 --with-greencard PATH
20165 give the path to greencard
20166 --with-haddock PATH
20168 give the path to haddock
20169 --with-happy PATH
20171 give the path to happy
20172 --with-haskell-suite PATH
20174 give the path to haskell-suite
20175 --with-haskell-suite-pkg PATH
20177 give the path to haskell-suite-pkg
20178 --with-hmake PATH
20180 give the path to hmake
20181 --with-hpc PATH
20183 give the path to hpc
20184 --with-hsc2hs PATH
20186 give the path to hsc2hs
20187 --with-hscolour PATH
20189 give the path to hscolour
20190 --with-jhc PATH
20192 give the path to jhc
20193 --with-ld PATH
20195 give the path to ld
20196 --with-pkg-config PATH
20198 give the path to pkg-config
20199 --with-runghc PATH
20201 give the path to runghc
20202 --with-strip PATH
20204 give the path to strip
20205 --with-tar PATH
20207 give the path to tar
20208 --with-uhc PATH
20210 give the path to uhc
20211 --alex-option OPT
20213 give an extra option to alex (no need to quote options
20214 containing spaces)
20215 --ar-option OPT
20217 give an extra option to ar (no need to quote options con‐
20218 taining spaces)
20219 --c2hs-option OPT
20221 give an extra option to c2hs (no need to quote options
20222 containing spaces)
20223 --cpphs-option OPT
20225 give an extra option to cpphs (no need to quote options
20226 containing spaces)
20227 --doctest-option OPT
20229 give an extra option to doctest (no need to quote options
20230 containing spaces)
20231 --gcc-option OPT
20233 give an extra option to gcc (no need to quote options
20234 containing spaces)
20235 --ghc-option OPT
20237 give an extra option to ghc (no need to quote options
20238 containing spaces)
20239 --ghc-pkg-option OPT
20241 give an extra option to ghc-pkg (no need to quote options
20242 containing spaces)
20243 --ghcjs-option OPT
20245 give an extra option to ghcjs (no need to quote options
20246 containing spaces)
20247 --ghcjs-pkg-option OPT
20249 give an extra option to ghcjs-pkg (no need to quote
20250 options containing spaces)
20251 --greencard-option OPT
20253 give an extra option to greencard (no need to quote
20254 options containing spaces)
20255 --haddock-option OPT
20257 give an extra option to haddock (no need to quote options
20258 containing spaces)
20259 --happy-option OPT
20261 give an extra option to happy (no need to quote options
20262 containing spaces)
20263 --haskell-suite-option OPT
20265 give an extra option to haskell-suite (no need to quote
20266 options containing spaces)
20267 --haskell-suite-pkg-option OPT
20269 give an extra option to haskell-suite-pkg (no need to
20270 quote options containing spaces)
20271 --hmake-option OPT
20273 give an extra option to hmake (no need to quote options
20274 containing spaces)
20275 --hpc-option OPT
20277 give an extra option to hpc (no need to quote options
20278 containing spaces)
20279 --hsc2hs-option OPT
20281 give an extra option to hsc2hs (no need to quote options
20282 containing spaces)
20283 --hscolour-option OPT
20285 give an extra option to hscolour (no need to quote
20286 options containing spaces)
20287 --jhc-option OPT
20289 give an extra option to jhc (no need to quote options
20290 containing spaces)
20291 --ld-option OPT
20293 give an extra option to ld (no need to quote options con‐
20294 taining spaces)
20295 --pkg-config-option OPT
20297 give an extra option to pkg-config (no need to quote
20298 options containing spaces)
20299 --runghc-option OPT
20301 give an extra option to runghc (no need to quote options
20302 containing spaces)
20303 --strip-option OPT
20305 give an extra option to strip (no need to quote options
20306 containing spaces)
20307 --tar-option OPT
20309 give an extra option to tar (no need to quote options
20310 containing spaces)
20311 --uhc-option OPT
20313 give an extra option to uhc (no need to quote options
20314 containing spaces)
20315 --alex-options OPTS
20317 give extra options to alex
20318 --ar-options OPTS
20320 give extra options to ar
20321 --c2hs-options OPTS
20323 give extra options to c2hs
20324 --cpphs-options OPTS
20326 give extra options to cpphs
20327 --doctest-options OPTS
20329 give extra options to doctest
20330 --gcc-options OPTS
20332 give extra options to gcc
20333 --ghc-options OPTS
20335 give extra options to ghc
20336 --ghc-pkg-options OPTS
20338 give extra options to ghc-pkg
20339 --ghcjs-options OPTS
20341 give extra options to ghcjs
20342 --ghcjs-pkg-options OPTS
20344 give extra options to ghcjs-pkg
20345 --greencard-options OPTS
20347 give extra options to greencard
20348 --haddock-options OPTS
20350 give extra options to haddock
20351 --happy-options OPTS
20353 give extra options to happy
20354 --haskell-suite-options OPTS
20356 give extra options to haskell-suite
20357 --haskell-suite-pkg-options OPTS
20359 give extra options to haskell-suite-pkg
20360 --hmake-options OPTS
20362 give extra options to hmake
20363 --hpc-options OPTS
20365 give extra options to hpc
20366 --hsc2hs-options OPTS
20368 give extra options to hsc2hs
20369 --hscolour-options OPTS
20371 give extra options to hscolour
20372 --jhc-options OPTS
20374 give extra options to jhc
20375 --ld-options OPTS
20377 give extra options to ld
20378 --pkg-config-options OPTS
20380 give extra options to pkg-config
20381 --runghc-options OPTS
20383 give extra options to runghc
20384 --strip-options OPTS
20386 give extra options to strip
20387 --tar-options OPTS
20389 give extra options to tar
20390 --uhc-options OPTS
20392 give extra options to uhc
20393 --cabal-lib-version VERSION
20395 Select which version of the Cabal lib to use to build
20396 packages (useful for testing).
20397 --constraint CONSTRAINT
20399 Specify constraints on a package (version,
20400 installed/source, flags)
20401 --preference CONSTRAINT
20403 Specify preferences (soft constraints) on the version of
20404 a package
20405 --solver SOLVER
20407 Select dependency solver to use (default: modular).
20408 Choices: modular.
20409 --allow-older [DEPS]
20411 Ignore lower bounds in all dependencies or DEPS
20412 --allow-newer [DEPS]
20414 Ignore upper bounds in all dependencies or DEPS
20415 --enable-documentation
20417 --disable-documentation
20418 building of documentation
20419 --doc-index-file TEMPLATE
20421 A central index of haddock API documentation (template
20422 cannot use $pkgid)
20423 --dry-run
20425 Do not install anything, only print what would be
20426 installed.
20427 --max-backjumps NUM
20429 Maximum number of backjumps allowed while solving
20430 (default: 2000). Use a negative number to enable unlim‐
20431 ited backtracking. Use 0 to disable backtracking com‐
20432 pletely.
20433 --reorder-goals
20435 --no-reorder-goals
20436 Try to reorder goals according to certain heuristics.
20437 Slows things down on average, but may make backtracking
20438 faster for some packages.
20439 --count-conflicts
20441 --no-count-conflicts
20442 Try to speed up solving by preferring goals that are
20443 involved in a lot of conflicts (default).
20444 --independent-goals
20446 --no-independent-goals
20447 Treat several goals on the command line as independent.
20448 If several goals depend on the same package, different
20449 versions can be chosen.
20450 --shadow-installed-packages
20452 --no-shadow-installed-packages
20453 If multiple package instances of the same version are
20454 installed, treat all but one as shadowed.
20455 --strong-flags
20457 --no-strong-flags
20458 Do not defer flag choices (this used to be the default in
20459 cabal-install <= 1.20).
20460 --allow-boot-library-installs
20462 --no-allow-boot-library-installs
20463 Allow cabal to install base, ghc-prim, integer-simple,
20464 integer-gmp, and template-haskell.
20465 --reinstall
20467 --no-reinstall
20468 Install even if it means installing the same version
20469 again.
20470 --avoid-reinstalls
20472 --no-avoid-reinstalls
20473 Do not select versions that would destructively overwrite
20474 installed packages.
20475 --force-reinstalls
20477 --no-force-reinstalls
20478 Reinstall packages even if they will most likely break
20479 other installed packages.
20480 --upgrade-dependencies
20482 --no-upgrade-dependencies
20483 Pick the latest version for all dependencies, rather than
20484 trying to pick an installed version.
20485 --only-dependencies
20487 --no-only-dependencies
20488 Install only the dependencies necessary to build the
20489 given packages
20490 --dependencies-only
20492 --no-dependencies-only
20493 A synonym for --only-dependencies
20494 --index-state STATE
20496 Use source package index state as it existed at a previ‐
20497 ous time. Accepts unix-timestamps (e.g. '@1474732068'),
20498 ISO8601 UTC timestamps (e.g. '2016-09-24T17:47:48Z'), or
20499 'HEAD' (default: 'HEAD').
20500 --root-cmd COMMAND
20502 (No longer supported, do not use.)
20503 --symlink-bindir DIR
20505 Add symlinks to installed executables into this direc‐
20506 tory.
20507 --build-summary TEMPLATE
20509 Save build summaries to file (name template can use
20510 $pkgid, $compiler, $os, $arch)
20511 --build-log TEMPLATE
20513 Log all builds to file (name template can use $pkgid,
20514 $compiler, $os, $arch)
20515 --remote-build-reporting LEVEL
20517 Generate build reports to send to a remote server (none,
20518 anonymous or detailed).
20519 --report-planning-failure
20521 Generate build reports when the dependency solver fails.
20522 This is used by the Hackage build bot.
20523 --enable-per-component
20525 --disable-per-component
20526 Per-component builds when possible
20527 --one-shot
20529 --no-one-shot
20530 Do not record the packages in the world file.
20531 --run-tests
20533 Run package test suites during installation.
20534 -j, --jobs [NUM]
20536 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
20537 given).
20538 --keep-going
20540 After a build failure, continue to build other unaffected
20541 packages.
20542 --offline
20544 --no-offline
20545 Don't download packages from the Internet.
20546 --project-file FILE
20548 Set the name of the cabal.project file to search for in
20549 parent directories
20550 --only
20552 Only installs the package in the current directory.
20553 --haddock-hoogle
20555 Generate a hoogle database
20556 --haddock-html
20558 Generate HTML documentation (the default)
20559 --haddock-html-location URL
20561 Location of HTML documentation for pre-requisite packages
20562 --haddock-for-hackage
20564 Collection of flags to generate documentation suitable
20565 for upload to hackage
20566 --haddock-executables
20568 Run haddock for Executables targets
20569 --haddock-tests
20571 Run haddock for Test Suite targets
20572 --haddock-benchmarks
20574 Run haddock for Benchmark targets
20575 --haddock-all
20577 Run haddock for all targets
20578 --haddock-internal
20580 Run haddock for internal modules and include all symbols
20581 --haddock-css PATH
20583 Use PATH as the haddock stylesheet
20584 --haddock-hyperlink-source, --haddock-hyperlink-sources, --had‐
20586 dock-hyperlinked-source
20587 Hyperlink the documentation to the source code
20588 --haddock-quickjump
20590 Generate an index for interactive documentation naviga‐
20591 tion
20592 --haddock-hscolour-css PATH
20594 Use PATH as the HsColour stylesheet
20595 --haddock-contents-location URL
20597 Bake URL in as the location for the contents page
20598 cabal run
20601 Usage: cabal run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]
20603 Builds and then runs the specified executable. If no executable is
20606 specified, but the package contains just one executable, that one is
20607 built and executed.
20608 Use `cabal test --show-details=streaming` to run a test-suite and get
20610 its full output.
20611 Examples:
20614 cabal run
20615 Run the only executable in the current package;
20616 cabal run foo -- --fooflag
20617 Works similar to `./foo --fooflag`.
20618 The run command is a part of the legacy v1 style of cabal usage.
20620 Please switch to using either the new project style and the new-run
20622 command or the legacy v1-run alias as new-style projects will become
20623 the default in the next version of cabal-install. Please file a bug if
20624 you cannot replicate a working v1- use case with the new-style com‐
20625 mands.
20626 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
20628 Flags:
20631 -v, --verbose [n]
20632 Control verbosity (n is 0--3, default verbosity level is
20633 1)
20634 --builddir, --distdir, --distpref DIR
20636 The directory where Cabal puts generated build files
20637 (default dist)
20638 -j, --jobs [NUM]
20640 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
20641 given).
20642 --with-alex PATH
20644 give the path to alex
20645 --with-ar PATH
20647 give the path to ar
20648 --with-c2hs PATH
20650 give the path to c2hs
20651 --with-cpphs PATH
20653 give the path to cpphs
20654 --with-doctest PATH
20656 give the path to doctest
20657 --with-gcc PATH
20659 give the path to gcc
20660 --with-ghc PATH
20662 give the path to ghc
20663 --with-ghc-pkg PATH
20665 give the path to ghc-pkg
20666 --with-ghcjs PATH
20668 give the path to ghcjs
20669 --with-ghcjs-pkg PATH
20671 give the path to ghcjs-pkg
20672 --with-greencard PATH
20674 give the path to greencard
20675 --with-haddock PATH
20677 give the path to haddock
20678 --with-happy PATH
20680 give the path to happy
20681 --with-haskell-suite PATH
20683 give the path to haskell-suite
20684 --with-haskell-suite-pkg PATH
20686 give the path to haskell-suite-pkg
20687 --with-hmake PATH
20689 give the path to hmake
20690 --with-hpc PATH
20692 give the path to hpc
20693 --with-hsc2hs PATH
20695 give the path to hsc2hs
20696 --with-hscolour PATH
20698 give the path to hscolour
20699 --with-jhc PATH
20701 give the path to jhc
20702 --with-ld PATH
20704 give the path to ld
20705 --with-pkg-config PATH
20707 give the path to pkg-config
20708 --with-runghc PATH
20710 give the path to runghc
20711 --with-strip PATH
20713 give the path to strip
20714 --with-tar PATH
20716 give the path to tar
20717 --with-uhc PATH
20719 give the path to uhc
20720 --alex-option OPT
20722 give an extra option to alex (no need to quote options
20723 containing spaces)
20724 --ar-option OPT
20726 give an extra option to ar (no need to quote options con‐
20727 taining spaces)
20728 --c2hs-option OPT
20730 give an extra option to c2hs (no need to quote options
20731 containing spaces)
20732 --cpphs-option OPT
20734 give an extra option to cpphs (no need to quote options
20735 containing spaces)
20736 --doctest-option OPT
20738 give an extra option to doctest (no need to quote options
20739 containing spaces)
20740 --gcc-option OPT
20742 give an extra option to gcc (no need to quote options
20743 containing spaces)
20744 --ghc-option OPT
20746 give an extra option to ghc (no need to quote options
20747 containing spaces)
20748 --ghc-pkg-option OPT
20750 give an extra option to ghc-pkg (no need to quote options
20751 containing spaces)
20752 --ghcjs-option OPT
20754 give an extra option to ghcjs (no need to quote options
20755 containing spaces)
20756 --ghcjs-pkg-option OPT
20758 give an extra option to ghcjs-pkg (no need to quote
20759 options containing spaces)
20760 --greencard-option OPT
20762 give an extra option to greencard (no need to quote
20763 options containing spaces)
20764 --haddock-option OPT
20766 give an extra option to haddock (no need to quote options
20767 containing spaces)
20768 --happy-option OPT
20770 give an extra option to happy (no need to quote options
20771 containing spaces)
20772 --haskell-suite-option OPT
20774 give an extra option to haskell-suite (no need to quote
20775 options containing spaces)
20776 --haskell-suite-pkg-option OPT
20778 give an extra option to haskell-suite-pkg (no need to
20779 quote options containing spaces)
20780 --hmake-option OPT
20782 give an extra option to hmake (no need to quote options
20783 containing spaces)
20784 --hpc-option OPT
20786 give an extra option to hpc (no need to quote options
20787 containing spaces)
20788 --hsc2hs-option OPT
20790 give an extra option to hsc2hs (no need to quote options
20791 containing spaces)
20792 --hscolour-option OPT
20794 give an extra option to hscolour (no need to quote
20795 options containing spaces)
20796 --jhc-option OPT
20798 give an extra option to jhc (no need to quote options
20799 containing spaces)
20800 --ld-option OPT
20802 give an extra option to ld (no need to quote options con‐
20803 taining spaces)
20804 --pkg-config-option OPT
20806 give an extra option to pkg-config (no need to quote
20807 options containing spaces)
20808 --runghc-option OPT
20810 give an extra option to runghc (no need to quote options
20811 containing spaces)
20812 --strip-option OPT
20814 give an extra option to strip (no need to quote options
20815 containing spaces)
20816 --tar-option OPT
20818 give an extra option to tar (no need to quote options
20819 containing spaces)
20820 --uhc-option OPT
20822 give an extra option to uhc (no need to quote options
20823 containing spaces)
20824 --alex-options OPTS
20826 give extra options to alex
20827 --ar-options OPTS
20829 give extra options to ar
20830 --c2hs-options OPTS
20832 give extra options to c2hs
20833 --cpphs-options OPTS
20835 give extra options to cpphs
20836 --doctest-options OPTS
20838 give extra options to doctest
20839 --gcc-options OPTS
20841 give extra options to gcc
20842 --ghc-options OPTS
20844 give extra options to ghc
20845 --ghc-pkg-options OPTS
20847 give extra options to ghc-pkg
20848 --ghcjs-options OPTS
20850 give extra options to ghcjs
20851 --ghcjs-pkg-options OPTS
20853 give extra options to ghcjs-pkg
20854 --greencard-options OPTS
20856 give extra options to greencard
20857 --haddock-options OPTS
20859 give extra options to haddock
20860 --happy-options OPTS
20862 give extra options to happy
20863 --haskell-suite-options OPTS
20865 give extra options to haskell-suite
20866 --haskell-suite-pkg-options OPTS
20868 give extra options to haskell-suite-pkg
20869 --hmake-options OPTS
20871 give extra options to hmake
20872 --hpc-options OPTS
20874 give extra options to hpc
20875 --hsc2hs-options OPTS
20877 give extra options to hsc2hs
20878 --hscolour-options OPTS
20880 give extra options to hscolour
20881 --jhc-options OPTS
20883 give extra options to jhc
20884 --ld-options OPTS
20886 give extra options to ld
20887 --pkg-config-options OPTS
20889 give extra options to pkg-config
20890 --runghc-options OPTS
20892 give extra options to runghc
20893 --strip-options OPTS
20895 give extra options to strip
20896 --tar-options OPTS
20898 give extra options to tar
20899 --uhc-options OPTS
20901 give extra options to uhc
20902 --only
20904 Don't reinstall add-source dependencies (sandbox-only)
20905 cabal v1-run
20908 Usage: cabal v1-run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]
20910 Builds and then runs the specified executable. If no executable is
20913 specified, but the package contains just one executable, that one is
20914 built and executed.
20915 Use `cabal v1-test --show-details=streaming` to run a test-suite and
20917 get its full output.
20918 Examples:
20921 cabal v1-run
20922 Run the only executable in the current package;
20923 cabal v1-run foo -- --fooflag
20924 Works similar to `./foo --fooflag`.
20925 The v1-run command is a part of the legacy v1 style of cabal usage.
20927 It is a legacy feature and will be removed in a future release of
20929 cabal-install. Please file a bug if you cannot replicate a working v1-
20930 use case with the new-style commands.
20931 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
20933 Flags:
20936 -v, --verbose [n]
20937 Control verbosity (n is 0--3, default verbosity level is
20938 1)
20939 --builddir, --distdir, --distpref DIR
20941 The directory where Cabal puts generated build files
20942 (default dist)
20943 -j, --jobs [NUM]
20945 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
20946 given).
20947 --with-alex PATH
20949 give the path to alex
20950 --with-ar PATH
20952 give the path to ar
20953 --with-c2hs PATH
20955 give the path to c2hs
20956 --with-cpphs PATH
20958 give the path to cpphs
20959 --with-doctest PATH
20961 give the path to doctest
20962 --with-gcc PATH
20964 give the path to gcc
20965 --with-ghc PATH
20967 give the path to ghc
20968 --with-ghc-pkg PATH
20970 give the path to ghc-pkg
20971 --with-ghcjs PATH
20973 give the path to ghcjs
20974 --with-ghcjs-pkg PATH
20976 give the path to ghcjs-pkg
20977 --with-greencard PATH
20979 give the path to greencard
20980 --with-haddock PATH
20982 give the path to haddock
20983 --with-happy PATH
20985 give the path to happy
20986 --with-haskell-suite PATH
20988 give the path to haskell-suite
20989 --with-haskell-suite-pkg PATH
20991 give the path to haskell-suite-pkg
20992 --with-hmake PATH
20994 give the path to hmake
20995 --with-hpc PATH
20997 give the path to hpc
20998 --with-hsc2hs PATH
21000 give the path to hsc2hs
21001 --with-hscolour PATH
21003 give the path to hscolour
21004 --with-jhc PATH
21006 give the path to jhc
21007 --with-ld PATH
21009 give the path to ld
21010 --with-pkg-config PATH
21012 give the path to pkg-config
21013 --with-runghc PATH
21015 give the path to runghc
21016 --with-strip PATH
21018 give the path to strip
21019 --with-tar PATH
21021 give the path to tar
21022 --with-uhc PATH
21024 give the path to uhc
21025 --alex-option OPT
21027 give an extra option to alex (no need to quote options
21028 containing spaces)
21029 --ar-option OPT
21031 give an extra option to ar (no need to quote options con‐
21032 taining spaces)
21033 --c2hs-option OPT
21035 give an extra option to c2hs (no need to quote options
21036 containing spaces)
21037 --cpphs-option OPT
21039 give an extra option to cpphs (no need to quote options
21040 containing spaces)
21041 --doctest-option OPT
21043 give an extra option to doctest (no need to quote options
21044 containing spaces)
21045 --gcc-option OPT
21047 give an extra option to gcc (no need to quote options
21048 containing spaces)
21049 --ghc-option OPT
21051 give an extra option to ghc (no need to quote options
21052 containing spaces)
21053 --ghc-pkg-option OPT
21055 give an extra option to ghc-pkg (no need to quote options
21056 containing spaces)
21057 --ghcjs-option OPT
21059 give an extra option to ghcjs (no need to quote options
21060 containing spaces)
21061 --ghcjs-pkg-option OPT
21063 give an extra option to ghcjs-pkg (no need to quote
21064 options containing spaces)
21065 --greencard-option OPT
21067 give an extra option to greencard (no need to quote
21068 options containing spaces)
21069 --haddock-option OPT
21071 give an extra option to haddock (no need to quote options
21072 containing spaces)
21073 --happy-option OPT
21075 give an extra option to happy (no need to quote options
21076 containing spaces)
21077 --haskell-suite-option OPT
21079 give an extra option to haskell-suite (no need to quote
21080 options containing spaces)
21081 --haskell-suite-pkg-option OPT
21083 give an extra option to haskell-suite-pkg (no need to
21084 quote options containing spaces)
21085 --hmake-option OPT
21087 give an extra option to hmake (no need to quote options
21088 containing spaces)
21089 --hpc-option OPT
21091 give an extra option to hpc (no need to quote options
21092 containing spaces)
21093 --hsc2hs-option OPT
21095 give an extra option to hsc2hs (no need to quote options
21096 containing spaces)
21097 --hscolour-option OPT
21099 give an extra option to hscolour (no need to quote
21100 options containing spaces)
21101 --jhc-option OPT
21103 give an extra option to jhc (no need to quote options
21104 containing spaces)
21105 --ld-option OPT
21107 give an extra option to ld (no need to quote options con‐
21108 taining spaces)
21109 --pkg-config-option OPT
21111 give an extra option to pkg-config (no need to quote
21112 options containing spaces)
21113 --runghc-option OPT
21115 give an extra option to runghc (no need to quote options
21116 containing spaces)
21117 --strip-option OPT
21119 give an extra option to strip (no need to quote options
21120 containing spaces)
21121 --tar-option OPT
21123 give an extra option to tar (no need to quote options
21124 containing spaces)
21125 --uhc-option OPT
21127 give an extra option to uhc (no need to quote options
21128 containing spaces)
21129 --alex-options OPTS
21131 give extra options to alex
21132 --ar-options OPTS
21134 give extra options to ar
21135 --c2hs-options OPTS
21137 give extra options to c2hs
21138 --cpphs-options OPTS
21140 give extra options to cpphs
21141 --doctest-options OPTS
21143 give extra options to doctest
21144 --gcc-options OPTS
21146 give extra options to gcc
21147 --ghc-options OPTS
21149 give extra options to ghc
21150 --ghc-pkg-options OPTS
21152 give extra options to ghc-pkg
21153 --ghcjs-options OPTS
21155 give extra options to ghcjs
21156 --ghcjs-pkg-options OPTS
21158 give extra options to ghcjs-pkg
21159 --greencard-options OPTS
21161 give extra options to greencard
21162 --haddock-options OPTS
21164 give extra options to haddock
21165 --happy-options OPTS
21167 give extra options to happy
21168 --haskell-suite-options OPTS
21170 give extra options to haskell-suite
21171 --haskell-suite-pkg-options OPTS
21173 give extra options to haskell-suite-pkg
21174 --hmake-options OPTS
21176 give extra options to hmake
21177 --hpc-options OPTS
21179 give extra options to hpc
21180 --hsc2hs-options OPTS
21182 give extra options to hsc2hs
21183 --hscolour-options OPTS
21185 give extra options to hscolour
21186 --jhc-options OPTS
21188 give extra options to jhc
21189 --ld-options OPTS
21191 give extra options to ld
21192 --pkg-config-options OPTS
21194 give extra options to pkg-config
21195 --runghc-options OPTS
21197 give extra options to runghc
21198 --strip-options OPTS
21200 give extra options to strip
21201 --tar-options OPTS
21203 give extra options to tar
21204 --uhc-options OPTS
21206 give extra options to uhc
21207 --only
21209 Don't reinstall add-source dependencies (sandbox-only)
21210 cabal test
21213 Usage: cabal test [FLAGS]
21215 or: cabal test TESTCOMPONENTS [FLAGS]
21216 If necessary (re)configures with `--enable-tests` flag and builds the
21219 test suite.
21220 Remember that the tests' dependencies must be installed if there are
21222 additional ones; e.g. with `cabal install --only-dependencies --enable-
21223 tests`.
21224 By defining UserHooks in a custom Setup.hs, the package can define
21226 actions to be executed before and after running tests.
21227 The test command is a part of the legacy v1 style of cabal usage.
21230 Please switch to using either the new project style and the new-test
21232 command or the legacy v1-test alias as new-style projects will become
21233 the default in the next version of cabal-install. Please file a bug if
21234 you cannot replicate a working v1- use case with the new-style com‐
21235 mands.
21236 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
21238 Flags:
21241 -v, --verbose [n]
21242 Control verbosity (n is 0--3, default verbosity level is
21243 1)
21244 --builddir, --distdir, --distpref DIR
21246 The directory where Cabal puts generated build files
21247 (default dist)
21248 --log TEMPLATE
21250 Log all test suite results to file (name template can use
21251 $pkgid, $compiler, $os, $arch, $test-suite, $result)
21252 --machine-log TEMPLATE
21254 Produce a machine-readable log file (name template can
21255 use $pkgid, $compiler, $os, $arch, $result)
21256 --show-details FILTER
21258 --keep-tix-files
21260 keep .tix files for HPC between test runs
21261 --test-options TEMPLATES
21263 give extra options to test executables (name templates
21264 can use $pkgid, $compiler, $os, $arch, $test-suite)
21265 --test-option TEMPLATE
21267 give extra option to test executables (no need to quote
21268 options containing spaces, name template can use $pkgid,
21269 $compiler, $os, $arch, $test-suite)
21270 -j, --jobs [NUM]
21272 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
21273 given).
21274 --with-alex PATH
21276 give the path to alex
21277 --with-ar PATH
21279 give the path to ar
21280 --with-c2hs PATH
21282 give the path to c2hs
21283 --with-cpphs PATH
21285 give the path to cpphs
21286 --with-doctest PATH
21288 give the path to doctest
21289 --with-gcc PATH
21291 give the path to gcc
21292 --with-ghc PATH
21294 give the path to ghc
21295 --with-ghc-pkg PATH
21297 give the path to ghc-pkg
21298 --with-ghcjs PATH
21300 give the path to ghcjs
21301 --with-ghcjs-pkg PATH
21303 give the path to ghcjs-pkg
21304 --with-greencard PATH
21306 give the path to greencard
21307 --with-haddock PATH
21309 give the path to haddock
21310 --with-happy PATH
21312 give the path to happy
21313 --with-haskell-suite PATH
21315 give the path to haskell-suite
21316 --with-haskell-suite-pkg PATH
21318 give the path to haskell-suite-pkg
21319 --with-hmake PATH
21321 give the path to hmake
21322 --with-hpc PATH
21324 give the path to hpc
21325 --with-hsc2hs PATH
21327 give the path to hsc2hs
21328 --with-hscolour PATH
21330 give the path to hscolour
21331 --with-jhc PATH
21333 give the path to jhc
21334 --with-ld PATH
21336 give the path to ld
21337 --with-pkg-config PATH
21339 give the path to pkg-config
21340 --with-runghc PATH
21342 give the path to runghc
21343 --with-strip PATH
21345 give the path to strip
21346 --with-tar PATH
21348 give the path to tar
21349 --with-uhc PATH
21351 give the path to uhc
21352 --alex-option OPT
21354 give an extra option to alex (no need to quote options
21355 containing spaces)
21356 --ar-option OPT
21358 give an extra option to ar (no need to quote options con‐
21359 taining spaces)
21360 --c2hs-option OPT
21362 give an extra option to c2hs (no need to quote options
21363 containing spaces)
21364 --cpphs-option OPT
21366 give an extra option to cpphs (no need to quote options
21367 containing spaces)
21368 --doctest-option OPT
21370 give an extra option to doctest (no need to quote options
21371 containing spaces)
21372 --gcc-option OPT
21374 give an extra option to gcc (no need to quote options
21375 containing spaces)
21376 --ghc-option OPT
21378 give an extra option to ghc (no need to quote options
21379 containing spaces)
21380 --ghc-pkg-option OPT
21382 give an extra option to ghc-pkg (no need to quote options
21383 containing spaces)
21384 --ghcjs-option OPT
21386 give an extra option to ghcjs (no need to quote options
21387 containing spaces)
21388 --ghcjs-pkg-option OPT
21390 give an extra option to ghcjs-pkg (no need to quote
21391 options containing spaces)
21392 --greencard-option OPT
21394 give an extra option to greencard (no need to quote
21395 options containing spaces)
21396 --haddock-option OPT
21398 give an extra option to haddock (no need to quote options
21399 containing spaces)
21400 --happy-option OPT
21402 give an extra option to happy (no need to quote options
21403 containing spaces)
21404 --haskell-suite-option OPT
21406 give an extra option to haskell-suite (no need to quote
21407 options containing spaces)
21408 --haskell-suite-pkg-option OPT
21410 give an extra option to haskell-suite-pkg (no need to
21411 quote options containing spaces)
21412 --hmake-option OPT
21414 give an extra option to hmake (no need to quote options
21415 containing spaces)
21416 --hpc-option OPT
21418 give an extra option to hpc (no need to quote options
21419 containing spaces)
21420 --hsc2hs-option OPT
21422 give an extra option to hsc2hs (no need to quote options
21423 containing spaces)
21424 --hscolour-option OPT
21426 give an extra option to hscolour (no need to quote
21427 options containing spaces)
21428 --jhc-option OPT
21430 give an extra option to jhc (no need to quote options
21431 containing spaces)
21432 --ld-option OPT
21434 give an extra option to ld (no need to quote options con‐
21435 taining spaces)
21436 --pkg-config-option OPT
21438 give an extra option to pkg-config (no need to quote
21439 options containing spaces)
21440 --runghc-option OPT
21442 give an extra option to runghc (no need to quote options
21443 containing spaces)
21444 --strip-option OPT
21446 give an extra option to strip (no need to quote options
21447 containing spaces)
21448 --tar-option OPT
21450 give an extra option to tar (no need to quote options
21451 containing spaces)
21452 --uhc-option OPT
21454 give an extra option to uhc (no need to quote options
21455 containing spaces)
21456 --alex-options OPTS
21458 give extra options to alex
21459 --ar-options OPTS
21461 give extra options to ar
21462 --c2hs-options OPTS
21464 give extra options to c2hs
21465 --cpphs-options OPTS
21467 give extra options to cpphs
21468 --doctest-options OPTS
21470 give extra options to doctest
21471 --gcc-options OPTS
21473 give extra options to gcc
21474 --ghc-options OPTS
21476 give extra options to ghc
21477 --ghc-pkg-options OPTS
21479 give extra options to ghc-pkg
21480 --ghcjs-options OPTS
21482 give extra options to ghcjs
21483 --ghcjs-pkg-options OPTS
21485 give extra options to ghcjs-pkg
21486 --greencard-options OPTS
21488 give extra options to greencard
21489 --haddock-options OPTS
21491 give extra options to haddock
21492 --happy-options OPTS
21494 give extra options to happy
21495 --haskell-suite-options OPTS
21497 give extra options to haskell-suite
21498 --haskell-suite-pkg-options OPTS
21500 give extra options to haskell-suite-pkg
21501 --hmake-options OPTS
21503 give extra options to hmake
21504 --hpc-options OPTS
21506 give extra options to hpc
21507 --hsc2hs-options OPTS
21509 give extra options to hsc2hs
21510 --hscolour-options OPTS
21512 give extra options to hscolour
21513 --jhc-options OPTS
21515 give extra options to jhc
21516 --ld-options OPTS
21518 give extra options to ld
21519 --pkg-config-options OPTS
21521 give extra options to pkg-config
21522 --runghc-options OPTS
21524 give extra options to runghc
21525 --strip-options OPTS
21527 give extra options to strip
21528 --tar-options OPTS
21530 give extra options to tar
21531 --uhc-options OPTS
21533 give extra options to uhc
21534 --only
21536 Don't reinstall add-source dependencies (sandbox-only)
21537 cabal v1-test
21540 Usage: cabal v1-test [FLAGS]
21542 or: cabal v1-test TESTCOMPONENTS [FLAGS]
21543 If necessary (re)configures with `--enable-tests` flag and builds the
21546 test suite.
21547 Remember that the tests' dependencies must be installed if there are
21549 additional ones; e.g. with `cabal v1-install --only-dependencies
21550 --enable-tests`.
21551 By defining UserHooks in a custom Setup.hs, the package can define
21553 actions to be executed before and after running tests.
21554 The v1-test command is a part of the legacy v1 style of cabal usage.
21557 It is a legacy feature and will be removed in a future release of
21559 cabal-install. Please file a bug if you cannot replicate a working v1-
21560 use case with the new-style commands.
21561 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
21563 Flags:
21566 -v, --verbose [n]
21567 Control verbosity (n is 0--3, default verbosity level is
21568 1)
21569 --builddir, --distdir, --distpref DIR
21571 The directory where Cabal puts generated build files
21572 (default dist)
21573 --log TEMPLATE
21575 Log all test suite results to file (name template can use
21576 $pkgid, $compiler, $os, $arch, $test-suite, $result)
21577 --machine-log TEMPLATE
21579 Produce a machine-readable log file (name template can
21580 use $pkgid, $compiler, $os, $arch, $result)
21581 --show-details FILTER
21583 --keep-tix-files
21585 keep .tix files for HPC between test runs
21586 --test-options TEMPLATES
21588 give extra options to test executables (name templates
21589 can use $pkgid, $compiler, $os, $arch, $test-suite)
21590 --test-option TEMPLATE
21592 give extra option to test executables (no need to quote
21593 options containing spaces, name template can use $pkgid,
21594 $compiler, $os, $arch, $test-suite)
21595 -j, --jobs [NUM]
21597 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
21598 given).
21599 --with-alex PATH
21601 give the path to alex
21602 --with-ar PATH
21604 give the path to ar
21605 --with-c2hs PATH
21607 give the path to c2hs
21608 --with-cpphs PATH
21610 give the path to cpphs
21611 --with-doctest PATH
21613 give the path to doctest
21614 --with-gcc PATH
21616 give the path to gcc
21617 --with-ghc PATH
21619 give the path to ghc
21620 --with-ghc-pkg PATH
21622 give the path to ghc-pkg
21623 --with-ghcjs PATH
21625 give the path to ghcjs
21626 --with-ghcjs-pkg PATH
21628 give the path to ghcjs-pkg
21629 --with-greencard PATH
21631 give the path to greencard
21632 --with-haddock PATH
21634 give the path to haddock
21635 --with-happy PATH
21637 give the path to happy
21638 --with-haskell-suite PATH
21640 give the path to haskell-suite
21641 --with-haskell-suite-pkg PATH
21643 give the path to haskell-suite-pkg
21644 --with-hmake PATH
21646 give the path to hmake
21647 --with-hpc PATH
21649 give the path to hpc
21650 --with-hsc2hs PATH
21652 give the path to hsc2hs
21653 --with-hscolour PATH
21655 give the path to hscolour
21656 --with-jhc PATH
21658 give the path to jhc
21659 --with-ld PATH
21661 give the path to ld
21662 --with-pkg-config PATH
21664 give the path to pkg-config
21665 --with-runghc PATH
21667 give the path to runghc
21668 --with-strip PATH
21670 give the path to strip
21671 --with-tar PATH
21673 give the path to tar
21674 --with-uhc PATH
21676 give the path to uhc
21677 --alex-option OPT
21679 give an extra option to alex (no need to quote options
21680 containing spaces)
21681 --ar-option OPT
21683 give an extra option to ar (no need to quote options con‐
21684 taining spaces)
21685 --c2hs-option OPT
21687 give an extra option to c2hs (no need to quote options
21688 containing spaces)
21689 --cpphs-option OPT
21691 give an extra option to cpphs (no need to quote options
21692 containing spaces)
21693 --doctest-option OPT
21695 give an extra option to doctest (no need to quote options
21696 containing spaces)
21697 --gcc-option OPT
21699 give an extra option to gcc (no need to quote options
21700 containing spaces)
21701 --ghc-option OPT
21703 give an extra option to ghc (no need to quote options
21704 containing spaces)
21705 --ghc-pkg-option OPT
21707 give an extra option to ghc-pkg (no need to quote options
21708 containing spaces)
21709 --ghcjs-option OPT
21711 give an extra option to ghcjs (no need to quote options
21712 containing spaces)
21713 --ghcjs-pkg-option OPT
21715 give an extra option to ghcjs-pkg (no need to quote
21716 options containing spaces)
21717 --greencard-option OPT
21719 give an extra option to greencard (no need to quote
21720 options containing spaces)
21721 --haddock-option OPT
21723 give an extra option to haddock (no need to quote options
21724 containing spaces)
21725 --happy-option OPT
21727 give an extra option to happy (no need to quote options
21728 containing spaces)
21729 --haskell-suite-option OPT
21731 give an extra option to haskell-suite (no need to quote
21732 options containing spaces)
21733 --haskell-suite-pkg-option OPT
21735 give an extra option to haskell-suite-pkg (no need to
21736 quote options containing spaces)
21737 --hmake-option OPT
21739 give an extra option to hmake (no need to quote options
21740 containing spaces)
21741 --hpc-option OPT
21743 give an extra option to hpc (no need to quote options
21744 containing spaces)
21745 --hsc2hs-option OPT
21747 give an extra option to hsc2hs (no need to quote options
21748 containing spaces)
21749 --hscolour-option OPT
21751 give an extra option to hscolour (no need to quote
21752 options containing spaces)
21753 --jhc-option OPT
21755 give an extra option to jhc (no need to quote options
21756 containing spaces)
21757 --ld-option OPT
21759 give an extra option to ld (no need to quote options con‐
21760 taining spaces)
21761 --pkg-config-option OPT
21763 give an extra option to pkg-config (no need to quote
21764 options containing spaces)
21765 --runghc-option OPT
21767 give an extra option to runghc (no need to quote options
21768 containing spaces)
21769 --strip-option OPT
21771 give an extra option to strip (no need to quote options
21772 containing spaces)
21773 --tar-option OPT
21775 give an extra option to tar (no need to quote options
21776 containing spaces)
21777 --uhc-option OPT
21779 give an extra option to uhc (no need to quote options
21780 containing spaces)
21781 --alex-options OPTS
21783 give extra options to alex
21784 --ar-options OPTS
21786 give extra options to ar
21787 --c2hs-options OPTS
21789 give extra options to c2hs
21790 --cpphs-options OPTS
21792 give extra options to cpphs
21793 --doctest-options OPTS
21795 give extra options to doctest
21796 --gcc-options OPTS
21798 give extra options to gcc
21799 --ghc-options OPTS
21801 give extra options to ghc
21802 --ghc-pkg-options OPTS
21804 give extra options to ghc-pkg
21805 --ghcjs-options OPTS
21807 give extra options to ghcjs
21808 --ghcjs-pkg-options OPTS
21810 give extra options to ghcjs-pkg
21811 --greencard-options OPTS
21813 give extra options to greencard
21814 --haddock-options OPTS
21816 give extra options to haddock
21817 --happy-options OPTS
21819 give extra options to happy
21820 --haskell-suite-options OPTS
21822 give extra options to haskell-suite
21823 --haskell-suite-pkg-options OPTS
21825 give extra options to haskell-suite-pkg
21826 --hmake-options OPTS
21828 give extra options to hmake
21829 --hpc-options OPTS
21831 give extra options to hpc
21832 --hsc2hs-options OPTS
21834 give extra options to hsc2hs
21835 --hscolour-options OPTS
21837 give extra options to hscolour
21838 --jhc-options OPTS
21840 give extra options to jhc
21841 --ld-options OPTS
21843 give extra options to ld
21844 --pkg-config-options OPTS
21846 give extra options to pkg-config
21847 --runghc-options OPTS
21849 give extra options to runghc
21850 --strip-options OPTS
21852 give extra options to strip
21853 --tar-options OPTS
21855 give extra options to tar
21856 --uhc-options OPTS
21858 give extra options to uhc
21859 --only
21861 Don't reinstall add-source dependencies (sandbox-only)
21862 cabal bench
21865 Usage: cabal bench [FLAGS]
21867 or: cabal bench BENCHCOMPONENTS [FLAGS]
21868 If necessary (re)configures with `--enable-benchmarks` flag and builds
21871 the benchmarks.
21872 Remember that the benchmarks' dependencies must be installed if there
21874 are additional ones; e.g. with `cabal install --only-dependencies
21875 --enable-benchmarks`.
21876 By defining UserHooks in a custom Setup.hs, the package can define
21878 actions to be executed before and after running benchmarks.
21879 The bench command is a part of the legacy v1 style of cabal usage.
21882 Please switch to using either the new project style and the new-bench
21884 command or the legacy v1-bench alias as new-style projects will become
21885 the default in the next version of cabal-install. Please file a bug if
21886 you cannot replicate a working v1- use case with the new-style com‐
21887 mands.
21888 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
21890 Flags:
21893 -v, --verbose [n]
21894 Control verbosity (n is 0--3, default verbosity level is
21895 1)
21896 --builddir, --distdir, --distpref DIR
21898 The directory where Cabal puts generated build files
21899 (default dist)
21900 --benchmark-options TEMPLATES
21902 give extra options to benchmark executables (name tem‐
21903 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
21904 --benchmark-option TEMPLATE
21906 give extra option to benchmark executables (no need to
21907 quote options containing spaces, name template can use
21908 $pkgid, $compiler, $os, $arch, $benchmark)
21909 -j, --jobs [NUM]
21911 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
21912 given).
21913 --with-alex PATH
21915 give the path to alex
21916 --with-ar PATH
21918 give the path to ar
21919 --with-c2hs PATH
21921 give the path to c2hs
21922 --with-cpphs PATH
21924 give the path to cpphs
21925 --with-doctest PATH
21927 give the path to doctest
21928 --with-gcc PATH
21930 give the path to gcc
21931 --with-ghc PATH
21933 give the path to ghc
21934 --with-ghc-pkg PATH
21936 give the path to ghc-pkg
21937 --with-ghcjs PATH
21939 give the path to ghcjs
21940 --with-ghcjs-pkg PATH
21942 give the path to ghcjs-pkg
21943 --with-greencard PATH
21945 give the path to greencard
21946 --with-haddock PATH
21948 give the path to haddock
21949 --with-happy PATH
21951 give the path to happy
21952 --with-haskell-suite PATH
21954 give the path to haskell-suite
21955 --with-haskell-suite-pkg PATH
21957 give the path to haskell-suite-pkg
21958 --with-hmake PATH
21960 give the path to hmake
21961 --with-hpc PATH
21963 give the path to hpc
21964 --with-hsc2hs PATH
21966 give the path to hsc2hs
21967 --with-hscolour PATH
21969 give the path to hscolour
21970 --with-jhc PATH
21972 give the path to jhc
21973 --with-ld PATH
21975 give the path to ld
21976 --with-pkg-config PATH
21978 give the path to pkg-config
21979 --with-runghc PATH
21981 give the path to runghc
21982 --with-strip PATH
21984 give the path to strip
21985 --with-tar PATH
21987 give the path to tar
21988 --with-uhc PATH
21990 give the path to uhc
21991 --alex-option OPT
21993 give an extra option to alex (no need to quote options
21994 containing spaces)
21995 --ar-option OPT
21997 give an extra option to ar (no need to quote options con‐
21998 taining spaces)
21999 --c2hs-option OPT
22001 give an extra option to c2hs (no need to quote options
22002 containing spaces)
22003 --cpphs-option OPT
22005 give an extra option to cpphs (no need to quote options
22006 containing spaces)
22007 --doctest-option OPT
22009 give an extra option to doctest (no need to quote options
22010 containing spaces)
22011 --gcc-option OPT
22013 give an extra option to gcc (no need to quote options
22014 containing spaces)
22015 --ghc-option OPT
22017 give an extra option to ghc (no need to quote options
22018 containing spaces)
22019 --ghc-pkg-option OPT
22021 give an extra option to ghc-pkg (no need to quote options
22022 containing spaces)
22023 --ghcjs-option OPT
22025 give an extra option to ghcjs (no need to quote options
22026 containing spaces)
22027 --ghcjs-pkg-option OPT
22029 give an extra option to ghcjs-pkg (no need to quote
22030 options containing spaces)
22031 --greencard-option OPT
22033 give an extra option to greencard (no need to quote
22034 options containing spaces)
22035 --haddock-option OPT
22037 give an extra option to haddock (no need to quote options
22038 containing spaces)
22039 --happy-option OPT
22041 give an extra option to happy (no need to quote options
22042 containing spaces)
22043 --haskell-suite-option OPT
22045 give an extra option to haskell-suite (no need to quote
22046 options containing spaces)
22047 --haskell-suite-pkg-option OPT
22049 give an extra option to haskell-suite-pkg (no need to
22050 quote options containing spaces)
22051 --hmake-option OPT
22053 give an extra option to hmake (no need to quote options
22054 containing spaces)
22055 --hpc-option OPT
22057 give an extra option to hpc (no need to quote options
22058 containing spaces)
22059 --hsc2hs-option OPT
22061 give an extra option to hsc2hs (no need to quote options
22062 containing spaces)
22063 --hscolour-option OPT
22065 give an extra option to hscolour (no need to quote
22066 options containing spaces)
22067 --jhc-option OPT
22069 give an extra option to jhc (no need to quote options
22070 containing spaces)
22071 --ld-option OPT
22073 give an extra option to ld (no need to quote options con‐
22074 taining spaces)
22075 --pkg-config-option OPT
22077 give an extra option to pkg-config (no need to quote
22078 options containing spaces)
22079 --runghc-option OPT
22081 give an extra option to runghc (no need to quote options
22082 containing spaces)
22083 --strip-option OPT
22085 give an extra option to strip (no need to quote options
22086 containing spaces)
22087 --tar-option OPT
22089 give an extra option to tar (no need to quote options
22090 containing spaces)
22091 --uhc-option OPT
22093 give an extra option to uhc (no need to quote options
22094 containing spaces)
22095 --alex-options OPTS
22097 give extra options to alex
22098 --ar-options OPTS
22100 give extra options to ar
22101 --c2hs-options OPTS
22103 give extra options to c2hs
22104 --cpphs-options OPTS
22106 give extra options to cpphs
22107 --doctest-options OPTS
22109 give extra options to doctest
22110 --gcc-options OPTS
22112 give extra options to gcc
22113 --ghc-options OPTS
22115 give extra options to ghc
22116 --ghc-pkg-options OPTS
22118 give extra options to ghc-pkg
22119 --ghcjs-options OPTS
22121 give extra options to ghcjs
22122 --ghcjs-pkg-options OPTS
22124 give extra options to ghcjs-pkg
22125 --greencard-options OPTS
22127 give extra options to greencard
22128 --haddock-options OPTS
22130 give extra options to haddock
22131 --happy-options OPTS
22133 give extra options to happy
22134 --haskell-suite-options OPTS
22136 give extra options to haskell-suite
22137 --haskell-suite-pkg-options OPTS
22139 give extra options to haskell-suite-pkg
22140 --hmake-options OPTS
22142 give extra options to hmake
22143 --hpc-options OPTS
22145 give extra options to hpc
22146 --hsc2hs-options OPTS
22148 give extra options to hsc2hs
22149 --hscolour-options OPTS
22151 give extra options to hscolour
22152 --jhc-options OPTS
22154 give extra options to jhc
22155 --ld-options OPTS
22157 give extra options to ld
22158 --pkg-config-options OPTS
22160 give extra options to pkg-config
22161 --runghc-options OPTS
22163 give extra options to runghc
22164 --strip-options OPTS
22166 give extra options to strip
22167 --tar-options OPTS
22169 give extra options to tar
22170 --uhc-options OPTS
22172 give extra options to uhc
22173 --only
22175 Don't reinstall add-source dependencies (sandbox-only)
22176 cabal v1-bench
22179 Usage: cabal v1-bench [FLAGS]
22181 or: cabal v1-bench BENCHCOMPONENTS [FLAGS]
22182 If necessary (re)configures with `--enable-benchmarks` flag and builds
22185 the benchmarks.
22186 Remember that the benchmarks' dependencies must be installed if there
22188 are additional ones; e.g. with `cabal v1-install --only-dependencies
22189 --enable-benchmarks`.
22190 By defining UserHooks in a custom Setup.hs, the package can define
22192 actions to be executed before and after running benchmarks.
22193 The v1-bench command is a part of the legacy v1 style of cabal usage.
22196 It is a legacy feature and will be removed in a future release of
22198 cabal-install. Please file a bug if you cannot replicate a working v1-
22199 use case with the new-style commands.
22200 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22202 Flags:
22205 -v, --verbose [n]
22206 Control verbosity (n is 0--3, default verbosity level is
22207 1)
22208 --builddir, --distdir, --distpref DIR
22210 The directory where Cabal puts generated build files
22211 (default dist)
22212 --benchmark-options TEMPLATES
22214 give extra options to benchmark executables (name tem‐
22215 plates can use $pkgid, $compiler, $os, $arch, $benchmark)
22216 --benchmark-option TEMPLATE
22218 give extra option to benchmark executables (no need to
22219 quote options containing spaces, name template can use
22220 $pkgid, $compiler, $os, $arch, $benchmark)
22221 -j, --jobs [NUM]
22223 Run NUM jobs simultaneously (or '$ncpus' if no NUM is
22224 given).
22225 --with-alex PATH
22227 give the path to alex
22228 --with-ar PATH
22230 give the path to ar
22231 --with-c2hs PATH
22233 give the path to c2hs
22234 --with-cpphs PATH
22236 give the path to cpphs
22237 --with-doctest PATH
22239 give the path to doctest
22240 --with-gcc PATH
22242 give the path to gcc
22243 --with-ghc PATH
22245 give the path to ghc
22246 --with-ghc-pkg PATH
22248 give the path to ghc-pkg
22249 --with-ghcjs PATH
22251 give the path to ghcjs
22252 --with-ghcjs-pkg PATH
22254 give the path to ghcjs-pkg
22255 --with-greencard PATH
22257 give the path to greencard
22258 --with-haddock PATH
22260 give the path to haddock
22261 --with-happy PATH
22263 give the path to happy
22264 --with-haskell-suite PATH
22266 give the path to haskell-suite
22267 --with-haskell-suite-pkg PATH
22269 give the path to haskell-suite-pkg
22270 --with-hmake PATH
22272 give the path to hmake
22273 --with-hpc PATH
22275 give the path to hpc
22276 --with-hsc2hs PATH
22278 give the path to hsc2hs
22279 --with-hscolour PATH
22281 give the path to hscolour
22282 --with-jhc PATH
22284 give the path to jhc
22285 --with-ld PATH
22287 give the path to ld
22288 --with-pkg-config PATH
22290 give the path to pkg-config
22291 --with-runghc PATH
22293 give the path to runghc
22294 --with-strip PATH
22296 give the path to strip
22297 --with-tar PATH
22299 give the path to tar
22300 --with-uhc PATH
22302 give the path to uhc
22303 --alex-option OPT
22305 give an extra option to alex (no need to quote options
22306 containing spaces)
22307 --ar-option OPT
22309 give an extra option to ar (no need to quote options con‐
22310 taining spaces)
22311 --c2hs-option OPT
22313 give an extra option to c2hs (no need to quote options
22314 containing spaces)
22315 --cpphs-option OPT
22317 give an extra option to cpphs (no need to quote options
22318 containing spaces)
22319 --doctest-option OPT
22321 give an extra option to doctest (no need to quote options
22322 containing spaces)
22323 --gcc-option OPT
22325 give an extra option to gcc (no need to quote options
22326 containing spaces)
22327 --ghc-option OPT
22329 give an extra option to ghc (no need to quote options
22330 containing spaces)
22331 --ghc-pkg-option OPT
22333 give an extra option to ghc-pkg (no need to quote options
22334 containing spaces)
22335 --ghcjs-option OPT
22337 give an extra option to ghcjs (no need to quote options
22338 containing spaces)
22339 --ghcjs-pkg-option OPT
22341 give an extra option to ghcjs-pkg (no need to quote
22342 options containing spaces)
22343 --greencard-option OPT
22345 give an extra option to greencard (no need to quote
22346 options containing spaces)
22347 --haddock-option OPT
22349 give an extra option to haddock (no need to quote options
22350 containing spaces)
22351 --happy-option OPT
22353 give an extra option to happy (no need to quote options
22354 containing spaces)
22355 --haskell-suite-option OPT
22357 give an extra option to haskell-suite (no need to quote
22358 options containing spaces)
22359 --haskell-suite-pkg-option OPT
22361 give an extra option to haskell-suite-pkg (no need to
22362 quote options containing spaces)
22363 --hmake-option OPT
22365 give an extra option to hmake (no need to quote options
22366 containing spaces)
22367 --hpc-option OPT
22369 give an extra option to hpc (no need to quote options
22370 containing spaces)
22371 --hsc2hs-option OPT
22373 give an extra option to hsc2hs (no need to quote options
22374 containing spaces)
22375 --hscolour-option OPT
22377 give an extra option to hscolour (no need to quote
22378 options containing spaces)
22379 --jhc-option OPT
22381 give an extra option to jhc (no need to quote options
22382 containing spaces)
22383 --ld-option OPT
22385 give an extra option to ld (no need to quote options con‐
22386 taining spaces)
22387 --pkg-config-option OPT
22389 give an extra option to pkg-config (no need to quote
22390 options containing spaces)
22391 --runghc-option OPT
22393 give an extra option to runghc (no need to quote options
22394 containing spaces)
22395 --strip-option OPT
22397 give an extra option to strip (no need to quote options
22398 containing spaces)
22399 --tar-option OPT
22401 give an extra option to tar (no need to quote options
22402 containing spaces)
22403 --uhc-option OPT
22405 give an extra option to uhc (no need to quote options
22406 containing spaces)
22407 --alex-options OPTS
22409 give extra options to alex
22410 --ar-options OPTS
22412 give extra options to ar
22413 --c2hs-options OPTS
22415 give extra options to c2hs
22416 --cpphs-options OPTS
22418 give extra options to cpphs
22419 --doctest-options OPTS
22421 give extra options to doctest
22422 --gcc-options OPTS
22424 give extra options to gcc
22425 --ghc-options OPTS
22427 give extra options to ghc
22428 --ghc-pkg-options OPTS
22430 give extra options to ghc-pkg
22431 --ghcjs-options OPTS
22433 give extra options to ghcjs
22434 --ghcjs-pkg-options OPTS
22436 give extra options to ghcjs-pkg
22437 --greencard-options OPTS
22439 give extra options to greencard
22440 --haddock-options OPTS
22442 give extra options to haddock
22443 --happy-options OPTS
22445 give extra options to happy
22446 --haskell-suite-options OPTS
22448 give extra options to haskell-suite
22449 --haskell-suite-pkg-options OPTS
22451 give extra options to haskell-suite-pkg
22452 --hmake-options OPTS
22454 give extra options to hmake
22455 --hpc-options OPTS
22457 give extra options to hpc
22458 --hsc2hs-options OPTS
22460 give extra options to hsc2hs
22461 --hscolour-options OPTS
22463 give extra options to hscolour
22464 --jhc-options OPTS
22466 give extra options to jhc
22467 --ld-options OPTS
22469 give extra options to ld
22470 --pkg-config-options OPTS
22472 give extra options to pkg-config
22473 --runghc-options OPTS
22475 give extra options to runghc
22476 --strip-options OPTS
22478 give extra options to strip
22479 --tar-options OPTS
22481 give extra options to tar
22482 --uhc-options OPTS
22484 give extra options to uhc
22485 --only
22487 Don't reinstall add-source dependencies (sandbox-only)
22488 cabal exec
22491 Usage: cabal exec [FLAGS] [--] COMMAND [--] [ARGS]
22493 A directly invoked GHC will not automatically be aware of any sand‐
22496 boxes: the GHC_PACKAGE_PATH environment variable controls what GHC
22497 uses. `cabal exec` can be used to modify this variable: COMMAND will be
22498 executed in a modified environment and thereby uses the sandbox package
22499 database.
22500 If there is no sandbox, behaves as identity (executing COMMAND).
22502 Note that other cabal commands change the environment variable appro‐
22504 priately already, so there is no need to wrap those in `cabal exec`.
22505 But with `cabal exec`, the user has more control and can, for example,
22506 execute custom scripts which indirectly execute GHC.
22507 Note that `cabal repl` is different from `cabal exec -- ghci` as the
22509 latter will not forward any additional flags being defined in the local
22510 package to ghci.
22511 See `cabal sandbox`.
22513 Examples:
22516 cabal exec -- ghci -Wall
22517 Start a repl session with sandbox packages and all warnings;
22518 cabal exec gitit -- -f gitit.cnf
22519 Give gitit access to the sandbox packages, and pass it a flag;
22520 cabal exec runghc Foo.hs
22521 Execute runghc on Foo.hs with runghc configured to use the
22522 sandbox package database (if a sandbox is being used).
22523 The exec command is a part of the legacy v1 style of cabal usage.
22525 Please switch to using either the new project style and the new-exec
22527 command or the legacy v1-exec alias as new-style projects will become
22528 the default in the next version of cabal-install. Please file a bug if
22529 you cannot replicate a working v1- use case with the new-style com‐
22530 mands.
22531 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22533 Flags:
22536 -v, --verbose [n]
22537 Control verbosity (n is 0--3, default verbosity level is
22538 1)
22539 --builddir, --distdir, --distpref DIR
22541 The directory where Cabal puts generated build files
22542 (default dist)
22543 cabal v1-exec
22546 Usage: cabal v1-exec [FLAGS] [--] COMMAND [--] [ARGS]
22548 A directly invoked GHC will not automatically be aware of any sand‐
22551 boxes: the GHC_PACKAGE_PATH environment variable controls what GHC
22552 uses. `cabal v1-exec` can be used to modify this variable: COMMAND will
22553 be executed in a modified environment and thereby uses the sandbox
22554 package database.
22555 If there is no sandbox, behaves as identity (executing COMMAND).
22557 Note that other cabal commands change the environment variable appro‐
22559 priately already, so there is no need to wrap those in `cabal v1-exec`.
22560 But with `cabal v1-exec`, the user has more control and can, for exam‐
22561 ple, execute custom scripts which indirectly execute GHC.
22562 Note that `cabal v1-repl` is different from `cabal v1-exec -- ghci` as
22564 the latter will not forward any additional flags being defined in the
22565 local package to ghci.
22566 See `cabal sandbox`.
22568 Examples:
22571 cabal v1-exec -- ghci -Wall
22572 Start a repl session with sandbox packages and all warnings;
22573 cabal v1-exec gitit -- -f gitit.cnf
22574 Give gitit access to the sandbox packages, and pass it a flag;
22575 cabal v1-exec runghc Foo.hs
22576 Execute runghc on Foo.hs with runghc configured to use the
22577 sandbox package database (if a sandbox is being used).
22578 The v1-exec command is a part of the legacy v1 style of cabal usage.
22580 It is a legacy feature and will be removed in a future release of
22582 cabal-install. Please file a bug if you cannot replicate a working v1-
22583 use case with the new-style commands.
22584 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22586 Flags:
22589 -v, --verbose [n]
22590 Control verbosity (n is 0--3, default verbosity level is
22591 1)
22592 --builddir, --distdir, --distpref DIR
22594 The directory where Cabal puts generated build files
22595 (default dist)
22596 cabal clean
22599 Usage: cabal clean [FLAGS]
22601 Removes .hi, .o, preprocessed sources, etc.
22604 The clean command is a part of the legacy v1 style of cabal usage.
22607 Please switch to using either the new project style and the new-clean
22609 command or the legacy v1-clean alias as new-style projects will become
22610 the default in the next version of cabal-install. Please file a bug if
22611 you cannot replicate a working v1- use case with the new-style com‐
22612 mands.
22613 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22615 Flags:
22618 -v, --verbose [n]
22619 Control verbosity (n is 0--3, default verbosity level is
22620 1)
22621 --builddir, --distdir, --distpref DIR
22623 The directory where Cabal puts generated build files
22624 (default dist)
22625 -s, --save-configure
22627 Do not remove the configuration file (dist/setup-config)
22628 during cleaning. Saves need to reconfigure.
22629 cabal v1-clean
22632 Usage: cabal v1-clean [FLAGS]
22634 Removes .hi, .o, preprocessed sources, etc.
22637 The v1-clean command is a part of the legacy v1 style of cabal usage.
22640 It is a legacy feature and will be removed in a future release of
22642 cabal-install. Please file a bug if you cannot replicate a working v1-
22643 use case with the new-style commands.
22644 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22646 Flags:
22649 -v, --verbose [n]
22650 Control verbosity (n is 0--3, default verbosity level is
22651 1)
22652 --builddir, --distdir, --distpref DIR
22654 The directory where Cabal puts generated build files
22655 (default dist)
22656 -s, --save-configure
22658 Do not remove the configuration file (dist/setup-config)
22659 during cleaning. Saves need to reconfigure.
22660 cabal sdist
22663 Usage: cabal sdist [FLAGS]
22665 The sdist command is a part of the legacy v1 style of cabal usage.
22668 Please switch to using either the new project style and the new-sdist
22670 command or the legacy v1-sdist alias as new-style projects will become
22671 the default in the next version of cabal-install. Please file a bug if
22672 you cannot replicate a working v1- use case with the new-style com‐
22673 mands.
22674 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22676 Flags:
22679 -v, --verbose [n]
22680 Control verbosity (n is 0--3, default verbosity level is
22681 1)
22682 --builddir, --distdir, --distpref DIR
22684 The directory where Cabal puts generated build files
22685 (default dist)
22686 --list-sources FILE
22688 Just write a list of the package's sources to a file
22689 --snapshot
22691 Produce a snapshot source distribution
22692 --output-directory DIR
22694 Generate a source distribution in the given directory,
22695 without creating a tarball
22696 --targz
22698 Produce a '.tar.gz' format archive (default and required
22699 for uploading to hackage)
22700 --zip
22702 Produce a '.zip' format archive
22703 cabal v1-sdist
22706 Usage: cabal v1-sdist [FLAGS]
22708 The v1-sdist command is a part of the legacy v1 style of cabal usage.
22711 It is a legacy feature and will be removed in a future release of
22713 cabal-install. Please file a bug if you cannot replicate a working v1-
22714 use case with the new-style commands.
22715 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22717 Flags:
22720 -v, --verbose [n]
22721 Control verbosity (n is 0--3, default verbosity level is
22722 1)
22723 --builddir, --distdir, --distpref DIR
22725 The directory where Cabal puts generated build files
22726 (default dist)
22727 --list-sources FILE
22729 Just write a list of the package's sources to a file
22730 --snapshot
22732 Produce a snapshot source distribution
22733 --output-directory DIR
22735 Generate a source distribution in the given directory,
22736 without creating a tarball
22737 --targz
22739 Produce a '.tar.gz' format archive (default and required
22740 for uploading to hackage)
22741 --zip
22743 Produce a '.zip' format archive
22744 cabal doctest
22747 Usage: cabal doctest [FLAGS]
22749 Requires the program doctest, version 0.12.
22752 The doctest command is a part of the legacy v1 style of cabal usage.
22755 Please switch to using either the new project style and the new-doctest
22757 command or the legacy v1-doctest alias as new-style projects will
22758 become the default in the next version of cabal-install. Please file a
22759 bug if you cannot replicate a working v1- use case with the new-style
22760 commands.
22761 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22763 Flags:
22766 -v, --verbose [n]
22767 Control verbosity (n is 0--3, default verbosity level is
22768 1)
22769 --builddir, --distdir, --distpref DIR
22771 The directory where Cabal puts generated build files
22772 (default dist)
22773 --with-doctest PATH
22775 give the path to doctest
22776 --doctest-option OPT
22778 give an extra option to doctest (no need to quote options
22779 containing spaces)
22780 --doctest-options OPTS
22782 give extra options to doctest
22783 cabal v1-doctest
22786 Usage: cabal v1-doctest [FLAGS]
22788 Requires the program doctest, version 0.12.
22791 The v1-doctest command is a part of the legacy v1 style of cabal usage.
22794 It is a legacy feature and will be removed in a future release of
22796 cabal-install. Please file a bug if you cannot replicate a working v1-
22797 use case with the new-style commands.
22798 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22800 Flags:
22803 -v, --verbose [n]
22804 Control verbosity (n is 0--3, default verbosity level is
22805 1)
22806 --builddir, --distdir, --distpref DIR
22808 The directory where Cabal puts generated build files
22809 (default dist)
22810 --with-doctest PATH
22812 give the path to doctest
22813 --doctest-option OPT
22815 give an extra option to doctest (no need to quote options
22816 containing spaces)
22817 --doctest-options OPTS
22819 give extra options to doctest
22820 cabal copy
22823 Usage: cabal copy [FLAGS]
22825 or: cabal copy COMPONENTS [FLAGS]
22826 Components encompass executables and libraries. Does not call register,
22829 and allows a prefix at install time. Without the --destdir flag, con‐
22830 figure determines location.
22831 Examples:
22834 cabal copy All the components in the package
22835 cabal copy foo A component (i.e. lib, exe, test suite) The
22836 copy command is a part of the legacy v1 style of cabal usage.
22837 Please switch to using either the new project style and the new-copy
22839 command or the legacy v1-copy alias as new-style projects will become
22840 the default in the next version of cabal-install. Please file a bug if
22841 you cannot replicate a working v1- use case with the new-style com‐
22842 mands.
22843 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22845 Flags:
22848 -v, --verbose [n]
22849 Control verbosity (n is 0--3, default verbosity level is
22850 1)
22851 --builddir, --distdir, --distpref DIR
22853 The directory where Cabal puts generated build files
22854 (default dist)
22855 --destdir DIR
22857 directory to copy files to, prepended to installation
22858 directories
22859 --target-package-db DATABASE
22861 package database to copy files into. Required when using
22862 ${pkgroot} prefix.
22863 cabal v1-copy
22866 Usage: cabal v1-copy [FLAGS]
22868 or: cabal v1-copy COMPONENTS [FLAGS]
22869 Components encompass executables and libraries. Does not call register,
22872 and allows a prefix at install time. Without the --destdir flag, con‐
22873 figure determines location.
22874 Examples:
22877 cabal v1-copy All the components in the package
22878 cabal v1-copy foo A component (i.e. lib, exe, test suite)
22879 The v1-copy command is a part of the legacy v1 style of cabal usage.
22880 It is a legacy feature and will be removed in a future release of
22882 cabal-install. Please file a bug if you cannot replicate a working v1-
22883 use case with the new-style commands.
22884 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22886 Flags:
22889 -v, --verbose [n]
22890 Control verbosity (n is 0--3, default verbosity level is
22891 1)
22892 --builddir, --distdir, --distpref DIR
22894 The directory where Cabal puts generated build files
22895 (default dist)
22896 --destdir DIR
22898 directory to copy files to, prepended to installation
22899 directories
22900 --target-package-db DATABASE
22902 package database to copy files into. Required when using
22903 ${pkgroot} prefix.
22904 cabal register
22907 Usage: cabal register [FLAGS]
22909 The register command is a part of the legacy v1 style of cabal usage.
22912 Please switch to using either the new project style and the new-regis‐
22914 ter command or the legacy v1-register alias as new-style projects will
22915 become the default in the next version of cabal-install. Please file a
22916 bug if you cannot replicate a working v1- use case with the new-style
22917 commands.
22918 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22920 Flags:
22923 -v, --verbose [n]
22924 Control verbosity (n is 0--3, default verbosity level is
22925 1)
22926 --builddir, --distdir, --distpref DIR
22928 The directory where Cabal puts generated build files
22929 (default dist)
22930 --user
22932 upon registration, register this package in the user's
22933 local package database
22934 --global
22936 (default)upon registration, register this package in the
22937 system-wide package database
22938 --inplace
22940 register the package in the build location, so it can be
22941 used without being installed
22942 --gen-script
22944 instead of registering, generate a script to register
22945 later
22946 --gen-pkg-config [PKG]
22948 instead of registering, generate a package registration
22949 file/directory
22950 --print-ipid
22952 print the installed package ID calculated for this pack‐
22953 age
22954 cabal v1-register
22957 Usage: cabal v1-register [FLAGS]
22959 The v1-register command is a part of the legacy v1 style of cabal
22962 usage.
22963 It is a legacy feature and will be removed in a future release of
22965 cabal-install. Please file a bug if you cannot replicate a working v1-
22966 use case with the new-style commands.
22967 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
22969 Flags:
22972 -v, --verbose [n]
22973 Control verbosity (n is 0--3, default verbosity level is
22974 1)
22975 --builddir, --distdir, --distpref DIR
22977 The directory where Cabal puts generated build files
22978 (default dist)
22979 --user
22981 upon registration, register this package in the user's
22982 local package database
22983 --global
22985 (default)upon registration, register this package in the
22986 system-wide package database
22987 --inplace
22989 register the package in the build location, so it can be
22990 used without being installed
22991 --gen-script
22993 instead of registering, generate a script to register
22994 later
22995 --gen-pkg-config [PKG]
22997 instead of registering, generate a package registration
22998 file/directory
22999 --print-ipid
23001 print the installed package ID calculated for this pack‐
23002 age
23003 cabal reconfigure
23006 Usage: cabal reconfigure [FLAGS]
23008 Run `configure` with the most recently used flags, or append FLAGS to
23011 the most recently used configuration. Accepts the same flags as `cabal
23012 configure'. If the package has never been configured, the default
23013 flags are used.
23014 Examples:
23017 cabal reconfigure
23018 Configure with the most recently used flags.
23019 cabal reconfigure -w PATH
23020 Reconfigure with the most recently used flags,
23021 but use the compiler at PATH.
23022 The reconfigure command is a part of the legacy v1 style of cabal
23025 usage.
23026 Please switch to using either the new project style and the new-recon‐
23028 figure command or the legacy v1-reconfigure alias as new-style projects
23029 will become the default in the next version of cabal-install. Please
23030 file a bug if you cannot replicate a working v1- use case with the new-
23031 style commands.
23032 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
23034 Flags:
23037 -v, --verbose [n]
23038 Control verbosity (n is 0--3, default verbosity level is
23039 1)
23040 --builddir, --distdir, --distpref DIR
23042 The directory where Cabal puts generated build files
23043 (default dist)
23044 -g, --ghc
23046 compile with GHC
23047 --ghcjs
23049 compile with GHCJS
23050 --uhc
23052 compile with UHC
23053 --haskell-suite
23055 compile with a haskell-suite compiler
23056 --cabal-file PATH
23058 use this Cabal file
23059 -w, --with-compiler PATH
23061 give the path to a particular compiler
23062 --with-hc-pkg PATH
23064 give the path to the package tool
23065 --prefix DIR
23067 bake this prefix in preparation of installation
23068 --bindir DIR
23070 installation directory for executables
23071 --libdir DIR
23073 installation directory for libraries
23074 --libsubdir DIR
23076 subdirectory of libdir in which libs are installed
23077 --dynlibdir DIR
23079 installation directory for dynamic libraries
23080 --libexecdir DIR
23082 installation directory for program executables
23083 --libexecsubdir DIR
23085 subdirectory of libexecdir in which private executables
23086 are installed
23087 --datadir DIR
23089 installation directory for read-only data
23090 --datasubdir DIR
23092 subdirectory of datadir in which data files are installed
23093 --docdir DIR
23095 installation directory for documentation
23096 --htmldir DIR
23098 installation directory for HTML documentation
23099 --haddockdir DIR
23101 installation directory for haddock interfaces
23102 --sysconfdir DIR
23104 installation directory for configuration files
23105 --program-prefix PREFIX
23107 prefix to be applied to installed executables
23108 --program-suffix SUFFIX
23110 suffix to be applied to installed executables
23111 --enable-library-vanilla
23113 --disable-library-vanilla
23114 Vanilla libraries
23115 -p, --enable-library-profiling
23117 --disable-library-profiling
23118 Library profiling
23119 --enable-shared
23121 --disable-shared
23122 Shared library
23123 --enable-static
23125 --disable-static
23126 Static library
23127 --enable-executable-dynamic
23129 --disable-executable-dynamic
23130 Executable dynamic linking
23131 --enable-profiling
23133 --disable-profiling
23134 Executable and library profiling
23135 --enable-executable-profiling
23137 --disable-executable-profiling
23138 Executable profiling (DEPRECATED)
23139 --profiling-detail level
23141 Profiling detail level for executable and library
23142 (default, none, exported-functions, toplevel-functions,
23143 all-functions).
23144 --library-profiling-detail level
23146 Profiling detail level for libraries only.
23147 -O, --enable-optimization, --enable-optimisation [n]
23149 Build with optimization (n is 0--2, default is 1)
23150 --disable-optimization, --disable-optimisation
23152 Build without optimization
23153 --enable-debug-info [n]
23155 Emit debug info (n is 0--3, default is 0)
23156 --disable-debug-info
23158 Don't emit debug info
23159 --enable-library-for-ghci
23161 --disable-library-for-ghci
23162 compile library for use with GHCi
23163 --enable-split-sections
23165 --disable-split-sections
23166 compile library code such that unneeded definitions can
23167 be dropped from the final executable (GHC 7.8+)
23168 --enable-split-objs
23170 --disable-split-objs
23171 split library into smaller objects to reduce binary sizes
23172 (GHC 6.6+)
23173 --enable-executable-stripping
23175 --disable-executable-stripping
23176 strip executables upon installation to reduce binary
23177 sizes
23178 --enable-library-stripping
23180 --disable-library-stripping
23181 strip libraries upon installation to reduce binary sizes
23182 --configure-option OPT
23184 Extra option for configure
23185 --user
23187 --global
23188 doing a per-user installation
23189 --package-db DB
23191 Append the given package database to the list of package
23192 databases used (to satisfy dependencies and register
23193 into). May be a specific file, 'global' or 'user'. The
23194 initial list is ['global'], ['global', 'user'], or
23195 ['global', $sandbox], depending on context. Use 'clear'
23196 to reset the list to empty. See the user guide for
23197 details.
23198 -f, --flags FLAGS
23200 Force values for the given flags in Cabal conditionals in
23201 the .cabal file. E.g., --flags="debug -usebytestrings"
23202 forces the flag "debug" to true and "usebytestrings" to
23203 false.
23204 --extra-include-dirs PATH
23206 A list of directories to search for header files
23207 --enable-deterministic
23209 --disable-deterministic
23210 Try to be as deterministic as possible (used by the test
23211 suite)
23212 --ipid IPID
23214 Installed package ID to compile this package as
23215 --cid CID
23217 Installed component ID to compile this component as
23218 --extra-lib-dirs PATH
23220 A list of directories to search for external libraries
23221 --extra-framework-dirs PATH
23223 A list of directories to search for external frameworks
23224 (OS X only)
23225 --extra-prog-path PATH
23227 A list of directories to search for required programs (in
23228 addition to the normal search locations)
23229 --instantiate-with NAME=MOD
23231 A mapping of signature names to concrete module instanti‐
23232 ations.
23233 --enable-tests
23235 --disable-tests
23236 dependency checking and compilation for test suites
23237 listed in the package description file.
23238 --enable-coverage
23240 --disable-coverage
23241 build package with Haskell Program Coverage. (GHC only)
23242 --enable-library-coverage
23244 --disable-library-coverage
23245 build package with Haskell Program Coverage. (GHC only)
23246 (DEPRECATED)
23247 --enable-benchmarks
23249 --disable-benchmarks
23250 dependency checking and compilation for benchmarks listed
23251 in the package description file.
23252 --enable-relocatable
23254 --disable-relocatable
23255 building a package that is relocatable. (GHC only)
23256 --disable-response-files
23258 enable workaround for old versions of programs like "ar"
23259 that do not support @file arguments
23260 --with-alex PATH
23262 give the path to alex
23263 --with-ar PATH
23265 give the path to ar
23266 --with-c2hs PATH
23268 give the path to c2hs
23269 --with-cpphs PATH
23271 give the path to cpphs
23272 --with-doctest PATH
23274 give the path to doctest
23275 --with-gcc PATH
23277 give the path to gcc
23278 --with-ghc PATH
23280 give the path to ghc
23281 --with-ghc-pkg PATH
23283 give the path to ghc-pkg
23284 --with-ghcjs PATH
23286 give the path to ghcjs
23287 --with-ghcjs-pkg PATH
23289 give the path to ghcjs-pkg
23290 --with-greencard PATH
23292 give the path to greencard
23293 --with-haddock PATH
23295 give the path to haddock
23296 --with-happy PATH
23298 give the path to happy
23299 --with-haskell-suite PATH
23301 give the path to haskell-suite
23302 --with-haskell-suite-pkg PATH
23304 give the path to haskell-suite-pkg
23305 --with-hmake PATH
23307 give the path to hmake
23308 --with-hpc PATH
23310 give the path to hpc
23311 --with-hsc2hs PATH
23313 give the path to hsc2hs
23314 --with-hscolour PATH
23316 give the path to hscolour
23317 --with-jhc PATH
23319 give the path to jhc
23320 --with-ld PATH
23322 give the path to ld
23323 --with-pkg-config PATH
23325 give the path to pkg-config
23326 --with-runghc PATH
23328 give the path to runghc
23329 --with-strip PATH
23331 give the path to strip
23332 --with-tar PATH
23334 give the path to tar
23335 --with-uhc PATH
23337 give the path to uhc
23338 --alex-option OPT
23340 give an extra option to alex (no need to quote options
23341 containing spaces)
23342 --ar-option OPT
23344 give an extra option to ar (no need to quote options con‐
23345 taining spaces)
23346 --c2hs-option OPT
23348 give an extra option to c2hs (no need to quote options
23349 containing spaces)
23350 --cpphs-option OPT
23352 give an extra option to cpphs (no need to quote options
23353 containing spaces)
23354 --doctest-option OPT
23356 give an extra option to doctest (no need to quote options
23357 containing spaces)
23358 --gcc-option OPT
23360 give an extra option to gcc (no need to quote options
23361 containing spaces)
23362 --ghc-option OPT
23364 give an extra option to ghc (no need to quote options
23365 containing spaces)
23366 --ghc-pkg-option OPT
23368 give an extra option to ghc-pkg (no need to quote options
23369 containing spaces)
23370 --ghcjs-option OPT
23372 give an extra option to ghcjs (no need to quote options
23373 containing spaces)
23374 --ghcjs-pkg-option OPT
23376 give an extra option to ghcjs-pkg (no need to quote
23377 options containing spaces)
23378 --greencard-option OPT
23380 give an extra option to greencard (no need to quote
23381 options containing spaces)
23382 --haddock-option OPT
23384 give an extra option to haddock (no need to quote options
23385 containing spaces)
23386 --happy-option OPT
23388 give an extra option to happy (no need to quote options
23389 containing spaces)
23390 --haskell-suite-option OPT
23392 give an extra option to haskell-suite (no need to quote
23393 options containing spaces)
23394 --haskell-suite-pkg-option OPT
23396 give an extra option to haskell-suite-pkg (no need to
23397 quote options containing spaces)
23398 --hmake-option OPT
23400 give an extra option to hmake (no need to quote options
23401 containing spaces)
23402 --hpc-option OPT
23404 give an extra option to hpc (no need to quote options
23405 containing spaces)
23406 --hsc2hs-option OPT
23408 give an extra option to hsc2hs (no need to quote options
23409 containing spaces)
23410 --hscolour-option OPT
23412 give an extra option to hscolour (no need to quote
23413 options containing spaces)
23414 --jhc-option OPT
23416 give an extra option to jhc (no need to quote options
23417 containing spaces)
23418 --ld-option OPT
23420 give an extra option to ld (no need to quote options con‐
23421 taining spaces)
23422 --pkg-config-option OPT
23424 give an extra option to pkg-config (no need to quote
23425 options containing spaces)
23426 --runghc-option OPT
23428 give an extra option to runghc (no need to quote options
23429 containing spaces)
23430 --strip-option OPT
23432 give an extra option to strip (no need to quote options
23433 containing spaces)
23434 --tar-option OPT
23436 give an extra option to tar (no need to quote options
23437 containing spaces)
23438 --uhc-option OPT
23440 give an extra option to uhc (no need to quote options
23441 containing spaces)
23442 --alex-options OPTS
23444 give extra options to alex
23445 --ar-options OPTS
23447 give extra options to ar
23448 --c2hs-options OPTS
23450 give extra options to c2hs
23451 --cpphs-options OPTS
23453 give extra options to cpphs
23454 --doctest-options OPTS
23456 give extra options to doctest
23457 --gcc-options OPTS
23459 give extra options to gcc
23460 --ghc-options OPTS
23462 give extra options to ghc
23463 --ghc-pkg-options OPTS
23465 give extra options to ghc-pkg
23466 --ghcjs-options OPTS
23468 give extra options to ghcjs
23469 --ghcjs-pkg-options OPTS
23471 give extra options to ghcjs-pkg
23472 --greencard-options OPTS
23474 give extra options to greencard
23475 --haddock-options OPTS
23477 give extra options to haddock
23478 --happy-options OPTS
23480 give extra options to happy
23481 --haskell-suite-options OPTS
23483 give extra options to haskell-suite
23484 --haskell-suite-pkg-options OPTS
23486 give extra options to haskell-suite-pkg
23487 --hmake-options OPTS
23489 give extra options to hmake
23490 --hpc-options OPTS
23492 give extra options to hpc
23493 --hsc2hs-options OPTS
23495 give extra options to hsc2hs
23496 --hscolour-options OPTS
23498 give extra options to hscolour
23499 --jhc-options OPTS
23501 give extra options to jhc
23502 --ld-options OPTS
23504 give extra options to ld
23505 --pkg-config-options OPTS
23507 give extra options to pkg-config
23508 --runghc-options OPTS
23510 give extra options to runghc
23511 --strip-options OPTS
23513 give extra options to strip
23514 --tar-options OPTS
23516 give extra options to tar
23517 --uhc-options OPTS
23519 give extra options to uhc
23520 --cabal-lib-version VERSION
23522 Select which version of the Cabal lib to use to build
23523 packages (useful for testing).
23524 --constraint CONSTRAINT
23526 Specify constraints on a package (version,
23527 installed/source, flags)
23528 --preference CONSTRAINT
23530 Specify preferences (soft constraints) on the version of
23531 a package
23532 --solver SOLVER
23534 Select dependency solver to use (default: modular).
23535 Choices: modular.
23536 --allow-older [DEPS]
23538 Ignore lower bounds in all dependencies or DEPS
23539 --allow-newer [DEPS]
23541 Ignore upper bounds in all dependencies or DEPS
23542 cabal v1-reconfigure
23545 Usage: cabal v1-reconfigure [FLAGS]
23547 Run `configure` with the most recently used flags, or append FLAGS to
23550 the most recently used configuration. Accepts the same flags as `cabal
23551 v1-configure'. If the package has never been configured, the default
23552 flags are used.
23553 Examples:
23556 cabal v1-reconfigure
23557 Configure with the most recently used flags.
23558 cabal v1-reconfigure -w PATH
23559 Reconfigure with the most recently used flags,
23560 but use the compiler at PATH.
23561 The v1-reconfigure command is a part of the legacy v1 style of cabal
23564 usage.
23565 It is a legacy feature and will be removed in a future release of
23567 cabal-install. Please file a bug if you cannot replicate a working v1-
23568 use case with the new-style commands.
23569 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
23571 Flags:
23574 -v, --verbose [n]
23575 Control verbosity (n is 0--3, default verbosity level is
23576 1)
23577 --builddir, --distdir, --distpref DIR
23579 The directory where Cabal puts generated build files
23580 (default dist)
23581 -g, --ghc
23583 compile with GHC
23584 --ghcjs
23586 compile with GHCJS
23587 --uhc
23589 compile with UHC
23590 --haskell-suite
23592 compile with a haskell-suite compiler
23593 --cabal-file PATH
23595 use this Cabal file
23596 -w, --with-compiler PATH
23598 give the path to a particular compiler
23599 --with-hc-pkg PATH
23601 give the path to the package tool
23602 --prefix DIR
23604 bake this prefix in preparation of installation
23605 --bindir DIR
23607 installation directory for executables
23608 --libdir DIR
23610 installation directory for libraries
23611 --libsubdir DIR
23613 subdirectory of libdir in which libs are installed
23614 --dynlibdir DIR
23616 installation directory for dynamic libraries
23617 --libexecdir DIR
23619 installation directory for program executables
23620 --libexecsubdir DIR
23622 subdirectory of libexecdir in which private executables
23623 are installed
23624 --datadir DIR
23626 installation directory for read-only data
23627 --datasubdir DIR
23629 subdirectory of datadir in which data files are installed
23630 --docdir DIR
23632 installation directory for documentation
23633 --htmldir DIR
23635 installation directory for HTML documentation
23636 --haddockdir DIR
23638 installation directory for haddock interfaces
23639 --sysconfdir DIR
23641 installation directory for configuration files
23642 --program-prefix PREFIX
23644 prefix to be applied to installed executables
23645 --program-suffix SUFFIX
23647 suffix to be applied to installed executables
23648 --enable-library-vanilla
23650 --disable-library-vanilla
23651 Vanilla libraries
23652 -p, --enable-library-profiling
23654 --disable-library-profiling
23655 Library profiling
23656 --enable-shared
23658 --disable-shared
23659 Shared library
23660 --enable-static
23662 --disable-static
23663 Static library
23664 --enable-executable-dynamic
23666 --disable-executable-dynamic
23667 Executable dynamic linking
23668 --enable-profiling
23670 --disable-profiling
23671 Executable and library profiling
23672 --enable-executable-profiling
23674 --disable-executable-profiling
23675 Executable profiling (DEPRECATED)
23676 --profiling-detail level
23678 Profiling detail level for executable and library
23679 (default, none, exported-functions, toplevel-functions,
23680 all-functions).
23681 --library-profiling-detail level
23683 Profiling detail level for libraries only.
23684 -O, --enable-optimization, --enable-optimisation [n]
23686 Build with optimization (n is 0--2, default is 1)
23687 --disable-optimization, --disable-optimisation
23689 Build without optimization
23690 --enable-debug-info [n]
23692 Emit debug info (n is 0--3, default is 0)
23693 --disable-debug-info
23695 Don't emit debug info
23696 --enable-library-for-ghci
23698 --disable-library-for-ghci
23699 compile library for use with GHCi
23700 --enable-split-sections
23702 --disable-split-sections
23703 compile library code such that unneeded definitions can
23704 be dropped from the final executable (GHC 7.8+)
23705 --enable-split-objs
23707 --disable-split-objs
23708 split library into smaller objects to reduce binary sizes
23709 (GHC 6.6+)
23710 --enable-executable-stripping
23712 --disable-executable-stripping
23713 strip executables upon installation to reduce binary
23714 sizes
23715 --enable-library-stripping
23717 --disable-library-stripping
23718 strip libraries upon installation to reduce binary sizes
23719 --configure-option OPT
23721 Extra option for configure
23722 --user
23724 --global
23725 doing a per-user installation
23726 --package-db DB
23728 Append the given package database to the list of package
23729 databases used (to satisfy dependencies and register
23730 into). May be a specific file, 'global' or 'user'. The
23731 initial list is ['global'], ['global', 'user'], or
23732 ['global', $sandbox], depending on context. Use 'clear'
23733 to reset the list to empty. See the user guide for
23734 details.
23735 -f, --flags FLAGS
23737 Force values for the given flags in Cabal conditionals in
23738 the .cabal file. E.g., --flags="debug -usebytestrings"
23739 forces the flag "debug" to true and "usebytestrings" to
23740 false.
23741 --extra-include-dirs PATH
23743 A list of directories to search for header files
23744 --enable-deterministic
23746 --disable-deterministic
23747 Try to be as deterministic as possible (used by the test
23748 suite)
23749 --ipid IPID
23751 Installed package ID to compile this package as
23752 --cid CID
23754 Installed component ID to compile this component as
23755 --extra-lib-dirs PATH
23757 A list of directories to search for external libraries
23758 --extra-framework-dirs PATH
23760 A list of directories to search for external frameworks
23761 (OS X only)
23762 --extra-prog-path PATH
23764 A list of directories to search for required programs (in
23765 addition to the normal search locations)
23766 --instantiate-with NAME=MOD
23768 A mapping of signature names to concrete module instanti‐
23769 ations.
23770 --enable-tests
23772 --disable-tests
23773 dependency checking and compilation for test suites
23774 listed in the package description file.
23775 --enable-coverage
23777 --disable-coverage
23778 build package with Haskell Program Coverage. (GHC only)
23779 --enable-library-coverage
23781 --disable-library-coverage
23782 build package with Haskell Program Coverage. (GHC only)
23783 (DEPRECATED)
23784 --enable-benchmarks
23786 --disable-benchmarks
23787 dependency checking and compilation for benchmarks listed
23788 in the package description file.
23789 --enable-relocatable
23791 --disable-relocatable
23792 building a package that is relocatable. (GHC only)
23793 --disable-response-files
23795 enable workaround for old versions of programs like "ar"
23796 that do not support @file arguments
23797 --with-alex PATH
23799 give the path to alex
23800 --with-ar PATH
23802 give the path to ar
23803 --with-c2hs PATH
23805 give the path to c2hs
23806 --with-cpphs PATH
23808 give the path to cpphs
23809 --with-doctest PATH
23811 give the path to doctest
23812 --with-gcc PATH
23814 give the path to gcc
23815 --with-ghc PATH
23817 give the path to ghc
23818 --with-ghc-pkg PATH
23820 give the path to ghc-pkg
23821 --with-ghcjs PATH
23823 give the path to ghcjs
23824 --with-ghcjs-pkg PATH
23826 give the path to ghcjs-pkg
23827 --with-greencard PATH
23829 give the path to greencard
23830 --with-haddock PATH
23832 give the path to haddock
23833 --with-happy PATH
23835 give the path to happy
23836 --with-haskell-suite PATH
23838 give the path to haskell-suite
23839 --with-haskell-suite-pkg PATH
23841 give the path to haskell-suite-pkg
23842 --with-hmake PATH
23844 give the path to hmake
23845 --with-hpc PATH
23847 give the path to hpc
23848 --with-hsc2hs PATH
23850 give the path to hsc2hs
23851 --with-hscolour PATH
23853 give the path to hscolour
23854 --with-jhc PATH
23856 give the path to jhc
23857 --with-ld PATH
23859 give the path to ld
23860 --with-pkg-config PATH
23862 give the path to pkg-config
23863 --with-runghc PATH
23865 give the path to runghc
23866 --with-strip PATH
23868 give the path to strip
23869 --with-tar PATH
23871 give the path to tar
23872 --with-uhc PATH
23874 give the path to uhc
23875 --alex-option OPT
23877 give an extra option to alex (no need to quote options
23878 containing spaces)
23879 --ar-option OPT
23881 give an extra option to ar (no need to quote options con‐
23882 taining spaces)
23883 --c2hs-option OPT
23885 give an extra option to c2hs (no need to quote options
23886 containing spaces)
23887 --cpphs-option OPT
23889 give an extra option to cpphs (no need to quote options
23890 containing spaces)
23891 --doctest-option OPT
23893 give an extra option to doctest (no need to quote options
23894 containing spaces)
23895 --gcc-option OPT
23897 give an extra option to gcc (no need to quote options
23898 containing spaces)
23899 --ghc-option OPT
23901 give an extra option to ghc (no need to quote options
23902 containing spaces)
23903 --ghc-pkg-option OPT
23905 give an extra option to ghc-pkg (no need to quote options
23906 containing spaces)
23907 --ghcjs-option OPT
23909 give an extra option to ghcjs (no need to quote options
23910 containing spaces)
23911 --ghcjs-pkg-option OPT
23913 give an extra option to ghcjs-pkg (no need to quote
23914 options containing spaces)
23915 --greencard-option OPT
23917 give an extra option to greencard (no need to quote
23918 options containing spaces)
23919 --haddock-option OPT
23921 give an extra option to haddock (no need to quote options
23922 containing spaces)
23923 --happy-option OPT
23925 give an extra option to happy (no need to quote options
23926 containing spaces)
23927 --haskell-suite-option OPT
23929 give an extra option to haskell-suite (no need to quote
23930 options containing spaces)
23931 --haskell-suite-pkg-option OPT
23933 give an extra option to haskell-suite-pkg (no need to
23934 quote options containing spaces)
23935 --hmake-option OPT
23937 give an extra option to hmake (no need to quote options
23938 containing spaces)
23939 --hpc-option OPT
23941 give an extra option to hpc (no need to quote options
23942 containing spaces)
23943 --hsc2hs-option OPT
23945 give an extra option to hsc2hs (no need to quote options
23946 containing spaces)
23947 --hscolour-option OPT
23949 give an extra option to hscolour (no need to quote
23950 options containing spaces)
23951 --jhc-option OPT
23953 give an extra option to jhc (no need to quote options
23954 containing spaces)
23955 --ld-option OPT
23957 give an extra option to ld (no need to quote options con‐
23958 taining spaces)
23959 --pkg-config-option OPT
23961 give an extra option to pkg-config (no need to quote
23962 options containing spaces)
23963 --runghc-option OPT
23965 give an extra option to runghc (no need to quote options
23966 containing spaces)
23967 --strip-option OPT
23969 give an extra option to strip (no need to quote options
23970 containing spaces)
23971 --tar-option OPT
23973 give an extra option to tar (no need to quote options
23974 containing spaces)
23975 --uhc-option OPT
23977 give an extra option to uhc (no need to quote options
23978 containing spaces)
23979 --alex-options OPTS
23981 give extra options to alex
23982 --ar-options OPTS
23984 give extra options to ar
23985 --c2hs-options OPTS
23987 give extra options to c2hs
23988 --cpphs-options OPTS
23990 give extra options to cpphs
23991 --doctest-options OPTS
23993 give extra options to doctest
23994 --gcc-options OPTS
23996 give extra options to gcc
23997 --ghc-options OPTS
23999 give extra options to ghc
24000 --ghc-pkg-options OPTS
24002 give extra options to ghc-pkg
24003 --ghcjs-options OPTS
24005 give extra options to ghcjs
24006 --ghcjs-pkg-options OPTS
24008 give extra options to ghcjs-pkg
24009 --greencard-options OPTS
24011 give extra options to greencard
24012 --haddock-options OPTS
24014 give extra options to haddock
24015 --happy-options OPTS
24017 give extra options to happy
24018 --haskell-suite-options OPTS
24020 give extra options to haskell-suite
24021 --haskell-suite-pkg-options OPTS
24023 give extra options to haskell-suite-pkg
24024 --hmake-options OPTS
24026 give extra options to hmake
24027 --hpc-options OPTS
24029 give extra options to hpc
24030 --hsc2hs-options OPTS
24032 give extra options to hsc2hs
24033 --hscolour-options OPTS
24035 give extra options to hscolour
24036 --jhc-options OPTS
24038 give extra options to jhc
24039 --ld-options OPTS
24041 give extra options to ld
24042 --pkg-config-options OPTS
24044 give extra options to pkg-config
24045 --runghc-options OPTS
24047 give extra options to runghc
24048 --strip-options OPTS
24050 give extra options to strip
24051 --tar-options OPTS
24053 give extra options to tar
24054 --uhc-options OPTS
24056 give extra options to uhc
24057 --cabal-lib-version VERSION
24059 Select which version of the Cabal lib to use to build
24060 packages (useful for testing).
24061 --constraint CONSTRAINT
24063 Specify constraints on a package (version,
24064 installed/source, flags)
24065 --preference CONSTRAINT
24067 Specify preferences (soft constraints) on the version of
24068 a package
24069 --solver SOLVER
24071 Select dependency solver to use (default: modular).
24072 Choices: modular.
24073 --allow-older [DEPS]
24075 Ignore lower bounds in all dependencies or DEPS
24076 --allow-newer [DEPS]
24078 Ignore upper bounds in all dependencies or DEPS
24079 cabal sandbox
24082 Usage: cabal sandbox init [FLAGS]
24084 or: cabal sandbox delete [FLAGS]
24085 or: cabal sandbox add-source [FLAGS] PATHS
24086 or: cabal sandbox delete-source [FLAGS] PATHS
24087 or: cabal sandbox list-sources [FLAGS]
24088 or: cabal sandbox hc-pkg [FLAGS] [--] COMMAND [--] [ARGS]
24089 Sandboxes are isolated package databases that can be used to prevent
24092 dependency conflicts that arise when many different packages are
24093 installed in the same database (i.e. the user's database in the home
24094 directory).
24095 A sandbox in the current directory (created by `sandbox init`) will be
24097 used instead of the user's database for commands such as `install` and
24098 `build`. Note that (a directly invoked) GHC will not automatically be
24099 aware of sandboxes; only if called via appropriate cabal commands, e.g.
24100 `repl`, `build`, `exec`.
24101 Currently, cabal will not search for a sandbox in folders above the
24103 current one, so cabal will not see the sandbox if you are in a sub‐
24104 folder of a sandbox.
24105 Subcommands:
24107 init:
24109 Initialize a sandbox in the current directory. An existing package
24110 database
24111 will not be modified, but settings (such as the location of the data‐
24112 base)
24113 can be modified this way.
24114 delete:
24116 Remove the sandbox; deleting all the packages installed inside.
24117 add-source:
24119 Make one or more local packages available in the sandbox. PATHS may
24120 be
24121 relative or absolute. Typical usecase is when you need to make a
24122 (temporary)
24123 modification to a dependency: You download the package into a differ‐
24124 ent
24125 directory, make the modification, and add that directory to the sand‐
24126 box with
24127 `add-source`.
24128 Unless given `--snapshot`, any add-source'd dependency that was modi‐
24130 fied
24131 since the last build will be re-installed automatically.
24132 delete-source:
24134 Remove an add-source dependency; however, this will not delete the
24135 package(s) that have been installed in the sandbox from this depen‐
24136 dency. You
24137 can either unregister the package(s) via `cabal sandbox hc-pkg
24138 unregister` or re-create the sandbox (`sandbox delete; sandbox
24139 init`).
24140 list-sources:
24142 List the directories of local packages made available via `cabal
24143 sandbox
24144 add-source`.
24145 hc-pkg:
24147 Similar to `ghc-pkg`, but for the sandbox package database. Can be
24148 used to
24149 list specific/all packages that are installed in the sandbox. For
24150 subcommands, see the help for ghc-pkg. Affected by the compiler ver‐
24151 sion
24152 specified by `configure`.
24153 Relevant global configuration keys:
24157 require-sandbox
24158 ignore-sandbox
24159 Examples:
24161 Set up a sandbox with one local dependency, located at ../foo:
24162 cabal sandbox init
24163 cabal sandbox add-source ../foo
24164 cabal install --only-dependencies
24165 Reset the sandbox:
24166 cabal sandbox delete
24167 cabal sandbox init
24168 cabal install --only-dependencies
24169 List the packages in the sandbox:
24170 cabal sandbox hc-pkg list
24171 Unregister the `broken` package from the sandbox:
24172 cabal sandbox hc-pkg -- --force unregister broken
24173 The sandbox command is a part of the legacy v1 style of cabal usage.
24175 Please switch to using either the new project style and the new-sandbox
24177 command or the legacy v1-sandbox alias as new-style projects will
24178 become the default in the next version of cabal-install. Please file a
24179 bug if you cannot replicate a working v1- use case with the new-style
24180 commands.
24181 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
24183 Flags:
24186 -v, --verbose [n]
24187 Control verbosity (n is 0--3, default verbosity level is
24188 1)
24189 --snapshot
24191 Take a snapshot instead of creating a link (only applies
24192 to 'add-source')
24193 --sandbox DIR
24195 Sandbox location (default: './.cabal-sandbox').
24196 cabal v1-sandbox
24199 Usage: cabal v1-sandbox init [FLAGS]
24201 or: cabal v1-sandbox delete [FLAGS]
24202 or: cabal v1-sandbox add-source [FLAGS] PATHS
24203 or: cabal v1-sandbox delete-source [FLAGS] PATHS
24204 or: cabal v1-sandbox list-sources [FLAGS]
24205 or: cabal v1-sandbox hc-pkg [FLAGS] [--] COMMAND [--] [ARGS]
24206 Sandboxes are isolated package databases that can be used to prevent
24209 dependency conflicts that arise when many different packages are
24210 installed in the same database (i.e. the user's database in the home
24211 directory).
24212 A sandbox in the current directory (created by `v1-sandbox init`) will
24214 be used instead of the user's database for commands such as
24215 `v1-install` and `v1-build`. Note that (a directly invoked) GHC will
24216 not automatically be aware of sandboxes; only if called via appropriate
24217 cabal commands, e.g. `v1-repl`, `v1-build`, `v1-exec`.
24218 Currently, cabal will not search for a sandbox in folders above the
24220 current one, so cabal will not see the sandbox if you are in a sub‐
24221 folder of a sandbox.
24222 Subcommands:
24224 init:
24226 Initialize a sandbox in the current directory. An existing package
24227 database
24228 will not be modified, but settings (such as the location of the data‐
24229 base)
24230 can be modified this way.
24231 delete:
24233 Remove the sandbox; deleting all the packages installed inside.
24234 add-source:
24236 Make one or more local packages available in the sandbox. PATHS may
24237 be
24238 relative or absolute. Typical usecase is when you need to make a
24239 (temporary)
24240 modification to a dependency: You download the package into a differ‐
24241 ent
24242 directory, make the modification, and add that directory to the sand‐
24243 box with
24244 `add-source`.
24245 Unless given `--snapshot`, any add-source'd dependency that was modi‐
24247 fied
24248 since the last build will be re-installed automatically.
24249 delete-source:
24251 Remove an add-source dependency; however, this will not delete the
24252 package(s) that have been installed in the sandbox from this depen‐
24253 dency. You
24254 can either unregister the package(s) via `cabal v1-sandbox hc-pkg
24255 unregister` or re-create the sandbox (`v1-sandbox delete; v1-sandbox
24256 init`).
24257 list-sources:
24259 List the directories of local packages made available via `cabal
24260 v1-sandbox
24261 add-source`.
24262 hc-pkg:
24264 Similar to `ghc-pkg`, but for the sandbox package database. Can be
24265 used to
24266 list specific/all packages that are installed in the sandbox. For
24267 subcommands, see the help for ghc-pkg. Affected by the compiler ver‐
24268 sion
24269 specified by `v1-configure`.
24270 Relevant global configuration keys:
24274 require-sandbox
24275 ignore-sandbox
24276 Examples:
24278 Set up a sandbox with one local dependency, located at ../foo:
24279 cabal v1-sandbox init
24280 cabal v1-sandbox add-source ../foo
24281 cabal v1-install --only-dependencies
24282 Reset the sandbox:
24283 cabal v1-sandbox delete
24284 cabal v1-sandbox init
24285 cabal v1-install --only-dependencies
24286 List the packages in the sandbox:
24287 cabal v1-sandbox hc-pkg list
24288 Unregister the `broken` package from the sandbox:
24289 cabal v1-sandbox hc-pkg -- --force unregister broken
24290 The v1-sandbox command is a part of the legacy v1 style of cabal usage.
24292 It is a legacy feature and will be removed in a future release of
24294 cabal-install. Please file a bug if you cannot replicate a working v1-
24295 use case with the new-style commands.
24296 For more information, see: https://wiki.haskell.org/Cabal/NewBuild
24298 Flags:
24301 -v, --verbose [n]
24302 Control verbosity (n is 0--3, default verbosity level is
24303 1)
24304 --snapshot
24306 Take a snapshot instead of creating a link (only applies
24307 to 'add-source')
24308 --sandbox DIR
24310 Sandbox location (default: './.cabal-sandbox').
24311
24315 ~/.cabal/config
24316 The defaults that can be overridden with command-line options.
24317 ~/.cabal/world
24319 A list of all packages whose installation has been explicitly
24320 requested.
24321
24324 To browse the list of known issues or report a new one please see
24325 https://github.com/haskell/cabal/labels/cabal-install.
24326 CABAL(1)