Documentation/topdocs/INSTALL.texi

   1 @node Top, , , (dir)
   2 @top
   3 @comment  node-name,  next,  previous,  up\input texinfo @c -*-texinfo-*-
   4 @setfilename INSTALL.info
   5 @settitle INSTALL - compiling and installing GNU LilyPond
   6
   7 @contents
   8
   9 @chapter Compiling and installing on Unix
  10
  11
  12 @html
  13 <a name="download-source">
  14 @end html
  15
  16 @section Downloading
  17
  18 Even numbered versions are `stable' (2.0, 1.8 etc), while odd version
  19 are development releases (2.1, 1.9, etc).  Building LilyPond is an
  20 involved process, so if possible, download a precompiled binary from
  21 @uref{http://www.lilypond.org/,the lilypond site}.
  22
  23
  24 @subsection Source code
  25
  26 Download source tarballs from here:
  27 @itemize @bullet
  28 @item Download development releases from
  29 @uref{http://www.lilypond.org/download/} by HTTP.
  30 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
  31 @end itemize
  32
  33
  34 Use Xdelta to patch tarballs, e.g. to patch
  35 @file{lilypond-1.4.2.tar.gz} to @file{lilypond-1.4.3.tar.gz}, do
  36 @example
  37         xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
  38 @end example
  39
  40 For information on packaging and CVS, see
  41 @uref{http://lilypond.org/}, under ``development''.
  42
  43
  44 @subsection Precompiled binaries
  45
  46 Check out @uref{http://lilypond.org} for up to date information on
  47 binary packages.
  48
  49
  50 @subsection Font problems
  51
  52 If you are upgrading from a previous version of LilyPond, be sure to
  53 remove all old font files. These include @file{.pk} and @file{.tfm} files
  54 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
  55 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}.  A
  56 script automating this has been included, see
  57 @file{buildscripts/clean-fonts.sh}.
  58
  59
  60
  61
  62 @section Requirements
  63
  64 @subsection Compilation
  65
  66 You need the following packages to compile LilyPond:
  67
  68 @itemize
  69
  70 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
  71 newer),
  72
  73   You will need to install some additional packages to get mftrace to
  74 work.
  75
  76 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
  77
  78 @item  @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
  79
  80 WARNING: plain Flex 2.5.4(a) generates invalid C++ code.  GCC 3.x
  81 chokes on this.  If you wish to use GCC 3.x, make sure that your
  82 distribution supports g++ 3.x and flex.  For workarounds, see
  83 lexer-gcc-3.1.sh in the source directory.
  84
  85 @item @TeX{}.
  86
  87 @TeX{} is used as an output backend.
  88
  89 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
  90 @file{.afm}, @file{.tfm}).  Make sure you have tetex 1.0 or newer
  91 (1.0.6 is known to work).  You may need to install a tetex-devel (or
  92 tetex-dev or libkpathsea-dev) package too.
  93
  94 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.6 or newer).
  95
  96 @item The
  97 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
  98 package for LaTeX}.
  99
 100  This package is normally included with the @TeX{} distribution.
 101
 102 @item kpathsea, a library for searching (@TeX{}) files.
 103
 104 @item
 105  @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.1 or
 106 newer).  EGCS and 2.x are known to cause crashes.
 107
 108 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
 109
 110 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
 111
 112 @item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
 113 newer, but not 1.50 or 1.75).
 114 @end itemize
 115
 116 @subsection Running requirements
 117
 118 GNU LilyPond does use a lot of resources. For operation you need the
 119 following software:
 120
 121 @itemize @bullet
 122 @item @TeX{}.
 123 @item Xdvi and Ghostscript.
 124 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
 125 @end itemize
 126
 127 You have to help @TeX{} and MetaFont find LilyPond support
 128 files. After compiling, scripts to do this can be found in
 129 @file{buildscripts/out/lilypond-profile} and
 130 @file{buildscripts/out/lilypond-login}.
 131
 132 @subsection Building documentation
 133
 134 You can view the documentation online at
 135 @uref{http://www.lilypond.org/doc/}, but you can also build it
 136 locally. This process requires a successful compile of lilypond. The
 137 documentation is built by issuing:
 138 @example
 139         make web
 140 @end example
 141
 142 Building the website requires some additional tools:
 143
 144 @itemize @bullet
 145 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
 146 @item ImageMagick
 147 @end itemize
 148
 149 The HTML files can be installed into the standard documentation path
 150 by issuing
 151
 152 @example
 153         make out=www web-install
 154 @end example
 155
 156
 157 @section Building LilyPond
 158
 159 To install GNU LilyPond, type
 160 @example
 161 gunzip -c lilypond-x.y.z | tar xf -
 162 cd lilypond-x.y.z
 163 ./configure             # run with --help to see appropriate options
 164 make
 165 make install
 166 sh buildscripts/clean-fonts.sh
 167 @end example
 168
 169 The most time-consuming part of compiling LilyPond is tracing the
 170 Type1 fonts. You can shortcut this operation by issuing
 171 one of the following commands:
 172
 173 @example
 174   make -C mf get-pfa                # requires rpm2cpio
 175   make -C mf get-debian-pfa         # may not be up to date
 176 @end example
 177
 178 If you are doing an upgrade, you should remove all @file{feta}
 179 @code{.pk} and @code{.tfm} files.  A script has been provided to do the
 180 work for you, see @file{buildscripts/clean-fonts.sh}.
 181
 182 If you are not root, you should choose a @code{--prefix} argument that
 183 points into your home directory, e.g.:
 184 @example
 185         ./configure --prefix=$HOME/usr
 186 @end example
 187
 188 In this case, you have to insert the contents of
 189 @code{buildscripts/out/lilypond-login} or
 190 @code{buildscripts/out/lilypond-profile} into your start up scripts by
 191 hand.
 192
 193
 194
 195 @subsection Configuring for multiple platforms
 196
 197 If you want to build multiple versions of LilyPond with different
 198 configuration settings, you can use the @code{--enable-config=CONF}
 199 option of configure.  You should use @samp{make conf=CONF} to generate
 200 the output in @file{out-CONF}.  Example: Suppose I want to build with
 201 and without profiling.  Then I'd use the following for the normal
 202 build:
 203
 204 @example
 205         ./configure --prefix=$HOME/usr/ --enable-checking
 206         make
 207         make install
 208 @end example
 209
 210 and for the profiling version, I specify a different configuration:
 211
 212 @example
 213         ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
 214         make conf=prof
 215         make conf=prof install
 216 @end example
 217
 218
 219
 220 @section Emacs mode
 221
 222 An Emacs mode for entering music and running LilyPond is contained in
 223 the source archive in the @file{elisp} directory.  @command{make
 224 install} installs it @var{elispdir}.  The file @file{lilypond-init.el}
 225 should be placed to @var{load-path}@file{/site-start.d/} or appended
 226 to your @file{~/.emacs} or @file{~/.emacs.el}.
 227
 228 As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
 229 to your @var{load-path}. Append the following line (modified) to your
 230 @file{~/.emacs}:
 231 @c any reason we do not advise:  (push "~/site-lisp" load-path)
 232 @quotation
 233 @example
 234 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
 235 @end example
 236 @end quotation
 237
 238
 239 @section Vim mode
 240
 241 @c lilypond.words.el for vim auto-completion?
 242 A Vim mode for entering music and running LilyPond is contained in
 243 the source archive. Copy recursively the file structure in @file{vim/} as
 244 your @file{~/.vim/} to get shortcuts. Install (generated) files
 245 @file{lilypond.words.el} and @file{lilypond.words.vim} to
 246 @file{~/.vim/syntax/} in order to get auto-completion and syntax
 247 highlighting.
 248
 249
 250 @section Problems
 251
 252 For help and questions use @email{lilypond-user@@gnu.org}.  Send bug
 253 reports to @email{bug-lilypond@@gnu.org}.
 254
 255 Bugs that are not fault of LilyPond are documented here.
 256
 257 @subsection Bison 1.875
 258
 259 There is a bug in bison-1.875: compilation fails with "parse error
 260 before `goto'" in line 4922 due to a bug in bison. To fix, either
 261 recompile bison 1.875 with the following fix:
 262
 263 @example
 264    $ cd lily; make out/parser.cc
 265    $ vi +4919 out/parser.cc
 266    # append a semicolon to the line containing "__attribute__ ((__unused__))
 267    # save
 268    $ make
 269 @end example
 270
 271 @subsection Linking to kpathsea
 272
 273 If kpathsea and the corresponding header files are installed in some
 274 directory where GCC does not search by default, for example in
 275 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
 276 you have to explicitly tell configure where to find it. To do this:
 277
 278 @itemize
 279 @item @code{rm config.cache}
 280 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
 281 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
 282 @item @code{./configure}
 283 @end itemize
 284 Once configure has found them, the paths are stored in
 285 @file{config.make} and will be used even if you don't have the
 286 environment variables set during make.
 287
 288
 289 @unnumberedsubsec Gcc-3.0.4
 290
 291 Gcc 3.0.4 is flaky;  upgrade GCC.
 292
 293 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
 294
 295 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code.  To compile
 296 LilyPond with gcc-3.1.1 you may do
 297
 298 @example
 299         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 300         CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
 301             ./configure --enable-config=gcc-3.1
 302         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 303         make conf=gcc-3.1
 304 @end example
 305
 306
 307 @unnumberedsubsec OpenBSD
 308
 309 @itemize @bullet
 310 @item
 311  Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
 312 set include paths for kpathsea.
 313 @end itemize
 314
 315 @unnumberedsubsec NetBSD
 316
 317 @itemize @bullet
 318 @item The flex precompiled in NetBSD-1.4.2 is broken.
 319 Upgrade to flex-2.5.4a.
 320 @end itemize
 321
 322 @unnumberedsubsec  Solaris
 323
 324 @itemize @bullet
 325 @item Solaris7, ./configure
 326
 327 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
 328 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
 329 is.   Run configure like:
 330 @example
 331         CONFIG_SHELL=/bin/ksh ksh -c ./configure
 332 @end example
 333 or:
 334 @example
 335         CONFIG_SHELL=/bin/bash bash -c ./configure
 336 @end example
 337
 338 @end itemize
 339
 340 @bye
 341