Misc updates for pitches.

[lilypond.git] / Documentation / user / install.itely

diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely
index 08c033b61ce965b6013bfa49b5b21e67ea0965f9..0e62f977f68b6d4e182ceacd5449b982580c2434 100644 (file)
--- a/Documentation/user/install.itely
+++ b/Documentation/user/install.itely
@@ -7,9 +7,10 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
-@c was "INSTALL - compiling and installing GNU LilyPond"
+@ifclear INSTALL
 @node Install
 @chapter Install
+@end ifclear
 
 @c  I don't know what this comment does.  Remove?  -gp
 @ignore
@@ -24,7 +25,7 @@ unstable development releases.  Stable versions have an even-numbered
 versions have an odd-numbered @q{minor} version number (i.e. 2.7, 2.9,
 2.11, etc).
 
-Building LilyPond is an involved process, so we @strong{highly}
+Building LilyPond is a very involved process, so we @strong{highly}
 recommend using the precompiled binaries.
 
 @menu
@@ -46,19 +47,24 @@ at @uref{http://download.linuxaudio.org/lilypond/binaries/}
 We currently create binaries for
 
 @example
-MacOS
-darwin-ppc
-darwin-x86
-freebsd-64
-freebsd-x86
-linux-64
-linux-arm
-linux-ppc
-linux-x86
-mingw
+darwin-ppc  - MacOS X powerpc
+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
 
 
+@c TRANSLATORS:
+@c   Please **do not** translate anything below this line.  Users
+@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
@@ -67,6 +73,7 @@ mingw
 * Downloading source code::     
 * Requirements::                
 * Building LilyPond::           
+* Building documentation without compiling LilyPond::  
 * Testing LilyPond::            
 * Problems::                    
 @end menu
@@ -113,7 +120,7 @@ FOO-devel, libFOO-dev or FOO-dev package too.
 
 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
 
-@item New Century Schoolbook fonts, as PFB files. These are shipped with
+@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}
 
@@ -205,6 +212,8 @@ make out=www web-install
 @node Building LilyPond
 @subsection Building LilyPond
 
+@unnumberedsubsubsec Compiling
+
 To install GNU LilyPond, type
 
 @example
@@ -223,7 +232,7 @@ points into your home directory, e.g.
 @end example
 
 
-@subsection Configuring for multiple platforms
+@unnumberedsubsubsec Compiling for multiple platforms
 
 If you want to build multiple versions of LilyPond with different
 configuration settings, you can use the @code{--enable-config=CONF}
@@ -247,6 +256,47 @@ make conf=prof install
 @end example
 
 
+@node Building documentation without compiling LilyPond
+@subsection Building documentation without compiling LilyPond
+
+The documentation can be built locally without compiling lilypond from
+scratch.
+
+From a fresh git checkout, do
+
+@example
+./autogen.sh   % ignore any warning messages
+cp GNUmakefile.in GNUmakefile
+make -C python
+nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
+% change the lilypond directory as appropriate
+@end example
+
+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
+unstable Lily will fail to build the docs.
+
+You may build the manual ( Documentation/user/ ) without building all
+the input/* stuff.
+
+@refbugs
+
+You may also need to create a script for @command{pngtopnm} and
+@code{pnmtopng}.  On Linux, I use this:
+
+@verbatim
+export LD_LIBRARY_PATH=/usr/lib
+exec /usr/bin/pngtopnm "$@"
+@end verbatim
+
+On OSX, I use this:
+
+@verbatim
+export DYLD_LIBRARY_PATH=/sw/lib
+exec /sw/bin/pngtopnm "$@" 
+@end verbatim
+
+
 @node Testing LilyPond
 @subsection Testing LilyPond
 
@@ -255,8 +305,8 @@ make conf=prof install
 @end html
 
 LilyPond comes with an extensive suite that exercises the entire
-program. This suite can be used to automatically check the impact of a
-change. This is done as follows
+program.  This suite can be used to automatically check the impact of a
+change.  This is done as follows
 
 @example
 make test-baseline
@@ -304,7 +354,7 @@ Bugs that are not fault of LilyPond are documented here.
 @unnumberedsubsubsec Bison 1.875
 
 There is a bug in bison-1.875: compilation fails with "parse error
-before `goto'" in line 4922 due to a bug in bison. To fix, please
+before `goto'" in line 4922 due to a bug in bison.  To fix, please
 recompile bison 1.875 with the following fix
 
 @example
@@ -316,17 +366,6 @@ $ make
 @end example
 
 
-@unnumberedsubsubsec MacOS X
-
-For Fink, use the following command to compile.
-
-@verbatim
-export GUILE=guile-1.6
-export GUILE_CONFIG=guile-1.6-config
-export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
-./configure
-@end verbatim
-
 @unnumberedsubsubsec Solaris
 
 Solaris7, ./configure