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