@chapter INSTALL - compiling and installing GNU LilyPond
-
-@section Abstract
-
-This document explains what you need to install LilyPond, and what you
-should do. If you are going to compile and install LilyPond often,
-e.g. when doing development, you might want to check out the
-@file{buildscripts/set-lily.sh} script. It sets some environment
-variables and symlinks, which comes in handy when you have to compile
-LilyPond more often.
-
@section Obtaining
You can get the latest version of LilyPond at
@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,
ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.
+There are three options for downloading sources.
+
+@itemize
+@item if you don't have any version, then you can download
+ the entire @file{.tar.gz} file.
+
+@item if you have an unpacked source tree of a previous version, you
+may use the diffs .
+
@emph{If you upgrade by patching do remember to rerun autoconf after
applying the patch}.
-If you do not want to download the entire archive for each version, the
-safest method for upgrading is to use @file{xdelta}, see
-@uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/}.
-The following command produces @file{lilypond-1.1.55.tar.gz} from
-@file{lilypond-1.1.54} identical (up to compression dates) to the .55 on
-the FTP site.
+@item if you have the @code{.tar.gz} file of a previous release, you can
+use
+@uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/, xdelta}.
+ This is much safer than using normal diffs, and is the recommended way.
+
+The following command produces @file{lilypond-1.3.122.tar.gz} from
+@file{lilypond-1.3.121} identical (up to compression dates) to the .122
+on the FTP site.
@example
- xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
+ xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz
@end example
+@end itemize
-@section Prerequisites
+@section Build requirements
-For compilation you need:
+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
+@uref{http://appel.lilypond.org/lilypond/gnu-windows/, Jan's windows
+page}.
-@itemize @bullet
-@item A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
- (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
-Solaris.
+You need the following packages to compile Lilypond.
-@item Lots of disk space: LilyPond takes between 30 and 100 mb to
-compile if you use debugging information. If you are short on
-disk-space run configure with @code{--disable-debugging}.
+@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
-Although we recommend to use Unix, LilyPond is known to run on Windows
-NT/95/98 as well. See Section Windows NT/95,es.
+@item Python 1.5,
+Check out @uref{http://www.python.org, the python website}.
-@item EGCS 1.1 or newer. Check out @uref{ftp://ftp.gnu.org/pub/gcc/}.
+@item GUILE 1.3.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 Python 1.5,
+@item GNU Make.
Check out
-@uref{ftp://ftp.python.org} or @uref{ftp://ftp.cwi.nl/pub/python}.
+@uref{ftp://ftp.gnu.org/gnu/make/, the GNU
+make FTP directory}.
-@item GUILE 1.3.4, check out @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
+@item Flex (version 2.5.4a or newer).
+Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
-@item GNU make.
-Check out @uref{ftp://ftp.gnu.org/make/,ftp://ftp.gnu.org/make/}.
+@item Bison (version 1.25 or newer).
+Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
-@item Flex (version 2.5.4 or newer).
-Check out @uref{ftp://ftp.gnu.org/flex/,ftp://ftp.gnu.org/flex/}.
+@item TeX.
-@item Bison (version 1.25 or newer).
-Check out @uref{ftp://ftp.gnu.org/bison/,ftp://ftp.gnu.org/bison/}.
+If you want LilyPond to use kpathsea support (recommended), 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).
-Check out @uref{ftp://ftp.gnu.org/pub/texinfo/,ftp://ftp.gnu.org/pub/texinfo/}.
-Most documentation is in texinfo.
+@item Texinfo (version 4.0 or newer).
+The documentation of lily is written in texinfo. Check out
+@uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}.
@item The geometry package for LaTeX is needed to use ly2dvi.
-Available at
-@uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
-or at mirror site @uref{ftp://ftp.dante.de,ftp://ftp.dante.de}
+It is available at
+@uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,the
+FTP directory for @code{geometry}}. This package is normally included
+with the @TeX{} distribution.
@item MetaPost, needed for generating PostScript fonts. Please
-note that tetex-0.4pl8 (included with Redhat 5.x) does not include
+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 do not want to use PostScript output, edit @file{mf/GNUmakefile}.
+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=}.
+@item kpathsea, a library for searching (TeX) files. @code{kpathsea} is
+usually included with your installation of TeX.
@end itemize
-@section Running
+@section Running requirements
GNU LilyPond does use a lot of resources. For operation you need the
following software
@itemize @bullet
-@item TeX
-@item A PostScript printer and/or viewer (such as Ghostscript) is strongly
- recommended. Xdvi will show all embedded PostScript too if you have
- Ghostscript installed.
-@item GUILE 1.3.4, check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/software/guile/}
+@item TeX.
+@item Xdvi and ghostscript
+@item GUILE 1.3.4, or newer. Check out
+@uref{http://www.gnu.org/software/guile.html,the GUILE webpage}
@end itemize
-For running LilyPond successfully you have to help TeX and MetaFont
-find various files. The recommended way of doing so is adjusting the
-environment variables in the start-up scripts of your shell. An
-example is given here for the Bourne shell:
-@example
-export MFINPUTS="/usr/local/share/lilypond/mf:"
-export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
-
-@end example
-
-The empty path component
-represents TeX and MetaFont's default search paths. Scripts with
-the proper paths for the bourne and C-shell respectively are generated in
+For running LilyPond successfully you have to help TeX and MetaFont find
+various files. The recommended way of doing so is adjusting the
+environment variables in the start-up scripts of your shell. Appropriate
+Csh and bourne sh scripts are left in
@file{buildscripts/out/lilypond-profile} and
-@file{buildscripts/out/lilypond-login} during compilation.
+@file{buildscripts/out/lilypond-login} after compilation.
-LilyPond is a hiddeously big, slow and bloated program. A fast CPU
-and plenty of RAM is recommended for comfortable use.
+LilyPond is a big and slow program. A fast CPU and plenty of RAM is
+recommended for comfortable use.
-@section Website
+@section Website requirements
-The website is the most convenient form to use for reading the
-documentation on-line documentation. It is made by entering @example
+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
+@example
- make htmldoc
+ make web-doc
@end example
-This does require a functioning LilyPond. The binary doesn't have to
-be installed.
-If you want to auto-generate Lily's website, you'll need some additional
-conversion tools.
+Building the website requires some additional tools:
@itemize @bullet
-@item xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
- users: it is included within the package libgr-progs).
- the original is at
-@uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz}
+@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, which is also in libgr-progs for RedHat. The original is
+@item pnmtopng. The original is
at
-@uref{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz,ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz}.i
-
-The version of @file{pnmtopng} that is distributed with RedHat 5.1 and
-5.2 contains a bug: pnmtopng is dynamically linked to the wrong
-version of libpng, which results in cropped images. Recompile it from
-source, and make sure that the pnmtopng binary is linked statically to
-the libpng that is included in libgr. RedHat 6.0 does not have this
-problem.
-
-@example
- tar xzf libgr-2.0.13.tar.gz
- make
- cd png
- rm libpng.so*
- make pnmtopng
-
-@end example
-
-You can then install the new pnmtopng into @file{/usr/local/bin/}
-
-@item @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html,Bib2html}.
- Which, in turn depends on man2html for proper installation.
+@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 this utility, but you will not see our
-hypertextified bibliography.
+The website will build without bib converter utility, but you will not
+see our hypertextified bibliography.
-@item @uref{http://www.zib.de/Visual/software/doc++/index.html,DOC++}
- A documentation system for C++ sources, which is used for the
- LilyPond sources.
@end itemize
@section Configuring and compiling
-to install GNU LilyPond, simply type:
+to install GNU LilyPond, type:
@example
-
gunzip -c lilypond-x.y.z | tar xf -
cd lilypond-x.y.z
- ./configure # fill in your standard prefix with --prefix
+ ./configure # run with --help to see appropriate options
make
make install
-
-@end example
-
-This will install a number of files, something close to:
-
-@example
- /usr/local/man/man1/mi2mu.1
- /usr/local/man/man1/convert-mudela.1
- /usr/local/man/man1/mudela-book.1
- /usr/local/man/man1/lilypond.1
- /usr/local/bin/lilypond
- /usr/local/bin/mi2mu
- /usr/local/bin/convert-mudela
- /usr/local/bin/mudela-book
- /usr/local/bin/abc2ly
- /usr/local/share/lilypond/*
- /usr/local/share/locale/@{it,nl@}/LC_MESSAGES/lilypond.mo
+ sh buildscripts/clean-fonts.sh
@end example
+If you are doing an upgrade, you should remove all @file{feta}
+@code{.pk} and @file{.tfm} files. A script has been provided to do the
+work for you, see @file{buildscripts/clean-fonts.sh}.
-The above assumes that you are root and have the GNU development
-tools, and your make is GNU make. If this is not the case, you can
-adjust your environment variables to your taste:
-
-@example
-
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- ./configure
-
-@end example
-
-@code{CPPFLAGS} are the preprocessor flags.
-
-The configure script is Cygnus configure, and it will accept
-@code{--help}. If you are not root, you will probably have to make it
-with a different @code{--prefix} option. Our favourite location is
+If you are not root, you should choose a @code{--prefix} argument that
+points into your home directory, eg.
@example
./configure --prefix=$HOME/usr
@end example
-In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
-
-Since GNU LilyPond currently is beta, you are advised to also use
-
-@example
-
- --enable-debugging
- --enable-checking
-
-@end example
-
-Options to configure include:
-
-@table @samp
-@item @code{--enable-printing}
- Enable debugging print routines (lilypond @code{-D} option)
-@item @code{--enable-optimise}
- Set maximum optimisation: compile with @code{-O2}. This can be
-unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
-@item @code{--enable-profiling}
- Compile with support for profiling.
-@item @code{--enable-config}
- Output to a different configuration file. Needed for multi-platform
- builds
-@end table
+In this case, you have to insert the contents of
+@code{buildscripts/out/lilypond-login} or
+@code{buildscripts/out/lilypond-profile} into your start up scripts by
+hand.
-All options are documented in the @file{configure} help
-The option @code{--enable-optimise} is recommended for Real Life usage.
-If you do
-
-@example
-
- make all
-
-@end example
-
-everything will be compiled, but nothing will be installed. The
-resulting binaries can be found in the subdirectories @file{out/} (which
-contain all files generated during compilation).
@section Configuring for multiple platforms
-If you want to compile LilyPond with different configuration settings,
-then, you can use the @code{--enable-config} option. Example: suppose I
-want to build with and without profiling. Then I'd use the
-following for the normal build,
-
+If you want to build multiple versions of LilyPond with different
+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,
@example
- ./configure --prefix=~ --disable-optimise --enable-checking
+ ./configure --prefix=~ --enable-checking
make
make install
-
@end example
and for the profiling version, I specify a different configuration.
@example
- ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
- make config=optprof
- make config=optprof install
-
+ ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
+ make conf=prof
+ make conf=prof install
+
@end example
-@section Installing
-if you have done a successful @code{make}, then a simple
-@example
- make install
-
-@end example
-should do the trick.
-If you are doing an upgrade, please remember to remove obsolete
-@file{.pk} and @file{.tfm} files of the fonts. A script has been
-provided to do the work for you, see @file{bin/clean-fonts.sh}.
+@section Emacs mode
+
+An emacs mode for LilyPond is included with the source archive as
+@file{lilypond-mode.el} and @file{lilypond-font-lock.el}. If you have
+an RPM, it is in @file{/usr/share/doc/lilypond-X/}. You have to install
+it yourself.
+
+Add this to your ~/.emacs or ~/.emacs.el:
+@example
+ (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)))
+@end example
+
+If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode is
+automatically loaded, so you need not modify your @code{~/.emacs} file.
-@section Redhat linux
+@section Red Hat Linux
-RedHat Linux users can compile an RPM. A spec file is in
-@file{make/out/lilypond.spec}, it is distributed along with the
-sources.
+Red Hat 7.0 i386 RPMS are available from
+@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/}.
-You can make the rpm by issuing
+You can also compile them yourself. A spec file is in
+@file{make/out/lilypond.spec}. This file is distributed along with the
+sources. You can make the rpm by issuing
@example
rpm -tb lilypond-x.y.z.tar.gz
@end example
-Precompiled i386 RedHat RPMS are available from
-@uref{ftp://freshmeat.net/pub/rpms/lilypond/,ftp://freshmeat.net/pub/rpms/lilypond/} and
-@uref{http://linux.umbc.edu/software/lilypond/rpms/,http://linux.umbc.edu/software/lilypond/rpms/}.
+For running on a Red Hat system you need these packages: guile, tetex,
+tetex-dvips, libstdc++, python, ghostscript.
-For compilation on a RedHat system you need these packages,
-in addition to the those needed for running:
-@itemize @bullet
-@item glibc-devel
-@item libstdc++-devel
-@item guile-devel
-@item flex
-@item bison
-@item texinfo
-@end itemize
+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.
-@section Debian GNU/linux
+@section SuSE
-A Debian package is also available; see
-@uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
-or contact Anthony Fok @email{foka@@debian.org} for more information.
-The build scripts are in the subdirectory @file{debian/}.
+[TODO: document this]
-@section Windows NT/95
+Install @code{tetex}, @code{te_mpost}, @code{te_kpath}.
-Separate instructions on building for W32 are available; See the files
-in @file{Documentation/ntweb/}, included with the sources.
-
-@section Problems
-For help and questions use @email{help-gnu-music@@gnu.org} and
-@email{gnu-music-discuss@@gnu.org}. Please consult the faq before
-mailing your problems.
+@section Mandrake
-If you find bugs, please send bug reports to
-@email{bug-gnu-music@@gnu.org}.
+[TODO]
-Known bugs that are LilyPond's fault are listed in @file{TODO}, or
-demonstrated in @file{input/bugs/}.
+@section Debian GNU/Linux
-Known bugs that are not LilyPond's fault are documented here.
+A Debian package is also available. You may install it easily by using
+apt-get as root:
+@example
+ apt-get install lilypond1.3
+@end example
-@unnumbered LinuxPPC Bugs:
+Alternatively, visit
@itemize @bullet
-@item egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
-fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
-
-@item egcs-1.0.2 (LinuxPPC R4):
-all compiling with @code{-O2} is suspect, in particular guile-1.3, and
-Lily herself will break.
+@item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
+@item @uref{http://ftp.debian.org/debian/pool/main/l/lilypond1.3/,http://ftp.debian.org/debian/pool/main/l/lilypond1.3/}
+for latest package uploaded to Debian unstable;
+@item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
+for latest semi-unofficial build of LilyPond 1.3.121 for Debian 2.2r2 (potato) users.
+The official stable Debian 2.2r2 is stuck with the old LilyPond-1.3.24.
@end itemize
+You may contact Anthony Fok @email{foka@@debian.org} for more information.
+The build scripts are in the subdirectory @file{debian/}; you can
+make the .deb by doing, for example:
-@unnumbered Linux-i386
-
-@itemize @bullet
-@item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
+@example
+ $ su - root
+ # dpkg --purge lilypond lilypond1.3
+ # exit
+ $ tar xzf lilypond-1.3.122.tar.gz
+ $ cd lilypond-1.3.122
+ $ dch -p -v 1.3.122-0.local.1 "Local build."
+ $ debuild
+ $ su - root
+ # dpkg -i ../lilypond1.3_1.3.122*.deb
+ # exit
+ $
+@end example
-Lily will crash during parsing (which suggests a C++ library
-incompatibility). Precise cause, precise platform description or
-solution are not known.
+For compilation on a Debian GNU/Linux system you need these packages,
+in addition to the those needed for running:
-Note that this only happens on some computers with the said platform.
+@itemize @bullet
+@item g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
+@item libguile<your-libguile-version-here>-dev
+@item make, m4, flex, bison
+@item gettext
+@item groff, texinfo, bibtex2html (not in 2.2r2)
+@item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
+@item dpkg-dev, debhelper, fakeroot
+@item gs, netpbm, pnmtopng
+@end itemize
-@item libg++ 2.7
+Most of these are listed on the Build-Depends line in the
+debian/control file. To ensure the creation of the lilypond deb is
+trouble-free, we recommend that you first install the following packages
+before starting dpkg-buildpackage by running apt-get as root.
-LilyPond occasionally crashes while parsing the initialisation files.
-This is a very obscure bug, and usually entering the commandline
-differently "fixes" it.
+For Debian 2.2 (or 2.2r2, 2.2r3):
@example
- lilypond input.ly
-@end example
+ apt-get install task-debian-devel task-c++-dev \
+ python-base libguile6-dev tetex-bin tetex-dev \
+ tetex-extra flex bison texinfo groff gs \
+ netpbm pnmtopng m4 gettext
+@end example
+
+For Debian in development ("unstable", the future 2.3 or 3.0):
-and
@example
- lilypond -I. ./input.ly
+ apt-get install task-debian-devel task-c++-dev \
+ python-base libguile9-dev tetex-bin libkpathsea-dev \
+ tetex-extra flex bison texinfo bibtex2html groff gs \
+ netpbm pnmtopng m4 gettext
@end example
-makes a difference
-Typical stacktrace:
+And, just so that old fonts from previous versions of LilyPond won't
+interfere with your build, you may want to do this before the build too:
+
@example
- SIGSEGV
- __libc_malloc (bytes=16384)
- ?? ()
- yyFlexLexer::yy_create_buffer ()
- Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
+ dpkg --purge lilypond lilypond1.3
@end example
-This behaviour has been observed with machines that have old libg++
-versions (LinuxPPC feb '98, RedHat 4.x).
-@end itemize
+@section Problems
+
+For help and questions use @email{help-gnu-music@@gnu.org} and
+@email{gnu-music-discuss@@gnu.org}. Please consult the faq before
+mailing your problems. If you find bugs, please send bug reports to
+@email{bug-gnu-music@@gnu.org}.
+
+Bugs that are not fault of LilyPond are documented here.
@unnumbered Solaris:
@quotation
Some versions of the AIX binder (linker) can fail with a relocation
overflow severe error when the -bbigtoc option is used to link
- GCC-produced object files into an executable that overflows the TOC. A
- fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
+ GCC-produced object files into an executable that overflows the TOC.
+ A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
-BBIGTOC) is available from IBM Customer Support and from its
27service.boulder.ibm.com website as PTF U455193.
projects / lilypond.git / blobdiff