]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/topdocs/INSTALL.texi
release: 1.3.28
[lilypond.git] / Documentation / topdocs / INSTALL.texi
index c2884623cc06774cb4e8b333abd03e811d85f33e..8678c583b19ff06500f36f2e24d167b2dda06356 100644 (file)
 
 This document explains what you need to install LilyPond, and what you
 should do.  If you are going to compile and install LilyPond often,
-e.g. when doing development, you might want to check out the 
-@file{buildscripts/set-lily.sh} script.  It sets some environment 
-variables and symlinks, which comes in handly when you have to compile 
-LilyPond more often.  
+e.g. when doing development, you might want to check out the
+@file{buildscripts/set-lily.sh} script.  It sets some environment
+variables and symlinks, which comes in handy when you have to compile
+LilyPond more often.
 
 @section Obtaining
 
@@ -61,7 +61,7 @@ NT/95/98 as well.  See Section Windows NT/95,es.
 Check out
 @uref{ftp://ftp.python.org} or @uref{ftp://ftp.cwi.nl/pub/python}.
 
-@item  GUILE 1.3,  check out @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
+@item  GUILE 1.3.4,  check out @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
 
 @item GNU make. 
 Check out @uref{ftp://ftp.gnu.org/make/,ftp://ftp.gnu.org/make/}.
@@ -72,7 +72,8 @@ Check out @uref{ftp://ftp.gnu.org/flex/,ftp://ftp.gnu.org/flex/}.
 @item Bison (version 1.25 or newer).
 Check out @uref{ftp://ftp.gnu.org/bison/,ftp://ftp.gnu.org/bison/}.
 
-@item Texinfo. Check out @uref{ftp://ftp.gnu.org/pub/texinfo/,ftp://ftp.gnu.org/pub/texinfo/}.
+@item Texinfo (version 4.0 or newer). 
+Check out @uref{ftp://ftp.gnu.org/pub/texinfo/,ftp://ftp.gnu.org/pub/texinfo/}.
 Most documentation is in texinfo.
 
 @item The geometry package for LaTeX is needed to use ly2dvi.  
@@ -80,9 +81,13 @@ Available at
 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
 or at mirror site @uref{ftp://ftp.dante.de,ftp://ftp.dante.de}
 
-@item MetaPost, if you want to use direct PostScript output. Please
-note  that  tetex-0.4pl8 (included with Redhat 5.x) does not include
-@file{mfplain.mp}, which is needed  for producing the scaleable font files.
+@item MetaPost, needed for generating PostScript fonts. Please
+note that tetex-0.4pl8 (included with Redhat 5.x) does not include
+@file{mfplain.mp}, which is needed for producing the scalable font
+files.
+
+If you do not want to use PostScript output, edit @file{mf/GNUmakefile}.
+
 
 @end itemize
 
@@ -96,7 +101,7 @@ following software
 @item A PostScript printer and/or viewer (such as Ghostscript) is strongly
     recommended.  Xdvi will show all embedded PostScript too if you have
     Ghostscript installed.
-@item  GUILE 1.3, check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/software/guile/}
+@item  GUILE 1.3.4, check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/software/guile/}
 @end itemize
 
 For running LilyPond successfully you have to help TeX and MetaFont
@@ -123,10 +128,11 @@ and plenty of RAM is recommended for comfortable use.
 The website is the most convenient form to use for reading the
 documentation on-line documentation. It is made by entering @example 
 
-  make website
+  make htmldoc
  
 @end example 
-This does require a fully functioning
+This does require a  functioning  LilyPond. The binary doesn't have to
+be installed. 
 
 If you want to auto-generate Lily's website, you'll need some additional
 conversion tools.
@@ -159,15 +165,16 @@ problem.
 
 You can then install the new pnmtopng into @file{/usr/local/bin/}
 
-@item Bib2html @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html.,http://pertsserver.cs.uiuc.edu/~hull/bib2html.}
+@item @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html,Bib2html}.
     Which, in turn depends on man2html for proper installation.
 man2html can be had from @uref{http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05,http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05}.
 
 The website will build without this utility, but you will not see our
 hypertextified bibliography.
 
-@item Doc++ (optional) to read the source code.
-
+@item @uref{http://www.zib.de/Visual/software/doc++/index.html,DOC++}
+    A documentation system for C++ sources, which is used for the
+    LilyPond sources.
 @end itemize
 
 @section Configuring and compiling
@@ -361,14 +368,10 @@ demonstrated in @file{input/bugs/}.
 
 Known bugs that are not LilyPond's fault are documented here.
 
-@unnumbered All platforms
-@itemize
-@item Guile 1.3.2 is buggy in several respects. Do not use it for LilyPond.
-@end itemize
 
 @unnumbered LinuxPPC Bugs:
 
-@itemize
+@itemize @bullet
 @item egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to 
 fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
 
@@ -381,7 +384,7 @@ Lily herself will break.
 
 @unnumbered Linux-i386
 
-@itemize
+@itemize @bullet
 @item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
 
 Lily will crash during parsing (which suggests a C++ library
@@ -390,12 +393,6 @@ solution are not known.
 
 Note that this only happens on some computers with the said platform.
 
-@item GUILE
-A binary RPM of Guile 1.3 has been distributed from the LilyPond ftp
-site.  This binary was made in RedHat 5.x, and it will fail if this
-RPM is used with RedHat 6.x.
-
-
 @item libg++ 2.7
 
 LilyPond occasionally crashes while parsing the initialisation files.
@@ -430,7 +427,7 @@ versions (LinuxPPC feb '98, RedHat 4.x).
 
 @unnumbered Solaris:
 
-@itemize
+@itemize @bullet
 @item Sparc64/Solaris 2.6, GNU make-3.77
 
 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
@@ -444,7 +441,7 @@ Not yet resolved.
 
 @unnumbered AIX
 
-@itemize
+@itemize @bullet
 @item AIX 4.3 ld
 
 The following is from the gcc install/SPECIFIC file.