The cabal-install package

[Tags: bsd3, program]

The 'cabal' command-line program simplifies the process of managing Haskell software by automating the fetching, configuration, compilation and installation of Haskell libraries and programs.


[Skip to ReadMe]

Properties

Versions0.4.0, 0.5.0, 0.5.1, 0.5.2, 0.6.0, 0.6.2, 0.6.4, 0.8.0, 0.8.2, 0.10.0, 0.10.2, 0.14.0, 0.14.1, 1.16.0, 1.16.0.1, 1.16.0.2, 1.16.1.0, 1.18.0, 1.18.0.1, 1.18.0.2, 1.18.0.3, 1.18.0.4, 1.18.0.5, 1.18.0.6, 1.18.0.7, 1.18.0.8, 1.18.1.0, 1.20.0.0, 1.20.0.1, 1.20.0.2, 1.20.0.3, 1.20.0.4, 1.20.0.5, 1.20.0.6, 1.20.1.0, 1.22.0.0, 1.22.0.1, 1.22.2.0, 1.22.3.0, 1.22.4.0, 1.22.5.0, 1.22.6.0
Change logchangelog
Dependenciesarray (>=0.1 && <0.6), base (>=4.3 && <5), bytestring (>=0.9 && <1), Cabal (>=1.22.2 && <1.23), containers (>=0.1 && <0.6), directory (>=1 && <1.3), filepath (>=1.0 && <1.5), HTTP (>=4000.2.5 && <4000.3), mtl (>=2.0 && <3), network (>=2.4), network-uri (>=2.6), old-time (>=1 && <1.2), pretty (>=1 && <1.2), process (>=1.0.1.1 && <1.3), random (>=1 && <1.2), stm (>=2.0 && <3), time (>=1.1 && <1.6), unix (>=2.0 && <2.8), Win32 (==2.*), zlib (>=0.5.3 && <0.6) [details]
LicenseBSD3
Copyright2005 Lemmih <lemmih@gmail.com> 2006 Paolo Martini <paolo@nemail.it> 2007 Bjorn Bringert <bjorn@bringert.net> 2007 Isaac Potoczny-Jones <ijones@syntaxpolice.org> 2007-2012 Duncan Coutts <duncan@community.haskell.org>
AuthorLemmih <lemmih@gmail.com> Paolo Martini <paolo@nemail.it> Bjorn Bringert <bjorn@bringert.net> Isaac Potoczny-Jones <ijones@syntaxpolice.org> Duncan Coutts <duncan@community.haskell.org>
Maintainercabal-devel@haskell.org
CategoryDistribution
Home pagehttp://www.haskell.org/cabal/
Bug trackerhttps://github.com/haskell/cabal/issues
Source repositoryhead: git clone https://github.com/haskell/cabal/(cabal-install)
Executablescabal
UploadedWed Jun 17 08:12:41 UTC 2015 by ryant
DistributionsDebian:1.22.0.1, Fedora:1.18.0.5, FreeBSD:1.18.0.5, LTSHaskell:1.18.1.0, NixOS:1.22.6.0, Stackage:1.22.6.0
Downloads144135 total (2582 in last 30 days)
Votes
2 []
StatusDocs not available [build log]
Last success reported on 2015-06-17 [all 1 reports]

Flags

NameDescriptionDefault
old-directoryUse directory < 1.2 and old-timeDisabled
network-uriGet Network.URI from the network-uri packageEnabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for cabal-install-1.22.6.0

The cabal-install package

See the Cabal web site for more information.

The cabal-install package provides a command line tool named cabal. It uses the Cabal library and provides a user interface to the Cabal/Hackage build automation and package management system. It can build and install both local and remote packages, including dependencies.

Installing the cabal command-line tool

The cabal-install package requires a number of other packages, most of which come with a standard GHC installation. It requires the network package, which is sometimes packaged separately by Linux distributions; for example, on Debian or Ubuntu, it is located in the "libghc6-network-dev" package.

cabal requires a few other Haskell packages that are not always installed. The exact list is specified in the .cabal file or in the bootstrap.sh file. All these packages are available from Hackage.

Note that on some Unix systems you may need to install an additional zlib development package using your system package manager; for example, on Debian or Ubuntu, it is located in the "zlib1g-dev" package; on Fedora, it is located in the "zlib-devel" package. It is required because the Haskell zlib package uses the system zlib C library and header files.

The cabal-install package is now part of the Haskell Platform, so you do not usually need to install it separately. However, if you are starting from a minimal GHC installation, you need to install cabal-install manually. Since it is an ordinary Cabal package, cabal-install can be built the standard way; to facilitate this, the process has been partially automated. It is described below.

Quick start on Unix-like systems

As a convenience for users on Unix-like systems, there is a bootstrap.sh script that will download and install each of cabal-install's dependencies in turn.

$ ./bootstrap.sh

It will download and install the dependencies. The script will install the library packages (vanilla, profiling and shared) into $HOME/.cabal/ and the cabal program into $HOME/.cabal/bin/. If you don't want to install profiling and shared versions of the libraries, use

$ EXTRA_CONFIGURE_OPTS="" ./bootstrap.sh

You then have the choice either to place $HOME/.cabal/bin on your $PATH or move the cabal program to somewhere on your $PATH. Next, you can get the latest list of packages by running:

$ cabal update

This will also create a default configuration file, if it does not already exist, at $HOME/.cabal/config.

By default, cabal will install programs to $HOME/.cabal/bin. If you do not want to add this directory to your $PATH, you can change the setting in the config file; for example, you could use the following:

symlink-bindir: $HOME/bin

Quick start on Windows systems

For Windows users, a precompiled program (cabal.exe) is provided. Download and put it somewhere on your %PATH% (for example, C:\Program Files\Haskell\bin.)

Next, you can get the latest list of packages by running:

$ cabal update

This will also create a default configuration file (if it does not already exist) at C:\Documents and Settings\%USERNAME%\Application Data\cabal\config.

Using cabal

There are two sets of commands: commands for working with a local project build tree and those for working with packages distributed from Hackage.

For the list of the full set of commands and flags for each command, run:

$ cabal help

Commands for developers for local build trees

The commands for local project build trees are almost the same as the runghc Setup command-line interface you may already be familiar with. In particular, it has the following commands:

The install command is somewhat different; it is an all-in-one operation. If you run cabal install in your build tree, it will configure, build, and install. It takes all the flags that configure takes such as --global and --prefix.

In addition, cabal will download and install any dependencies that are not already installed. It can also rebuild packages to ensure a consistent set of dependencies.

Commands for released Hackage packages

$ cabal update

This command gets the latest list of packages from the Hackage server. On occasion, this command must be run manually--for instance, if you want to install a newly released package.

$ cabal install xmonad

This command installs one or more named packages, and all their dependencies, from Hackage. By default, it installs the latest available version; however, you may specify exact versions or version ranges. For example, cabal install alex-2.2 or cabal install parsec < 3.

$ cabal list xml

This does a search of the installed and available packages. It does a case-insensitive substring match on the package name.