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