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