]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
release: 1.3.120
[lilypond.git] / INSTALL.txt
index 75215d77dc1070b9d090a0bb915b32fd79b13978..0a2e54f06460eee339e5f2c4e400ce171b669031 100644 (file)
@@ -3,16 +3,6 @@
 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 handy when you have to compile LilyPond
-more often.
-
 Obtaining
 =========
 
@@ -39,7 +29,7 @@ Prerequisites
 
    * 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
@@ -48,24 +38,30 @@ 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/gnu/gcc/'.
+   * A reasonable C++ compiler:  EGCS 1.1, GCC 2.95.2 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.4,  check out
+   * GUILE 1.3.4 or newer,  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/
+   * 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
+   * Flex (version 2.5.4a 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/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
 
+   * 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.
@@ -81,7 +77,11 @@ Prerequisites
      `mfplain.mp', which is needed for producing the scalable font
      files.
 
-     If you do not want to use PostScript output, edit `mf/GNUmakefile'.
+     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
@@ -90,29 +90,29 @@ 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.4, check out http://www.gnu.org/software/guile/
+   * GUILE 1.3.4, or newer.  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
 find various files.  The recommended way of doing so is adjusting the
-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:"
+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.
 
-   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.
 
-   LilyPond is a hiddeously big, slow and bloated program.  A fast CPU
-and plenty of RAM is recommended for comfortable use.
+   LilyPond is a big and slow program.  A fast CPU and plenty of RAM is
+recommended for comfortable use.
 
 Website
 =======
@@ -127,50 +127,36 @@ to be installed.
    If you want to auto-generate Lily's website, you'll need some
 additional conversion tools.
 
-   * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
-      users: it is included within the package libgr-progs).
-     the original is at
+   * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities)
+     (For RedHat Linux              users: it is included within the package
+     libgr-progs).     the original is at
      ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
      (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
 
-   * pnmtopng, which is also in libgr-progs for RedHat. The original is
-     at
+   * pnmtopng (also in libgr-progs for RedHat). The original is at
      ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
      (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
 
      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, 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).
-     Which, in turn depends on man2html for proper installation.
-     man2html can be had from
+     version of libpng.
+
+   * Bibtex2html (http://www.lri.fr/~filliatr/ftp/bibtex2html/), or
+     Bib2html (http://www.uni-koblenz.de/ag-ki/ftp/bib2html/).
+     Bibtex2html is available in debian, while bib2html is in some rpm
+     based distributions.  Bib2html, 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.
+     The website will build without bib converter utility, but you will
+     not see our hypertextified bibliography.
 
-   * DOC++ (http://www.zib.de/Visual/software/doc++/index.html)     A
-     documentation system for C++ sources, which is used for the
-     LilyPond sources.
 
 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
@@ -179,17 +165,22 @@ Configuring and compiling
 
    This will install a number of files, something close to:
 
-       /usr/local/man/man1/mi2mu.1
-       /usr/local/man/man1/convert-mudela.1
-       /usr/local/man/man1/mudela-book.1
+       /usr/local/man/man1/midi2ly.1
+       /usr/local/man/man1/abc2ly.1
+       /usr/local/man/man1/etf2ly.1
+       /usr/local/man/man1/convert-ly.1
+       /usr/local/man/man1/lilypond-book.1
        /usr/local/man/man1/lilypond.1
        /usr/local/bin/lilypond
-       /usr/local/bin/mi2mu
-       /usr/local/bin/convert-mudela
-       /usr/local/bin/mudela-book
+       /usr/local/bin/midi2ly
+       /usr/local/bin/convert-ly
+       /usr/local/bin/lilypond-book
        /usr/local/bin/abc2ly
+       /usr/local/bin/pmx2ly
+       /usr/local/bin/musedata2ly
+       /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
@@ -262,9 +253,9 @@ following for the normal build,
    and for the profiling version, I specify a different configuration.
 
 
-           ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
-           make config=optprof
-           make config=optprof install
+           ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
+           make config=prof
+           make config=prof install
 
 Installing
 ==========
@@ -291,11 +282,8 @@ Redhat linux
        rpm -tb lilypond-x.y.z.tar.gz
        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/).
+   Precompiled RedHat-7.0 i386 RPMS are available from
+`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:
@@ -311,14 +299,44 @@ addition to the those needed for running:
 
    * texinfo
 
+   * tetex-devel
+
 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/'.
+<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
 
 Windows NT/95
 =============
@@ -335,10 +353,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.
+   Bugs that are not LilyPond's fault are documented here.
 
 LinuxPPC Bugs:
 **************