1 \input texinfo @c -*-texinfo-*-
2 @setfilename INSTALL.info
3 @settitle INSTALL - compiling and installing GNU LilyPond
5 @documentencoding utf-8
13 @chapter Compiling and installing on Unix
17 <a name="download-source">
22 Even numbered minor versions are `stable' (2.6, 2.8, etc), while odd
23 version are development releases (2.7, 2.9, etc). Building LilyPond
24 is an involved process. If possible
25 @uref{http://lilypond.org/download,download a precompiled binary}
28 @subsection Source code
34 @uref{http://lilypond.org/download/} by HTTP.
35 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
38 CVS from @uref{http://savannah.gnu.org/cvs/?group=lilypond,savannah.gnu.org}
42 CVS_RSH=ssh cvs -d:ext:anoncvs@@savannah.gnu.org:/cvsroot/lilypond co lilypond
45 The CVS repository does not contain generated files. To create
53 For information on packaging, see @uref{http://lilypond.org/devel}.
55 @subsection Precompiled binary packages
57 Check out @uref{http://lilypond.org/web/install/} for up to date
58 information on binary packages for your platform.
63 @subsection Compilation
65 In addition to the packages needed for running Lilypond (see below),
66 you need the following extra packages for building.
68 When installing a binary package FOO, you may need to install the
69 FOO-devel, libFOO-dev or FOO-dev package too.
73 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
75 @item New Century Schoolbook fonts, as PFB files. These are shipped
76 with X11 and Ghostscript, and are named @file{c059033l.pfb}
77 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
79 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
82 You will need to install some additional packages to get mftrace to
85 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
86 (version 1.6.7 or newer). If you are installing binary packages, you
87 may need to install guile-devel or guile-dev or libguile-dev too.
89 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
92 @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
95 @item @uref{http://www.python.org,Python} (version 2.3 or newer)
97 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
99 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
102 @item @uref{http://www.gnu.org/software/flex/,Flex}
104 @item @uref{http://www.perl.org/,Perl}
106 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}
108 @item All packages required for running, including development packages with
109 header files and libraries.
113 @subsection Running requirements
115 Running LilyPond requires proper installation of the following
120 @item @uref{http://www.freetype.org/,Freetype} (version 2).
121 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
122 @item @uref{http://www.pango.org/,Pango} (version 1.6 or newer).
123 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
124 (version 1.6.5 or newer).
125 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
126 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
127 newer. 8.50 recommended)
130 @subsection Building documentation
132 You can view the documentation online at
133 @uref{http://lilypond.org/doc/}, but you can also build it locally.
134 This process requires a successful compile of lilypond. The
135 documentation is built by issuing
142 Building the website requires some additional tools and packages
145 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
147 @item International fonts (see input/regression/utf-8.ly for hints
148 about which font packages are necessary for your platform)
149 @item Ghostscript, 8.50 with the patch from
150 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
152 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
155 The HTML files can be installed into the standard documentation path
160 make out=www web-install
165 @section Building LilyPond
167 To install GNU LilyPond, type
170 gunzip -c lilypond-x.y.z | tar xf -
172 ./configure # run with --help for applicable options
178 The most time-consuming part of compiling LilyPond is tracing the
179 Type1 fonts. You can shortcut this operation by issuing
180 one of the following commands
184 make -C mf get-pfa # requires rpm2cpio
185 make -C mf get-debian-pfa # may not be up to date
189 If you are not root, you should choose a @code{--prefix} argument that
190 points into your home directory, e.g.
193 ./configure --prefix=$HOME/usr
198 @subsection Configuring for multiple platforms
200 If you want to build multiple versions of LilyPond with different
201 configuration settings, you can use the @code{--enable-config=CONF}
202 option of configure. You should use @samp{make conf=CONF} to generate
203 the output in @file{out-CONF}. Example: Suppose you want to build
204 with and without profiling, then use the following for the normal
209 ./configure --prefix=$HOME/usr/ --enable-checking
215 and for the profiling version, specify a different configuration
219 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
221 make conf=prof install
228 An Emacs mode for entering music and running LilyPond is contained in
229 the source archive in the @file{elisp} directory. Do @command{make
230 install} to install it to @var{elispdir}. The file @file{lilypond-init.el}
231 should be placed to @var{load-path}@file{/site-start.d/} or appended
232 to your @file{~/.emacs} or @file{~/.emacs.el}.
234 As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
235 your @var{load-path} by appending the following line (as modified) to your
237 @c any reason we do not advise: (push "~/site-lisp" load-path)
240 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
247 A Vim mode for entering music and running LilyPond is contained in the
248 source archive in @code{$VIM} directory.
250 The LilyPond file type is detected if the file @file{~/.vim/filetype.vim} @c
251 has the following content
254 if exists("did_load_filetypes")
257 augroup filetypedetect
258 au! BufNewFile,BufRead *.ly setf lilypond
263 Please include this path by appending the following line to your
268 set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/
273 where $@{LILYPOND_VERISON@} is your lilypond version. If Lilypond was not
274 installed in @file{/usr/local/}, then change this path accordingly.
279 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
280 reports to @email{bug-lilypond@@gnu.org}.
282 Bugs that are not fault of LilyPond are documented here.
284 @subsection Bison 1.875
286 There is a bug in bison-1.875: compilation fails with "parse error
287 before `goto'" in line 4922 due to a bug in bison. To fix, please
288 recompile bison 1.875 with the following fix
292 $ cd lily; make out/parser.cc
293 $ vi +4919 out/parser.cc
294 # append a semicolon to the line containing "__attribute__ ((__unused__))
302 @unnumberedsubsec Gcc-3.0.4
304 Gcc 3.0.4 is flaky; upgrade GCC.
306 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
308 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
309 LilyPond with gcc-3.1.1 or higher you may do
313 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
314 CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
315 ./configure --enable-config=gcc-3.1
316 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
321 @unnumberedsubsec MacOS X
323 For Fink, use the following command to compile.
326 export GUILE=guile-1.6
327 export GUILE_CONFIG=guile-1.6-config
328 export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
329 ./configure --without-kpathsea
332 @unnumberedsubsec OpenBSD
336 Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
337 set include paths for kpathsea.
340 @unnumberedsubsec NetBSD
343 @item The flex precompiled in NetBSD-1.4.2 is broken.
344 Upgrade to flex-2.5.4a.
347 @unnumberedsubsec Solaris
350 @item Solaris7, ./configure
352 @file{./configure} needs a POSIX compliant shell. On Solaris7,
353 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
354 is. Run configure like
357 CONFIG_SHELL=/bin/ksh ksh -c ./configure
363 CONFIG_SHELL=/bin/bash bash -c ./configure