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 @html
   8 <!--- @@WEB-TITLE@@=Installation Instructions --->
   9 @end html
  10
  11 @contents
  12
  13 @chapter Compiling and installing on Unix
  14
  15
  16 @html
  17 <a name="download-source">
  18 @end html
  19
  20 @section Downloading
  21
  22 Even numbered versions are `stable'. The webpages for the stable version
  23 (1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
  24 servers}. Big enhancements go into the latest odd numbered version
  25 (1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
  26 site}.
  27
  28 Building LilyPond is an involved process. We advise to use binary
  29 packages if these are available for your platform.
  30
  31
  32
  33 @subsection Source code
  34
  35 Download source tarballs from here:
  36 @itemize @bullet
  37 @item Download development releases from
  38 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
  39 @uref{http://www.lilypond.org/ftp/} by HTTP.
  40 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
  41 @end itemize
  42
  43
  44 Use Xdelta to patch tarballs, e.g. to patch
  45 @file{lilypond-1.4.2.tar.gz} to @file{lilypond-1.4.3.tar.gz}, do
  46 @example
  47         xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
  48 @end example
  49
  50 For information on packaging and CVS, see
  51 @uref{http://lilypond.org/}, under ``develoment''.
  52
  53
  54 @subsection Precompiled binaries
  55
  56 Check out @uref{http://lilypond.org} for up to date information on
  57 binary packages.
  58
  59
  60 @subsection Font problems
  61
  62 If you are upgrading from a previous version of LilyPond, be sure to
  63 remove all old font files. These include @file{.pk} and @file{.tfm} files
  64 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
  65 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}.  A
  66 script automating this has been included, see
  67 @file{buildscripts/clean-fonts.sh}.
  68
  69
  70
  71
  72 @section Requirements
  73
  74 @subsection Compilation
  75
  76 You need the following packages to compile LilyPond:
  77
  78 @itemize
  79 @item
  80  @uref{http://gcc.gnu.org/,
  81 The GNU c++ compiler} (version 3.1 or newer).
  82 EGCS 1.1 may work, but is no longer supported.
  83
  84 @item @uref{http://www.python.org,Python} (version 2.1 or newer).
  85
  86 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
  87
  88 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
  89
  90 @item  @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer).
  91
  92 WARNING: plain Flex 2.5.4(a) generates invalid C++ code.  GCC 3.x
  93 chokes on this.  If you wish to use GCC 3.x, make sure that your
  94 distribution supports g++ 3.x and flex.  For workarounds, see
  95 lexer-gcc-3.1.sh in the source directory.
  96
  97 @item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
  98 newer, but not 1.50 or 1.75).
  99
 100 @item @TeX{}.
 101
 102 @TeX{} is used as an output backend.
 103
 104 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
 105 @file{.afm}, @file{.tfm}).  Make sure you have tetex 1.0 or newer
 106 (1.0.6 is known to work).  You may need to install a tetex-devel (or
 107 tetex-dev or libkpathsea-dev) package too.
 108
 109 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.2 or newer).
 110
 111 @item The
 112 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
 113 package for LaTeX}.
 114
 115  This package is normally included with the @TeX{} distribution.
 116
 117 @item kpathsea, a library for searching (@TeX{}) files.
 118
 119 @ignore
 120 @code{kpathsea} is
 121 usually included with your installation of @TeX{}.  You may need to
 122 install a tetex-devel or tetex-dev package too. If kpathsea is not
 123 installed in a directory where the compiler normally looks, read the
 124 hints for Slackware below.
 125
 126 In the very unlikely case that kpathsea is not available for your
 127 platform (i.e., you're not running GNU/Linux, Windows, or any recent
 128 UNIX), you can compile LilyPond without kpathsea support.  In that case,
 129 you'll probably have to indicate where @TeX{}'s tfm files live.  Invoke
 130 configure something like:
 131
 132 @quotation
 133 @example
 134         ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
 135 @end example
 136 @end quotation
 137 @end ignore
 138
 139 @end itemize
 140
 141 @subsection Running requirements
 142
 143 GNU LilyPond does use a lot of resources. For operation you need the
 144 following software:
 145
 146 @itemize @bullet
 147 @item @TeX{}.
 148 @item Xdvi and Ghostscript.
 149 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
 150 @end itemize
 151
 152 For running LilyPond successfully
 153
 154 You have to help @TeX{} and MetaFont find LilyPond support
 155 files. After compiling, scripts to do this can be found in
 156 @file{buildscripts/out/lilypond-profile} and
 157 @file{buildscripts/out/lilypond-login}.
 158
 159 @subsection Building documentation
 160
 161 You can view the documentation online at
 162 @uref{http://www.lilypond.org/doc/}, but you can also build it
 163 locally. This process requires a successful compile of lilypond. The
 164 documentation is built by issuing:
 165 @example
 166         make web
 167 @end example
 168
 169 Building the website requires some additional tools:
 170
 171 @itemize @bullet
 172 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} see
 173 @item ImageMagick
 174 @item @uref{http://www.cs.uu.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
 175 newer),
 176
 177   You will need to install some additional packages to get mftrace to
 178 work.
 179 @end itemize
 180
 181 @section Building LilyPond
 182
 183 To install GNU LilyPond, type
 184 @example
 185 gunzip -c lilypond-x.y.z | tar xf -
 186 cd lilypond-x.y.z
 187 ./configure             # run with --help to see appropriate options
 188 make
 189 make install
 190 sh buildscripts/clean-fonts.sh
 191 @end example
 192
 193 If, in addition, you want to generate PDF files of your scores and have
 194 installed mftrace, type
 195 @example
 196 make pfa-fonts
 197 make MAKE_PFA_FILES=1 install
 198 texhash
 199 @end example
 200
 201 PFA versions of the fonts for the latest LilyPond version can also be
 202 obtained from the internet: download the .deb file that corresponds to
 203 your version, eg.
 204
 205 @example
 206 wget http://ftp.us.debian.org/debian/pool/main/l/lilypond/lilypond_1.8.0-1_i386.deb
 207 ar x lilypond_1.8.0.-1_i386.deb
 208 tar -C / -zxf  data.tar.gz /usr/share/lilypond/1.8.0/fonts/type1/
 209 tar -C / -zxf  data.tar.gz /usr/share/lilypond/1.8.0/dvips/
 210 texhash
 211 @end example
 212
 213 If you are installing LilyPond somewhere else, unpack the appropriate
 214 files as shown, and move them to the appropriate paths.
 215
 216 If you are doing an upgrade, you should remove all @file{feta}
 217 @code{.pk} and @code{.tfm} files.  A script has been provided to do the
 218 work for you, see @file{buildscripts/clean-fonts.sh}.
 219
 220 If you are not root, you should choose a @code{--prefix} argument that
 221 points into your home directory, e.g.:
 222 @example
 223         ./configure --prefix=$HOME/usr
 224 @end example
 225
 226 In this case, you have to insert the contents of
 227 @code{buildscripts/out/lilypond-login} or
 228 @code{buildscripts/out/lilypond-profile} into your start up scripts by
 229 hand.
 230
 231
 232
 233 @subsection Configuring for multiple platforms
 234
 235 If you want to build multiple versions of LilyPond with different
 236 configuration settings, you can use the @code{--enable-config=CONF}
 237 option of configure.  You should use @samp{make conf=CONF} to generate
 238 the output in @file{out-CONF}.  Example: Suppose I want to build with
 239 and without profiling.  Then I'd use the following for the normal
 240 build:
 241 @c prefix=~ ?
 242 @example
 243         ./configure --prefix=$HOME/usr/ --enable-checking
 244         make
 245         make install
 246 @end example
 247
 248 and for the profiling version, I specify a different configuration:
 249
 250 @example
 251         ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
 252         make conf=prof
 253         make conf=prof install
 254 @end example
 255
 256
 257
 258 @section Emacs mode
 259
 260 An Emacs mode for entering music and running LilyPond is contained in
 261 the source archive as @file{lilypond-mode.el},
 262 @file{lilypond-indent.el}, @file{lilypond-font-lock.el} and
 263 @file{lilypond.words}.  You should install these files to a directory
 264 included in your @var{load-path}. File @file{lilypond-init.el} should
 265 be placed to @var{load-path}@file{/site-start.d/} or appended to your
 266 @file{~/.emacs} or @file{~/.emacs.el}.
 267
 268 As a user, you may want add your source path or, e.g., @file{~/site-lisp/}
 269 to your @var{load-path}. Append the following line (modified) to your
 270 @file{~/.emacs}:
 271 @quotation
 272 @example
 273         (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
 274 @end example
 275 @end quotation
 276
 277
 278 @section Vim mode
 279
 280 A Vim mode for entering music and running LilyPond is contained in
 281 the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
 282 to get shortcuts. Install file @file{lilypond.words} to @file{~/.vim/} to
 283 get auto-completion. Syntax highlighting you get by installing
 284 @file{lilypond.vim} to @file{~/.vim/syntax/} and appending the following
 285 to @file{~/.vim/filetype.vim}:
 286 @quotation
 287 @example
 288         " my filetype file
 289         if exists("did_load_filetypes")
 290           finish
 291         endif
 292         augroup filetypedetect
 293           au! BufRead,BufNewFile  *.ly          setfiletype lilypond
 294         augroup
 295 @end example
 296 @end quotation
 297
 298
 299
 300 @section Problems
 301
 302 For help and questions use @email{lilypond-user@@gnu.org}.  Please
 303 consult the FAQ before mailing your problems.  If you find bugs, please
 304 send bug reports to @email{bug-lilypond@@gnu.org}.
 305
 306 Bugs that are not fault of LilyPond are documented here.
 307
 308 @subsection Linking to kpathsea
 309
 310 If kpathsea and the corresponding header files are installed in some
 311 directory where GCC does not search by default, for example in
 312 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
 313 you have to explicitly tell configure where to find it. To do this:
 314
 315 @itemize
 316 @item @code{rm config.cache}
 317 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
 318 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
 319 @item @code{./configure}
 320 @end itemize
 321 Once configure has found them, the paths are stored in
 322 @file{config.make} and will be used even if you don't have the
 323 environment variables set during make.
 324
 325
 326 @unnumberedsubsec Gcc-3.0.4
 327
 328 Gcc 3.0.4 is flaky;  upgrade GCC.
 329
 330 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
 331
 332 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code.  To compile
 333 LilyPond with gcc-3.1.1 you may do
 334
 335 @example
 336         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 337         CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
 338             ./configure --enable-config=gcc-3.1
 339         CONF=gcc-3.1 ./lexer-gcc-3.1.sh
 340         make conf=gcc-3.1
 341 @end example
 342
 343
 344 @unnumberedsubsec OpenBSD
 345
 346 @itemize @bullet
 347 @item
 348  Refer to the section ``Linking to kpathsea'': GCC on OpenBSD doesn't
 349 set include paths for kpathsea.
 350 @end itemize
 351
 352 @unnumberedsubsec NetBSD
 353
 354 @itemize @bullet
 355 @item The flex precompiled in NetBSD-1.4.2 is broken.
 356 Upgrade to flex-2.5.4a.
 357
 358 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
 359 release)) does not include @file{/usr/pkg} paths.  Configure it using:
 360 @example
 361
 362         CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
 363
 364 @end example
 365
 366 @end itemize
 367
 368 @unnumberedsubsec  Solaris
 369
 370 @itemize @bullet
 371 @item Solaris7, ./configure
 372
 373 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
 374 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
 375 is.  Please run configure like:
 376 @example
 377         CONFIG_SHELL=/bin/ksh ksh -c ./configure
 378 @end example
 379 or:
 380 @example
 381         CONFIG_SHELL=/bin/bash bash -c ./configure
 382 @end example
 383
 384 @item Sparc64/Solaris 2.6, ld
 385
 386 Not yet resolved.
 387 @end itemize
 388
 389
 390 @unnumberedsubsec   AIX
 391
 392 @itemize @bullet
 393 @item AIX 4.3 ld
 394
 395 The following is from the gcc install/SPECIFIC file:
 396 @quotation
 397    Some versions of the AIX binder (linker) can fail with a relocation
 398    overflow severe error when the -bbigtoc option is used to link
 399    GCC-produced object files into an executable that overflows the TOC.
 400    A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
 401    -BBIGTOC) is available from IBM Customer Support and from its
 402    27service.boulder.ibm.com website as PTF U455193.
 403
 404    Binutils does not support AIX 4.3 (at least through release 2.9). GNU
 405    as and GNU ld will not work properly and one should not configure GCC
 406    to use those GNU utilities. Use the native AIX tools which do
 407    interoperate with GCC.
 408 @end quotation
 409
 410 add -Wl,-bbigtoc to USER_LDFLAGS, i.e.:
 411 @example
 412         LDFLAGS='-Wl,-bbigtoc' ./configure
 413 @end example
 414
 415 @end itemize
 416
 417
 418 @bye
 419