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' (2.0, 1.8 etc), while odd version
19 are development releases (2.1, 1.9, etc). Building LilyPond is an
20 involved process, so if possible, download a precompiled binary from
21 @uref{http://www.lilypond.org/,the lilypond site}.
24 @subsection Source code
26 Download source tarballs from here:
28 @item Download development releases from
29 @uref{http://www.lilypond.org/download/} by HTTP.
30 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
34 Use Xdelta to patch tarballs, e.g. to patch
35 @file{lilypond-1.4.2.tar.gz} to @file{lilypond-1.4.3.tar.gz}, do
37 xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
40 For information on packaging and CVS, see
41 @uref{http://lilypond.org/}, under ``development''.
44 @subsection Precompiled binaries
46 Check out @uref{http://lilypond.org} for up to date information on
50 @subsection Font problems
52 If you are upgrading from a previous version of LilyPond, be sure to
53 remove all old font files. These include @file{.pk} and @file{.tfm} files
54 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
55 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}. A
56 script automating this has been included, see
57 @file{buildscripts/clean-fonts.sh}.
64 @subsection Compilation
66 You need the following packages to compile LilyPond:
70 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
73 You will need to install some additional packages to get mftrace to
76 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
78 @item @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
80 WARNING: plain Flex 2.5.4(a) generates invalid C++ code. GCC 3.x
81 chokes on this. If you wish to use GCC 3.x, make sure that your
82 distribution supports g++ 3.x and flex. For workarounds, see
83 lexer-gcc-3.1.sh in the source directory.
87 @TeX{} is used as an output backend.
89 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
90 @file{.afm}, @file{.tfm}). Make sure you have tetex 1.0 or newer
91 (1.0.6 is known to work). You may need to install a tetex-devel (or
92 tetex-dev or libkpathsea-dev) package too.
94 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.6 or newer).
97 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
100 This package is normally included with the @TeX{} distribution.
102 @item kpathsea, a library for searching (@TeX{}) files.
105 @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.1 or
106 newer). EGCS and 2.x are known to cause crashes.
108 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
110 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
112 @item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
113 newer, but not 1.50 or 1.75).
116 @subsection Running requirements
118 GNU LilyPond does use a lot of resources. For operation you need the
123 @item Xdvi and Ghostscript.
124 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
127 You have to help @TeX{} and MetaFont find LilyPond support
128 files. After compiling, scripts to do this can be found in
129 @file{buildscripts/out/lilypond-profile} and
130 @file{buildscripts/out/lilypond-login}.
132 @subsection Building documentation
134 You can view the documentation online at
135 @uref{http://www.lilypond.org/doc/}, but you can also build it
136 locally. This process requires a successful compile of lilypond. The
137 documentation is built by issuing:
142 Building the website requires some additional tools:
145 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
149 The HTML files can be installed into the standard documentation path
153 make out=www web-install
157 @section Building LilyPond
159 To install GNU LilyPond, type
161 gunzip -c lilypond-x.y.z | tar xf -
163 ./configure # run with --help to see appropriate options
166 sh buildscripts/clean-fonts.sh
169 The most time-consuming part of compiling LilyPond is tracing the
170 Type1 fonts. You can shortcut this operation by issuing
171 one of the following commands:
174 make -C mf get-pfa # requires rpm2cpio
175 make -C mf get-debian-pfa # may not be up to date
178 If you are doing an upgrade, you should remove all @file{feta}
179 @code{.pk} and @code{.tfm} files. A script has been provided to do the
180 work for you, see @file{buildscripts/clean-fonts.sh}.
182 If you are not root, you should choose a @code{--prefix} argument that
183 points into your home directory, e.g.:
185 ./configure --prefix=$HOME/usr
188 In this case, you have to insert the contents of
189 @code{buildscripts/out/lilypond-login} or
190 @code{buildscripts/out/lilypond-profile} into your start up scripts by
195 @subsection Configuring for multiple platforms
197 If you want to build multiple versions of LilyPond with different
198 configuration settings, you can use the @code{--enable-config=CONF}
199 option of configure. You should use @samp{make conf=CONF} to generate
200 the output in @file{out-CONF}. Example: Suppose I want to build with
201 and without profiling. Then I'd use the following for the normal
205 ./configure --prefix=$HOME/usr/ --enable-checking
210 and for the profiling version, I specify a different configuration:
213 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
215 make conf=prof install
222 An Emacs mode for entering music and running LilyPond is contained in
223 the source archive in the @file{elisp} directory. @command{make
224 install} installs it @var{elispdir}. The file @file{lilypond-init.el}
225 should be placed to @var{load-path}@file{/site-start.d/} or appended
226 to your @file{~/.emacs} or @file{~/.emacs.el}.
228 As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
229 to your @var{load-path}. Append the following line (modified) to your
231 @c any reason we do not advise: (push "~/site-lisp" load-path)
234 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
241 @c lilypond.words.el for vim auto-completion?
242 A Vim mode for entering music and running LilyPond is contained in
243 the source archive. The LilyPond file type is detected if your file
244 @file{~/.vim/filetype.vim} has the following content:
246 if exists("did_load_filetypes")
249 augroup filetypedetect
250 au! BufNewFile,BufRead *.ly setf lilypond
253 In addition, LilyPond's vim-mode files which are installed to
254 @file{/usr/share/lilypond/vim/} have to be placed in a path specified
255 in your @code{$VIMRUNTIME} environment variable. You can add this path
256 to @code{$VIMRUNTIME} by appending the following line to your
259 set runtimepath+=/usr/share/lilypond/vim/
264 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
265 reports to @email{bug-lilypond@@gnu.org}.
267 Bugs that are not fault of LilyPond are documented here.
269 @subsection Bison 1.875
271 There is a bug in bison-1.875: compilation fails with "parse error
272 before `goto'" in line 4922 due to a bug in bison. To fix, either
273 recompile bison 1.875 with the following fix:
276 $ cd lily; make out/parser.cc
277 $ vi +4919 out/parser.cc
278 # append a semicolon to the line containing "__attribute__ ((__unused__))
283 @subsection Linking to kpathsea
285 If kpathsea and the corresponding header files are installed in some
286 directory where GCC does not search by default, for example in
287 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
288 you have to explicitly tell configure where to find it. To do this:
291 @item @code{rm config.cache}
292 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
293 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
294 @item @code{./configure}
296 Once configure has found them, the paths are stored in
297 @file{config.make} and will be used even if you don't have the
298 environment variables set during make.
301 @unnumberedsubsec Gcc-3.0.4
303 Gcc 3.0.4 is flaky; upgrade GCC.
305 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
307 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
308 LilyPond with gcc-3.1.1 you may do
311 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
312 CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
313 ./configure --enable-config=gcc-3.1
314 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
319 @unnumberedsubsec OpenBSD
323 Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
324 set include paths for kpathsea.
327 @unnumberedsubsec NetBSD
330 @item The flex precompiled in NetBSD-1.4.2 is broken.
331 Upgrade to flex-2.5.4a.
334 @unnumberedsubsec Solaris
337 @item Solaris7, ./configure
339 @file{./configure} needs a POSIX compliant shell. On Solaris7,
340 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
341 is. Run configure like:
343 CONFIG_SHELL=/bin/ksh ksh -c ./configure
347 CONFIG_SHELL=/bin/bash bash -c ./configure