X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fcompile.itely;h=f5974903236429fc8308a6eee59c002341180280;hb=3fc5b244e6c7967dcc768d434166408c614bcc5d;hp=5ceaa5772069a310e99866e8964eb18aaaf188fa;hpb=1ec1d313a266eb82fc0590bf8487ad5b305c4849;p=lilypond.git diff --git a/Documentation/user/compile.itely b/Documentation/user/compile.itely index 5ceaa57720..f597490323 100644 --- a/Documentation/user/compile.itely +++ b/Documentation/user/compile.itely @@ -50,6 +50,27 @@ For information on packaging, see @uref{http://lilypond.org/devel}. In addition to the packages needed for running LilyPond (see below), you need the following extra packages for building. +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 + +@multitable @columnfractions .5 .5 +@headitem Distribution +@tab Command + +@item Debian, Ubuntu +@tab @code{sudo apt-get build-dep lilypond} + +@item Fedora, RHEL +@tab @code{sudo yum-builddep lilypond} + +@item openSUSE, SLED +@c sorry for the idiosyncratic command, I really asked and argued +@c for "zypper build-dep" :-( +@tab @code{sudo zypper --build-deps-only source-install lilypond} + +@end multitable + When installing a binary package FOO, you may need to install the FOO-devel, libFOO-dev or FOO-dev package too. @@ -89,7 +110,7 @@ newer. 4.x is strongly recommended). @item @uref{http://www.perl.org/,Perl}. -@item @uref{http://www.gnu.org/software/flex/,GNU Bison}. +@item @uref{http://www.gnu.org/software/bison/,GNU Bison}. @item All packages required for running, including development packages with header files and libraries. @@ -224,7 +245,7 @@ LilyPond binary. The documentation is built by issuing @example -make web +make doc @end example After compilation, the HTML documentation tree is available in @@ -234,7 +255,7 @@ The HTML, PDF and if available Info files can be installed into the standard documentation path by issuing @example -make web-install +make install-doc @end example @noindent @@ -253,14 +274,14 @@ make info Separate installation of this documentation is done by issuing @example -make info-install +make install-info @end example @noindent -Note that to get the images in Info documentation, @code{web-install} +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, -whereas @code{info-install} copies images in +whereas @code{install-info} copies images in @file{@var{prefix}/share/info} subdirectories. It is possible to build a documentation tree in @@ -269,14 +290,14 @@ used on a website with content negotiation for automatic language selection; this can be achieved by issuing @example -make WEB_TARGETS=online web +make WEB_TARGETS=online doc @end example @noindent and both @q{offline} and @q{online} targets can be generated by issuing @example -make WEB_TARGETS="offline online" web +make WEB_TARGETS="offline online" doc @end example Several targets are available to clean the documentation build and @@ -310,7 +331,7 @@ in @file{local.make} or on the command line to the number of a bi-processor or dual core machine @example -make -j3 CPU_COUNT=3 web +make -j3 CPU_COUNT=3 doc @end example @noindent @@ -321,7 +342,7 @@ 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 +run @code{make doc-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. @@ -344,7 +365,7 @@ From a fresh Git checkout, do ./autogen.sh # ignore any warning messages cp GNUmakefile.in GNUmakefile make -C python -nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web +nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc @end example Please note that this may break sometimes -- for example, if a new @@ -353,7 +374,7 @@ development release of LilyPond will fail to build the docs. 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 +issue @code{make doc}, 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