]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/topdocs/INSTALL.texi
Instructions how to install vim-mode.
[lilypond.git] / Documentation / topdocs / INSTALL.texi
1 @node Top, , , (dir)
2 @top
3 @comment  node-name,  next,  previous,  up\input texinfo @c -*-texinfo-*-
4 @setfilename INSTALL.info
5 @settitle INSTALL - compiling and installing GNU LilyPond
6
7 @html
8 <!--- @@WEB-TITLE@@=Installation Instructions --->
9 @end html
10
11 @contents
12
13 @chapter INSTALL - compiling and installing GNU LilyPond
14
15
16 This document describes how to build LilyPond on Unix platforms.  It
17 is also known to run and compile on Windows NT/95/98/ME/XP as well.
18 More information on this topic can be found at the
19 @uref{http://www.lilypond.org/cygwin/, LilyPond on Windows page}.
20
21
22 @html
23 <a name="download-source">
24 @end html
25
26 @section Downloading
27
28 Even numbered versions are `stable'. The webpages for the stable version
29 (1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
30 servers}. Big enhancements go into the latest odd numbered version
31 (1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
32 site}.
33
34 Building LilyPond is an involved process. We advise to use binary
35 packages if these are available for your platform.
36
37 @subsection Source code
38
39   If you want to compile LilyPond from source, download here:
40 @itemize @bullet
41 @item Download development releases from
42 @c Hmm, these won't show up in lilypond.org/stats
43 @c Otoh, lilypond.org is not updated when release mail arrives
44 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/} by FTP and
45 @uref{http://ftp.cs.uu.nl/pub/GNU/LilyPond/}, by HTTP.
46 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror)
47 @item at @code{lilypond.org} 
48 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
49 @uref{http://www.lilypond.org/ftp/} by HTTP.
50 @end itemize
51
52
53 For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the
54 tarball; see instructions below.
55
56 Of course, if your platform supports LilyPond, such as Debian GNU/Linux,
57 FreeBSD, OpenBSD or NetBSD, you're encouraged to use the native build
58 from source drill.
59
60 The latest development version is also available through anonymous
61 CVS. See @uref{http://savannah.gnu.org/cvs/?group=lilypond}.
62
63 CVS does not contain generated files.  To create @file{configure}, run
64 @quotation
65 @example
66 ./autogen.sh
67 @end example
68 @end quotation
69
70 @html
71 <a name="download-binaries">
72 @end html
73
74
75
76 @subsection Precompiled binaries
77
78 If you want to track bleeding edge development, try:
79
80 @itemize @bullet
81 @item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian
82 GNU/Linux} usually has the latest binaries for the most useful stable
83 and development versions, while
84 @item @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/,
85 Mandrake Cooker} also provides fairly recent versions.
86 @end itemize
87
88 Binaries are made available for other popular platforms, but as we need
89 to compile them ourselves, they are not updated for every version
90 released.
91
92 @itemize @bullet
93 @item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat-7.x/, Red Hat i386}
94 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE, SuSE}
95 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/,
96 LinuxPPC}
97 @item
98 @uref{http://www.lilypond.org/gnu-windows/, Windows}
99 @end itemize
100
101 @subsection Upgrading
102
103 There are two options for upgrading sources.
104
105 @itemize
106 @item if you have an unpacked source tree of a previous version, you
107 may the patches.
108
109 @emph{If you upgrade by patching do remember to rerun autoconf after
110 applying the patch}.
111
112 @item if you have the @code{.tar.gz} file of a previous release, you can
113 use
114 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/, xdelta}.
115  This is much safer than using patches, and is the recommended way.
116
117 The following command produces @file{lilypond-1.4.3.tar.gz} from
118 @file{lilypond-1.4.2.tar.gz} identical (up to compression dates) to the .3
119 on the FTP site.
120 @example
121   xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
122 @end example
123 @end itemize
124
125 @subsection Font problems.
126
127 If you are upgrading from a previous version of LilyPond, be sure to
128 remove all old font files. These include @file{.pk} and @file{.tfm} files
129 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
130 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}.  A
131 script automating this has been included, see
132 @file{buildscripts/clean-fonts.sh}.
133
134
135
136
137 @section Requirements
138
139 @subsection Compilation
140
141 You need the following packages to compile Lilypond.
142
143 @itemize
144 @item The GNU c++ compiler (version 2.95.2 or newer).
145 EGCS 1.1 may work, but is no longer supported.
146 Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}.
147
148 WARNING: if you choose to upgrade to GCC 3.x, enquire if your
149 distribution supports g++ 3.x and flex.  At the time of writing (Fri
150 Jul 5 2002), @strong{no} distribution that we know of ships a flex
151 that generates gcc-3.1.x compliant C++ code.
152
153 @item Python (version 1.5 or newer).
154 Check out @uref{http://www.python.org, the python website}.
155
156 @item GUILE (version 1.4 or newer).
157 Check out
158 @uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
159
160 @item GNU Make. 
161 Check out
162 @uref{ftp://ftp.gnu.org/gnu/make/, the GNU
163 make FTP directory}.
164
165 @item Flex (version 2.5.4a or newer). 
166 Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
167
168 WARNING: plain Flex 2.5.4(a) generates invalid C++ code.  GCC 3.x
169 chokes on this.  If you wish to use GCC 3.x, make sure that your
170 distribution supports g++ 3.x and flex.  For workarounds, see
171 lexer-gcc-3.0.patch and lexer-gcc-3.1.sh in the source directory.
172
173 @item Bison (version 1.25 or newer).
174 Check out @uref{http://www.gnu.org/software/bison/,the bison  webpage}
175
176 @item @TeX{}.
177
178 @TeX{} is used as an output backend.
179
180 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
181 @file{.afm}, @file{.tfm}).  Make sure you have tetex 1.0 or newer
182 (1.0.6 is known to work).  You may need to install a tetex-devel (or
183 tetex-dev or libkpathsea-dev) package too.
184
185 @item Texinfo (version 4.2 or newer).
186 The documentation of lily is written in texinfo.  Check out
187 @uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}.
188
189 @item The geometry package for LaTeX is needed to use ly2dvi.  
190 It is available at
191 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,the
192 FTP directory for @code{geometry}}. This package is normally included
193 with the @TeX{} distribution.
194
195 @item kpathsea, a library for searching (@TeX{}) files.  @code{kpathsea} is
196 usually included with your installation of @TeX{}.  You may need to
197 install a tetex-devel or tetex-dev package too. If kpathsea is not
198 installed in a directory where the compiler normally looks, read the
199 hints for Slackware below.
200
201 In the very unlikely case that kpathsea is not available for your
202 platform (ie, you're not running GNU/Linux, Windows, or any recent
203 UNIX), you can compile LilyPond without kpathsea support.  In that case,
204 you'll probably have to indicate where @TeX{}'s tfm files live.  Invoke
205 configure something like:
206
207 @quotation
208 @example
209 ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
210 @end example
211 @end quotation
212
213 @end itemize
214
215 @subsection Running requirements
216
217 GNU LilyPond does use a lot of resources. For operation you need the
218 following software
219
220 @itemize @bullet
221 @item @TeX{}.
222 @item Xdvi and Ghostscript
223 @item GUILE 1.4, or newer.
224 Check out
225 @uref{http://www.gnu.org/software/guile.html,the GUILE webpage}
226 @end itemize
227
228 For running LilyPond successfully you have to help @TeX{} and MetaFont find
229 various files.  The recommended way of doing so is adjusting the
230 environment variables in the start-up scripts of your shell. Appropriate
231 Csh and bourne sh scripts are left in
232 @file{buildscripts/out/lilypond-profile} and
233 @file{buildscripts/out/lilypond-login} after compilation.
234
235 LilyPond is a big and slow program.  A fast CPU and plenty of RAM is
236 recommended for comfortable use.
237
238 @subsection Building documentation
239
240 You can view the documentation online at
241 @uref{http://www.lilypond.org/stable/Documentation/out-www/}, but you
242 can also build it locally. This process requires a successful compile of
243 lilypond. The documentation is built by issuing
244 @example 
245
246   make web-doc
247  
248 @end example 
249
250 Building the website requires some additional tools: 
251
252 @itemize @bullet
253 @item The netpbm utilities, see @uref{http://netpbm.sourceforge.net/}
254 @item mftrace 1.0 or newer, needed for generating PostScript Type1
255 fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/mftrace/}.  You
256 will need to install some additional packages to get mftrace to work.
257 @end itemize
258
259 @section Building LilyPond
260
261 to install GNU LilyPond, type:
262 @example 
263         gunzip -c lilypond-x.y.z | tar xf -
264         cd lilypond-x.y.z
265         ./configure             # run with --help to see appropriate options
266         make
267         make install
268         sh buildscripts/clean-fonts.sh      
269 @end example 
270
271 If you are doing an upgrade, you should remove all @file{feta}
272 @code{.pk} and @file{.tfm} files.  A script has been provided to do the
273 work for you, see @file{buildscripts/clean-fonts.sh}.
274
275
276 If you are not root, you should choose a @code{--prefix} argument that
277 points into your home directory, eg.
278 @example 
279
280         ./configure --prefix=$HOME/usr
281  
282 @end example 
283
284 In this case, you have to insert the contents of
285 @code{buildscripts/out/lilypond-login} or
286 @code{buildscripts/out/lilypond-profile} into your start up scripts by
287 hand.
288
289
290
291 @subsection Configuring for multiple platforms
292
293 If you want to build multiple versions of LilyPond with different
294 configuration settings, you can use the @code{--enable-config=CONF}
295 option of configure.  You should use @samp{make conf=CONF} to generate
296 the output in @file{out-CONF}.  Example: suppose I want to build with
297 and without profiling.  Then I'd use the following for the normal
298 build,
299 @c prefix=~ ?
300 @example 
301
302       ./configure --prefix=$HOME/usr/ --enable-checking
303       make
304       make install
305 @end example 
306
307 and for the profiling version, I specify a different configuration.
308
309 @example 
310
311       ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
312       make conf=prof
313       make conf=prof install
314
315 @end example 
316
317
318
319
320
321 @section Emacs mode
322
323 An Emacs mode for entering music and running LilyPond is included with
324 the source archive as @file{lilypond-mode.el},
325 @file{lilypond-indent.el} and @file{lilypond-font-lock.el}. 
326 You should install these files somewhere in your @var{load-path}. Add, e.g.,
327 @file{~/site-lisp/} to @var{load-path} by appending the following line to your
328 @file{~/.emacs} or @file{~/.emacs.el}:
329 @quotation
330 @example
331 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
332 @end example
333 @end quotation
334 Place then @file{lilypond-init.el} to @var{load-path}@file{/site-start.d/}
335 or append it also to your @file{~/.emacs} or @file{~/.emacs.el}.
336 If you have installed a precompiled LilyPond package, these files can be
337 found in @file{/usr/share/doc/lilypond-x.y.z/}. 
338
339 If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is
340 automatically loaded, you not even need to modify your @code{~/.emacs}
341 file.
342
343 @section Vim mode
344
345 A Vim mode for entering music and running LilyPond is included with 
346 the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
347 to get shortcuts. Add files @file{lilypond.vim} and @file{lilypond.words} 
348 to @file{~/.vim/} to get syntax-highlighting and auto-completion,
349 correspondingly.
350
351
352 @section Compiling for distributions 
353
354 @subsection Red Hat Linux
355
356 Red Hat 7.x i386 RPMS are available from
357 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.  For running on
358 a Red Hat system you need these packages: guile, tetex, tetex-latex,
359 tetex-dvips, libstdc++, python, ghostscript.
360
361 You can also compile them yourself.  A spec file is in
362 @file{make/out/lilypond.redhat.spec}. This file is distributed along
363 with the sources.  You can make the rpm by issuing
364 @example 
365
366         cp lilypond-x.y.z.tar.gz /usr/src/redhat/SOURCES/
367         tar xfz lilypond-x.y.z.tar.gz
368         rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec
369         rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
370
371 @end example 
372
373 For compilation on a Red Hat system you need these packages, in
374 addition to the those needed for running: glibc-devel, gcc-c++,
375 libstdc++-devel, guile-devel, flex, bison, texinfo, groff, mftrace,
376 netpbm-progs, autotrace, t1utils.
377
378
379
380 @subsection LinuxPPC
381
382
383 Some LinuxPPC RPMS should available from
384 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
385
386 A LinuxPPC RPM can be made using the @file{lilypond.redhat.spec} file.
387
388 @subsection SuSE
389
390 Some SUSE RPMS should available from
391 @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE}.
392
393 You can also compile a RPM for SUSE yourself.  A spec file is in
394 @file{make/out/lilypond.suse.spec}, see the instructions for building
395 the Red Hat RPM.
396
397 You must have the following packages: guile tcsh tetex te_latex te_kpath
398 te_mpost libpng python gpp libgpp gettext autoconf netpbm libnetpb
399 gs_serv gs_lib gs_fonts guile
400
401 @subsection Slackware
402
403 No precompiled packages for Slackware are available.
404
405 Problems have been reported with Slackware 7.0; apparently, it ships
406 with a faulty compiler. Do not compile LilyPond with -O2 on this
407 platform.
408
409 At least on Slackware 8.0, you have to manually specify the paths to the
410 Kpathsea library, see the section on kpathsea 
411
412
413 @subsection Mandrake
414
415 Some binaries are available at rpmfind.net. Refer to 
416 @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/}.
417
418 You can also compile a RPM for Mandrake yourself.  A spec file is in
419 @file{make/out/lilypond.mandrake.spec}, see the instructions for building
420 the Red Hat RPM.
421
422 @subsection Debian GNU/Linux
423
424 A Debian package is also available.  You may install it easily by running
425 @command{apt-get} as root:
426 @example
427
428         apt-get install lilypond lilypond-doc
429 @end example
430
431 You can also compile the .deb for Debian yourself, do:
432 @example
433
434         apt-get -b source lilypond
435 @end example
436
437 If you're real impatient, you may even do:
438 @example
439
440         cd lilypond-x.y.z   # a previous version
441         uscan               # download and build latest directly from upstream
442 @end example
443
444
445 Debian's @TeX{} installation is a bit short on memory, you may want to
446 increase it like this:
447 @example
448 --- texmf.cnf.orig      Sun Dec 16 23:47:07 2001
449 +++ texmf.cnf   Sun Dec 16 23:46:34 2001
450 @@ -411,8 +411,8 @@
451  main_memory.context = 1500000
452  main_memory.mpost = 1000000
453  main_memory = 263000 % words of inimemory available; also applies to inimf&mp
454 -extra_mem_top = 0    % extra high memory for chars, tokens, etc.
455 -extra_mem_bot = 0    % extra low memory for boxes, glue, breakpoints, etc.
456 +extra_mem_top = 1000000    % extra high memory for chars, tokens, etc.
457 +extra_mem_bot = 1000000    % extra low memory for boxes, glue, breakpoints, etc.
458  
459  obj_tab_size.context = 300000
460  
461 @@ -430,7 +430,7 @@
462  % Max number of characters in all strings, including all error messages,
463  % help texts, font names, control sequences.  These values apply to TeX and MP.
464  pool_size.context = 750000
465 -pool_size = 125000             
466 +pool_size = 250000             
467  % Minimum pool space after TeX/MP's own strings; must be at least
468  % 25000 less than pool_size, but doesn't need to be nearly that large.
469  string_vacancies.context = 45000
470 @end example
471
472 You could also export @env{extra_mem_top} and @env{extra_mem_bot} as
473 environment variables if you do not want to or cannot modify
474 @file{/etc/texmf/texmf.cnf}.
475
476 Alternatively, visit
477
478 @itemize @bullet
479 @item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
480 @item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
481 for latest semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato) users.
482 The official stable Debian 2.2 is stuck with the old LilyPond-1.3.24.
483 Since LilyPond-1.4 has been released, the older lilypond1.3 Debian
484 package is now obsolete.
485 @end itemize
486
487 Please contact Anthony Fok @email{lilypond@@packages.debian.org} for more
488 information.
489
490 The build scripts are in the subdirectory @file{debian/}; you can
491 make the .deb by doing, for example:
492
493 @example
494         $ su - root
495         # dpkg --purge lilypond lilypond1.3
496         # exit
497         $ tar xzf lilypond-1.4.3.tar.gz
498         $ cd lilypond-1.4.3
499         $ dch -p -v 1.4.3-0.local.1 "Local build."
500         $ debuild -B
501         $ su - root
502         # dpkg -i ../lilypond_1.4.3*.deb
503         # exit
504         $
505 @end example
506
507 Use command @command{debuild} instead of @command{debuild -B} if you have
508 a very fast machine and want to build the HTML, PS and DVI documentation
509 too.
510
511 For compilation on a Debian GNU/Linux system you need these packages,
512 in addition to the those needed for running:
513
514 @itemize @bullet
515 @item g++, cpp, libc6-dev, libstdc++<@var{your-libstdc++-version-here}>-dev
516 @item libguile<@var{your-libguile-version-here}>-dev
517 @item make, m4, flex, bison
518 @item gettext
519 @item groff, texinfo
520 @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
521 @item dpkg-dev, debhelper, fakeroot
522 @item gs, netpbm
523 @item pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
524   in Debian testing/unstable.)
525 @end itemize
526
527 Most of these are listed on the @samp{Build-Depends} line in the
528 @file{debian/control} file.  To ensure the creation of the lilypond deb is
529 trouble-free, we recommend that you first install the following packages
530 by running \@command{apt-get} as root before building the package:
531
532 For Debian 2.2:
533
534 @example
535         apt-get install task-debian-devel task-c++-dev \
536                 python-base libguile6-dev tetex-bin tetex-dev \
537                 tetex-extra flex bison texinfo groff gs \
538                 netpbm pnmtopng m4 gettext
539 @end example
540
541 For Debian in development ("unstable", the future 2.3 or 3.0):
542
543 @example
544         apt-get install binutils cpp gcc libc6-dev \
545                 g++ libstdc++2.10-dev \
546                 python-base libguile-dev tetex-bin libkpathsea-dev \
547                 tetex-extra flex bison texinfo  groff gs \
548                 netpbm m4 gettext
549 @end example
550
551 And, just so that old fonts from previous versions of LilyPond won't
552 interfere with your build, you may want to do this before the build too:
553
554 @example
555         dpkg --purge lilypond lilypond1.3
556 @end example
557
558 @subsection MacOS X
559
560 LilyPond is available through fink, in the unstable cvs distribution.
561
562 You need to:
563 @itemize @bullet
564 @item Get the Fink package manager from @uref{http://fink.sourceforge.net}
565 @item Get the Lilypond package description by enabling the "unstable" tree
566 in fink and executing @command{fink selfupdate-cvs}.
567 @end itemize
568
569 Then do:
570 @quotation
571 @example
572         fink install lilypond-unstable
573 @end example
574 @end quotation
575
576 That's it!  The command should compile and install all LilyPond
577 prerequisites (python, TeX, X11, ghostscript) and then LilyPond
578 itself.
579
580
581 @subsection compiling on MacOS X
582 LilyPond has been built on Darwin, to be precise, on:
583 @example
584     Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24
585     22:06:02 PST 2002; root:xnu/xnu-201.19.obj~1/RELEASE_PPC  Power Macintosh powerpc
586 @end example
587
588 using:   
589
590 @example
591     Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release)
592 @end example
593
594 To make sure you have all packages needed to build LilyPond installed,
595 run as root:
596
597 @example
598         apt-get install bash python guile debianutils flex bison texinfo \
599                 ghostscript6 netpbm m4 gettext
600 @end example        
601
602 and:
603                 
604 @example
605         fink install tetex
606 @end example        
607
608 For more information about @file{apt-get} and @file{fink}, see
609 @uref{http://fink.sf.net,fink.sourceforge.net}.
610
611 @c  brokenness of autoconf; don't ask
612 Then, configure, patch, make and install LilyPond using these commands:
613
614 @example
615         CC="cc -I/sw/include" CXX="c++ -I/sw/include" LDFLAGS="-L/sw/lib" \
616             ./configure --prefix=/sw
617         make -C lily out/parser.hh out/parser.cc out/config.h
618         patch -p0 < darwin.patch
619         make -C lily out/parser.o
620         make DEPENDENCIES_OUTPUT=/dev/null all
621         make install
622 @end example
623
624 For installing, you must be root, of course.
625
626 @c Why isn't this in BUGS (where it belongs?)
627 @section Problems
628
629 For help and questions use @email{lilypond-user@@gnu.org}.  Please
630 consult the FAQ before mailing your problems.  If you find bugs, please
631 send bug reports to @email{bug-lilypond@@gnu.org}.
632
633 Bugs that are not fault of LilyPond are documented here.
634
635 @subsection Linking to kpathsea
636
637 If kpathsea and the corresponding header files are installed in some
638 directory where GCC does not search by default, for example in
639 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
640 you have to explicitly tell configure where to find it. To do this,
641
642 @itemize
643 @item @code{rm config.cache}
644 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
645 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
646 @item @code{./configure}
647 @end itemize
648 Once configure has found them, the paths are stored in
649 @file{config.make} and will be used even if you don't have the
650 environment variables set during make.
651
652
653 @unnumberedsubsec Gcc-3.0.4
654
655 Gcc 3.0.4, is a bit flaky.  Try downgrading to 2.95.x, or if you're
656 adventurous (see below), upgrading to 3.1.x.
657
658 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
659
660 Flex 2.5.4a does not produce g++-3.0 compliant C++ code.  To compile
661 LilyPond with gcc-3.0 you may do:
662
663 @example
664         CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
665         make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
666         patch -p1 < lexer-gcc-3.0.patch
667         make conf=gcc-3.0 -C lily
668 @end example
669
670 Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
671
672 @unnumberedsubsec Flex-2.5.4a and gcc-3.1.x
673
674 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code.  To compile
675 LilyPond with gcc-3.1.1 you may do:
676
677 @example
678         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
679         CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
680             ./configure --enable-config=gcc-3.1
681         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
682         make conf=gcc-3.1
683 @end example
684
685 This assumes that the GCC 3.1 binaries are called gcc-3.1 and g++-3.1.
686 Note that this is @strong{not} fixed in Debian/unstable for flex <=
687 2.5.4a-26.
688
689 @unnumberedsubsec Linux-2.4.0, Guile-1.4 --with-threads
690
691 There's a bug in certain kernels around version 2.4.0, that is
692 triggered when using Guile 1.4 compiled with pthreads.  You'll see
693 random segmentation fault crashes of LilyPond.  Upgrade to a newer
694 version of Linux.  If you can't do that, you may try to recompiling
695 Guile without threads (YMMV):
696
697 @example
698          guile-1.4$ ./configure --without-threads; make all install
699 @end example
700
701 @unnumberedsubsec OpenBSD
702
703 @itemize @bullet
704 @item By default, gcc on OpenBSD doesn't include
705 @file{/usr/local/include} and @file{/usr/local/lib} in the system
706 paths.  Depending upon where/how you installed kpathsea and other
707 libraries, you may need to refer to the section ``Linking to
708 kpathsea''.
709
710 @end itemize
711
712 @unnumberedsubsec NetBSD
713
714 @itemize @bullet
715 @item The flex precompiled in NetBSD-1.4.2 is broken.
716 Download flex-2.5.4a, build, install.
717
718 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
719 release)) does not include @file{/usr/pkg} paths.  Configure using:
720 @example
721
722 CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
723
724 @end example
725
726 @end itemize
727
728 @unnumberedsubsec  Solaris
729
730 @itemize @bullet
731 @item Solaris7, ./configure
732
733 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
734 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
735 is.  Please run configure like:
736 @example
737         CONFIG_SHELL=/bin/ksh ksh -c ./configure
738 @end example
739 or
740 @example
741         CONFIG_SHELL=/bin/bash bash -c ./configure
742 @end example
743
744 @item Sparc64/Solaris 2.6, GNU make-3.77
745
746 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
747
748 @item Sparc64/Solaris 2.6, ld
749
750 Not yet resolved.
751 @end itemize
752
753
754 @unnumberedsubsec   AIX
755
756 @itemize @bullet
757 @item AIX 4.3 ld
758
759 The following is from the gcc install/SPECIFIC file.
760 @quotation
761    Some versions of the AIX binder (linker) can fail with a relocation
762    overflow severe error when the -bbigtoc option is used to link
763    GCC-produced object files into an executable that overflows the TOC.
764    A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND  
765    -BBIGTOC) is available from IBM Customer Support and from its
766    27service.boulder.ibm.com website as PTF U455193.   
767
768    Binutils does not support AIX 4.3 (at least through release 2.9). GNU
769    as and GNU ld will not work properly and one should not configure GCC
770    to use those GNU utilities. Use the native AIX tools which do
771    interoperate with GCC.
772 @end quotation
773
774 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
775 @example
776     LDFLAGS='-Wl,-bbigtoc' ./configure
777 @end example
778
779 @end itemize
780
781
782 @bye
783