X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=INSTALL.txt;h=09be506e995f928b8332a23c1bdee4f0579d6ef4;hb=7cf608d94950fc22c3ec60a72a2efba69b8d396d;hp=d1baab30154dbd207a9e74837151ac930fb97686;hpb=2059367f59496fb11796bd2cf239f6b58625231e;p=lilypond.git diff --git a/INSTALL.txt b/INSTALL.txt index d1baab3015..09be506e99 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,330 +1,486 @@ +INSTALL - compiling and installing GNU LilyPond +*********************************************** +Table of Contents +***************** +INSTALL - compiling and installing GNU LilyPond + Precompiled binaries + Downloading + Compiling from source + Downloading source code + Requirements + Compilation + Running requirements + Requirements for building documentation + Building LilyPond + Compiling + Compiling for multiple platforms + Compiling outside the source tree + Useful `make' variables + Building documentation + Commands for building documentation + Building documentation without compiling LilyPond + Testing LilyPond + Problems + Bison 1.875 + Solaris + FreeBSD + International fonts -INSTALL(1) LilyPond documentation INSTALL(1) +There are two sets of releases for LilyPond: stable releases, and +unstable development releases. Stable versions have an even-numbered +`minor' version number (i.e. 2.8, 2.10, 2.12, etc). Development +versions have an odd-numbered `minor' version number (i.e. 2.7, 2.9, +2.11, etc). -NAME - INSTALL - installing GNU LilyPond + Building LilyPond is a very involved process, so we *highly* +recommend using the precompiled binaries. -DESCRIPTION - This page documents installation and compilation of GNU - LilyPond +Precompiled binaries +==================== -ABSTRACT - You do something which looks remotely like +Downloading +----------- - configure - make - make install +Check out `http://lilypond.org/web/install/' for up to date information +on binary packages for your platform. If your operating system is not +covered on that general page, please see the complete list at +`http://download.linuxaudio.org/lilypond/binaries/' - The detailed instructions follow here. + We currently create binaries for -PREREQUISITES - For compilation you need. + darwin-ppc - MacOS X powerpc + darwin-x86 - MacOS X intel + freebsd-64 - FreeBSD 6.x, x86_64 + freebsd-x86 - FreeBSD 4.x, x86 + linux-64 - Any GNU/Linux distribution, x86_64 + linux-ppc - Any GNU/Linux distribution, powerpc + linux-x86 - Any GNU/Linux distribution, x86 + mingw - Windows x86 - o A GNU system: GNU LilyPond is known to run on these - GNU systems: Linux (PPC, intel), FreeBSD, AIX, - NeXTStep, IRIX, Digital Unix and Solaris. - If you have the Cygnus WINDOWS32 port of the GNU - utils, it will even work in Windows NT/95, but we - don't promise to support it. +Known issues and warnings +......................... - o GNU C++ version 2.7 or newer (yes, 2.8 is fine). +If you have MacOS 10.3 or 10.4 and you would like to use Python scripts +such as `convert-ly' and `lilypond-book', see *note Setup for MacOS X: +(lilypond-program)Setup for MacOS X. - o Python +Compiling from source +===================== -RUNNING - GNU LilyPond does use a lot of resources. For operation - you need the following: +Downloading source code +----------------------- - o TeX +Download source - o A PostScript printer and/or viewer (such as - Ghostscript) is strongly recommended. Xdvi will show - all embedded PostScript too if you have Ghostscript - installed. + * tarballs from `http://lilypond.org/download/' by HTTP. -RECOMMENDED - Although not strictly necessary, these are recommended to - have. + * tarballs from `http://download.linuxaudio.org/lilypond/' by HTTP. - o GNU make. + * GIT from git.sv.gnu.org + (http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary) - o Flex (version 2.5.4 or newer). + git clone git://git.sv.gnu.org/lilypond.git - o Bison (version 1.25 or newer). + The repository does not contain generated files. To create + `configure', run + ./autogen.sh - o Perl-5. Most documentation was created with the - perl's Plain Old Documentation. (I use 5.003) + For information on packaging, see `http://lilypond.org/devel'. +Requirements +------------ +Compilation +........... -25/Apr/98 LilyPond 0.1.59 1 +In addition to the packages needed for running LilyPond (see below), you +need the following extra packages for building. + When installing a binary package FOO, you may need to install the +FOO-devel, libFOO-dev or FOO-dev package too. + * FontForge (http://fontforge.sf.net/) 20060125 or newer. + * MetaFont (http://metafont.tutorial.free.fr/) (mf-nowin, mf, mfw or + mfont binaries) and MetaPost + (http://cm.bell-labs.com/who/hobby/MetaPost.html) (mpost binary), + usually packaged with a LaTeX distribution like tetex or texlive. + * t1utils (http://www.lcdf.org/~eddietwo/type/#t1utils) (version + 1.33 or newer recommended). -INSTALL(1) LilyPond documentation INSTALL(1) + * New Century Schoolbook fonts, as PFB files. These are shipped with + X11 and Ghostscript, and are named `c059033l.pfb' `c059036l.pfb', + `c059013l.pfb' and `c059016l.pfb'. + * GUILE (http://www.gnu.org/software/guile/guile.html) (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. - o Python. Although perl is nice, python is better. We - will shift towards python for build scripts + * Texinfo (ftp://ftp.gnu.org/gnu/texinfo/) (version 4.11 or newer). - o GNU find + * The GNU c++ compiler (http://gcc.gnu.org/) (version 3.4 or newer. + 4.x is strongly recommended). - o A fast computer (a full page of music typically takes - 1 minute on my 486/133, using the --enable-checking - compile. It's lot slower than most MusiXTeX - preprocessors) + * Python (http://www.python.org) (version 2.4 or newer) -CONFIGURING and COMPILING - to install GNU LilyPond, simply type: + * GNU Make (ftp://ftp.gnu.org/gnu/make/) (version 3.78 or newer). - configure - make - make install + * gettext (http://www.gnu.org/software/gettext/gettext.html) + (version 0.17 or newer). - This will install the following files: + * Flex (http://www.gnu.org/software/flex/). - /usr/local/man/man1/mi2mu.1 - /usr/local/man/man1/convert-mudela.1 - /usr/local/man/man1/mudela-book.1 - /usr/local/man/man1/lilypond.1 - /usr/local/lib/libflower.{so,a} - /usr/local/bin/lilypond - /usr/local/bin/mi2mu - /usr/local/share/lilypond/* - /usr/lib/texmf/texmf/tex/lilypond/* + * Perl (http://www.perl.org/). - The TeX include directory is detected dynamically, but it - can be adjusted with --enable-tex-prefix and --enable-tex- - dir. The above assumes that you are root and have the GNU - development tools, and your make is GNU make. If this is - not the case, you can adjust your environment variables to - your taste: + * GNU Bison (http://www.gnu.org/software/bison/). - export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR" - configure + * All packages required for running, including development packages + with header files and libraries. - CPPFLAGS are the preprocessor flags. - the configure script is Cygnus configure, and it will - accept --help. If you are not root, you will probably have - to make it with +Running requirements +.................... - configure --prefix=/home/me_myself_and_I/ +Running LilyPond requires proper installation of the following software - In this case, you will have to set MFINPUTS, and TEXINPUTS - accordingly. + * Freetype (http://www.freetype.org/) (version 2.1.10 or newer). - If you want to install GNU LilyPond in /usr/local, and - your TeX has no default hooks for local stuff (mine is - broken too), you can do: + * FontConfig (http://fontconfig.org/) (version 2.2 or newer). + * Pango (http://www.pango.org/) (version 1.12 or newer). + * GUILE (http://www.gnu.org/software/guile/guile.html) (version + 1.8.2 or newer), or patch 1.8.1 with + `http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch'. + * Python (http://www.python.org) (version 2.4 or newer). -25/Apr/98 LilyPond 0.1.59 2 + * Ghostscript (http://www.ghostscript.com) (version 8.15 or newer. + 8.60 recommended) + * Dejaview. (This is normally installed by default) + International fonts are required to create music with international +text or lyrics. +Requirements for building documentation +....................................... +You can view the documentation online at `http://lilypond.org/doc/', +but you can also build it locally. This process requires a successful +compile of LilyPond, and some additional tools and packages: -INSTALL(1) LilyPond documentation INSTALL(1) + * The netpbm utilities (http://netpbm.sourceforge.net/) + * ImageMagick - configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf + * International fonts (see input/regression/utf-8.ly for hints about + which font packages are necessary for your platform) - Since GNU LilyPond currently is beta, you are advised to - also use + * Ghostscript 8.60 or newer, or 8.50 with the patch from + `http://bugs.ghostscript.com/show_bug.cgi?id=688154' and the patch + from `http://bugs.ghostscript.com/show_bug.cgi?id=688017'. - --enable-debugging - --enable-checking + * Texi2HTML (http://www.nongnu.org/texi2html/) 1.80 or newer - other options include: + * rsync - --enable-shared - Make a shared library (gnu/linux, solaris (?) only ) +Building LilyPond +----------------- - --enable-printing - Enable debugging print routines (lilypond -d option) +Compiling +......... - --enable-optimise - Set maximum optimisation: compile with -O2 +To install GNU LilyPond, type - --enable-profiling - Compile with support for profiling + gunzip -c lilypond-x.y.z | tar xf - + cd lilypond-x.y.z + ./configure # run with --help for applicable options + make + su -c 'make install' - --enable-tex-prefix - Set the directory where TeX and Metafont live +If you are not root, you should choose a `--prefix' argument that +points into your home directory, e.g. - --enable-tex-dir - Set then directory TeX input is in (detected as a - subdir of tex-prefix) + ./configure --prefix=$HOME/usr - --enable-mf-dir - Set the directory mf input is in (idem) +Compiling for multiple platforms +................................ - --enable-config - Output to different configuration files. Needed for - multi-platform builds +If you want to build multiple versions of LilyPond with different +configuration settings, you can use the `--enable-config=CONF' option +of `configure'. You should use `make conf=CONF' to generate the output +in `out-CONF'. For example, suppose you want to build with and without +profiling, then use the following for the normal build - All options are documented in the configure help The - option --enable-optimise is recommended for Real Life - usage. + ./configure --prefix=$HOME/usr/ --enable-checking + make + make install - If you do + and for the profiling version, specify a different configuration - make all + ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking + make conf=prof + make conf=prof install - everything will be compiled, but nothing will be - installed. The resulting binaries can be found in the - subdirectories out/ (which contain all files generated - during compilation). +Compiling outside the source tree +................................. -CONFIGURING FOR MULTIPLE PLATFORMS - If you want to compile LilyPond with different - configuration settings, then, you can use the --enable- - config option. Example: suppose I want to build with and - without profiling. Then I'd use the following for the +It is possible to compile LilyPond in a build tree different from the +source tree, with `--srcdir' option of `configure': + mkdir lily-build && cd lily-build + SOURCEDIR/configure --srcdir=SOURCEDIR +Useful `make' variables +....................... -25/Apr/98 LilyPond 0.1.59 3 +If a less verbose build output if desired, the variable `QUIET_BUILD' +may be set to `1' on `make' command line, or in `local.make' at top of +the build tree. +Building documentation +---------------------- +This requires a successful compile of LilyPond, or using an external +LilyPond binary. +Commands for building documentation +................................... +The documentation is built by issuing -INSTALL(1) LilyPond documentation INSTALL(1) + make doc + After compilation, the HTML documentation tree is available in +`out-www/offline-root/', and can be browsed locally. - normal build, + The HTML, PDF and if available Info files can be installed into the +standard documentation path by issuing - configure --prefix=~ --disable-optimise --enable-checking - make - make install + make install-doc - and for the profiling version, I specify a different - configuration. +This also installs Info documentation with images if the installation +prefix is properly set; otherwise, instructions to complete proper +installation of Info documentation are printed on standard output. - configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking - make configuration=optprof - make configuration=optprof install + Compilation of documentation in Info format with images can be done +separately by issuing + make info -INSTALLING - If you have done a successful make, then a simple +Separate installation of this documentation is done by issuing - make install + make install-info - should do the trick. +Note that to get the images in Info documentation, `install-doc' target +creates symbolic links to HTML and PDF installed documentation tree in +`PREFIX/share/info', in order to save disk space, whereas +`install-info' copies images in `PREFIX/share/info' subdirectories. - If you are doing an upgrade, please remember to remove - obsolete .pk and .tfm files of the fonts. A script has - been provided to do the work, see bin/clean-fonts.sh. + It is possible to build a documentation tree in +`out-www/online-root/', with special processing, so it can be used on a +website with content negotiation for automatic language selection; this +can be achieved by issuing -CAVEATS - o The -O2 option to gcc triggers a gcc bug on DEC Alpha - in dstream.cc. You should turn off this flag for this - file. + make WEB_TARGETS=online doc - o Perl5.003 and Perl5.004 use different syntax for - pod2html. +and both `offline' and `online' targets can be generated by issuing -EXAMPLE - This is what I type in my xterm: + make WEB_TARGETS="offline online" doc - lilypond someinput.ly - tex someinput.tex - xdvi someinput& + Several targets are available to clean the documentation build and +help with maintaining documentation; an overview of these targets is +available with - This is what the output looks like over here: + make help - GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0 - Parsing ... [/home/hw/share/lilypond/init// - <..etc..> - init//performer.ly]]][input/kortjakje.ly] - Creating elements ...[8][16][24][25] - Preprocessing elements... - Calculating column positions ... [14][25] - Postprocessing elements... - TeX output to someinput.tex ... - Creating MIDI elements ...MIDI output to someinput.midi ... +from every directory in the build tree. Most targets for documentation +maintenance are available from `Documentation/'; for more information, +see the Contributors' Guide, section _Documentation work_. + The makefile variable `QUIET_BUILD' may be set to `1' for a less +verbose build output, just like for building the programs. +Known issues and warnings +......................... -25/Apr/98 LilyPond 0.1.59 4 +The most time consuming task for building the documentation is running +LilyPond to build images of music, and there cannot be several +simultaneously running `lilypond-book' instances, so `-j' `make' option +does not significantly speed up the build process. To help speed it +up, the makefile variable CPU_COUNT may be set in `local.make' or on +the command line to the number of `.ly' files that LilyPond should +process simultaneously, e.g. on a bi-processor or dual core machine + make -j3 CPU_COUNT=3 doc +The recommended value of CPU_COUNT is one plus the number of cores or +processors, but it is advisable to set it to a smaller value if your +system has not enough RAM to run that many simultaneous LilyPond +instances. + If source files have changed since last documentation build, output +files that need to be rebuilt are normally rebuilt, even if you do not +run `make doc-clean' first. However, building dependencies in the +documentation are so complex that rebuilding of some targets may not be +triggered as they should be; a workaround is to force rebuilding by +touching appropriate files, e.g. + touch Documentation/user/*.itely + touch input/lsr/*.ly -INSTALL(1) LilyPond documentation INSTALL(1) +Building documentation without compiling LilyPond +................................................. +The documentation can be built locally without compiling LilyPond +binary, if LilyPond is already installed on your system. - hw:~/musix/spacer$ xdvi someinput& - [1] 855 + From a fresh Git checkout, do - Check out the input files, some of them have comments - Please refer to the man page for more information. + ./autogen.sh # ignore any warning messages + cp GNUmakefile.in GNUmakefile + make -C python + nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc -REDHAT LINUX - RedHat Linux users should be able to get a RPM. A spec - file is in make/out/lilypond.spec. You should be able to - create an rpm as a normal user. Be sure you have a - ~/.rpmrc, and edit the RPM-dir in Variables.make. (If you - create the RPM as a normal user the permissions will not - be set correctly, unfortunately) + Please note that this may break sometimes - for example, if a new +feature is added with a test file in input/regression, even the latest +development release of LilyPond will fail to build the docs. -DEBIAN GNU/LINUX - A Debian package is also available; contact Anthony Fok - . The build scripts are in the - subdirectory debian/ + You may build the manual without building all the `input/*' stuff: +change directory, for example to `Documentation/user', issue `make +doc', which will build documentation in a subdirectory `out-www' from +the source files in current directory. In this case, if you also want +to browse the documentation in its post-processed form, change back to +top directory and issue -WINDOWS NT/95 - So, you're stuck with Windows, eh? Well, don't worry, you - just need (to get) Cygnus' windows32 port of gnu - development stuff; have a look at - http://www.cygnus.com/gnu-win32. + make out=www WWW-post - To make GNU LilyPond under, brr, aargh, shudder... - windows32, well, simply type: - bash configure - make +Known issues and warnings +......................... - Note If you rely on broken DOS/Windows tools such as - pkzip/WinZIP to unpack the distribution, make sure the - entire source tree is unpacked correctly, in particular - the empty out directories (flower/out, lib/out et. al.) +You may also need to create a script for `pngtopnm' and `pnmtopng'. On +GNU/Linux, I use this: -AUTHORS - Han-Wen Nienhuys +export LD_LIBRARY_PATH=/usr/lib +exec /usr/bin/pngtopnm "$@" - Jan Nieuwenhuizen + On MacOS X, I use this: - Have fun! +export DYLD_LIBRARY_PATH=/sw/lib +exec /sw/bin/pngtopnm "$@" +Testing LilyPond +---------------- +LilyPond comes with an extensive suite that exercises the entire +program. This suite can be used to automatically check the impact of a +change. This is done as follows + make test-baseline + _## apply your changes, compile_ + make check + This will leave an HTML page `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. + To rerun tests, use + make test-redo _## redo files differing from baseline_ + make test-clean _## remove all test results_ +and then run `make check' again. + For tracking memory usage as part of this test, you will need GUILE +CVS; especially the following patch: +`http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch'. + For checking the coverage of the test suite, do the following + ./scripts/auxiliar/build-coverage.sh + _# uncovered files, least covered first_ + ./scripts/auxiliar/coverage.py --summary out-cov/*.cc + _# consecutive uncovered lines, longest first_ + ./scripts/auxiliar/coverage.py --uncovered out-cov/*.cc +Problems +-------- +For help and questions use . Send bug reports +to . + Bugs that are not fault of LilyPond are documented here. +Bison 1.875 +........... -25/Apr/98 LilyPond 0.1.59 5 +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 + $ cd lily; make out/parser.cc + $ vi +4919 out/parser.cc + # append a semicolon to the line containing "__attribute__ ((__unused__)) + # save + $ make + +Solaris +....... + +Solaris7, ./configure + + `./configure' needs a POSIX compliant shell. On Solaris7, `/bin/sh' +is not yet POSIX compliant, but `/bin/ksh' or bash is. Run configure +like + + CONFIG_SHELL=/bin/ksh ksh -c ./configure + +or + + CONFIG_SHELL=/bin/bash bash -c ./configure + +FreeBSD +....... + +To use system fonts, dejaview must be installed. With the default +port, the fonts are installed in `usr/X11R6/lib/X11/fonts/dejavu'. + + Open the file `$LILYPONDBASE/usr/etc/fonts/local.conf' and add the +following line just after the `' line. (Adjust as necessary +for your hierarchy.) + + /usr/X11R6/lib/X11/fonts + +International fonts +................... + +On MacOS X, all fonts are installed by default. However, finding all +system fonts requires a bit of configuration; see this post +(http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html) +on the `lilypond-user' mailing list. + + On Linux, international fonts are installed by different means on +every distribution. We cannot list the exact commands or packages that +are necessary, as each distribution is different, and the exact package +names within each distribution changes. Here are some hints, though: + +Red Hat Fedora + + taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \ + ttfonts-zh_CN fonts-ja fonts-hebrew + +Debian GNU/Linux + + apt-get install emacs-intl-fonts xfonts-intl-.* \ + ttf-kochi-gothic ttf-kochi-mincho \ + xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi