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