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/clean-fonts.sh}.
  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 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 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} (version 1.6.0 or newer).
  79 If you are installing a binary packages, you may need to install
  80 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 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 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.7 or newer).
  99
 100 @item The
 101 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
 102 package for LaTeX}.
 103
 104  This package is normally included with the @TeX{} distribution.
 105
 106 @item kpathsea, a library for searching (@TeX{}) files.
 107
 108 @item
 109  @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.1 or
 110 newer).  EGCS and 2.x are known to cause crashes.
 111
 112 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
 113
 114 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
 115
 116 @item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
 117 newer, but not 1.50 or 1.75).
 118
 119 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
 120 @end itemize
 121
 122 @subsection Running requirements
 123
 124 GNU LilyPond does use a lot of resources. For operation you need the
 125 following software:
 126
 127 @itemize @bullet
 128 @item @uref{http://lilypond.org/download/fonts,ec-fonts-mftraced}
 129 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
 130 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
 131 @item @TeX{}.
 132 @item Xdvi and Ghostscript.
 133 @end itemize
 134
 135 You have to help @TeX{} and MetaFont find LilyPond support
 136 files. After compiling, scripts to do this can be found in
 137 @file{buildscripts/out/lilypond-profile} and
 138 @file{buildscripts/out/lilypond-login}.
 139
 140 @subsection Building documentation
 141
 142 You can view the documentation online at
 143 @uref{http://lilypond.org/doc/}, but you can also build it
 144 locally. This process requires a successful compile of lilypond. The
 145 documentation is built by issuing:
 146 @example
 147         make web
 148 @end example
 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 @example
 162         make out=www web-install
 163 @end example
 164
 165
 166 @section Building LilyPond
 167
 168 To install GNU LilyPond, type
 169 @example
 170 gunzip -c lilypond-x.y.z | tar xf -
 171 cd lilypond-x.y.z
 172 ./configure             # run with --help to see appropriate options
 173 make
 174 make install
 175 sh buildscripts/clean-fonts.sh
 176 @end example
 177
 178 The most time-consuming part of compiling LilyPond is tracing the
 179 Type1 fonts. You can shortcut this operation by issuing
 180 one of the following commands:
 181
 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
 187 If you are doing an upgrade, you should remove all @file{feta}
 188 @code{.pk} and @code{.tfm} files.  A script has been provided to do the
 189 work for you, see @file{buildscripts/clean-fonts.sh}.
 190
 191 If you are not root, you should choose a @code{--prefix} argument that
 192 points into your home directory, e.g.:
 193 @example
 194         ./configure --prefix=$HOME/usr
 195 @end example
 196
 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
 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 I want to build with
 210 and without profiling.  Then I'd use the following for the normal
 211 build:
 212
 213 @example
 214         ./configure --prefix=$HOME/usr/ --enable-checking
 215         make
 216         make install
 217 @end example
 218
 219 and for the profiling version, I specify a different configuration:
 220
 221 @example
 222         ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
 223         make conf=prof
 224         make conf=prof install
 225 @end example
 226
 227
 228
 229 @section Emacs mode
 230
 231 An Emacs mode for entering music and running LilyPond is contained in
 232 the source archive in the @file{elisp} directory.  Do @command{make
 233 install} to install it to @var{elispdir}.  The file @file{lilypond-init.el}
 234 should be placed to @var{load-path}@file{/site-start.d/} or appended
 235 to your @file{~/.emacs} or @file{~/.emacs.el}.
 236
 237 As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
 238 your @var{load-path} by appending the following line (as modified) to your
 239 @file{~/.emacs}:
 240 @c any reason we do not advise:  (push "~/site-lisp" load-path)
 241 @quotation
 242 @example
 243 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
 244 @end example
 245 @end quotation
 246
 247
 248 @section Vim mode
 249
 250 A Vim mode for entering music and running LilyPond is contained in the
 251 source archive in @code{$VIM} directory.  For version 6.2 and newer,
 252 Vim-mode works directly after installing LilyPond.  Otherwise,
 253 complete the following two steps.
 254
 255 For earlier versions (and if @code{$VIM} environment variable does not
 256 fall-back to @file{/usr/local/share/vim}, see @code{:version} in vim),
 257 the LilyPond file type is detected if your file @file{~/.vim/filetype.vim} @c
 258 has the following content:
 259 @example
 260         if exists("did_load_filetypes")
 261           finish
 262         endif
 263         augroup filetypedetect
 264           au! BufNewFile,BufRead *.ly           setf lilypond
 265         augroup END
 266 @end example
 267 If Vim has been (pre-)installed to @file{/usr/...} (or any other place)
 268 instead of @file{/usr/local/...}, then @file{/usr/local/share/vim} may not
 269 be specified in your @code{$VIMRUNTIME} environment variable and you have to
 270 include this path explicitly by appending the following line to your
 271 @file{~/.vimrc}:
 272 @example
 273         set runtimepath+=/usr/local/share/vim/
 274 @end example
 275
 276 @section Problems
 277
 278 For help and questions use @email{lilypond-user@@gnu.org}.  Send bug
 279 reports to @email{bug-lilypond@@gnu.org}.
 280
 281 Bugs that are not fault of LilyPond are documented here.
 282
 283 @subsection Bison 1.875
 284
 285 There is a bug in bison-1.875: compilation fails with "parse error
 286 before `goto'" in line 4922 due to a bug in bison. To fix, either
 287 recompile bison 1.875 with the following fix:
 288
 289 @example
 290    $ cd lily; make out/parser.cc
 291    $ vi +4919 out/parser.cc
 292    # append a semicolon to the line containing "__attribute__ ((__unused__))
 293    # save
 294    $ make
 295 @end example
 296
 297 @subsection Linking to kpathsea
 298
 299 If kpathsea and the corresponding header files are installed in some
 300 directory where GCC does not search by default, for example in
 301 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
 302 you have to explicitly tell configure where to find it. To do this:
 303
 304 @itemize
 305 @item @code{rm config.cache}
 306 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
 307 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
 308 @item @code{./configure}
 309 @end itemize
 310 Once configure has found them, the paths are stored in
 311 @file{config.make} and will be used even if you don't have the
 312 environment variables set during make.
 313
 314
 315 @unnumberedsubsec Gcc-3.0.4
 316
 317 Gcc 3.0.4 is flaky;  upgrade GCC.
 318
 319 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
 320
 321 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code.  To compile
 322 LilyPond with gcc-3.1.1 you may do
 323
 324 @example
 325         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 326         CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
 327             ./configure --enable-config=gcc-3.1
 328         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 329         make conf=gcc-3.1
 330 @end example
 331
 332
 333 @unnumberedsubsec OpenBSD
 334
 335 @itemize @bullet
 336 @item
 337  Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
 338 set include paths for kpathsea.
 339 @end itemize
 340
 341 @unnumberedsubsec NetBSD
 342
 343 @itemize @bullet
 344 @item The flex precompiled in NetBSD-1.4.2 is broken.
 345 Upgrade to flex-2.5.4a.
 346 @end itemize
 347
 348 @unnumberedsubsec  Solaris
 349
 350 @itemize @bullet
 351 @item Solaris7, ./configure
 352
 353 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
 354 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
 355 is.   Run configure like:
 356 @example
 357         CONFIG_SHELL=/bin/ksh ksh -c ./configure
 358 @end example
 359 or:
 360 @example
 361         CONFIG_SHELL=/bin/bash bash -c ./configure
 362 @end example
 363
 364 @end itemize
 365
 366 @bye
 367