cabal1
Manual page for cabal-install version 3.10.3.0
Usage
cabal [GLOBAL
FLAGS]
[COMMAND
[FLAGS]]
Overview
Command line interface to the Haskell Cabal infrastructure.
See http://www.haskell.org/cabal/ for more information.
Commands:
|
[global] |
|
user-config
|
Display and update the user's global cabal configuration. |
help
|
Help about commands. |
|
[package database] |
|
update
|
Updates list of known packages. |
list
|
List packages matching a search string. |
info
|
Display detailed information about a particular package. |
|
[initialization and download] |
|
init
|
Create a new cabal package. |
fetch
|
Downloads packages for later installation. |
get
|
Download/Extract a package's source code (repository). |
|
[project configuration] |
|
configure
|
Add extra project configuration. |
freeze
|
Freeze dependencies. |
gen-bounds
|
Generate dependency bounds. |
outdated
|
Check for outdated dependencies. |
|
[project building and installing] |
|
build
|
Compile targets within the project. |
install
|
Install packages. |
haddock
|
Build Haddock documentation. |
haddock-project
|
Generate Haddocks HTML documentation for the cabal project. |
clean
|
Clean the package store and remove temporary files. |
|
[running and testing] |
|
list-bin
|
List the path to a single executable. |
repl
|
Open an interactive session for the given component. |
run
|
Run an executable. |
bench
|
Run benchmarks. |
test
|
Run test-suites. |
exec
|
Give a command access to the store. |
|
[sanity checks and shipping] |
|
check
|
Check the package for common mistakes. |
sdist
|
Generate a source distribution file (.tar.gz). |
upload
|
Uploads source packages or documentation to Hackage. |
report
|
Upload build reports to a remote server. |
|
[deprecated] |
|
unpack
|
Deprecated alias for 'get'. |
hscolour
|
Generate HsColour colourised code, in HTML format. |
|
[new-style projects (forwards-compatible aliases)] |
|
v2-build
|
Compile targets within the project. |
v2-configure
|
Add extra project configuration. |
v2-repl
|
Open an interactive session for the given component. |
v2-run
|
Run an executable. |
v2-test
|
Run test-suites. |
v2-bench
|
Run benchmarks. |
v2-freeze
|
Freeze dependencies. |
v2-haddock
|
Build Haddock documentation. |
v2-exec
|
Give a command access to the store. |
v2-update
|
Updates list of known packages. |
v2-install
|
Install packages. |
v2-clean
|
Clean the package store and remove temporary files. |
v2-sdist
|
Generate a source distribution file (.tar.gz). |
|
[legacy command aliases] |
|
v1-build
|
Compile all/specific components. |
v1-configure
|
Prepare to build the package. |
v1-repl
|
Open an interpreter session for the given component. |
v1-run
|
Builds and runs an executable. |
v1-test
|
Run all/specific tests in the test suite. |
v1-bench
|
Run all/specific benchmarks. |
v1-freeze
|
Freeze dependencies. |
v1-haddock
|
Generate Haddock HTML documentation. |
v1-install
|
Install packages. |
v1-clean
|
Clean up after a build. |
v1-copy
|
Copy the files of all/specific components to install locations. |
v1-register
|
Register this package with the compiler. |
v1-reconfigure
|
Reconfigure the package if necessary. |
|
[other] |
|
haddock-project
|
Generate Haddocks HTML documentation for the cabal project. |
new-haddock-project
|
Generate Haddocks HTML documentation for the cabal project. |
v2-haddock-project
|
Generate Haddocks HTML documentation for the cabal project. |
For more information about a command use:
-
cabal COMMAND
--help
or cabal help COMMAND
To install Cabal packages from hackage use:
-
cabal install foo [--dry-run]
Occasionally you need to update the list of available packages:
-
cabal update
Global flags:
-
-h, --help -
Show this help text
-
-V, --version -
Print version information
-
--numeric-version -
Print just the version number
-
--config-file=FILE -
Set an alternate location for the config file
-
--ignore-expiry -
Ignore expiry dates on signed metadata (use only in exceptional circumstances)
-
--http-transport=HttpTransport -
Set a transport for http(s) requests. Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')
--nix[=(True or False)]-
Nix integration: run commands through nix-shell if a 'shell.nix' file exists (default is False)
-
--enable-nix -
Enable Nix integration: run commands through nix-shell if a 'shell.nix' file exists
-
--disable-nix -
Disable Nix integration
-
--store-dir=DIR -
The location of the build store
-
--active-repositories=REPOS -
The active package repositories (set to ':none' to disable all repositories)
You can edit the cabal configuration file to set defaults:
-
/homedoesnotexistatbuildtime/.config/cabal/config
This file will be generated with sensible defaults if you run 'cabal update'.
compiled using version 3.10.3.0 of the Cabal library
Releases
3 releases since Debian 11 (Bullseye); the text changed 2 times.
--active-repositories since Debian 13 (Trixie);
--disable-nix since Debian 12 (Bookworm);
--enable-nix since Debian 12 (Bookworm);
--help since Debian 12 (Bookworm);
--http-transport since Debian 13 (Trixie);
--ignore-expiry since Debian 12 (Bookworm);
--numeric-version since Debian 12 (Bookworm);
--store-dir since Debian 13 (Trixie);
-V since Debian 12 (Bookworm);
-h since Debian 12 (Bookworm).
--alex-option until Debian 11 (Bullseye);
--alex-options until Debian 11 (Bullseye);
--allow-newer until Debian 11 (Bullseye);
--allow-older until Debian 11 (Bullseye);
--application-dir until Debian 11 (Bullseye);
--ar-option until Debian 11 (Bullseye);
--ar-options until Debian 11 (Bullseye);
--augment until Debian 11 (Bullseye);
--author until Debian 11 (Bullseye);
--benchmark-option until Debian 11 (Bullseye);
--benchmark-options until Debian 11 (Bullseye);
--bindir until Debian 11 (Bullseye);
--build-depends until Debian 11 (Bullseye);
--build-log until Debian 11 (Bullseye);
--build-summary until Debian 11 (Bullseye);
--build-tool until Debian 11 (Bullseye);
--builddir until Debian 11 (Bullseye);
--c2hs-option until Debian 11 (Bullseye);
--c2hs-options until Debian 11 (Bullseye);
--cabal-file until Debian 11 (Bullseye);
--cabal-lib-version until Debian 11 (Bullseye);
--cabal-version until Debian 11 (Bullseye);
--category until Debian 11 (Bullseye);
--cid until Debian 11 (Bullseye);
--configure-option until Debian 11 (Bullseye);
--constraint until Debian 11 (Bullseye);
--contents-location until Debian 11 (Bullseye);
--cpphs-option until Debian 11 (Bullseye);
--cpphs-options until Debian 11 (Bullseye);
--css until Debian 11 (Bullseye);
--datadir until Debian 11 (Bullseye);
--datasubdir until Debian 11 (Bullseye);
--default-user-config until Debian 12 (Bookworm);
--dependency until Debian 11 (Bullseye);
--destdir until Debian 11 (Bullseye);
--disable-debug-info until Debian 11 (Bullseye);
--disable-optimisation until Debian 11 (Bullseye);
--disable-optimization until Debian 11 (Bullseye);
--distdir until Debian 11 (Bullseye);
--distpref until Debian 11 (Bullseye);
--doc-index-file until Debian 11 (Bullseye);
--docdir until Debian 11 (Bullseye);
--doctest-option until Debian 11 (Bullseye);
--doctest-options until Debian 11 (Bullseye);
--dynlibdir until Debian 11 (Bullseye);
--email until Debian 11 (Bullseye);
--enable-debug-info until Debian 11 (Bullseye);
--enable-optimisation until Debian 11 (Bullseye);
--enable-optimization until Debian 11 (Bullseye);
--env until Debian 11 (Bullseye);
--exe until Debian 11 (Bullseye);
--expose-module until Debian 11 (Bullseye);
--extension until Debian 11 (Bullseye);
--extra-framework-dirs until Debian 11 (Bullseye);
--extra-include-dirs until Debian 11 (Bullseye);
--extra-lib-dirs until Debian 11 (Bullseye);
--extra-prog-path until Debian 11 (Bullseye);
--extra-source-file until Debian 11 (Bullseye);
--flags until Debian 11 (Bullseye);
--for-hackage until Debian 11 (Bullseye);
--gcc-option until Debian 11 (Bullseye);
--gcc-options until Debian 11 (Bullseye);
--gen-pkg-config until Debian 11 (Bullseye);
--ghc until Debian 11 (Bullseye);
--ghc-option until Debian 11 (Bullseye);
--ghc-options until Debian 11 (Bullseye);
--ghc-pkg-option until Debian 11 (Bullseye);
--ghc-pkg-options until Debian 11 (Bullseye);
--ghcjs until Debian 11 (Bullseye);
--ghcjs-option until Debian 11 (Bullseye);
--ghcjs-options until Debian 11 (Bullseye);
--ghcjs-pkg-option until Debian 11 (Bullseye);
--ghcjs-pkg-options until Debian 11 (Bullseye);
--global until Debian 11 (Bullseye);
--greencard-option until Debian 11 (Bullseye);
--greencard-options until Debian 11 (Bullseye);
--haddock-contents-location until Debian 11 (Bullseye);
--haddock-css until Debian 11 (Bullseye);
--haddock-for-hackage until Debian 11 (Bullseye);
--haddock-hscolour-css until Debian 11 (Bullseye);
--haddock-html-location until Debian 11 (Bullseye);
--haddock-option until Debian 11 (Bullseye);
--haddock-options until Debian 11 (Bullseye);
--haddockdir until Debian 11 (Bullseye);
--happy-option until Debian 11 (Bullseye);
--happy-options until Debian 11 (Bullseye);
--haskell-suite until Debian 11 (Bullseye);
--haskell-suite-option until Debian 11 (Bullseye);
--haskell-suite-options until Debian 11 (Bullseye);
--haskell-suite-pkg-option until Debian 11 (Bullseye);
--haskell-suite-pkg-options until Debian 11 (Bullseye);
--hmake-option until Debian 11 (Bullseye);
--hmake-options until Debian 11 (Bullseye);
--homepage until Debian 11 (Bullseye);
--hpc-option until Debian 11 (Bullseye);
--hpc-options until Debian 11 (Bullseye);
--hsc2hs-option until Debian 11 (Bullseye);
--hsc2hs-options until Debian 11 (Bullseye);
--hscolour-css until Debian 11 (Bullseye);
--hscolour-option until Debian 11 (Bullseye);
--hscolour-options until Debian 11 (Bullseye);
--html-location until Debian 11 (Bullseye);
--htmldir until Debian 11 (Bullseye);
--ignore until Debian 11 (Bullseye);
--index-state until Debian 11 (Bullseye);
--install-method until Debian 11 (Bullseye);
--installdir until Debian 11 (Bullseye);
--instantiate-with until Debian 11 (Bullseye);
--ipid until Debian 11 (Bullseye);
--is-executable until Debian 11 (Bullseye);
--is-libandexe until Debian 11 (Bullseye);
--is-library until Debian 11 (Bullseye);
--jhc-option until Debian 11 (Bullseye);
--jhc-options until Debian 11 (Bullseye);
--jobs until Debian 11 (Bullseye);
--language until Debian 11 (Bullseye);
--ld-option until Debian 11 (Bullseye);
--ld-options until Debian 11 (Bullseye);
--lib until Debian 11 (Bullseye);
--libandexe until Debian 11 (Bullseye);
--libdir until Debian 11 (Bullseye);
--libexecdir until Debian 11 (Bullseye);
--libexecsubdir until Debian 11 (Bullseye);
--library-profiling-detail until Debian 11 (Bullseye);
--libsubdir until Debian 11 (Bullseye);
--license until Debian 11 (Bullseye);
--list-sources until Debian 11 (Bullseye);
--local-repo until Debian 11 (Bullseye);
--log until Debian 11 (Bullseye);
--logs-dir until Debian 11 (Bullseye);
--logsdir until Debian 11 (Bullseye);
--machine-log until Debian 11 (Bullseye);
--main-is until Debian 11 (Bullseye);
--max-backjumps until Debian 11 (Bullseye);
--minor until Debian 11 (Bullseye);
--only until Debian 11 (Bullseye);
--output-dir until Debian 11 (Bullseye);
--output-directory until Debian 11 (Bullseye);
--outputdir until Debian 11 (Bullseye);
--overwrite-policy until Debian 11 (Bullseye);
--package-db until Debian 11 (Bullseye);
--package-dir until Debian 11 (Bullseye);
--package-env until Debian 11 (Bullseye);
--package-name until Debian 11 (Bullseye);
--packagedir until Debian 11 (Bullseye);
--password until Debian 11 (Bullseye);
--password-command until Debian 11 (Bullseye);
--pkg-config-option until Debian 11 (Bullseye);
--pkg-config-options until Debian 11 (Bullseye);
--preference until Debian 11 (Bullseye);
--prefix until Debian 11 (Bullseye);
--profiling-detail until Debian 11 (Bullseye);
--program-prefix until Debian 11 (Bullseye);
--program-suffix until Debian 11 (Bullseye);
--project-file until Debian 11 (Bullseye);
--publish until Debian 11 (Bullseye);
--reject-unconstrained-dependencies until Debian 11 (Bullseye);
--remote-build-reporting until Debian 11 (Bullseye);
--remote-repo until Debian 11 (Bullseye);
--remote-repo-cache until Debian 11 (Bullseye);
--repl-options until Debian 11 (Bullseye);
--root-cmd until Debian 11 (Bullseye);
--runghc-option until Debian 11 (Bullseye);
--runghc-options until Debian 11 (Bullseye);
--sandbox until Debian 11 (Bullseye);
--sandbox-config-file until Debian 11 (Bullseye);
--show-details until Debian 11 (Bullseye);
--solver until Debian 11 (Bullseye);
--source-dir until Debian 11 (Bullseye);
--source-repository until Debian 11 (Bullseye);
--sourcedir until Debian 11 (Bullseye);
--storedir until Debian 11 (Bullseye);
--strip-option until Debian 11 (Bullseye);
--strip-options until Debian 11 (Bullseye);
--symlink-bindir until Debian 11 (Bullseye);
--synopsis until Debian 11 (Bullseye);
--sysconfdir until Debian 11 (Bullseye);
--tar-option until Debian 11 (Bullseye);
--tar-options until Debian 11 (Bullseye);
--target-package-db until Debian 11 (Bullseye);
--test-dir until Debian 11 (Bullseye);
--test-log until Debian 11 (Bullseye);
--test-machine-log until Debian 11 (Bullseye);
--test-option until Debian 11 (Bullseye);
--test-options until Debian 11 (Bullseye);
--test-show-details until Debian 11 (Bullseye);
--test-wrapper until Debian 11 (Bullseye);
--uhc until Debian 11 (Bullseye);
--uhc-option until Debian 11 (Bullseye);
--uhc-options until Debian 11 (Bullseye);
--user until Debian 11 (Bullseye);
--username until Debian 11 (Bullseye);
--verbose until Debian 11 (Bullseye);
--with-alex until Debian 11 (Bullseye);
--with-ar until Debian 11 (Bullseye);
--with-c2hs until Debian 11 (Bullseye);
--with-compiler until Debian 11 (Bullseye);
--with-cpphs until Debian 11 (Bullseye);
--with-doctest until Debian 11 (Bullseye);
--with-gcc until Debian 11 (Bullseye);
--with-ghc until Debian 11 (Bullseye);
--with-ghc-pkg until Debian 11 (Bullseye);
--with-ghcjs until Debian 11 (Bullseye);
--with-ghcjs-pkg until Debian 11 (Bullseye);
--with-greencard until Debian 11 (Bullseye);
--with-haddock until Debian 11 (Bullseye);
--with-happy until Debian 11 (Bullseye);
--with-haskell-suite until Debian 11 (Bullseye);
--with-haskell-suite-pkg until Debian 11 (Bullseye);
--with-hc-pkg until Debian 11 (Bullseye);
--with-hmake until Debian 11 (Bullseye);
--with-hpc until Debian 11 (Bullseye);
--with-hsc2hs until Debian 11 (Bullseye);
--with-hscolour until Debian 11 (Bullseye);
--with-jhc until Debian 11 (Bullseye);
--with-ld until Debian 11 (Bullseye);
--with-pkg-config until Debian 11 (Bullseye);
--with-runghc until Debian 11 (Bullseye);
--with-strip until Debian 11 (Bullseye);
--with-tar until Debian 11 (Bullseye);
--with-uhc until Debian 11 (Bullseye);
--world-file until Debian 11 (Bullseye);
--write-ghc-environment-files until Debian 11 (Bullseye);
-O until Debian 11 (Bullseye);
-P until Debian 11 (Bullseye);
-a until Debian 11 (Bullseye);
-b until Debian 11 (Bullseye);
-c until Debian 11 (Bullseye);
-d until Debian 11 (Bullseye);
-e until Debian 11 (Bullseye);
-f until Debian 11 (Bullseye);
-g until Debian 11 (Bullseye);
-j until Debian 11 (Bullseye);
-l until Debian 11 (Bullseye);
-o until Debian 11 (Bullseye);
-p until Debian 11 (Bullseye);
-s until Debian 11 (Bullseye);
-u until Debian 11 (Bullseye);
-v until Debian 11 (Bullseye);
-w until Debian 11 (Bullseye);
-x until Debian 11 (Bullseye).