Documentation/topdocs/INSTALL.yo

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