]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
release: 1.3.0
[lilypond.git] / INSTALL.txt
index 537df8e33adc49e63179e654a095f7c6db7152a2..2a431f3a5c0a8c6d9eb00db2c5f15db14fcb0160 100644 (file)
@@ -6,8 +6,6 @@ INSTALL - compiling and installing GNU LilyPond
 Abstract
 ========
 
-   TODO: document xdeltas
-
    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
@@ -20,12 +18,20 @@ Obtaining
 
    You can get the latest version of LilyPond at
 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
-(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).  Refer to the links document
-for mirror sites.
+(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).
 
    _If you upgrade by patching do remember to rerun autoconf after
 applying the patch_.
 
+   If you do not want to download the entire archive for each version,
+the safest method for upgrading is to use `xdelta', see
+`ftp://ftp.xcf.berkeley.edu/pub/xdelta/'.
+
+   The following command produces `lilypond-1.1.55.tar.gz' from
+`lilypond-1.1.54' identical (up to compression dates) to the .55 on the
+FTP site.
+       xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
+
 Prerequisites
 =============
 
@@ -39,16 +45,16 @@ Prerequisites
      compile if you use debugging information.  If you are short on
      disk-space run configure with `--disable-debugging'.
 
-     Although we recommend to use Unix, LilyPond is known to run on
+   * 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/
-     (ftp://ftp.gnu.org/pub/gcc/)
+   * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
 
-   * Python 1.5, Check out ftp://ftp.python.org (ftp://ftp.python.org)
-     or ftp://ftp.cwi.nl/pub/python (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,  check out http://www.gnu.org/software/guile/guile.html
+   * GUILE 1.3.4,  check out
+     http://www.gnu.org/software/guile/guile.html
      (http://www.gnu.org/software/guile/guile.html).
 
    * GNU make.  Check out ftp://ftp.gnu.org/make/
@@ -88,7 +94,7 @@ following software
      strongly     recommended.  Xdvi will show all embedded PostScript
      too if you have     Ghostscript installed.
 
-   * GUILE 1.3, check out http://www.gnu.org/programs/guile.html
+   * 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
@@ -157,10 +163,7 @@ additional conversion tools.
    * Doc++ (optional) to read the source code.
 
 
-   You also have to install `buildscripts/out/ps-to-gifs' in a
-directory that is in the path.
-
-configuring and compiling
+Configuring and compiling
 =========================
 
    to install GNU LilyPond, simply type:
@@ -179,6 +182,9 @@ configuring and compiling
        /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/abc2ly
        /usr/local/share/lilypond/*
        /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
 
@@ -237,7 +243,7 @@ accordingly.
 resulting binaries can be found in the subdirectories `out/' (which
 contain all files generated during compilation).
 
-configuring for multiple platforms
+Configuring for multiple platforms
 ==================================
 
    If you want to compile LilyPond with different configuration
@@ -271,15 +277,6 @@ Installing
 `.pk' and `.tfm' files of the fonts.  A script has been provided to do
 the work for you, see `bin/clean-fonts.sh'.
 
-CAVEATS
-=======
-
-   * The -O2 option  triggers  bugs on various platforms (PowerPC,
-     Alpha).      If you experience problems, you  should first try
-     turning off     this.
-
-   * On PPC you need at least EGCS-1.1.2f.
-
 Redhat linux
 ============
 
@@ -320,24 +317,99 @@ Debian GNU/linux
 Windows NT/95
 =============
 
-   Separate instructions on building for W32 are available; See file
-README-W32, included with the sources.
+   Separate instructions on building for W32 are available; See the
+files in `Documentation/ntweb/', included with the sources.
 
-Bugs
-====
+Problems
+========
 
-   Send bug reports to bug-gnu-music@gnu.org.  For help and questions
-use help-gnu-music@gnu.org and gnu-music-discuss@gnu.org.  Please
-consult the faq before mailing your problems.
+   For help and questions use <help-gnu-music@gnu.org> and
+<gnu-music-discuss@gnu.org>.  Please consult the faq before mailing
+your problems.
 
-Authors
-=======
+   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/'.
+
+   Known bugs that are not LilyPond's fault are documented here.
+
+LinuxPPC Bugs:
+**************
+
+   * 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,
+     `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
+
+   * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
+     particular guile-1.3, and Lily herself will break.
+
+Linux-i386
+**********
+
+   * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
+
+     Lily will crash during parsing (which suggests a C++ library
+     incompatibility).  Precise cause, precise platform description or
+     solution are not known.
+
+     Note that this only happens on some computers with the said
+     platform.
+
+   * libg++ 2.7
+
+     LilyPond occasionally crashes while parsing the initialisation
+     files.  This is a very obscure bug, and usually entering the
+     commandline differently "fixes" it.
+
+               lilypond input.ly
+
+     and
+               lilypond -I. ./input.ly
+     makes a difference
+
+     Typical stacktrace:
+               SIGSEGV
+               __libc_malloc (bytes=16384)
+               ?? ()
+               yyFlexLexer::yy_create_buffer ()
+               Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
+
+     This behaviour has been observed with machines that have old libg++
+     versions (LinuxPPC feb '98, RedHat 4.x).
+
+Solaris:
+********
+
+   * Sparc64/Solaris 2.6, GNU make-3.77
+
+     GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+     newer.
+
+   * Sparc64/Solaris 2.6, ld
+
+     Not yet resolved.
+
+AIX
+***
+
+   * AIX 4.3 ld
 
-   Han-Wen Nienhuys <hanwen@cs.uu.nl>
+     The following is from the gcc install/SPECIFIC file.
+             Some versions of the AIX binder (linker) can fail with a
+          relocation    overflow severe error when the -bbigtoc option
+          is used to link    GCC-produced object files into an
+          executable that overflows the TOC. A    fix for APAR IX75823
+          (OVERFLOW DURING LINK WHEN USING GCC AND    -BBIGTOC) is
+          available from IBM Customer Support and from its
+          27service.boulder.ibm.com website as PTF U455193.
 
-   Jan Nieuwenhuizen <janneke@gnu.org>
+          Binutils does not support AIX 4.3 (at least through release
+          2.9). GNU    as and GNU ld will not work properly and one
+          should not configure GCC    to use those GNU utilities. Use
+          the native AIX tools which do    interoperate with GCC.
 
-   In case of problems, please use the mailing list for help.
+     add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+              LDFLAGS='-Wl,-bbigtoc' ./configure
 
-   Have fun!