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 o Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
 113     Which, in turn depends on man2html for proper installation.
 114 man2html can be had from http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05.
 115
 116     TeTeX users should not forget to rerun texhash.
 117
 118 Building the website requires pnmtopng.  The version of pnmtopng
 119 that is distributed with RedHat 5.1 and 5.2 contains a bug: pnmtopng
 120 is dynamically linked to the wrong version of libpng.  Recompile it
 121 from source, and make sure that the pnmtopng binary is linked
 122 statically to the libpng that is included in libgr.   RedHat 6.0 does
 123 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 6: CONFIGURING and COMPILING
 134
 135 to install GNU LilyPond, simply type:
 136
 137         gunzip -c lilypond-x.y.z | tar xf -
 138         cd lilypond-x.y.z
 139         ./configure             # fill in your standard prefix with --prefix
 140         make
 141         make install
 142
 143 This will install a number of files, something close to:
 144
 145         /usr/local/man/man1/mi2mu.1
 146         /usr/local/man/man1/convert-mudela.1
 147         /usr/local/man/man1/mudela-book.1
 148         /usr/local/man/man1/lilypond.1
 149         /usr/local/bin/lilypond
 150         /usr/local/bin/mi2mu
 151         /usr/local/share/lilypond/*
 152         /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
 153
 154 The above assumes that you are root and have the GNU development
 155 tools, and your make is GNU make.  If this is not the case, you can
 156 adjust your environment variables to your taste:
 157
 158         export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 159         ./configure
 160
 161 CPPFLAGS are the preprocessor flags.
 162
 163 The configure script is Cygnus configure, and it will accept
 164 --help. If you are not root, you will probably have to make it
 165 with a different --prefix option.  Our favourite location is
 166
 167         ./configure --prefix=$HOME/usr
 168
 169 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
 170
 171 Since GNU LilyPond currently is beta, you are advised to also use
 172
 173         --enable-debugging
 174         --enable-checking
 175
 176 Options to configure include:
 177
 178 o --enable-printing
 179     Enable debugging print routines (lilypond -D option)
 180 o --enable-optimise
 181     Set maximum optimisation: compile with -O2.  This can be
 182 unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
 183 o --enable-profiling
 184     Compile with support for profiling.
 185 o --enable-config
 186     Output to a different configuration file.  Needed for multi-platform
 187     builds
 188
 189 All options are documented in the configure help
 190 The option --enable-optimise is recommended for Real Life usage.
 191
 192 If you do
 193
 194         make all
 195
 196 everything will be compiled, but nothing will be installed.  The
 197 resulting binaries can be found in the subdirectories out/ (which
 198 contain all files generated during compilation).
 199
 200 7: CONFIGURING FOR MULTIPLE PLATFORMS
 201
 202 If you want to compile LilyPond with different configuration settings,
 203 then, you can use the --enable-config option.  Example: suppose I
 204 want to build with and   without profiling.  Then I'd use the
 205 following for the normal build,
 206
 207       ./configure --prefix=~ --disable-optimise --enable-checking
 208       make
 209       make install
 210
 211 and for the profiling version, I specify a different configuration.
 212
 213       ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
 214       make config=optprof
 215       make config=optprof install
 216
 217 8: INSTALLING
 218
 219 If you have done a successful make, then a simple
 220
 221         make install
 222
 223 should do the trick.
 224
 225 If you are doing an upgrade, please remember to remove obsolete
 226 .pk and .tfm files of the fonts.  A script has been
 227 provided to do the work for you, see bin/clean-fonts.sh.
 228
 229 CAVEATS
 230
 231 o The -O2 option  triggers  bugs on various platforms (PowerPC, Alpha).
 232     If you experience problems, you  should first try  turning off
 233     this.
 234 o  On PPC you need at least EGCS-1.1.2f.
 235
 236 EXAMPLE
 237
 238 This is what I type in my xterm:
 239
 240         lilypond someinput.ly
 241         tex someinput.tex
 242         xdvi someinput&
 243
 244 This is what the output looks like over here:
 245
 246         GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
 247         Parsing ... [/home/hw/share/lilypond/init//
 248                 <..etc..>
 249                 init//performer.ly]]][input/kortjakje.ly]
 250         Creating elements ...[8][16][24][25]
 251         Preprocessing elements...
 252         Calculating column positions ... [14][25]
 253         Postprocessing elements...
 254         TeX output to someinput.tex ...
 255         Creating MIDI elements ...MIDI output to someinput.midi ...
 256
 257         hw:~/musix/spacer$ xdvi someinput&
 258         [1] 855
 259
 260 Check out the input files, some of them have comments
 261 Please refer to the man page for more information.
 262
 263 9: REDHAT LINUX
 264
 265 RedHat Linux users can compile an RPM. A spec file is in
 266 make/out/lilypond.spec, it is distributed along with the
 267 sources.
 268
 269 You can make the rpm by issuing
 270
 271         rpm -tb lilypond-x.y.z.tar.gz
 272         rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 273
 274 Precompiled i386 eRedHat RPMS are available from
 275 http://linux.umbc.edu/software/lilypond/rpms/.
 276
 277 10: DEBIAN GNU/LINUX
 278
 279 A Debian package is also available; contact Anthony Fok
 280 <foka@debian.org>.  The build scripts are in the subdirectory
 281 debian/.
 282
 283 11: WINDOWS NT/95
 284
 285 Separate instructions on building for W32 are avaible
 286 in the file README-W32.yo.
 287
 288 12: AUTHORS
 289
 290 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 291
 292 Jan Nieuwenhuizen <janneke@gnu.org>
 293
 294 Have fun!