+INSTALL - compiling and installing GNU LilyPond
+***********************************************
-INSTALL(1) LilyPond documentation INSTALL(1)
+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
+`buildscripts/set-lily.sh' script. It sets some environment variables
+and symlinks, which comes in handly when you have to compile LilyPond
+more often.
-NAME
- INSTALL - installing GNU LilyPond
+Obtaining
+=========
-DESCRIPTION
- This page documents installation and compilation of GNU
- LilyPond
+ You can get the latest version of LilyPond at
+ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
+(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/). Refer to the links document
+for mirror sites.
-ABSTRACT
- You do something which looks remotely like
+ _If you upgrade by patching do remember to rerun autoconf after
+applying the patch_.
- configure
- make
- make install
+ If you do not want to download the entire archive for each version,
+the safest method for upgrading is to use `xdelta', see
+`ftp://ftp.xcf.berkeley.edu/pub/xdelta/'
- The detailed instructions follow here.
+ The following command produces `lilypond-1.1.55.tar.gz' from
+`lilypond-1.1.54' identical (up to compression dates) to the .55 on the
+FTP site.
+ xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
-PREREQUISITES
- For compilation you need.
+Prerequisites
+=============
- o A GNU system: GNU LilyPond is known to run on these
- GNU systems: Linux (PPC, intel), FreeBSD, AIX,
- NeXTStep, IRIX, Digital Unix and Solaris.
+ For compilation you need:
- If you have the Cygnus WINDOWS32 port of the GNU
- utils, it will even work in Windows NT/95, but we
- don't promise to support it.
+ * A GNU system: GNU LilyPond is known to run on these GNU systems:
+ Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
+ and Solaris.
- o GNU C++ v2.7 or better.
+ * 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 `--disable-debugging'.
- o GNU make.
+ * Although we recommend to use Unix, LilyPond is known to run on
+ Windows NT/95/98 as well. See Section Windows NT/95,es.
- o Flex (2.5.1 or better).
+ * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
- o Bison. (Version 1.25 or better)
+ * Python 1.5, Check out `ftp://ftp.python.org' or
+ `ftp://ftp.cwi.nl/pub/python'.
-RUNNING
- GNU LilyPond does use a lot of resources. For operation
- you need the following:
+ * GUILE 1.3, check out http://www.gnu.org/software/guile/guile.html
+ (http://www.gnu.org/software/guile/guile.html).
- o TeX
+ * GNU make. Check out ftp://ftp.gnu.org/make/
+ (ftp://ftp.gnu.org/make/).
- o A PostScript printer and/or viewer (such as
- Ghostscript) is strongly recommended. Xdvi will show
- all embedded PostScript too if you have Ghostscript
- installed.
+ * Flex (version 2.5.4 or newer). Check out ftp://ftp.gnu.org/flex/
+ (ftp://ftp.gnu.org/flex/).
-RECOMMENDED
- Although not strictly necessary, these are recommended to
- have.
+ * Bison (version 1.25 or newer). Check out ftp://ftp.gnu.org/bison/
+ (ftp://ftp.gnu.org/bison/).
- o Perl-5. Most documentation was created with the
- perl's Plain Old Documentation. (I use 5.003)
+ * Texinfo. Check out ftp://ftp.gnu.org/pub/texinfo/
+ (ftp://ftp.gnu.org/pub/texinfo/). Most documentation is in
+ texinfo.
+ * The geometry package for LaTeX is needed to use ly2dvi. Available
+ at
+ 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 ftp://ftp.dante.de (ftp://ftp.dante.de)
+ * MetaPost, if you want to use direct PostScript output. Please note
+ that tetex-0.4pl8 (included with Redhat 5.x) does not include
+ `mfplain.mp', which is needed for producing the scaleable font
+ files.
+Running
+=======
-11/Mar/98 LilyPond 0.1.48 1
+ GNU LilyPond does use a lot of resources. For operation you need the
+following software
+ * TeX
+ * A PostScript printer and/or viewer (such as Ghostscript) is
+ strongly recommended. Xdvi will show all embedded PostScript
+ too if you have Ghostscript installed.
+ * GUILE 1.3, check out http://www.gnu.org/programs/guile.html
+ (http://www.gnu.org/programs/guile.html)
+ 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:
+ export MFINPUTS="/usr/local/share/lilypond/mf:"
+ export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
-INSTALL(1) LilyPond documentation INSTALL(1)
+ 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 `buildscripts/out/lilypond-profile' and
+`buildscripts/out/lilypond-login' during compilation.
+ LilyPond is a hiddeously big, slow and bloated program. A fast CPU
+and plenty of RAM is recommended for comfortable use.
- o Python. Although perl is nice, python is better. We
- will shift towards python for build scripts
+Website
+=======
- o GNU find
+ The website is the most convenient form to use for reading the
+documentation on-line documentation. It is made by entering
- o A fast computer (a full page of music typically takes
- 1 minute on my 486/133, using the --enable-checking
- compile. It's lot slower than most MusiXTeX
- preprocessors)
+ make website
+ This does require a fully functioning
-CONFIGURING and COMPILING
- to install GNU LilyPond, simply type:
+ If you want to auto-generate Lily's website, you'll need some
+additional conversion tools.
- configure
- make install
+ * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
+ users: it is included within the package libgr-progs).
+ the original is at
+ ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
+ (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
- This will install the following files:
+ * pnmtopng, which is also in libgr-progs for RedHat. The original is
+ at
+ 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
- /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/lib/libflower.{so,a}
- /usr/local/bin/lilypond
- /usr/local/bin/mi2mu
- /usr/local/share/lilypond/*
- /usr/lib/texmf/texmf/tex/lilypond/*
+ The version of `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.
- The TeX include directory is detected dynamically, but it
- can be adjusted with --enable-tex-prefix and --enable-tex-
- dir. 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:
+ tar xzf libgr-2.0.13.tar.gz
+ make
+ cd png
+ rm libpng.so*
+ make pnmtopng
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- configure
+ You can then install the new pnmtopng into `/usr/local/bin/'
- CPPFLAGS are the preprocessor flags.
+ * Bib2html 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
+ 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 configure script is Cygnus configure, and it will
- accept --help. If you are not root, you will probably have
- to make it with
+ The website will build without this utility, but you will not see
+ our hypertextified bibliography.
- configure --prefix=/home/me_myself_and_I/
+ * Doc++ (optional) to read the source code.
- In this case, you will have to set MFINPUTS, and TEXINPUTS
- accordingly.
- If you want to install GNU LilyPond in /usr/local, and
- your TeX has no default hooks for local stuff (mine is
- broken too), you can do:
+configuring and compiling
+=========================
- configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
+ to install GNU LilyPond, simply type:
+ gunzip -c lilypond-x.y.z | tar xf -
+ cd lilypond-x.y.z
+ ./configure # fill in your standard prefix with --prefix
+ make
+ make install
+ This will install a number of files, something close to:
-11/Mar/98 LilyPond 0.1.48 2
+ /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
+ 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:
+ export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
+ ./configure
+ `CPPFLAGS' are the preprocessor flags.
-INSTALL(1) LilyPond documentation INSTALL(1)
+ The configure script is Cygnus configure, and it will accept
+`--help'. If you are not root, you will probably have to make it with a
+different `--prefix' option. Our favourite location is
- Since GNU LilyPond currently is beta, you are advised to
- also use
+ ./configure --prefix=$HOME/usr
- --enable-debugging
- --enable-checking
+ In this case, you will have to set up MFINPUTS, and TEXINPUTS
+accordingly.
- other options include:
+ Since GNU LilyPond currently is beta, you are advised to also use
- --enable-shared
- Make a shared library (gnu/linux, solaris (?) only )
- --enable-printing
- Enable debugging print routines (lilypond -d option)
+ --enable-debugging
+ --enable-checking
- --enable-optimise
- Set maximum optimisation: compile with -O2
+ Options to configure include:
- --enable-profiling
- Compile with support for profiling
+``--enable-printing''
+ Enable debugging print routines (lilypond `-D' option)
- --enable-tex-prefix
- Set the directory where TeX and Metafont live
+``--enable-optimise''
+ Set maximum optimisation: compile with `-O2'. This can be
+ unreliable on some compiler/platform combinations (eg, DEC Alpha
+ and PPC)
- --enable-tex-dir
- Set then directory TeX input is in (detected as a
- subdir of tex-prefix)
+``--enable-profiling''
+ Compile with support for profiling.
- --enable-mf-dir
- Set the directory mf input is in (idem)
+``--enable-config''
+ Output to a different configuration file. Needed for
+ multi-platform builds
- --enable-out-dir
- Set the directory for machine generated output.
+ All options are documented in the `configure' help The option
+`--enable-optimise' is recommended for Real Life usage.
- All options are documented in the configure help The
- option --enable-optimise is recommended for Real Life
- usage.
+ If you do
- If you do
- make all
+ make all
- everything will be compiled, but nothing will be
- installed. The resulting binaries can be found in the
- subdirectories out/ (which contain all files generated
- during compilation).
+ everything will be compiled, but nothing will be installed. The
+resulting binaries can be found in the subdirectories `out/' (which
+contain all files generated during compilation).
- Building for multiple hosts
+configuring for multiple platforms
+==================================
- LilyPond does not follow the GNU standards when it comes
- to configuring and making Makefiles. In LilyPond, make
- generates all output in output directories (called out/,
- by default). You can have multiple compiles from the same
- source-tree, by overriding the setting for the output
- directory.
+ If you want to compile LilyPond with different configuration
+settings, then, you can use the `--enable-config' option. Example:
+suppose I want to build with and without profiling. Then I'd use the
+following for the normal build,
+ ./configure --prefix=~ --disable-optimise --enable-checking
+ make
+ make install
-11/Mar/98 LilyPond 0.1.48 3
+ and for the profiling version, I specify a different configuration.
+ ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
+ make config=optprof
+ make config=optprof install
+Installing
+==========
+ if you have done a successful `make', then a simple
-INSTALL(1) LilyPond documentation INSTALL(1)
+ make install
- Example: on my system, I do debugging and lots compiling.
- For this I use the configuration as follows:
+ should do the trick.
- configure --prefix=~ --enable-debugging --enable-printing --enable-checking
- make all
+ If you are doing an upgrade, please remember to remove obsolete
+`.pk' and `.tfm' files of the fonts. A script has been provided to do
+the work for you, see `bin/clean-fonts.sh'.
- and I want to do profiling. For that I use
+Redhat linux
+============
- configure --prefix=~ --enable-debugging --disable-printing\
- --disable-checking --enable-profiling --enable-optimise\
- --enable-out-dir=out-profile
+ RedHat Linux users can compile an RPM. A spec file is in
+`make/out/lilypond.spec', it is distributed along with the sources.
- make OUTDIR_NAME=out-profile all
+ You can make the rpm by issuing
- These two commands build two entirely separate versions of
- LilyPond. In Real Life, you would probably also want to
- have two different prefixes. On my machine this is no
- problem; I never do make install. My prefix dirs are
- linked back to my source directory.
+ rpm -tb lilypond-x.y.z.tar.gz
+ rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
-INSTALLING
- If you have done a successful make, then a simple
+ Precompiled i386 RedHat RPMS are available from
+ftp://freshmeat.net/pub/rpms/lilypond/
+(ftp://freshmeat.net/pub/rpms/lilypond/) and
+http://linux.umbc.edu/software/lilypond/rpms/
+(http://linux.umbc.edu/software/lilypond/rpms/).
- make install
+ For compilation on a RedHat system you need these packages, in
+addition to the those needed for running:
+ * glibc-devel
- should do the trick.
+ * libstdc++-devel
- If you are doing an upgrade, please remember to remove
- obsolete .pk and .tfm files of the fonts. A script has
- been provided to do the work, see bin/clean-fonts.sh.
+ * guile-devel
-CAVEATS
- o The -O2 option to gcc triggers a gcc bug on DEC Alpha
- in dstream.cc. You should turn off this flag for this
- file.
+ * flex
- o Perl5.003 and Perl5.004 use different syntax for
- pod2html.
+ * bison
-EXAMPLE
- This is what I type in my xterm:
+ * texinfo
- lilypond someinput.ly
- tex someinput.tex
- xdvi someinput&
+Debian GNU/linux
+================
- This is what the output looks like over here:
+ A Debian package is also available; contact Anthony Fok
+<foka@debian.org>. The build scripts are in the subdirectory `debian/'.
+Windows NT/95
+=============
+ Separate instructions on building for W32 are available; See file
+README-W32, included with the sources.
+Problems
+========
+ For help and questions use <help-gnu-music@gnu.org> and
+<gnu-music-discuss@gnu.org>. Please consult the faq before mailing
+your problems.
+ If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
+ Known bugs that are LilyPond's fault are listed in `TODO', or
+demonstrated in `input/bugs/'.
+ Known bugs that are not LilyPond's fault are documented here.
+All platforms
+*************
+*GUILE 1.3.2
+ Guile 1.3.2 is buggy in several respects. Do not use it for
+ LilyPond.
-11/Mar/98 LilyPond 0.1.48 4
+LinuxPPC Bugs:
+**************
+*R5, egcs-1.1.2-12c
+ 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,
+ `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
+*R4, egcs-1.0.2
+ All compiling with `-O2' is suspect, in particular guile-1.3, and
+ Lily herself will break.
+Linux-i386
+**********
+*SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
+ Lily will crash during parsing (which suggests a C++ library
+ incompatibility). Precise cause, precise platform description or
+ solution are not known.
-INSTALL(1) LilyPond documentation INSTALL(1)
+ Note that this only happens on some computers with the said
+ platform.
+*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.
- GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
- Parsing ... [/home/hw/share/lilypond/init//
- <..etc..>
- init//performer.ly]]][input/kortjakje.ly]
- Creating elements ...[8][16][24][25]
- Preprocessing elements...
- Calculating column positions ... [14][25]
- Postprocessing elements...
- TeX output to someinput.tex ...
- Creating MIDI elements ...MIDI output to someinput.midi ...
+*libg++ 2.7
+ LilyPond occasionally crashes while parsing the initialisation
+ files. This is a very obscure bug, and usually entering the
+ commandline differently "fixes" it.
- hw:~/musix/spacer$ xdvi someinput&
- [1] 855
+ lilypond input.ly
- Check out the input files, some of them have comments
- Please refer to the man page for more information.
+ and
+ lilypond -I. ./input.ly
+ makes a difference
-REDHAT LINUX
- RedHat Linux users should be able to get a RPM. A spec
- file is in make/out/lilypond.spec. You should be able to
- create an rpm as a normal user. Be sure you have a
- ~/.rpmrc, and edit the RPM-dir in Variables.make. (If you
- create the RPM as a normal user the permissions will not
- be set correctly, unfortunately)
+ Typical stacktrace:
+ SIGSEGV
+ __libc_malloc (bytes=16384)
+ ?? ()
+ yyFlexLexer::yy_create_buffer ()
+ Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
-DEBIAN GNU/LINUX
- A Debian package is also available; contact Anthony Fok
- <foka@debian.org>. The build scripts are in the
- subdirectory debian/
+ This behaviour has been observed with machines that have old libg++
+ versions (LinuxPPC feb '98, RedHat 4.x).
-WINDOWS NT/95
- So, you're stuck with Windows, eh? Well, don't worry, you
- just need (to get) Cygnus' windows32 port of gnu
- development stuff; have a look at
- http://www.cygnus.com/gnu-win32.
+Solaris:
+********
- To make GNU LilyPond under, brr, aargh, shudder...
- windows32, well, simply type:
+*Sparc64/Solaris 2.6, GNU make-3.77
+ GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+ newer.
- bash configure
- make
+*Sparc64/Solaris 2.6, ld
+ Not yet resolved.
- Note If you rely on broken DOS/Windows tools such as
- pkzip/WinZIP to unpack the distribution, make sure the
- entire source tree is unpacked correctly, in particular
- the empty out directories (flower/out, lib/out et. al.)
+AIX
+***
-MUSIXTEX
- Previous versions (before 0.1.39) used fonts from the TeX
- macro package "MusixTeX". You can still use these, but
- they are not supported. Since LilyPond's Feta font is
- much prettier, you'd be seriously misguided if you used
- them, but anyway, here are the installation instructions
- for those deprecated fonts.
+*AIX 4.3 ld
+ The following is from the gcc install/SPECIFIC file.
+ 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 -BBIGTOC) is
+ available from IBM Customer Support and from its
+ 27service.boulder.ibm.com website as PTF U455193.
+ Binutils does not support AIX 4.3 (at least through release
+ 2.9). GNU as and GNU ld will not work properly and one
+ should not configure GCC to use those GNU utilities. Use
+ the native AIX tools which do interoperate with GCC.
+ add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+ LDFLAGS='-Wl,-bbigtoc' ./configure
-11/Mar/98 LilyPond 0.1.48 5
+Authors
+=======
+ Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Jan Nieuwenhuizen <janneke@gnu.org>
+ In case of problems, please use the mailing list for help.
-
-INSTALL(1) LilyPond documentation INSTALL(1)
-
-
- [obsolete] I use the MusixTeX fonts those found in
- MusixTeX T.73. Beware, the clef symbol seems to have
- changed its position in some versions, (notably Egler's,
- a.k.a. OpusTeX). The MusixTeX fonts are included in
- MusixTeX (T73 or better), which can be had from any CTAN
- site, e.g. at
-
- ftp://ftp.shsu.edu/tex-archive/macros/musixtex/taupin
-
- ftp://ftp.tex.ac.uk/tex-archive/macros/musixtex/taupin
-
- ftp://ftp.dante.de/tex-archive/macros/musixtex/taupin
-
- You only need the contents of the mf/ subdirectory of the
- package. The primary site of the Taupin version is
- ftp://hprib.lps.u-psud.fr/pub/music_zips/musixtex.zip
-
- Install the musixtex fonts in a directory which TeX and MF
- knows (if you are root, look for a directory which
- contains the directories with AMS and CM source (*.mf)
- files. Create a subdir lilypond or musixtex and copy the
- fonts into that). Do not forget to rehash TeX (if
- applicable)
-
- Example: my fonts are in
- /usr/local/lib/texfonts/musixtex/, and I have a symlink
- pointing to that in
- /usr/lib/texmf/texmf/fonts/source/public/. After I copied
- the files, I ran "texhash"
-
- Andreas Egler's version of MusixTeX, now called OpusTeX,
- will also work. Andreas moved some characters around in
- the fonts, so you have to edit the definitions in
- tex/eglerdefs.tex.
-
-AUTHORS
- Han-Wen Nienhuys <hanwen@cs.ruu.nl>
-
- Jan Nieuwenhuizen <jan@digicash.com>
-
- Have fun!
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-11/Mar/98 LilyPond 0.1.48 6
-
+ Have fun!
projects / lilypond.git / blobdiff