]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
release: 1.1.47
[lilypond.git] / INSTALL.txt
index 3ca4a10605dc9a79d082f033aaa824799ab028b9..622b63747e9447e71ff72082693b72962b20fc0e 100644 (file)
@@ -9,15 +9,14 @@ Contents
 2: OBTAINING
 3: PREREQUISITES
 4: RUNNING
-5: RECOMMENDED
-6: WEBSITE
-7: CONFIGURING and COMPILING
-8: CONFIGURING FOR MULTIPLE PLATFORMS
-9: INSTALLING
-10: REDHAT LINUX
-11: DEBIAN GNU/LINUX
-12: WINDOWS NT/95
-13: AUTHORS
+5: WEBSITE
+6: CONFIGURING and COMPILING
+7: CONFIGURING FOR MULTIPLE PLATFORMS
+8: INSTALLING
+9: REDHAT LINUX
+10: DEBIAN GNU/LINUX
+11: WINDOWS NT/95
+12: AUTHORS
 
 1: ABSTRACT
 
@@ -45,92 +44,73 @@ o    A GNU system: GNU LilyPond is known to run on these GNU
      systems: Linux (PPC, intel),  FreeBSD,  AIX,  NeXTStep,
      IRIX, Digital Unix and Solaris.
 
-o    Lots  of  disk space: LilyPond takes between 50 and 100
+o    Lots  of  disk space: LilyPond takes between 30 and 100
      mb to 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 Windows NT/95/98 as well.  See Section 12.
+     run on Windows NT/95/98 as well.  See Section 11.
 
 o    EGCS 1.1 or newer.
 
-o    Python  1.5  (Strictly  speaking,  you  shouldn't  need
-     Python for compiling and installing, but you'll need it
-     to regenerate the font tables, e.g.).
+o    Python   1.5,   Check   out   ftp://ftp.python.org   or
+     ftp://ftp.cwi.nl/pub/python.
 
-o    GUILE  1.3  (no,  GUILE  1.2  won't  work),  check  out
-     http://www.gnu.org/software/guile/guile.html.
+o    GUILE   1.3,    check   out    http://www.gnu.org/soft-
+     ware/guile/guile.html.
+
+o    GNU make.  Check out ftp://ftp.gnu.org.
+
+o    Flex    (version    2.5.4   or   newer).    Check   out
+     ftp://ftp.gnu.org.
+
+o    Bison   (version   1.25   or   newer).     Check    out
+     ftp://ftp.gnu.org.
+
+o    Yodl.   All  documentation  will  be in Yodl. (1.30.17)
+     ftp://ftp.lilypond.org/pub/yodl
+
+o    The geometry package for LaTeX is needed to use ly2dvi.
+     Available           at          ftp://ftp.ctan.org/tex-
+     archive/macros/latex/contrib/supported/geometry  or  at
+     mirror site ftp://ftp.dante.de
 
 4: RUNNING
 
-GNU LilyPond does use a lot of resources. For operation  you
-need the following:
+GNU  LilyPond does use a lot of resources. For operation you
+need the following software
 
 o    TeX
 
 o    A   PostScript   printer   and/or   viewer   (such   as
-     Ghostscript) is strongly recommended.  Xdvi  will  show
-     all  embedded  PostScript  too  if you have Ghostscript
+     Ghostscript)  is  strongly recommended.  Xdvi will show
+     all embedded PostScript too  if  you  have  Ghostscript
      installed.
 
-o    GUILE  1.3  (no,  GUILE  1.2  won't  work),  check  out
-     http://www.gnu.org/programs/guile.html
+o    GUILE    1.3,    check    out   http://www.gnu.org/pro-
+     grams/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
+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:"
 
-The  empty path component represents  and MetaFont's default
-search paths.  Scripts with the proper paths for the  bourne
+The empty path component represents  and MetaFont's  default
+
+search  paths.  Scripts with the proper paths for the bourne
 and   C-shell   respectively   are   generated   in   build-
-scripts/out/lilypond-profile and  buildscripts/out/lilypond-
+scripts/out/lilypond-profile  and buildscripts/out/lilypond-
 login during compilation.
 
-5: RECOMMENDED
+LilyPond is a hideously slow program.  A fast CPU and plenty
+of RAM is recommended for comfortable use.
 
-Although  not  strictly  necessary, these are recommended to
-have.
-
-o    GNU make.  Check out ftp://ftp.gnu.org or any mirror of
-     this site.
-
-o    Flex    (version    2.5.4   or   newer).    Check   out
-     ftp://ftp.gnu.org or any mirror of this site.
-
-o    Bison   (version   1.25   or   newer).     Check    out
-     ftp://ftp.gnu.org or any mirror of this site.
-
-o    GUILE  1.3  (no,  GUILE  1.2  won't  work),  check  out
-     http://www.gnu.org/programs/guile.html.
-
-o    Python   (version   1.5   or   newer).     Check    out
-     ftp://ftp.python.org or ftp://ftp.cwi.nl/pub/python.
-
-o    Yodl.   All  documentation  will  be in Yodl. (1.30.17)
-     ftp://ftp.lilypond.org/pub/yodl
-     http://www.cs.uu.nl/~hanwen/yodl
-
-o    Texinfo. (version 3.12 or newer)
-
-o    GNU  find  Check out ftp://ftp.gnu.org or any mirror of
-     this site.
-
-o    The geometry package for LaTeX is needed to use ly2dvi.
-     Available           at          ftp://ftp.ctan.org/tex-
-     archive/macros/latex/contrib/supported/geometry  or  at
-     mirror site ftp://ftp.dante.de
-
-o    A fast computer: a full page of music typically takes 1
-     minute on my 486/133, using the --enable-checking  com-
-     pile.
-
-6: WEBSITE
+5: WEBSITE
 
 If  you  want  to  auto-generate Lily's website, you'll need
 some additional conversion tools.
@@ -148,12 +128,11 @@ o    Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
      TeTeX users should not forget to rerun texhash.
 
 Building the website requires pnmtopng.  The version of pnm-
-topng  that  is  distributed  with RedHat 5.1 contains a bug
-(pnmtopng is dynamically linked  to  the  wrong  version  of
-libpng).   Recompile  it from source, and make sure that the
+topng that is distributed with RedHat 5.1 and 5.2 contains a
+bug: pnmtopng is dynamically linked to the wrong version  of
+libpng.   Recompile  it  from source, and make sure that the
 pnmtopng binary is linked statically to the libpng  that  is
-
-included in libgr.
+included  in libgr.   RedHat 6.0 does not have this problem.
 
       tar xzf libgr-2.0.13.tar.gz
            make
@@ -163,7 +142,7 @@ included in libgr.
 
 You can then install the new pnmtopng into /usr/local/bin/
 
-7: CONFIGURING and COMPILING
+6: CONFIGURING and COMPILING
 
 to install GNU LilyPond, simply type:
 
@@ -184,9 +163,9 @@ This will install a number of files, something close to:
           /usr/local/share/lilypond/*
           /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
 
-The  above assumes that you are root and have the GNU devel-
+The above assumes that you are root and have the GNU  devel-
 opment tools, and your make is GNU make.  If this is not the
-case,  you  can  adjust  your  environment variables to your
+case, you can adjust  your  environment  variables  to  your
 taste:
 
           export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
@@ -195,16 +174,16 @@ taste:
 CPPFLAGS are the preprocessor flags.
 
 The configure script is Cygnus configure, and it will accept
---help.  If you are not root, you will probably have to make
+--help. If you are not root, you will probably have to  make
 it with a different --prefix option.  Our favourite location
 is
 
           ./configure --prefix=$HOME/usr
 
-In  this  case, you will have to set up MFINPUTS, and TEXIN-
+In this case, you will have to set up MFINPUTS,  and  TEXIN-
 PUTS accordingly.
 
-Since GNU LilyPond currently is beta,  you  are  advised  to
+Since  GNU  LilyPond  currently  is beta, you are advised to
 also use
 
           --enable-debugging
@@ -216,33 +195,33 @@ Options to configure include:
      Enable debugging print routines (lilypond -D option)
 
 --enable-optimise
-     Set  maximum  optimisation: compile with -O2.  This can
-     be unreliable on  some  compiler/platform  combinations
+     Set maximum optimisation: compile with -O2.   This  can
+     be  unreliable  on  some compiler/platform combinations
      (eg, DEC Alpha and PPC)
 
 --enable-profiling
      Compile with support for profiling.
 
 --enable-config
-     Output  to  a different configuration file.  Needed for
+     Output to a different configuration file.   Needed  for
      multi-platform builds
 
-All options are documented in the configure help The  option
+All  options are documented in the configure help The option
 --enable-optimise is recommended for Real Life usage.
 
 If you do
 
           make all
 
-everything  will be compiled, but nothing will be installed.
-The resulting binaries can be found  in  the  subdirectories
+everything will be compiled, but nothing will be  installed.
+The  resulting  binaries  can be found in the subdirectories
 out/ (which contain all files generated during compilation).
 
-8: CONFIGURING FOR MULTIPLE PLATFORMS
+7: CONFIGURING FOR MULTIPLE PLATFORMS
 
 If you want to compile LilyPond with different configuration
-settings,  then,  you  can  use  the --enable-config option.
-Example: suppose I want to build with and   without  profil-
+settings, then, you  can  use  the  --enable-config  option.
+Example:  suppose I want to build with and   without profil-
 ing.  Then I'd use the following for the normal build,
 
            ./configure --prefix=~ --disable-optimise --enable-checking
@@ -256,7 +235,7 @@ uration.
            make config=optprof
            make config=optprof install
 
-9: INSTALLING
+8: INSTALLING
 
 If you have done a successful make, then a simple
 
@@ -265,14 +244,13 @@ If you have done a successful make, then a simple
 should do the trick.
 
 If you are doing an upgrade, please remember to remove obso-
-lete  .pk  and  .tfm  files of the fonts.  A script has been
+lete .pk and .tfm files of the fonts.   A  script  has  been
 provided to do the work for you, see bin/clean-fonts.sh.
 
 CAVEATS
 
-o    The -O2 option  triggers   bugs  on  various  platforms
-     (PowerPC,  Alpha).   If  you  experience  problems, you
-
+o    The  -O2  option   triggers   bugs on various platforms
+     (PowerPC, Alpha).   If  you  experience  problems,  you
      should first try  turning off this.
 
 EXAMPLE
@@ -302,10 +280,10 @@ This is what the output looks like over here:
 Check out the input files, some of them have comments Please
 refer to the man page for more information.
 
-10: REDHAT LINUX
+9: REDHAT LINUX
 
-RedHat  Linux  users  can  compile an RPM. A spec file is in
-make/out/lilypond.spec, it is  distributed  along  with  the
+RedHat Linux users can compile an RPM. A  spec  file  is  in
+make/out/lilypond.spec,  it  is  distributed  along with the
 sources.
 
 You can make the rpm by issuing
@@ -313,18 +291,18 @@ You can make the rpm by issuing
           rpm -tb lilypond-x.y.z.tar.gz
           rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 
-11: DEBIAN GNU/LINUX
+10: DEBIAN GNU/LINUX
 
-A  Debian  package  is  also  available; contact Anthony Fok
-foka@debian.org.  The build scripts are in the  subdirectory
+A Debian package is  also  available;  contact  Anthony  Fok
+foka@debian.org.   The build scripts are in the subdirectory
 debian/.
 
-12: WINDOWS NT/95
+11: WINDOWS NT/95
 
 Separate instructions on building for W32 are avaible in the
 file README-W32.yo.
 
-13: AUTHORS
+12: AUTHORS
 
 Han-Wen Nienhuys <hanwen@cs.uu.nl>