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 fully functioning
 123
 124    If you want to auto-generate Lily's website, you'll need some
 125 additional conversion tools.
 126
 127    * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
 128       users: it is included within the package libgr-progs).
 129      the original is at
 130      ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
 131      (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
 132
 133    * pnmtopng, which is also in libgr-progs for RedHat. The original is
 134      at
 135      ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
 136      (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
 137
 138      The version of `pnmtopng' that is distributed with RedHat 5.1 and
 139      5.2 contains a bug: pnmtopng is dynamically linked to the wrong
 140      version of libpng, which results in cropped images.  Recompile it
 141      from source, and make sure that the pnmtopng binary is linked
 142      statically to the libpng that is included in libgr.  RedHat 6.0
 143      does not have this problem.
 144
 145            tar xzf libgr-2.0.13.tar.gz
 146                 make
 147                 cd png
 148                 rm libpng.so*
 149                 make pnmtopng
 150
 151      You can then install the new pnmtopng into `/usr/local/bin/'
 152
 153    * Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
 154      (http://pertsserver.cs.uiuc.edu/~hull/bib2html.)      Which, in
 155      turn depends on man2html for proper installation.  man2html can be
 156      had from
 157      http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
 158      (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
 159
 160      The website will build without this utility, but you will not see
 161      our hypertextified bibliography.
 162
 163    * Doc++ (optional) to read the source code.
 164
 165
 166 Configuring and compiling
 167 =========================
 168
 169    to install GNU LilyPond, simply type:
 170
 171         gunzip -c lilypond-x.y.z | tar xf -
 172         cd lilypond-x.y.z
 173         ./configure             # fill in your standard prefix with --prefix
 174         make
 175         make install
 176
 177    This will install a number of files, something close to:
 178
 179         /usr/local/man/man1/mi2mu.1
 180         /usr/local/man/man1/convert-mudela.1
 181         /usr/local/man/man1/mudela-book.1
 182         /usr/local/man/man1/lilypond.1
 183         /usr/local/bin/lilypond
 184         /usr/local/bin/mi2mu
 185         /usr/local/bin/convert-mudela
 186         /usr/local/bin/mudela-book
 187         /usr/local/bin/abc2ly
 188         /usr/local/share/lilypond/*
 189         /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
 190
 191    The above assumes that you are root and have the GNU development
 192 tools, and your make is GNU make.  If this is not the case, you can
 193 adjust your environment variables to your taste:
 194
 195
 196         export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 197         ./configure
 198
 199    `CPPFLAGS' are the preprocessor flags.
 200
 201    The configure script is Cygnus configure, and it will accept
 202 `--help'. If you are not root, you will probably have to make it with a
 203 different `--prefix' option.  Our favourite location is
 204
 205
 206         ./configure --prefix=$HOME/usr
 207
 208    In this case, you will have to set up MFINPUTS, and TEXINPUTS
 209 accordingly.
 210
 211    Since GNU LilyPond currently is beta, you are advised to also use
 212
 213
 214         --enable-debugging
 215         --enable-checking
 216
 217    Options to configure include:
 218
 219 ``--enable-printing''
 220      Enable debugging print routines (lilypond `-D' option)
 221
 222 ``--enable-optimise''
 223      Set maximum optimisation: compile with `-O2'.  This can be
 224      unreliable on some compiler/platform combinations (eg, DEC Alpha
 225      and PPC)
 226
 227 ``--enable-profiling''
 228      Compile with support for profiling.
 229
 230 ``--enable-config''
 231      Output to a different configuration file.  Needed for
 232      multi-platform     builds
 233
 234    All options are documented in the `configure' help The option
 235 `--enable-optimise' is recommended for Real Life usage.
 236
 237    If you do
 238
 239
 240         make all
 241
 242    everything will be compiled, but nothing will be installed.  The
 243 resulting binaries can be found in the subdirectories `out/' (which
 244 contain all files generated during compilation).
 245
 246 Configuring for multiple platforms
 247 ==================================
 248
 249    If you want to compile LilyPond with different configuration
 250 settings, then, you can use the `--enable-config' option.  Example:
 251 suppose I want to build with and   without profiling.  Then I'd use the
 252 following for the normal build,
 253
 254
 255            ./configure --prefix=~ --disable-optimise --enable-checking
 256            make
 257            make install
 258
 259    and for the profiling version, I specify a different configuration.
 260
 261
 262            ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
 263            make config=optprof
 264            make config=optprof install
 265
 266 Installing
 267 ==========
 268
 269    if you have done a successful `make', then a simple
 270
 271
 272         make install
 273
 274    should do the trick.
 275
 276    If you are doing an upgrade, please remember to remove obsolete
 277 `.pk' and `.tfm' files of the fonts.  A script has been provided to do
 278 the work for you, see `bin/clean-fonts.sh'.
 279
 280 Redhat linux
 281 ============
 282
 283    RedHat Linux users can compile an RPM. A spec file is in
 284 `make/out/lilypond.spec', it is distributed along with the sources.
 285
 286    You can make the rpm by issuing
 287
 288         rpm -tb lilypond-x.y.z.tar.gz
 289         rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
 290
 291    Precompiled i386 RedHat RPMS are available from
 292 ftp://freshmeat.net/pub/rpms/lilypond/
 293 (ftp://freshmeat.net/pub/rpms/lilypond/) and
 294 http://linux.umbc.edu/software/lilypond/rpms/
 295 (http://linux.umbc.edu/software/lilypond/rpms/).
 296
 297    For compilation on a RedHat system you need these packages, in
 298 addition to the those needed for running:
 299    * glibc-devel
 300
 301    * libstdc++-devel
 302
 303    * guile-devel
 304
 305    * flex
 306
 307    * bison
 308
 309    * texinfo
 310
 311 Debian GNU/linux
 312 ================
 313
 314    A Debian package is also available; contact Anthony Fok
 315 <foka@debian.org>.  The build scripts are in the subdirectory `debian/'.
 316
 317 Windows NT/95
 318 =============
 319
 320    Separate instructions on building for W32 are available; See the
 321 files in `Documentation/ntweb/', included with the sources.
 322
 323 Problems
 324 ========
 325
 326    For help and questions use <help-gnu-music@gnu.org> and
 327 <gnu-music-discuss@gnu.org>.  Please consult the faq before mailing
 328 your problems.
 329
 330    If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
 331
 332    Known bugs that are LilyPond's fault are listed in `TODO', or
 333 demonstrated in `input/bugs/'.
 334
 335    Known bugs that are not LilyPond's fault are documented here.
 336
 337 LinuxPPC Bugs:
 338 **************
 339
 340    * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
 341      fixed in egcs-1.1.2-12f or gcc-2.95-0a,
 342      `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
 343
 344    * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
 345      particular guile-1.3, and Lily herself will break.
 346
 347 Linux-i386
 348 **********
 349
 350    * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
 351
 352      Lily will crash during parsing (which suggests a C++ library
 353      incompatibility).  Precise cause, precise platform description or
 354      solution are not known.
 355
 356      Note that this only happens on some computers with the said
 357      platform.
 358
 359    * libg++ 2.7
 360
 361      LilyPond occasionally crashes while parsing the initialisation
 362      files.  This is a very obscure bug, and usually entering the
 363      commandline differently "fixes" it.
 364
 365                 lilypond input.ly
 366
 367      and
 368                 lilypond -I. ./input.ly
 369      makes a difference
 370
 371      Typical stacktrace:
 372                 SIGSEGV
 373                 __libc_malloc (bytes=16384)
 374                 ?? ()
 375                 yyFlexLexer::yy_create_buffer ()
 376                 Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
 377
 378      This behaviour has been observed with machines that have old libg++
 379      versions (LinuxPPC feb '98, RedHat 4.x).
 380
 381 Solaris:
 382 ********
 383
 384    * Sparc64/Solaris 2.6, GNU make-3.77
 385
 386      GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
 387      newer.
 388
 389    * Sparc64/Solaris 2.6, ld
 390
 391      Not yet resolved.
 392
 393 AIX
 394 ***
 395
 396    * AIX 4.3 ld
 397
 398      The following is from the gcc install/SPECIFIC file.
 399              Some versions of the AIX binder (linker) can fail with a
 400           relocation    overflow severe error when the -bbigtoc option
 401           is used to link    GCC-produced object files into an
 402           executable that overflows the TOC. A    fix for APAR IX75823
 403           (OVERFLOW DURING LINK WHEN USING GCC AND    -BBIGTOC) is
 404           available from IBM Customer Support and from its
 405           27service.boulder.ibm.com website as PTF U455193.
 406
 407           Binutils does not support AIX 4.3 (at least through release
 408           2.9). GNU    as and GNU ld will not work properly and one
 409           should not configure GCC    to use those GNU utilities. Use
 410           the native AIX tools which do    interoperate with GCC.
 411
 412      add -Wl,-bbigtoc to USER_LDFLAGS, ie:
 413               LDFLAGS='-Wl,-bbigtoc' ./configure
 414
 415