Commit 366192f3 authored by Francesco Gazzetta's avatar Francesco Gazzetta

Add docs for install-method and installdir

parent 0056aa44
......@@ -541,7 +541,7 @@ cabal new-install
-----------------
``cabal new-install [FLAGS] PACKAGES`` builds the specified packages and
symlinks their executables in ``symlink-bindir`` (usually ``~/.cabal/bin``).
symlinks/copies their executables in ``installdir`` (usually ``~/.cabal/bin``).
For example this command will build the latest ``cabal-install`` and symlink
its ``cabal`` executable:
......@@ -559,6 +559,16 @@ repository, this command will build cabal-install HEAD and symlink the
$ cabal new-install exe:cabal
Where symlinking is not possible (eg. on Windows), ``--install-method=copy``
can be used:
::
$ cabal new-install exe:cabal --install-method=copy --installdir=~/bin
Note that copied executables are not self-contained, since they might use
data-files from the store.
It is also possible to "install" libraries using the ``--lib`` flag. For
example, this command will build the latest Cabal library and install it:
......
......@@ -73,7 +73,7 @@ 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
installdir: $HOME/bin
Quick start on Windows systems
......
......@@ -540,7 +540,7 @@ then
echo "By default cabal will install programs to $HOME/.cabal/bin"
echo "If you do not want to add this directory to your PATH then you can"
echo "change the setting in the config file, for example you could use:"
echo "symlink-bindir: $HOME/bin"
echo "installdir: $HOME/bin"
else
echo "Sorry, something went wrong."
echo "The 'cabal' executable was not successfully installed into"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment