Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 169 lines (115 sloc) 4.88 kb
16eb4de @dcoutts Update the README
dcoutts authored
1 The Cabal library package
2 =========================
f9271bc @SyntaxPolice cabal-in-cabal (updated makefile)
SyntaxPolice authored
3
16eb4de @dcoutts Update the README
dcoutts authored
4 [Cabal home page](http://www.haskell.org/cabal/)
a5976f9 @dcoutts Tweaks to the readme, hopefully will reduce confusion
dcoutts authored
5
6 If you also want the `cabal` command line program then you need
7 the `cabal-install` package in addition to this library.
8
f9271bc @SyntaxPolice cabal-in-cabal (updated makefile)
SyntaxPolice authored
9
16eb4de @dcoutts Update the README
dcoutts authored
10 Installation instructions for the Cabal library
11 ===============================================
12
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
13 Installing as a user (no root or administer access)
a5976f9 @dcoutts Tweaks to the readme, hopefully will reduce confusion
dcoutts authored
14 ---------------------------------------------------
11e7c2e @SyntaxPolice updated these docs after some feedback
SyntaxPolice authored
15
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
16 ghc --make Setup
17 ./Setup configure --user
18 ./Setup build
19 ./Setup install
11e7c2e @SyntaxPolice updated these docs after some feedback
SyntaxPolice authored
20
a5976f9 @dcoutts Tweaks to the readme, hopefully will reduce confusion
dcoutts authored
21 Note the use of the `--user` flag at the configure step.
22
16eb4de @dcoutts Update the README
dcoutts authored
23 Compiling Setup rather than using `runghc Setup` is much faster and works on
24 Windows. For all packages other than Cabal itself it is fine to use `runghc`.
25
573e710 @dcoutts Note the per-user install path on Windows in the README
dcoutts authored
26 This will install into `$HOME/.cabal/` on unix and into
27 `$Documents and Settings\$User\Application Data\cabal\` on Windows
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
28 If you want to install elsewhere use the `--prefix=` flag at the
29 configure step.
a449b2b @SyntaxPolice updated README with suggestions from simon and some clarification
SyntaxPolice authored
30
31
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
32 Installing as root / Administrator
a5976f9 @dcoutts Tweaks to the readme, hopefully will reduce confusion
dcoutts authored
33 ----------------------------------
a449b2b @SyntaxPolice updated README with suggestions from simon and some clarification
SyntaxPolice authored
34
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
35 ghc --make Setup
36 ./Setup configure
37 ./Setup build
38 sudo ./Setup install
dce1959 @SyntaxPolice added readme info about installing over new versions of cabal
SyntaxPolice authored
39
16eb4de @dcoutts Update the README
dcoutts authored
40 Compiling Setup rather than using `runghc Setup` is much faster and works on
41 Windows. For all packages other than Cabal itself it is fine to use `runghc`.
42
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
43 This will install into `/usr/local` on unix and on Windows it will
44 install into `$ProgramFiles/Haskell`. If you want to install
45 elsewhere use the `--prefix=` flag at the configure step.
dce1959 @SyntaxPolice added readme info about installing over new versions of cabal
SyntaxPolice authored
46
a449b2b @SyntaxPolice updated README with suggestions from simon and some clarification
SyntaxPolice authored
47
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
48 Working with older versions of GHC and Cabal
49 ============================================
a449b2b @SyntaxPolice updated README with suggestions from simon and some clarification
SyntaxPolice authored
50
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
51 It is recommended just to leave any pre-existing version of Cabal
52 installed. In particular it is *essential* to keep the version that
53 came with GHC itself since other installed packages need it (eg the
54 "ghc" api package).
dce1959 @SyntaxPolice added readme info about installing over new versions of cabal
SyntaxPolice authored
55
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
56 Prior to GHC 6.4.2 however, GHC didn't deal particularly well with
57 having multiple versions of packages installed at once. So if you
58 are using GHC 6.4.1 or older and you have an older version of Cabal
59 installed, you probably just want to remove it:
dce1959 @SyntaxPolice added readme info about installing over new versions of cabal
SyntaxPolice authored
60
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
61 ghc-pkg unregister Cabal
dce1959 @SyntaxPolice added readme info about installing over new versions of cabal
SyntaxPolice authored
62
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
63 or if you had Cabal installed just for your user account then:
dce1959 @SyntaxPolice added readme info about installing over new versions of cabal
SyntaxPolice authored
64
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
65 ghc-pkg unregister Cabal --user
dce1959 @SyntaxPolice added readme info about installing over new versions of cabal
SyntaxPolice authored
66
67
16eb4de @dcoutts Update the README
dcoutts authored
68 The `filepath` dependency
69 =========================
70
71 Cabal now uses the `filepath` package so that must be installed first.
72 GHC-6.6.1 and later come with `filepath` however earlier versions do not by
73 default. If you do not already have `filepath` then you need to install it. You
74 can use any existing version of Cabal to do that. If you have neither Cabal or
6347b8e @dcoutts Fix instructions in README for building with 6.6 and filepath
dcoutts authored
75 filepath then it is slightly harder but still possible.
76
77 Unpack Cabal and filepath into separate directories. For example:
78
79 tar -xzf filepath-1.1.0.0.tar.gz
80 tar -xzf Cabal-1.6.0.0.tar.gz
81
82 # rename to make the following instructions simpler:
83 mv filepath-1.1.0.0/ filepath/
84 mv Cabal-1.6.0.0/ Cabal/
16eb4de @dcoutts Update the README
dcoutts authored
85
86 cd Cabal
6347b8e @dcoutts Fix instructions in README for building with 6.6 and filepath
dcoutts authored
87 ghc -i../filepath -cpp --make Setup.hs -o ../filepath/setup
16eb4de @dcoutts Update the README
dcoutts authored
88 cd ../filepath/
6347b8e @dcoutts Fix instructions in README for building with 6.6 and filepath
dcoutts authored
89 ./setup configure --user
16eb4de @dcoutts Update the README
dcoutts authored
90 ./setup build
91 ./setup install
92
93 This installs filepath so you are then in a position to install Cabal by the
94 normal method.
95
e84a7eb @dcoutts Merge the info from the releaseNotes file into the README file
dcoutts authored
96
97 More Information
98 ================
99
100 Please see the web site for the [user guide] and API documentation.
101 There is some more information available on the [development wiki].
102
103 [user guide]: http://www.haskell.org/cabal/
104 [development wiki]: http://hackage.haskell.org/trac/hackage/
105
106
107 Bugs
108 =======
109
110 Please report bugs and wish-list items in our [bug tracker].
111
112 [bug tracker]: http://hackage.haskell.org/trac/hackage/
113
114
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
115 Your Help
e84a7eb @dcoutts Merge the info from the releaseNotes file into the README file
dcoutts authored
116 ---------
3a7fc29 @dcoutts Update README, changelog and releaseNotes
dcoutts authored
117
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
118 To help us in the next round of development work it would be
119 enormously helpful to know from our users what their most pressing
120 problems are with Cabal and Hackage. You probably have a favourite
121 Cabal bug or limitation. Take a look at our [bug tracker]. Make sure
122 the problem is reported there and properly described. Comment on the
123 ticket to tell us how much of a problem the bug is for you. Add
124 yourself to the ticket's cc list so we can discuss requirements and
125 keep you informed on progress. For feature requests it is very
126 helpful if there is a description of how you would expect to
127 interact with the new feature.
3a7fc29 @dcoutts Update README, changelog and releaseNotes
dcoutts authored
128
129
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
130 Code
131 =======
132
133 You can get the code from the web page; the version control system we
134 use is very open and welcoming to new developers.
3a7fc29 @dcoutts Update README, changelog and releaseNotes
dcoutts authored
135
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
136 You can get the main development branch:
3a7fc29 @dcoutts Update README, changelog and releaseNotes
dcoutts authored
137
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
138 > darcs get --partial http://darcs.haskell.org/cabal
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
139
16eb4de @dcoutts Update the README
dcoutts authored
140 and you can get the stable 1.6 branch:
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
141
16eb4de @dcoutts Update the README
dcoutts authored
142 > darcs get --partial http://darcs.haskell.org/cabal-branches/cabal-1.6
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
143
144
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
145 Credits
146 =======
3a7fc29 @dcoutts Update README, changelog and releaseNotes
dcoutts authored
147
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
148 Cabal Coders (in alphabetical order):
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
149
20fabcb @SyntaxPolice small changes to README and description
SyntaxPolice authored
150 - Krasimir Angelov
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
151 - Bjorn Bringert
3a7fc29 @dcoutts Update README, changelog and releaseNotes
dcoutts authored
152 - Duncan Coutts
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
153 - Isaac Jones
99b2f1a @SyntaxPolice lots of changes, mostly from ross
SyntaxPolice authored
154 - David Himmelstrup (Lemmih)
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
155 - Simon Marlow
20fabcb @SyntaxPolice small changes to README and description
SyntaxPolice authored
156 - Ross Patterson
e4dcdc1 @dcoutts note need to use -i when bootstrapping ghc, and update coders list
dcoutts authored
157 - Thomas Schilling
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
158 - Martin Sjögren
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
159 - Malcolm Wallace
e4dcdc1 @dcoutts note need to use -i when bootstrapping ghc, and update coders list
dcoutts authored
160 - and nearly 30 other people have contributed occasional patches
161
a449b2b @SyntaxPolice updated README with suggestions from simon and some clarification
SyntaxPolice authored
162 Cabal spec:
923d702 @dcoutts Update the README and convert it to markdown syntax
dcoutts authored
163
0432902 @SyntaxPolice more README, makefile comment
SyntaxPolice authored
164 - Isaac Jones
165 - Simon Marlow
166 - Ross Patterson
167 - Simon Peyton Jones
168 - Malcolm Wallace
Something went wrong with that request. Please try again.