]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
release: 1.3.153
[lilypond.git] / INSTALL.txt
index 898649b307c754bb9bdaccf4adcd2a9c4593a2e5..69302af91e2aa34daac0f30dc1adb3bb4b555ce6 100644 (file)
@@ -1,35 +1,75 @@
 
 
+Table of Contents
+*****************
+
+
+
+
+INSTALL - compiling and installing GNU LilyPond
+  Downloading
+    source code
+    Binaries
+    Upgrading
+  Requirements
+    Compilation
+    Running requirements
+    Website requirements
+  Building  LilyPond
+    Configuring for multiple platforms
+  Emacs mode
+  Compiling for distributions
+    Red Hat Linux
+    LinuxPPC
+    SuSE
+    Slackware
+    Mandrake
+    Debian GNU/Linux
+  Problems
+    NetBSD
+    Solaris:
+    AIX
+
+
 INSTALL - compiling and installing GNU LilyPond
 ***********************************************
 
-Downloading source code
-=======================
+   This document describes how to build LilyPond on Unix platforms.  It
+is also known to run and compile on Windows NT/95/98 as well.  More
+information on this topic can be found at the LilyPond on Windows page
+(ftp://ftp.lilypond.org/pub/LilyPond/gnu-windows/).
+
+Downloading
+===========
 
-   If you want to compile LilyPond from source, download here:
-   * Download stable releases at GNU (ftp://ftp.gnu.org/gnu/lilypond/)
+   Even numbered versions are `stable'. The webpages for the stable
+version (1.2) reside on the GNU servers
+(http://www.gnu.org/software/lilypond). Big enhancements go into the
+latest odd numbered version (1.3), whose webpages are on the lilypond
+site (http://www.lilypond.org/).
 
-   * Download development releases from by FTP
-     (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/development/) and by HTTP
-     (http://ftp.cs.uu.nl/pub/GNU/LilyPond/development/).
+source code
+-----------
 
-   * ftp (Canadian mirror) (ftp://sca.uwaterloo.ca/pub/)
+   If you want to compile LilyPond from source, download here:
+   * Download development releases from
+     `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/development/' by FTP and
+     `http://ftp.cs.uu.nl/pub/GNU/LilyPond/development/', by HTTP.
 
-   * at `lilypond.org' by FTP (ftp://ftp.lilypond.org/pub/LilyPond/) and
-     HTTP (http://www.lilypond.org/ftp/).
+   * `ftp://sca.uwaterloo.ca/pub/' by FTP (Canadian mirror)
 
-   Installing and compiling requires many additional packages, which are
-listed in the installation instructions
-(Documentation/topdocs/out-www/INSTALL.html).
+   * at `lilypond.org' `ftp://ftp.lilypond.org/pub/LilyPond/' by FTP and
+     `http://www.lilypond.org/ftp/' by HTTP.
 
-Downloading binaries
-====================
+Binaries
+--------
 
    Binaries are available, but are not updated for every version
 released.
-   * RedHat i386 (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/RPMS/)
+   * RedHat i386
+     (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/)
 
-   * LinuxPPC (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/linuxppc)
+   * LinuxPPC (ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc)
 
    * Debian GNU/Linux Stable
      (ftp://ftp.debian.org/debian/pool/main/l/lilypond)
@@ -38,11 +78,11 @@ released.
      (ftp://ftp.debian.org/debian/pool/main/l/lilypond1.3)
 
    * Windows Stable (http://home.austin.rr.com/jbr/jeff/lilypond/)
+     Windows Testing (http://www.lilypond.org/gnu-windows)
 
-   * Windows Testing (ftp://ftp.lilypond.org/pub/lilypond/gnu-windows)
 
 Upgrading
-=========
+---------
 
    There are two  options for upgrading sources.
 
@@ -61,13 +101,11 @@ Upgrading
      on the FTP site.
             xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz
 
-Build requirements
-==================
+Requirements
+============
 
-   This document describes how to build LilyPond on Unix platforms.  It
-is also known to run and compile on Windows NT/95/98 as well.  More
-information on this topic can be found at the LilyPond on Windows page
-(ftp://ftp.lilypond.org/pub/LilyPond/gnu-windows/).
+Compilation
+-----------
 
    You need the following packages to compile Lilypond.
 
@@ -130,7 +168,7 @@ information on this topic can be found at the LilyPond on Windows page
 
 
 Running requirements
-====================
+--------------------
 
    GNU LilyPond does use a lot of resources. For operation you need the
 following software
@@ -153,7 +191,7 @@ Csh and bourne sh scripts are left in
 recommended for comfortable use.
 
 Website requirements
-====================
+--------------------
 
    The documentation comes in the form of a website. You can view this
 website on the internet, but you can also build it locally. This process
@@ -162,7 +200,7 @@ issuing
 
        make web-doc
 
-   Building the website requires  some additional tools:
+   Building the website requires some additional tools:
 
    * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities).
      The original is at the netpbm FTP site
@@ -182,9 +220,14 @@ issuing
      The website will build without bib converter utility, but you will
      not see our hypertextified bibliography.
 
+   * texinfo (a development release) The documentation will build with
+     texinfo-4.0, but if you want split html pages, you're best off
+     using the lates pretest version from texinfo-4.0b
+     (ftp://texinfo.org/texinfo/pretests/texinfo-4.0b.tar.gz) or
+     texinfo-4.0b (ftp://alpha.gnu.org/gnu/texinfo-4.0b.tar.gz)
 
-Configuring and compiling
-=========================
+Building  LilyPond
+==================
 
    to install GNU LilyPond, type:
        gunzip -c lilypond-x.y.z | tar xf -
@@ -208,7 +251,7 @@ points into your home directory, eg.
 `buildscripts/out/lilypond-profile' into your start up scripts by hand.
 
 Configuring for multiple platforms
-==================================
+----------------------------------
 
    If you want to build multiple versions of LilyPond with different
 configuration settings, you can use the `--enable-config=CONF' option
@@ -234,7 +277,7 @@ Emacs mode
 `lilypond-mode.el' and `lilypond-font-lock.el'.  If you have an RPM, it
 is in `/usr/share/doc/lilypond-X/'.  You have to install it yourself.
 
-   Add this to your ~/.emacs or ~/.emacs.el:
+   Add this to your `~/.emacs' or `~/.emacs.el':
          (load-library "lilypond-mode.el")
          (setq auto-mode-alist
            (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
@@ -243,47 +286,97 @@ is in `/usr/share/doc/lilypond-X/'.  You have to install it yourself.
    If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
 is automatically loaded, so you need not modify your `~/.emacs' file.
 
+Compiling for distributions
+===========================
+
 Red Hat Linux
-=============
+-------------
 
    Red Hat 7.0 i386 RPMS are available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
 
    You can also compile them yourself.  A spec file is in
-`make/out/lilypond.spec'. This file is distributed along with the
+`make/out/redhat.spec'. This file is distributed along with the
 sources.  You can make the rpm by issuing
 
-       rpm -tb lilypond-x.y.z.tar.gz
+             tar xfz lilypond-x.y.z.tar.gz
+       rpm -bb lilypond-x.y.z/make/out/redhat.spec
        rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 
    For running on a Red Hat system you need these packages: guile,
-tetex, tetex-dvips, libstdc++, python, ghostscript.
+tetex, tetex-latex, tetex-dvips, libstdc++, python, ghostscript.
 
    For compilation on a Red Hat system you need these packages, in
 addition to the those needed for running: glibc-devel, gcc-c++,
 libstdc++-devel, guile-devel, flex, bison, texinfo, tetex-devel, groff,
 libgr-progs.
 
+   Warning
+
+   There appears to be a problem with the Xdvi shipped with RedHat 7.1.
+Symptoms: Xdvi responds very sluggishly or hangs while viewing lilypond
+output. The cause for this problem is unknown; you are advised to
+recompile Xdvi from source.
+
+LinuxPPC
+--------
+
+   Some LinuxPPC RPMS should available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
+
+   A LinuxPPC RPM can be made using the `redhat.spec' file.
+
 SuSE
-====
+----
+
+   Some SUSE RPMS should available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
+
+   You can also compile a RPM for SUSE yourself.  A spec file is in
+`make/out/suse.spec', see the instructions for building the RedHat RPM.
 
-   [TODO: document this]
+   You must have the following packages: guile tcsh tetex te_latex
+te_kpath te_mpost libpng python gpp libgpp gettext autoconf netpbm
+libnetpb gs_serv gs_lib gs_fonts guile
 
-   Install `tetex', `te_mpost', `te_kpath'.
+Slackware
+---------
+
+   No precompiled packages for Slackware are available.
+
+   Problems have been reported with Slackware 7.0; apparently, it ships
+with a faulty compiler. Do not compile LilyPond with -O2 on this
+platform.
 
 Mandrake
-========
+--------
 
-   [TODO]
+   Some binaries are available at rpmfind.net. Refer to
+`ftp://ftp.rpmfind.net/linux/Mandrake-devel/cooker/contrib/RPMS/'.
 
 Debian GNU/Linux
-================
+----------------
 
    A Debian package is also available.  You may install it easily by
 using apt-get as root:
 
        apt-get install lilypond1.3
 
+   Debian's tex installation is a bit short on memory, you may want to
+increase it like this:
+     --- /etc/texmf/texmf.cnf.dpkg     Sun Jan 28 14:12:14 2001
+     +++ /etc/texmf/texmf.cnf  Fri Apr 27 11:09:35 2001
+     @ -384,8 +384,8 @
+      main_memory.context = 1500000
+      main_memory.mpost = 1000000
+      main_memory = 263000 % words of inimemory available; also applies to inimf&mp
+     -extra_mem_top = 0    % extra high memory for chars, tokens, etc.
+     -extra_mem_bot = 0    % extra low memory for boxes, glue, breakpoints, etc.
+     +extra_mem_top = 100000    % extra high memory for chars, tokens, etc.
+     +extra_mem_bot = 100000    % extra low memory for boxes, glue, breakpoints, etc.
+     
+      obj_tab_size.context = 256000
+
    Alternatively, visit
 
    * http://packages.debian.org/lilypond
@@ -370,7 +463,7 @@ your problems.  If you find bugs, please send bug reports to
    Bugs that are not fault of LilyPond are documented here.
 
 NetBSD
-******
+------
 
    * The flex precompiled in NetBSD-1.4.2 is broken.  Download
      flex-2.5.4a, build, install.
@@ -382,7 +475,7 @@ NetBSD
 
 
 Solaris:
-********
+--------
 
    * Sparc64/Solaris 2.6, GNU make-3.77
 
@@ -394,7 +487,7 @@ Solaris:
      Not yet resolved.
 
 AIX
-***
+---
 
    * AIX 4.3 ld