+INSTALL - compiling and installing GNU LilyPond
+***********************************************
+
+Table of Contents
+*****************
+
+INSTALL - compiling and installing GNU LilyPond
+1 Compilation
+ 1.1 Overview of compiling
+ 1.2 Requirements
+ 1.2.1 Requirements for running LilyPond
+ 1.2.2 Requirements for compiling LilyPond
+ 1.2.3 Requirements for building documentation
+ 1.3 Getting the source code
+ 1.4 Configuring `make'
+ 1.4.1 Running `./autogen.sh'
+ 1.4.2 Running `../configure'
+ Configuration options
+ Checking build dependencies
+ Configuring target directories
+ 1.5 Compiling LilyPond
+ 1.5.1 Using `make'
+ 1.5.2 Saving time with the `-j' option
+ 1.5.3 Compiling for multiple platforms
+ 1.5.4 Useful `make' variables
+ 1.6 Post-compilation options
+ 1.6.1 Installing LilyPond from a local build
+ 1.6.2 Generating documentation
+ Documentation editor's edit/compile cycle
+ Building documentation
+ Building a single document
+ Saving time with `CPU_COUNT'
+ AJAX search
+ Installing documentation
+ Building documentation without compiling
+ 1.6.3 Testing LilyPond binary
+ 1.7 Problems
+ Bison 1.875
+ Compiling on MacOS X
+ Solaris
+ FreeBSD
+ International fonts
+ Using lilypond python libraries
+ 1.8 Concurrent stable and development versions
+ 1.9 Build system
+
+
+1 Compilation
+*************
+
+1.1 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.).
+
+1.2 Requirements
+================
- INSTALL - compiling and installing GNU LilyPond
+1.2.1 Requirements for running LilyPond
+---------------------------------------
- HWN & JCN
+Running LilyPond requires proper installation of the following software:
-Contents
+ * DejaVu fonts (http://www.dejavu-fonts.org/) (normally installed by
+ default)
- 1: ABSTRACT
-2: OBTAINING
-3: PREREQUISITES
-4: RUNNING
-5: WEBSITE
-6: CONFIGURING and COMPILING
-7: CONFIGURING FOR MULTIPLE PLATFORMS
-8: INSTALLING
-9: REDHAT LINUX
-10: DEBIAN GNU/LINUX
-11: WINDOWS NT/95
-12: AUTHORS
+ * FontConfig (http://www.fontconfig.org/) (2.4.0 or newer)
-1: ABSTRACT
+ * Freetype (http://www.freetype.org/) (2.1.10 or newer)
-This document explains what you need to install LilyPond,
-and what you should do. If you are going to compile and
-install LilyPond often, e.g. when doing development, you
-might want to check out the buildscripts/set-lily.sh script.
-It sets some environment variables and symlinks, which comes
-in handly when you have to compile LilyPond more often.
+ * Ghostscript (http://www.ghostscript.com) (8.60 or newer)
-2: OBTAINING
+ * Guile (http://www.gnu.org/software/guile/guile.html) (1.8.2 or
+ newer)
-You can get the latest version of LilyPond at
-ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/. Refer to the links
-document for mirror sites.
+ * Pango (http://www.pango.org/) (1.12 or newer)
-If you upgrade by patching do remember to rerun autoconf
-after applying the patch.
+ * Python (http://www.python.org) (2.4 or newer)
-3: PREREQUISITES
+ International fonts are required to create music with international
+text or lyrics.
-For compilation you need:
+1.2.2 Requirements for compiling LilyPond
+-----------------------------------------
-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.
+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:
-o 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.
+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'
- Although we recommend to use Unix, LilyPond is known to
- run on Windows NT/95/98 as well. See Section 11.
+ * Everything listed in *note Requirements for running LilyPond::
-o EGCS 1.1 or newer.
+ * Development packages for the above items (which should include
+ header files and libraries).
-o Python 1.5, Check out ftp://ftp.python.org or
- ftp://ftp.cwi.nl/pub/python.
+ Red Hat Fedora:
-o GUILE 1.3, check out http://www.gnu.org/soft-
- ware/guile/guile.html.
+ guile-devel-VERSION
+ fontconfig-devel-VERSION
+ freetype-devel-VERSION
+ pango-devel-VERSION
+ python-devel-VERSION
-o GNU make. Check out ftp://ftp.gnu.org.
+ Debian GNU/Linux:
-o Flex (version 2.5.4 or newer). Check out
- ftp://ftp.gnu.org.
+ guile-VERSION-dev
+ libfontconfig1-dev
+ libfreetype6-dev
+ libpango1.0-dev
+ pythonVERSION-dev
-o Bison (version 1.25 or newer). Check out
- ftp://ftp.gnu.org.
+ * Flex (http://flex.sourceforge.net/)
-o Yodl. All documentation will be in Yodl. (1.30.17)
- ftp://ftp.lilypond.org/pub/yodl
+ * 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.)
-o The geometry package for LaTeX is needed to use ly2dvi.
- Available at ftp://ftp.ctan.org/tex-
- archive/macros/latex/contrib/supported/geometry or at
- mirror site ftp://ftp.dante.de
+ * GNU Bison (http://www.gnu.org/software/bison/)
-o MetaPost, if you want to use direct PostScript output.
- Please note that tetex-0.4pl8 (included with Redhat
- 5.x) does not include mfplain.mp, which is needed for
- producing the scaleable font files.
+ * GNU Compiler Collection (http://gcc.gnu.org/) (3.4 or newer, 4.X
+ recommended)
-4: 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)
-o 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).
-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.
+ * MetaPost (http://cm.bell-labs.com/who/hobby/MetaPost.html) (mpost
+ binary), usually packaged with TeX
+ (http://www.latex-project.org/ftp.html).
-o GUILE 1.3, check out http://www.gnu.org/pro-
- grams/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. An example is given here for the
-Bourne shell:
+ * Texinfo (http://www.gnu.org/software/texinfo/) (4.11 or newer)
- export MFINPUTS="/usr/local/share/lilypond/mf:"
- export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
+ * Type 1 utilities (http://www.lcdf.org/~eddietwo/type/#t1utils)
+ (1.33 or newer recommended)
-The empty path component represents and MetaFont's default
-search paths. Scripts with the proper paths for the bourne
-and C-shell respectively are generated in build-
-scripts/out/lilypond-profile and buildscripts/out/lilypond-
-login during compilation.
+1.2.3 Requirements for building documentation
+---------------------------------------------
-LilyPond is a hideously slow program. A fast CPU and plenty
-of RAM is recommended for comfortable use.
+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:
-5: WEBSITE
+ * Everything listed in *note Requirements for compiling LilyPond::
-If you want to auto-generate Lily's website, you'll need
-some additional conversion tools.
+ * ImageMagick (http://www.imagemagick.org/)
-o xpmtoppm (from 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/con-
- trib/utilities/netpbm-1mar1994.p1.tar.gz
+ * Netpbm (http://netpbm.sourceforge.net/)
-o pnmtopng, which is also in libgr-progs for RedHat. The
- original is at
- ftp://swrinde.nde.swri.edu/pub/png/applications/pnm-
- topng-2.37.2.tar.gz.i
+ * gzip (http://gzip.org/)
- The version of pnmtopng that is distributed with RedHat
- 5.1 and 5.2 contains a bug: pnmtopng is dynamically
- linked to the wrong version of libpng. Recompile it
- from source, and make sure that the pnmtopng binary is
- linked statically to the libpng that is included in
- libgr. RedHat 6.0 does not have this problem.
+ * rsync (http://rsync.samba.org/)
- tar xzf libgr-2.0.13.tar.gz
- make
- cd png
- rm libpng.so*
- make pnmtopng
+ * Texi2HTML (http://www.nongnu.org/texi2html/) (1.82)
- You can then install the new pnmtopng into
- /usr/local/bin/
+ * International fonts
-o Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
- Which, in turn depends on man2html for proper installa-
- tion. man2html can be had from http://askdon-
- ald.ask.uni-karlsruhe.de/hppd/hpux/Network-
- ing/WWW/Man2html-1.05.
+ Red Hat Fedora:
- The website will build without this utility, but you
- will not see our hypertextified bibliography.
+ fonts-arabic
+ fonts-hebrew
+ fonts-ja
+ fonts-xorg-truetype
+ taipeifonts
+ ttfonts-ja
+ ttfonts-zh_CN
- TeTeX users should not forget to rerun texhash.
+ Debian GNU/Linux:
-You also have to install buildscripts/out/ps-to-gifs in a
-directory that is in the path.
+ emacs-intl-fonts
+ ttf-kochi-gothic
+ ttf-kochi-mincho
+ xfonts-bolkhov-75dpi
+ xfonts-cronyx-75dpi
+ xfonts-cronyx-100dpi
+ xfonts-intl-.*
-6: CONFIGURING and COMPILING
+1.3 Getting the source code
+===========================
-to install GNU LilyPond, simply type:
+Downloading the Git repository
+------------------------------
- gunzip -c lilypond-x.y.z | tar xf -
- cd lilypond-x.y.z
- ./configure # fill in your standard prefix with --prefix
- make
- make install
+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.
-This will install a number of files, something close to:
+Downloading a source tarball
+----------------------------
- /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/bin/lilypond
- /usr/local/bin/mi2mu
- /usr/local/share/lilypond/*
- /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
+Packagers are encouraged to use source tarballs for compiling.
-The above assumes that you are root and have the GNU devel-
-opment tools, and your make is GNU make. If this is not the
-case, you can adjust your environment variables to your
-taste:
+ The tarball for the latest stable release is available on the *note
+Source: (lilypond-web)Source. page.
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- ./configure
+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.
-CPPFLAGS are the preprocessor flags.
+All tagged releases (including legacy stable versions and the most
+recent development release) are available here:
-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
+ `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 TEXIN-
-PUTS 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:
- --enable-debugging
- --enable-checking
+ tar -xzf lilypond-X.Y.Z.tar.gz
-Options to configure include:
+ 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.
---enable-printing
- Enable debugging print routines (lilypond -D option)
+ 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-optimise
- Set maximum optimisation: compile with -O2. This can
- be unreliable on some compiler/platform combinations
- (eg, DEC Alpha and PPC)
+1.4 Configuring `make'
+======================
---enable-profiling
- Compile with support for profiling.
+1.4.1 Running `./autogen.sh'
+----------------------------
---enable-config
- Output to a different configuration file. Needed for
- multi-platform builds
+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'.
-All options are documented in the configure help The option
---enable-optimise is recommended for Real Life usage.
+ Next, you need to create the generated files; enter the following
+command from your top source directory:
-If you do
+ ./autogen.sh --noconfigure
- make all
+ This will generate a number of files and directories to aid
+configuration, such as `configure', `README.txt', etc.
-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).
+ Next, create the build directory with:
-7: CONFIGURING FOR MULTIPLE PLATFORMS
+ mkdir build/
+ cd build/
-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 profil-
-ing. Then I'd use the following for the normal build,
+ We heavily recommend building lilypond inside a separate directory
+with this method.
- ./configure --prefix=~ --disable-optimise --enable-checking
- make
- make install
+1.4.2 Running `../configure'
+----------------------------
-and for the profiling version, I specify a different config-
-uration.
+Configuration options
+.....................
- ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
- make config=optprof
- make config=optprof install
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
-8: INSTALLING
+The `../configure' command (generated by `./autogen.sh') provides many
+options for configuring `make'. To see them all, run:
-If you have done a successful make, then a simple
+ ../configure --help
- make install
+Checking build dependencies
+...........................
-should do the trick.
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
-If you are doing an upgrade, please remember to remove obso-
-lete .pk and .tfm files of the fonts. A script has been
-provided to do the work for you, see bin/clean-fonts.sh.
+When `../configure' is run without any arguments, it will check to make
+sure your system has everything required for compilation:
-CAVEATS
+ ../configure
-o The -O2 option triggers bugs on various platforms
- (PowerPC, Alpha). If you experience problems, you
+ If any build dependency is missing, `../configure' will return with:
- should first try turning off this.
+ ERROR: Please install required programs: FOO
-o On PPC you need at least EGCS-1.1.2f.
+ The following message is issued if you are missing programs that are
+only needed for building the documentation:
-EXAMPLE
+ WARNING: Please consider installing optional programs: BAR
-This is what I type in my xterm:
+ If you intend to build the documentation locally, you will need to
+install or update these programs accordingly.
- lilypond someinput.ly
- tex someinput.tex
- xdvi someinput&
+ 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::.
-This is what the output looks like over here:
+Configuring target directories
+..............................
- 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 ...
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
- hw:~/musix/spacer$ xdvi someinput&
- [1] 855
+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':
-Check out the input files, some of them have comments Please
-refer to the man page for more information.
+ 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''.
-9: REDHAT LINUX
+ A typical installation prefix is `$HOME/usr':
-RedHat Linux users can compile an RPM. A spec file is in
-make/out/lilypond.spec, it is distributed along with the
-sources.
+ ../configure --prefix=$HOME/usr
-You can make the rpm by issuing
+ 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.
- rpm -tb lilypond-x.y.z.tar.gz
- rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+ 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.
-Precompiled i386 RedHat RPMS are available from
-http://linux.umbc.edu/software/lilypond/rpms/.
+ 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.
-10: DEBIAN GNU/LINUX
+ If you encounter any problems, please see *note Problems::.
-A Debian package is also available; contact Anthony Fok
-foka@debian.org. The build scripts are in the subdirectory
-debian/.
+1.5 Compiling LilyPond
+======================
-11: WINDOWS NT/95
+1.5.1 Using `make'
+------------------
-Separate instructions on building for W32 are avaible in the
-file README-W32.yo.
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
-12: AUTHORS
+LilyPond is compiled with the `make' command. Assuming `make' is
+configured properly, you can simply run:
-Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ make
+
+ `make' is short for `make all'. To view a list of `make' targets,
+run:
+
+ make help
+
+ TODO: Describe what `make' actually does.
+
+
+
+See also
+........
+
+
+
+ *note Generating documentation:: provides more info on the `make'
+targets used to build the LilyPond documentation.
+
+1.5.2 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.
+
+1.5.3 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::
+
+1.5.4 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.
+
+1.6 Post-compilation options
+============================
+
+1.6.1 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::.
+
+1.6.2 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_
+ make [-jX CPU_COUNT=X] doc-stage-1 _## to build only PDF documentation_
+
+ * Edit/compile cycle:
+
+ _## edit source files, then..._
+
+ make [-jX] _## needed if editing outside_
+ _## Documentation/, but useful anyway_
+ _## for finding Texinfo errors._
+ make [-jX CPU_COUNT=X] doc _## usually faster than initial build._
+
+ * Reset:
+
+ It is generally possible to remove the compiled documentation from
+ your system with `make doc-clean', but this method is not 100%
+ guaranteed. Instead, if you want to be sure you have a clean
+ system, 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
+
+ or, to build only the PDF documentation and not the HTML,
+
+ make doc-stage-1
+
+ Note: The first time you run `make doc', the process can
+ easily take an hour or more with not much output on the
+ command line.
+
+ After this initial build, `make doc' only makes changes to the
+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.
+
+ `make doc' sends the output from most of the compilation to
+logfiles. If the build fails for any reason, it should prompt you with
+the name of a logfile which will provide information to help you work
+out why the build failed. These logfiles are not deleted with
+`make doc-clean'. To remove all the logfiles generated by the
+compilation process, use:
+
+ make log-clean
+
+ `make doc' compiles the documents for all languages. To save some
+compile time, the English language documents can be compiled on their
+own with:
+
+ make LANGS='' doc
+
+Similarly, it is possible to compile a subset of the translated
+documentation by specifying their language codes on the command line.
+For example, the French and German translations are compiled with:
+
+ make LANGS='de fr' doc
+
+Note that this will also compile the English version.
+
+ Compilation of documentation in Info format with images can be done
+separately by issuing:
+
+ make info
+
+An issue when switching branches between master and translation is the
+appearance/disappearance of translated versions of some manuals. If
+you see such a warning from make:
+
+ No rule to make target `X', needed by `Y'
+
+Your best bet is to delete the file Y.dep and to try again.
+
+Building a single document
+..........................
+
+It's possible to build a single document. For example, to rebuild only
+`contributor.pdf', do the following:
+
+ cd build/
+ cd Documentation/
+ touch ../../Documentation/contributor.texi
+ make out=www out-www/contributor.pdf
+
+ If you are only working on a single document, test-building it in
+this way can give substantial time savings - recreating
+`contributor.pdf', for example, takes a matter of seconds.
+
+Saving time with `CPU_COUNT'
+............................
+
+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:
+
+ 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 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.
+
+AJAX search
+...........
+
+To build the documentation with interactive searching, use:
+
+ make doc AJAX_SEARCH=1
+
+ This requires PHP, and you must view the docs via a http connection
+(you cannot view them on your local filesystem).
+
+ Note: Due to potential security or load issues, this option is
+ not enabled in the official documentation builds. Enable at
+ your own risk.
+
+Installing documentation
+........................
+
+The HTML, PDF and if available Info files can be installed into the
+standard documentation path by issuing
+
+ make install-doc
+
+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.
+
+ To install the Info documentation separately, run:
+
+ make install-info
+
+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.
+
+ 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
+
+ make WEB_TARGETS=online doc
+
+and both `offline' and `online' targets can be generated by issuing
+
+ make WEB_TARGETS="offline online" doc
+
+ Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
+
+ make help
+
+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 "$@"
+
+1.6.3 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.
+
+1.7 Problems
+============
+
+For help and questions use <lilypond-user@gnu.org>. Send bug reports
+to <bug-lilypond@gnu.org>.
+
+ 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
+--------------------
+
+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).
+
+ 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 `<fontconfig>' line. (Adjust as necessary
+for your hierarchy.)
+
+ <dir>/usr/X11R6/lib/X11/fonts</dir>
+
+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
+
+ apt-get install emacs-intl-fonts xfonts-intl-.* \
+ ttf-kochi-gothic ttf-kochi-mincho \
+ xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi
+
+Using lilypond python libraries
+-------------------------------
+
+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.
+
+1.8 Concurrent stable and development versions
+==============================================
+
+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:
+
+ <PATH TO>/lilypond/out/bin/lilypond
+
+ 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.
+
+ So, to use the stable version, install it as usual and use the
+normal commands:
+
+ lilypond foobar.ly
+
+ 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':
+
+ exec <PATH TO>/lilypond/out/bin/lilypond "$@"
+
+ Save it as `Lilypond' (with a capital L to distinguish it from the
+stable `lilypond'), and make it executable:
+
+ chmod +x Lilypond
+
+ Then you can invoke the development version this way:
+
+ Lilypond foobar.ly
+
+ TODO: ADD
+
+ - other compilation tricks for developers
+
+1.9 Build system
+================
+
+We currently use make and stepmake, which is complicated and only used
+by us. Hopefully this will change in the future.
+
+Version-specific texinfo macros
+-------------------------------
+
+ * made with `scripts/build/create-version-itexi.py' and
+ `scripts/build/create-weblinks-itexi.py'
+
+ * used extensively in the `WEBSITE_ONLY_BUILD' version of the
+ website (made with `website.make', used on lilypond.org)
+
+ * not (?) used in the main docs?
+
+ * 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.
-Jan Nieuwenhuizen <janneke@gnu.org>
-Have fun!
projects / lilypond.git / blobdiff