INSTALL.txt

   1
   2       INSTALL - compiling and installing GNU LilyPond
   3
   4                          HWN & JCN
   5
   6 Contents
   7
   8      1: ABSTRACT
   9 2: OBTAINING
  10 3: PREREQUISITES
  11 4: RUNNING
  12 5: WEBSITE
  13 6: CONFIGURING and COMPILING
  14 7: CONFIGURING FOR MULTIPLE PLATFORMS
  15 8: INSTALLING
  16 9: REDHAT LINUX
  17 10: DEBIAN GNU/LINUX
  18 11: WINDOWS NT/95
  19 12: AUTHORS
  20
  21 1: ABSTRACT
  22
  23 This  document  explains  what you need to install LilyPond,
  24 and what you should do.  If you are  going  to  compile  and
  25 install  LilyPond  often,  e.g.  when doing development, you
  26 might want to check out the buildscripts/set-lily.sh script.
  27 It sets some environment variables and symlinks, which comes
  28 in handly when you have to compile LilyPond more often.
  29
  30 2: OBTAINING
  31
  32 You  can   get   the   latest   version   of   LilyPond   at
  33 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/.   Refer  to  the links
  34 document for mirror sites.
  35
  36 If you upgrade by patching do  remember  to  rerun  autoconf
  37 after applying the patch.
  38
  39 3: PREREQUISITES
  40
  41 For compilation you need:
  42
  43 o    A GNU system: GNU LilyPond is known to run on these GNU
  44      systems: Linux (PPC, intel),  FreeBSD,  AIX,  NeXTStep,
  45      IRIX, Digital Unix and Solaris.
  46
  47 o    Lots  of  disk space: LilyPond takes between 30 and 100
  48      mb to compile if you use debugging information.  If you
  49      are  short  on disk-space run configure with --disable-
  50      debugging.
  51
  52      Although we recommend to use Unix, LilyPond is known to
  53      run on Windows NT/95/98 as well.  See Section 11.
  54
  55 o    EGCS 1.1 or newer.
  56
  57 o    Python   1.5,   Check   out   ftp://ftp.python.org   or
  58      ftp://ftp.cwi.nl/pub/python.
  59
  60 o    GUILE   1.3,    check   out    http://www.gnu.org/soft-
  61      ware/guile/guile.html.
  62
  63 o    GNU make.  Check out ftp://ftp.gnu.org.
  64
  65 o    Flex    (version    2.5.4   or   newer).    Check   out
  66      ftp://ftp.gnu.org.
  67
  68 o    Bison   (version   1.25   or   newer).     Check    out
  69      ftp://ftp.gnu.org.
  70
  71 o    Yodl.   All  documentation  will  be in Yodl. (1.30.17)
  72      ftp://ftp.lilypond.org/pub/yodl
  73
  74 o    The geometry package for LaTeX is needed to use ly2dvi.
  75      Available           at          ftp://ftp.ctan.org/tex-
  76      archive/macros/latex/contrib/supported/geometry  or  at
  77      mirror site ftp://ftp.dante.de
  78
  79 4: RUNNING
  80
  81 GNU  LilyPond does use a lot of resources. For operation you
  82 need the following software
  83
  84 o    TeX
  85
  86 o    A   PostScript   printer   and/or   viewer   (such   as
  87      Ghostscript)  is  strongly recommended.  Xdvi will show
  88      all embedded PostScript too  if  you  have  Ghostscript
  89      installed.
  90
  91 o    GUILE    1.3,    check    out   http://www.gnu.org/pro-
  92      grams/guile.html
  93
  94 For running LilyPond successfully you have to help  TeX  and
  95 MetaFont  find  various files.  The recommended way of doing
  96 so is adjusting the environment variables  in  the  start-up
  97 scripts  of  your  shell.   An example is given here for the
  98 Bourne shell:
  99
 100      export MFINPUTS="/usr/local/share/lilypond/mf:"
 101      export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
 102
 103 The empty path component represents  and MetaFont's  default
 104
 105 search  paths.  Scripts with the proper paths for the bourne
 106 and   C-shell   respectively   are   generated   in   build-
 107 scripts/out/lilypond-profile  and buildscripts/out/lilypond-
 108 login during compilation.
 109
 110 LilyPond is a hideously slow program.  A fast CPU and plenty
 111 of RAM is recommended for comfortable use.
 112
 113 5: WEBSITE
 114
 115 If  you  want  to  auto-generate Lily's website, you'll need
 116 some additional conversion tools.
 117
 118 o    xpmtoppm (from the Portable Bitmap Utilities) (For Red-
 119      Hat  Linux  users:  it  is  included within the package
 120      libgr-progs).
 121
 122 o    Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
 123      Which, in turn depends on man2html for proper installa-
 124      tion.   man2html  can  be   had   from   http://askdon-
 125      ald.ask.uni-karlsruhe.de/hppd/hpux/Network-
 126      ing/WWW/Man2html-1.05.
 127
 128      TeTeX users should not forget to rerun texhash.
 129
 130 Building the website requires pnmtopng.  The version of pnm-
 131 topng that is distributed with RedHat 5.1 and 5.2 contains a
 132 bug: pnmtopng is dynamically linked to the wrong version  of
 133 libpng.   Recompile  it  from source, and make sure that the
 134 pnmtopng binary is linked statically to the libpng  that  is
 135 included  in libgr.   RedHat 6.0 does not have this problem.
 136
 137       tar xzf libgr-2.0.13.tar.gz
 138            make
 139            cd png
 140            rm libpng.so*
 141            make pnmtopng
 142
 143 You can then install the new pnmtopng into /usr/local/bin/
 144
 145 6: CONFIGURING and COMPILING
 146
 147 to install GNU LilyPond, simply type:
 148
 149           gunzip -c lilypond-x.y.z | tar xf -
 150           cd lilypond-x.y.z
 151           ./configure         # fill in your standard prefix with --prefix
 152           make
 153           make install
 154
 155 This will install a number of files, something close to:
 156
 157           /usr/local/man/man1/mi2mu.1
 158           /usr/local/man/man1/convert-mudela.1
 159           /usr/local/man/man1/mudela-book.1
 160           /usr/local/man/man1/lilypond.1
 161           /usr/local/bin/lilypond
 162           /usr/local/bin/mi2mu
 163           /usr/local/share/lilypond/*
 164           /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
 165
 166 The above assumes that you are root and have the GNU  devel-
 167 opment tools, and your make is GNU make.  If this is not the
 168 case, you can adjust  your  environment  variables  to  your
 169 taste:
 170
 171           export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 172           ./configure
 173
 174 CPPFLAGS are the preprocessor flags.
 175
 176 The configure script is Cygnus configure, and it will accept
 177 --help. If you are not root, you will probably have to  make
 178 it with a different --prefix option.  Our favourite location
 179 is
 180
 181           ./configure --prefix=$HOME/usr
 182
 183 In this case, you will have to set up MFINPUTS,  and  TEXIN-
 184 PUTS accordingly.
 185
 186 Since  GNU  LilyPond  currently  is beta, you are advised to
 187 also use
 188
 189           --enable-debugging
 190           --enable-checking
 191
 192 Options to configure include:
 193
 194 --enable-printing
 195      Enable debugging print routines (lilypond -D option)
 196
 197 --enable-optimise
 198      Set maximum optimisation: compile with -O2.   This  can
 199      be  unreliable  on  some compiler/platform combinations
 200      (eg, DEC Alpha and PPC)
 201
 202 --enable-profiling
 203      Compile with support for profiling.
 204
 205 --enable-config
 206      Output to a different configuration file.   Needed  for
 207      multi-platform builds
 208
 209 All  options are documented in the configure help The option
 210 --enable-optimise is recommended for Real Life usage.
 211
 212 If you do
 213
 214           make all
 215
 216 everything will be compiled, but nothing will be  installed.
 217 The  resulting  binaries  can be found in the subdirectories
 218 out/ (which contain all files generated during compilation).
 219
 220 7: CONFIGURING FOR MULTIPLE PLATFORMS
 221
 222 If you want to compile LilyPond with different configuration
 223 settings, then, you  can  use  the  --enable-config  option.
 224 Example:  suppose I want to build with and   without profil-
 225 ing.  Then I'd use the following for the normal build,
 226
 227            ./configure --prefix=~ --disable-optimise --enable-checking
 228            make
 229            make install
 230
 231 and for the profiling version, I specify a different config-
 232 uration.
 233
 234            ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
 235            make config=optprof
 236            make config=optprof install
 237
 238 8: INSTALLING
 239
 240 If you have done a successful make, then a simple
 241
 242           make install
 243
 244 should do the trick.
 245
 246 If you are doing an upgrade, please remember to remove obso-
 247 lete .pk and .tfm files of the fonts.   A  script  has  been
 248 provided to do the work for you, see bin/clean-fonts.sh.
 249
 250 CAVEATS
 251
 252 o    The  -O2  option   triggers   bugs on various platforms
 253      (PowerPC, Alpha).   If  you  experience  problems,  you
 254      should first try  turning off this.
 255
 256 EXAMPLE
 257
 258 This is what I type in my xterm:
 259
 260           lilypond someinput.ly
 261           tex someinput.tex
 262           xdvi someinput&
 263
 264 This is what the output looks like over here:
 265
 266           GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
 267           Parsing ... [/home/hw/share/lilypond/init//
 268                <..etc..>
 269                init//performer.ly]]][input/kortjakje.ly]
 270           Creating elements ...[8][16][24][25]
 271           Preprocessing elements...
 272           Calculating column positions ... [14][25]
 273           Postprocessing elements...
 274           TeX output to someinput.tex ...
 275           Creating MIDI elements ...MIDI output to someinput.midi ...
 276
 277           hw:~/musix/spacer$ xdvi someinput&
 278           [1] 855
 279
 280 Check out the input files, some of them have comments Please
 281 refer to the man page for more information.
 282
 283 9: REDHAT LINUX
 284
 285 RedHat Linux users can compile an RPM. A  spec  file  is  in
 286 make/out/lilypond.spec,  it  is  distributed  along with the
 287 sources.
 288
 289 You can make the rpm by issuing
 290
 291           rpm -tb lilypond-x.y.z.tar.gz
 292           rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 293
 294 10: DEBIAN GNU/LINUX
 295
 296 A Debian package is  also  available;  contact  Anthony  Fok
 297 foka@debian.org.   The build scripts are in the subdirectory
 298 debian/.
 299
 300 11: WINDOWS NT/95
 301
 302 Separate instructions on building for W32 are avaible in the
 303 file README-W32.yo.
 304
 305 12: AUTHORS
 306
 307 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 308
 309 Jan Nieuwenhuizen <janneke@gnu.org>
 310
 311 Have fun!