.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CABAL-INSTALL "1" "October 2023" "cabal-install version 3.8.1.0" "User Commands"
.SH NAME
cabal-install \- manual page for cabal-install version 3.8.1.0
.SH SYNOPSIS
.B cabal
[\fI\,GLOBAL FLAGS\/\fR] [\fI\,COMMAND \/\fR[\fI\,FLAGS\/\fR]]
.SH DESCRIPTION
Command line interface to the Haskell Cabal infrastructure.
.PP
See http://www.haskell.org/cabal/ for more information.
.SS "Commands:"
.IP
[global]
.TP
update
Updates list of known packages.
.TP
install
Install packages.
.TP
help
Help about commands.
.TP
info
Display detailed information about a particular package.
.TP
list
List packages matching a search string.
.TP
fetch
Downloads packages for later installation.
.TP
user\-config
Display and update the user's global cabal configuration.
.IP
[package]
.TP
get
Download/Extract a package's source code (repository).
.TP
unpack
Deprecated alias for 'get'.
.TP
init
Create a new cabal package.
.TP
configure
Add extra project configuration.
.TP
build
Compile targets within the project.
.TP
clean
Clean the package store and remove temporary files.
.TP
run
Run an executable.
.TP
repl
Open an interactive session for the given component.
.TP
test
Run test\-suites.
.TP
bench
Run benchmarks.
.TP
check
Check the package for common mistakes.
.TP
sdist
Generate a source distribution file (.tar.gz).
.TP
upload
Uploads source packages or documentation to Hackage.
.TP
report
Upload build reports to a remote server.
.TP
freeze
Freeze dependencies.
.TP
gen\-bounds
Generate dependency bounds.
.TP
outdated
Check for outdated dependencies.
.TP
haddock
Build Haddock documentation.
.TP
hscolour
Generate HsColour colourised code, in HTML format.
.TP
exec
Give a command access to the store.
.TP
list\-bin
List the path to a single executable.
.IP
[new\-style projects (forwards\-compatible aliases)]
.TP
v2\-build
Compile targets within the project.
.TP
v2\-configure
Add extra project configuration.
.TP
v2\-repl
Open an interactive session for the given component.
.TP
v2\-run
Run an executable.
.TP
v2\-test
Run test\-suites.
.TP
v2\-bench
Run benchmarks.
.TP
v2\-freeze
Freeze dependencies.
.TP
v2\-haddock
Build Haddock documentation.
.TP
v2\-exec
Give a command access to the store.
.TP
v2\-update
Updates list of known packages.
.TP
v2\-install
Install packages.
.TP
v2\-clean
Clean the package store and remove temporary files.
.TP
v2\-sdist
Generate a source distribution file (.tar.gz).
.IP
[legacy command aliases]
.TP
v1\-build
Compile all/specific components.
.TP
v1\-configure
Prepare to build the package.
.TP
v1\-repl
Open an interpreter session for the given component.
.TP
v1\-run
Builds and runs an executable.
.TP
v1\-test
Run all/specific tests in the test suite.
.TP
v1\-bench
Run all/specific benchmarks.
.TP
v1\-freeze
Freeze dependencies.
.TP
v1\-haddock
Generate Haddock HTML documentation.
.TP
v1\-install
Install packages.
.TP
v1\-clean
Clean up after a build.
.TP
v1\-copy
Copy the files of all/specific components to install locations.
.TP
v1\-register
Register this package with the compiler.
.TP
v1\-reconfigure
Reconfigure the package if necessary.
.SS "For more information about a command use:"
.IP
cabal COMMAND \fB\-\-help\fR
.PP
or cabal help COMMAND
.SS "To install Cabal packages from hackage use:"
.IP
cabal install foo [\-\-dry\-run]
.SS "Occasionally you need to update the list of available packages:"
.IP
cabal update
.SS "Global flags:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this help text
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version information
.TP
\fB\-\-numeric\-version\fR
Print just the version number
.TP
\fB\-\-config\-file\fR=\fI\,FILE\/\fR
Set an alternate location for the config file
.TP
\fB\-\-ignore\-expiry\fR
Ignore expiry dates on signed metadata (use
only in exceptional circumstances)
.TP
\fB\-\-http\-transport\fR=\fI\,HttpTransport\/\fR
Set a transport for http(s) requests. Accepts
\&'curl', 'wget', 'powershell', and
\&'plain\-http'. (default: 'curl')
.TP
\fB\-\-enable\-nix\fR
Enable Nix integration: run commands through
nix\-shell if a 'shell.nix' file exists
.TP
\fB\-\-disable\-nix\fR
Disable Nix integration
.TP
\fB\-\-store\-dir\fR=\fI\,DIR\/\fR
The location of the build store
.TP
\fB\-\-active\-repositories\fR=\fI\,REPOS\/\fR
The active package repositories (set to
\&':none' to disable all repositories)
.SS "You can edit the cabal configuration file to set defaults:"
.IP
/homedoesnotexistatbuildtime/.cabal/config
.PP
This file will be generated with sensible defaults if you run 'cabal update'.
.PP
compiled using version 3.8.1.0 of the Cabal library