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