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