Personal tools

Cabal-Install

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
(installation description)
 
(Added a link to "An Introduction to Cabal sandboxes")
 
(29 intermediate revisions by 12 users not shown)
Line 1: Line 1:
The Cabal-Install package provides the <code>cabal</code> command-line program
+
The cabal-install package provides the <code>cabal</code> command-line tool which simplifies the process of managing Haskell software
which simplifies the process of managing Haskell software
 
 
by automating the fetching, configuration, compilation and installation of Haskell libraries and programs.
 
by automating the fetching, configuration, compilation and installation of Haskell libraries and programs.
Those packages must be prepared using [[Cabal]] and should be present at [http://hackage.haskell.org/ HackageDB].
+
Those packages must be prepared using [[Cabal]] and should be present at [http://hackage.haskell.org/packages/archive/pkg-list.html Hackage].
   
Once you have running cabal-install installation of further packages is just one simple shell call like
 
cabal install new-package
 
   
Also uploading a new package to HackageDB is as simple as
+
== Usage ==
cabal upload new-package
 
   
But before you can do that, you have to complete the:
+
=== Installing a package ===
   
  +
Once you have the tool installed, installing other packages is easy.
  +
The first thing to do is to give the command:
  +
cabal update
  +
This will download the most recent list of packages; this must be done from time to time, to get the latest version of each package, when installing.
  +
  +
To install Cabal packages from [http://hackage.haskell.org/packages/archive/pkg-list.html Hackage] use:
  +
cabal install foo
  +
  +
Other common variations:
  +
cabal install Package in the current directory
  +
cabal install foo Package from the hackage server
  +
cabal install foo-1.0 Specific version of a package
  +
cabal install 'foo < 2' Constrained package version
  +
cabal install foo bar baz Several packages at once
  +
cabal install foo --dry-run Show what would be installed
  +
cabal install foo --constraint=bar==1.0 Use version 1.0 of package bar
  +
  +
One thing to be especially aware of, is that the packages are installed locally by default, whereas the commands
  +
runhaskell Setup configure
  +
runhaskell Setup build
  +
runhaskell Setup install
  +
install globally by default.
  +
If you install a package globally, the local packages are ignored. The default for cabal-install can be modified by editing the configuration file.
  +
  +
Help about cabal-install can be obtained by giving commands like:
  +
cabal --help
  +
cabal install --help
  +
  +
=== The cabal-install configuration file ===
  +
You can edit the cabal configuration file to set defaults:
  +
~/.cabal/config (for *nix based systems)
  +
  +
For Windows there are different locations for different versions of Windows (just to make things easy). To get the directory cabal actually uses, start GHCi and give the following commands:
  +
:m System.Directory
  +
getAppUserDataDirectory "cabal"
  +
  +
  +
==== Things to put in the config file ====
  +
To turn on --global by default:
  +
user-install: False
  +
  +
The root-cmd configuration parameter can be used to automatically run cabal-install with root privileges on *nix based systems, when needed:
  +
root-cmd: sudo
  +
  +
 
== Installation ==
 
== Installation ==
   
You must download the following tarballs and you must [[Cabal/How to install a Cabal package|build and install]] them manually.
+
If you have the [http://hackage.haskell.org/platform/ Haskell Platform] installed, you already have cabal-install; no further action is needed.
  +
  +
[[File:Button-100.png|link=http://hackage.haskell.org/platform/]]
  +
  +
  +
=== Windows ===
  +
  +
Get a pre-built <code>cabal.exe</code> from:
  +
http://www.haskell.org/cabal/download.html
  +
  +
You must put the <code>cabal.exe</code> in a directory that is on your <code>%PATH%</code>, for example <code>C:\Program Files\Haskell\bin</code>.
  +
  +
  +
=== Unix ===
  +
  +
Download the latest cabal-install tarball from:
  +
http://www.haskell.org/cabal/download.html
  +
  +
It includes a shell script <code>bootstrap.sh</code> that you can run to download and install the other dependencies.
  +
  +
Note this assumes you have the zlib C library and its header files installed. Those header files are usually in a native system package like <code>zlib-devel</code> (On debian-based systems it is <code>zlib1g-dev</code>). You should also have the Haskell packages <code>parsec</code> and <code>network</code> installed. If you installed GHC via your native system package manager then you may also need to use it to install these two packages. (On debian-based systems they are called <code>libghc6-parsec-dev</code> and <code>libghc6-network-dev</code>.)
  +
  +
tar -zxf cabal-install-0.14.0.tar.gz
  +
cd cabal-install-0.14.0
  +
./bootstrap.sh
  +
  +
If this completes successfully you will have the cabal binary in <code>~/.cabal/bin</code>. You should either add this directory to your <code>$PATH</code> or copy the cabal program to some location that is on your <code>$PATH</code>, eg <code>~/bin</code>.
  +
  +
to get the current list of package from hackage you should now run:
  +
  +
cabal update
  +
  +
By default the cabal tool will install programs in <code>~/.cabal/bin</code>. If you decided not to put this directory on your <code>$PATH</code> then you can get cabal to symlink binaries into another directory, eg <code>~/bin</code>. To use this feature edit <code>~/.cabal/config</code> and see the <code>symlink-bindir field</code>. Note that the <code>~/.cabal/config</code> file is not created until you run a cabal command for the first time, eg <code>cabal update</code>.
  +
  +
  +
== Error reporting ==
  +
  +
Errors in cabal-install can be reported at
  +
[https://github.com/haskell/cabal/issues the GitHub Cabal issues page]
  +
  +
  +
== FAQ ==
  +
  +
=== I just installed packages, but now the packages are not found ===
  +
This happens when you install a package globally, and the previous packages were installed locally. Note that cabal-install install locally by default and the "runhaskell Setup" commands install globally by default.
   
Cabal-install package itself:
+
=== How can I uninstall packages? ===
http://hackage.haskell.org/cgi-bin/hackage-scripts/package/cabal-install
+
There is no "cabal uninstall" command. You can only unregister packages with [[ghc-pkg]]:
  +
ghc-pkg unregister
   
Dependencies that aren't in core:
 
http://hackage.haskell.org/cgi-bin/hackage-scripts/package/HTTP
 
http://hackage.haskell.org/cgi-bin/hackage-scripts/package/zlib
 
   
Note the last one assumes you have zlib the C library and its header files installed.
+
== See also ==
Those header files are usually in a package like zlib-devel.
 
   
If that succeeds, that's possibly the last time you ever installed a foreign Haskell package manually!
+
* The [https://github.com/haskell/cabal Cabal] page on GitHub.
  +
* [http://coldwa.st/e/blog/2013-08-20-Cabal-sandbox.html An Introduction to Cabal sandboxes]
  +
* [http://www.vex.net/~trebla/haskell/cabal-cabal.xhtml The Cabal of Cabal], the undocumented or obscure artifices and intrigues of Cabal.
  +
* [http://www.vex.net/~trebla/haskell/sicp.xhtml Storage and Identification of Cabalized Packages]
  +
* [[Hack-Nix]] alternative based on the [http://nixos.org Nix] package manager.
  +
* [[Capri]] a wrapper over cabal-install and [[ghc-pkg]] to operate in project-private mode; similar to [[Hack-Nix]] but does not involve any extra software..
   
 
[[Category:Tools]]
 
[[Category:Tools]]
  +
[[Category:Cabal]]

Latest revision as of 16:44, 14 November 2013

The cabal-install package provides the cabal command-line tool which simplifies the process of managing Haskell software by automating the fetching, configuration, compilation and installation of Haskell libraries and programs. Those packages must be prepared using Cabal and should be present at Hackage.


Contents

[edit] 1 Usage

[edit] 1.1 Installing a package

Once you have the tool installed, installing other packages is easy. The first thing to do is to give the command:

 cabal update

This will download the most recent list of packages; this must be done from time to time, to get the latest version of each package, when installing.

To install Cabal packages from Hackage use:

 cabal install foo

Other common variations:

 cabal install                             Package in the current directory
 cabal install foo                         Package from the hackage server
 cabal install foo-1.0                     Specific version of a package
 cabal install 'foo < 2'                   Constrained package version
 cabal install foo bar baz                 Several packages at once
 cabal install foo --dry-run               Show what would be installed
 cabal install foo --constraint=bar==1.0   Use version 1.0 of package bar

One thing to be especially aware of, is that the packages are installed locally by default, whereas the commands

 runhaskell Setup configure
 runhaskell Setup build
 runhaskell Setup install

install globally by default. If you install a package globally, the local packages are ignored. The default for cabal-install can be modified by editing the configuration file.

Help about cabal-install can be obtained by giving commands like:

 cabal --help
 cabal install --help

[edit] 1.2 The cabal-install configuration file

You can edit the cabal configuration file to set defaults:

 ~/.cabal/config (for *nix based systems)

For Windows there are different locations for different versions of Windows (just to make things easy). To get the directory cabal actually uses, start GHCi and give the following commands:

 :m System.Directory
 getAppUserDataDirectory "cabal"

[edit] 1.2.1 Things to put in the config file

To turn on --global by default:

 user-install: False

The root-cmd configuration parameter can be used to automatically run cabal-install with root privileges on *nix based systems, when needed:

 root-cmd: sudo


[edit] 2 Installation

If you have the Haskell Platform installed, you already have cabal-install; no further action is needed.

Button-100.png


[edit] 2.1 Windows

Get a pre-built cabal.exe from:

 http://www.haskell.org/cabal/download.html

You must put the cabal.exe in a directory that is on your %PATH%, for example C:\Program Files\Haskell\bin.


[edit] 2.2 Unix

Download the latest cabal-install tarball from:

 http://www.haskell.org/cabal/download.html

It includes a shell script bootstrap.sh that you can run to download and install the other dependencies.

Note this assumes you have the zlib C library and its header files installed. Those header files are usually in a native system package like zlib-devel (On debian-based systems it is zlib1g-dev). You should also have the Haskell packages parsec and network installed. If you installed GHC via your native system package manager then you may also need to use it to install these two packages. (On debian-based systems they are called libghc6-parsec-dev and libghc6-network-dev.)

 tar -zxf cabal-install-0.14.0.tar.gz 
 cd cabal-install-0.14.0
 ./bootstrap.sh

If this completes successfully you will have the cabal binary in ~/.cabal/bin. You should either add this directory to your $PATH or copy the cabal program to some location that is on your $PATH, eg ~/bin.

to get the current list of package from hackage you should now run:

 cabal update

By default the cabal tool will install programs in ~/.cabal/bin. If you decided not to put this directory on your $PATH then you can get cabal to symlink binaries into another directory, eg ~/bin. To use this feature edit ~/.cabal/config and see the symlink-bindir field. Note that the ~/.cabal/config file is not created until you run a cabal command for the first time, eg cabal update.


[edit] 3 Error reporting

Errors in cabal-install can be reported at the GitHub Cabal issues page


[edit] 4 FAQ

[edit] 4.1 I just installed packages, but now the packages are not found

This happens when you install a package globally, and the previous packages were installed locally. Note that cabal-install install locally by default and the "runhaskell Setup" commands install globally by default.

[edit] 4.2 How can I uninstall packages?

There is no "cabal uninstall" command. You can only unregister packages with ghc-pkg:

 ghc-pkg unregister


[edit] 5 See also