@c @n ode Compiling from source
@c @s ection Compiling from source
-
@menu
* Overview of compiling::
* Requirements::
Attempts to compile LilyPond natively on Windows have been
unsuccessful, though a workaround is available (see
-@rcontrib{Lilybuntu}).
+@rcontrib{Lilydev}).
@node Requirements
@item @uref{http://flex.sourceforge.net/, Flex}
@item @uref{http://fontforge.sf.net/, FontForge} (20060125 or
-newer)
+newer; 20100501 or newer is recommended; must be compiled
+with @option{--enable-double}. Failure to do so can lead to
+poor intersection calculations and poorly-rendered glyphs.)
@item @uref{http://www.gnu.org/software/bison/, GNU Bison}
@uref{http://download.linuxaudio.org/lilypond/source/}
@end example
-Download the tarball to your @file{@/~/@/src/} directory, or some
+Download the tarball to your @file{~/src/} directory, or some
other appropriate place.
@warning{Be careful where you unpack the tarball! Any
subdirectories of the current folder named @file{lilypond/} or
-@file{lilypond@/-@var{x.y.z}/} (where @var{x.y.z} is the release
+@file{lilypond-@var{x.y.z}/} (where @var{x.y.z} is the release
number) will be overwritten if there is a name clash with the
tarball.}
@end example
This creates a subdirectory within the current directory called
-@file{lilypond@/-@var{x.y.z}/}. Once unpacked, the source files
+@file{lilypond-@var{x.y.z}/}. Once unpacked, the source files
occupy about 40 MB of disk space.
Windows users wanting to look at the source code may have to
@menu
* Running ./autogen.sh::
-* Running ./configure::
+* Running ../configure::
@end menu
command from your top source directory:
@example
-./autogen.sh
+./autogen.sh --noconfigure
@end example
-This will:
+This will generate a number of files and directories to aid
+configuration, such as @file{configure}, @file{README.txt}, etc.
+
+Next, create the build directory with:
+
+@example
+mkdir build/
+cd build/
+@end example
-@enumerate
-@item generate a number of files and directories to aid
-configuration, such as @file{configure}, @file{README@/.txt}, etc.
+We heavily recommend building lilypond inside a separate directory
+with this method.
-@item automatically run the @command{./configure} command.
-@end enumerate
+@node Running ../configure
+@subsection Running @command{../configure}
-@node Running ./configure
-@subsection Running @command{./configure}
@menu
* Configuration options::
* Checking build dependencies::
* Configuring target directories::
-* Making an out-of-tree build::
@end menu
@node Configuration options
@unnumberedsubsubsec Configuration options
-The @command{./configure} command (generated by
+@warning{make sure that you are in the @file{build/} subdirectory
+of your source tree.}
+
+The @command{../configure} command (generated by
@command{./autogen.sh}) provides many options for configuring
@command{make}. To see them all, run:
@example
-./configure --help
+../configure --help
@end example
@node Checking build dependencies
@unnumberedsubsubsec Checking build dependencies
-When @command{./configure} is run without any arguments, it will
+@warning{make sure that you are in the @file{build/} subdirectory
+of your source tree.}
+
+When @command{../configure} is run without any arguments, it will
check to make sure your system has everything required for
-compilation. This is done automatically when
-@command{./autogen.sh} is run. If any build dependency is
-missing, @command{./configure} will return with:
+compilation:
+
+@example
+../configure
+@end example
+
+If any build dependency is missing, @command{../configure} will
+return with:
@example
ERROR: Please install required programs: @var{foo}
If you intend to build the documentation locally, you will need to
install or update these programs accordingly.
-@warning{@command{./configure} may fail to issue warnings for
+@warning{@command{../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 @ref{Requirements for building
@node Configuring target directories
@unnumberedsubsubsec Configuring target directories
+@warning{make sure that you are in the @file{build/} subdirectory
+of your source tree.}
+
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
-@command{./configure@tie{}--help}:
+@command{../configure@tie{}--help}:
@quotation
By default, `@command{make@tie{}install}' will install all the
-files in @file{/@/usr/@/local/@/bin}, @file{/@/usr/@/local/@/lib} etc. You
-can specify an installation prefix other than @file{/@/usr/@/local}
-using `@code{--prefix}', for instance `@code{--prefix=$HOME}'.
+files in @file{/usr/local/bin}, @file{/usr/local/lib} etc. You
+can specify an installation prefix other than @file{/usr/local}
+using `@option{--prefix}', for instance `@option{--prefix=$HOME}'.
@end quotation
-A typical installation prefix is @file{$HOME/@/usr}:
+A typical installation prefix is @file{$HOME/usr}:
@example
-./configure --prefix=$HOME/usr
+../configure --prefix=$HOME/usr
@end example
Note that if you plan to install a local build on a system where
directory will be automatically created if necessary.
The location of the @command{lilypond} command installed by this
-process will be @file{@var{prefix}/@/bin/@/lilypond}; you may want to
-add @file{@var{prefix}/@/bin/} to your @code{$PATH} if it is not
+process will be @file{@var{prefix}/bin/lilypond}; you may want to
+add @file{@var{prefix}/bin/} to your @code{$PATH} if it is not
already included.
It is also possible to specify separate installation directories
for different types of program files. See the full output of
-@command{./configure@tie{}--help} for more information.
+@command{../configure@tie{}--help} for more information.
If you encounter any problems, please see @ref{Problems}.
-@node Making an out-of-tree build
-@unnumberedsubsubsec Making an out-of-tree build
-
-It is possible to compile LilyPond in a build tree different from
-the source tree, using the @option{--srcdir} option of
-@command{configure}. Note that in some cases you may need to
-remove the output of a previous @command{configure} command by
-running @command{make@tie{}distclean} in the main source directory
-before configuring the out-of-tree build:
-
-@example
-make distclean
-mkdir lily-build && cd lily-build
-@var{sourcedir}/configure --srcdir=@var{sourcedir}
-@end example
-
-
@node Compiling LilyPond
@section Compiling LilyPond
@node Using make
@subsection Using @command{make}
+@warning{make sure that you are in the @file{build/} subdirectory
+of your source tree.}
+
LilyPond is compiled with the @command{make} command. Assuming
@command{make} is configured properly, you can simply run:
If you want to build multiple versions of LilyPond with different
configuration settings, you can use the
-@code{--enable-config=@var{CONF}} option of @command{configure}.
-You should use @code{make@tie{}conf=@var{CONF}} to generate the
-output in @file{out@/-@var{CONF}}. For example, suppose you want to
+@option{--enable-config=@var{conf}} option of @command{configure}.
+You should use @code{make@tie{}conf=@var{conf}} to generate the
+output in @file{out-@var{conf}}. For example, suppose you want to
build with and without profiling, then use the following for the
normal build
If a less verbose build output if desired, the variable
@code{QUIET_BUILD} may be set to @code{1} on @command{make}
-command line, or in @file{local@/.make} at top of the build tree.
+command line, or in @file{local.make} at top of the build tree.
@node Post-compilation options
@end example
If instead, your installation directory is not one that you can
-normally write to (such as the default @file{/@/usr/@/local/}, which
+normally write to (such as the default @file{/usr/local/}, which
typically is only writeable by the superuser), you will need to
temporarily become the superuser when running
@command{make@tie{}install}:
@menu
* Documentation editor's edit/compile cycle::
* Building documentation::
+* Building a single document::
* Saving time with CPU_COUNT::
* AJAX search::
* Installing documentation::
make [-j@var{X}] @emph{## needed if editing outside}
@emph{## Documentation/, but useful anyway}
@emph{## for finding Texinfo errors.}
-touch Documentation/*te?? @emph{## bug workaround}
make [-j@var{X} CPU_COUNT=@var{X}] doc @emph{## usually faster than initial build.}
@end example
@item
Reset:
-@example
-make doc-clean @emph{## use only as a last resort.}
-@end example
+In some cases, it is possible to clean the compiled documentation
+with @samp{make@tie{}doc-clean}, but this method is not guaranteed
+to fix everything. Instead, we recommend that you delete your
+@file{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.
+
@end itemize
@node Building documentation
documentation is already built.
If @command{make@tie{}doc} succeeds, the HTML documentation tree
-is available in @file{out@/-www/@/offline@/-root/}, and can be browsed
+is available in @file{out-www/offline-root/}, and can be browsed
locally. Various portions of the documentation can be found by
-looking in @file{out/} and @file{out@/-www} subdirectories in other
+looking in @file{out/} and @file{out-www} subdirectories in other
places in the source tree, but these are only @emph{portions} of
the docs. Please do not complain about anything which is broken
in those places; the only complete set of documentation is in
-@file{out@/-www/@/offline@/-root/} from the top of the source tree.
+@file{out-www/offline-root/} from the top of the source tree.
+
+@code{make doc} compiles the documents for all languages. To save
+some compile time, the English language documents can be compiled
+on their own with:
+
+@example
+make LANGS='' doc
+@end example
+
+@noindent 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:
+
+@example
+make LANGS='de fr' doc
+@end example
+
+@noindent Note that this will also compile the English version.
Compilation of documentation in Info format with images can be
done separately by issuing:
indiscriminately---it is more efficient to @command{touch} only
the affected files.
+@noindent
+Another typical issue when switching branches between master and
+lilypond/translation is the appearance/disappearance of translated
+versions of some manuals. If you see such a warning from make:
+
+@example
+No rule to make target `X', needed by `Y'
+@end example
+
+@noindent
+Your best bet is to delete the file Y.dep and to try again.
+
+@node Building a single document
+@unnumberedsubsubsec Building a single document
+It's possible to build a single document. For example, to rebuild
+only @file{contributor.pdf}, do the following:
+
+@example
+cd build/
+cd Documentation/
+touch ../../Documentation/contributor.texi
+make out=www out-www/contributor.pdf
+@end example
+
+If you are only working on a single document, test-building it in
+this way can give substantial time savings - recreating
+@file{contributor.pdf}, for example, takes a matter of seconds.
@node Saving time with CPU_COUNT
@unnumberedsubsubsec Saving time with @code{CPU_COUNT}
several simultaneously running @command{lilypond-book} instances,
so the @option{-j} @command{make} option does not significantly
speed up the build process. To help speed it up, the makefile
-variable @option{CPU_COUNT} may be set in @file{local@/.make} or on
+variable @option{CPU_COUNT} may be set in @file{local.make} or on
the command line to the number of @code{.ly} files that LilyPond
should process simultaneously, e.g. on a bi-processor or dual core
machine:
@noindent
Note that to get the images in Info documentation, @code{install-doc}
target creates symbolic links to HTML and PDF installed documentation
-tree in @file{@var{prefix}/@/share/@/info}, in order to save disk space,
+tree in @file{@var{prefix}/share/info}, in order to save disk space,
whereas @code{install-info} copies images in
-@file{@var{prefix}/@/share/@/info} subdirectories.
+@file{@var{prefix}/share/info} subdirectories.
It is possible to build a documentation tree in
-@file{out@/-www/@/online@/-root/}, with special processing, so it can be
+@file{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
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 @file{input/@/@/*} stuff
+You may build the manual without building all the @file{input/*} stuff
(i.e. mostly regression tests): change directory, for example to
@file{Documentation/}, issue @code{make doc}, which will build
-documentation in a subdirectory @file{out@/-www} from the source files in
+documentation in a subdirectory @file{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
export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib:$DYLD_FALLBACK_LIBRARY_PATH
@end example
-Now you must edit the generated @file{config@/.make} file. Change
+Now you must edit the generated @file{config.make} file. Change
@example
FLEXLEXER_FILE = /usr/include/FlexLexer.h
Solaris7, ./configure
-@file{@/./@/configure} needs a POSIX compliant shell. On Solaris7,
-@file{/@/bin/@/sh} is not yet POSIX compliant, but @file{/@/bin/@/ksh} or bash
+@file{./configure} needs a POSIX compliant shell. On Solaris7,
+@file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
is. Run configure like
@example
@unnumberedsubsubsec FreeBSD
To use system fonts, dejaview must be installed. With the default
-port, the fonts are installed in @file{usr/@/X11R6/@/lib/@/X11/@/fonts/@/dejavu}.
+port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
-Open the file @file{$LILYPONDBASE/@/usr/@/etc/@/fonts/@/local@/.conf} and add the
+Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
following line just after the @code{<fontconfig>} line. (Adjust as necessary
for your hierarchy.)
If you want to use lilypond's python libraries (either running
certain build scripts manually, or using them in other programs),
-set @code{PYTHONPATH} to @file{python/@/out} in your build
-directory, or @file{@/.@/.@/./@/usr/@/lib/@/lilypond/@/current/@/python} in the
+set @code{PYTHONPATH} to @file{python/out} in your build
+directory, or @file{.../usr/lib/lilypond/current/python} in the
installation directory structure.
@item
used extensively in the @code{WEBSITE_ONLY_BUILD} version of the
-website (made with @file{website@/.make}, used on lilypond.org)
+website (made with @file{website.make}, used on lilypond.org)
@item
not (?) used in the main docs?
projects / lilypond.git / blobdiff