X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=INSTALL.txt;h=594698c1d8e161f3a2f341f5ff30036c45dd70e4;hb=refs%2Fheads%2Fdon%2Fdep5_copyright;hp=b4eeade2943ced984d92e78f6beda2dca60386d7;hpb=f02e7db17cd0babaeb7978251ca5809e353ad29a;p=lilypond.git diff --git a/INSTALL.txt b/INSTALL.txt index b4eeade294..594698c1d8 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,513 +1,883 @@ +INSTALL - compiling and installing GNU LilyPond +*********************************************** +Table of Contents +***************** INSTALL - compiling and installing GNU LilyPond -*********************************************** + Overview of compiling + Requirements + Requirements for running LilyPond + Requirements for compiling LilyPond + Requirements for building documentation + Getting the source code + Configuring `make' + Running `./autogen.sh' + Running `../configure' + Configuration options + Checking build dependencies + Configuring target directories + Compiling LilyPond + Using `make' + Saving time with the `-j' option + Compiling for multiple platforms + Useful `make' variables + Post-compilation options + Installing LilyPond from a local build + Generating documentation + Documentation editor's edit/compile cycle + Building documentation + Saving time with `CPU_COUNT' + AJAX search + Installing documentation + Building documentation without compiling + Testing LilyPond binary + Problems + Bison 1.875 + Compiling on MacOS X + Solaris + FreeBSD + International fonts + Using lilypond python libraries + Concurrent stable and development versions + Build system + + +Overview of compiling +===================== + +Compiling LilyPond from source is an involved process, and is only +recommended for developers and packagers. Typical program users are +instead encouraged to obtain the program from a package manager (on +Unix) or by downloading a precompiled binary configured for a specific +operating system. Pre-compiled binaries are available on the *note +Download: (lilypond-web)Download. page. + + Compiling LilyPond from source is necessary if you want to build, +install, or test your own version of the program. + + A successful compile can also be used to generate and install the +documentation, incorporating any changes you may have made. However, a +successful compile is not a requirement for generating the +documentation. The documentation can be built using a Git repository +in conjunction with a locally installed copy of the program. For more +information, see *note Building documentation without compiling::. + + Attempts to compile LilyPond natively on Windows have been +unsuccessful, though a workaround is available (see *note Lilydev: +(lilypond-contributor)Lilydev.). + +Requirements +============ -Obtaining -========= +Requirements for running LilyPond +--------------------------------- - You can get the latest version of LilyPond at -ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/ -(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/). +Running LilyPond requires proper installation of the following software: - _If you upgrade by patching do remember to rerun autoconf after -applying the patch_. + * DejaVu fonts (http://www.dejavu-fonts.org/) (normally installed by + default) - If you do not want to download the entire archive for each version, -the safest method for upgrading is to use `xdelta', see -`ftp://ftp.xcf.berkeley.edu/pub/xdelta/'. + * FontConfig (http://www.fontconfig.org/) (2.4.0 or newer) - The following command produces `lilypond-1.3.122.tar.gz' from -`lilypond-1.3.121' identical (up to compression dates) to the .122 on -the FTP site. - xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz + * Freetype (http://www.freetype.org/) (2.1.10 or newer) -Prerequisites -============= + * Ghostscript (http://www.ghostscript.com) (8.60 or newer) - For compilation you need: + * Guile (http://www.gnu.org/software/guile/guile.html) (1.8.2 or + newer) - * A GNU system: GNU LilyPond is known to run on these GNU systems: - Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix - and Solaris. + * Pango (http://www.pango.org/) (1.12 or newer) - * Lots of disk space: LilyPond takes between 30 and 100 mb to - compile if you use debugging information. If you are short on - disk-space run configure with `--disable-debugging'. + * Python (http://www.python.org) (2.4 or newer) - * Although we recommend to use Unix, LilyPond is known to run on - Windows NT/95/98 as well. See Section Windows NT/95,es. + International fonts are required to create music with international +text or lyrics. - * A reasonable C++ compiler: EGCS 1.1, GCC 2.95.2 or newer. Check - out `ftp://ftp.gnu.org/gnu/gcc/'. +Requirements for compiling LilyPond +----------------------------------- - * Python 1.5, Check out `ftp://ftp.python.org' or - `ftp://ftp.cwi.nl/pub/python'. +Below is a full list of packages needed to build LilyPond. However, +for most common distributions there is an easy way of installing most +all build dependencies in one go: - * GUILE 1.3.4 or newer, check out - http://www.gnu.org/software/guile/guile.html - (http://www.gnu.org/software/guile/guile.html). Version 1.4 is - recommended for better performance. +Distribution Command +-------------------------------------------------------------------------- +Debian, Ubuntu `sudo apt-get build-dep lilypond' +Fedora, RHEL `sudo yum-builddep lilypond' +openSUSE, SLED `sudo zypper --build-deps-only + source-install lilypond' - * GNU Make. Check out ftp://ftp.gnu.org/gnu/make/ - (ftp://ftp.gnu.org/gnu/make/). + * Everything listed in *note Requirements for running LilyPond:: - * Flex (version 2.5.4a or newer). Check out - ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/ - (ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/). + * Development packages for the above items (which should include + header files and libraries). - * Bison (version 1.25 or newer). Check out - ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/). + Red Hat Fedora: - * TeX. If you want LilyPond to use kpathsea support (recommended), - 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 package too. + guile-devel-VERSION + fontconfig-devel-VERSION + freetype-devel-VERSION + pango-devel-VERSION + python-devel-VERSION - * Texinfo (version 4.0 or newer). Check out - ftp://ftp.gnu.org/gnu/texinfo/ (ftp://ftp.gnu.org/gnu/texinfo/). - Most documentation is in texinfo. + Debian GNU/Linux: - * The geometry package for LaTeX is needed to use ly2dvi. Available - at - ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry - (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry) - or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de) + guile-VERSION-dev + libfontconfig1-dev + libfreetype6-dev + libpango1.0-dev + pythonVERSION-dev - * MetaPost, needed for generating PostScript fonts. Please note that - tetex-0.4pl8 (included with Red Hat 5.x) does not include - `mfplain.mp', which is needed for producing the scalable font - files. + * Flex (http://flex.sourceforge.net/) - If you do not want to use PostScript output, edit `mf/GNUmakefile', - removing the line saying `PFA_FILES=' + * FontForge (http://fontforge.sf.net/) (20060125 or newer; 20100501 + or newer is recommended; must be compiled with `--enable-double'. + Failure to do so can lead to poor intersection calculations and + poorly-rendered glyphs.) - * kpathsea, a library for searching (TeX) files. `kpathsea' is - usually included with your installation of TeX. + * GNU Bison (http://www.gnu.org/software/bison/) + * GNU Compiler Collection (http://gcc.gnu.org/) (3.4 or newer, 4.X + recommended) -Running -======= + * GNU gettext (http://www.gnu.org/software/gettext/gettext.html) + (0.17 or newer) - GNU LilyPond does use a lot of resources. For operation you need the -following software + * GNU Make (http://www.gnu.org/software/make/) (3.78 or newer) - * TeX. + * MetaFont (http://metafont.tutorial.free.fr/) (mf-nowin, mf, mfw or + mfont binaries), usually packaged with TeX + (http://www.latex-project.org/ftp.html). - * A PostScript printer and/or viewer (such as Ghostscript) is - strongly recommended. Xdvi will show all embedded PostScript - too if you have Ghostscript installed. + * MetaPost (http://cm.bell-labs.com/who/hobby/MetaPost.html) (mpost + binary), usually packaged with TeX + (http://www.latex-project.org/ftp.html). - * GUILE 1.3.4, or newer. Check out - http://www.gnu.org/software/guile/ - (http://www.gnu.org/programs/guile.html) + * Perl (http://www.perl.org/) - 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 sh scripts are left in `buildscripts/out/lilypond-profile' and -`buildscripts/out/lilypond-login' after compilation. + * Texinfo (http://www.gnu.org/software/texinfo/) (4.11 or newer) - The empty path component represents TeX and MetaFont's default search -paths. Scripts with the proper paths for the bourne and C-shell -respectively are generated in `buildscripts/out/lilypond-profile' and -`buildscripts/out/lilypond-login' during compilation. + * Type 1 utilities (http://www.lcdf.org/~eddietwo/type/#t1utils) + (1.33 or newer recommended) - LilyPond is a big and slow program. A fast CPU and plenty of RAM is -recommended for comfortable use. +Requirements for building documentation +--------------------------------------- -Website -======= +You can view the documentation online at +`http://www.lilypond.org/doc/', but you can also build it locally. +This process requires some additional tools and packages: - The website is the most convenient form to use for reading the -documentation on-line documentation. It is made by entering + * Everything listed in *note Requirements for compiling LilyPond:: + * ImageMagick (http://www.imagemagick.org/) - make web-doc - This does require a functioning LilyPond. The executable doesn't -have to be installed, though. + * Netpbm (http://netpbm.sourceforge.net/) - If you want to auto-generate Lily's website, you'll need some -additional conversion tools. + * gzip (http://gzip.org/) - * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities) - (For Red Hat Linux users: it is included within the - package libgr-progs). The original is at - ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz - (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz) + * rsync (http://rsync.samba.org/) - * pnmtopng (also in libgr-progs for Red Hat). The original is at - ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz - (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i + * Texi2HTML (http://www.nongnu.org/texi2html/) (1.82) - The version of `pnmtopng' that is distributed with Red Hat 5.1 and - 5.2 contains a bug: pnmtopng is dynamically linked to the wrong - version of libpng. + * International fonts - * Bibtex2html (http://www.lri.fr/~filliatr/ftp/bibtex2html/), or - Bib2html (http://www.uni-koblenz.de/ag-ki/ftp/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 - 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). + Red Hat Fedora: - The website will build without bib converter utility, but you will - not see our hypertextified bibliography. + fonts-arabic + fonts-hebrew + fonts-ja + fonts-xorg-truetype + taipeifonts + ttfonts-ja + ttfonts-zh_CN + Debian GNU/Linux: -Configuring and compiling -========================= + emacs-intl-fonts + ttf-kochi-gothic + ttf-kochi-mincho + xfonts-bolkhov-75dpi + xfonts-cronyx-75dpi + xfonts-cronyx-100dpi + xfonts-intl-.* - to install GNU LilyPond, simply type: - gunzip -c lilypond-x.y.z | tar xf - - cd lilypond-x.y.z - ./configure # fill in your standard prefix with --prefix - make - make install +Getting the source code +======================= - This will install a number of files, something close to: +Downloading the Git repository +------------------------------ - /usr/local/man/man1/midi2ly.1 - /usr/local/man/man1/abc2ly.1 - /usr/local/man/man1/etf2ly.1 - /usr/local/man/man1/convert-ly.1 - /usr/local/man/man1/lilypond-book.1 - /usr/local/man/man1/lilypond.1 - /usr/local/bin/lilypond - /usr/local/bin/midi2ly - /usr/local/bin/convert-ly - /usr/local/bin/lilypond-book - /usr/local/bin/abc2ly - /usr/local/bin/pmx2ly - /usr/local/bin/musedata2ly - /usr/local/bin/etf2ly - /usr/local/share/lilypond/* - /usr/local/share/locale/{....}/LC_MESSAGES/lilypond.mo +In general, developers compile LilyPond from within a local Git +repository. Setting up a local Git repository is explained in *note +Starting with Git: (lilypond-contributor)Starting with Git. - 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: +Downloading a source tarball +---------------------------- +Packagers are encouraged to use source tarballs for compiling. - export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR" - ./configure + The tarball for the latest stable release is available on the *note +Source: (lilypond-web)Source. page. - `CPPFLAGS' are the preprocessor flags. +The latest source code snapshot +(http://git.savannah.gnu.org/gitweb/?p=lilypond.git;a=snapshot) is also +available as a tarball from the GNU Savannah Git server. - The configure script is Cygnus configure, and it will accept -`--help'. If you are not root, you will probably have to make it with a -different `--prefix' option. Our favourite location is +All tagged releases (including legacy stable versions and the most +recent development release) are available here: + `http://download.linuxaudio.org/lilypond/source/' - ./configure --prefix=$HOME/usr + Download the tarball to your `~/src/' directory, or some other +appropriate place. - In this case, you will have to set up MFINPUTS, and TEXINPUTS -accordingly. + Note: Be careful where you unpack the tarball! Any + subdirectories of the current folder named `lilypond/' or + `lilypond-X.Y.Z/' (where X.Y.Z is the release number) will be + overwritten if there is a name clash with the tarball. - Since GNU LilyPond currently is beta, you are advised to also use + Unpack the tarball with this command: + tar -xzf lilypond-X.Y.Z.tar.gz - --enable-debugging - --enable-checking + This creates a subdirectory within the current directory called +`lilypond-X.Y.Z/'. Once unpacked, the source files occupy about 40 MB +of disk space. - Options to configure include: + Windows users wanting to look at the source code may have to +download and install the free-software 7zip archiver +(http://www.7-zip.org) to extract the tarball. -``--enable-printing'' - Enable debugging print routines (lilypond `-D' option) +Configuring `make' +================== -``--enable-optimise'' - Set maximum optimisation: compile with `-O2'. This can be - unreliable on some compiler/platform combinations (eg, DEC Alpha - and PPC) +Running `./autogen.sh' +---------------------- -``--enable-profiling'' - Compile with support for profiling. +After you unpack the tarball (or download the Git repository), the +contents of your top source directory should be similar to the current +source tree listed at +`http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=tree'. -``--enable-config=CONF'' - Output to different configuration files. Enables different binary - builds alongside eachother, eg, multi-configuration (debugging, - profiling), or multi-platform builds. Use `make conf=CONF' to - build for a specific configuration. + Next, you need to create the generated files; enter the following +command from your top source directory: - All options are documented in the `configure' help The option -`--enable-optimise' is recommended for Real Life usage. + ./autogen.sh --noconfigure - If you do + This will generate a number of files and directories to aid +configuration, such as `configure', `README.txt', etc. + Next, create the build directory with: - make all + mkdir build/ + cd build/ - 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). + We heavily recommend building lilypond inside a separate directory +with this method. -Emacs mode -========== +Running `../configure' +---------------------- - An emacs mode for LilyPond is included with the source archive as -`lilypond-mode.el' and `lilypond-font-lock.el'. If you have an RPM, it -is in `/usr/share/doc/lilypond-X/'. You have to install it yourself. +Configuration options +..................... - Add this to your ~/.emacs or ~/.emacs.el: - (load-library "lilypond-mode.el") - (setq auto-mode-alist - (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist)) - (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock))) + Note: make sure that you are in the `build/' subdirectory of + your source tree. - If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode -is automatically loaded, so you need not modify your ~/.emacs file. +The `../configure' command (generated by `./autogen.sh') provides many +options for configuring `make'. To see them all, run: -Configuring for multiple platforms -================================== + ../configure --help - If you want to build multiple versions of LilyPond with different -configuration settings, you can use the `--enable-config=CONF' option. -You should use `make conf=CONF' to generate the output in `out-CONF'. -Example: suppose I want to build with and without profiling. Then I'd -use the following for the normal build, +Checking build dependencies +........................... + Note: make sure that you are in the `build/' subdirectory of + your source tree. - ./configure --prefix=~ --disable-optimise --enable-checking - make - make install +When `../configure' is run without any arguments, it will check to make +sure your system has everything required for compilation: - and for the profiling version, I specify a different configuration. + ../configure + If any build dependency is missing, `../configure' will return with: - ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking - make conf=prof - make conf=prof install + ERROR: Please install required programs: FOO -Installing -========== + The following message is issued if you are missing programs that are +only needed for building the documentation: - if you have done a successful `make', then a simple + WARNING: Please consider installing optional programs: BAR + If you intend to build the documentation locally, you will need to +install or update these programs accordingly. - make install + Note: `../configure' may fail to issue warnings for certain + documentation build requirements that are not met. If you + experience problems when building the documentation, you may + need to do a manual check of *note Requirements for building + documentation::. - should do the trick. +Configuring target directories +.............................. - 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 for you, see `bin/clean-fonts.sh'. + Note: make sure that you are in the `build/' subdirectory of + your source tree. -Red Hat Linux -============= +If you intend to use your local build to install a local copy of the +program, you will probably want to configure the installation +directory. Here are the relevant lines taken from the output of +`../configure --help': - Red Hat Linux users can compile an RPM. A spec file is in -`make/out/lilypond.spec'; it is distributed along with the sources. + By default, ``make install'' will install all the files in + `/usr/local/bin', `/usr/local/lib' etc. You can specify an + installation prefix other than `/usr/local' using ``--prefix'', + for instance ``--prefix=$HOME''. - You can make the rpm by issuing + A typical installation prefix is `$HOME/usr': - rpm -tb lilypond-x.y.z.tar.gz - rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z + ../configure --prefix=$HOME/usr - Precompiled Red Hat 7.0 i386 RPMS are available from -`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'. + Note that if you plan to install a local build on a system where you +do not have root privileges, you will need to do something like this +anyway--`make install' will only succeed if the installation prefix +points to a directory where you have write permission (such as your +home directory). The installation directory will be automatically +created if necessary. - For compilation on a Red Hat system you need these packages, in -addition to the those needed for running: - * glibc-devel + The location of the `lilypond' command installed by this process +will be `PREFIX/bin/lilypond'; you may want to add `PREFIX/bin/' to +your `$PATH' if it is not already included. - * libstdc++-devel + It is also possible to specify separate installation directories for +different types of program files. See the full output of +`../configure --help' for more information. - * guile-devel + If you encounter any problems, please see *note Problems::. - * flex +Compiling LilyPond +================== - * bison +Using `make' +------------ - * texinfo + Note: make sure that you are in the `build/' subdirectory of + your source tree. - * tetex-devel +LilyPond is compiled with the `make' command. Assuming `make' is +configured properly, you can simply run: -SuSE -==== + make - [TODO: document this] + `make' is short for `make all'. To view a list of `make' targets, +run: - Install `tetex', `te_mpost', `te_kpath'. + make help -Debian GNU/Linux -================ + TODO: Describe what `make' actually does. + +Saving time with the `-j' option +-------------------------------- + +If your system has multiple CPUs, you can speed up compilation by +adding `-jX' to the `make' command, where `X' is one more than the +number of cores you have. For example, a typical Core2Duo machine +would use: + + make -j3 + + If you get errors using the `-j' option, and `make' succeeds without +it, try lowering the `X' value. + + Because multiple jobs run in parallel when `-j' is used, it can be +difficult to determine the source of an error when one occurs. In that +case, running `make' without the `-j' is advised. + +Compiling for multiple platforms +-------------------------------- + +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 + + ./configure --prefix=$HOME/usr/ --enable-checking + make + + and for the profiling version, specify a different configuration + + ./configure --prefix=$HOME/usr/ --enable-profiling \ + --enable-config=prof --disable-checking + make conf=prof + + If you wish to install a copy of the build with profiling, don't +forget to use `conf=CONF' when issuing `make install': + + make conf=prof install + + +See also +........ + + + + *note Installing LilyPond from a local build:: + +Useful `make' variables +----------------------- + +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. + +Post-compilation options +======================== + +Installing LilyPond from a local build +-------------------------------------- + +If you configured `make' to install your local build in a directory +where you normally have write permission (such as your home directory), +and you have compiled LilyPond by running `make', you can install the +program in your target directory by running: + + make install + + If instead, your installation directory is not one that you can +normally write to (such as the default `/usr/local/', which typically +is only writeable by the superuser), you will need to temporarily +become the superuser when running `make install': + + sudo make install + +or... + + su -c 'make install' + + If you don't have superuser privileges, then you need to configure +the installation directory to one that you can write to, and then +re-install. See *note Configuring target directories::. + +Generating documentation +------------------------ + +Documentation editor's edit/compile cycle +......................................... + + * Initial documentation build: + + make [-jX] + make [-jX CPU_COUNT=X] doc _## can take an hour or more_ + + * Edit/compile cycle: + + _## edit source files, then..._ + + make [-jX] _## needed if editing outside_ + _## Documentation/, but useful anyway_ + _## for finding Texinfo errors._ + touch Documentation/*te?? _## bug workaround_ + make [-jX CPU_COUNT=X] doc _## usually faster than initial build._ + + * Reset: + + In some cases, it is possible to clean the compiled documentation + with `make doc-clean', but this method is not guaranteed to fix + everything. Instead, we recommend that you delete your `build/' + directory, and begin compiling from scratch. Since the + documentation compile takes much longer than the non-documentation + compile, this does not increase the overall time by a great deal. + + +Building documentation +...................... + +After a successful compile (using `make'), the documentation can be +built by issuing: + + make doc + + The first time you run `make doc', the process can easily take an +hour or more. After that, `make doc' only makes changes to the +pre-built documentation where needed, so it may only take a minute or +two to test changes if the documentation is already built. + + If `make doc' succeeds, the HTML documentation tree is available in +`out-www/offline-root/', and can be browsed locally. Various portions +of the documentation can be found by looking in `out/' and `out-www' +subdirectories in other places in the source tree, but these are only +_portions_ of the docs. Please do not complain about anything which is +broken in those places; the only complete set of documentation is in +`out-www/offline-root/' from the top of the source tree. + + Compilation of documentation in Info format with images can be done +separately by issuing: + + make info + + +Known issues and warnings +......................... + +If source files have changed since the last documentation build, output +files that need to be rebuilt are normally rebuilt, even if you do not +run `make doc-clean' first. However, build dependencies in the +documentation are so complex that some newly-edited files may not be +rebuilt as they should be; a workaround is to `touch' the top source +file for any manual you've edited. For example, if you make changes to +a file in `notation/', do: + + touch Documentation/notation.tely + +The top sources possibly affected by this are: - A Debian package is also available. You may install it easily by -using apt-get as root: + Documentation/extend.texi + Documentation/changes.tely + Documentation/contributor.texi + Documentation/essay.tely + Documentation/extending.tely + Documentation/learning.tely + Documentation/notation.tely + Documentation/snippets.tely + Documentation/usage.tely + Documentation/web.texi - apt-get install lilypond1.3 +You can `touch' all of them at once with: - Alternatively, visit + touch Documentation/*te?? - * http://packages.debian.org/lilypond - (http://packages.debian.org/lilypond) +However, this will rebuild all of the manuals indiscriminately--it is +more efficient to `touch' only the affected files. - * http://ftp.debian.org/debian/pool/main/l/lilypond1.3/ - (http://ftp.debian.org/debian/pool/main/l/lilypond1.3/) for latest - package uploaded to Debian unstable; +Saving time with `CPU_COUNT' +............................ - * http://people.debian.org/~foka/lilypond/ - (http://people.debian.org/~foka/lilypond/) for latest - semi-unofficial build of LilyPond 1.3.121 for Debian 2.2r2 - (potato) users. The official stable Debian 2.2r2 is stuck with - the old LilyPond-1.3.24. +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 the `-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: - You may contact Anthony Fok for more information. + make -j3 CPU_COUNT=3 doc - The build scripts are in the subdirectory `debian/'; you can make -the .deb by doing, for example: +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 unless +your system has enough RAM to run that many simultaneous LilyPond +instances. Also, values for the `-j' option that pose problems with +`make' are less likely to pose problems with `make doc' (this applies +to both `-j' and `CPU_COUNT'). For example, with a quad-core processor, +it is possible for `make -j5 CPU_COUNT=5 doc' to work consistently even +if `make -j5' rarely succeeds. - $ su - root - # dpkg --purge lilypond lilypond1.3 - # exit - $ tar xzf lilypond-1.3.122.tar.gz - $ cd lilypond-1.3.122 - $ dch -p -v 1.3.122-0.local.1 "Local build." - $ debuild - $ su - root - # dpkg -i ../lilypond1.3_1.3.122*.deb - # exit - $ +AJAX search +........... - For compilation on a Debian GNU/Linux system you need these packages, -in addition to the those needed for running: +To build the documentation with interactive searching, use: - * g++, cpp, libc6-dev, libstdc++-dev + make doc AJAX_SEARCH=1 - * libguile-dev + This requires PHP, and you must view the docs via a http connection +(you cannot view them on your local filesystem). - * make, m4, flex, bison + Note: Due to potential security or load issues, this option is + not enabled in the official documentation builds. Enable at + your own risk. - * gettext +Installing documentation +........................ - * groff, texinfo, bibtex2html (not in 2.2r2) +The HTML, PDF and if available Info files can be installed into the +standard documentation path by issuing - * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev + make install-doc - * dpkg-dev, debhelper, fakeroot +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. - * gs, netpbm, pnmtopng + To install the Info documentation separately, run: - Most of these are listed on the Build-Depends line in the -debian/control file. To ensure the creation of the lilypond deb is -trouble-free, we recommend that you first install the following packages -before starting dpkg-buildpackage by running apt-get as root. + make install-info - For Debian 2.2 (or 2.2r2, 2.2r3): +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. - 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 + 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 - For Debian in development ("unstable", the future 2.3 or 3.0): + make WEB_TARGETS=online doc - 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 \ - netpbm pnmtopng m4 gettext +and both `offline' and `online' targets can be generated by issuing - 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: + make WEB_TARGETS="offline online" doc - dpkg --purge lilypond lilypond1.3 + Several targets are available to clean the documentation build and +help with maintaining documentation; an overview of these targets is +available with -Windows NT/95 -============= + make help - Separate instructions on building for W32 are available; See the -files in `Documentation/ntweb/', included with the sources. +from every directory in the build tree. Most targets for documentation +maintenance are available from `Documentation/'; for more information, +see *note Documentation work: (lilypond-contributor)Documentation work. + + The makefile variable `QUIET_BUILD' may be set to `1' for a less +verbose build output, just like for building the programs. + +Building documentation without compiling +........................................ + +The documentation can be built locally without compiling LilyPond +binary, if LilyPond is already installed on your system. + + From a fresh Git checkout, do + + ./autogen.sh # ignore any warning messages + cp GNUmakefile.in GNUmakefile + make -C scripts && make -C python + nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc + + 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. + + You may build the manual without building all the `input/*' stuff +(i.e. mostly regression tests): change directory, for example to +`Documentation/', 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 + + make out=www WWW-post + + +Known issues and warnings +......................... + +You may also need to create a script for `pngtopnm' and `pnmtopng'. On +GNU/Linux, I use this: + +export LD_LIBRARY_PATH=/usr/lib +exec /usr/bin/pngtopnm "$@" + + On MacOS X with fink, I use this: + +export DYLD_LIBRARY_PATH=/sw/lib +exec /sw/bin/pngtopnm "$@" + + On MacOS X with macports, you should use this: + +export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib +exec /opt/local/bin/pngtopnm "$@" + +Testing LilyPond binary +----------------------- + +LilyPond comes with an extensive suite that exercises the entire +program. This suite can be used to test that the binary has been built +correctly. + + The test suite can be executed with: + +make test + + If the test suite completes successfully, the LilyPond binary has +been verified. + + More information on the regression test suite is found at *note +Regression tests: (lilypond-contributor)Regression tests. Problems ======== - For help and questions use and -. Please consult the faq before mailing -your problems. +For help and questions use . Send bug reports +to . + + Bugs that are not fault of LilyPond are documented here. + +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, 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 + +Compiling on MacOS X +.................... - If you find bugs, please send bug reports to . +Here are special instructions for compiling under MacOS X. These +instructions assume that dependencies are installed using MacPorts. +(http://www.macports.org/) The instructions have been tested using OS X +10.5 (Leopard). - Bugs that are LilyPond's fault are listed in our TODO list on the -web, or demonstrated in `input/bugs/'. + First, install the relevant dependencies using MacPorts. + + Next, add the following to your relevant shell initialization files. +This is `~/.profile' by default. You should create this file if it +does not exist. + + export PATH=/opt/local/bin:/opt/local/sbin:$PATH + export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib:$DYLD_FALLBACK_LIBRARY_PATH + + Now you must edit the generated `config.make' file. Change + + FLEXLEXER_FILE = /usr/include/FlexLexer.h + +to: + + FLEXLEXER_FILE = /opt/local/include/FlexLexer.h + + At this point, you should verify that you have the appropriate fonts +installed with your ghostscript installation. Check `ls +/opt/local/share/ghostscript/fonts' for: 'c0590*' files (.pfb, .pfb and +.afm). If you don't have them, run the following commands to grab them +from the ghostscript SVN server and install them in the appropriate +location: + + svn export http://svn.ghostscript.com/ghostscript/tags/urw-fonts-1.0.7pre44/ + sudo mv urw-fonts-1.0.7pre44/* /opt/local/share/ghostscript/fonts/ + rm -rf urw-fonts-1.07pre44 + + Now run the `./configure' script. To avoid complications with +automatic font detection, add + + --with-ncsb-dir=/opt/local/share/ghostscript/fonts + +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 Mac OS 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 - Bugs that are not LilyPond's fault are documented here. + apt-get install emacs-intl-fonts xfonts-intl-.* \ + ttf-kochi-gothic ttf-kochi-mincho \ + xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi -LinuxPPC Bugs: -************** +Using lilypond python libraries +............................... - * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to - fixed in egcs-1.1.2-12f or gcc-2.95-0a, - `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/' +If you want to use lilypond's python libraries (either running certain +build scripts manually, or using them in other programs), set +`PYTHONPATH' to `python/out' in your build directory, or +`.../usr/lib/lilypond/current/python' in the installation directory +structure. - * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in - particular guile-1.3, and Lily herself will break. +Concurrent stable and development versions +========================================== -Linux-i386 -********** +It can be useful to have both the stable and the development versions +of Lilypond available at once. One way to do this on GNU/Linux is to +install the stable version using the precompiled binary, and run the +development version from the source tree. After running `make all' +from the top directory of the Lilypond source files, there will be a +binary called `lilypond' in the `out' directory: - * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0) + /lilypond/out/bin/lilypond - Lily will crash during parsing (which suggests a C++ library - incompatibility). Precise cause, precise platform description or - solution are not known. + This binary can be run without actually doing the `make install' +command. The advantage to this is that you can have all of the latest +changes available after pulling from git and running `make all', +without having to uninstall the old version and reinstall the new. - Note that this only happens on some computers with the said - platform. + So, to use the stable version, install it as usual and use the +normal commands: - * libg++ 2.7 + lilypond foobar.ly - LilyPond occasionally crashes while parsing the initialisation - files. This is a very obscure bug, and usually entering the - commandline differently "fixes" it. + To use the development version, create a link to the binary in the +source tree by saving the following line in a file somewhere in your +`$PATH': - lilypond input.ly + exec /lilypond/out/bin/lilypond "$@" - and - lilypond -I. ./input.ly - makes a difference + Save it as `Lilypond' (with a capital L to distinguish it from the +stable `lilypond'), and make it executable: - Typical stacktrace: - SIGSEGV - __libc_malloc (bytes=16384) - ?? () - yyFlexLexer::yy_create_buffer () - Includable_lexer::new_input (this=0x8209a00, s={strh_ = { + chmod +x Lilypond - This behaviour has been observed with machines that have old libg++ - versions (LinuxPPC feb '98, Red Hat 4.x). + Then you can invoke the development version this way: -Solaris: -******** + Lilypond foobar.ly - * Sparc64/Solaris 2.6, GNU make-3.77 + TODO: ADD - GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or - newer. + - other compilation tricks for developers - * Sparc64/Solaris 2.6, ld +Build system +============ - Not yet resolved. +We currently use make and stepmake, which is complicated and only used +by us. Hopefully this will change in the future. -AIX -*** +Version-specific texinfo macros +............................... - * AIX 4.3 ld + * made with `scripts/build/create-version-itexi.py' and + `scripts/build/create-weblinks-itexi.py' - The following is from the gcc install/SPECIFIC file. - 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. + * used extensively in the `WEBSITE_ONLY_BUILD' version of the + website (made with `website.make', used on lilypond.org) - 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. + * not (?) used in the main docs? - add -Wl,-bbigtoc to USER_LDFLAGS, ie: - LDFLAGS='-Wl,-bbigtoc' ./configure + * the numbers in VERSION file: MINOR_VERSION should be 1 more than + the last release, VERSION_DEVEL should be the last *online* + release. Yes, VERSION_DEVEL is less than VERSION.