]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
projects / lilypond.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
* stepmake/aclocal.m4: version check patch (thanks MWD)
[lilypond.git] / INSTALL.txt
diff --git a/INSTALL.txt b/INSTALL.txt
index cf0e511331e8e1ce4525bea0c0ce2e0e41a7b681..2a431f3a5c0a8c6d9eb00db2c5f15db14fcb0160 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -3,6 +3,16 @@
 INSTALL - compiling and installing GNU LilyPond
 ***********************************************
 
 INSTALL - compiling and installing GNU LilyPond
 ***********************************************
 
+Abstract
+========
+
+   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
+`buildscripts/set-lily.sh' script.  It sets some environment variables
+and symlinks, which comes in handly when you have to compile LilyPond
+more often.
+
 Obtaining
 =========
 
 Obtaining
 =========
 
@@ -29,7 +39,7 @@ Prerequisites
 
    * A GNU system: GNU LilyPond is known to run on these GNU systems:
      Linux     (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
 
    * A GNU system: GNU LilyPond is known to run on these GNU systems:
      Linux     (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
-     and     Solaris.
+     and Solaris.
 
    * Lots of disk space: LilyPond takes between 30 and 100 mb to
      compile if you use debugging information.  If you are short on
 
    * Lots of disk space: LilyPond takes between 30 and 100 mb to
      compile if you use debugging information.  If you are short on
@@ -38,32 +48,27 @@ 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.
 
    * 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/gnu/gcc/'.
+   * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
 
    * Python 1.5, Check out `ftp://ftp.python.org' or
      `ftp://ftp.cwi.nl/pub/python'.
 
 
    * Python 1.5, Check out `ftp://ftp.python.org' or
      `ftp://ftp.cwi.nl/pub/python'.
 
-   * GUILE 1.3.4 or newer,  check out
+   * GUILE 1.3.4,  check out
      http://www.gnu.org/software/guile/guile.html
      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/gnu/make/
-     (ftp://ftp.gnu.org/gnu/make/).
+     (http://www.gnu.org/software/guile/guile.html).
 
 
-   * Flex (version 2.5.4a or newer).  Check out
-     ftp://ftp.gnu.org/gnu/flex/ (ftp://ftp.gnu.org/gnu/flex/).
+   * GNU make.  Check out ftp://ftp.gnu.org/make/
+     (ftp://ftp.gnu.org/make/).
 
 
-   * Bison (version 1.25 or newer).  Check out
-     ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
+   * Flex (version 2.5.4 or newer).  Check out ftp://ftp.gnu.org/flex/
+     (ftp://ftp.gnu.org/flex/).
 
 
-   * 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.
+   * Bison (version 1.25 or newer).  Check out ftp://ftp.gnu.org/bison/
+     (ftp://ftp.gnu.org/bison/).
 
 
-   * 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.
+   * Texinfo. Check out ftp://ftp.gnu.org/pub/texinfo/
+     (ftp://ftp.gnu.org/pub/texinfo/).  Most documentation is in
+     texinfo.
 
    * The geometry package for LaTeX is needed to use ly2dvi.  Available
      at
 
    * The geometry package for LaTeX is needed to use ly2dvi.  Available
      at
@@ -71,17 +76,11 @@ Prerequisites
      (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
      or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
 
      (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
      or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
 
-   * 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
+   * 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
      files.
 
      files.
 
-     If you do not want to use PostScript output, edit `mf/GNUmakefile',
-     removing the line saying `PFA_FILES='
-
-   * kpathsea, a library for searching (TeX) files.  `kpathsea' is
-     usually included with your installation of TeX.
-
 
 Running
 =======
 
 Running
 =======
@@ -89,7 +88,7 @@ Running
    GNU LilyPond does use a lot of resources. For operation you need the
 following software
 
    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
 
    * A PostScript printer and/or viewer (such as Ghostscript) is
      strongly     recommended.  Xdvi will show all embedded PostScript
@@ -100,17 +99,18 @@ following software
 
    For running LilyPond successfully you have to help TeX and MetaFont
 find various files.  The recommended way of doing so is adjusting the
 
    For running LilyPond successfully you have to help TeX and MetaFont
 find various files.  The recommended way of doing so is adjusting the
-environment variables in the start-up scripts of your shell. Appropriate
-Csh and sh scripts are left in `buildscripts/out/lilypond-profile' and
-`buildscripts/out/lilypond-login' after compilation.
+environment variables in the start-up scripts of your shell.  An
+example is given here for the Bourne shell:
+     export MFINPUTS="/usr/local/share/lilypond/mf:"
+     export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
 
 
-   The empty path component represents TeX and MetaFont's default search
-paths.  Scripts with the proper paths for the bourne and C-shell
+   The empty path component represents TeX and MetaFont's default
+search paths.  Scripts with the proper paths for the bourne and C-shell
 respectively are generated in `buildscripts/out/lilypond-profile' and
 `buildscripts/out/lilypond-login' during compilation.
 
 respectively are generated in `buildscripts/out/lilypond-profile' and
 `buildscripts/out/lilypond-login' during compilation.
 
-   LilyPond is a big and slow program.  A fast CPU and plenty of RAM is
-recommended for comfortable use.
+   LilyPond is a hiddeously big, slow and bloated program.  A fast CPU
+and plenty of RAM is recommended for comfortable use.
 
 Website
 =======
 
 Website
 =======
@@ -118,9 +118,8 @@ Website
    The website is the most convenient form to use for reading the
 documentation on-line documentation. It is made by entering
 
    The website is the most convenient form to use for reading the
 documentation on-line documentation. It is made by entering
 
-       make htmldoc
-   This does require a  functioning  LilyPond. The binary doesn't have
-to be installed.
+       make website
+   This does require a fully functioning
 
    If you want to auto-generate Lily's website, you'll need some
 additional conversion tools.
 
    If you want to auto-generate Lily's website, you'll need some
 additional conversion tools.
@@ -138,22 +137,37 @@ additional conversion tools.
 
      The version of `pnmtopng' that is distributed with RedHat 5.1 and
      5.2 contains a bug: pnmtopng is dynamically linked to the wrong
 
      The version of `pnmtopng' that is distributed with RedHat 5.1 and
      5.2 contains a bug: pnmtopng is dynamically linked to the wrong
-     version of libpng.
-
-   * Bib2html (http://pertsserver.cs.uiuc.edu/~hull/bib2html).
-     Which, in turn depends on man2html for proper installation.
-     man2html can be had from
+     version of libpng, which results in cropped images.  Recompile it
+     from source, and make sure that the pnmtopng binary is linked
+     statically to the libpng that is included in libgr.  RedHat 6.0
+     does not have this problem.
+
+           tar xzf libgr-2.0.13.tar.gz
+                make
+                cd png
+                rm libpng.so*
+                make pnmtopng
+
+     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
      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.
 
      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
 =========================
 
    to install GNU LilyPond, simply type:
 
 Configuring and compiling
 =========================
 
    to install GNU LilyPond, simply type:
+
        gunzip -c lilypond-x.y.z | tar xf -
        cd lilypond-x.y.z
        ./configure             # fill in your standard prefix with --prefix
        gunzip -c lilypond-x.y.z | tar xf -
        cd lilypond-x.y.z
        ./configure             # fill in your standard prefix with --prefix
@@ -162,20 +176,17 @@ Configuring and compiling
 
    This will install a number of files, something close to:
 
 
    This will install a number of files, something close to:
 
-       /usr/local/man/man1/midi2ly.1
-       /usr/local/man/man1/abc2ly.1
-       /usr/local/man/man1/etf2ly.1
+       /usr/local/man/man1/mi2mu.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/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/midi2ly
+       /usr/local/bin/mi2mu
        /usr/local/bin/convert-mudela
        /usr/local/bin/mudela-book
        /usr/local/bin/abc2ly
        /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/lilypond/*
-       /usr/local/share/locale/{....}/LC_MESSAGES/lilypond.mo
+       /usr/local/share/locale/{it,nl}/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
 
    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
@@ -248,9 +259,9 @@ following for the normal build,
    and for the profiling version, I specify a different configuration.
 
 
    and for the profiling version, I specify a different configuration.
 
 
-           ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
-           make config=prof
-           make config=prof install
+           ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
+           make config=optprof
+           make config=optprof install
 
 Installing
 ==========
 
 Installing
 ==========
@@ -278,7 +289,10 @@ Redhat linux
        rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 
    Precompiled i386 RedHat RPMS are available from
        rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 
    Precompiled i386 RedHat RPMS are available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
+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/).
 
    For compilation on a RedHat system you need these packages, in
 addition to the those needed for running:
 
    For compilation on a RedHat system you need these packages, in
 addition to the those needed for running:
@@ -294,44 +308,11 @@ addition to the those needed for running:
 
    * texinfo
 
 
    * texinfo
 
-   * tetex-devel
-
 Debian GNU/linux
 ================
 
 Debian GNU/linux
 ================
 
-   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/'; you can make
-the .deb by doing
-
-
-       tar xzf lilypond-x.y.z.tar.gz
-       cd lilypond-x.y.z
-       dpkg-buildpackage
-       dpkg -i ../lilypond_x.y.z*deb
-
-   For compilation on a Debian GNU/Linux system you need these packages,
-in addition to the those needed for running:
-   * libc6-dev
-
-   * libstdc++<your-libstdc++-version-here>-dev
-
-   * libguile<your-libguile-version-here>-dev
-
-   * flex
-
-   * bison
-
-   * gettext
-
-   * texinfo
-
-   * tetex-dev
-
-   * debhelper
+   A Debian package is also available; contact Anthony Fok
+<foka@debian.org>.  The build scripts are in the subdirectory `debian/'.
 
 Windows NT/95
 =============
 
 Windows NT/95
 =============
@@ -348,10 +329,10 @@ your problems.
 
    If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
 
 
    If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
 
-   Bugs that are LilyPond's fault are listed in our TODO list on the
-web, or demonstrated in `input/bugs/'.
+   Known bugs that are LilyPond's fault are listed in `TODO', or
+demonstrated in `input/bugs/'.
 
 
-   Bugs that are not LilyPond's fault are documented here.
+   Known bugs that are not LilyPond's fault are documented here.
 
 LinuxPPC Bugs:
 **************
 
 LinuxPPC Bugs:
 **************
Debian packaging of lilypond