X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Finstall.itely;h=cb16e07e057a5d364cfc952ea06aa87036c5be6a;hb=f52e59b15644e5da959b30a2e2d55fd5d5970bcb;hp=6feae60833a85951474ef0687afd2b9dc8219e0d;hpb=40b08aca291b101bcab28ce68088935a0ad07fe2;p=lilypond.git diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely index 6feae60833..cb16e07e05 100644 --- a/Documentation/user/install.itely +++ b/Documentation/user/install.itely @@ -7,7 +7,7 @@ version that you are working on. See TRANSLATION for details. @end ignore -@c \version "2.11.51" +@c \version "2.11.61" @ifclear INSTALL @node Install @@ -47,22 +47,43 @@ 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:: @@ -115,7 +136,8 @@ FOO-devel, libFOO-dev or FOO-dev package too. @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer. -@item MetaFont (mf-nowin, mf, mfw or mfont binaries) and MetaPost +@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. @@ -180,7 +202,7 @@ 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} @@ -193,6 +215,10 @@ 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. +@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 @@ -333,17 +359,25 @@ less verbose build output, just like for building the programs. @knownissues -@code{-j} command-line option of @command{make} is unsupported for -building the documentation. As the most time consuming task is -running LilyPond to build images of music, the makefile variable -@code{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 +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 CPU_COUNT=2 web +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