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
  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 @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
 129 newer).
 130 @end itemize
 131
 132 @subsection Building documentation
 133
 134 You can view the documentation online at
 135 @uref{http://lilypond.org/doc/}, but you can also build it locally.
 136 This process requires a successful compile of lilypond.  The
 137 documentation is built by issuing
 138 @quotation
 139 @example
 140 make web
 141 @end example
 142 @end quotation
 143
 144 Building the website requires some additional tools and packages
 145
 146 @itemize @bullet
 147 @item @uref{http://lilypond.org/download/fonts,ec-fonts-mftraced}
 148 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
 149 @item ImageMagick
 150 @item International fonts (see input/regression/utf-8.ly for hints
 151 about which font packages are necessary for your platform)
 152 @end itemize
 153
 154 The HTML files can be installed into the standard documentation path
 155 by issuing
 156
 157 @quotation
 158 @example
 159 make out=www web-install
 160 @end example
 161 @end quotation
 162
 163
 164 @section Building LilyPond
 165
 166 To install GNU LilyPond, type
 167 @quotation
 168 @example
 169 gunzip -c lilypond-x.y.z | tar xf -
 170 cd lilypond-x.y.z
 171 ./configure             # run with --help for applicable options
 172 make
 173 make install
 174 @end example
 175 @end quotation
 176
 177 The most time-consuming part of compiling LilyPond is tracing the
 178 Type1 fonts. You can shortcut this operation by issuing
 179 one of the following commands
 180
 181 @quotation
 182 @example
 183 make -C mf get-pfa                # requires rpm2cpio
 184 make -C mf get-debian-pfa         # may not be up to date
 185 @end example
 186 @end quotation
 187
 188 If you are not root, you should choose a @code{--prefix} argument that
 189 points into your home directory, e.g.
 190 @quotation
 191 @example
 192 ./configure --prefix=$HOME/usr
 193 @end example
 194 @end quotation
 195
 196 @ignore
 197 In this case, you have to insert the contents of
 198 @code{buildscripts/out/lilypond-login} or
 199 @code{buildscripts/out/lilypond-profile} into your start up scripts by
 200 hand.
 201 @end ignore
 202
 203
 204 @subsection Configuring for multiple platforms
 205
 206 If you want to build multiple versions of LilyPond with different
 207 configuration settings, you can use the @code{--enable-config=CONF}
 208 option of configure.  You should use @samp{make conf=CONF} to generate
 209 the output in @file{out-CONF}.  Example: Suppose you want to build
 210 with and without profiling, then use the following for the normal
 211 build
 212
 213 @quotation
 214 @example
 215 ./configure --prefix=$HOME/usr/ --enable-checking
 216 make
 217 make install
 218 @end example
 219 @end quotation
 220
 221 and for the profiling version, specify a different configuration
 222
 223 @quotation
 224 @example
 225 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
 226 make conf=prof
 227 make conf=prof install
 228 @end example
 229 @end quotation
 230
 231
 232 @section Emacs mode
 233
 234 An Emacs mode for entering music and running LilyPond is contained in
 235 the source archive in the @file{elisp} directory.  Do @command{make
 236 install} to install it to @var{elispdir}.  The file @file{lilypond-init.el}
 237 should be placed to @var{load-path}@file{/site-start.d/} or appended
 238 to your @file{~/.emacs} or @file{~/.emacs.el}.
 239
 240 As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
 241 your @var{load-path} by appending the following line (as modified) to your
 242 @file{~/.emacs}
 243 @c any reason we do not advise:  (push "~/site-lisp" load-path)
 244 @quotation
 245 @example
 246 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
 247 @end example
 248 @end quotation
 249
 250
 251 @section Vim mode
 252
 253 A Vim mode for entering music and running LilyPond is contained in the
 254 source archive in @code{$VIM} directory.  For version 6.2 and newer,
 255 Vim-mode works directly after installing LilyPond.  Otherwise,
 256 complete the following two steps.
 257
 258 For earlier versions (and if @code{$VIM} environment variable does not
 259 fall-back to @file{/usr/local/share/vim}, see @code{:version} in vim),
 260 the LilyPond file type is detected if your file @file{~/.vim/filetype.vim} @c
 261 has the following content
 262 @quotation
 263 @example
 264 if exists("did_load_filetypes")
 265   finish
 266 endif
 267 augroup filetypedetect
 268   au! BufNewFile,BufRead *.ly           setf lilypond
 269 augroup END
 270 @end example
 271 @end quotation
 272 If Vim has been (pre-)installed to @file{/usr/...} (or any other place)
 273 instead of @file{/usr/local/...}, then @file{/usr/local/share/vim} may not
 274 be specified in your @code{$VIMRUNTIME} environment variable and you have to
 275 include this path explicitly by appending the following line to your
 276 @file{~/.vimrc}
 277 @quotation
 278 @example
 279 set runtimepath+=/usr/local/share/vim/
 280 @end example
 281 @end quotation
 282
 283 @section Problems
 284
 285 For help and questions use @email{lilypond-user@@gnu.org}.  Send bug
 286 reports to @email{bug-lilypond@@gnu.org}.
 287
 288 Bugs that are not fault of LilyPond are documented here.
 289
 290 @subsection Bison 1.875
 291
 292 There is a bug in bison-1.875: compilation fails with "parse error
 293 before `goto'" in line 4922 due to a bug in bison. To fix, either
 294 recompile bison 1.875 with the following fix
 295
 296 @quotation
 297 @example
 298 $ cd lily; make out/parser.cc
 299 $ vi +4919 out/parser.cc
 300 # append a semicolon to the line containing "__attribute__ ((__unused__))
 301 # save
 302 $ make
 303 @end example
 304 @end quotation
 305
 306 @subsection Linking to kpathsea
 307
 308 If kpathsea and the corresponding header files are installed in some
 309 directory where GCC does not search by default, for example in
 310 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
 311 you have to explicitly tell configure where to find it.  To do this
 312
 313 @itemize
 314 @item @code{rm config.cache}
 315 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
 316 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
 317 @item @code{./configure}
 318 @end itemize
 319 Once configure has found them, the paths are stored in
 320 @file{config.make} and will be used even if you don't have the
 321 environment variables set during make.
 322
 323
 324 @unnumberedsubsec Gcc-3.0.4
 325
 326 Gcc 3.0.4 is flaky; upgrade GCC.
 327
 328 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
 329
 330 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code.  To compile
 331 LilyPond with gcc-3.1.1 or higher you may do
 332
 333 @quotation
 334 @example
 335 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 336 CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
 337 ./configure --enable-config=gcc-3.1
 338 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 339 make conf=gcc-3.1
 340 @end example
 341 @end quotation
 342
 343
 344 @unnumberedsubsec OpenBSD
 345
 346 @itemize @bullet
 347 @item
 348 Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
 349 set include paths for kpathsea.
 350 @end itemize
 351
 352 @unnumberedsubsec NetBSD
 353
 354 @itemize @bullet
 355 @item The flex precompiled in NetBSD-1.4.2 is broken.
 356 Upgrade to flex-2.5.4a.
 357 @end itemize
 358
 359 @unnumberedsubsec  Solaris
 360
 361 @itemize @bullet
 362 @item Solaris7, ./configure
 363
 364 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
 365 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
 366 is.  Run configure like
 367 @quotation
 368 @example
 369         CONFIG_SHELL=/bin/ksh ksh -c ./configure
 370 @end example
 371 @end quotation
 372 or
 373 @quotation
 374 @example
 375         CONFIG_SHELL=/bin/bash bash -c ./configure
 376 @end example
 377 @end quotation
 378
 379 @end itemize
 380
 381 @bye
 382