X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Ftopdocs%2FINSTALL.texi;h=afff3cc621385f36ec4e8145ef0a92dc7b957235;hb=4ba76f3ddd8f927febb9a303cee4837499a8b2da;hp=623ece58d5481fb86a28de994344d48cff72260c;hpb=7646cf1f71cbd2db91b5450aff30889614d0dae0;p=lilypond.git diff --git a/Documentation/topdocs/INSTALL.texi b/Documentation/topdocs/INSTALL.texi index 623ece58d5..afff3cc621 100644 --- a/Documentation/topdocs/INSTALL.texi +++ b/Documentation/topdocs/INSTALL.texi @@ -1,7 +1,12 @@ -\input texinfo @c -*-texinfo-*- +@node +@comment node-name, next, previous, up\input texinfo @c -*-texinfo-*- @setfilename INSTALL.info @settitle INSTALL - compiling and installing GNU LilyPond +@html + +@end html + @node Top, , , (dir) @top @@ -28,12 +33,13 @@ servers}. Big enhancements go into the latest odd numbered version (1.3), whose webpages are on @uref{http://www.lilypond.org/,the lilypond site}. -@subsection source code - +@subsection Source code If you want to compile LilyPond from source, download here: @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.cs.uu.nl/pub/GNU/LilyPond/} by FTP and @uref{http://ftp.cs.uu.nl/pub/GNU/LilyPond/}, by HTTP. @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror) @@ -42,24 +48,42 @@ If you want to compile LilyPond from source, download here: @uref{http://www.lilypond.org/ftp/} by HTTP. @end itemize +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. + +For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the +tarball; see instructions below. + @html @end html -@subsection Binaries +@subsection Precompiled binaries + +If you want to track bleeding edge development, try: -Binaries are available, but are not updated for every version released. @itemize @bullet -@item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, Red Hat i386} -@item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/, LinuxPPC} -@item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian GNU/Linux} -@item @uref{http://home.austin.rr.com/jbr/jeff/lilypond/, Windows Stable} -@c @item @uref{ftp://ftp.lilypond.org/pub/lilypond/gnu-windows, Windows -@c Testing} -@uref{http://www.lilypond.org/gnu-windows/, Windows Testing} +@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{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, 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 @@ -93,13 +117,14 @@ on the FTP site. You need the following packages to compile Lilypond. @itemize -@item A reasonably new C++ compiler: EGCS 1.1, GCC 2.95.2 or +@item A reasonably new version of the GNU C++ compiler: EGCS 1.1, GCC 2.95.2 or newer. Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}. -@item Python 1.5, +@item Python (version 1.5 or newer). Check out @uref{http://www.python.org, the python website}. -@item GUILE 1.3.4 or newer, check out +@item GUILE (version 1.4 or newer). +Check out @uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}. Version 1.4 is recommended for better performance. @@ -132,14 +157,6 @@ It is available at FTP directory for @code{geometry}}. This package is normally included with the @TeX{} distribution. -@item MetaPost, needed for generating PostScript fonts. Please -note that tetex-0.4pl8 (included with Red Hat 5.x) does not include -@file{mfplain.mp}, which is needed for producing the scalable font -files. - -If you don't have MetaPost and don't want to use PostScript output, then -edit @file{mf/GNUmakefile}, removing the line saying @code{PFA_FILES=}. - @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. @@ -154,6 +171,11 @@ configure something like: ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols @end example + +@item pktrace, [OPTIONAL], needed for generating PostScript Type1 +fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/pktrace/}. You +will need to install some additional packages to get pktrace to work. + @end itemize @subsection Running requirements @@ -203,16 +225,6 @@ at @uref{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz,in the pnmtopng FTP site}. -@item @uref{http://www.lri.fr/~filliatr/ftp/bibtex2html/, Bibtex2html}, or -@uref{http://www.uni-koblenz.de/ag-ki/ftp/bib2html/, Bib2html}. -Bibtex2html is available in debian, while bib2html is in some rpm based -distributions. -Bib2html, in turn depends on man2html for proper installation. -man2html can be had from @uref{http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05,http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05}. - -The website will build without bib converter utility, but you will not -see our hypertextified bibliography. - @item texinfo (a development release) The documentation will build with texinfo-4.0, but if you want split html pages, you're best off using the lates pretest version from @@ -283,13 +295,18 @@ and for the profiling version, I specify a different configuration. @section Emacs mode -An emacs mode for LilyPond is included with the source archive as -@file{lilypond-mode.el} and @file{lilypond-font-lock.el}. If you have -an RPM, it is in @file{/usr/share/doc/lilypond-X/}. You have to install -it yourself. +An Emacs mode for entering music and running LilyPond is included with +the source archive as @file{lilypond-mode.el} and +@file{lilypond-font-lock.el}. You should install these files somewhere +in your @var{load-path}. If you have installed a precompiled LilyPond +package, these files can be found in +@file{/usr/share/doc/lilypond-x.y.z/}. + +Add this to your @file{~/.emacs} or @file{~/.emacs.el}, or install this +file in Emacs' @file{site-start.d}: +@example + ;;; lilypond-init.el --- Startup code for LilyPond mode -Add this to your @file{~/.emacs} or @file{~/.emacs.el}: -@example (load-library "lilypond-mode.el") (setq auto-mode-alist (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist)) @@ -297,7 +314,8 @@ Add this to your @file{~/.emacs} or @file{~/.emacs.el}: @end example If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is -automatically loaded, so you need not modify your @code{~/.emacs} file. +automatically loaded, you not even need to modify your @code{~/.emacs} +file. @section Compiling for distributions @@ -307,12 +325,12 @@ Red Hat 7.0 i386 RPMS are available from @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}. You can also compile them yourself. A spec file is in -@file{make/out/redhat.spec}. This file is distributed along with the -sources. You can make the rpm by issuing +@file{make/out/lilypond.redhat.spec}. This file is distributed along +with the sources. You can make the rpm by issuing @example tar xfz lilypond-x.y.z.tar.gz - rpm -bb lilypond-x.y.z/make/out/redhat.spec + rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z @end example @@ -322,16 +340,9 @@ tetex-latex, tetex-dvips, libstdc++, python, ghostscript. 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, tetex-devel, groff, -libgr-progs. +guile-devel, flex, bison, texinfo, groff, pktrace. -@b{Warning} - -There appears to be a problem with the Xdvi shipped with Red Hat 7.1. -Symptoms: Xdvi responds very sluggishly or hangs while viewing -lilypond output. The cause for this problem is unknown; you are advised -to recompile Xdvi from source. @subsection LinuxPPC @@ -339,16 +350,16 @@ to recompile Xdvi from source. Some LinuxPPC RPMS should available from @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}. -A LinuxPPC RPM can be made using the @file{redhat.spec} file. +A LinuxPPC RPM can be made using the @file{lilypond.redhat.spec} file. @subsection SuSE Some SUSE RPMS should available from -@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}. +@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/suse.spec}, see the instructions for building the Red Hat -RPM. +@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 @@ -365,35 +376,60 @@ platform. @subsection Mandrake Some binaries are available at rpmfind.net. Refer to -@uref{ftp://ftp.rpmfind.net/linux/Mandrake-devel/cooker/contrib/RPMS/}. +@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: @example ---- /etc/texmf/texmf.cnf.dpkg Sun Jan 28 14:12:14 2001 -+++ /etc/texmf/texmf.cnf Fri Apr 27 11:09:35 2001 -@@ -384,8 +384,8 @@ +--- 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 = 100000 % extra high memory for chars, tokens, etc. -+extra_mem_bot = 100000 % 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 = 256000 - + 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 @end example You could also export @env{extra_mem_top} and @env{extra_mem_bot} as @@ -444,7 +480,6 @@ in addition to the those needed for running: @item make, m4, flex, bison @item gettext @item groff, texinfo -@item bibtex2html (not in Debian 2.2) @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev @item dpkg-dev, debhelper, fakeroot @item gs, netpbm @@ -469,9 +504,10 @@ For Debian 2.2: For Debian in development ("unstable", the future 2.3 or 3.0): @example - apt-get install task-debian-devel task-c++-dev \ - python-base libguile9-dev tetex-bin libkpathsea-dev \ - tetex-extra flex bison texinfo bibtex2html groff gs \ + 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 @@ -482,17 +518,93 @@ interfere with your build, you may want to do this before the build too: dpkg --purge lilypond lilypond1.3 @end example +@subsection 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: + +@example + Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release) +@end example + +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 + +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{help-gnu-music@@gnu.org} and -@email{gnu-music-discuss@@gnu.org}. Please consult the FAQ before -mailing your problems. If you find bugs, please send bug reports to -@email{bug-gnu-music@@gnu.org}. +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}. Bugs that are not fault of LilyPond are documented here. +@unnumberedsubsec FLex-2.5.4a and gcc-3.0 + +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 Python-2.1[.1] + +Regular expressions are broken in Python 2.1.[.1], either upgrade or +downgrade python. + +@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): + +@example + guile-1.4$ ./configure --without-threads; make all install +@end example + + @unnumberedsubsec NetBSD @itemize @bullet