+INSTALL - compiling and installing GNU LilyPond
+***********************************************
-INSTALL(1) LilyPond documentation INSTALL(1)
+Obtaining
+=========
+ 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/).
-NAME
- INSTALL - installing GNU LilyPond
+ There are three options for downloading sources.
-DESCRIPTION
- This page documents installation and compilation of GNU
- LilyPond
+ * if you don't have any version, then you can download the entire
+ `.tar.gz' file.
-ABSTRACT
- You do something which looks remotely like
+ * if you have an unpacked source tree of a previous version, you
+ may use the diffs .
- configure
- make
- make install
+ _If you upgrade by patching do remember to rerun autoconf after
+ applying the patch_.
- The detailed instructions follow here.
+ * if you have the `.tar.gz' file of a previous release, you can use
+ xdelta (ftp://ftp.xcf.berkeley.edu/pub/xdelta/). This is much
+ safer than using normal diffs, and is the recommended way.
-PREREQUISITES
- For compilation you need.
+ The following command produces `lilypond-1.3.122.tar.gz' from
+ `lilypond-1.3.121' identical (up to compression dates) to the .122
+ on the FTP site.
+ xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz
- o A GNU system: GNU LilyPond is known to run on these
- GNU systems: Linux (PPC, intel), FreeBSD, AIX,
- NeXTStep, Digital Unix and Solaris.
+Build requirements
+==================
- 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.
+ 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 Jan's windows page
+(http://appel.lilypond.org/lilypond/gnu-windows/).
- o GNU C++ v2.7 or better, with libg++ installed.
- Version 2.7.2 or better recommended.
+ You need the following packages to compile Lilypond.
- o GNU make.
+ * A reasonably new C++ compiler: EGCS 1.1, GCC 2.95.2 or newer.
+ Check out the gcc site (ftp://ftp.gnu.org/gnu/gcc/).
- o Flex (2.5.1 or better).
+ * Python 1.5, Check out the python website (http://www.python.org).
- o Bison. (Version 1.25 or better)
+ * GUILE 1.3.4 or newer, check out the GUILE webpage
+ (http://www.gnu.org/software/guile/guile.html). Version 1.4 is
+ recommended for better performance.
-RUNNING
- GNU LilyPond does use a lot of resources. For operation
- you need the following:
+ * GNU Make. Check out the GNU make FTP directory
+ (ftp://ftp.gnu.org/gnu/make/).
- o TeX
+ * Flex (version 2.5.4a or newer). Check out the Flex webpage
+ (http://www.gnu.org/software/flex/).
- 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.
+ * Bison (version 1.25 or newer). Check out the bison webpage
+ (http://www.gnu.org/software/bison/)
-RECOMMENDED
- Although not strictly necessary, these are recommended to
- have.
+ * TeX.
- o Perl-5. Most documentation was created with the
- perl's Plain Old Documentation. (I use 5.003)
+ 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.
+ * Texinfo (version 4.0 or newer). The documentation of lily is
+ written in texinfo. Check out the texinfo FTP directory
+ (ftp://ftp.gnu.org/gnu/texinfo/).
+ * The geometry package for LaTeX is needed to use ly2dvi. It is
+ available at the FTP directory for `geometry'
+ (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry).
+ This package is normally included with the TeX distribution.
+ * MetaPost, needed for generating PostScript fonts. Please note that
+ tetex-0.4pl8 (included with Red Hat 5.x) does not include
+ `mfplain.mp', which is needed for producing the scalable font
+ files.
-28/Jan/98 LilyPond 0.1.45 1
+ If you don't have MetaPost and don't want to use PostScript
+ output, then edit `mf/GNUmakefile', removing the line saying
+ `PFA_FILES='.
+ * kpathsea, a library for searching (TeX) files. `kpathsea' is
+ usually included with your installation of TeX.
+Running requirements
+====================
+ GNU LilyPond does use a lot of resources. For operation you need the
+following software
-INSTALL(1) LilyPond documentation INSTALL(1)
+ * TeX.
+ * Xdvi and ghostscript
- o Python. Although perl is nice, python is better. We
- will shift towards python for build scripts
+ * GUILE 1.3.4, or newer. Check out the GUILE webpage
+ (http://www.gnu.org/software/guile.html)
- o GNU find
+ 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
+`buildscripts/out/lilypond-profile' and
+`buildscripts/out/lilypond-login' after compilation.
- 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)
+ LilyPond is a big and slow program. A fast CPU and plenty of RAM is
+recommended for comfortable use.
-CONFIGURING and COMPILING
- to install GNU LilyPond, simply type:
+Website requirements
+====================
- configure
- make install
+ 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
- This will install the following files:
+ make web-doc
- /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/*
+ Building the website requires some additional tools:
- 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:
+ * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities).
+ The original is at the netpbm FTP site
+ (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- configure
+ * pnmtopng. The original is at in the pnmtopng FTP site
+ (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).
- CPPFLAGS are the preprocessor flags.
+ * Bibtex2html (http://www.lri.fr/~filliatr/ftp/bibtex2html/), or
+ Bib2html (http://www.uni-koblenz.de/ag-ki/ftp/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
+ 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 bib converter utility, but you will
+ not see our hypertextified bibliography.
- configure --prefix=/home/me_myself_and_I/
- In this case, you will have to set MFINPUTS, and TEXINPUTS
- accordingly.
+Configuring and compiling
+=========================
- 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:
+ to install GNU LilyPond, type:
+ 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
- configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
+ If you are doing an upgrade, you should remove all `feta' `.pk' and
+`.tfm' files. A script has been provided to do the work for you, see
+`buildscripts/clean-fonts.sh'.
+ If you are not root, you should choose a `--prefix' argument that
+points into your home directory, eg.
+ ./configure --prefix=$HOME/usr
-28/Jan/98 LilyPond 0.1.45 2
+ In this case, you have to insert the contents of
+`buildscripts/out/lilypond-login' or
+`buildscripts/out/lilypond-profile' into your start up scripts by hand.
+Configuring for multiple platforms
+==================================
+ If you want to build multiple versions of LilyPond with different
+configuration settings, you can use the `--enable-config=CONF' option
+of configure. You should use `make conf=CONF' to generate the output
+in `out-CONF'. Example: suppose I want to build with and without
+profiling. Then I'd use the following for the normal build,
+ ./configure --prefix=~ --enable-checking
+ make
+ make install
+ and for the profiling version, I specify a different configuration.
-INSTALL(1) LilyPond documentation INSTALL(1)
+ ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
+ make conf=prof
+ make conf=prof install
- Since GNU LilyPond currently is beta, you are advised to
- also use
+Emacs mode
+==========
- --enable-debugging
- --enable-checking
+ An emacs mode for LilyPond is included with the source archive as
+`lilypond-mode.el' and `lilypond-font-lock.el'. If you have an RPM, it
+is in `/usr/share/doc/lilypond-X/'. You have to install it yourself.
- other options include:
+ Add this to your ~/.emacs or ~/.emacs.el:
+ (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)))
- --enable-shared
- Make a shared library (gnu/linux, solaris (?) only )
+ If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
+is automatically loaded, so you need not modify your `~/.emacs' file.
- --enable-printing
- Enable debugging print routines (lilypond -d option)
+Red Hat Linux
+=============
- --enable-optimise
- Set maximum optimisation: compile with -O2
+ Red Hat 7.0 i386 RPMS are available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
- --enable-profiling
- Compile with support for profiling
+ You can also compile them yourself. A spec file is in
+`make/out/lilypond.spec'. This file is distributed along with the
+sources. You can make the rpm by issuing
- --enable-tex-prefix
- Set the directory where TeX and Metafont live
+ rpm -tb lilypond-x.y.z.tar.gz
+ rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
- --enable-tex-dir
- Set then directory TeX input is in (detected as a
- subdir of tex-prefix)
+ For running on a Red Hat system you need these packages: guile,
+tetex, tetex-dvips, libstdc++, python, ghostscript.
- --enable-mf-dir
- Set the directory mf input is in (idem)
+ 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.
- --enable-out-dir
- Set the directory for machine generated output.
+SuSE
+====
- All options are documented in the configure help The
- option --enable-optimise is recommended for Real Life
- usage.
+ [TODO: document this]
- If you do
+ Install `tetex', `te_mpost', `te_kpath'.
- make all
+Mandrake
+========
- 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).
+ [TODO]
- Building for multiple hosts
+Debian GNU/Linux
+================
- 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.
+ A Debian package is also available. You may install it easily by
+using apt-get as root:
+ apt-get install lilypond1.3
+ Alternatively, visit
-28/Jan/98 LilyPond 0.1.45 3
+ * http://packages.debian.org/lilypond
+ (http://packages.debian.org/lilypond)
+ * 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;
+ * 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.
+ You may contact Anthony Fok <foka@debian.org> for more information.
+ The build scripts are in the subdirectory `debian/'; you can make
+the .deb by doing, for example:
-INSTALL(1) LilyPond documentation INSTALL(1)
+ $ 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
+ $
+ For compilation on a Debian GNU/Linux system you need these packages,
+in addition to the those needed for running:
- Example: on my system, I do debugging and lots compiling.
- For this I use the configuration as follows:
+ * g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
- configure --prefix=~ --enable-debugging --enable-printing --enable-checking
- make all
+ * libguile<your-libguile-version-here>-dev
- and I want to do profiling. For that I use
+ * make, m4, flex, bison
- configure --prefix=~ --enable-debugging --disable-printing\
- --disable-checking --enable-profiling --enable-optimise\
- --enable-out-dir=out-profile
+ * gettext
- make OUTDIR_NAME=out-profile all
+ * groff, texinfo, bibtex2html (not in 2.2r2)
- 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.
+ * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
-INSTALLING
- If you have done a successful make, then a simple
+ * dpkg-dev, debhelper, fakeroot
- make install
+ * gs, netpbm, pnmtopng
- should do the trick.
+ 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.
- 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.
+ For Debian 2.2 (or 2.2r2, 2.2r3):
-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.
+ 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
- o Perl5.003 and Perl5.004 use different syntax for
- pod2html.
+ For Debian in development ("unstable", the future 2.3 or 3.0):
-EXAMPLE
- This is what I type in my xterm:
+ 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
- lilypond someinput.ly
- tex someinput.tex
- xdvi someinput&
+ 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:
- This is what the output looks like over here:
+ dpkg --purge lilypond lilypond1.3
+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>.
+ Bugs that are not fault of LilyPond are documented here.
+NetBSD
+******
+ * The flex precompiled in NetBSD-1.4.2 is broken. Download
+ flex-2.5.4a, build, install.
+ * The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
+ release)) does not include `/usr/pkg' paths. Configure using:
+ CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
+Solaris:
+********
-28/Jan/98 LilyPond 0.1.45 4
+ * Sparc64/Solaris 2.6, GNU make-3.77
+ GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+ newer.
+ * Sparc64/Solaris 2.6, ld
+ Not yet resolved.
+AIX
+***
-INSTALL(1) LilyPond documentation INSTALL(1)
+ * 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.
- 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 ...
+ 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.
- hw:~/musix/spacer$ xdvi someinput&
- [1] 855
-
- Check out the input files, some of them have comments
- Please refer to the man page for more information.
-
-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)
-
-DEBIAN GNU/LINUX
- A Debian package is also available; contact Anthony Fok
- <foka@debian.org>. The build scripts are in the
- subdirectory debian/
-
-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.
-
- To make GNU LilyPond under, brr, aargh, shudder...
- windows32, well, simply type:
-
- bash configure
- make
-
- 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.)
-
-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.
-
-
-
-28/Jan/98 LilyPond 0.1.45 5
-
-
-
-
-
-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@stack.nl>
-
- Jan Nieuwenhuizen <jan@digicash.com>
-
- Have fun!
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-28/Jan/98 LilyPond 0.1.45 6
+ add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+ LDFLAGS='-Wl,-bbigtoc' ./configure
projects / lilypond.git / blobdiff