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 @contents
   8
   9 @chapter Compiling and installing on Unix
  10
  11
  12 @html
  13 <a name="download-source">
  14 @end html
  15
  16 @section Downloading
  17
  18 Even numbered versions are `stable' (2.0, 1.8 etc), while odd version
  19 are development releases (1.9, 1.7 etc).  Building LilyPond is an
  20 involved process, so if possible, download a precompiled binary from
  21 @uref{http://www.lilypond.org/,the lilypond site}.
  22
  23
  24 @subsection Source code
  25
  26 Download source tarballs from here:
  27 @itemize @bullet
  28 @item Download development releases from
  29 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
  30 @uref{http://www.lilypond.org/ftp/} by HTTP.
  31 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
  32 @end itemize
  33
  34
  35 Use Xdelta to patch tarballs, e.g. to patch
  36 @file{lilypond-1.4.2.tar.gz} to @file{lilypond-1.4.3.tar.gz}, do
  37 @example
  38         xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
  39 @end example
  40
  41 For information on packaging and CVS, see
  42 @uref{http://lilypond.org/}, under ``development''.
  43
  44
  45 @subsection Precompiled binaries
  46
  47 Check out @uref{http://lilypond.org} for up to date information on
  48 binary packages.
  49
  50
  51 @subsection Font problems
  52
  53 If you are upgrading from a previous version of LilyPond, be sure to
  54 remove all old font files. These include @file{.pk} and @file{.tfm} files
  55 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
  56 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}.  A
  57 script automating this has been included, see
  58 @file{buildscripts/clean-fonts.sh}.
  59
  60
  61
  62
  63 @section Requirements
  64
  65 @subsection Compilation
  66
  67 You need the following packages to compile LilyPond:
  68
  69 @itemize
  70
  71 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
  72 newer),
  73
  74   You will need to install some additional packages to get mftrace to
  75 work.
  76
  77 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
  78
  79 @item  @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
  80
  81 WARNING: plain Flex 2.5.4(a) generates invalid C++ code.  GCC 3.x
  82 chokes on this.  If you wish to use GCC 3.x, make sure that your
  83 distribution supports g++ 3.x and flex.  For workarounds, see
  84 lexer-gcc-3.1.sh in the source directory.
  85
  86 @item @TeX{}.
  87
  88 @TeX{} is used as an output backend.
  89
  90 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
  91 @file{.afm}, @file{.tfm}).  Make sure you have tetex 1.0 or newer
  92 (1.0.6 is known to work).  You may need to install a tetex-devel (or
  93 tetex-dev or libkpathsea-dev) package too.
  94
  95 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.6 or newer).
  96
  97 @item The
  98 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
  99 package for LaTeX}.
 100
 101  This package is normally included with the @TeX{} distribution.
 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.25 or
 114 newer, but not 1.50 or 1.75).
 115 @end itemize
 116
 117 @subsection Running requirements
 118
 119 GNU LilyPond does use a lot of resources. For operation you need the
 120 following software:
 121
 122 @itemize @bullet
 123 @item @TeX{}.
 124 @item Xdvi and Ghostscript.
 125 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
 126 @end itemize
 127
 128 You have to help @TeX{} and MetaFont find LilyPond support
 129 files. After compiling, scripts to do this can be found in
 130 @file{buildscripts/out/lilypond-profile} and
 131 @file{buildscripts/out/lilypond-login}.
 132
 133 @subsection Building documentation
 134
 135 You can view the documentation online at
 136 @uref{http://www.lilypond.org/doc/}, but you can also build it
 137 locally. This process requires a successful compile of lilypond. The
 138 documentation is built by issuing:
 139 @example
 140         make web
 141 @end example
 142
 143 Building the website requires some additional tools:
 144
 145 @itemize @bullet
 146 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
 147 @item ImageMagick
 148 @end itemize
 149
 150 The HTML files can be installed into the standard documentation path
 151 by issuing
 152
 153 @example
 154         make out=www web-install
 155 @end example
 156
 157
 158 @section Building LilyPond
 159
 160 To install GNU LilyPond, type
 161 @example
 162 gunzip -c lilypond-x.y.z | tar xf -
 163 cd lilypond-x.y.z
 164 ./configure             # run with --help to see appropriate options
 165 make
 166 make install
 167 sh buildscripts/clean-fonts.sh
 168 @end example
 169
 170 The most time-consuming part of compiling LilyPond is tracing the
 171 Type1 fonts. You can shortcut this operation by issuing
 172 one of the following commands:
 173
 174 @example
 175   make -C mf get-pfa                # requires rpm2cpio
 176   make -C mf get-debian-pfa         # may not be up to date
 177 @end example
 178
 179 If you are doing an upgrade, you should remove all @file{feta}
 180 @code{.pk} and @code{.tfm} files.  A script has been provided to do the
 181 work for you, see @file{buildscripts/clean-fonts.sh}.
 182
 183 If you are not root, you should choose a @code{--prefix} argument that
 184 points into your home directory, e.g.:
 185 @example
 186         ./configure --prefix=$HOME/usr
 187 @end example
 188
 189 In this case, you have to insert the contents of
 190 @code{buildscripts/out/lilypond-login} or
 191 @code{buildscripts/out/lilypond-profile} into your start up scripts by
 192 hand.
 193
 194
 195
 196 @subsection Configuring for multiple platforms
 197
 198 If you want to build multiple versions of LilyPond with different
 199 configuration settings, you can use the @code{--enable-config=CONF}
 200 option of configure.  You should use @samp{make conf=CONF} to generate
 201 the output in @file{out-CONF}.  Example: Suppose I want to build with
 202 and without profiling.  Then I'd use the following for the normal
 203 build:
 204
 205 @example
 206         ./configure --prefix=$HOME/usr/ --enable-checking
 207         make
 208         make install
 209 @end example
 210
 211 and for the profiling version, I specify a different configuration:
 212
 213 @example
 214         ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
 215         make conf=prof
 216         make conf=prof install
 217 @end example
 218
 219
 220
 221 @section Emacs mode
 222
 223 An Emacs mode for entering music and running LilyPond is contained in
 224 the source archive in the @file{elisp} directory.  @command{make
 225 install} installs it @var{elispdir}.  The file @file{lilypond-init.el}
 226 should be placed to @var{load-path}@file{/site-start.d/} or appended
 227 to your @file{~/.emacs} or @file{~/.emacs.el}.
 228
 229 As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
 230 to your @var{load-path}. Append the following line (modified) to your
 231 @file{~/.emacs}:
 232 @c any reason we do not advise:  (push "~/site-lisp" load-path)
 233 @quotation
 234 @example
 235 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
 236 @end example
 237 @end quotation
 238
 239
 240 @section Vim mode
 241
 242 @c lilypond.words.el for vim auto-completion?
 243 A Vim mode for entering music and running LilyPond is contained in
 244 the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
 245 to get shortcuts. Install file @file{lilypond.words.el} to @file{~/.vim/} to
 246 get auto-completion. Syntax highlighting you get by installing files
 247 @file{lilypond.vim} and @file{lilypond.words.vim} to @file{~/.vim/syntax/}
 248 and appending the following to @file{~/.vim/filetype.vim}:
 249 @quotation
 250 @example
 251         " my filetype file
 252         if exists("did_load_filetypes")
 253           finish
 254         endif
 255         augroup filetypedetect
 256           au! BufRead,BufNewFile  *.ly          setfiletype lilypond
 257         augroup
 258 @end example
 259 @end quotation
 260
 261
 262
 263 @section Problems
 264
 265 For help and questions use @email{lilypond-user@@gnu.org}.  Send bug
 266 reports to @email{bug-lilypond@@gnu.org}.
 267
 268 Bugs that are not fault of LilyPond are documented here.
 269
 270 @subsection Linking to kpathsea
 271
 272 If kpathsea and the corresponding header files are installed in some
 273 directory where GCC does not search by default, for example in
 274 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
 275 you have to explicitly tell configure where to find it. To do this:
 276
 277 @itemize
 278 @item @code{rm config.cache}
 279 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
 280 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
 281 @item @code{./configure}
 282 @end itemize
 283 Once configure has found them, the paths are stored in
 284 @file{config.make} and will be used even if you don't have the
 285 environment variables set during make.
 286
 287
 288 @unnumberedsubsec Gcc-3.0.4
 289
 290 Gcc 3.0.4 is flaky;  upgrade GCC.
 291
 292 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
 293
 294 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code.  To compile
 295 LilyPond with gcc-3.1.1 you may do
 296
 297 @example
 298         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 299         CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
 300             ./configure --enable-config=gcc-3.1
 301         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 302         make conf=gcc-3.1
 303 @end example
 304
 305
 306 @unnumberedsubsec OpenBSD
 307
 308 @itemize @bullet
 309 @item
 310  Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
 311 set include paths for kpathsea.
 312 @end itemize
 313
 314 @unnumberedsubsec NetBSD
 315
 316 @itemize @bullet
 317 @item The flex precompiled in NetBSD-1.4.2 is broken.
 318 Upgrade to flex-2.5.4a.
 319 @end itemize
 320
 321 @unnumberedsubsec  Solaris
 322
 323 @itemize @bullet
 324 @item Solaris7, ./configure
 325
 326 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
 327 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
 328 is.   Run configure like:
 329 @example
 330         CONFIG_SHELL=/bin/ksh ksh -c ./configure
 331 @end example
 332 or:
 333 @example
 334         CONFIG_SHELL=/bin/bash bash -c ./configure
 335 @end example
 336
 337 @end itemize
 338
 339 @bye
 340