]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/compile.itely
Imported Upstream version 2.12.3
[lilypond.git] / Documentation / user / compile.itely
index 15227251bd15057f4b218eb759ebd54754521b44..243df4bdceeecd64cd5695d60737603e120aa0ee 100644 (file)
@@ -89,7 +89,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,38 +224,59 @@ LilyPond binary.
 The documentation is built by issuing
 
 @example
-make web
+make doc
 @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
+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
 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.
+prefix is properly set; otherwise, instructions to complete proper
+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;
-this can be achieved by issuing
+Compilation of documentation in Info format with images can be done
+separately by issuing
 
 @example
-make WEB_TARGETS=online web
+make info
+@end example
+
+@noindent
+Separate installation of this documentation is done by issuing
+
+@example
+make install-info
+@end example
+
+@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,
+whereas @code{install-info} copies images in
+@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
+used on a website with content negotiation for automatic language
+selection; this can be achieved by issuing
+
+@example
+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
@@ -269,12 +290,14 @@ make help
 @noindent
 from every directory in the build tree.  Most targets for
 documentation maintenance are available from @file{Documentation/};
-for more information, see @file{Documentation/user/README.txt} and
-@file{Documentation/TRANSLATION}.
+@c FIXME: xref to CG
+for more information, see the Contributors' Guide, section
+@emph{Documentation work}.
 
 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
@@ -287,7 +310,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
@@ -298,7 +321,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.
@@ -321,7 +344,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
@@ -330,7 +353,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