@setfilename INSTALL.info
@settitle INSTALL - compiling and installing GNU LilyPond
+@documentencoding utf-8
+@documentlanguage en
+
@node Top
@top
@section Downloading
-Even numbered minor versions are `stable' (2.2, 2.4 etc), while odd
-version are development releases (2.3, 2.5, etc). Building LilyPond
-is an involved process. If possible, from
-@uref{http://lilypond.org/download,download a precompiled binary}
-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
@itemize @bullet
@item tarballs from
-@itemize @bullet
@uref{http://lilypond.org/download/} by HTTP.
-@item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
-@end itemize
+@item tarballs from
+@uref{http://download.linuxaudio.org/lilypond/} by HTTP.
@item
-CVS from @uref{http://savannah.gnu.org/cvs/?group=lilypond,savannah.gnu.org}
-@itemize @bullet
-@c @quotation
+GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
@example
-CVS_RSH=ssh cvs -d:ext:anoncvs@@savannah.gnu.org:/cvsroot/lilypond co lilypond
+git clone git://git.sv.gnu.org/lilypond.git
@end example
-@c @end quotation
-The CVS repository does not contain generated files. To create
+
+The repository does not contain generated files. To create
@file{configure}, run
@example
./autogen.sh
@end example
@end itemize
-@end itemize
For information on packaging, see @uref{http://lilypond.org/devel}.
@subsection Precompiled binary packages
-Check out @uref{http://lilypond.org/download} for up to date information on
-binary packages for your platform.
-
-
-@subsection Font problems
-
-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/out/clean-fonts}.
+Check out @uref{http://lilypond.org/web/install/} for up to date
+information on binary packages for your platform.
@section Requirements
@itemize
-@item @uref{http://fontforge.sf.net/,FontForge} 20041211 or newer.
+@item @uref{http://fontforge.sf.net/,FontForge} 20060125 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}
-@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.0 or
+@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
newer),
You will need to install some additional packages to get mftrace to
work.
@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
-(version 1.6.5 or newer). If you are installing binary packages, you
+(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.
-@item @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
-
-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.1.sh in the source directory.
-
-@item @TeX{}.
-
-@TeX{} is used as an optional output backend.
-
-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). If you are installing binary packages, you
-may need to install tetex-devel, tetex-dev or libkpathsea-dev too.
-
-
-@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.7 or newer).
+@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
@item
- @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.1 or
-newer). EGCS and 2.x are known to cause crashes.
+@uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
+newer).
-@item @uref{http://www.python.org,Python} (version 2.1 or newer).
+@item @uref{http://www.python.org,Python} (version 2.3 or newer)
@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
+@item @uref{http://www.gnu.org/software/flex/,Flex}
+
+@item @uref{http://www.perl.org/,Perl}
+
+@item @uref{http://www.gnu.org/software/flex/,GNU Bison}
+
@item All packages required for running, including development packages with
header files and libraries.
@itemize @bullet
@item @uref{http://www.freetype.org/,Freetype} (version 2).
-@item @uref{http://www.pango.org/,Pango} (version 1.6 or newer).
+@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.6.5 or newer).
-@item @uref{http://www.python.org,Python} (version 2.1 or newer).
-@item @TeX{}.
+(version 1.8.2 or newer), or patch 1.8.x 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).
+newer. 8.50 recommended)
@end itemize
-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}.
-
@subsection Building documentation
You can view the documentation online at
Building the website requires some additional tools and packages
@itemize @bullet
-@item @uref{http://lilypond.org/download/fonts,ec-fonts-mftraced}
@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
@item ImageMagick
+@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
The HTML files can be installed into the standard documentation path
@end example
@end quotation
+@section Testing LilyPond
+
+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, the MIDI output, or error reporting.
+
+To rerun tests, use
+
+@example
+ make test-clean @emph{## remove files differing from baseline}
+ make test-real-clean @emph{## remove all test results}
+@end example
+
+@noindent
+and then run @code{make check} again.
+
@section Building LilyPond
./configure # run with --help for applicable options
make
make install
-sh buildscripts/clean-fonts.sh
-@end example
-@end quotation
-
-The most time-consuming part of compiling LilyPond is tracing the
-Type1 fonts. You can shortcut this operation by issuing
-one of the following commands
-
-@quotation
-@example
-make -C mf get-pfa # requires rpm2cpio
-make -C mf get-debian-pfa # may not be up to date
@end example
@end quotation
-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/out/clean-fonts}.
-
If you are not root, you should choose a @code{--prefix} argument that
points into your home directory, e.g.
@quotation
@end example
@end quotation
-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.
-
-
@subsection Configuring for multiple platforms
@section Vim mode
A Vim mode for entering music and running LilyPond is contained in the
-source archive in @code{$VIM} directory. For version 6.2 and newer,
-Vim-mode works directly after installing LilyPond. Otherwise,
-complete the following two steps.
+source archive in @code{$VIM} directory.
-For earlier versions (and if @code{$VIM} environment variable does not
-fall-back to @file{/usr/local/share/vim}, see @code{:version} in vim),
-the LilyPond file type is detected if your file @file{~/.vim/filetype.vim} @c
+The LilyPond file type is detected if the file @file{~/.vim/filetype.vim} @c
has the following content
@quotation
@example
augroup END
@end example
@end quotation
-If Vim has been (pre-)installed to @file{/usr/...} (or any other place)
-instead of @file{/usr/local/...}, then @file{/usr/local/share/vim} may not
-be specified in your @code{$VIMRUNTIME} environment variable and you have to
-include this path explicitly by appending the following line to your
+
+Please include this path by appending the following line to your
@file{~/.vimrc}
+
@quotation
@example
-set runtimepath+=/usr/local/share/vim/
+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.
+
+
@section Problems
For help and questions use @email{lilypond-user@@gnu.org}. Send bug
@subsection Bison 1.875
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, either
+before `goto'" in line 4922 due to a bug in bison. To fix, please
recompile bison 1.875 with the following fix
@quotation
@end example
@end quotation
-@subsection Linking to kpathsea
-
-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
-
-@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.
-
-@unnumberedsubsec Gcc-3.0.4
+@unnumberedsubsec MacOS X
-Gcc 3.0.4 is flaky; upgrade GCC.
+For Fink, use the following command to compile.
-@unnumberedsubsec Flex-2.5.4a and gcc-3.x
-
-Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
-LilyPond with gcc-3.1.1 or higher you may do
-
-@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
-@end example
-@end quotation
-
-
-@unnumberedsubsec OpenBSD
-
-@itemize @bullet
-@item
-Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
-set include paths for kpathsea.
-@end itemize
-
-@unnumberedsubsec NetBSD
-
-@itemize @bullet
-@item The flex precompiled in NetBSD-1.4.2 is broken.
-Upgrade to flex-2.5.4a.
-@end itemize
+@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
projects / lilypond.git / blobdiff