X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Ftopdocs%2FINSTALL.texi;h=c663700030c51fedcf11dd5d11a0abc715f42e80;hb=78f563e58de2de28fd17067fd434a42cb9f055a5;hp=abb37e1de603c43bcfd9e69a5ecbb432c4d8156f;hpb=b11e28c777fdee74bbe9fce9349ea37a029a06e3;p=lilypond.git diff --git a/Documentation/topdocs/INSTALL.texi b/Documentation/topdocs/INSTALL.texi index abb37e1de6..c663700030 100644 --- a/Documentation/topdocs/INSTALL.texi +++ b/Documentation/topdocs/INSTALL.texi @@ -1,22 +1,16 @@ -@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 - -@end html +@documentencoding utf-8 +@documentlanguage en -@contents - -@chapter INSTALL - compiling and installing GNU LilyPond +@node Top +@top +@contents -This document describes how to build LilyPond on Unix platforms. It -is also known to run and compile on Windows NT/95/98/ME/XP as well. -More information on this topic can be found at the -@uref{http://www.lilypond.org/cygwin/, LilyPond on Windows page}. +@chapter Compiling and installing on Unix @html @@ -25,694 +19,279 @@ More information on this topic can be found at the @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 - If you want to compile LilyPond from source, download here: +Download source @itemize @bullet -@item Download development releases from -@c Hmm, these won't show up in lilypond.org/stats -@c Otoh, lilypond.org is not updated when release mail arrives -@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 - - -For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the -tarball; see instructions below. - -Of course, if your platform supports LilyPond, such as Debian GNU/Linux, -FreeBSD, OpenBSD or NetBSD, you're encouraged to use the native build -from source drill. - -The latest development version is also available through anonymous -CVS. See @uref{http://savannah.gnu.org/cvs/?group=lilypond}. - -CVS does not contain generated files. To create @file{configure}, run: -@quotation +@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 - ./autogen.sh +git clone git://git.sv.gnu.org/lilypond.git @end example -@end quotation - -@html - -@end html - - - -@subsection Precompiled binaries - -If you want to track bleeding edge development, try: - -@itemize @bullet -@item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian -GNU/Linux} usually has the latest binaries for the most useful stable -and development versions, while -@item @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/, -Mandrake Cooker} also provides fairly recent versions. -@end itemize -Binaries are made available for other popular platforms, but as we need -to compile them ourselves, they are not updated for every version -released. - -@itemize @bullet -@item @uref{http://www-ccrma.stanford.edu/planetccrma/software/soundapps.html#lilypond,Red Hat i386} -@item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE, SuSE} -@item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/, -LinuxPPC} -@item -@uref{http://www.lilypond.org/gnu-windows/, Windows} -@end itemize - -@subsection Upgrading - -There are two options for upgrading sources: - -@itemize -@item If you have an unpacked source tree of a previous version, you -may the patches. - -@emph{If you upgrade by patching do remember to rerun autoconf after makefilesapplying the patch}. - -@item If you have the @code{.tar.gz} file of a previous release, you can -use -@uref{http://sourceforge.net/projects/xdelta/, xdelta}. - This is much safer than using patches, and is the recommended way. - -The following command produces @file{lilypond-1.4.3.tar.gz} from -@file{lilypond-1.4.2.tar.gz} identical (up to compression dates) to the .3 -on the FTP site: +The repository does not contain generated files. To create +@file{configure}, run @example - xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz +./autogen.sh @end example @end itemize -@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/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: +In addition to the packages needed for running Lilypond (see below), +you need the following extra packages for building. -@itemize -@item The GNU c++ compiler (version 2.95.2 or newer). -EGCS 1.1 may work, but is no longer supported. -Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}. +When installing a binary package FOO, you may need to install the +FOO-devel, libFOO-dev or FOO-dev package too. -WARNING: if you choose to upgrade to GCC 3.x, enquire if your -distribution supports g++ 3.x and flex. At the time of writing (Fri -Jul 5 2002), @strong{no} distribution that we know of ships a flex -that generates gcc-3.1.x compliant C++ code. +@itemize -@item Python (version 2.1 or newer). -Check out @uref{http://www.python.org, the python website}. +@item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer. -@item GUILE (version 1.6.4 or newer). -Check out -@uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}. +@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 GNU Make (version 3.78 or newer). -Check out -@uref{ftp://ftp.gnu.org/gnu/make/, the GNU -make FTP directory}. +@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or +newer), -@item Flex (version 2.5.4a or newer). -Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}. +You will need to install some additional packages to get mftrace to +work. -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.gnu.org/software/guile/guile.html,GUILE} +(version 1.6.7 or newer). If you are installing binary packages, you +may need to install guile-devel or guile-dev or libguile-dev too. -@item Bison (version 1.25 or newer). -Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}. +@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer). -@item @TeX{}. +@item +@uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or +newer). -@TeX{} is used as an output backend. +@item @uref{http://www.python.org,Python} (version 2.3 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{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer). -@item Texinfo (version 4.2 or newer). -The documentation of lily is written in texinfo. Check out -@uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}. +@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}. -@item The geometry package for LaTeX is needed to use ly2dvi. -It is available at -@uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,the -FTP directory for @code{geometry}}. This package is normally included -with the @TeX{} distribution. +@item @uref{http://www.gnu.org/software/flex/,Flex} -@item kpathsea, a library for searching (@TeX{}) files. @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 +@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 GUILE 1.4, or newer. -Check out -@uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}. -@end itemize -For running LilyPond successfully you have to help @TeX{} and MetaFont find -various files. The recommended way of doing so is adjusting the -environment variables in the start-up scripts of your shell. Appropriate -Csh and bourne sh scripts are left in -@file{buildscripts/out/lilypond-profile} and -@file{buildscripts/out/lilypond-login} after compilation. - -LilyPond is a big and slow program. A fast CPU and plenty of RAM is -recommended for comfortable use. +@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.0 or newer). +@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/stable/Documentation/out-www/}, 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 netpbm utilities, see @uref{http://netpbm.sourceforge.net/} -@item mftrace 1.0 or newer, needed for generating PostScript Type1 -fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/mftrace/}. You -will need to install some additional packages to get mftrace to work. +@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 -@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 you are doing an upgrade, you should remove all @file{feta} -@code{.pk} and @file{.tfm} files. A script has been provided to do the -work for you, see @file{buildscripts/clean-fonts.sh}. - - -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 - -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 - -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 - -and for the profiling version, I specify a different configuration: - -@example - ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking - make conf=prof - make conf=prof install -@end example - - - +The HTML files can be installed into the standard documentation path +by issuing - -@section Emacs mode - -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}. If you have installed a precompiled LilyPond -package, these files can be found in @file{/usr/share/doc/lilypond-x.y.z/}. - -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}: @quotation @example - (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path)) +make out=www web-install @end example @end quotation -If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is -automatically loaded, you not even need to modify your @code{~/.emacs} -file. -@section Vim mode +@section Building LilyPond -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}: +To install GNU LilyPond, type @quotation @example - " my filetype file - if exists("did_load_filetypes") - finish - endif - augroup filetypedetect - au! BufRead,BufNewFile *.ly setfiletype lilypond - augroup +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 Compiling for distributions - -@subsection Red Hat Linux - - -You can compile RPMS yourself. For running on a Red Hat system you -need these packages: guile, tetex, tetex-latex, tetex-dvips, -libstdc++, python, ghostscript. A spec file is in -@file{make/out/lilypond.redhat.spec}. This file is distributed along -with the sources. You can make the rpm by issuing: -@example - cp lilypond-x.y.z.tar.gz /usr/src/redhat/SOURCES/ - tar xfz lilypond-x.y.z.tar.gz - rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec - rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z -@end example - -For compilation on a Red Hat system you need these packages, in -addition to the those needed for running: glibc-devel, gcc-c++, -libstdc++-devel, guile-devel, flex, bison, texinfo, groff, mftrace, -netpbm-progs, autotrace, t1utils. - -@subsection SuSE - -Some SUSE RPMS should available from -@uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE}. - -You can also compile a RPM for SUSE yourself. A spec file is in -@file{make/out/lilypond.suse.spec}, see the instructions for building -the Red Hat RPM. - -You must have the following packages: guile tcsh tetex te_latex te_kpath -te_mpost libpng python gpp libgpp gettext autoconf netpbm libnetpb -gs_serv gs_lib gs_fonts guile - -@subsection Slackware - -No precompiled packages for Slackware are available. - -Problems have been reported with Slackware 7.0; apparently, it ships -with a faulty compiler. Do not compile LilyPond with -O2 on this -platform. - -At least on Slackware 8.0, you have to manually specify the paths to the -Kpathsea library, see the section on kpathsea. - - -@subsection Mandrake - -Some binaries are available at rpmfind.net. Refer to -@uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/}. - -You can also compile a RPM for Mandrake yourself. A spec file is in -@file{make/out/lilypond.mandrake.spec}, see the instructions for building -the Red Hat RPM. - -@subsection Debian GNU/Linux - -A Debian package is also available. You may install it easily by running -@command{apt-get} as root: -@example - - apt-get install lilypond lilypond-doc -@end example - -You can also compile the .deb for Debian yourself, do: -@example - - apt-get -b source lilypond -@end example - -If you're real impatient, you may even do: -@example - - cd lilypond-x.y.z # a previous version - uscan # download and build latest directly from upstream -@end example - - -Debian's @TeX{} installation is a bit short on memory, you may want to -increase it like this: +If you are not root, you should choose a @code{--prefix} argument that +points into your home directory, e.g. +@quotation @example ---- texmf.cnf.orig Sun Dec 16 23:47:07 2001 -+++ texmf.cnf Sun Dec 16 23:46:34 2001 -@@ -411,8 +411,8 @@ - main_memory.context = 1500000 - main_memory.mpost = 1000000 - main_memory = 263000 % words of inimemory available; also applies to inimf&mp --extra_mem_top = 0 % extra high memory for chars, tokens, etc. --extra_mem_bot = 0 % extra low memory for boxes, glue, breakpoints, etc. -+extra_mem_top = 1000000 % extra high memory for chars, tokens, etc. -+extra_mem_bot = 1000000 % extra low memory for boxes, glue, breakpoints, etc. - - obj_tab_size.context = 300000 - -@@ -430,7 +430,7 @@ - % Max number of characters in all strings, including all error messages, - % help texts, font names, control sequences. These values apply to TeX and MP. - pool_size.context = 750000 --pool_size = 125000 -+pool_size = 250000 - % Minimum pool space after TeX/MP's own strings; must be at least - % 25000 less than pool_size, but doesn't need to be nearly that large. - string_vacancies.context = 45000 +./configure --prefix=$HOME/usr @end example +@end quotation -You could also export @env{extra_mem_top} and @env{extra_mem_bot} as -environment variables if you do not want to or cannot modify -@file{/etc/texmf/texmf.cnf}. - -Alternatively, visit: - -@itemize @bullet -@item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond} -@item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/} -for latest semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato) users. -The official stable Debian 2.2 is stuck with the old LilyPond-1.3.24. -Since LilyPond-1.4 has been released, the older lilypond1.3 Debian -package is now obsolete. -@end itemize -Please contact Anthony Fok @email{lilypond@@packages.debian.org} for more -information. +@subsection Configuring for multiple platforms -The build scripts are in the subdirectory @file{debian/}; you can -make the .deb by doing, for example: +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 +@quotation @example - $ su - root - # dpkg --purge lilypond lilypond1.3 - # exit - $ tar xzf lilypond-1.4.3.tar.gz - $ cd lilypond-1.4.3 - $ dch -p -v 1.4.3-0.local.1 "Local build." - $ debuild -B - $ su - root - # dpkg -i ../lilypond_1.4.3*.deb - # exit - $ +./configure --prefix=$HOME/usr/ --enable-checking +make +make install @end example +@end quotation -Use command @command{debuild} instead of @command{debuild -B} if you have -a very fast machine and want to build the HTML, PS and DVI documentation -too. - -For compilation on a Debian GNU/Linux system you need these packages, -in addition to the those needed for running: - -@itemize @bullet -@item g++, cpp, libc6-dev, libstdc++<@var{your-libstdc++-version-here}>-dev -@item libguile<@var{your-libguile-version-here}>-dev -@item make, m4, flex, bison -@item gettext -@item groff, texinfo -@item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev -@item dpkg-dev, debhelper, fakeroot -@item gs, netpbm -@item pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm - in Debian testing/unstable.) -@end itemize - -Most of these are listed on the @samp{Build-Depends} line in the -@file{debian/control} file. To ensure the creation of the lilypond deb is -trouble-free, we recommend that you first install the following packages -by running \@command{apt-get} as root before building the package: - -For Debian 2.2: +and for the profiling version, specify a different configuration +@quotation @example - apt-get install task-debian-devel task-c++-dev \ - python-base libguile6-dev tetex-bin tetex-dev \ - tetex-extra flex bison texinfo groff gs \ - netpbm pnmtopng m4 gettext +./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking +make conf=prof +make conf=prof install @end example +@end quotation -For Debian in development ("unstable", the future 2.3 or 3.0): - -@example - apt-get install binutils cpp gcc libc6-dev \ - g++ libstdc++2.10-dev \ - python-base libguile-dev tetex-bin libkpathsea-dev \ - tetex-extra flex bison texinfo groff gs \ - netpbm m4 gettext -@end example -And, just so that old fonts from previous versions of LilyPond won't -interfere with your build, you may want to do this before the build too: +@section Emacs mode +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 - dpkg --purge lilypond lilypond1.3 +(setq load-path (append (list (expand-file-name "~/site-lisp")) load-path)) @end example +@end quotation -@subsection MacOS X -LilyPond is available through fink, in the unstable cvs distribution. +@section Vim mode -You need to: -@itemize @bullet -@item Get the Fink package manager from @uref{http://fink.sourceforge.net}. -@item Get the LilyPond package description by enabling the "unstable" tree -in fink and executing @command{fink selfupdate-cvs}. -@end itemize +A Vim mode for entering music and running LilyPond is contained in the +source archive in @code{$VIM} directory. -Then do: +The LilyPond file type is detected if the file @file{~/.vim/filetype.vim} @c +has the following content @quotation @example - fink install lilypond-unstable +if exists("did_load_filetypes") + finish +endif +augroup filetypedetect + au! BufNewFile,BufRead *.ly setf lilypond +augroup END @end example @end quotation -That's it! The command should compile and install all LilyPond -prerequisites (python, TeX, X11, ghostscript) and then LilyPond -itself. - - -@subsection Compiling on MacOS X -LilyPond has been built on Darwin, to be precise, on: -@example - Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24 - 22:06:02 PST 2002; root:xnu/xnu-201.19.obj~1/RELEASE_PPC Power Macintosh powerpc -@end example - -using: +Please include this path by appending the following line to your +@file{~/.vimrc} +@quotation @example - Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release) +set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/ @end example +@end quotation -To make sure you have all packages needed to build LilyPond installed, -run as root: - -@example - apt-get install bash python guile debianutils flex bison texinfo \ - ghostscript6 netpbm m4 gettext -@end example - -and: - -@example - fink install tetex -@end example - -For more information about @file{apt-get} and @file{fink}, see -@uref{http://fink.sf.net,fink.sourceforge.net}. - -@c brokenness of autoconf; don't ask -Then, configure, patch, make and install LilyPond using these commands: - -@example - CC="cc -I/sw/include" CXX="c++ -I/sw/include" LDFLAGS="-L/sw/lib" \ - ./configure --prefix=/sw - make -C lily out/parser.hh out/parser.cc out/config.h - patch -p0 < darwin.patch - make -C lily out/parser.o - make DEPENDENCIES_OUTPUT=/dev/null all - make install -@end example +@noindent +where $@{LILYPOND_VERISON@} is your lilypond version. If Lilypond was not +installed in @file{/usr/local/}, then change this path accordingly. -For installing, you must be root, of course. -@c Why isn't this in BUGS (where it belongs?) @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}. +For help and questions use @email{lilypond-user@@gnu.org}. Send bug +reports to @email{bug-lilypond@@gnu.org}. Bugs that are not fault of LilyPond are documented here. -@subsection Linking to kpathsea +@subsection Bison 1.875 -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 - -Gcc 3.0.4, is a bit flaky. Try downgrading to 2.95.x, or if you're -adventurous (see below), upgrading to 3.1.x. - -@unnumberedsubsec Flex-2.5.4a and gcc-3.x - -Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile -LilyPond with gcc-3.0 you may do: - -@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 -@end example - -Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13. - -@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: - -@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 - -This assumes that the GCC 3.1 binaries are called gcc-3.1 and g++-3.1. -Note that this is @strong{not} fixed in Debian/unstable for flex <= -2.5.4a-26. - -@unnumberedsubsec Linux-2.4.0, Guile-1.4 --with-threads - -There's a bug in certain kernels around version 2.4.0, that is -triggered when using Guile 1.4 compiled with pthreads. You'll see -random segmentation fault crashes of LilyPond. Upgrade to a newer -version of Linux. If you can't do that, you may try to recompiling -Guile without threads (YMMV): +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 - guile-1.4$ ./configure --without-threads; make all install +$ 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 -@unnumberedsubsec OpenBSD - -@itemize @bullet -@item By default, gcc on OpenBSD doesn't include -@file{/usr/local/include} and @file{/usr/local/lib} in the system -paths. Depending upon where/how you installed kpathsea and other -libraries, you may need to refer to the section ``Linking to -kpathsea''. - -@end itemize - -@unnumberedsubsec NetBSD - -@itemize @bullet -@item The flex precompiled in NetBSD-1.4.2 is broken. -Download flex-2.5.4a, build, install. -@item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1 -release)) does not include @file{/usr/pkg} paths. Configure using: -@example +@unnumberedsubsec MacOS X - CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure +For Fink, use the following command to compile. -@end example - -@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 @@ -721,52 +300,20 @@ release)) does not include @file{/usr/pkg} paths. Configure using: @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, GNU make-3.77 - -GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer. - -@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 - +