-\input texinfo @c -*-texinfo-*-
+@node
+@comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
@setfilename INSTALL.info
@settitle INSTALL - compiling and installing GNU LilyPond
@chapter INSTALL - compiling and installing GNU LilyPond
-This document describes how to build LilyPond on Unix platforms. It is
-also known to run and compile on Windows NT/95/98 as well. More
-information on this topic can be found at the
-@uref{http://www.lilypond.org/gnu-windows/, LilyPond on Windows page}.
+This document describes how to build LilyPond on Unix platforms. It
+is also known to run and compile on Windows NT/95/98/ME/XP as well.
+More information on this topic can be found at the
+@uref{http://www.lilypond.org/cygwin/, LilyPond on Windows page}.
@html
@section Downloading
Even numbered versions are `stable'. The webpages for the stable version
-(1.2) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
+(1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
servers}. Big enhancements go into the latest odd numbered version
-(1.3), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
+(1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
site}.
@subsection Source code
@uref{http://www.lilypond.org/ftp/} by HTTP.
@end itemize
+
Of course, if your platform supports LilyPond, such as Debian GNU/Linux,
FreeBSD, OpenBSD or NetBSD, you're encouraged to use the native build
from source drill.
For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the
tarball; see instructions below.
+
+@subsubsection Anonymous CVS access
+
+Short version:
+
+@quotation
+@example
+cvs -d :pserver:anoncvs@@lilypond.org:/home/lilypond login
+cvs -d :pserver:anoncvs@@lilypond.org:/home/lilypond co -P lilypond
+@end example
+@end quotation
+
+See @uref{http://lilypond.org/wiki/?CVS} for more information.
+
@html
<a name="download-binaries">
@end html
You need the following packages to compile Lilypond.
@itemize
-@item A reasonably new C++ compiler: EGCS 1.1, GCC 2.95.2 or
-newer. Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}.
+@item The GNU c++ compiler (version 2.95.2 or newer).
+EGCS 1.1 may work, but is no longer supported.
+Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}.
-@item Python 1.5,
+WARNING: if you choose to upgrade to GCC 3.x, enquire if your
+distribution supports g++ 3.x and flex.
+
+@item Python (version 1.5 or newer).
Check out @uref{http://www.python.org, the python website}.
-@item GUILE 1.3.4 or newer, check out
+@item GUILE (version 1.4 or newer).
+Check out
@uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
-Version 1.4 is recommended for better performance.
@item GNU Make.
Check out
@item Flex (version 2.5.4a or newer).
Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
+WARNING: plain Flex 2.5.4(a) generates invalid C++ code. GCC 3.x
+chokes on this. If you wish to use GCC 3.x, make sure that your
+distribution supports g++ 3.x and flex. For a workaround, see
+lexer-gcc-3.0 below.
+
@item Bison (version 1.25 or newer).
Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
Make sure you have tetex 1.0 or newer (1.0.6 is known to work). You may
need to install a tetex-devel or tetex-dev package too.
-@item Texinfo (version 4.0 or newer).
+@item Texinfo (version 4.2 or newer).
The documentation of lily is written in texinfo. Check out
@uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}.
@item kpathsea, a library for searching (@TeX{}) files. @code{kpathsea} is
usually included with your installation of @TeX{}. You may need to install
-a tetex-devel or tetex-dev package too.
+a tetex-devel or tetex-dev package too. If kpathsea is not installed in
+a directory where the compiler normally looks, read the hints for
+Slackware below.
In the very unlikely case that kpathsea is not available for your
platform (ie, you're not running GNU/Linux, Windows, or any recent
you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
configure something like:
+@quotation
@example
./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
@end example
-
-
-@item pktrace, [OPTIONAL], needed for generating PostScript Type1
-fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/pktrace/}
-
-@item autotrace-0.27a, [OPTIONAL], needed for generating PostScript Type1
-fonts. @uref{http://autotrace.sourceforge.net}.
-
-@item MetaPost [OPTIONAL] needed for generating PostScript Type3 fonts. Please
-note that tetex-0.4pl8 (included with Red Hat 5.x) does not include
-@file{mfplain.mp}, which is needed for producing the scalable font
-files.
-
-If you don't have MetaPost and don't want to use PostScript output, then
-edit @file{mf/GNUmakefile}, removing the line saying @code{PFA_FILES=}.
-
-
+@end quotation
@end itemize
@itemize @bullet
@item @TeX{}.
@item Xdvi and Ghostscript
-@item GUILE 1.3.4, or newer. Check out
+@item GUILE 1.4, or newer. Check out
@uref{http://www.gnu.org/software/guile.html,the GUILE webpage}
@end itemize
Building the website requires some additional tools:
@itemize @bullet
-@item xpmtoppm (from the netpbm package: the Portable Bitmap Utilities).
- The original is at
-@uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,the
-netpbm FTP site}
-
-@item pnmtopng. The original is
-at
-@uref{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz,in
-the pnmtopng FTP site}.
-
-@item @uref{http://www.lri.fr/~filliatr/ftp/bibtex2html/, Bibtex2html}, or
-@uref{http://www.uni-koblenz.de/ag-ki/ftp/bib2html/, Bib2html}.
-Bibtex2html is available in debian, while bib2html is in some rpm based
-distributions.
-Bib2html, in turn depends on man2html for proper installation.
-man2html can be had from @uref{http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05,http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05}.
-
-The website will build without bib converter utility, but you will not
-see our hypertextified bibliography.
-
-@item texinfo (a development release)
-The documentation will build with texinfo-4.0, but if you want split
-html pages, you're best off using the lates pretest version from
-@uref{ftp://texinfo.org/texinfo/pretests/texinfo-4.0b.tar.gz,
-texinfo-4.0b} or
-@uref{ftp://alpha.gnu.org/gnu/texinfo-4.0b.tar.gz,texinfo-4.0b}
+@item The netpbm utilities, see @uref{http://netpbm.sourceforge.net/}
+@item pktrace 1.0 or newer, needed for generating PostScript Type1
+fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/pktrace/}. You
+will need to install some additional packages to get pktrace to work.
@end itemize
@section Building LilyPond
configuration settings, you can use the @code{--enable-config=CONF}
option of configure. You should use @samp{make conf=CONF} to generate
the output in @file{out-CONF}. Example: suppose I want to build with
-and without profiling. Then I'd use the following for the normal build,
+and without profiling. Then I'd use the following for the normal
+build,
+@c prefix=~ ?
@example
./configure --prefix=~ --enable-checking
@section Emacs mode
An Emacs mode for entering music and running LilyPond is included with
-the source archive as @file{lilypond-mode.el} and
-@file{lilypond-font-lock.el}. You should install these files somewhere
-in your @var{load-path}. If you have installed a precompiled LilyPond
-package, these files can be found in
-@file{/usr/share/doc/lilypond-x.y.z/}.
+the source archive as @file{lilypond-mode.el},
+@file{lilypond-indent.el} and @file{lilypond-font-lock.el}. You
+should install these files somewhere in your @var{load-path}. If you
+have installed a precompiled LilyPond package, these files can be
+found in @file{/usr/share/doc/lilypond-x.y.z/}.
Add this to your @file{~/.emacs} or @file{~/.emacs.el}, or install this
file in Emacs' @file{site-start.d}:
+@quotation
@example
- ;;; lilypond-init.el --- Startup code for LilyPond mode
+ ;;; lilypond-init.el --- Startup code for LilyPond mode
+
+ (autoload 'LilyPond-mode "lilypond-mode")
+ (setq auto-mode-alist
+ (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
- (load-library "lilypond-mode.el")
- (setq auto-mode-alist
- (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
- (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
+ (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
@end example
+@end quotation
If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is
automatically loaded, you not even need to modify your @code{~/.emacs}
@subsection Red Hat Linux
-Red Hat 7.0 i386 RPMS are available from
-@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
+Red Hat 7.x i386 RPMS are available from
+@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}. For running on
+a Red Hat system you need these packages: guile, tetex, tetex-latex,
+tetex-dvips, libstdc++, python, ghostscript.
You can also compile them yourself. A spec file is in
@file{make/out/lilypond.redhat.spec}. This file is distributed along
@end example
-For running on a Red Hat system you need these packages: guile, tetex,
-tetex-latex, tetex-dvips, libstdc++, python, ghostscript.
+For compilation on a Red Hat system you need these packages, in
+addition to the those needed for running: glibc-devel, gcc-c++,
+libstdc++-devel, guile-devel, flex, bison, texinfo, groff, pktrace,
+netpbm-progs, autotrace, t1utils.
-For compilation on a Red Hat system you need these packages, in addition
-to the those needed for running: glibc-devel, gcc-c++, libstdc++-devel,
-guile-devel, flex, bison, texinfo, tetex-devel, groff,
-libgr-progs.
@subsection LinuxPPC
the Red Hat RPM.
You must have the following packages: guile tcsh tetex te_latex te_kpath
-te_mpost libpng python gpp libgpp gettext autoconf netpbm libnetpb
+te_mpost libpng python gpp libgpp gettext autoconf253 netpbm libnetpb
gs_serv gs_lib gs_fonts guile
@subsection Slackware
with a faulty compiler. Do not compile LilyPond with -O2 on this
platform.
+At least on Slackware 8.0, you have to manually specify the paths to the
+Kpathsea library, using
+@itemize
+@item @code{rm config.cache}
+@item @code{export LDFLAGS=-L/usr/share/texmf/lib}
+@item @code{export CPPFLAGS=-I/usr/share/texmf/include}
+@item @code{./configure}
+@end itemize
+
+
@subsection Mandrake
Some binaries are available at rpmfind.net. Refer to
Debian's @TeX{} installation is a bit short on memory, you may want to
increase it like this:
@example
---- /etc/texmf/texmf.cnf.dpkg Sun Jan 28 14:12:14 2001
-+++ /etc/texmf/texmf.cnf Fri Apr 27 11:09:35 2001
-@@ -384,8 +384,8 @@
+--- texmf.cnf.orig Sun Dec 16 23:47:07 2001
++++ texmf.cnf Sun Dec 16 23:46:34 2001
+@@ -411,8 +411,8 @@
main_memory.context = 1500000
main_memory.mpost = 1000000
main_memory = 263000 % words of inimemory available; also applies to inimf&mp
-extra_mem_top = 0 % extra high memory for chars, tokens, etc.
-extra_mem_bot = 0 % extra low memory for boxes, glue, breakpoints, etc.
-+extra_mem_top = 100000 % extra high memory for chars, tokens, etc.
-+extra_mem_bot = 100000 % extra low memory for boxes, glue, breakpoints, etc.
++extra_mem_top = 1000000 % extra high memory for chars, tokens, etc.
++extra_mem_bot = 1000000 % extra low memory for boxes, glue, breakpoints, etc.
- obj_tab_size.context = 256000
-
+ obj_tab_size.context = 300000
+
+@@ -430,7 +430,7 @@
+ % Max number of characters in all strings, including all error messages,
+ % help texts, font names, control sequences. These values apply to TeX and MP.
+ pool_size.context = 750000
+-pool_size = 125000
++pool_size = 250000
+ % Minimum pool space after TeX/MP's own strings; must be at least
+ % 25000 less than pool_size, but doesn't need to be nearly that large.
+ string_vacancies.context = 45000
@end example
You could also export @env{extra_mem_top} and @env{extra_mem_bot} as
@item make, m4, flex, bison
@item gettext
@item groff, texinfo
-@item bibtex2html (not in Debian 2.2)
@item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
@item dpkg-dev, debhelper, fakeroot
@item gs, netpbm
apt-get install binutils cpp gcc libc6-dev \
g++ libstdc++2.10-dev \
python-base libguile-dev tetex-bin libkpathsea-dev \
- tetex-extra flex bison texinfo bibtex2html groff gs \
+ tetex-extra flex bison texinfo groff gs \
netpbm m4 gettext
@end example
dpkg --purge lilypond lilypond1.3
@end example
+@subsection MacOS X
+
+LilyPond is available through fink, in the unstable cvs distribution.
+
+You need to:
+@itemize @bullet
+@item Get the Fink package manager from @uref{http://fink.sourceforge.net}
+@item Get the Lilypond package description by enabling the "unstable" tree
+in fink and executing @command{fink selfupdate-cvs}.
+@end itemize
+
+Then do:
+@quotation
+@example
+ fink install lilypond-unstable
+@end example
+@end quotation
+
+That's it! The command should compile and install all LilyPond
+prerequisites (python, TeX, X11, ghostscript) and then LilyPond
+itself.
+
+
+@subsubsection compiling on MacOS X
+LilyPond has been built on Darwin, to be precise, on:
+@example
+ Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24
+ 22:06:02 PST 2002; root:xnu/xnu-201.19.obj~1/RELEASE_PPC Power Macintosh powerpc
+@end example
+
+using:
+
+@example
+ Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release)
+@end example
+
+To make sure you have all packages needed to build LilyPond installed,
+run as root:
+
+@example
+ apt-get install bash python guile debianutils flex bison texinfo \
+ ghostscript6 netpbm m4 gettext
+@end example
+
+and:
+
+@example
+ fink install tetex
+@end example
+
+For more information about @file{apt-get} and @file{fink}, see
+@uref{http://fink.sf.net,fink.sourceforge.net}.
+
+@c brokenness of autoconf; don't ask
+Then, configure, patch, make and install LilyPond using these commands:
+
+@example
+ CC="cc -I/sw/include" CXX="c++ -I/sw/include" LDFLAGS="-L/sw/lib" \
+ ./configure --prefix=/sw
+ make -C lily out/parser.hh out/parser.cc out/config.h
+ patch -p0 < darwin.patch
+ make -C lily out/parser.o
+ make DEPENDENCIES_OUTPUT=/dev/null all
+ make install
+@end example
+
+For installing, you must be root, of course.
@c Why isn't this in BUGS (where it belongs?)
@section Problems
Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
-
-
@unnumberedsubsec Linux-2.4.0, Guile-1.4 --with-threads
There's a bug in certain kernels around version 2.4.0, that is
projects / lilypond.git / blobdiff