INSTALL.txt

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