-@node Top, , , (dir)
-@top
-@comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
+\input texinfo @c -*-texinfo-*-
@setfilename INSTALL.info
@settitle INSTALL - compiling and installing GNU LilyPond
-@html
-<!--- @@WEB-TITLE@@=Installation Instructions --->
-@end html
+@documentencoding utf-8
+@documentlanguage en
+
+@node Top
+@top
@contents
@section Downloading
-Even numbered versions are `stable'. The webpages for the stable version
-(1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
-servers}. Big enhancements go into the latest odd numbered version
-(1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
-site}.
-
-Building LilyPond is an involved process. We advise to use binary
-packages if these are available for your platform.
-
-
+Even numbered minor versions are `stable' (2.6, 2.8, etc), while odd
+version are development releases (2.7, 2.9, etc). Building LilyPond
+is an involved process. If possible
+@uref{http://lilypond.org/install,download a precompiled binary} for
+your platform.
@subsection Source code
-Download source tarballs from here:
+Download source
@itemize @bullet
-@item Download development releases from
-@uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
-@uref{http://www.lilypond.org/ftp/} by HTTP.
-@item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
-@end itemize
-
-
-Use Xdelta to patch tarballs, e.g. to patch
-@file{lilypond-1.4.2.tar.gz} to @file{lilypond-1.4.3.tar.gz}, do
+@item tarballs from
+@uref{http://lilypond.org/download/} by HTTP.
+@item tarballs from
+@uref{http://download.linuxaudio.org/lilypond/} by HTTP.
+@item
+GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
@example
- xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
+git clone git://git.sv.gnu.org/lilypond.git
@end example
-For information on packaging and CVS, see
-@uref{http://lilypond.org/}, under ``develoment''.
-
-
-@subsection Precompiled binaries
-
-Check out @uref{http://lilypond.org} for up to date information on
-binary packages.
-
-
-@subsection Font problems
+The repository does not contain generated files. To create
+@file{configure}, run
+@example
+./autogen.sh
+@end example
+@end itemize
-If you are upgrading from a previous version of LilyPond, be sure to
-remove all old font files. These include @file{.pk} and @file{.tfm} files
-that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
-@file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}. A
-script automating this has been included, see
-@file{buildscripts/clean-fonts.sh}.
+For information on packaging, see @uref{http://lilypond.org/devel}.
+@subsection Precompiled binary packages
+Check out @uref{http://lilypond.org/web/install/} for up to date
+information on binary packages for your platform.
@section Requirements
@subsection Compilation
-You need the following packages to compile LilyPond:
-
-@itemize
-@item
- @uref{http://gcc.gnu.org/,
-The GNU c++ compiler} (version 3.1 or newer).
-EGCS 1.1 may work, but is no longer supported.
-Check out
+In addition to the packages needed for running Lilypond (see below),
+you need the following extra packages for building.
-@item @uref{http://www.python.org,Python} (version 2.1 or newer).
+When installing a binary package FOO, you may need to install the
+FOO-devel, libFOO-dev or FOO-dev package too.
-@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
+@itemize
-@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer),
+@item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
-@item @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
+@item New Century Schoolbook fonts, as PFB files. These are shipped
+with X11 and Ghostscript, and are named @file{c059033l.pfb}
+@file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
-WARNING: plain Flex 2.5.4(a) generates invalid C++ code. GCC 3.x
-chokes on this. If you wish to use GCC 3.x, make sure that your
-distribution supports g++ 3.x and flex. For workarounds, see
-lexer-gcc-3.0.patch and lexer-gcc-3.1.sh in the source directory.
+@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
+newer),
-@item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or newer).
+You will need to install some additional packages to get mftrace to
+work.
-@item @TeX{}.
+@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
+(version 1.8.2 or newer). If you are installing binary packages, you
+may need to install guile-devel or guile-dev or libguile-dev too.
-@TeX{} is used as an output backend.
+@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
-Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
-@file{.afm}, @file{.tfm}). 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 or libkpathsea-dev) package too.
+@item
+@uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
+newer).
-@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.2 or newer).
+@item @uref{http://www.python.org,Python} (version 2.3 or newer)
-@item The
-@uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
-package for LaTeX}.
+@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
- This package is normally included with the @TeX{} distribution.
+@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
-@item kpathsea, a library for searching (@TeX{}) files.
+@item @uref{http://www.gnu.org/software/flex/,Flex}
-@ignore
-@code{kpathsea} is
-usually included with your installation of @TeX{}. You may need to
-install a tetex-devel or tetex-dev package too. If kpathsea is not
-installed in a directory where the compiler normally looks, read the
-hints for Slackware below.
+@item @uref{http://www.perl.org/,Perl}
-In the very unlikely case that kpathsea is not available for your
-platform (i.e., you're not running GNU/Linux, Windows, or any recent
-UNIX), you can compile LilyPond without kpathsea support. In that case,
-you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
-configure something like:
+@item @uref{http://www.gnu.org/software/flex/,GNU Bison}
-@quotation
-@example
- ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
-@end example
-@end quotation
-@end ignore
+@item All packages required for running, including development packages with
+header files and libraries.
@end itemize
@subsection Running requirements
-GNU LilyPond does use a lot of resources. For operation you need the
-following software:
+Running LilyPond requires proper installation of the following
+software
@itemize @bullet
-@item @TeX{}.
-@item Xdvi and Ghostscript.
-@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
-@end itemize
-For running LilyPond successfully
-
-You have to help @TeX{} and MetaFont find LilyPond support
-files. After compiling, scripts to do this can be found in
-@file{buildscripts/out/lilypond-profile} and
-@file{buildscripts/out/lilypond-login}.
+@item @uref{http://www.freetype.org/,Freetype} (version 2).
+@item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
+@item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
+@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
+(version 1.8.2 or newer), or patch 1.8.1 with
+@uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
+@item @uref{http://www.python.org,Python} (version 2.4 or newer).
+@item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
+newer. 8.50 recommended)
+@end itemize
@subsection Building documentation
You can view the documentation online at
-@uref{http://www.lilypond.org/doc/}, but you can also build it
-locally. This process requires a successful compile of lilypond. The
-documentation is built by issuing:
-@example
- make web
-@end example
+@uref{http://lilypond.org/doc/}, but you can also build it locally.
+This process requires a successful compile of lilypond. The
+documentation is built by issuing
+@quotation
+@example
+make web
+@end example
+@end quotation
-Building the website requires some additional tools:
+Building the website requires some additional tools and packages
@itemize @bullet
-@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} see
+@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
@item ImageMagick
-@item @uref{http://www.cs.uu.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
-newer),
-
- You will need to install some additional packages to get mftrace to
-work.
+@item International fonts (see input/regression/utf-8.ly for hints
+about which font packages are necessary for your platform)
+@item Ghostscript, 8.50 with the patch from
+@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
+and the patch from
+@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
@end itemize
-@section Building LilyPond
-
-To install GNU LilyPond, type:
-@example
- 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
-@end example
-
-If, in addition, you want to generate PDF files of your scores and have
-installed mftrace, type:
-@example
- make pfa-fonts
- make MAKE_PFA_FILES=1 install
- texhash
-@end example
-(PFA versions of the fonts for the latest LilyPond version can also be
-obtained from the web site using:
-@example
- mkdir /tmp/newfonts
- cd /tmp/newfonts/
- wget -l 1 -nd -r -A pfa,map http://lilypond.org/stable/mf/out/
- mv *.pfa $LILYPONDSHARE/fonts/type1/
- mv *.map $LILYPONDSHARE/dvips/
- texhash
-@end example
-where @code{$LILYPONDSHARE} denotes @code{/usr/share/lilypond/1.7.*/} or
-wherever LilyPond is installed on your system.
-
-If you are doing an upgrade, you should remove all @file{feta}
-@code{.pk} and @code{.tfm} files. A script has been provided to do the
-work for you, see @file{buildscripts/clean-fonts.sh}.
+The HTML files can be installed into the standard documentation path
+by issuing
+@quotation
+@example
+make out=www web-install
+@end example
+@end quotation
-If you are not root, you should choose a @code{--prefix} argument that
-points into your home directory, e.g.:
-@example
- ./configure --prefix=$HOME/usr
-@end example
+@section Testing LilyPond
-In this case, you have to insert the contents of
-@code{buildscripts/out/lilypond-login} or
-@code{buildscripts/out/lilypond-profile} into your start up scripts by
-hand.
+LilyPond comes with an extensive suite that excercises the entire
+program. This suite can be used to automatically check the impact of a
+change. This is done as follows
+@example
+ make test-baseline
+ @emph{## apply your changes, compile}
+ make check
+@end example
+This will leave an HTML page @file{out/test-results/index.html}. This
+page shows all the important differences that your change introduced,
+whether in the layout, MIDI, performance or error reporting.
-@subsection Configuring for multiple platforms
+To rerun tests, use
-If you want to build multiple versions of LilyPond with different
-configuration settings, you can use the @code{--enable-config=CONF}
-option of configure. You should use @samp{make conf=CONF} to generate
-the output in @file{out-CONF}. Example: Suppose I want to build with
-and without profiling. Then I'd use the following for the normal
-build:
-@c prefix=~ ?
-@example
- ./configure --prefix=$HOME/usr/ --enable-checking
- make
- make install
-@end example
+@example
+ make test-redo @emph{## redo files differing from baseline}
+ make test-clean @emph{## remove all test results}
+@end example
-and for the profiling version, I specify a different configuration:
+@noindent
+and then run @code{make check} again.
-@example
- ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
- make conf=prof
- make conf=prof install
-@end example
+For tracking memory usage as part of this test, you will need GUILE
+CVS; especially the following patch:
+@uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
+For checking the coverage of the test suite, do the following
+@example
+ ./buildscripts/build-coverage.sh
+ @emph{# uncovered files, least covered first}
+ python ./buildscripts/coverage.py --summary out-cov/*.cc
+ @emph{# consecutive uncovered lines, longest first}
+ python ./buildscripts/coverage.py --uncovered out-cov/*.cc
+@end example
-@section Emacs mode
+@section Building LilyPond
-An Emacs mode for entering music and running LilyPond is contained in
-the source archive as @file{lilypond-mode.el},
-@file{lilypond-indent.el}, @file{lilypond-font-lock.el} and
-@file{lilypond.words}. You should install these files to a directory
-included in your @var{load-path}. File @file{lilypond-init.el} should
-be placed to @var{load-path}@file{/site-start.d/} or appended to your
-@file{~/.emacs} or @file{~/.emacs.el}.
-
-As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
-to your @var{load-path}. Append the following line (modified) to your
-@file{~/.emacs}:
+To install GNU LilyPond, type
@quotation
@example
- (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
+gunzip -c lilypond-x.y.z | tar xf -
+cd lilypond-x.y.z
+./configure # run with --help for applicable options
+make
+make install
@end example
@end quotation
-
-@section Vim mode
-
-A Vim mode for entering music and running LilyPond is contained in
-the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
-to get shortcuts. Install file @file{lilypond.words} to @file{~/.vim/} to
-get auto-completion. Syntax highlighting you get by installing
-@file{lilypond.vim} to @file{~/.vim/syntax/} and appending the following
-to @file{~/.vim/filetype.vim}:
+If you are not root, you should choose a @code{--prefix} argument that
+points into your home directory, e.g.
@quotation
@example
- " my filetype file
- if exists("did_load_filetypes")
- finish
- endif
- augroup filetypedetect
- au! BufRead,BufNewFile *.ly setfiletype lilypond
- augroup
+./configure --prefix=$HOME/usr
@end example
@end quotation
+@subsection Configuring for multiple platforms
-@section Problems
-
-For help and questions use @email{lilypond-user@@gnu.org}. Please
-consult the FAQ before mailing your problems. If you find bugs, please
-send bug reports to @email{bug-lilypond@@gnu.org}.
+If you want to build multiple versions of LilyPond with different
+configuration settings, you can use the @code{--enable-config=CONF}
+option of configure. You should use @samp{make conf=CONF} to generate
+the output in @file{out-CONF}. Example: Suppose you want to build
+with and without profiling, then use the following for the normal
+build
-Bugs that are not fault of LilyPond are documented here.
+@quotation
+@example
+./configure --prefix=$HOME/usr/ --enable-checking
+make
+make install
+@end example
+@end quotation
-@subsection Linking to kpathsea
+and for the profiling version, specify a different configuration
-If kpathsea and the corresponding header files are installed in some
-directory where GCC does not search by default, for example in
-@file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
-you have to explicitly tell configure where to find it. To do this:
+@quotation
+@example
+./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
+make conf=prof
+make conf=prof install
+@end example
+@end quotation
-@itemize
-@item @code{rm config.cache}
-@item @code{export LDFLAGS=-L/usr/share/texmf/lib}
-@item @code{export CPPFLAGS=-I/usr/share/texmf/include}
-@item @code{./configure}
-@end itemize
-Once configure has found them, the paths are stored in
-@file{config.make} and will be used even if you don't have the
-environment variables set during make.
+@section Emacs mode
-@unnumberedsubsec Gcc-3.0.4
+An Emacs mode for entering music and running LilyPond is contained in
+the source archive in the @file{elisp} directory. Do @command{make
+install} to install it to @var{elispdir}. The file @file{lilypond-init.el}
+should be placed to @var{load-path}@file{/site-start.d/} or appended
+to your @file{~/.emacs} or @file{~/.emacs.el}.
+
+As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
+your @var{load-path} by appending the following line (as modified) to your
+@file{~/.emacs}
+@c any reason we do not advise: (push "~/site-lisp" load-path)
+@quotation
+@example
+(setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
+@end example
+@end quotation
-Gcc 3.0.4 is flaky; upgrade GCC.
-@unnumberedsubsec Flex-2.5.4a and gcc-3.x
+@section Vim mode
-Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
-LilyPond with gcc-3.0 you may do:
+A Vim mode for entering music and running LilyPond is contained in the
+source archive in @code{$VIM} directory.
+The LilyPond file type is detected if the file @file{~/.vim/filetype.vim} @c
+has the following content
+@quotation
@example
- CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
- make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
- patch -p1 < lexer-gcc-3.0.patch
- make conf=gcc-3.0 -C lily
+if exists("did_load_filetypes")
+ finish
+endif
+augroup filetypedetect
+ au! BufNewFile,BufRead *.ly setf lilypond
+augroup END
@end example
+@end quotation
-@unnumberedsubsec Flex-2.5.4a and gcc-3.1.x
-
-Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
-LilyPond with gcc-3.1.1 you may do:
+Please include this path by appending the following line to your
+@file{~/.vimrc}
+@quotation
@example
- CONF=gcc-3.1 ./lexer-gcc-3.1.sh
- CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
- ./configure --enable-config=gcc-3.1
- CONF=gcc-3.1 ./lexer-gcc-3.1.sh
- make conf=gcc-3.1
+set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/
@end example
+@end quotation
+@noindent
+where $@{LILYPOND_VERISON@} is your lilypond version. If Lilypond was not
+installed in @file{/usr/local/}, then change this path accordingly.
-@unnumberedsubsec OpenBSD
+@section Problems
-@itemize @bullet
-@item
- Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
-set include paths for kpathsea.
-@end itemize
+For help and questions use @email{lilypond-user@@gnu.org}. Send bug
+reports to @email{bug-lilypond@@gnu.org}.
-@unnumberedsubsec NetBSD
+Bugs that are not fault of LilyPond are documented here.
-@itemize @bullet
-@item The flex precompiled in NetBSD-1.4.2 is broken.
-Upgrade to flex-2.5.4a.
+@subsection Bison 1.875
-@item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
-release)) does not include @file{/usr/pkg} paths. Configure using:
+There is a bug in bison-1.875: compilation fails with "parse error
+before `goto'" in line 4922 due to a bug in bison. To fix, please
+recompile bison 1.875 with the following fix
+
+@quotation
@example
+$ cd lily; make out/parser.cc
+$ vi +4919 out/parser.cc
+# append a semicolon to the line containing "__attribute__ ((__unused__))
+# save
+$ make
+@end example
+@end quotation
- CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
-@end example
+@unnumberedsubsec MacOS X
-@end itemize
+For Fink, use the following command to compile.
+
+@verbatim
+export GUILE=guile-1.6
+export GUILE_CONFIG=guile-1.6-config
+export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
+./configure
+@end verbatim
@unnumberedsubsec Solaris
@file{./configure} needs a POSIX compliant shell. On Solaris7,
@file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
-is. Please run configure like:
+is. Run configure like
+@quotation
@example
CONFIG_SHELL=/bin/ksh ksh -c ./configure
@end example
-or:
+@end quotation
+or
+@quotation
@example
CONFIG_SHELL=/bin/bash bash -c ./configure
@end example
-
-@item Sparc64/Solaris 2.6, ld
-
-Not yet resolved.
-@end itemize
-
-
-@unnumberedsubsec AIX
-
-@itemize @bullet
-@item AIX 4.3 ld
-
-The following is from the gcc install/SPECIFIC file:
-@quotation
- 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.
-
- 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.
@end quotation
-add -Wl,-bbigtoc to USER_LDFLAGS, i.e.:
-@example
- LDFLAGS='-Wl,-bbigtoc' ./configure
-@end example
-
@end itemize
-
@bye
-
+
projects / lilypond.git / blobdiff