release: 1.1.63

[lilypond.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
index dccba82a8d0c0a09a6bbbe6aac9336c42ddbf9d0..3dfb8ed76a07563e5d04a3145c22a42ae4642b02 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -76,35 +76,39 @@ o    The geometry package for LaTeX is needed to use ly2dvi.
      archive/macros/latex/contrib/supported/geometry  or  at
      mirror site ftp://ftp.dante.de
 
      archive/macros/latex/contrib/supported/geometry  or  at
      mirror site ftp://ftp.dante.de
 

+o    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.
+

 4: RUNNING
 
 4: RUNNING
 

-GNU  LilyPond does use a lot of resources. For operation you
+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
 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.
 
      installed.
 

-o    GUILE    1.3,    check    out   http://www.gnu.org/pro-
+o    GUILE   1.3,    check    out    http://www.gnu.org/pro-

      grams/guile.html
 
      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:"
 
 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-
 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.
 
 LilyPond is a hideously slow program.  A fast CPU and plenty
 login during compilation.
 
 LilyPond is a hideously slow program.  A fast CPU and plenty


@@ -112,24 +116,24 @@ of RAM is recommended for comfortable use.
 
 5: WEBSITE
 
 
 5: WEBSITE
 

-If  you  want  to  auto-generate Lily's website, you'll need
+If you want to auto-generate  Lily's  website,  you'll  need

 some additional conversion tools.
 
 o    xpmtoppm (from the Portable Bitmap Utilities) (For Red-
 some additional conversion tools.
 
 o    xpmtoppm (from the Portable Bitmap Utilities) (For Red-

-     Hat  Linux  users:  it  is  included within the package
-     libgr-progs).  the original is at  ftp://ftp.x.org/con-
+     Hat Linux users: it  is  included  within  the  package
+     libgr-progs).   the original is at ftp://ftp.x.org/con-

      trib/utilities/netpbm-1mar1994.p1.tar.gz
 
      trib/utilities/netpbm-1mar1994.p1.tar.gz
 

-o    pnmtopng,  which is also in libgr-progs for RedHat. The
-     original                     is                      at
+o    pnmtopng, which is also in libgr-progs for RedHat.  The
+     original                      is                     at

      ftp://swrinde.nde.swri.edu/pub/png/applications/pnm-
      topng-2.37.2.tar.gz.i
 
      The version of pnmtopng that is distributed with RedHat
      ftp://swrinde.nde.swri.edu/pub/png/applications/pnm-
      topng-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.   Recompile  it
-     from  source, and make sure that the pnmtopng binary is
-     linked statically to the libpng  that  is  included  in
+     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.  RedHat 6.0 does not have this problem.
 
            tar xzf libgr-2.0.13.tar.gz
      libgr.  RedHat 6.0 does not have this problem.
 
            tar xzf libgr-2.0.13.tar.gz


@@ -138,22 +142,21 @@ o    pnmtopng,  which is also in libgr-progs for RedHat. The
                 rm libpng.so*
                 make pnmtopng
 
                 rm libpng.so*
                 make pnmtopng
 

-     You   can   then   install   the   new   pnmtopng  into
+     You  can   then   install   the   new   pnmtopng   into

      /usr/local/bin/
 
 o    Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
      /usr/local/bin/
 
 o    Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.

-     Which,   in   turn   depends  on  man2html  for  proper
-
-     installation.  man2html can be had from  http://askdon-
+     Which, in turn depends on man2html for proper installa-
+     tion.    man2html   can   be  had  from  http://askdon-

      ald.ask.uni-karlsruhe.de/hppd/hpux/Network-
      ing/WWW/Man2html-1.05.
 
      ald.ask.uni-karlsruhe.de/hppd/hpux/Network-
      ing/WWW/Man2html-1.05.
 

-     The website will build without this  utility,  but  you
+     The  website  will  build without this utility, but you

      will not see our hypertextified bibliography.
 
      TeTeX users should not forget to rerun texhash.
 
      will not see our hypertextified bibliography.
 
      TeTeX users should not forget to rerun texhash.
 

-You  also  have  to install buildscripts/out/ps-to-gifs in a
+You also have to install  buildscripts/out/ps-to-gifs  in  a

 directory that is in the path.
 
 6: CONFIGURING and COMPILING
 directory that is in the path.
 
 6: CONFIGURING and COMPILING


@@ -177,10 +180,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
 
           /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
 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"
 taste:
 
           export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"


@@ -189,16 +191,16 @@ taste:
 CPPFLAGS are the preprocessor flags.
 
 The configure script is Cygnus configure, and it will accept
 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
 
 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.
 
 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
 also use
 
           --enable-debugging


@@ -210,33 +212,33 @@ Options to configure include:
      Enable debugging print routines (lilypond -D option)
 
 --enable-optimise
      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
      (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
 
      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
 
 --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).
 
 7: CONFIGURING FOR MULTIPLE PLATFORMS
 
 If you want to compile LilyPond with different configuration
 out/ (which contain all files generated during compilation).
 
 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
 ing.  Then I'd use the following for the normal build,
 
            ./configure --prefix=~ --disable-optimise --enable-checking


@@ -259,13 +261,14 @@ 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-
 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
 
 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.
 
 o    On PPC you need at least EGCS-1.1.2f.
      should first try  turning off this.
 
 o    On PPC you need at least EGCS-1.1.2f.


@@ -299,8 +302,8 @@ refer to the man page for more information.
 
 9: 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
 sources.
 
 You can make the rpm by issuing


@@ -308,13 +311,13 @@ 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
 
           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
+Precompiled    i386   RedHat   RPMS   are   available   from

 http://linux.umbc.edu/software/lilypond/rpms/.
 
 10: DEBIAN GNU/LINUX
 
 http://linux.umbc.edu/software/lilypond/rpms/.
 
 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/.
 
 11: WINDOWS NT/95
 debian/.
 
 11: WINDOWS NT/95