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