Difference between revisions of "Cabal/How to install a Cabal package"
< Cabal
Jump to navigation
Jump to search
BrettGiles (talk | contribs) m (Categorize) |
(Added some more detail, including info on how to install as user-only in case people don't have administrative rights on a machine.) |
||
Line 10: | Line 10: | ||
## Move into the directory this creates: |
## Move into the directory this creates: |
||
##:<code>cd PACKAGE-VERSION</code> |
##:<code>cd PACKAGE-VERSION</code> |
||
− | ## This directory should contain a file <code>Setup.hs</code> or <code>Setup.lhs</code>. |
+ | ## This directory should contain a file <code>Setup.hs</code> or <code>Setup.lhs</code>. In order to install a package globally, perform the following commands for the appropriate file (see the [http://www.haskell.org/ghc/docs/latest/html/Cabal/builders.html Cabal documentation] for more details): |
##:<code>runghc Setup.hs configure</code> |
##:<code>runghc Setup.hs configure</code> |
||
##:<code>runghc Setup.hs build</code> |
##:<code>runghc Setup.hs build</code> |
||
##:<code>runghc Setup.hs install</code> |
##:<code>runghc Setup.hs install</code> |
||
+ | ## If instead of installing globally, you just wish to install a package for your normal user account, you could instead use the following <code>configure</code> command, which would register the install in the user-specific database and install binaries and libraries in $HOME/bin, $HOME/lib, and so forth: |
||
+ | ##:<code>runghc Setup.hs configure --user --prefix=$HOME</code> |
||
+ | ## Additionally, you can get more information about any of these commands by adding <code>--help</code> after the command. For example, to see all the options available for the <code>configure</code> step, you could use the following command: |
||
+ | ##:<code>runghc Setup.hs configure --help</code> |
||
+ | ## Lastly, if you encounter unsatisfied dependencies when you run the configure step, that is when you recurse and first install the missing package. |
Revision as of 23:31, 20 September 2007
You've found an interesting Haskell package on HackageDB. How do you install it on your system?
- Check whether the package came with your Haskell implementation.
- If your operating system has a packaging system (e.g. most Linux or BSD distributions), check whether it is already packaged there.
- Otherwise, you'll have to build and install the package. A program to automate this process, called cabal-install, is under development. In the meantime, you'll have to do it manually:
- First, ensure that all the packages it depends on are installed (by following these instructions recursively).
- Unpack the tar file (yes, this assumes a Unix system; sorry about that):
tar xzf PACKAGE-VERSION.tar.gz
- Move into the directory this creates:
cd PACKAGE-VERSION
- This directory should contain a file
Setup.hs
orSetup.lhs
. In order to install a package globally, perform the following commands for the appropriate file (see the Cabal documentation for more details):runghc Setup.hs configure
runghc Setup.hs build
runghc Setup.hs install
- If instead of installing globally, you just wish to install a package for your normal user account, you could instead use the following
configure
command, which would register the install in the user-specific database and install binaries and libraries in $HOME/bin, $HOME/lib, and so forth:runghc Setup.hs configure --user --prefix=$HOME
- Additionally, you can get more information about any of these commands by adding
--help
after the command. For example, to see all the options available for theconfigure
step, you could use the following command:runghc Setup.hs configure --help
- Lastly, if you encounter unsatisfied dependencies when you run the configure step, that is when you recurse and first install the missing package.