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.1.55.tar.gz} from
  25 @file{lilypond-1.1.54} identical (up to compression dates) to the .55 on
  26 the FTP site.
  27 @example
  28   xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.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/gnu/flex/,ftp://ftp.gnu.org/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 Redhat 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 RedHat 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 RedHat). 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 RedHat 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 Redhat linux
 302
 303 RedHat 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 i386 RedHat RPMS are available from
 316 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/}.
 317
 318 For compilation on a RedHat 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; see
 333 @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
 334 or contact Anthony Fok @email{foka@@debian.org} for more information.
 335
 336 The build scripts are in the subdirectory @file{debian/}; you can
 337 make the .deb by doing
 338
 339 @example
 340
 341         tar xzf lilypond-x.y.z.tar.gz
 342         cd lilypond-x.y.z
 343         dpkg-buildpackage
 344         dpkg -i ../lilypond_x.y.z*deb
 345
 346 @end example
 347
 348 For compilation on a Debian GNU/Linux system you need these packages,
 349 in addition to the those needed for running:
 350 @itemize @bullet
 351 @item libc6-dev
 352 @item libstdc++<your-libstdc++-version-here>-dev
 353 @item libguile<your-libguile-version-here>-dev
 354 @item flex
 355 @item bison
 356 @item gettext
 357 @item texinfo
 358 @item tetex-dev
 359 @item debhelper
 360 @end itemize
 361
 362
 363 @section Windows NT/95
 364
 365 Separate instructions on building for W32 are available; See the files
 366 in @file{Documentation/ntweb/}, included with the sources.
 367
 368 @section Problems
 369
 370 For help and questions use @email{help-gnu-music@@gnu.org} and
 371 @email{gnu-music-discuss@@gnu.org}.  Please consult the faq before
 372 mailing your problems.
 373
 374 If you find bugs, please send bug reports to
 375 @email{bug-gnu-music@@gnu.org}.
 376
 377 Bugs that are LilyPond's fault are listed in our TODO list on the
 378 web, or demonstrated in @file{input/bugs/}.
 379
 380 Bugs that are not LilyPond's fault are documented here.
 381
 382
 383 @unnumbered LinuxPPC Bugs:
 384
 385 @itemize @bullet
 386 @item egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
 387 fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
 388
 389 @item egcs-1.0.2 (LinuxPPC R4):
 390 all compiling with @code{-O2} is suspect, in particular guile-1.3, and
 391 Lily herself will break.
 392 @end itemize
 393
 394
 395
 396 @unnumbered Linux-i386
 397
 398 @itemize @bullet
 399 @item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
 400
 401 Lily will crash during parsing (which suggests a C++ library
 402 incompatibility).  Precise cause, precise platform description or
 403 solution are not known.
 404
 405 Note that this only happens on some computers with the said platform.
 406
 407 @item libg++ 2.7
 408
 409 LilyPond occasionally crashes while parsing the initialisation files.
 410 This is a very obscure bug, and usually entering the commandline
 411 differently "fixes" it.
 412
 413 @example
 414         lilypond input.ly
 415 @end  example
 416
 417 and
 418 @example
 419         lilypond -I. ./input.ly
 420 @end example
 421 makes a difference
 422
 423 Typical stacktrace:
 424 @example
 425         SIGSEGV
 426         __libc_malloc (bytes=16384)
 427         ?? ()
 428         yyFlexLexer::yy_create_buffer ()
 429         Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
 430 @end example
 431
 432 This behaviour has been observed with machines that have old libg++
 433 versions (LinuxPPC feb '98, RedHat 4.x).
 434 @end itemize
 435
 436
 437
 438
 439 @unnumbered Solaris:
 440
 441 @itemize @bullet
 442 @item Sparc64/Solaris 2.6, GNU make-3.77
 443
 444 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
 445
 446
 447 @item Sparc64/Solaris 2.6, ld
 448
 449 Not yet resolved.
 450 @end itemize
 451
 452
 453 @unnumbered AIX
 454
 455 @itemize @bullet
 456 @item AIX 4.3 ld
 457
 458 The following is from the gcc install/SPECIFIC file.
 459 @quotation
 460    Some versions of the AIX binder (linker) can fail with a relocation
 461    overflow severe error when the -bbigtoc option is used to link
 462    GCC-produced object files into an executable that overflows the TOC. A
 463    fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
 464    -BBIGTOC) is available from IBM Customer Support and from its
 465    27service.boulder.ibm.com website as PTF U455193.
 466
 467    Binutils does not support AIX 4.3 (at least through release 2.9). GNU
 468    as and GNU ld will not work properly and one should not configure GCC
 469    to use those GNU utilities. Use the native AIX tools which do
 470    interoperate with GCC.
 471 @end quotation
 472
 473 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
 474 @example
 475     LDFLAGS='-Wl,-bbigtoc' ./configure
 476 @end example
 477
 478 @end itemize
 479
 480
 481 @bye
 482