@setfilename INSTALL.info
@settitle INSTALL - compiling and installing GNU LilyPond
+@comment FIXME -- this information is getting rather stale
+
@contents
@chapter Compiling and installing on Unix
@section Downloading
Even numbered versions are `stable' (2.0, 1.8 etc), while odd version
-are development releases (1.9, 1.7 etc). Building LilyPond is an
+are development releases (2.1, 1.9, etc). Building LilyPond is an
involved process, so if possible, download a precompiled binary from
-@uref{http://www.lilypond.org/,the lilypond site}.
+@uref{http://lilypond.org/,the lilypond site}.
@subsection Source code
Download source tarballs from here:
@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.
+@uref{http://lilypond.org/download/} by HTTP.
@item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
@end itemize
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}.
+@file{buildscripts/out/clean-fonts}.
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 and 2.x are known to cause crashes.
-@item @uref{http://www.python.org,Python} (version 2.1 or newer).
-@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
+@item @uref{http://fontforge.sf.net/,FontForge} 20041211 or newer.
-@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
+@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.0 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 a 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).
distribution supports g++ 3.x and flex. For workarounds, see
lexer-gcc-3.1.sh in the source directory.
-@item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
-newer, but not 1.50 or 1.75).
-
@item @TeX{}.
@TeX{} is used as an 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). You may need to install a tetex-devel (or
-tetex-dev or libkpathsea-dev) package too.
+(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.6 or newer).
+@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.7 or newer).
-@item The
-@uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
-package for LaTeX}.
+@item kpathsea, a library for searching (@TeX{}) files.
- This package is normally included with the @TeX{} distribution.
+@item
+ @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.1 or
+newer). EGCS and 2.x are known to cause crashes.
-@item kpathsea, a library for searching (@TeX{}) files.
+@item @uref{http://www.python.org,Python} (version 2.1 or newer).
-@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
-newer),
+@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
- You will need to install some additional packages to get mftrace to
-work.
+@item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.29 or
+newer, but not 1.50 or 1.75).
+@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
@end itemize
@subsection Running requirements
following software:
@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.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{}.
-@item Xdvi and Ghostscript.
-@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
+@item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
+newer)
@end itemize
You have to help @TeX{} and MetaFont find LilyPond support
@subsection Building documentation
You can view the documentation online at
-@uref{http://www.lilypond.org/doc/}, but you can also build it
+@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:
@example
make web
@end example
-Building the website requires some additional tools:
+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
@end itemize
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}.
+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.:
@section Emacs mode
An Emacs mode for entering music and running LilyPond is contained in
-the source archive in the @file{elisp} directory. @command{make
-install} installs it @var{elispdir}. The file @file{lilypond-init.el}
+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 or, e.g., @file{~/site-lisp/}
-to your @var{load-path}. Append the following line (modified) to your
+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
@section Vim mode
-@c lilypond.words.el for vim auto-completion?
-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.el} to @file{~/.vim/} to
-get auto-completion. Syntax highlighting you get by installing files
-@file{lilypond.vim} and @file{lilypond.words.vim} to @file{~/.vim/syntax/}
-and appending the following to @file{~/.vim/filetype.vim}:
-@quotation
+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.
+
+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
+has the following content:
@example
- " my filetype file
if exists("did_load_filetypes")
- finish
+ finish
endif
augroup filetypedetect
- au! BufRead,BufNewFile *.ly setfiletype lilypond
- augroup
+ au! BufNewFile,BufRead *.ly setf lilypond
+ augroup END
+@end example
+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
+@file{~/.vimrc}:
+@example
+ set runtimepath+=/usr/local/share/vim/
@end example
-@end quotation
-
-
@section Problems
Bugs that are not fault of LilyPond are documented here.
+@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
+recompile bison 1.875 with the following fix:
+
+@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
+
@subsection Linking to kpathsea
If kpathsea and the corresponding header files are installed in some
projects / lilypond.git / blobdiff