-@node
+@node Top, , , (dir)
+@top
@comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
@setfilename INSTALL.info
@settitle INSTALL - compiling and installing GNU LilyPond
<!--- @@WEB-TITLE@@=Installation Instructions --->
@end html
-@node Top, , , (dir)
-@top
-
@contents
@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}.
+Building LilyPond is an involved process. We advise to use binary
+packages if these are available for your platform.
+
@subsection Source code
-If you want to compile LilyPond from source, download here:
+ If you want to compile LilyPond from source, download here:
@itemize @bullet
@item Download development releases from
@c Hmm, these won't show up in lilypond.org/stats
@c Otoh, lilypond.org is not updated when release mail arrives
-@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/} by FTP and
-@uref{http://ftp.cs.uu.nl/pub/GNU/LilyPond/}, by HTTP.
-@item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror)
-@item at @code{lilypond.org}
@uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
@uref{http://www.lilypond.org/ftp/} by HTTP.
+@item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror)
@end itemize
+
+For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the
+tarball; see instructions below.
+
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.
+The latest development version is also available through anonymous
+CVS. See @uref{http://savannah.gnu.org/cvs/?group=lilypond}.
+
+CVS does not contain generated files. To create @file{configure}, run
+@quotation
+@example
+./autogen.sh
+@end example
+@end quotation
@html
<a name="download-binaries">
released.
@itemize @bullet
-@item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, Red Hat i386}
+@item @uref{http://www-ccrma.stanford.edu/planetccrma/software/soundapps.html#lilypond,Red Hat i386}
@item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE, SuSE}
@item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/,
LinuxPPC}
@end example
@end itemize
+@subsection Font problems.
+
+If you are upgrading from a previous version of LilyPond, be sure to
+remove all old font files. These include @file{.pk} and @file{.tfm} files
+that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
+@file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}. A
+script automating this has been included, see
+@file{buildscripts/clean-fonts.sh}.
+
+
+
+
@section Requirements
@subsection Compilation
You need the following packages to compile Lilypond.
@itemize
-@item A reasonably new version of the GNU 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 (version 1.5 or newer).
+WARNING: if you choose to upgrade to GCC 3.x, enquire if your
+distribution supports g++ 3.x and flex. At the time of writing (Fri
+Jul 5 2002), @strong{no} distribution that we know of ships a flex
+that generates gcc-3.1.x compliant C++ code.
+
+@item Python (version 2.1 or newer).
Check out @uref{http://www.python.org, the python website}.
-@item GUILE (version 1.4 or newer).
+@item GUILE (version 1.6 or newer).
Check out
@uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
@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 workarounds, see
+lexer-gcc-3.0.patch and lexer-gcc-3.1.sh in the source directory.
+
@item Bison (version 1.25 or newer).
Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
@TeX{} is used as an output backend.
-Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf}, @file{.afm}, @file{.tfm}).
-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.
+Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
+@file{.afm}, @file{.tfm}). 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 or libkpathsea-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}.
with the @TeX{} distribution.
@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.
+usually included with your installation of @TeX{}. You may need to
+install 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 1.0 or newer, [OPTIONAL], 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 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
LilyPond is a big and slow program. A fast CPU and plenty of RAM is
recommended for comfortable use.
-@subsection Website requirements
+@subsection Building documentation
-The documentation comes in the form of a website. You can view this
-website on the internet, but you can also build it locally. This process
-requires a successful compile of lilypond. The website is built
-by issuing
+You can view the documentation online at
+@uref{http://www.lilypond.org/stable/Documentation/out-www/}, but you
+can also build it locally. This process requires a successful compile of
+lilypond. The documentation is built by issuing
@example
- make web-doc
+ make web
@end example
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 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 mftrace 1.0 or newer, needed for generating PostScript Type1
+fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/mftrace/}. You
+will need to install some additional packages to get mftrace to work.
@end itemize
-@section Building LilyPond
+@section Building LilyPond
to install GNU LilyPond, type:
@example
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
+ ./configure --prefix=$HOME/usr/ --enable-checking
make
make install
@end example
@example
- ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
+ ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
make conf=prof
make conf=prof install
@section Emacs mode
-An Emacs mode for entering music and running LilyPond is included with
+An Emacs mode for entering music and running LilyPond is contained in
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}:
+@file{lilypond-indent.el}, @file{lilypond-font-lock.el} and
+@file{lilypond.words}.
+You should install these files to a directory included in your
+@var{load-path}. File @file{lilypond-init.el} should be placed to
+@var{load-path}@file{/site-start.d/} or appended to your @file{~/.emacs}
+or @file{~/.emacs.el}. If you have installed a precompiled LilyPond
+package, these files can be found in @file{/usr/share/doc/lilypond-x.y.z/}.
+
+As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
+to your @var{load-path}. Append the following line (modified) to your
+@file{~/.emacs}:
@quotation
@example
- ;;; lilypond-init.el --- Startup code for LilyPond mode
-
- (autoload 'LilyPond-mode "lilypond-mode")
- (setq auto-mode-alist
- (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
-
- (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
+(setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
@end example
@end quotation
automatically loaded, you not even need to modify your @code{~/.emacs}
file.
+@section Vim mode
+
+A Vim mode for entering music and running LilyPond is contained in
+the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
+to get shortcuts. Install file @file{lilypond.words} to @file{~/.vim/} to
+get auto-completion. Syntax highlighting you get by installing
+@file{lilypond.vim} to @file{~/.vim/syntax/} and appending the following
+to @file{~/.vim/filetype.vim}:
+@quotation
+@example
+" my filetype file
+if exists("did_load_filetypes")
+ finish
+endif
+augroup filetypedetect
+ au! BufRead,BufNewFile *.ly setfiletype lilypond
+augroup
+@end example
+@end quotation
+
@section Compiling for distributions
@subsection Red Hat Linux
-Red Hat 7.0 i386 RPMS are available from
-@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
-You can also compile them yourself. A spec file is in
+You can compile RPMS yourself. For running on a Red Hat system you
+need these packages: guile, tetex, tetex-latex, tetex-dvips,
+libstdc++, python, ghostscript. A spec file is in
@file{make/out/lilypond.redhat.spec}. This file is distributed along
with the sources. You can make the rpm by issuing
@example
+ cp lilypond-x.y.z.tar.gz /usr/src/redhat/SOURCES/
tar xfz lilypond-x.y.z.tar.gz
rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec
rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
@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.
-
-
-
-@subsection LinuxPPC
-
-
-Some LinuxPPC RPMS should available from
-@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
-
-A LinuxPPC RPM can be made using the @file{lilypond.redhat.spec} file.
+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, mftrace,
+netpbm-progs, autotrace, t1utils.
@subsection SuSE
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, see the section on kpathsea
+
+
@subsection Mandrake
Some binaries are available at rpmfind.net. Refer to
itself.
-@subsubsection compiling on MacOS X
+@subsection 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
Bugs that are not fault of LilyPond are documented here.
-@unnumberedsubsec FLex-2.5.4a and gcc-3.0
+@subsection Linking to kpathsea
+
+If kpathsea and the corresponding header files are installed in some
+directory where GCC does not search by default, for example in
+@file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
+you have to explicitly tell configure where to find it. To do this,
+
+@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
+Once configure has found them, the paths are stored in
+@file{config.make} and will be used even if you don't have the
+environment variables set during make.
+
+
+@unnumberedsubsec Gcc-3.0.4
+
+Gcc 3.0.4, is a bit flaky. Try downgrading to 2.95.x, or if you're
+adventurous (see below), upgrading to 3.1.x.
+
+@unnumberedsubsec Flex-2.5.4a and gcc-3.x
Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
LilyPond with gcc-3.0 you may do:
Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
+@unnumberedsubsec Flex-2.5.4a and gcc-3.1.x
+
+Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
+LilyPond with gcc-3.1.1 you may do:
+
+@example
+ CONF=gcc-3.1 ./lexer-gcc-3.1.sh
+ CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
+ ./configure --enable-config=gcc-3.1
+ CONF=gcc-3.1 ./lexer-gcc-3.1.sh
+ make conf=gcc-3.1
+@end example
+
+This assumes that the GCC 3.1 binaries are called gcc-3.1 and g++-3.1.
+Note that this is @strong{not} fixed in Debian/unstable for flex <=
+2.5.4a-26.
+
@unnumberedsubsec Linux-2.4.0, Guile-1.4 --with-threads
There's a bug in certain kernels around version 2.4.0, that is
guile-1.4$ ./configure --without-threads; make all install
@end example
+@unnumberedsubsec OpenBSD
+
+@itemize @bullet
+@item By default, gcc on OpenBSD doesn't include
+@file{/usr/local/include} and @file{/usr/local/lib} in the system
+paths. Depending upon where/how you installed kpathsea and other
+libraries, you may need to refer to the section ``Linking to
+kpathsea''.
+
+@end itemize
@unnumberedsubsec NetBSD
@end itemize
-@unnumberedsubsec Solaris:
+@unnumberedsubsec Solaris
@itemize @bullet
+@item Solaris7, ./configure
+
+@file{./configure} needs a POSIX compliant shell. On Solaris7,
+@file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
+is. Please run configure like:
+@example
+ CONFIG_SHELL=/bin/ksh ksh -c ./configure
+@end example
+or
+@example
+ CONFIG_SHELL=/bin/bash bash -c ./configure
+@end example
+
@item Sparc64/Solaris 2.6, GNU make-3.77
GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
projects / lilypond.git / blobdiff