3 @comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
4 @setfilename INSTALL.info
5 @settitle INSTALL - compiling and installing GNU LilyPond
8 <!--- @@WEB-TITLE@@=Installation Instructions --->
13 @chapter Compiling and installing on Unix
17 <a name="download-source">
22 Even numbered versions are `stable'. The webpages for the stable version
23 (1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
24 servers}. Big enhancements go into the latest odd numbered version
25 (1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
28 Building LilyPond is an involved process. We advise to use binary
29 packages if these are available for your platform.
33 @subsection Source code
35 Download source tarballs from here:
37 @item Download development releases from
38 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
39 @uref{http://www.lilypond.org/ftp/} by HTTP.
40 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
44 Use Xdelta to patch tarballs, e.g. to patch
45 @file{lilypond-1.4.2.tar.gz} to @file{lilypond-1.4.3.tar.gz}, do
47 xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
50 For information on packaging and CVS, see
51 @uref{http://lilypond.org/}, under ``develoment''.
54 @subsection Precompiled binaries
56 Check out @uref{http://lilypond.org} for up to date information on
60 @subsection Font problems
62 If you are upgrading from a previous version of LilyPond, be sure to
63 remove all old font files. These include @file{.pk} and @file{.tfm} files
64 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
65 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}. A
66 script automating this has been included, see
67 @file{buildscripts/clean-fonts.sh}.
74 @subsection Compilation
76 You need the following packages to compile LilyPond:
80 @uref{http://gcc.gnu.org/,
81 The GNU c++ compiler} (version 3.1 or newer).
82 EGCS 1.1 may work, but is no longer supported.
85 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
87 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.4 or newer).
89 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer),
91 @item @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
93 WARNING: plain Flex 2.5.4(a) generates invalid C++ code. GCC 3.x
94 chokes on this. If you wish to use GCC 3.x, make sure that your
95 distribution supports g++ 3.x and flex. For workarounds, see
96 lexer-gcc-3.0.patch and lexer-gcc-3.1.sh in the source directory.
98 @item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or newer).
102 @TeX{} is used as an output backend.
104 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
105 @file{.afm}, @file{.tfm}). Make sure you have tetex 1.0 or newer
106 (1.0.6 is known to work). You may need to install a tetex-devel (or
107 tetex-dev or libkpathsea-dev) package too.
109 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.2 or newer).
112 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
115 This package is normally included with the @TeX{} distribution.
117 @item kpathsea, a library for searching (@TeX{}) files.
121 usually included with your installation of @TeX{}. You may need to
122 install a tetex-devel or tetex-dev package too. If kpathsea is not
123 installed in a directory where the compiler normally looks, read the
124 hints for Slackware below.
126 In the very unlikely case that kpathsea is not available for your
127 platform (i.e., you're not running GNU/Linux, Windows, or any recent
128 UNIX), you can compile LilyPond without kpathsea support. In that case,
129 you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
130 configure something like:
134 ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
141 @subsection Running requirements
143 GNU LilyPond does use a lot of resources. For operation you need the
148 @item Xdvi and Ghostscript.
149 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.4, or newer.
152 For running LilyPond successfully
154 You have to help @TeX{} and MetaFont find LilyPond support
155 files. After compiling, scripts to do this can be found in
156 @file{buildscripts/out/lilypond-profile} and
157 @file{buildscripts/out/lilypond-login}.
159 @subsection Building documentation
161 You can view the documentation online at
162 @uref{http://www.lilypond.org/doc/}, but you can also build it
163 locally. This process requires a successful compile of lilypond. The
164 documentation is built by issuing:
169 Building the website requires some additional tools:
172 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} see
174 @item @uref{http://www.cs.uu.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
177 You will need to install some additional packages to get mftrace to
181 @section Building LilyPond
183 To install GNU LilyPond, type:
185 gunzip -c lilypond-x.y.z | tar xf -
187 ./configure # run with --help to see appropriate options
190 sh buildscripts/clean-fonts.sh
193 If, in addition, you want to generate PDF files of your scores and have
194 installed mftrace, type:
197 make MAKE_PFA_FILES=1 install
200 (PFA versions of the fonts for the latest LilyPond version can also be
201 obtained from the web site using:
205 wget -l 1 -nd -r -A pfa,map http://lilypond.org/stable/mf/out/
206 mv *.pfa $LILYPONDSHARE/fonts/type1/
207 mv *.map $LILYPONDSHARE/dvips/
210 where @code{$LILYPONDSHARE} denotes @code{/usr/share/lilypond/1.7.*/} or
211 wherever LilyPond is installed on your system.
213 If you are doing an upgrade, you should remove all @file{feta}
214 @code{.pk} and @code{.tfm} files. A script has been provided to do the
215 work for you, see @file{buildscripts/clean-fonts.sh}.
218 If you are not root, you should choose a @code{--prefix} argument that
219 points into your home directory, e.g.:
221 ./configure --prefix=$HOME/usr
224 In this case, you have to insert the contents of
225 @code{buildscripts/out/lilypond-login} or
226 @code{buildscripts/out/lilypond-profile} into your start up scripts by
231 @subsection Configuring for multiple platforms
233 If you want to build multiple versions of LilyPond with different
234 configuration settings, you can use the @code{--enable-config=CONF}
235 option of configure. You should use @samp{make conf=CONF} to generate
236 the output in @file{out-CONF}. Example: Suppose I want to build with
237 and without profiling. Then I'd use the following for the normal
241 ./configure --prefix=$HOME/usr/ --enable-checking
246 and for the profiling version, I specify a different configuration:
249 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
251 make conf=prof install
258 An Emacs mode for entering music and running LilyPond is contained in
259 the source archive as @file{lilypond-mode.el},
260 @file{lilypond-indent.el}, @file{lilypond-font-lock.el} and
261 @file{lilypond.words}. You should install these files to a directory
262 included in your @var{load-path}. File @file{lilypond-init.el} should
263 be placed to @var{load-path}@file{/site-start.d/} or appended to your
264 @file{~/.emacs} or @file{~/.emacs.el}.
266 As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
267 to your @var{load-path}. Append the following line (modified) to your
271 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
278 A Vim mode for entering music and running LilyPond is contained in
279 the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
280 to get shortcuts. Install file @file{lilypond.words} to @file{~/.vim/} to
281 get auto-completion. Syntax highlighting you get by installing
282 @file{lilypond.vim} to @file{~/.vim/syntax/} and appending the following
283 to @file{~/.vim/filetype.vim}:
287 if exists("did_load_filetypes")
290 augroup filetypedetect
291 au! BufRead,BufNewFile *.ly setfiletype lilypond
300 For help and questions use @email{lilypond-user@@gnu.org}. Please
301 consult the FAQ before mailing your problems. If you find bugs, please
302 send bug reports to @email{bug-lilypond@@gnu.org}.
304 Bugs that are not fault of LilyPond are documented here.
306 @subsection Linking to kpathsea
308 If kpathsea and the corresponding header files are installed in some
309 directory where GCC does not search by default, for example in
310 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
311 you have to explicitly tell configure where to find it. To do this:
314 @item @code{rm config.cache}
315 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
316 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
317 @item @code{./configure}
319 Once configure has found them, the paths are stored in
320 @file{config.make} and will be used even if you don't have the
321 environment variables set during make.
324 @unnumberedsubsec Gcc-3.0.4
326 Gcc 3.0.4 is flaky; upgrade GCC.
328 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
330 Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
331 LilyPond with gcc-3.0 you may do:
334 CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
335 make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
336 patch -p1 < lexer-gcc-3.0.patch
337 make conf=gcc-3.0 -C lily
340 @unnumberedsubsec Flex-2.5.4a and gcc-3.1.x
342 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
343 LilyPond with gcc-3.1.1 you may do:
346 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
347 CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
348 ./configure --enable-config=gcc-3.1
349 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
355 @unnumberedsubsec OpenBSD
359 Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
360 set include paths for kpathsea.
363 @unnumberedsubsec NetBSD
366 @item The flex precompiled in NetBSD-1.4.2 is broken.
367 Upgrade to flex-2.5.4a.
369 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
370 release)) does not include @file{/usr/pkg} paths. Configure using:
373 CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
379 @unnumberedsubsec Solaris
382 @item Solaris7, ./configure
384 @file{./configure} needs a POSIX compliant shell. On Solaris7,
385 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
386 is. Please run configure like:
388 CONFIG_SHELL=/bin/ksh ksh -c ./configure
392 CONFIG_SHELL=/bin/bash bash -c ./configure
395 @item Sparc64/Solaris 2.6, ld
401 @unnumberedsubsec AIX
406 The following is from the gcc install/SPECIFIC file:
408 Some versions of the AIX binder (linker) can fail with a relocation
409 overflow severe error when the -bbigtoc option is used to link
410 GCC-produced object files into an executable that overflows the TOC.
411 A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
412 -BBIGTOC) is available from IBM Customer Support and from its
413 27service.boulder.ibm.com website as PTF U455193.
415 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
416 as and GNU ld will not work properly and one should not configure GCC
417 to use those GNU utilities. Use the native AIX tools which do
418 interoperate with GCC.
421 add -Wl,-bbigtoc to USER_LDFLAGS, i.e.:
423 LDFLAGS='-Wl,-bbigtoc' ./configure