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}
 239     Output to a different configuration file.  Needed for multi-platform
 240     builds
 241 @end table
 242
 243 All options are documented in the @file{configure} help
 244 The option @code{--enable-optimise} is recommended for Real Life usage.
 245
 246 If you do
 247
 248 @example
 249
 250         make all
 251
 252 @end example
 253
 254 everything will be compiled, but nothing will be installed.  The
 255 resulting binaries can be found in the subdirectories @file{out/} (which
 256 contain all files generated during compilation).
 257
 258 @section Configuring for multiple platforms
 259
 260 If you want to compile LilyPond with different configuration settings,
 261 then, you can use the @code{--enable-config} option.  Example: suppose I
 262 want to build with and   without profiling.  Then I'd use the
 263 following for the normal build,
 264
 265 @example
 266
 267       ./configure --prefix=~ --disable-optimise --enable-checking
 268       make
 269       make install
 270
 271 @end example
 272
 273 and for the profiling version, I specify a different configuration.
 274
 275 @example
 276
 277       ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
 278       make config=prof
 279       make config=prof install
 280
 281 @end example
 282
 283
 284 @section Installing
 285
 286 if you have done a successful @code{make}, then a simple
 287
 288 @example
 289
 290         make install
 291
 292 @end example
 293
 294 should do the trick.
 295
 296 If you are doing an upgrade, please remember to remove obsolete
 297 @file{.pk} and @file{.tfm} files of the fonts.  A script has been
 298 provided to do the work for you, see @file{bin/clean-fonts.sh}.
 299
 300
 301 @section Red Hat Linux
 302
 303 Red Hat Linux users can compile an RPM.  A spec file is in
 304 @file{make/out/lilypond.spec}; it is distributed along with the
 305 sources.
 306
 307 You can make the rpm by issuing
 308 @example
 309
 310         rpm -tb lilypond-x.y.z.tar.gz
 311         rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 312
 313 @end example
 314
 315 Precompiled Red Hat 7.0 i386 RPMS are available from
 316 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/}.
 317
 318 For compilation on a Red Hat system you need these packages,
 319 in addition to the those needed for running:
 320 @itemize @bullet
 321 @item glibc-devel
 322 @item libstdc++-devel
 323 @item guile-devel
 324 @item flex
 325 @item bison
 326 @item texinfo
 327 @item tetex-devel
 328 @end itemize
 329
 330 @section Debian GNU/Linux
 331
 332 A Debian package is also available.  You may install it easily by using
 333 apt-get as root:
 334
 335 @example
 336         apt-get install lilypond1.3
 337 @end example
 338
 339 Alternatively, visit
 340
 341 @itemize @bullet
 342 @item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
 343 @item @uref{http://ftp.debian.org/debian/pool/main/l/lilypond1.3/,http://ftp.debian.org/debian/pool/main/l/lilypond1.3/}
 344 for latest package uploaded to Debian unstable;
 345 @item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
 346 for latest semi-unofficial build of LilyPond 1.3.121 for Debian 2.2r2 (potato) users.
 347 The official stable Debian 2.2r2 is stuck with the old LilyPond-1.3.24.
 348 @end itemize
 349
 350 You may contact Anthony Fok @email{foka@@debian.org} for more information.
 351
 352 The build scripts are in the subdirectory @file{debian/}; you can
 353 make the .deb by doing, for example:
 354
 355 @example
 356         $ su - root
 357         # dpkg --purge lilypond lilypond1.3
 358         # exit
 359         $ tar xzf lilypond-1.3.122.tar.gz
 360         $ cd lilypond-1.3.122
 361         $ dch -p -v 1.3.122-0.local.1 "Local build."
 362         $ debuild
 363         $ su - root
 364         # dpkg -i ../lilypond1.3_1.3.122*.deb
 365         # exit
 366         $
 367 @end example
 368
 369 For compilation on a Debian GNU/Linux system you need these packages,
 370 in addition to the those needed for running:
 371
 372 @itemize @bullet
 373 @item g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
 374 @item libguile<your-libguile-version-here>-dev
 375 @item make, m4, flex, bison
 376 @item gettext
 377 @item groff, texinfo, bibtex2html (not in 2.2r2)
 378 @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
 379 @item dpkg-dev, debhelper, fakeroot
 380 @item gs, netpbm, pnmtopng
 381 @end itemize
 382
 383 Most of these are listed on the Build-Depends line in the
 384 debian/control file.  To ensure the creation of the lilypond deb is
 385 trouble-free, we recommend that you first install the following packages
 386 before starting dpkg-buildpackage by running apt-get as root.
 387
 388 For Debian 2.2 (or 2.2r2, 2.2r3):
 389
 390 @example
 391         apt-get install task-debian-devel task-c++-dev \
 392                 python-base libguile6-dev tetex-bin tetex-dev \
 393                 tetex-extra flex bison texinfo groff gs \
 394                 netpbm pnmtopng m4 gettext
 395 @end example
 396
 397 For Debian in development ("unstable", the future 2.3 or 3.0):
 398
 399 @example
 400         apt-get install task-debian-devel task-c++-dev \
 401                 python-base libguile9-dev tetex-bin libkpathsea-dev \
 402                 tetex-extra flex bison texinfo bibtex2html groff gs \
 403                 netpbm pnmtopng m4 gettext
 404 @end example
 405
 406 And, just so that old fonts from previous versions of LilyPond won't
 407 interfere with your build, you may want to do this before the build too:
 408
 409 @example
 410         dpkg --purge lilypond lilypond1.3
 411 @end example
 412
 413
 414 @section Windows NT/95
 415
 416 Separate instructions on building for W32 are available; See the files
 417 in @file{Documentation/ntweb/}, included with the sources.
 418
 419 @section Problems
 420
 421 For help and questions use @email{help-gnu-music@@gnu.org} and
 422 @email{gnu-music-discuss@@gnu.org}.  Please consult the faq before
 423 mailing your problems.
 424
 425 If you find bugs, please send bug reports to
 426 @email{bug-gnu-music@@gnu.org}.
 427
 428 Bugs that are LilyPond's fault are listed in our TODO list on the
 429 web, or demonstrated in @file{input/bugs/}.
 430
 431 Bugs that are not LilyPond's fault are documented here.
 432
 433
 434 @unnumbered LinuxPPC Bugs:
 435
 436 @itemize @bullet
 437 @item egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
 438 fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
 439
 440 @item egcs-1.0.2 (LinuxPPC R4):
 441 all compiling with @code{-O2} is suspect, in particular guile-1.3, and
 442 Lily herself will break.
 443 @end itemize
 444
 445
 446
 447 @unnumbered Linux-i386
 448
 449 @itemize @bullet
 450 @item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
 451
 452 Lily will crash during parsing (which suggests a C++ library
 453 incompatibility).  Precise cause, precise platform description or
 454 solution are not known.
 455
 456 Note that this only happens on some computers with the said platform.
 457
 458 @item libg++ 2.7
 459
 460 LilyPond occasionally crashes while parsing the initialisation files.
 461 This is a very obscure bug, and usually entering the commandline
 462 differently "fixes" it.
 463
 464 @example
 465         lilypond input.ly
 466 @end  example
 467
 468 and
 469 @example
 470         lilypond -I. ./input.ly
 471 @end example
 472 makes a difference
 473
 474 Typical stacktrace:
 475 @example
 476         SIGSEGV
 477         __libc_malloc (bytes=16384)
 478         ?? ()
 479         yyFlexLexer::yy_create_buffer ()
 480         Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
 481 @end example
 482
 483 This behaviour has been observed with machines that have old libg++
 484 versions (LinuxPPC feb '98, Red Hat 4.x).
 485 @end itemize
 486
 487
 488
 489
 490 @unnumbered Solaris:
 491
 492 @itemize @bullet
 493 @item Sparc64/Solaris 2.6, GNU make-3.77
 494
 495 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
 496
 497
 498 @item Sparc64/Solaris 2.6, ld
 499
 500 Not yet resolved.
 501 @end itemize
 502
 503
 504 @unnumbered AIX
 505
 506 @itemize @bullet
 507 @item AIX 4.3 ld
 508
 509 The following is from the gcc install/SPECIFIC file.
 510 @quotation
 511    Some versions of the AIX binder (linker) can fail with a relocation
 512    overflow severe error when the -bbigtoc option is used to link
 513    GCC-produced object files into an executable that overflows the TOC.
 514    A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
 515    -BBIGTOC) is available from IBM Customer Support and from its
 516    27service.boulder.ibm.com website as PTF U455193.
 517
 518    Binutils does not support AIX 4.3 (at least through release 2.9). GNU
 519    as and GNU ld will not work properly and one should not configure GCC
 520    to use those GNU utilities. Use the native AIX tools which do
 521    interoperate with GCC.
 522 @end quotation
 523
 524 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
 525 @example
 526     LDFLAGS='-Wl,-bbigtoc' ./configure
 527 @end example
 528
 529 @end itemize
 530
 531
 532 @bye
 533