]> git.donarmstrong.com Git - lilypond.git/blob - INSTALL.text
release: 0.0.72pre
[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    A Unix system with GNU tools. GNU LilyPond is known
27             to run on these unices: Linux, AIX, Digital Unix and
28             Solaris.
29
30             If you have the Cygnus WINDOWS32 port of the GNU
31             utils, it will even work in Windows NT/95, but don't
32             promise to support it.
33
34        +\bo    GNU C++ v2.7 or better, with libg++ installed.
35             Version 2.7.2 or better recommended.
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 3/Jul/97                 LilyPond 0.0.72                        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 (gnu/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 3/Jul/97                 LilyPond 0.0.72                        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        subdirectories _\bo_\bu_\bt_\b/ (which contain all files generated
163        during compilation).
164
165 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
166        If you have done a successful make, then a simple
167
168                make install
169
170        should do the trick.
171
172        [todo. Obsolete; fonts are in distribution now.]
173
174        Install the musixtex fonts in a directory which TeX and MF
175        knows (if you are root, look for a directory which
176        contains the directories with AMS and CM source (*.mf)
177        files. Create a subdir lilypond or musixtex and copy the
178        fonts into that). Do not forget to rehash TeX (if
179        applicable)
180
181        Example: my fonts are in
182        _\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
183        pointing to that in
184        _\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/
185
186 C\bC\bC\bCA\bA\bA\bAV\bV\bV\bVE\bE\bE\bEA\bA\bA\bAT\bT\bT\bTS\bS\bS\bS
187        +\bo    The -O2 option to gcc triggers a gcc bug on DEC Alpha
188             in dstream.cc. You should turn off this flag for this
189             file.
190
191 R\bR\bR\bRU\bU\bU\bUN\bN\bN\bNN\bN\bN\bNI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
192        GNU LilyPond does use a lot of resources. For operation
193
194
195
196 3/Jul/97                 LilyPond 0.0.72                        3
197
198
199
200
201
202 INSTALL(1)            LilyPond documentation           INSTALL(1)
203
204
205        you need the following:
206
207        +\bo    A fast computer (a full page of music typically takes
208             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
209             compile. It's lot slower than most MusiXTeX
210             preprocessors)
211
212        +\bo    TeX
213
214        +\bo    The MusixTeX fonts. (I use those found in MusixTeX
215             T.59). Beware, the clef symbol has changed position
216             in the Egler version, aka. OpusTeX)
217
218        At this time, GNU LilyPond output looks nice, but is not
219        of production quality. If you're not discouraged; this is
220        what I type in my xterm:
221
222                lilypond someinput.ly
223                tex lelie.tex
224                xdvi test&
225
226        This is what the output looks like over here:
227
228                hw:~/musix/spacer$ lilypond input/kortjakje.ly
229                GNU LilyPond 0.0.71 #20/FlowerLib 1.1.20 #0
230                Parsing ... [/home/hw/share/lilypond/init//symbol.ini  <..snip..>
231                ..      .ini]][input/kortjakje.ly]
232                Creating elements ...
233                Preprocessing elements...
234                Calculating column positions ... [3][8][13][17][21][25]
235                Postprocessing elements...
236                TeX output to lelie.tex ...
237
238                hw:~/musix/spacer$ tex lelie
239                This is TeX, Version 3.14159 (C version 6.1)
240                (lelie.tex
241                Hyphenation patterns for english, dutch, german, loaded.
242                (/home/hw/lib/texmf/tex/lilypond/lilyponddefs.tex) [1] )
243                Output written on lelie.dvi (1 page, 8944 bytes).
244                Transcript written on lelie.log.
245
246                hw:~/musix/spacer$ xdvi lelie&
247                [1] 855
248
249        Check out the input files, some of them have comments
250        Please refer to the man page for more information.
251
252 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
253        RedHat Linux users should be able to get a RPM. A spec
254        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
255        create an rpm as a normal user. Be sure you have a
256        ~/.rpmrc, and edit the RPM-dir in _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs_\b._\bm_\ba_\bk_\be
257
258
259
260
261
262 3/Jul/97                 LilyPond 0.0.72                        4
263
264
265
266
267
268 INSTALL(1)            LilyPond documentation           INSTALL(1)
269
270
271 W\bW\bW\bWI\bI\bI\bIN\bN\bN\bND\bD\bD\bDO\bO\bO\bOZ\bZ\bZ\bZE\bE\bE\bE
272        Windows NT:
273
274        you need the cygnus windows32 gnu port development stuff;
275        have a look at http://www.cygnus.com/gnu-win32.
276
277        to make GNU LilyPond under, brr, aargh, well, simply type:
278
279                bash configure
280                make windows32
281
282
283 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
284        GNU LilyPond (pl 0.0.39) is known to compile on the
285        following platforms:
286
287        Unix:
288
289                * gnu/linux 2.0.x, g++ 2.7.2[.1]
290                * aix 4.1, g++ 2.7.2
291                * solaris 2.5, g++ 2.7.2
292
293        Other:
294
295                * windows-nt 4.0, cygnus gnu-windows32 beta17.1 (~=g++ 2.7.2)
296                * gnu/linux 2.0.28 X to doze, gcc-go32 (~=g++ 2.7.2) [exec. untested]
297
298
299 A\bA\bA\bAU\bU\bU\bUT\bT\bT\bTH\bH\bH\bHO\bO\bO\bOR\bR\bR\bRS\bS\bS\bS
300        Han-Wen Nienhuys <hanwen@stack.nl>
301
302        Jan Nieuwenhuizen <jan@digicash.com>
303
304        Have fun!
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328 3/Jul/97                 LilyPond 0.0.72                        5
329
330