INSTALL.txt

   1
   2
   3 INSTALL - compiling and installing GNU LilyPond
   4 ***********************************************
   5
   6 Abstract
   7 ========
   8
   9    This document explains what you need to install LilyPond, and what
  10 you should do.  If you are going to compile and install LilyPond often,
  11 e.g. when doing development, you might want to check out the
  12 `buildscripts/set-lily.sh' script.  It sets some environment variables
  13 and symlinks, which comes in handly when you have to compile LilyPond
  14 more often.
  15
  16 Obtaining
  17 =========
  18
  19    You can get the latest version of LilyPond at
  20 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
  21 (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).
  22
  23    _If you upgrade by patching do remember to rerun autoconf after
  24 applying the patch_.
  25
  26    If you do not want to download the entire archive for each version,
  27 the safest method for upgrading is to use `xdelta', see
  28 `ftp://ftp.xcf.berkeley.edu/pub/xdelta/'.
  29
  30    The following command produces `lilypond-1.1.55.tar.gz' from
  31 `lilypond-1.1.54' identical (up to compression dates) to the .55 on the
  32 FTP site.
  33        xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
  34
  35 Prerequisites
  36 =============
  37
  38    For compilation you need:
  39
  40    * A GNU system: GNU LilyPond is known to run on these GNU systems:
  41      Linux     (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
  42      and Solaris.
  43
  44    * Lots of disk space: LilyPond takes between 30 and 100 mb to
  45      compile if you use debugging information.  If you are short on
  46      disk-space run configure with `--disable-debugging'.
  47
  48    * Although we recommend to use Unix, LilyPond is known to run on
  49      Windows NT/95/98 as well.  See Section Windows NT/95,es.
  50
  51    * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
  52
  53    * Python 1.5, Check out `ftp://ftp.python.org' or
  54      `ftp://ftp.cwi.nl/pub/python'.
  55
  56    * GUILE 1.3.4,  check out
  57      http://www.gnu.org/software/guile/guile.html
  58      (http://www.gnu.org/software/guile/guile.html).
  59
  60    * GNU make.  Check out ftp://ftp.gnu.org/make/
  61      (ftp://ftp.gnu.org/make/).
  62
  63    * Flex (version 2.5.4 or newer).  Check out ftp://ftp.gnu.org/flex/
  64      (ftp://ftp.gnu.org/flex/).
  65
  66    * Bison (version 1.25 or newer).  Check out ftp://ftp.gnu.org/bison/
  67      (ftp://ftp.gnu.org/bison/).
  68
  69    * Texinfo. Check out ftp://ftp.gnu.org/pub/texinfo/
  70      (ftp://ftp.gnu.org/pub/texinfo/).  Most documentation is in
  71      texinfo.
  72
  73    * The geometry package for LaTeX is needed to use ly2dvi.  Available
  74      at
  75      ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
  76      (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
  77      or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
  78
  79    * MetaPost, if you want to use direct PostScript output. Please note
  80      that  tetex-0.4pl8 (included with Redhat 5.x) does not include
  81      `mfplain.mp', which is needed  for producing the scaleable font
  82      files.
  83
  84
  85 Running
  86 =======
  87
  88    GNU LilyPond does use a lot of resources. For operation you need the
  89 following software
  90
  91    * TeX
  92
  93    * A PostScript printer and/or viewer (such as Ghostscript) is
  94      strongly     recommended.  Xdvi will show all embedded PostScript
  95      too if you have     Ghostscript installed.
  96
  97    * GUILE 1.3.4, check out http://www.gnu.org/software/guile/
  98      (http://www.gnu.org/programs/guile.html)
  99
 100    For running LilyPond successfully you have to help TeX and MetaFont
 101 find various files.  The recommended way of doing so is adjusting the
 102 environment variables in the start-up scripts of your shell.  An
 103 example is given here for the Bourne shell:
 104      export MFINPUTS="/usr/local/share/lilypond/mf:"
 105      export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
 106
 107    The empty path component represents TeX and MetaFont's default
 108 search paths.  Scripts with the proper paths for the bourne and C-shell
 109 respectively are generated in `buildscripts/out/lilypond-profile' and
 110 `buildscripts/out/lilypond-login' during compilation.
 111
 112    LilyPond is a hiddeously big, slow and bloated program.  A fast CPU
 113 and plenty of RAM is recommended for comfortable use.
 114
 115 Website
 116 =======
 117
 118    The website is the most convenient form to use for reading the
 119 documentation on-line documentation. It is made by entering
 120
 121        make website
 122    This does require a  functioning  LilyPond. The binary doesn't have
 123 to be installed.
 124
 125    If you want to auto-generate Lily's website, you'll need some
 126 additional conversion tools.
 127
 128    * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
 129       users: it is included within the package libgr-progs).
 130      the original is at
 131      ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
 132      (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
 133
 134    * pnmtopng, which is also in libgr-progs for RedHat. The original is
 135      at
 136      ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
 137      (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
 138
 139      The version of `pnmtopng' that is distributed with RedHat 5.1 and
 140      5.2 contains a bug: pnmtopng is dynamically linked to the wrong
 141      version of libpng, which results in cropped images.  Recompile it
 142      from source, and make sure that the pnmtopng binary is linked
 143      statically to the libpng that is included in libgr.  RedHat 6.0
 144      does not have this problem.
 145
 146            tar xzf libgr-2.0.13.tar.gz
 147                 make
 148                 cd png
 149                 rm libpng.so*
 150                 make pnmtopng
 151
 152      You can then install the new pnmtopng into `/usr/local/bin/'
 153
 154    * Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
 155      (http://pertsserver.cs.uiuc.edu/~hull/bib2html.)      Which, in
 156      turn depends on man2html for proper installation.  man2html can be
 157      had from
 158      http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
 159      (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
 160
 161      The website will build without this utility, but you will not see
 162      our hypertextified bibliography.
 163
 164    * Doc++ (optional) to read the source code.
 165
 166
 167 Configuring and compiling
 168 =========================
 169
 170    to install GNU LilyPond, simply type:
 171
 172         gunzip -c lilypond-x.y.z | tar xf -
 173         cd lilypond-x.y.z
 174         ./configure             # fill in your standard prefix with --prefix
 175         make
 176         make install
 177
 178    This will install a number of files, something close to:
 179
 180         /usr/local/man/man1/mi2mu.1
 181         /usr/local/man/man1/convert-mudela.1
 182         /usr/local/man/man1/mudela-book.1
 183         /usr/local/man/man1/lilypond.1
 184         /usr/local/bin/lilypond
 185         /usr/local/bin/mi2mu
 186         /usr/local/bin/convert-mudela
 187         /usr/local/bin/mudela-book
 188         /usr/local/bin/abc2ly
 189         /usr/local/share/lilypond/*
 190         /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
 191
 192    The above assumes that you are root and have the GNU development
 193 tools, and your make is GNU make.  If this is not the case, you can
 194 adjust your environment variables to your taste:
 195
 196
 197         export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 198         ./configure
 199
 200    `CPPFLAGS' are the preprocessor flags.
 201
 202    The configure script is Cygnus configure, and it will accept
 203 `--help'. If you are not root, you will probably have to make it with a
 204 different `--prefix' option.  Our favourite location is
 205
 206
 207         ./configure --prefix=$HOME/usr
 208
 209    In this case, you will have to set up MFINPUTS, and TEXINPUTS
 210 accordingly.
 211
 212    Since GNU LilyPond currently is beta, you are advised to also use
 213
 214
 215         --enable-debugging
 216         --enable-checking
 217
 218    Options to configure include:
 219
 220 ``--enable-printing''
 221      Enable debugging print routines (lilypond `-D' option)
 222
 223 ``--enable-optimise''
 224      Set maximum optimisation: compile with `-O2'.  This can be
 225      unreliable on some compiler/platform combinations (eg, DEC Alpha
 226      and PPC)
 227
 228 ``--enable-profiling''
 229      Compile with support for profiling.
 230
 231 ``--enable-config''
 232      Output to a different configuration file.  Needed for
 233      multi-platform     builds
 234
 235    All options are documented in the `configure' help The option
 236 `--enable-optimise' is recommended for Real Life usage.
 237
 238    If you do
 239
 240
 241         make all
 242
 243    everything will be compiled, but nothing will be installed.  The
 244 resulting binaries can be found in the subdirectories `out/' (which
 245 contain all files generated during compilation).
 246
 247 Configuring for multiple platforms
 248 ==================================
 249
 250    If you want to compile LilyPond with different configuration
 251 settings, then, you can use the `--enable-config' option.  Example:
 252 suppose I want to build with and   without profiling.  Then I'd use the
 253 following for the normal build,
 254
 255
 256            ./configure --prefix=~ --disable-optimise --enable-checking
 257            make
 258            make install
 259
 260    and for the profiling version, I specify a different configuration.
 261
 262
 263            ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
 264            make config=optprof
 265            make config=optprof install
 266
 267 Installing
 268 ==========
 269
 270    if you have done a successful `make', then a simple
 271
 272
 273         make install
 274
 275    should do the trick.
 276
 277    If you are doing an upgrade, please remember to remove obsolete
 278 `.pk' and `.tfm' files of the fonts.  A script has been provided to do
 279 the work for you, see `bin/clean-fonts.sh'.
 280
 281 Redhat linux
 282 ============
 283
 284    RedHat Linux users can compile an RPM. A spec file is in
 285 `make/out/lilypond.spec', it is distributed along with the sources.
 286
 287    You can make the rpm by issuing
 288
 289         rpm -tb lilypond-x.y.z.tar.gz
 290         rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 291
 292    Precompiled i386 RedHat RPMS are available from
 293 ftp://freshmeat.net/pub/rpms/lilypond/
 294 (ftp://freshmeat.net/pub/rpms/lilypond/) and
 295 http://linux.umbc.edu/software/lilypond/rpms/
 296 (http://linux.umbc.edu/software/lilypond/rpms/).
 297
 298    For compilation on a RedHat system you need these packages, in
 299 addition to the those needed for running:
 300    * glibc-devel
 301
 302    * libstdc++-devel
 303
 304    * guile-devel
 305
 306    * flex
 307
 308    * bison
 309
 310    * texinfo
 311
 312 Debian GNU/linux
 313 ================
 314
 315    A Debian package is also available; contact Anthony Fok
 316 <foka@debian.org>.  The build scripts are in the subdirectory `debian/'.
 317
 318 Windows NT/95
 319 =============
 320
 321    Separate instructions on building for W32 are available; See the
 322 files in `Documentation/ntweb/', included with the sources.
 323
 324 Problems
 325 ========
 326
 327    For help and questions use <help-gnu-music@gnu.org> and
 328 <gnu-music-discuss@gnu.org>.  Please consult the faq before mailing
 329 your problems.
 330
 331    If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
 332
 333    Known bugs that are LilyPond's fault are listed in `TODO', or
 334 demonstrated in `input/bugs/'.
 335
 336    Known bugs that are not LilyPond's fault are documented here.
 337
 338 LinuxPPC Bugs:
 339 **************
 340
 341    * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
 342      fixed in egcs-1.1.2-12f or gcc-2.95-0a,
 343      `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
 344
 345    * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
 346      particular guile-1.3, and Lily herself will break.
 347
 348 Linux-i386
 349 **********
 350
 351    * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
 352
 353      Lily will crash during parsing (which suggests a C++ library
 354      incompatibility).  Precise cause, precise platform description or
 355      solution are not known.
 356
 357      Note that this only happens on some computers with the said
 358      platform.
 359
 360    * libg++ 2.7
 361
 362      LilyPond occasionally crashes while parsing the initialisation
 363      files.  This is a very obscure bug, and usually entering the
 364      commandline differently "fixes" it.
 365
 366                 lilypond input.ly
 367
 368      and
 369                 lilypond -I. ./input.ly
 370      makes a difference
 371
 372      Typical stacktrace:
 373                 SIGSEGV
 374                 __libc_malloc (bytes=16384)
 375                 ?? ()
 376                 yyFlexLexer::yy_create_buffer ()
 377                 Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
 378
 379      This behaviour has been observed with machines that have old libg++
 380      versions (LinuxPPC feb '98, RedHat 4.x).
 381
 382 Solaris:
 383 ********
 384
 385    * Sparc64/Solaris 2.6, GNU make-3.77
 386
 387      GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
 388      newer.
 389
 390    * Sparc64/Solaris 2.6, ld
 391
 392      Not yet resolved.
 393
 394 AIX
 395 ***
 396
 397    * AIX 4.3 ld
 398
 399      The following is from the gcc install/SPECIFIC file.
 400              Some versions of the AIX binder (linker) can fail with a
 401           relocation    overflow severe error when the -bbigtoc option
 402           is used to link    GCC-produced object files into an
 403           executable that overflows the TOC. A    fix for APAR IX75823
 404           (OVERFLOW DURING LINK WHEN USING GCC AND    -BBIGTOC) is
 405           available from IBM Customer Support and from its
 406           27service.boulder.ibm.com website as PTF U455193.
 407
 408           Binutils does not support AIX 4.3 (at least through release
 409           2.9). GNU    as and GNU ld will not work properly and one
 410           should not configure GCC    to use those GNU utilities. Use
 411           the native AIX tools which do    interoperate with GCC.
 412
 413      add -Wl,-bbigtoc to USER_LDFLAGS, ie:
 414               LDFLAGS='-Wl,-bbigtoc' ./configure
 415
 416