]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
release: 1.3.83
[lilypond.git] / INSTALL.txt
index 5c5754ea88b6235872bdecaa39b05cbe64405fcd..73a3a997dda2fa1c614d5f816eb10922d73c9df0 100644 (file)
@@ -10,7 +10,7 @@ Abstract
 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
 `buildscripts/set-lily.sh' script.  It sets some environment variables
-and symlinks, which comes in handly when you have to compile LilyPond
+and symlinks, which comes in handy when you have to compile LilyPond
 more often.
 
 Obtaining
@@ -48,26 +48,32 @@ Prerequisites
    * Although we recommend to use Unix, LilyPond is known to run on
      Windows NT/95/98 as well.  See Section Windows NT/95,es.
 
-   * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
+   * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/gnu/gcc/'.
 
    * Python 1.5, Check out `ftp://ftp.python.org' or
      `ftp://ftp.cwi.nl/pub/python'.
 
-   * GUILE 1.3,  check out http://www.gnu.org/software/guile/guile.html
-     (http://www.gnu.org/software/guile/guile.html).
+   * GUILE 1.3.4 or newer,  check out
+     http://www.gnu.org/software/guile/guile.html
+     (http://www.gnu.org/software/guile/guile.html).  Version 1.4 is
+     recommended for better performance.
 
-   * GNU make.  Check out ftp://ftp.gnu.org/make/
-     (ftp://ftp.gnu.org/make/).
+   * GNU Make.  Check out ftp://ftp.gnu.org/gnu/make/
+     (ftp://ftp.gnu.org/gnu/make/).
 
-   * Flex (version 2.5.4 or newer).  Check out ftp://ftp.gnu.org/flex/
-     (ftp://ftp.gnu.org/flex/).
+   * Flex (version 2.5.4 or newer).  Check out
+     ftp://ftp.gnu.org/gnu/flex/ (ftp://ftp.gnu.org/gnu/flex/).
 
-   * Bison (version 1.25 or newer).  Check out ftp://ftp.gnu.org/bison/
-     (ftp://ftp.gnu.org/bison/).
+   * Bison (version 1.25 or newer).  Check out
+     ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
 
-   * Texinfo. Check out ftp://ftp.gnu.org/pub/texinfo/
-     (ftp://ftp.gnu.org/pub/texinfo/).  Most documentation is in
-     texinfo.
+   * TeX.  If you want LilyPond to use kpathsea support (recommended),
+     make sure you have tetex 1.0 or newer (1.0.6 is known to work).
+     You may need to install a tetex-devel or tetex-dev package too.
+
+   * Texinfo (version 4.0 or newer).  Check out
+     ftp://ftp.gnu.org/gnu/texinfo/ (ftp://ftp.gnu.org/gnu/texinfo/).
+     Most documentation is in texinfo.
 
    * The geometry package for LaTeX is needed to use ly2dvi.  Available
      at
@@ -75,11 +81,16 @@ Prerequisites
      (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
      or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
 
-   * MetaPost, if you want to use direct PostScript output. Please note
-     that  tetex-0.4pl8 (included with Redhat 5.x) does not include
-     `mfplain.mp', which is needed  for producing the scaleable font
+   * MetaPost, needed for generating PostScript fonts. Please note that
+     tetex-0.4pl8 (included with Redhat 5.x) does not include
+     `mfplain.mp', which is needed for producing the scalable font
      files.
 
+     If you do not want to use PostScript output, edit `mf/GNUmakefile'.
+
+   * kpathsea, a library for searching (TeX) files.  `kpathsea' is
+     usually included with your installation of TeX.
+
 
 Running
 =======
@@ -87,13 +98,13 @@ Running
    GNU LilyPond does use a lot of resources. For operation you need the
 following software
 
-   * TeX
+   * TeX.
 
    * A PostScript printer and/or viewer (such as Ghostscript) is
      strongly     recommended.  Xdvi will show all embedded PostScript
      too if you have     Ghostscript installed.
 
-   * GUILE 1.3, check out http://www.gnu.org/software/guile/
+   * GUILE 1.3.4, check out http://www.gnu.org/software/guile/
      (http://www.gnu.org/programs/guile.html)
 
    For running LilyPond successfully you have to help TeX and MetaFont
@@ -117,8 +128,9 @@ Website
    The website is the most convenient form to use for reading the
 documentation on-line documentation. It is made by entering
 
-       make website
-   This does require a fully functioning
+       make htmldoc
+   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.
@@ -149,18 +161,15 @@ additional conversion tools.
 
      You can then install the new pnmtopng into `/usr/local/bin/'
 
-   * Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
-     (http://pertsserver.cs.uiuc.edu/~hull/bib2html.)      Which, in
-     turn depends on man2html for proper installation.  man2html can be
-     had from
+   * Bib2html (http://pertsserver.cs.uiuc.edu/~hull/bib2html).
+     Which, in turn depends on man2html for proper installation.
+     man2html can be had from
      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.
 
-   * Doc++ (optional) to read the source code.
-
 
 Configuring and compiling
 =========================
@@ -175,17 +184,20 @@ Configuring and compiling
 
    This will install a number of files, something close to:
 
-       /usr/local/man/man1/mi2mu.1
+       /usr/local/man/man1/midi2ly.1
+       /usr/local/man/man1/abc2ly.1
+       /usr/local/man/man1/etf2ly.1
        /usr/local/man/man1/convert-mudela.1
        /usr/local/man/man1/mudela-book.1
        /usr/local/man/man1/lilypond.1
        /usr/local/bin/lilypond
-       /usr/local/bin/mi2mu
+       /usr/local/bin/midi2ly
        /usr/local/bin/convert-mudela
        /usr/local/bin/mudela-book
        /usr/local/bin/abc2ly
+       /usr/local/bin/etf2ly
        /usr/local/share/lilypond/*
-       /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
+       /usr/local/share/locale/{....}/LC_MESSAGES/lilypond.mo
 
    The above assumes that you are root and have the GNU development
 tools, and your make is GNU make.  If this is not the case, you can
@@ -288,10 +300,7 @@ Redhat linux
        rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 
    Precompiled i386 RedHat RPMS are available from
-ftp://freshmeat.net/pub/rpms/lilypond/
-(ftp://freshmeat.net/pub/rpms/lilypond/) and
-http://linux.umbc.edu/software/lilypond/rpms/
-(http://linux.umbc.edu/software/lilypond/rpms/).
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
 
    For compilation on a RedHat system you need these packages, in
 addition to the those needed for running:
@@ -310,8 +319,11 @@ addition to the those needed for running:
 Debian GNU/linux
 ================
 
-   A Debian package is also available; contact Anthony Fok
-<foka@debian.org>.  The build scripts are in the subdirectory `debian/'.
+   A Debian package is also available; see
+http://packages.debian.org/lilypond
+(http://packages.debian.org/lilypond) or contact Anthony Fok
+<foka@debian.org> for more information.  The build scripts are in the
+subdirectory `debian/'.
 
 Windows NT/95
 =============
@@ -328,16 +340,10 @@ your problems.
 
    If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
 
-   Known bugs that are LilyPond's fault are listed in `TODO', or
-demonstrated in `input/bugs/'.
+   Bugs that are LilyPond's fault are listed in our TODO list on the
+web, or demonstrated in `input/bugs/'.
 
-   Known bugs that are not LilyPond's fault are documented here.
-
-All platforms
-*************
-
-   * Guile 1.3.2 is buggy in several respects. Do not use it for
-     LilyPond.
+   Bugs that are not LilyPond's fault are documented here.
 
 LinuxPPC Bugs:
 **************
@@ -361,10 +367,6 @@ Linux-i386
      Note that this only happens on some computers with the said
      platform.
 
-   * 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.
-
    * libg++ 2.7
 
      LilyPond occasionally crashes while parsing the initialisation