X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Ftopdocs%2FINSTALL.texi;h=df2bc044d089d335ab5f700c8c2e101d272e76e3;hb=36079063504b59027cdd84e36a1fc9e2bfc4fc76;hp=c2884623cc06774cb4e8b333abd03e811d85f33e;hpb=d1965f31e75a5e1e9faeb995ef2d37ce5fb3ff85;p=lilypond.git
diff --git a/Documentation/topdocs/INSTALL.texi b/Documentation/topdocs/INSTALL.texi
index c2884623cc..df2bc044d0 100644
--- a/Documentation/topdocs/INSTALL.texi
+++ b/Documentation/topdocs/INSTALL.texi
@@ -1,458 +1,692 @@
-\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
+@html
+
+@end html
+
@node Top, , , (dir)
@top
+@contents
+
@chapter INSTALL - compiling and installing GNU LilyPond
-@section Abstract
+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}.
-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 handly when you have to compile
-LilyPond more often.
-@section Obtaining
+@html
+
+@end html
-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/}.
+@section Downloading
+Even numbered versions are `stable'. The webpages for the stable version
+(1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
+servers}. Big enhancements go into the latest odd numbered version
+(1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
+site}.
-@emph{If you upgrade by patching do remember to rerun autoconf after
-applying the patch}.
+@subsection Source code
+
+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.
+@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
-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/}.
+Short version:
-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.
+@quotation
@example
- xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
+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
+
+@end html
+
+
-@section Prerequisites
+@subsection Precompiled binaries
-For compilation you need:
+If you want to track bleeding edge development, try:
@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.
+@item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian
+GNU/Linux} usually has the latest binaries for the most useful stable
+and development versions, while
+@item @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/,
+Mandrake Cooker} also provides fairly recent versions.
+@end itemize
-@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}.
+Binaries are made available for other popular platforms, but as we need
+to compile them ourselves, they are not updated for every version
+released.
+@itemize @bullet
+@item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, 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}
@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.
+@uref{http://www.lilypond.org/gnu-windows/, Windows}
+@end itemize
+
+@subsection Upgrading
+
+There are two options for upgrading sources.
-@item EGCS 1.1 or newer. Check out @uref{ftp://ftp.gnu.org/pub/gcc/}.
+@itemize
+@item if you have an unpacked source tree of a previous version, you
+may the patches.
+
+@emph{If you upgrade by patching do remember to rerun autoconf after
+applying the patch}.
+
+@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 patches, and is the recommended way.
+
+The following command produces @file{lilypond-1.4.3.tar.gz} from
+@file{lilypond-1.4.2.tar.gz} identical (up to compression dates) to the .3
+on the FTP site.
+@example
+ xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
+@end example
+@end itemize
+
+@section Requirements
+
+@subsection Compilation
+
+You need the following packages to compile Lilypond.
-@item Python 1.5,
+@itemize
+@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}.
+
+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 (version 1.4 or newer).
Check out
-@uref{ftp://ftp.python.org} or @uref{ftp://ftp.cwi.nl/pub/python}.
+@uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
-@item GUILE 1.3, check out @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
+@item GNU Make.
+Check out
+@uref{ftp://ftp.gnu.org/gnu/make/, the GNU
+make FTP directory}.
-@item GNU make.
-Check out @uref{ftp://ftp.gnu.org/make/,ftp://ftp.gnu.org/make/}.
+@item Flex (version 2.5.4a or newer).
+Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
-@item Flex (version 2.5.4 or newer).
-Check out @uref{ftp://ftp.gnu.org/flex/,ftp://ftp.gnu.org/flex/}.
+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{ftp://ftp.gnu.org/bison/,ftp://ftp.gnu.org/bison/}.
+Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
+
+@item @TeX{}.
-@item Texinfo. Check out @uref{ftp://ftp.gnu.org/pub/texinfo/,ftp://ftp.gnu.org/pub/texinfo/}.
-Most documentation is in texinfo.
+@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.
+
+@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 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 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. 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
+UNIX), you can compile LilyPond without kpathsea support. In that case,
+you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
+configure something like:
-@item MetaPost, if you want to use direct PostScript output. Please
-note that tetex-0.4pl8 (included with Redhat 5.x) does not include
-@file{mfplain.mp}, which is needed for producing the scaleable font files.
+@quotation
+@example
+./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
+@end example
+@end quotation
@end itemize
-@section Running
+@subsection 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, 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.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
+@subsection 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 website
+ make web-doc
@end example
-This does require a fully functioning
-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 pnmtopng, which is also in libgr-progs for RedHat. 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.
+@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
+to install GNU LilyPond, type:
@example
- tar xzf libgr-2.0.13.tar.gz
- make
- cd png
- rm libpng.so*
- make pnmtopng
-
+ gunzip -c lilypond-x.y.z | tar xf -
+ cd lilypond-x.y.z
+ ./configure # run with --help to see appropriate options
+ make
+ make install
+ sh buildscripts/clean-fonts.sh
@end example
-You can then install the new pnmtopng into @file{/usr/local/bin/}
+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}.
-@item Bib2html @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html.,http://pertsserver.cs.uiuc.edu/~hull/bib2html.}
- Which, 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.
+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 have to insert the contents of
+@code{buildscripts/out/lilypond-login} or
+@code{buildscripts/out/lilypond-profile} into your start up scripts by
+hand.
-@item Doc++ (optional) to read the source code.
-@end itemize
-@section Configuring and compiling
+@subsection Configuring for multiple platforms
-to install GNU LilyPond, simply type:
+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,
+@c prefix=~ ?
@example
- gunzip -c lilypond-x.y.z | tar xf -
- cd lilypond-x.y.z
- ./configure # fill in your standard prefix with --prefix
- make
- make install
-
+ ./configure --prefix=~ --enable-checking
+ make
+ make install
@end example
-This will install a number of files, something close to:
+and for the profiling version, I specify a different configuration.
@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
+
+ ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
+ make conf=prof
+ make conf=prof install
+
@end example
-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.
+@section Emacs mode
-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
+An Emacs mode for entering music and running LilyPond is included with
+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/}.
-@example
+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
- ./configure --prefix=$HOME/usr
-
-@end example
+ (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)))
+@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}
+file.
+
+@section Compiling for distributions
-In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
+@subsection Red Hat Linux
-Since GNU LilyPond currently is beta, you are advised to also use
+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
+with the sources. You can make the rpm by issuing
@example
- --enable-debugging
- --enable-checking
-
+ 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
-Options to configure include:
+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.
-@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
-All options are documented in the @file{configure} help
-The option @code{--enable-optimise} is recommended for Real Life usage.
-If you do
+@subsection LinuxPPC
-@example
- make all
-
-@end example
+Some LinuxPPC RPMS should available from
+@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
-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).
+A LinuxPPC RPM can be made using the @file{lilypond.redhat.spec} file.
-@section Configuring for multiple platforms
+@subsection SuSE
-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,
+Some SUSE RPMS should available from
+@uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE}.
-@example
+You can also compile a RPM for SUSE yourself. A spec file is in
+@file{make/out/lilypond.suse.spec}, see the instructions for building
+the Red Hat RPM.
- ./configure --prefix=~ --disable-optimise --enable-checking
- make
- make install
-
-@end example
+You must have the following packages: guile tcsh tetex te_latex te_kpath
+te_mpost libpng python gpp libgpp gettext autoconf253 netpbm libnetpb
+gs_serv gs_lib gs_fonts guile
-and for the profiling version, I specify a different configuration.
+@subsection Slackware
-@example
+No precompiled packages for Slackware are available.
- ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
- make config=optprof
- make config=optprof install
-
-@end example
+Problems have been reported with Slackware 7.0; apparently, it ships
+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
-@section Installing
-if you have done a successful @code{make}, then a simple
+@subsection Mandrake
-@example
+Some binaries are available at rpmfind.net. Refer to
+@uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/}.
- make install
-
-@end example
+You can also compile a RPM for Mandrake yourself. A spec file is in
+@file{make/out/lilypond.mandrake.spec}, see the instructions for building
+the Red Hat RPM.
+
+@subsection Debian GNU/Linux
+
+A Debian package is also available. You may install it easily by running
+@command{apt-get} as root:
+@example
-should do the trick.
+ apt-get install lilypond lilypond-doc
+@end example
-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}.
+You can also compile the .deb for Debian yourself, do:
+@example
+ apt-get -b source lilypond
+@end example
-@section Redhat linux
+If you're real impatient, you may even do:
+@example
-RedHat Linux users can compile an RPM. A spec file is in
-@file{make/out/lilypond.spec}, it is distributed along with the
-sources.
+ cd lilypond-x.y.z # a previous version
+ uscan # download and build latest directly from upstream
+@end example
-You can make the rpm by issuing
-@example
- rpm -tb lilypond-x.y.z.tar.gz
- rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+Debian's @TeX{} installation is a bit short on memory, you may want to
+increase it like this:
+@example
+--- 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 = 1000000 % extra high memory for chars, tokens, etc.
++extra_mem_bot = 1000000 % extra low memory for boxes, glue, breakpoints, etc.
-@end example
+ 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
-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/}.
+You could also export @env{extra_mem_top} and @env{extra_mem_bot} as
+environment variables if you do not want to or cannot modify
+@file{/etc/texmf/texmf.cnf}.
+
+Alternatively, visit
-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
+@item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
+@item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
+for latest semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato) users.
+The official stable Debian 2.2 is stuck with the old LilyPond-1.3.24.
+Since LilyPond-1.4 has been released, the older lilypond1.3 Debian
+package is now obsolete.
@end itemize
-@section Debian GNU/linux
+Please contact Anthony Fok @email{lilypond@@packages.debian.org} for more
+information.
-A Debian package is also available; contact Anthony Fok
-@email{foka@@debian.org}. The build scripts are in the subdirectory
-@file{debian/}.
+The build scripts are in the subdirectory @file{debian/}; you can
+make the .deb by doing, for example:
-@section Windows NT/95
+@example
+ $ su - root
+ # dpkg --purge lilypond lilypond1.3
+ # exit
+ $ tar xzf lilypond-1.4.3.tar.gz
+ $ cd lilypond-1.4.3
+ $ dch -p -v 1.4.3-0.local.1 "Local build."
+ $ debuild -B
+ $ su - root
+ # dpkg -i ../lilypond_1.4.3*.deb
+ # exit
+ $
+@end example
-Separate instructions on building for W32 are available; See the files
-in @file{Documentation/ntweb/}, included with the sources.
+Use command @command{debuild} instead of @command{debuild -B} if you have
+a very fast machine and want to build the HTML, PS and DVI documentation
+too.
-@section Problems
+For compilation on a Debian GNU/Linux system you need these packages,
+in addition to the those needed for running:
-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.
+@itemize @bullet
+@item g++, cpp, libc6-dev, libstdc++<@var{your-libstdc++-version-here}>-dev
+@item libguile<@var{your-libguile-version-here}>-dev
+@item make, m4, flex, bison
+@item gettext
+@item groff, texinfo
+@item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
+@item dpkg-dev, debhelper, fakeroot
+@item gs, netpbm
+@item pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
+ in Debian testing/unstable.)
+@end itemize
-If you find bugs, please send bug reports to
-@email{bug-gnu-music@@gnu.org}.
+Most of these are listed on the @samp{Build-Depends} line in the
+@file{debian/control} file. To ensure the creation of the lilypond deb is
+trouble-free, we recommend that you first install the following packages
+by running \@command{apt-get} as root before building the package:
-Known bugs that are LilyPond's fault are listed in @file{TODO}, or
-demonstrated in @file{input/bugs/}.
+For Debian 2.2:
-Known bugs that are not LilyPond's fault are documented here.
+@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
-@unnumbered All platforms
-@itemize
-@item Guile 1.3.2 is buggy in several respects. Do not use it for LilyPond.
-@end itemize
+For Debian in development ("unstable", the future 2.3 or 3.0):
-@unnumbered LinuxPPC Bugs:
+@example
+ 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 groff gs \
+ netpbm m4 gettext
+@end example
-@itemize
-@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/}
+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
+ dpkg --purge lilypond lilypond1.3
+@end example
-@item egcs-1.0.2 (LinuxPPC R4):
-all compiling with @code{-O2} is suspect, in particular guile-1.3, and
-Lily herself will break.
+@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.
-@unnumbered Linux-i386
-@itemize
-@item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
+@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
-Lily will crash during parsing (which suggests a C++ library
-incompatibility). Precise cause, precise platform description or
-solution are not known.
+using:
-Note that this only happens on some computers with the said platform.
+@example
+ Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release)
+@end example
-@item GUILE
-A binary RPM of Guile 1.3 has been distributed from the LilyPond ftp
-site. This binary was made in RedHat 5.x, and it will fail if this
-RPM is used with RedHat 6.x.
+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
-@item libg++ 2.7
+For more information about @file{apt-get} and @file{fink}, see
+@uref{http://fink.sf.net,fink.sourceforge.net}.
-LilyPond occasionally crashes while parsing the initialisation files.
-This is a very obscure bug, and usually entering the commandline
-differently "fixes" it.
+@c brokenness of autoconf; don't ask
+Then, configure, patch, make and install LilyPond using these commands:
@example
- lilypond input.ly
-@end 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
+
+For help and questions use @email{lilypond-user@@gnu.org}. Please
+consult the FAQ before mailing your problems. If you find bugs, please
+send bug reports to @email{bug-lilypond@@gnu.org}.
+
+Bugs that are not fault of LilyPond are documented here.
+
+@unnumberedsubsec FLex-2.5.4a and gcc-3.0
+
+Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
+LilyPond with gcc-3.0 you may do:
-and
@example
- lilypond -I. ./input.ly
+ CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
+ make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
+ patch -p1 < lexer-gcc-3.0.patch
+ make conf=gcc-3.0 -C lily
@end example
-makes a difference
-Typical stacktrace:
+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
+triggered when using Guile 1.4 compiled with pthreads. You'll see
+random segmentation fault crashes of LilyPond. Upgrade to a newer
+version of Linux. If you can't do that, you may try to recompiling
+Guile without threads (YMMV):
+
@example
- SIGSEGV
- __libc_malloc (bytes=16384)
- ?? ()
- yyFlexLexer::yy_create_buffer ()
- Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
+ guile-1.4$ ./configure --without-threads; make all install
@end example
-This behaviour has been observed with machines that have old libg++
-versions (LinuxPPC feb '98, RedHat 4.x).
-@end itemize
+@unnumberedsubsec NetBSD
+
+@itemize @bullet
+@item The flex precompiled in NetBSD-1.4.2 is broken.
+Download flex-2.5.4a, build, install.
+
+@item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
+release)) does not include @file{/usr/pkg} paths. Configure using:
+@example
+CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
+@end example
-@unnumbered Solaris:
+@end itemize
-@itemize
+@unnumberedsubsec Solaris:
+
+@itemize @bullet
@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.
-
@item Sparc64/Solaris 2.6, ld
Not yet resolved.
@end itemize
-@unnumbered AIX
+@unnumberedsubsec AIX
-@itemize
+@itemize @bullet
@item AIX 4.3 ld
The following is from the gcc install/SPECIFIC file.
@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.