Add a TODO comment re grace note spacing.

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

diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely
index 37d4cdd0317a9fccf335a784f690858a5d486ceb..4821926c83157c83cf1a53acaa75b55db2b2cab5 100644 (file)
--- a/Documentation/user/install.itely
+++ b/Documentation/user/install.itely
@@ -47,15 +47,15 @@ at @uref{http://download.linuxaudio.org/lilypond/binaries/}
 We currently create binaries for
 
 @example
-MacOSX-ppc
-MacOSX-x86
-freebsd-64
-freebsd-x86
-linux-64
-linux-arm
-linux-ppc
-linux-x86
-win32-x86
+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
 
 
@@ -83,7 +83,7 @@ win32-x86
 
 Download source
 
-@itemize @bullet
+@itemize
 @item tarballs from
 @uref{http://lilypond.org/download/} by HTTP.
 @item tarballs from
@@ -120,19 +120,15 @@ 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}
 
-@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). 
@@ -159,7 +155,7 @@ header files and libraries.
 
 Running LilyPond requires proper installation of the following software
 
-@itemize @bullet
+@itemize
 
 @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
@@ -190,7 +186,7 @@ make web
 
 Building the website requires some additional tools and packages
 
-@itemize @bullet
+@itemize
 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
 @item ImageMagick
 @item International fonts (see input/regression/utf-8.ly for hints
@@ -236,7 +232,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
@@ -279,6 +275,44 @@ 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
+
+In order to force make to build a complete manual (this does not
+rebuild all examples, only things which are changed), I recommend
+writing a script like this:
+
+@verbatim
+### run from Documentation/user/
+#  possibly required on OSX 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
+out-www/lilypond-program.* ; fi;
+if [ -e out-www/lilypond-learning.texi ]; then rm
+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
@@ -288,8 +322,8 @@ the input/* stuff.
 @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
@@ -337,7 +371,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