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