X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Finstall.itely;h=59e99e0481b5997ebe2b77fd5b7174712266b5ff;hb=9c3ecc7d6e596e8151a58ce7ed0dd9e1b0802d1e;hp=18c1c6fe1b4fd1fdbfd88d56407af7b2054e8de5;hpb=1bc5dc8562745eb82f0cd92a6011786b7b61c434;p=lilypond.git diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely index 18c1c6fe1b..59e99e0481 100644 --- a/Documentation/user/install.itely +++ b/Documentation/user/install.itely @@ -7,20 +7,13 @@ version that you are working on. See TRANSLATION for details. @end ignore -@c \version "2.11.38" +@c \version "2.12.0" @ifclear INSTALL @node Install @chapter Install @end ifclear -@c I don't know what this comment does. Remove? -gp -@ignore -@h tml - -@e nd html -@end ignore - There are two sets of releases for LilyPond: stable releases, and unstable development releases. Stable versions have an even-numbered @q{minor} version number (i.e. 2.8, 2.10, 2.12, etc). Development @@ -31,15 +24,15 @@ Building LilyPond is a very involved process, so we @strong{highly} recommend using the precompiled binaries. @menu -* Precompiled binaries:: -* Compiling from source:: +* Precompiled binaries:: +* Compiling from source:: @end menu @node Precompiled binaries @section Precompiled binaries -@subsection Downloading +@unnumberedsubsec Downloading Check out @uref{http://lilypond.org/web/install/} for up to date information on binary packages for your platform. If your operating @@ -54,30 +47,51 @@ darwin-x86 - MacOS X intel freebsd-64 - FreeBSD 6.x, x86_64 freebsd-x86 - FreeBSD 4.x, x86 linux-64 - Any GNU/Linux distribution, x86_64 -linux-arm - Any GNU/Linux distribution, arm linux-ppc - Any GNU/Linux distribution, powerpc linux-x86 - Any GNU/Linux distribution, x86 mingw - Windows x86 @end example +@knownissues + +If you have MacOS 10.3 or 10.4 and you would like to use Python +scripts such as @command{convert-ly} and @command{lilypond-book}, see +@ref{Setup for MacOS X,,,lilypond-program,Application Usage}. + + +@node Compiling from source +@section Compiling from source + +@ignore +You can also compile LilyPond directly from the source code. This +requires that you can read English, so this section is not +translated. If you really want to compile LilyPond, see +@iftex +@c DO NOT translate the following line at all. +@ref{Compiling from source,,,lilypond-program,Application Usage}. +@end iftex +@ifhtml +@c Please translate the following line (but not the .html file name) +the @uref{Compiling-from-source.html,documentation in English}. +@end ifhtml +@end ignore @c TRANSLATORS: @c Please **do not** translate anything below this line. Users -@c should not be compiling LilyPond themselves; if they really +@c should not be compiling LilyPond themselves; if they really @c want to do so, they should be able to read the English docs, @c because they'll probably need to ask questions in English @c on the -devel list. -gp - -@node Compiling from source -@section Compiling from source +@c Instead, please uncomment and translate the paragraph above, +@c and remove all stuff (menu, nodes, contents) below this line. @menu -* Downloading source code:: -* Requirements:: -* Building LilyPond:: -* Building documentation:: -* Testing LilyPond:: -* Problems:: +* Downloading source code:: +* Requirements:: +* Building LilyPond:: +* Building documentation:: +* Testing LilyPond:: +* Problems:: @end menu @node Downloading source code @@ -90,7 +104,7 @@ Download source @uref{http://lilypond.org/download/} by HTTP. @item tarballs from @uref{http://download.linuxaudio.org/lilypond/} by HTTP. -@item +@item GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org} @example @@ -122,9 +136,17 @@ FOO-devel, libFOO-dev or FOO-dev package too. @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer. +@item @uref{http://metafont.tutorial.free.fr/,MetaFont} (mf-nowin, mf, mfw or +mfont binaries) and @uref{http://cm.bell-labs.com/who/hobby/MetaPost.html,MetaPost} +(mpost binary), usually packaged with a @LaTeX{} distribution like +tetex or texlive. + +@item @uref{http://www.lcdf.org/~eddietwo/type/#t1utils,t1utils} +(version 1.33 or newer recommended). + @item New Century Schoolbook fonts, as PFB files. These are shipped with X11 and Ghostscript, and are named @file{c059033l.pfb} -@file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb} +@file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}. @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.8.2 or newer). If you are installing binary packages, you may need to @@ -139,13 +161,14 @@ newer. 4.x is strongly recommended). @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer). -@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}. +@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext} +(version 0.17 or newer). -@item @uref{http://www.gnu.org/software/flex/,Flex} +@item @uref{http://www.gnu.org/software/flex/,Flex}. -@item @uref{http://www.perl.org/,Perl} +@item @uref{http://www.perl.org/,Perl}. -@item @uref{http://www.gnu.org/software/flex/,GNU Bison} +@item @uref{http://www.gnu.org/software/flex/,GNU Bison}. @item All packages required for running, including development packages with header files and libraries. @@ -160,14 +183,14 @@ Running LilyPond requires proper installation of the following software @itemize @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer). -@item @uref{http://www.freetype.org/,FontConfig} (version 2.2). +@item @uref{http://fontconfig.org/,FontConfig} (version 2.2 or newer). @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer). @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.8.2 or newer), or patch 1.8.1 with @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}. @item @uref{http://www.python.org,Python} (version 2.4 or newer). @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or -newer. 8.50 recommended) +newer. 8.60 recommended) @item Dejaview. (This is normally installed by default) @end itemize @@ -180,19 +203,21 @@ or lyrics. You can view the documentation online at @uref{http://lilypond.org/doc/}, but you can also build it locally. This process requires a successful compile of LilyPond, and some -additional tools and packages +additional tools and packages: @itemize @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} @item ImageMagick @item International fonts (see input/regression/utf-8.ly for hints about which font packages are necessary for your platform) -@item Ghostscript, 8.50 with the patch from +@item Ghostscript 8.60 or newer, or 8.50 with the patch from @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154} and the patch from -@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}, or use -a release of Ghostscript which includes these patches, for example -8.60 or newer. +@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}. +@item @uref{http://www.nongnu.org/texi2html/,Texi2HTML} 1.79 or newer +is strongly recommended to build documentation in HTML; support for +building HTML documentation using @command{makeinfo} from GNU Texinfo +is deprecated. @end itemize @@ -255,6 +280,14 @@ mkdir lily-build && cd lily-build @end example + +@unnumberedsubsubsec Useful @command{make} variables + +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. + + @node Building documentation @subsection Building documentation @@ -285,6 +318,11 @@ path by issuing make web-install @end example +@noindent +This also installs Info documentation with images if the installation +prefix is properly set; otherwise, instructions for manual installation +of Info documentation are printed on standard output. + It is also possible to build a documentation tree in @file{out-www/online-root/}, with special processing, so it can be used on a website with content negotiation for automatic language selection; @@ -315,6 +353,42 @@ documentation maintenance are available from @file{Documentation/}; for more information, see @file{Documentation/user/README.txt} and @file{Documentation/TRANSLATION}. +The makefile variable @code{QUIET_BUILD} may be set to @code{1} for a +less verbose build output, just like for building the programs. + +@knownissues + +The most time consuming task for building the documentation is running +LilyPond to build images of music, and there cannot be several +simultaneously running @command{lilypond-book} instances, so @code{-j} +@command{make} option does not significantly speed up the build process. +To help speed it up, the makefile variable @var{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 + +@example +make -j3 CPU_COUNT=3 web +@end example + +@noindent +The recommended value of @var{CPU_COUNT} is one plus the number of +cores or processors, but it is advisable to set it to a smaller value +if your system has not enough RAM to run that many simultaneous +LilyPond instances. + +If source files have changed since last documentation build, output +files that need to be rebuilt are normally rebuilt, even if you do not +run @code{make web-clean} first. However, building dependencies in the +documentation are so complex that rebuilding of some targets may not +be triggered as they should be; a workaround is to force rebuilding +by touching appropriate files, e.g. + +@example +touch Documentation/user/*.itely +touch input/lsr/*.ly +@end example + @node Building documentation without compiling LilyPond @unnumberedsubsubsec Building documentation without compiling LilyPond @@ -335,13 +409,12 @@ 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: change directory, for example to -@file{Documentation/user}, issue @code{make web}, which will build -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 +You may build the manual without building all the @file{input/*} +stuff: change directory, for example to @file{Documentation/user}, +issue @code{make web}, which will build 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 @example make out=www WWW-post @@ -361,7 +434,7 @@ On MacOS@tie{}X, I use this: @verbatim export DYLD_LIBRARY_PATH=/sw/lib -exec /sw/bin/pngtopnm "$@" +exec /sw/bin/pngtopnm "$@" @end verbatim @@ -404,11 +477,11 @@ CVS; especially the following patch: For checking the coverage of the test suite, do the following @example -./buildscripts/build-coverage.sh +./scripts/auxiliar/build-coverage.sh @emph{# uncovered files, least covered first} -python ./buildscripts/coverage.py --summary out-cov/*.cc -@emph{# consecutive uncovered lines, longest first} -python ./buildscripts/coverage.py --uncovered out-cov/*.cc +./scripts/auxiliar/coverage.py --summary out-cov/*.cc +@emph{# consecutive uncovered lines, longest first} +./scripts/auxiliar/coverage.py --uncovered out-cov/*.cc @end example @@ -485,12 +558,12 @@ hints, though: Red Hat Fedora taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \ - ttfonts-zh_CN fonts-ja fonts-hebrew + 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 + xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi @end verbatim