Cabal
3.4
1. Getting Started with Haskell and Cabal
2. Introduction
3. Configuration and Installing Packages
4. Package Concepts and Development
5. Nix-style Local Builds
6. cabal-install Commands
7. Package Description
8. cabal.project Reference
9. Setup.hs Commands
10. Package Description Format Specification History
11. Field Syntax Reference
12. Reporting Bugs and Stability of Cabal Interfaces
13. Nix Integration
Reference
Index
Cabal
Docs
»
Index
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
Symbols
--allow-boot-library-installs
cabal project option
--allow-newer
cabal project option
--allow-newer[=pkgs]
runhaskell-Setup.hs-configure command line option
--allow-older
cabal project option
--allow-older[=pkgs]
runhaskell-Setup.hs-configure command line option
--benchmark-option=option
runhaskell-Setup.hs-test command line option
--benchmark-options=options
runhaskell-Setup.hs-test command line option
--bindir=dir
runhaskell-Setup.hs-configure command line option
--build-summary
cabal project option
--builddir=DIR
command line option
--builddir=dir
runhaskell-Setup.hs-test command line option
--cabal-lib-version
cabal project option
--cid=cid
runhaskell-Setup.hs-configure command line option
--compiler
cabal project option
--configure-option
cabal project option
--configure-option=str
runhaskell-Setup.hs-configure command line option
--constraint
cabal project option
--constraint=constraint
runhaskell-Setup.hs-configure command line option
--count-conflicts
cabal project option
--css=path
runhaskell-Setup.hs-haddock command line option
runhaskell-Setup.hs-hscolour command line option
--datadir=dir
runhaskell-Setup.hs-configure command line option
--datasubdir=dir
runhaskell-Setup.hs-configure command line option
--default-user-config=file
runhaskell-Setup.hs-configure command line option
--dependency[=pkgname=ipid]
runhaskell-Setup.hs-configure command line option
--destdir=path
runhaskell-Setup.hs-copy command line option
--disable-benchmarks
cabal project option
--disable-coverage
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-debug-info
cabal project option
--disable-documentation
cabal project option
--disable-executable-dynamic
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-executable-profiling
cabal project option
--disable-executable-static
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-executable-stripping
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-library-coverage
cabal project option
--disable-library-for-ghci
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-library-profiling
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-library-stripping
cabal project option
--disable-library-vanilla
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-optimization
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-profiling
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-response-files
runhaskell-Setup.hs-configure command line option
--disable-shared
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-split-objs
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-split-sections
cabal project option
--disable-static
cabal project option
runhaskell-Setup.hs-configure command line option
--disable-tests
cabal project option
runhaskell-Setup.hs-configure command line option
--doc-index-file
cabal project option
--docdir=dir
runhaskell-Setup.hs-configure command line option
--dynlibdir=dir
runhaskell-Setup.hs-configure command line option
--enable-benchmarks
cabal project option
--enable-coverage
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-debug-info
cabal project option
--enable-documentation
cabal project option
--enable-executable-dynamic
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-executable-profiling
cabal project option
--enable-executable-static
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-executable-stripping
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-library-coverage
cabal project option
--enable-library-for-ghci
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-library-profiling
cabal project option
--enable-library-profiling or -p
runhaskell-Setup.hs-configure command line option
--enable-library-stripping
cabal project option
--enable-library-vanilla
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-optimization
cabal project option
--enable-optimization[=n] or -O [n]
runhaskell-Setup.hs-configure command line option
--enable-profiling
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-shared
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-split-objs
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-split-sections
cabal project option
--enable-static
cabal project option
runhaskell-Setup.hs-configure command line option
--enable-tests
cabal project option
runhaskell-Setup.hs-configure command line option
--exact-configuration
runhaskell-Setup.hs-configure command line option
--executables
runhaskell-Setup.hs-haddock command line option
runhaskell-Setup.hs-hscolour command line option
--extra-framework-dirs
cabal project option
--extra-framework-dirs[=dir]
runhaskell-Setup.hs-configure command line option
--extra-include-dirs
cabal project option
--extra-include-dirs[=dir]
runhaskell-Setup.hs-configure command line option
--extra-lib-dirs
cabal project option
--extra-lib-dirs[=dir]
runhaskell-Setup.hs-configure command line option
--extra-prog-path
cabal project option
--fine-grained-conflicts
cabal project option
--flags
cabal project option
--flags=flagspecs
runhaskell-Setup.hs-configure command line option
--gen-pkg-config[=path]
runhaskell-Setup.hs-register command line option
--gen-script
runhaskell-Setup.hs-register command line option
runhaskell-Setup.hs-unregister command line option
--ghc or -g
runhaskell-Setup.hs-configure command line option
--global
runhaskell-Setup.hs-configure command line option
runhaskell-Setup.hs-install command line option
runhaskell-Setup.hs-register command line option
runhaskell-Setup.hs-unregister command line option
--help
setup command line option
--hoogle
runhaskell-Setup.hs-haddock command line option
--hscolour-css=path
runhaskell-Setup.hs-haddock command line option
--html-location
cabal project option
--html-location=url
runhaskell-Setup.hs-haddock command line option
--htmldir=dir
runhaskell-Setup.hs-configure command line option
--http-transport
cabal project option
--human-log=path
runhaskell-Setup.hs-test command line option
--hyperlink-source
runhaskell-Setup.hs-haddock command line option
--ignore-expiry
cabal project option
--inplace
runhaskell-Setup.hs-register command line option
--internal
runhaskell-Setup.hs-haddock command line option
--ipid=ipid
runhaskell-Setup.hs-configure command line option
--jhc
runhaskell-Setup.hs-configure command line option
--jobs
cabal project option
--keep-going
cabal project option
--lhc
runhaskell-Setup.hs-configure command line option
--libdir=dir
runhaskell-Setup.hs-configure command line option
--libexecdir=dir
runhaskell-Setup.hs-configure command line option
--libexecsubdir=dir
runhaskell-Setup.hs-configure command line option
--library-profiling-detail
cabal project option
--library-profiling-detail[=level]
runhaskell-Setup.hs-configure command line option
--libsubdir=dir
runhaskell-Setup.hs-configure command line option
--logs-dir
cabal project option
--machine-log=path
runhaskell-Setup.hs-test command line option
--max-backjumps
cabal project option
--minimize-conflict-set
cabal project option
--no-allow-boot-library-installs
cabal project option
--no-count-conflicts
cabal project option
--no-fine-grained-conflicts
cabal project option
--no-minimize-conflict-set
cabal project option
--no-reorder-goals
cabal project option
--no-strong-flags
cabal project option
--package-db=db
runhaskell-Setup.hs-configure command line option
--preference
cabal project option
--preference=preference
runhaskell-Setup.hs-configure command line option
--prefix=dir
runhaskell-Setup.hs-configure command line option
--profiling-detail
cabal project option
--profiling-detail[=level]
runhaskell-Setup.hs-configure command line option
--prog-option=option
runhaskell-Setup.hs-build command line option
runhaskell-Setup.hs-configure command line option
--prog-options=options
runhaskell-Setup.hs-build command line option
runhaskell-Setup.hs-configure command line option
--program-prefix
cabal project option
--program-prefix=prefix
runhaskell-Setup.hs-configure command line option
--program-suffix
cabal project option
--program-suffix=suffix
runhaskell-Setup.hs-configure command line option
--project-file=FILE
command line option
--reject-unconstrained-dependencies
cabal project option
--relocatable
cabal project option
--remote-repo-cache
cabal project option
--reorder-goals
cabal project option
--run-tests
cabal project option
--save-configure
runhaskell-Setup.hs-clean command line option
--show-details=filter
runhaskell-Setup.hs-test command line option
--snapshot
runhaskell-Setup.hs-sdist command line option
--solver
cabal project option
--store-dir=DIR
command line option
--strong-flags
cabal project option
--sysconfdir=dir
runhaskell-Setup.hs-configure command line option
--test-option=option
runhaskell-Setup.hs-test command line option
--test-options=options
runhaskell-Setup.hs-test command line option
--test-wrapper=path
runhaskell-Setup.hs-test command line option
--uhc
runhaskell-Setup.hs-configure command line option
--user
runhaskell-Setup.hs-configure command line option
runhaskell-Setup.hs-install command line option
runhaskell-Setup.hs-register command line option
runhaskell-Setup.hs-unregister command line option
--verbose
cabal project option
--verbose=n or -v n
setup command line option
--with-compiler
cabal project option
--with-compiler=path or -w *path*
runhaskell-Setup.hs-configure command line option
--with-hc-pkg
cabal project option
--with-hc-pkg=path
runhaskell-Setup.hs-configure command line option
--with-prog=path
runhaskell-Setup.hs-configure command line option
--world-file
cabal project option
--write-ghc-environment-files
cabal project option
-f flagname or -f -flagname
runhaskell-Setup.hs-configure command line option
-h or -?
setup command line option
-s
runhaskell-Setup.hs-clean command line option
A
active-repositories
cabal project option
allow-boot-library-installs
cabal project option
allow-newer
cabal project option
allow-older
cabal project option
asm-options
package.cabal field
asm-sources
package.cabal field
author
package.cabal field
autogen-includes
package.cabal field
autogen-modules
package.cabal field
B
benchmark:benchmark
package.cabal section
benchmark:main-is
package.cabal field
benchmark:type
package.cabal field
benchmarks
cabal project option
bug-reports
package.cabal field
build-depends
package.cabal field
build-summary
cabal project option
build-tool-depends
package.cabal field
build-tools
package.cabal field
build-type
package.cabal field
buildable
package.cabal field
C
c-sources
package.cabal field
cabal project option
--allow-boot-library-installs
--allow-newer
--allow-older
--build-summary
--cabal-lib-version
--compiler
--configure-option
--constraint
--count-conflicts
--disable-benchmarks
--disable-coverage
--disable-debug-info
--disable-documentation
--disable-executable-dynamic
--disable-executable-profiling
--disable-executable-static
--disable-executable-stripping
--disable-library-coverage
--disable-library-for-ghci
--disable-library-profiling
--disable-library-stripping
--disable-library-vanilla
--disable-optimization
--disable-profiling
--disable-shared
--disable-split-objs
--disable-split-sections
--disable-static
--disable-tests
--doc-index-file
--enable-benchmarks
--enable-coverage
--enable-debug-info
--enable-documentation
--enable-executable-dynamic
--enable-executable-profiling
--enable-executable-static
--enable-executable-stripping
--enable-library-coverage
--enable-library-for-ghci
--enable-library-profiling
--enable-library-stripping
--enable-library-vanilla
--enable-optimization
--enable-profiling
--enable-shared
--enable-split-objs
--enable-split-sections
--enable-static
--enable-tests
--extra-framework-dirs
--extra-include-dirs
--extra-lib-dirs
--extra-prog-path
--fine-grained-conflicts
--flags
--html-location
--http-transport
--ignore-expiry
--jobs
--keep-going
--library-profiling-detail
--logs-dir
--max-backjumps
--minimize-conflict-set
--no-allow-boot-library-installs
--no-count-conflicts
--no-fine-grained-conflicts
--no-minimize-conflict-set
--no-reorder-goals
--no-strong-flags
--preference
--profiling-detail
--program-prefix
--program-suffix
--reject-unconstrained-dependencies
--relocatable
--remote-repo-cache
--reorder-goals
--run-tests
--solver
--strong-flags
--verbose
--with-compiler
--with-hc-pkg
--world-file
--write-ghc-environment-files
active-repositories
allow-boot-library-installs
allow-newer
allow-older
benchmarks
build-summary
cabal-lib-version
compiler
configure-options
constraints
count-conflicts
coverage
debug-info
doc-index-file
documentation
executable-dynamic
executable-profiling
executable-static
executable-stripping
extra-framework-dirs
extra-include-dirs
extra-lib-dirs
extra-packages
extra-prog-path
fine-grained-conflicts
flags
haddock-all
haddock-benchmarks
haddock-contents-location
haddock-css
haddock-executables
haddock-hoogle
haddock-hscolour-css
haddock-html
haddock-html-location
haddock-hyperlink-source
haddock-internal
haddock-keep-temp-files
haddock-tests
http-transport
ignore-expiry
index-state
jobs
keep-going
library-coverage
library-for-ghci
library-profiling
library-profiling-detail
library-stripping
library-vanilla
logs-dir
max-backjumps
minimize-conflict-set
optimization
optional-packages
packages
preferences
profiling
profiling-detail
program-prefix
program-suffix
reject-unconstrained-dependencies
relocatable
remote-repo-cache
reorder-goals
run-tests
shared
solver
split-objs
split-sections
static
strong-flags
tests
verbose
with-compiler
with-hc-pkg
world-file
write-ghc-environment-files
cabal-lib-version
cabal project option
cabal-version
package.cabal field
category
package.cabal field
cc-options
package.cabal field
cmm-options
package.cabal field
cmm-sources
package.cabal field
command line option
--builddir=DIR
--project-file=FILE
--store-dir=DIR
common:common
package.cabal section
compiler
cabal project option
configure-options
cabal project option
constraints
cabal project option
copyright
package.cabal field
count-conflicts
cabal project option
coverage
cabal project option
cpp-options
package.cabal field
custom-setup:custom-setup
package.cabal section
custom-setup:setup-depends
package.cabal field
cxx-options
package.cabal field
cxx-sources
package.cabal field
D
data-dir
package.cabal field
data-files
package.cabal field
debug-info
cabal project option
default-extensions
package.cabal field
default-language
package.cabal field
description
package.cabal field
doc-index-file
cabal project option
documentation
cabal project option
E
environment variable
PATH
executable-dynamic
cabal project option
executable-profiling
cabal project option
executable-static
cabal project option
executable-stripping
cabal project option
executable:executable
package.cabal section
executable:main-is
package.cabal field
executable:scope
package.cabal field
extensions
package.cabal field
extra-bundled-libraries
package.cabal field
extra-doc-files
package.cabal field
extra-dynamic-library-flavours
package.cabal field
extra-framework-dirs
cabal project option
package.cabal field
extra-ghci-libraries
package.cabal field
extra-include-dirs
cabal project option
extra-lib-dirs
cabal project option
package.cabal field
extra-libraries
package.cabal field
extra-library-flavours
package.cabal field
extra-packages
cabal project option
extra-prog-path
cabal project option
extra-source-files
package.cabal field
extra-tmp-files
package.cabal field
F
fine-grained-conflicts
cabal project option
flag:default
package.cabal field
flag:description
package.cabal field
flag:flag
package.cabal section
flag:manual
package.cabal field
flags
cabal project option
foreign-library:foreign-library
package.cabal section
foreign-library:lib-version-info
package.cabal field
foreign-library:lib-version-linux
package.cabal field
foreign-library:mod-def-file
package.cabal field
foreign-library:options
package.cabal field
foreign-library:type
package.cabal field
frameworks
package.cabal field
G
ghc-options
package.cabal field
ghc-prof-options
package.cabal field
ghc-shared-options
package.cabal field
ghcjs-options
package.cabal field
ghcjs-prof-options
package.cabal field
ghcjs-shared-options
package.cabal field
Give extra options to the benchmark executables.
runhaskell-Setup.hs-test command line option
Give extra options to the test executables.
runhaskell-Setup.hs-test command line option
H
haddock-all
cabal project option
haddock-benchmarks
cabal project option
haddock-contents-location
cabal project option
haddock-css
cabal project option
haddock-executables
cabal project option
haddock-hoogle
cabal project option
haddock-hscolour-css
cabal project option
haddock-html
cabal project option
haddock-html-location
cabal project option
haddock-hyperlink-source
cabal project option
haddock-internal
cabal project option
haddock-keep-temp-files
cabal project option
haddock-tests
cabal project option
homepage
package.cabal field
hs-source-dir
package.cabal field
hs-source-dirs
package.cabal field
http-transport
cabal project option
I
ignore-expiry
cabal project option
import
package.cabal field
include-dirs
package.cabal field
includes
package.cabal field
index-state
cabal project option
install-includes
package.cabal field
J
jobs
cabal project option
js-sources
package.cabal field
K
keep-going
cabal project option
L
ld-options
package.cabal field
library-coverage
cabal project option
library-for-ghci
cabal project option
library-profiling
cabal project option
library-profiling-detail
cabal project option
library-stripping
cabal project option
library-vanilla
cabal project option
library:exposed
package.cabal field
library:exposed-modules
package.cabal field
library:library
package.cabal section
library:reexported-modules
package.cabal field
library:signatures
package.cabal field
library:virtual-modules
package.cabal field
library:visibility
package.cabal field
license
package.cabal field
license-file
package.cabal field
license-files
package.cabal field
logs-dir
cabal project option
M
maintainer
package.cabal field
max-backjumps
cabal project option
minimize-conflict-set
cabal project option
mixins
package.cabal field
N
name
package.cabal field
O
optimization
cabal project option
optional-packages
cabal project option
other-extensions
package.cabal field
other-languages
package.cabal field
other-modules
package.cabal field
P
package-url
package.cabal field
package.cabal field
asm-options
asm-sources
author
autogen-includes
autogen-modules
benchmark:main-is
benchmark:type
bug-reports
build-depends
build-tool-depends
build-tools
build-type
buildable
c-sources
cabal-version
category
cc-options
cmm-options
cmm-sources
copyright
cpp-options
custom-setup:setup-depends
cxx-options
cxx-sources
data-dir
data-files
default-extensions
default-language
description
executable:main-is
executable:scope
extensions
extra-bundled-libraries
extra-doc-files
extra-dynamic-library-flavours
extra-framework-dirs
extra-ghci-libraries
extra-lib-dirs
extra-libraries
extra-library-flavours
extra-source-files
extra-tmp-files
flag:default
flag:description
flag:manual
foreign-library:lib-version-info
foreign-library:lib-version-linux
foreign-library:mod-def-file
foreign-library:options
foreign-library:type
frameworks
ghc-options
ghc-prof-options
ghc-shared-options
ghcjs-options
ghcjs-prof-options
ghcjs-shared-options
homepage
hs-source-dir
hs-source-dirs
import
include-dirs
includes
install-includes
js-sources
ld-options
library:exposed
library:exposed-modules
library:reexported-modules
library:signatures
library:virtual-modules
library:visibility
license
license-file
license-files
maintainer
mixins
name
other-extensions
other-languages
other-modules
package-url
pkgconfig-depends
source-repository:branch
source-repository:location
source-repository:module
source-repository:subdir
source-repository:tag
source-repository:type
stability
synopsis
test-suite:main-is
test-suite:test-module
test-suite:type
tested-with
version
virtual-modules
package.cabal section
benchmark:benchmark
common:common
custom-setup:custom-setup
executable:executable
flag:flag
foreign-library:foreign-library
library:library
source-repository:source-repository
test-suite:test-suite
packages
cabal project option
PATH
pkgconfig-depends
package.cabal field
preferences
cabal project option
profiling
cabal project option
profiling-detail
cabal project option
program-prefix
cabal project option
program-suffix
cabal project option
R
reject-unconstrained-dependencies
cabal project option
relocatable
cabal project option
remote-repo-cache
cabal project option
reorder-goals
cabal project option
run-tests
cabal project option
runhaskell-Setup.hs-build command line option
--prog-option=option
--prog-options=options
runhaskell-Setup.hs-clean command line option
--save-configure
-s
runhaskell-Setup.hs-configure command line option
--allow-newer[=pkgs]
--allow-older[=pkgs]
--bindir=dir
--cid=cid
--configure-option=str
--constraint=constraint
--datadir=dir
--datasubdir=dir
--default-user-config=file
--dependency[=pkgname=ipid]
--disable-coverage
--disable-executable-dynamic
--disable-executable-static
--disable-executable-stripping
--disable-library-for-ghci
--disable-library-profiling
--disable-library-vanilla
--disable-optimization
--disable-profiling
--disable-response-files
--disable-shared
--disable-split-objs
--disable-static
--disable-tests
--docdir=dir
--dynlibdir=dir
--enable-coverage
--enable-executable-dynamic
--enable-executable-static
--enable-executable-stripping
--enable-library-for-ghci
--enable-library-profiling or -p
--enable-library-vanilla
--enable-optimization[=n] or -O [n]
--enable-profiling
--enable-shared
--enable-split-objs
--enable-static
--enable-tests
--exact-configuration
--extra-framework-dirs[=dir]
--extra-include-dirs[=dir]
--extra-lib-dirs[=dir]
--flags=flagspecs
--ghc or -g
--global
--htmldir=dir
--ipid=ipid
--jhc
--lhc
--libdir=dir
--libexecdir=dir
--libexecsubdir=dir
--library-profiling-detail[=level]
--libsubdir=dir
--package-db=db
--preference=preference
--prefix=dir
--profiling-detail[=level]
--prog-option=option
--prog-options=options
--program-prefix=prefix
--program-suffix=suffix
--sysconfdir=dir
--uhc
--user
--with-compiler=path or -w *path*
--with-hc-pkg=path
--with-prog=path
-f flagname or -f -flagname
runhaskell-Setup.hs-copy command line option
--destdir=path
runhaskell-Setup.hs-haddock command line option
--css=path
--executables
--hoogle
--hscolour-css=path
--html-location=url
--hyperlink-source
--internal
runhaskell-Setup.hs-hscolour command line option
--css=path
--executables
runhaskell-Setup.hs-install command line option
--global
--user
runhaskell-Setup.hs-register command line option
--gen-pkg-config[=path]
--gen-script
--global
--inplace
--user
runhaskell-Setup.hs-sdist command line option
--snapshot
runhaskell-Setup.hs-test command line option
--benchmark-option=option
--benchmark-options=options
--builddir=dir
--human-log=path
--machine-log=path
--show-details=filter
--test-option=option
--test-options=options
--test-wrapper=path
Give extra options to the benchmark executables.
Give extra options to the test executables.
runhaskell-Setup.hs-unregister command line option
--gen-script
--global
--user
S
setup command line option
--help
--verbose=n or -v n
-h or -?
shared
cabal project option
solver
cabal project option
source-repository:branch
package.cabal field
source-repository:location
package.cabal field
source-repository:module
package.cabal field
source-repository:source-repository
package.cabal section
source-repository:subdir
package.cabal field
source-repository:tag
package.cabal field
source-repository:type
package.cabal field
split-objs
cabal project option
split-sections
cabal project option
stability
package.cabal field
static
cabal project option
strong-flags
cabal project option
synopsis
package.cabal field
T
test-suite:main-is
package.cabal field
test-suite:test-module
package.cabal field
test-suite:test-suite
package.cabal section
test-suite:type
package.cabal field
tested-with
package.cabal field
tests
cabal project option
V
verbose
cabal project option
version
package.cabal field
virtual-modules
package.cabal field
W
with-compiler
cabal project option
with-hc-pkg
cabal project option
world-file
cabal project option
write-ghc-environment-files
cabal project option
Read the Docs
v: 3.4
Versions
latest
stable
3.6
3.4
3.2
3.0
2.4
2.0
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.