Documentation/topdocs/INSTALL.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename INSTALL.info
   3 @settitle INSTALL - compiling and installing GNU LilyPond
   4
   5 @node Top, , , (dir)
   6 @top
   7
   8 @chapter INSTALL - compiling and installing GNU LilyPond
   9
  10 @section Obtaining
  11
  12 You can get the latest version of LilyPond at
  13 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,
  14 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.
  15
  16
  17 @emph{If you upgrade by patching do remember to rerun autoconf after
  18 applying the patch}.
  19
  20 If you do not want to download the entire archive for each version, the
  21 safest method for upgrading is to use @file{xdelta}, see
  22 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/}.
  23
  24 The following command produces @file{lilypond-1.3.122.tar.gz} from
  25 @file{lilypond-1.3.121} identical (up to compression dates) to the .122 on
  26 the FTP site.
  27 @example
  28   xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz
  29 @end example
  30
  31 @section Prerequisites
  32
  33 For compilation you need:
  34
  35 @itemize @bullet
  36 @item A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
  37     (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
  38     Solaris.
  39
  40 @item Lots of disk space: LilyPond takes between 30 and 100 mb to
  41 compile if you use debugging information.  If you are short on
  42 disk-space run configure with @code{--disable-debugging}.
  43
  44 @item
  45 Although we recommend to use Unix, LilyPond is known to run on Windows
  46 NT/95/98 as well.  See Section Windows NT/95,es.
  47
  48 @item A reasonable C++ compiler:  EGCS 1.1, GCC 2.95.2 or newer. Check out @uref{ftp://ftp.gnu.org/gnu/gcc/}.
  49
  50 @item  Python 1.5,
  51 Check out @uref{ftp://ftp.python.org} or
  52 @uref{ftp://ftp.cwi.nl/pub/python}.
  53
  54 @item  GUILE 1.3.4 or newer,  check out
  55 @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
  56 Version 1.4 is recommended for better performance.
  57
  58 @item GNU Make.
  59 Check out
  60 @uref{ftp://ftp.gnu.org/gnu/make/,ftp://ftp.gnu.org/gnu/make/}.
  61
  62 @item Flex (version 2.5.4a or newer).
  63 Check out @uref{ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/,ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/}.
  64
  65 @item Bison (version 1.25 or newer).
  66 Check out @uref{ftp://ftp.gnu.org/gnu/bison/,ftp://ftp.gnu.org/gnu/bison/}.
  67
  68 @item TeX.  If you want LilyPond to use kpathsea support (recommended),
  69 make sure you have tetex 1.0 or newer (1.0.6 is known to work).  You may
  70 need to install a tetex-devel or tetex-dev package too.
  71
  72 @item Texinfo (version 4.0 or newer).
  73 Check out @uref{ftp://ftp.gnu.org/gnu/texinfo/,ftp://ftp.gnu.org/gnu/texinfo/}.
  74 Most documentation is in texinfo.
  75
  76 @item The geometry package for LaTeX is needed to use ly2dvi.
  77 Available at
  78 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
  79 or at mirror site @uref{ftp://ftp.dante.de,ftp://ftp.dante.de}
  80
  81 @item MetaPost, needed for generating PostScript fonts. Please
  82 note that tetex-0.4pl8 (included with Red Hat 5.x) does not include
  83 @file{mfplain.mp}, which is needed for producing the scalable font
  84 files.
  85
  86 If you do not want to use PostScript output, edit @file{mf/GNUmakefile},
  87 removing the line saying @code{PFA_FILES=}
  88
  89 @item kpathsea, a library for searching (TeX) files.  @code{kpathsea} is
  90 usually included with your installation of TeX.
  91
  92 @end itemize
  93
  94 @section Running
  95
  96 GNU LilyPond does use a lot of resources. For operation you need the
  97 following software
  98
  99 @itemize @bullet
 100 @item TeX.
 101 @item A PostScript printer and/or viewer (such as Ghostscript) is strongly
 102     recommended.  Xdvi will show all embedded PostScript too if you have
 103     Ghostscript installed.
 104 @item  GUILE 1.3.4, or newer.  Check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/software/guile/}
 105 @end itemize
 106
 107 For running LilyPond successfully you have to help TeX and MetaFont find
 108 various files.  The recommended way of doing so is adjusting the
 109 environment variables in the start-up scripts of your shell. Appropriate
 110 Csh and sh scripts are left in @file{buildscripts/out/lilypond-profile}
 111 and @file{buildscripts/out/lilypond-login} after compilation.
 112
 113 The empty path component represents TeX and MetaFont's default search
 114 paths.  Scripts with the proper paths for the bourne and C-shell
 115 respectively are generated in @file{buildscripts/out/lilypond-profile}
 116 and @file{buildscripts/out/lilypond-login} during compilation.
 117
 118 LilyPond is a big and slow program.  A fast CPU and plenty of RAM is
 119 recommended for comfortable use.
 120
 121 @section Website
 122
 123 The website is the most convenient form to use for reading the
 124 documentation on-line documentation. It is made by entering @example
 125
 126   make htmldoc
 127
 128 @end example
 129 This does require a functioning LilyPond.  The binary doesn't have to
 130 be installed.
 131
 132 If you want to auto-generate Lily's website, you'll need some additional
 133 conversion tools.
 134
 135 @itemize @bullet
 136 @item xpmtoppm (from the netpbm package: the Portable Bitmap Utilities) (For Red Hat Linux
 137              users: it is included within the package libgr-progs).
 138         The original is at
 139 @uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz}
 140
 141 @item pnmtopng (also in libgr-progs for Red Hat). The original is
 142 at
 143 @uref{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz,ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz}.i
 144
 145 The version of @file{pnmtopng} that is distributed with Red Hat 5.1 and
 146 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
 147 version of libpng.
 148
 149 @item @uref{http://www.lri.fr/~filliatr/ftp/bibtex2html/, Bibtex2html}, or
 150 @uref{http://www.uni-koblenz.de/ag-ki/ftp/bib2html/, Bib2html}.
 151 Bibtex2html is available in debian, while bib2html is in some rpm based
 152 distributions.
 153 Bib2html, in turn depends on man2html for proper installation.
 154 man2html can be had from @uref{http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05,http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05}.
 155
 156 The website will build without bib converter utility, but you will not
 157 see our hypertextified bibliography.
 158
 159 @end itemize
 160
 161 @section Configuring and compiling
 162
 163 to install GNU LilyPond, simply type:
 164 @example
 165         gunzip -c lilypond-x.y.z | tar xf -
 166         cd lilypond-x.y.z
 167         ./configure             # fill in your standard prefix with --prefix
 168         make
 169         make install
 170 @end example
 171
 172 This will install a number of files, something close to:
 173
 174 @example
 175         /usr/local/man/man1/midi2ly.1
 176         /usr/local/man/man1/abc2ly.1
 177         /usr/local/man/man1/etf2ly.1
 178         /usr/local/man/man1/convert-ly.1
 179         /usr/local/man/man1/lilypond-book.1
 180         /usr/local/man/man1/lilypond.1
 181         /usr/local/bin/lilypond
 182         /usr/local/bin/midi2ly
 183         /usr/local/bin/convert-ly
 184         /usr/local/bin/lilypond-book
 185         /usr/local/bin/abc2ly
 186         /usr/local/bin/pmx2ly
 187         /usr/local/bin/musedata2ly
 188         /usr/local/bin/etf2ly
 189         /usr/local/share/lilypond/*
 190         /usr/local/share/locale/@{....@}/LC_MESSAGES/lilypond.mo
 191 @end example
 192
 193
 194 The above assumes that you are root and have the GNU development
 195 tools, and your make is GNU make.  If this is not the case, you can
 196 adjust your environment variables to your taste:
 197
 198 @example
 199
 200         export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 201         ./configure
 202
 203 @end example
 204
 205 @code{CPPFLAGS} are the preprocessor flags.
 206
 207 The configure script is Cygnus configure, and it will accept
 208 @code{--help}. If you are not root, you will probably have to make it
 209 with a different @code{--prefix} option.  Our favourite location is
 210
 211 @example
 212
 213         ./configure --prefix=$HOME/usr
 214
 215 @end example
 216
 217 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
 218
 219 Since GNU LilyPond currently is beta, you are advised to also use
 220
 221 @example
 222
 223         --enable-debugging
 224         --enable-checking
 225
 226 @end example
 227
 228 Options to configure include:
 229
 230 @table @samp
 231 @item @code{--enable-printing}
 232     Enable debugging print routines (lilypond @code{-D} option)
 233 @item @code{--enable-optimise}
 234     Set maximum optimisation: compile with @code{-O2}.  This can be
 235 unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
 236 @item @code{--enable-profiling}
 237     Compile with support for profiling.
 238 @item @code{--enable-config=CONF}
 239     Output to different configuration files.  Enables different binary
 240     builds alongside eachother, eg, multi-configuration (debugging,
 241     profiling), or multi-platform builds.  Use `make conf=CONF' to
 242     build for a specific configuration.
 243 @end table
 244
 245 All options are documented in the @file{configure} help
 246 The option @code{--enable-optimise} is recommended for Real Life usage.
 247
 248 If you do
 249
 250 @example
 251
 252         make all
 253
 254 @end example
 255
 256 everything will be compiled, but nothing will be installed.  The
 257 resulting binaries can be found in the subdirectories @file{out/} (which
 258 contain all files generated during compilation).
 259
 260
 261 @section Emacs mode
 262
 263
 264 An emacs mode for LilyPond is included with the source archive as
 265 @file{lilypond-mode.el} and @file{lilypond-font-lock.el}.  If you have
 266 an RPM, it is in @file{/usr/share/doc/lilypond-X/}.  You have to install
 267 it yourself.
 268
 269 Add this to your ~/.emacs or ~/.emacs.el:
 270 @example
 271     (load-library "lilypond-mode.el")
 272     (setq auto-mode-alist
 273       (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
 274     (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
 275 @end example
 276
 277 If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
 278 is automatically loaded, so you need not modify your ~/.emacs file.
 279
 280
 281 @section Configuring for multiple platforms
 282
 283 If you want to build multiple versions of LilyPond with different
 284 configuration settings, you can use the @code{--enable-config=CONF}
 285 option.  You should use @samp{make conf=CONF} to generate the output in
 286 @file{out-CONF}.  Example: suppose I want to build with and without
 287 profiling.  Then I'd use the following for the normal build,
 288
 289 @example
 290
 291       ./configure --prefix=~ --disable-optimise --enable-checking
 292       make
 293       make install
 294
 295 @end example
 296
 297 and for the profiling version, I specify a different configuration.
 298
 299 @example
 300
 301       ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
 302       make conf=prof
 303       make conf=prof install
 304
 305 @end example
 306
 307
 308 @section Installing
 309
 310 if you have done a successful @code{make}, then a simple
 311
 312 @example
 313
 314         make install
 315
 316 @end example
 317
 318 should do the trick.
 319
 320 If you are doing an upgrade, please remember to remove obsolete
 321 @file{.pk} and @file{.tfm} files of the fonts.  A script has been
 322 provided to do the work for you, see @file{bin/clean-fonts.sh}.
 323
 324
 325 @section Red Hat Linux
 326
 327 Red Hat Linux users can compile an RPM.  A spec file is in
 328 @file{make/out/lilypond.spec}; it is distributed along with the
 329 sources.
 330
 331 You can make the rpm by issuing
 332 @example
 333
 334         rpm -tb lilypond-x.y.z.tar.gz
 335         rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 336
 337 @end example
 338
 339 Precompiled Red Hat 7.0 i386 RPMS are available from
 340 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/}.
 341
 342 For compilation on a Red Hat system you need these packages,
 343 in addition to the those needed for running:
 344 @itemize @bullet
 345 @item glibc-devel
 346 @item libstdc++-devel
 347 @item guile-devel
 348 @item flex
 349 @item bison
 350 @item texinfo
 351 @item tetex-devel
 352 @end itemize
 353
 354 @section SuSE
 355
 356 [TODO: document this]
 357
 358 Install @code{tetex}, @code{te_mpost}, @code{te_kpath}.
 359
 360
 361 @section Debian GNU/Linux
 362
 363 A Debian package is also available.  You may install it easily by using
 364 apt-get as root:
 365
 366 @example
 367         apt-get install lilypond1.3
 368 @end example
 369
 370 Alternatively, visit
 371
 372 @itemize @bullet
 373 @item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
 374 @item @uref{http://ftp.debian.org/debian/pool/main/l/lilypond1.3/,http://ftp.debian.org/debian/pool/main/l/lilypond1.3/}
 375 for latest package uploaded to Debian unstable;
 376 @item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
 377 for latest semi-unofficial build of LilyPond 1.3.121 for Debian 2.2r2 (potato) users.
 378 The official stable Debian 2.2r2 is stuck with the old LilyPond-1.3.24.
 379 @end itemize
 380
 381 You may contact Anthony Fok @email{foka@@debian.org} for more information.
 382
 383 The build scripts are in the subdirectory @file{debian/}; you can
 384 make the .deb by doing, for example:
 385
 386 @example
 387         $ su - root
 388         # dpkg --purge lilypond lilypond1.3
 389         # exit
 390         $ tar xzf lilypond-1.3.122.tar.gz
 391         $ cd lilypond-1.3.122
 392         $ dch -p -v 1.3.122-0.local.1 "Local build."
 393         $ debuild
 394         $ su - root
 395         # dpkg -i ../lilypond1.3_1.3.122*.deb
 396         # exit
 397         $
 398 @end example
 399
 400 For compilation on a Debian GNU/Linux system you need these packages,
 401 in addition to the those needed for running:
 402
 403 @itemize @bullet
 404 @item g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
 405 @item libguile<your-libguile-version-here>-dev
 406 @item make, m4, flex, bison
 407 @item gettext
 408 @item groff, texinfo, bibtex2html (not in 2.2r2)
 409 @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
 410 @item dpkg-dev, debhelper, fakeroot
 411 @item gs, netpbm, pnmtopng
 412 @end itemize
 413
 414 Most of these are listed on the Build-Depends line in the
 415 debian/control file.  To ensure the creation of the lilypond deb is
 416 trouble-free, we recommend that you first install the following packages
 417 before starting dpkg-buildpackage by running apt-get as root.
 418
 419 For Debian 2.2 (or 2.2r2, 2.2r3):
 420
 421 @example
 422         apt-get install task-debian-devel task-c++-dev \
 423                 python-base libguile6-dev tetex-bin tetex-dev \
 424                 tetex-extra flex bison texinfo groff gs \
 425                 netpbm pnmtopng m4 gettext
 426 @end example
 427
 428 For Debian in development ("unstable", the future 2.3 or 3.0):
 429
 430 @example
 431         apt-get install task-debian-devel task-c++-dev \
 432                 python-base libguile9-dev tetex-bin libkpathsea-dev \
 433                 tetex-extra flex bison texinfo bibtex2html groff gs \
 434                 netpbm pnmtopng m4 gettext
 435 @end example
 436
 437 And, just so that old fonts from previous versions of LilyPond won't
 438 interfere with your build, you may want to do this before the build too:
 439
 440 @example
 441         dpkg --purge lilypond lilypond1.3
 442 @end example
 443
 444
 445 @section Windows NT/95
 446
 447 Separate instructions on building for W32 are available; See the files
 448 in @file{Documentation/ntweb/}, included with the sources.
 449
 450 @section Problems
 451
 452 For help and questions use @email{help-gnu-music@@gnu.org} and
 453 @email{gnu-music-discuss@@gnu.org}.  Please consult the faq before
 454 mailing your problems.
 455
 456 If you find bugs, please send bug reports to
 457 @email{bug-gnu-music@@gnu.org}.
 458
 459 Bugs that are LilyPond's fault are listed in our TODO list on the
 460 web, or demonstrated in @file{input/bugs/}.
 461
 462 Bugs that are not LilyPond's fault are documented here.
 463
 464
 465 @unnumbered LinuxPPC Bugs:
 466
 467 @itemize @bullet
 468 @item egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
 469 fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
 470
 471 @item egcs-1.0.2 (LinuxPPC R4):
 472 all compiling with @code{-O2} is suspect, in particular guile-1.3, and
 473 Lily herself will break.
 474 @end itemize
 475
 476
 477
 478 @unnumbered Linux-i386
 479
 480 @itemize @bullet
 481 @item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
 482
 483 Lily will crash during parsing (which suggests a C++ library
 484 incompatibility).  Precise cause, precise platform description or
 485 solution are not known.
 486
 487 Note that this only happens on some computers with the said platform.
 488
 489 @item libg++ 2.7
 490
 491 LilyPond occasionally crashes while parsing the initialisation files.
 492 This is a very obscure bug, and usually entering the commandline
 493 differently "fixes" it.
 494
 495 @example
 496         lilypond input.ly
 497 @end  example
 498
 499 and
 500 @example
 501         lilypond -I. ./input.ly
 502 @end example
 503 makes a difference
 504
 505 Typical stacktrace:
 506 @example
 507         SIGSEGV
 508         __libc_malloc (bytes=16384)
 509         ?? ()
 510         yyFlexLexer::yy_create_buffer ()
 511         Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
 512 @end example
 513
 514 This behaviour has been observed with machines that have old libg++
 515 versions (LinuxPPC feb '98, Red Hat 4.x).
 516 @end itemize
 517
 518
 519
 520
 521 @unnumbered Solaris:
 522
 523 @itemize @bullet
 524 @item Sparc64/Solaris 2.6, GNU make-3.77
 525
 526 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
 527
 528
 529 @item Sparc64/Solaris 2.6, ld
 530
 531 Not yet resolved.
 532 @end itemize
 533
 534
 535 @unnumbered AIX
 536
 537 @itemize @bullet
 538 @item AIX 4.3 ld
 539
 540 The following is from the gcc install/SPECIFIC file.
 541 @quotation
 542    Some versions of the AIX binder (linker) can fail with a relocation
 543    overflow severe error when the -bbigtoc option is used to link
 544    GCC-produced object files into an executable that overflows the TOC.
 545    A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
 546    -BBIGTOC) is available from IBM Customer Support and from its
 547    27service.boulder.ibm.com website as PTF U455193.
 548
 549    Binutils does not support AIX 4.3 (at least through release 2.9). GNU
 550    as and GNU ld will not work properly and one should not configure GCC
 551    to use those GNU utilities. Use the native AIX tools which do
 552    interoperate with GCC.
 553 @end quotation
 554
 555 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
 556 @example
 557     LDFLAGS='-Wl,-bbigtoc' ./configure
 558 @end example
 559
 560 @end itemize
 561
 562
 563 @bye
 564