3 @comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
4 @setfilename INSTALL.info
5 @settitle INSTALL - compiling and installing GNU LilyPond
9 @chapter Compiling and installing on Unix
13 <a name="download-source">
18 Even numbered versions are `stable'. The webpages for the stable version
19 (1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
20 servers}. Big enhancements go into the latest odd numbered version
21 (1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
24 Building LilyPond is an involved process. We advise to use binary
25 packages if these are available for your platform.
29 @subsection Source code
31 Download source tarballs from here:
33 @item Download development releases from
34 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
35 @uref{http://www.lilypond.org/ftp/} by HTTP.
36 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
40 Use Xdelta to patch tarballs, e.g. to patch
41 @file{lilypond-1.4.2.tar.gz} to @file{lilypond-1.4.3.tar.gz}, do
43 xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
46 For information on packaging and CVS, see
47 @uref{http://lilypond.org/}, under ``development''.
50 @subsection Precompiled binaries
52 Check out @uref{http://lilypond.org} for up to date information on
56 @subsection Font problems
58 If you are upgrading from a previous version of LilyPond, be sure to
59 remove all old font files. These include @file{.pk} and @file{.tfm} files
60 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
61 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}. A
62 script automating this has been included, see
63 @file{buildscripts/clean-fonts.sh}.
70 @subsection Compilation
72 You need the following packages to compile LilyPond:
76 @uref{http://gcc.gnu.org/,
77 The GNU c++ compiler} (version 3.1 or newer).
78 EGCS and 2.x are known to cause crashes.
80 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
82 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
84 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
86 @item @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
88 WARNING: plain Flex 2.5.4(a) generates invalid C++ code. GCC 3.x
89 chokes on this. If you wish to use GCC 3.x, make sure that your
90 distribution supports g++ 3.x and flex. For workarounds, see
91 lexer-gcc-3.1.sh in the source directory.
93 @item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
94 newer, but not 1.50 or 1.75).
98 @TeX{} is used as an output backend.
100 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
101 @file{.afm}, @file{.tfm}). Make sure you have tetex 1.0 or newer
102 (1.0.6 is known to work). You may need to install a tetex-devel (or
103 tetex-dev or libkpathsea-dev) package too.
105 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.6 or newer).
108 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
111 This package is normally included with the @TeX{} distribution.
113 @item kpathsea, a library for searching (@TeX{}) files.
115 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
118 You will need to install some additional packages to get mftrace to
123 @subsection Running requirements
125 GNU LilyPond does use a lot of resources. For operation you need the
130 @item Xdvi and Ghostscript.
131 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
134 You have to help @TeX{} and MetaFont find LilyPond support
135 files. After compiling, scripts to do this can be found in
136 @file{buildscripts/out/lilypond-profile} and
137 @file{buildscripts/out/lilypond-login}.
139 @subsection Building documentation
141 You can view the documentation online at
142 @uref{http://www.lilypond.org/doc/}, but you can also build it
143 locally. This process requires a successful compile of lilypond. The
144 documentation is built by issuing:
149 Building the website requires some additional tools:
152 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
156 The HTML files can be installed into the standard documentation path
160 make out=www web-install
164 @section Building LilyPond
166 To install GNU LilyPond, type
168 gunzip -c lilypond-x.y.z | tar xf -
170 ./configure # run with --help to see appropriate options
173 sh buildscripts/clean-fonts.sh
176 The most time-consuming part of compiling LilyPond is tracing the
177 Type1 fonts. You can shortcut this operation by issuing
178 one of the following commands:
181 make -C mf get-pfa # requires rpm2cpio
182 make -C mf get-debian-pfa # may not be up to date
185 If you are doing an upgrade, you should remove all @file{feta}
186 @code{.pk} and @code{.tfm} files. A script has been provided to do the
187 work for you, see @file{buildscripts/clean-fonts.sh}.
189 If you are not root, you should choose a @code{--prefix} argument that
190 points into your home directory, e.g.:
192 ./configure --prefix=$HOME/usr
195 In this case, you have to insert the contents of
196 @code{buildscripts/out/lilypond-login} or
197 @code{buildscripts/out/lilypond-profile} into your start up scripts by
202 @subsection Configuring for multiple platforms
204 If you want to build multiple versions of LilyPond with different
205 configuration settings, you can use the @code{--enable-config=CONF}
206 option of configure. You should use @samp{make conf=CONF} to generate
207 the output in @file{out-CONF}. Example: Suppose I want to build with
208 and without profiling. Then I'd use the following for the normal
212 ./configure --prefix=$HOME/usr/ --enable-checking
217 and for the profiling version, I specify a different configuration:
220 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
222 make conf=prof install
229 An Emacs mode for entering music and running LilyPond is contained in
230 the source archive as @file{lilypond-mode.el},
231 @file{lilypond-indent.el}, @file{lilypond-font-lock.el} and
232 @file{lilypond.words.el}. You should install these files to a directory
233 included in your @var{load-path}. File @file{lilypond-init.el} should
234 be placed to @var{load-path}@file{/site-start.d/} or appended to your
235 @file{~/.emacs} or @file{~/.emacs.el}.
237 As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
238 to your @var{load-path}. Append the following line (modified) to your
242 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
249 A Vim mode for entering music and running LilyPond is contained in
250 the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
251 to get shortcuts. Install file @file{lilypond.words.el} to @file{~/.vim/} to
252 get auto-completion. Syntax highlighting you get by installing files
253 @file{lilypond.vim} and @file{lilypond.words.vim} to @file{~/.vim/syntax/}
254 and appending the following to @file{~/.vim/filetype.vim}:
258 if exists("did_load_filetypes")
261 augroup filetypedetect
262 au! BufRead,BufNewFile *.ly setfiletype lilypond
271 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
272 reports to @email{bug-lilypond@@gnu.org}.
274 Bugs that are not fault of LilyPond are documented here.
276 @subsection Linking to kpathsea
278 If kpathsea and the corresponding header files are installed in some
279 directory where GCC does not search by default, for example in
280 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
281 you have to explicitly tell configure where to find it. To do this:
284 @item @code{rm config.cache}
285 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
286 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
287 @item @code{./configure}
289 Once configure has found them, the paths are stored in
290 @file{config.make} and will be used even if you don't have the
291 environment variables set during make.
294 @unnumberedsubsec Gcc-3.0.4
296 Gcc 3.0.4 is flaky; upgrade GCC.
298 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
300 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
301 LilyPond with gcc-3.1.1 you may do
304 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
305 CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
306 ./configure --enable-config=gcc-3.1
307 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
312 @unnumberedsubsec OpenBSD
316 Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
317 set include paths for kpathsea.
320 @unnumberedsubsec NetBSD
323 @item The flex precompiled in NetBSD-1.4.2 is broken.
324 Upgrade to flex-2.5.4a.
328 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
329 release)) does not include @file{/usr/pkg} paths. Configure it using:
332 CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
339 @unnumberedsubsec Solaris
342 @item Solaris7, ./configure
344 @file{./configure} needs a POSIX compliant shell. On Solaris7,
345 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
346 is. Run configure like:
348 CONFIG_SHELL=/bin/ksh ksh -c ./configure
352 CONFIG_SHELL=/bin/bash bash -c ./configure