[commit: packages/Cabal] ghc-head: Feature the 'cabal' tool more prominently in the docs. (f272caa)
git at git.haskell.org
git at git.haskell.org
Mon Aug 26 23:30:46 CEST 2013
Repository : ssh://git@git.haskell.org/Cabal
On branch : ghc-head
Link : http://git.haskell.org/?p=packages/Cabal.git;a=commit;h=f272caa764c4d829d319546de3956d6c0d428a96
>---------------------------------------------------------------
commit f272caa764c4d829d319546de3956d6c0d428a96
Author: Mikhail Glushenkov <mikhail.glushenkov at gmail.com>
Date: Fri Aug 23 09:19:37 2013 +0200
Feature the 'cabal' tool more prominently in the docs.
The docs/website sorely need to be reworked, but this will do for now.
>---------------------------------------------------------------
f272caa764c4d829d319546de3956d6c0d428a96
Cabal/doc/installing-packages.markdown | 28 +++++++++++++++++++++++-----
1 file changed, 23 insertions(+), 5 deletions(-)
diff --git a/Cabal/doc/installing-packages.markdown b/Cabal/doc/installing-packages.markdown
index 0feb727..9f81611 100644
--- a/Cabal/doc/installing-packages.markdown
+++ b/Cabal/doc/installing-packages.markdown
@@ -1,16 +1,23 @@
% Cabal User Guide
-
# Building and installing packages #
After you've unpacked a Cabal package, you can build it by moving into
-the root directory of the package and using the `Setup.hs` or
-`Setup.lhs` script there:
+the root directory of the package and running the `cabal` tool there:
+
+> `cabal` [_command_] [_option_...]
+
+The _command_ argument selects a particular step in the build/install process.
+
+You can also get a summary of the command syntax with
+
+> `cabal help`
+
+Alternatively, you can also use the `Setup.hs` or `Setup.lhs` script:
> `_runhaskell_ Setup.hs` [_command_] [_option_...]
-The _command_ argument selects a particular step in the build/install
-process. You can also get a summary of the command syntax with
+For the summary of the command syntax, run:
> `runhaskell Setup.hs --help`
@@ -38,6 +45,17 @@ runhaskell Setup.hs install
The package is installed under the user's home directory and is
registered in the user's package database (`--user`).
+## Installing packages from Hackage ##
+
+The `cabal` tool also can download, configure, build and install a [Hackage]
+package and all of its dependencies in a single step. To do this, run:
+
+~~~~~~~~~~~~~~~~
+cabal install [PACKAGE...]
+~~~~~~~~~~~~~~~~
+
+To browse the list of available packages, visit the [Hackage] web site.
+
## Creating a binary package ##
When creating binary packages (e.g. for RedHat or Debian) one needs to
More information about the ghc-commits
mailing list