X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Finstall.itely;h=151d08b58f79d9a9ec35b29df1c7a9c60f2d4b41;hb=18c8f740f67e6063de22296054f78c6218f8d224;hp=cc0ca9764b3b32d381217ebdad551cdc257a3466;hpb=555d8e498a31380d62be9f4853ab514b3786e986;p=lilypond.git diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely index cc0ca9764b..151d08b58f 100644 --- a/Documentation/user/install.itely +++ b/Documentation/user/install.itely @@ -110,7 +110,7 @@ For information on packaging, see @uref{http://lilypond.org/devel}. @unnumberedsubsubsec Compilation -In addition to the packages needed for running Lilypond (see below), you +In addition to the packages needed for running LilyPond (see below), you need the following extra packages for building. When installing a binary package FOO, you may need to install the @@ -124,15 +124,11 @@ FOO-devel, libFOO-dev or FOO-dev package too. X11 and Ghostscript, and are named @file{c059033l.pfb} @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb} -@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or -newer); you may need to install some additional packages to get mftrace -to work. - @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 install guile-devel or guile-dev or libguile-dev too. -@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer). +@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.11 or newer). @item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or newer). @@ -181,14 +177,8 @@ 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. The -documentation is built by issuing - -@example -make web -@end example - -Building the website requires some additional tools and packages +This process requires a successful compile of LilyPond, and some +additional tools and packages @itemize @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} @@ -201,13 +191,38 @@ and the patch from @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}. @end itemize -The HTML files can be installed into the standard documentation path -by issuing +The documentation is built by issuing + +@example +make web +@end example + +After compilation, the HTML documentation tree is available in +@file{out-www/offline-root/}, and can be browsed locally. + +The HTML and PDF files can be installed into the standard documentation +path by issuing @example make out=www web-install @end example +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; +this can be achieved by issuing + +@example +make WEB_TARGETS=online web +@end example + +@noindent +and both @q{offline} and @q{online} targets can be generated by issuing + +@example +make WEB_TARGETS="offline online" web +@end example + @node Building LilyPond @subsection Building LilyPond @@ -236,7 +251,7 @@ points into your home directory, e.g. If you want to build multiple versions of LilyPond with different configuration settings, you can use the @code{--enable-config=CONF} -option of configure. You should use @samp{make conf=CONF} to generate +option of configure. You should use @code{make conf=CONF} to generate the output in @file{out-CONF}. Example: Suppose you want to build with and without profiling, then use the following for the normal build @@ -259,7 +274,7 @@ make conf=prof install @node Building documentation without compiling LilyPond @subsection Building documentation without compiling LilyPond -The documentation can be built locally without compiling lilypond from +The documentation can be built locally without compiling LilyPond from scratch. From a fresh git checkout, do @@ -279,7 +294,7 @@ unstable Lily will fail to build the docs. You may build the manual ( Documentation/user/ ) without building all the input/* stuff. -@refbugs +@knownissues You may also need to create a script for @command{pngtopnm} and @code{pnmtopng}. On Linux, I use this: @@ -289,7 +304,7 @@ export LD_LIBRARY_PATH=/usr/lib exec /usr/bin/pngtopnm "$@" @end verbatim -On OSX, I use this: +On MacOS@tie{}X, I use this: @verbatim export DYLD_LIBRARY_PATH=/sw/lib @@ -302,7 +317,7 @@ writing a script like this: @verbatim ### run from Documentation/user/ -# possibly required on OSX and/or old texinfo +# possibly required on OS X and/or old texinfo # ulimit -n 4096 if [ -e out-www/lilypond.texi ]; then rm out-www/lilypond.* ; fi; if [ -e out-www/lilypond-program.texi ]; then rm @@ -312,6 +327,11 @@ out-www/lilypond-learning.* ; fi; nice make LILYPOND_EXTERNAL_BINARY=~/usr/bin/lilypond web @end verbatim +To rebuild the complete HTML docs, run the above script from the +@file{Documentation/user/} directory, then run the final line (the +@code{nice make}) from the top source dir. + + @node Testing LilyPond @subsection Testing LilyPond @@ -417,7 +437,7 @@ for your hierarchy.) @unnumberedsubsubsec International fonts -On MacOs X, all fonts are installed by default. However, finding all +On MacOS@tie{}X, all fonts are installed by default. However, finding all system fonts requires a bit of configuration; see @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html, this post} on the @code{lilypond-user} mailing list.