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