Documentation/topdocs/INSTALL.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename INSTALL.info
   3 @settitle INSTALL - compiling and installing GNU LilyPond
   4
   5 @documentencoding utf-8
   6 @documentlanguage en
   7
   8 @node Top
   9 @top
  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 minor versions are `stable' (2.6, 2.8, etc), while odd
  23 version are development releases (2.7, 2.9, etc).  Building LilyPond
  24 is an involved process.  If possible
  25 @uref{http://lilypond.org/install,download a precompiled binary} for
  26 your platform.
  27
  28 @subsection Source code
  29
  30 Download source
  31 @itemize @bullet
  32 @item tarballs from
  33 @uref{http://lilypond.org/download/} by HTTP.
  34 @item tarballs from
  35 @uref{http://download.linuxaudio.org/lilypond/} by HTTP.
  36 @item
  37 GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
  38 @example
  39 git clone git://git.sv.gnu.org/lilypond.git
  40 @end example
  41
  42 The repository does not contain generated files.  To create
  43 @file{configure}, run
  44 @example
  45 ./autogen.sh
  46 @end example
  47 @end itemize
  48
  49 For information on packaging, see @uref{http://lilypond.org/devel}.
  50
  51 @subsection Precompiled binary packages
  52
  53 Check out @uref{http://lilypond.org/web/install/} for up to date
  54 information on binary packages for your platform.
  55
  56
  57 @section Requirements
  58
  59 @subsection Compilation
  60
  61 In addition to the packages needed for running Lilypond (see below),
  62 you need the following extra packages for building.
  63
  64 When installing a binary package FOO, you may need to install the
  65 FOO-devel, libFOO-dev or FOO-dev package too.
  66
  67 @itemize
  68
  69 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
  70
  71 @item New Century Schoolbook fonts, as PFB files. These are shipped
  72 with X11 and Ghostscript, and are named @file{c059033l.pfb}
  73 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
  74
  75 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
  76 newer),
  77
  78 You will need to install some additional packages to get mftrace to
  79 work.
  80
  81 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
  82 (version 1.8.2 or newer).  If you are installing binary packages, you
  83 may need to install guile-devel or guile-dev or libguile-dev too.
  84
  85 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
  86
  87 @item
  88 @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
  89 newer).
  90
  91 @item @uref{http://www.python.org,Python} (version 2.3 or newer)
  92
  93 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
  94
  95 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
  96
  97 @item @uref{http://www.gnu.org/software/flex/,Flex}
  98
  99 @item @uref{http://www.perl.org/,Perl}
 100
 101 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}
 102
 103 @item All packages required for running, including development packages with
 104 header files and libraries.
 105
 106 @end itemize
 107
 108 @subsection Running requirements
 109
 110 Running LilyPond requires proper installation of the following
 111 software
 112
 113 @itemize @bullet
 114
 115 @item @uref{http://www.freetype.org/,Freetype} (version 2).
 116 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
 117 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
 118 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
 119 (version 1.8.2 or newer), or patch 1.8.x with
 120 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
 121 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
 122 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
 123 newer. 8.50 recommended)
 124 @end itemize
 125
 126 @subsection Building documentation
 127
 128 You can view the documentation online at
 129 @uref{http://lilypond.org/doc/}, but you can also build it locally.
 130 This process requires a successful compile of lilypond.  The
 131 documentation is built by issuing
 132 @quotation
 133 @example
 134 make web
 135 @end example
 136 @end quotation
 137
 138 Building the website requires some additional tools and packages
 139
 140 @itemize @bullet
 141 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
 142 @item ImageMagick
 143 @item International fonts (see input/regression/utf-8.ly for hints
 144 about which font packages are necessary for your platform)
 145 @item Ghostscript, 8.50 with the patch from
 146 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
 147 and the patch from
 148 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
 149 @end itemize
 150
 151 The HTML files can be installed into the standard documentation path
 152 by issuing
 153
 154 @quotation
 155 @example
 156 make out=www web-install
 157 @end example
 158 @end quotation
 159
 160
 161 @section Building LilyPond
 162
 163 To install GNU LilyPond, type
 164 @quotation
 165 @example
 166 gunzip -c lilypond-x.y.z | tar xf -
 167 cd lilypond-x.y.z
 168 ./configure             # run with --help for applicable options
 169 make
 170 make install
 171 @end example
 172 @end quotation
 173
 174 If you are not root, you should choose a @code{--prefix} argument that
 175 points into your home directory, e.g.
 176 @quotation
 177 @example
 178 ./configure --prefix=$HOME/usr
 179 @end example
 180 @end quotation
 181
 182
 183 @subsection Configuring for multiple platforms
 184
 185 If you want to build multiple versions of LilyPond with different
 186 configuration settings, you can use the @code{--enable-config=CONF}
 187 option of configure.  You should use @samp{make conf=CONF} to generate
 188 the output in @file{out-CONF}.  Example: Suppose you want to build
 189 with and without profiling, then use the following for the normal
 190 build
 191
 192 @quotation
 193 @example
 194 ./configure --prefix=$HOME/usr/ --enable-checking
 195 make
 196 make install
 197 @end example
 198 @end quotation
 199
 200 and for the profiling version, specify a different configuration
 201
 202 @quotation
 203 @example
 204 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
 205 make conf=prof
 206 make conf=prof install
 207 @end example
 208 @end quotation
 209
 210
 211 @section Emacs mode
 212
 213 An Emacs mode for entering music and running LilyPond is contained in
 214 the source archive in the @file{elisp} directory.  Do @command{make
 215 install} to install it to @var{elispdir}.  The file @file{lilypond-init.el}
 216 should be placed to @var{load-path}@file{/site-start.d/} or appended
 217 to your @file{~/.emacs} or @file{~/.emacs.el}.
 218
 219 As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
 220 your @var{load-path} by appending the following line (as modified) to your
 221 @file{~/.emacs}
 222 @c any reason we do not advise:  (push "~/site-lisp" load-path)
 223 @quotation
 224 @example
 225 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
 226 @end example
 227 @end quotation
 228
 229
 230 @section Vim mode
 231
 232 A Vim mode for entering music and running LilyPond is contained in the
 233 source archive in @code{$VIM} directory.
 234
 235 The LilyPond file type is detected if the file @file{~/.vim/filetype.vim} @c
 236 has the following content
 237 @quotation
 238 @example
 239 if exists("did_load_filetypes")
 240   finish
 241 endif
 242 augroup filetypedetect
 243   au! BufNewFile,BufRead *.ly           setf lilypond
 244 augroup END
 245 @end example
 246 @end quotation
 247
 248 Please include this path by appending the following line to your
 249 @file{~/.vimrc}
 250
 251 @quotation
 252 @example
 253 set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/
 254 @end example
 255 @end quotation
 256
 257 @noindent
 258 where $@{LILYPOND_VERISON@} is your lilypond version.  If Lilypond was not
 259 installed in @file{/usr/local/}, then change this path accordingly.
 260
 261
 262 @section Problems
 263
 264 For help and questions use @email{lilypond-user@@gnu.org}.  Send bug
 265 reports to @email{bug-lilypond@@gnu.org}.
 266
 267 Bugs that are not fault of LilyPond are documented here.
 268
 269 @subsection Bison 1.875
 270
 271 There is a bug in bison-1.875: compilation fails with "parse error
 272 before `goto'" in line 4922 due to a bug in bison. To fix, please
 273 recompile bison 1.875 with the following fix
 274
 275 @quotation
 276 @example
 277 $ cd lily; make out/parser.cc
 278 $ vi +4919 out/parser.cc
 279 # append a semicolon to the line containing "__attribute__ ((__unused__))
 280 # save
 281 $ make
 282 @end example
 283 @end quotation
 284
 285
 286 @unnumberedsubsec MacOS X
 287
 288 For Fink, use the following command to compile.
 289
 290 @verbatim
 291 export GUILE=guile-1.6
 292 export GUILE_CONFIG=guile-1.6-config
 293 export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
 294 ./configure
 295 @end verbatim
 296
 297 @unnumberedsubsec  Solaris
 298
 299 @itemize @bullet
 300 @item Solaris7, ./configure
 301
 302 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
 303 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
 304 is.  Run configure like
 305 @quotation
 306 @example
 307         CONFIG_SHELL=/bin/ksh ksh -c ./configure
 308 @end example
 309 @end quotation
 310 or
 311 @quotation
 312 @example
 313         CONFIG_SHELL=/bin/bash bash -c ./configure
 314 @end example
 315 @end quotation
 316
 317 @end itemize
 318
 319 @bye
 320