]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
release: 1.1.64
[lilypond.git] / INSTALL.txt
index 1b088819bc02ab044819aa0e1d7dc087d064d7e2..3dfb8ed76a07563e5d04a3145c22a42ae4642b02 100644 (file)
@@ -1,23 +1,14 @@
 
-
-
-
-
-
-
-
-
       INSTALL - compiling and installing GNU LilyPond
 
                          HWN & JCN
 
-
 Contents
 
      1: ABSTRACT
-2: PREREQUISITES
-3: RUNNING
-4: RECOMMENDED
+2: OBTAINING
+3: PREREQUISITES
+4: RUNNING
 5: WEBSITE
 6: CONFIGURING and COMPILING
 7: CONFIGURING FOR MULTIPLE PLATFORMS
@@ -27,43 +18,33 @@ Contents
 11: WINDOWS NT/95
 12: AUTHORS
 
-
 1: 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 handly when you have to compile LilyPond more often.
 
-You do something which looks remotely like
-
+2: OBTAINING
 
+You  can   get   the   latest   version   of   LilyPond   at
+ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/.   Refer  to  the links
+document for mirror sites.
 
+If you upgrade by patching do  remember  to  rerun  autoconf
+after applying the patch.
 
-
-          configure    # Check out the buildscripts/set-lily.sh script
-          make
-          make install
-
-
-
-
-
-The   detailed   instructions   follow   here.   The  build-
-scripts/set-lily.sh script sets some  environment  variables
-and symlinks, which comes in handly when you have to compile
-LilyPond very often.  It is aimed  at  people  who  run  (or
-debug) LilyPond without installing.
-
-
-2: PREREQUISITES
-
+3: PREREQUISITES
 
 For compilation you need:
 
-
 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.
@@ -71,21 +52,39 @@ o    Lots  of  disk space: LilyPond takes between 50 and 100
      Although we recommend to use Unix, LilyPond is known to
      run on Windows NT/95/98 as well.  See Section 11.
 
+o    EGCS 1.1 or newer.
 
-o    GNU  C++  version  2.7  or newer (2.8 and egcs are also
-     fine).
+o    Python   1.5,   Check   out   ftp://ftp.python.org   or
+     ftp://ftp.cwi.nl/pub/python.
 
-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    GUILE   1.3,    check   out    http://www.gnu.org/soft-
+     ware/guile/guile.html.
 
+o    GNU make.  Check out ftp://ftp.gnu.org.
 
-3: RUNNING
+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.
 
-GNU LilyPond does use a lot of resources. For operation  you
-need the following:
+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
+
+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
+
+GNU LilyPond does use a lot of resources. For operation  you
+need the following software
 
 o    TeX
 
@@ -94,144 +93,84 @@ o    A   PostScript   printer   and/or   viewer   (such   as
      all  embedded  PostScript  too  if you have Ghostscript
      installed.
 
-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:
-
-
+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
+Bourne shell:
 
      export MFINPUTS="/usr/local/share/lilypond/mf:"
-     export TEXINPUTS="/usr/local/share/lilypond/tex:"
-
-
-
+     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.
 
-
-4: RECOMMENDED
-
-
-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 (version 1.2) Check  out  http://www.gnu.org/pro-
-     grams/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://pcnov095.win.tue.nl/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. It's lot slower than most MusiXTeX preprocessors)
-
+LilyPond is a hideously slow program.  A fast CPU and plenty
+of RAM is recommended for comfortable use.
 
 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-
-     Hat  Linux  users:  it  is  included within the package
-     libgr-progs).
+     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
+
+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
+     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
+                make
+                cd png
+                rm libpng.so*
+                make pnmtopng
+
+     You  can   then   install   the   new   pnmtopng   into
+     /usr/local/bin/
 
 o    Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
      Which, in turn depends on man2html for proper installa-
-     tion.   man2html  can  be   had   from   http://askdon-
+     tion.    man2html   can   be  had  from  http://askdon-
      ald.ask.uni-karlsruhe.de/hppd/hpux/Network-
      ing/WWW/Man2html-1.05.
 
-     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
-pnmtopng binary is linked statically to the libpng  that  is
-
-
-included in libgr.
-
-
-
-
-
-      tar xzf libgr-2.0.13.tar.gz
-           make
-           cd png
-           rm libpng.so*
-           make pnmtopng
-
+     The  website  will  build without this utility, but you
+     will not see our hypertextified bibliography.
 
+     TeTeX users should not forget to rerun texhash.
 
-
-
-You can then install the new pnmtopng into /usr/local/bin/
-
+You also have to install  buildscripts/out/ps-to-gifs  in  a
+directory that is in the path.
 
 6: CONFIGURING and COMPILING
 
-
 to install GNU LilyPond, simply type:
 
-
-
-
-
-          configure
+          gunzip -c lilypond-x.y.z | tar xf -
+          cd lilypond-x.y.z
+          ./configure         # fill in your standard prefix with --prefix
           make
           make install
 
-
-
-
-
 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
@@ -241,23 +180,13 @@ 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-
 opment tools, and your make is GNU make.  If this is not the
 case,  you  can  adjust  your  environment variables to your
 taste:
 
-
-
-
-
-
           export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
-          configure
-
-
-
-
+          ./configure
 
 CPPFLAGS are the preprocessor flags.
 
@@ -266,16 +195,7 @@ The configure script is Cygnus configure, and it will accept
 it with a different --prefix option.  Our favourite location
 is
 
-
-
-
-
-
-          configure --prefix=$HOME/usr
-
-
-
-
+          ./configure --prefix=$HOME/usr
 
 In  this  case, you will have to set up MFINPUTS, and TEXIN-
 PUTS accordingly.
@@ -283,21 +203,11 @@ PUTS accordingly.
 Since GNU LilyPond currently is beta,  you  are  advised  to
 also use
 
-
-
-
-
-
           --enable-debugging
           --enable-checking
 
-
 Options to configure include:
 
-
---enable-guile
-     Link in GUILE (experimental)
-
 --enable-printing
      Enable debugging print routines (lilypond -D option)
 
@@ -318,115 +228,61 @@ All options are documented in the configure help The  option
 
 If you do
 
-
-
-
-
-
           make all
 
-
-
-
-
 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
 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
+           ./configure --prefix=~ --disable-optimise --enable-checking
            make
            make install
 
-
-
-
-
 and for the profiling version, I specify a different config-
 uration.
 
-
-
-
-
-
-           configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
+           ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
            make config=optprof
            make config=optprof install
 
-
-
-
-
-
 8: INSTALLING
 
-
 If you have done a successful make, then a simple
 
-
-
-
-
-
           make install
 
-
-
-
-
 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
 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
 
+     should first try  turning off this.
 
-o    The -O2 option to gcc triggers a gcc bug on  DEC  Alpha
-     in  dstream.cc.  You should turn off this flag for this
-
-
-     file.
-
+o    On PPC you need at least EGCS-1.1.2f.
 
 EXAMPLE
 
-
 This is what I type in my xterm:
 
-
-
-
-
-
           lilypond someinput.ly
           tex someinput.tex
           xdvi someinput&
 
-
-
-
-
 This is what the output looks like over here:
 
-
-
-
-
-
           GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
           Parsing ... [/home/hw/share/lilypond/init//
                <..etc..>
@@ -438,71 +294,39 @@ This is what the output looks like over here:
           TeX output to someinput.tex ...
           Creating MIDI elements ...MIDI output to someinput.midi ...
 
-
           hw:~/musix/spacer$ xdvi someinput&
           [1] 855
 
-
-
-
-
 Check out the input files, some of them have comments Please
 refer to the man page for more information.
 
-
 9: REDHAT LINUX
 
-
 RedHat  Linux  users  can  compile an RPM. A spec file is in
-make/out/lilypond.spec.   You  should  install  a  gif  file
-called  lelie_icon.gif along with the sources.  You can gen-
-erate this gif file by typing
-
-
-
-
-
-
-          make gifs
-
-
-
-
-
-in the directory Documentation.
+make/out/lilypond.spec, it is  distributed  along  with  the
+sources.
 
 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
 
-
-
-
-
-          make rpm
-
-
-
-
-
+Precompiled    i386   RedHat   RPMS   are   available   from
+http://linux.umbc.edu/software/lilypond/rpms/.
 
 10: DEBIAN GNU/LINUX
 
-
 A Debian package is  also  available;  contact  Anthony  Fok
-foka@debian.org <foka@debian.org>.  The build scripts are in
-the subdirectory debian/
-
+foka@debian.org.   The build scripts are in the subdirectory
+debian/.
 
 11: WINDOWS NT/95
 
-
 Separate instructions on building for W32 are avaible in the
 file README-W32.yo.
 
-
 12: AUTHORS
 
-
 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 
 Jan Nieuwenhuizen <janneke@gnu.org>