]> git.donarmstrong.com Git - lilypond.git/blob - INSTALL.text
release: 0.0.58
[lilypond.git] / INSTALL.text
1
2
3
4 INSTALL(1)            LilyPond documentation           INSTALL(1)
5
6
7 N\bN\bN\bNA\bA\bA\bAM\bM\bM\bME\bE\bE\bE
8        INSTALL - installing GNU LilyPond
9
10 D\bD\bD\bDE\bE\bE\bES\bS\bS\bSC\bC\bC\bCR\bR\bR\bRI\bI\bI\bIP\bP\bP\bPT\bT\bT\bTI\bI\bI\bIO\bO\bO\bON\bN\bN\bN
11        This page documents installation  and compilation of GNU
12        LilyPond
13
14 I\bI\bI\bIM\bM\bM\bMP\bP\bP\bPO\bO\bO\bOR\bR\bR\bRT\bT\bT\bTA\bA\bA\bAN\bN\bN\bNT\bT\bT\bT
15        if you have downloaded a
16
17                *.pre*
18
19        version, then this is version is _\bn_\bo_\bt meant for producing
20        nice output, but to keep your patchsets up to date.  It
21        might not even compile.
22
23 P\bP\bP\bPR\bR\bR\bRE\bE\bE\bER\bR\bR\bRE\bE\bE\bEQ\bQ\bQ\bQU\bU\bU\bUI\bI\bI\bIS\bS\bS\bSI\bI\bI\bIT\bT\bT\bTE\bE\bE\bES\bS\bS\bS
24        For compilation you need.
25
26        +\bo    Unix. GNU LilyPond is known to run on Linux, AIX,
27             Digital Unix and Solaris
28
29             If you have the Cygnus WIN32 port of the GNU utils,
30             it will even work in Lose NT/95, but don't promise to
31             support it.
32
33        +\bo    GNU C++ v2.7 or better, with libg++ installed.
34             Version 2.7.2 or better recommended. I almost
35             positive that it will not compile with AT&T CC.
36
37        +\bo    GNU make.
38
39        +\bo    Flex (2.5.1 or better).
40
41        +\bo    Bison. (Version 1.25 or better)
42
43 R\bR\bR\bRE\bE\bE\bEC\bC\bC\bCO\bO\bO\bOM\bM\bM\bMM\bM\bM\bME\bE\bE\bEN\bN\bN\bND\bD\bD\bDE\bE\bE\bED\bD\bD\bD
44        +\bo    Perl.  Most scripts are written in Perl. The
45             documentation was created with the perl's Plain Old
46             Documentation.
47
48        +\bo (GNU) find
49
50 C\bC\bC\bCO\bO\bO\bON\bN\bN\bNF\bF\bF\bFI\bI\bI\bIG\bG\bG\bGU\bU\bU\bUR\bR\bR\bRI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG a\ba\ba\ban\bn\bn\bnd\bd\bd\bd C\bC\bC\bCO\bO\bO\bOM\bM\bM\bMP\bP\bP\bPI\bI\bI\bIL\bL\bL\bLI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
51        to install GNU LilyPond, simply type:
52
53                configure
54                make install
55
56        This will install the following files:
57
58
59
60
61
62
63
64 2/May/97                 LilyPond 0.0.58                        1
65
66
67
68
69
70 INSTALL(1)            LilyPond documentation           INSTALL(1)
71
72
73                /usr/local/man/man1/mi2mu.1
74                /usr/local/man/man5/mudela.5
75                /usr/local/man/man1/lilypond.1
76                /usr/local/lib/libflower.{so,a}
77                /usr/local/bin/lilypond
78                /usr/local/bin/mi2mu
79                /usr/local/share/lilypond/*
80                /usr/lib/texmf/texmf/tex/lilypond/*
81                /usr/lib/texmf/texmf/fonts/source/lilypond/*
82
83        The TeX include directory is detected dynamically, but it
84        can be adjusted with -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-t\bt\bt\bte\be\be\bex\bx\bx\bx-\b-\b-\b-p\bp\bp\bpr\br\br\bre\be\be\bef\bf\bf\bfi\bi\bi\bix\bx\bx\bx and -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-t\bt\bt\bte\be\be\bex\bx\bx\bx-\b-\b-\b-
85        d\bd\bd\bdi\bi\bi\bir\br\br\br. The above assumes that you are root and have the gnu
86        development tools, and your make is gnu make.  If this is
87        not the case, you can adjust your environment variables to
88        your taste:
89
90                export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
91                configure
92
93        CPPFLAGS are the preprocessor flags.
94
95        the configure script is Cygnus configure, and it will
96        accept -\b-\b-\b--\b-\b-\b-h\bh\bh\bhe\be\be\bel\bl\bl\blp\bp\bp\bp. If you are not root, you will probably have
97        to make it with
98
99                configure --prefix=/home/me_myself_and_I/
100
101        In this case, you will have to set MFINPUTS, and TEINPUTS
102        accordingly.
103
104        If you want to install GNU LilyPond in _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl, and
105        your TeX has no default hooks for local stuff (mine is
106        broken too), you can do:
107
108                configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
109
110        Since GNU LilyPond currently is beta, you are advised to
111        also use
112
113                --enable-debugging
114                --enable-checking
115
116        other options include:
117
118        --enable-shared
119            Make a shared library (linux, solaris (?) only )
120
121        --enable-printing
122            Enable debugging print routines (lilypond -\b-\b-\b-d\bd\bd\bd option)
123
124        --enable-optimise
125            Set maximum optimisation
126
127
128
129
130 2/May/97                 LilyPond 0.0.58                        2
131
132
133
134
135
136 INSTALL(1)            LilyPond documentation           INSTALL(1)
137
138
139        --enable-profiling
140            Compile with support for profiling
141
142        --enable-tex-prefix
143            Set the directory where texmf lives
144
145        --enable-tex-dir
146            Set then directory tex input is in (detected as a
147            subdir of tex-prefix)
148
149        --enable-mf-dir
150            Set then directory tex input is in (idem)
151
152        All options are documented in the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be help The
153        option -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-o\bo\bo\bop\bp\bp\bpt\bt\bt\bti\bi\bi\bim\bm\bm\bmi\bi\bi\bis\bs\bs\bse\be\be\be is recommended for Real Life
154        usage.
155
156        If you do
157
158                make all
159
160        everything will be compiled, but nothing will be
161        installed.  The resulting binaries can be found in the
162        subdirectory _\bb_\bi_\bn_\b/.
163
164 I\bI\bI\bIN\bN\bN\bNS\bS\bS\bST\bT\bT\bTA\bA\bA\bAL\bL\bL\bLL\bL\bL\bLI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
165        If you have done a successful make, then a simple
166
167                make install
168
169        should do the trick.
170
171        [todo]
172
173        Install the musixtex fonts in a directory which TeX and MF
174        knows (if you are root, look for a directory which
175        contains the directories with AMS and CM source (*.mf)
176        files. Create a subdir lilypond or musixtex and copy the
177        fonts into that). Do not forget to rehash TeX (if
178        applicable)
179
180        Example: my fonts are in
181        _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl_\b/_\bl_\bi_\bb_\b/_\bt_\be_\bx_\bf_\bo_\bn_\bt_\bs_\b/_\bm_\bu_\bs_\bi_\bx_\bt_\be_\bx_\b/, and I have a symlink
182        pointing to that in
183        _\b/_\bu_\bs_\br_\b/_\bl_\bi_\bb_\b/_\bt_\be_\bx_\bm_\bf_\b/_\bt_\be_\bx_\bm_\bf_\b/_\bf_\bo_\bn_\bt_\bs_\b/_\bs_\bo_\bu_\br_\bc_\be_\b/_\bp_\bu_\bb_\bl_\bi_\bc_\b/
184
185 C\bC\bC\bCA\bA\bA\bAV\bV\bV\bVE\bE\bE\bEA\bA\bA\bAT\bT\bT\bTS\bS\bS\bS
186        +\bo    The -O2 option to gcc triggers a gcc bug on DEC Alpha
187             in dstream.cc. You should turn off this flag for this
188             file.
189
190 R\bR\bR\bRU\bU\bU\bUN\bN\bN\bNN\bN\bN\bNI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
191        GNU LilyPond does use a lot of resources. For operation
192        you need the following:
193
194
195
196 2/May/97                 LilyPond 0.0.58                        3
197
198
199
200
201
202 INSTALL(1)            LilyPond documentation           INSTALL(1)
203
204
205        +\bo    A fast computer (a full page of music typically takes
206             1 minute on my 486/66, using the -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-c\bc\bc\bch\bh\bh\bhe\be\be\bec\bc\bc\bck\bk\bk\bki\bi\bi\bin\bn\bn\bng\bg\bg\bg
207             compile. It's lot slower than most MusiXTeX
208             preprocessors)
209
210        +\bo    TeX
211
212        +\bo    The MusixTeX fonts. (I use those found in MusixTeX
213             T.59). Beware, the clef symbol has changed position
214             in recent versions of MusixTeX)
215
216        Please refer to the man page for more information.
217
218 R\bR\bR\bRE\bE\bE\bED\bD\bD\bDH\bH\bH\bHA\bA\bA\bAT\bT\bT\bT L\bL\bL\bLI\bI\bI\bIN\bN\bN\bNU\bU\bU\bUX\bX\bX\bX
219        RedHat Linux users should be able to get a RPM. A spec
220        file is in _\bm_\ba_\bk_\be_\b/_\bl_\bi_\bl_\by_\bp_\bo_\bn_\bd_\b._\bs_\bp_\be_\bc. You should be able to
221        create an rpm as a normal user. Be sure you have a
222        ~/.rpmrc, and edit the RPM-dir in _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs_\b._\bm_\ba_\bk_\be
223
224 W\bW\bW\bWI\bI\bI\bIN\bN\bN\bND\bD\bD\bDO\bO\bO\bOZ\bZ\bZ\bZE\bE\bE\bE
225        Windows NT:
226
227        you need the cygnus win32 gnu port development stuff; have
228        a look at http://www.cygnus.com/gnu-win32.
229
230        to make GNU LilyPond under, brr, aargh, well, simply type:
231
232                bash configure
233                make win32
234
235
236 P\bP\bP\bPL\bL\bL\bLA\bA\bA\bAT\bT\bT\bTF\bF\bF\bFO\bO\bO\bOR\bR\bR\bRM\bM\bM\bMS\bS\bS\bS
237        GNU LilyPond (pl 0.0.39) is known to compile on the
238        following platforms:
239
240                * linux 2.0.x, g++ 2.7.2[.1]
241                * aix 4.1, g++ 2.7.2
242                * windows-nt 4.0, cygnus gnu-win32 beta17.1 (~=g++ 2.7.2)
243                * linux 2.0.28 X to doze, gcc-go32 (~=g++ 2.7.2) [exec. untested]
244
245
246 A\bA\bA\bAU\bU\bU\bUT\bT\bT\bTH\bH\bH\bHO\bO\bO\bOR\bR\bR\bRS\bS\bS\bS
247        Han-Wen Nienhuys <hanwen@stack.nl>
248
249        Jan Nieuwenhuizen <jan@digicash.com>
250
251        Have fun!
252
253
254
255
256
257
258
259
260
261
262 2/May/97                 LilyPond 0.0.58                        4
263
264