INSTALL.txt

   1
   2 TITLE INFORMATION: INSTALL - compiling and installing GNU LilyPond
   3 AUTHOR INFORMATION: HWN & JCN
   4
   5 Contents
   6
   7 1: ABSTRACT
   8 2: PREREQUISITES
   9 3: RUNNING
  10 4: RECOMMENDED
  11 5: WEBSITE
  12 6: CONFIGURING and COMPILING
  13 7: CONFIGURING FOR MULTIPLE PLATFORMS
  14 8: INSTALLING
  15 9: REDHAT LINUX
  16 10: DEBIAN GNU/LINUX
  17 11: WINDOWS NT/95
  18 12: AUTHORS
  19
  20 1: ABSTRACT
  21
  22 You do something which looks remotely like
  23
  24         configure    # Check out the buildscripts/set-lily.sh script
  25         make
  26         make install
  27
  28 The detailed instructions follow here.  The
  29 buildscripts/set-lily.sh script sets some environment variables
  30 and symlinks, which comes in handly when you have to compile LilyPond
  31 very often.  It is aimed at people who run (or debug) LilyPond without
  32 installing.
  33
  34 2: PREREQUISITES
  35
  36 For compilation you need:
  37
  38 o A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
  39     (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
  40 Solaris.
  41
  42 o Lots of disk space: LilyPond takes between 50 and 100 mb to
  43 compile if you use debugging information.  If you are short on
  44 disk-space run configure with --disable-debugging.
  45
  46 Although we recommend to use Unix, LilyPond is known to run on Windows
  47 NT/95/98 as well.  See Section [w32].
  48
  49 o  GNU C++ version 2.7 or newer (2.8 and egcs are also fine).
  50 o  Python 1.5 (Strictly speaking, you shouldn't need Python for
  51    compiling and installing, but you'll need it to regenerate the font
  52    tables, e.g.).
  53
  54 3: RUNNING
  55
  56 GNU LilyPond does use a lot of resources. For operation you need the following:
  57
  58 o TeX
  59 o A PostScript printer and/or viewer (such as Ghostscript) is strongly
  60     recommended.  Xdvi will show all embedded PostScript too if you have
  61     Ghostscript installed.
  62
  63 4: RECOMMENDED
  64
  65 Although not strictly necessary, these are recommended to have.
  66
  67 o GNU make.
  68 Check out ftp://ftp.gnu.org
  69 or any mirror of this site.
  70
  71 o Flex (version 2.5.4 or newer).
  72 Check out ftp://ftp.gnu.org
  73 or any mirror of this site.
  74 o Bison (version 1.25 or newer).
  75 Check out ftp://ftp.gnu.org
  76 or any mirror of this site.
  77
  78 o Python (version 1.5 or newer).  Check out
  79 ftp://ftp.python.org or ftp://ftp.cwi.nl/pub/python.
  80
  81 o Yodl.  All documentation will be in Yodl. (1.30.17)
  82 ftp://pcnov095.win.tue.nl/pub/yodl
  83     http://www.cs.uu.nl/~hanwen/yodl
  84 o Texinfo. (version 3.12 or newer)
  85
  86 o GNU find
  87 Check out ftp://ftp.gnu.org
  88 or any mirror of this site
  89
  90 o  A fast computer (a full page of music typically takes 1 minute on my
  91     486/133, using the --enable-checking compile. It's lot slower than
  92     most MusiXTeX preprocessors)
  93
  94 5: WEBSITE
  95
  96 If you want to auto-generate Lily's website, you'll need some additional
  97 conversion tools.
  98
  99 o xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
 100              users: it is included within the package libgr-progs).
 101 o Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
 102     Which, in turn depends on man2html for proper installation.
 103 man2html can be had from http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05.
 104
 105     TeTeX users should not forget to rerun texhash.
 106
 107 6: CONFIGURING and COMPILING
 108
 109 to install GNU LilyPond, simply type:
 110
 111         configure  --enable-tex-dir=XXXX --enable-mf-dir=YYYY
 112         make
 113         make install
 114
 115 This will install a number of files, something close to:
 116
 117         /usr/local/man/man1/mi2mu.1
 118         /usr/local/man/man1/convert-mudela.1
 119         /usr/local/man/man1/mudela-book.1
 120         /usr/local/man/man1/lilypond.1
 121         /usr/local/bin/lilypond
 122         /usr/local/bin/mi2mu
 123         /usr/local/share/lilypond/*
 124         /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
 125         /usr/lib/texmf/texmf/tex/lilypond/*
 126
 127 You should specify directories that are in TeX's and MetaFont's
 128 include path with the options (--enable-tex-dir) and
 129 --enable-mf-dir.  If you don't specify any directories, the TeX
 130 include directory is detected dynamically, which is unreliable.  The
 131 above assumes that you are root and have the GNU development tools,
 132 and your make is GNU make.  If this is not the case, you can adjust
 133 your environment variables to your taste:
 134
 135         export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 136         configure
 137
 138 CPPFLAGS are the preprocessor flags.
 139
 140 The configure script is Cygnus configure, and it will accept
 141 --help. If you are not root, you will probably have to make it
 142 with a different --prefix option.  Our favourite location is
 143
 144         configure --prefix=$HOME/usr
 145
 146 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
 147
 148 If you want to install GNU LilyPond in /usr/local, and your TeX has
 149 no default hooks for local stuff, you can do:
 150
 151         configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
 152
 153 Since GNU LilyPond currently is beta, you are advised to also use
 154
 155         --enable-debugging
 156         --enable-checking
 157
 158 Other options include:
 159
 160 o --enable-shared
 161     Make a shared library (gnu/linux, solaris (?) only )  (TEMPORARILY
 162 OUT OF ORDER)
 163
 164 o --enable-printing
 165     Enable debugging print routines (lilypond -D option)
 166 o --enable-optimise
 167     Set maximum optimisation: compile with -O2
 168 o --enable-profiling
 169     Compile with support for profiling.
 170 o --enable-tex-prefix
 171     Set the directory where TeX and Metafont live.
 172 o --enable-tex-dir
 173     Set then directory TeX input is in (detected as a subdir of
 174     tex-prefix).  This should be a directory that is reachable both for
 175     tex and latex.  On my system the best choice would be
 176     /usr/lib/texmf/texmf/tex/generic//.
 177 o --enable-mf-dir
 178     Set the directory metafont input is in (idem).   On my system the best
 179     choice would be /usr/lib/texmf/texmf/fonts/source/public/.
 180 o --enable-config
 181     Output to a different configuration file.  Needed for multi-platform
 182     builds
 183
 184 All options are documented in the configure help
 185 The option --enable-optimise is recommended for Real Life usage.
 186
 187 If you do
 188
 189         make all
 190
 191 everything will be compiled, but nothing will be installed.  The
 192 resulting binaries can be found in the subdirectories out/ (which
 193 contain all files generated during compilation).
 194
 195 7: CONFIGURING FOR MULTIPLE PLATFORMS
 196
 197 If you want to compile LilyPond with different configuration settings,
 198 then, you can use the --enable-config option.  Example: suppose I
 199 want to build with and   without profiling.  Then I'd use the
 200 following for the normal build,
 201
 202       configure --prefix=~ --disable-optimise --enable-checking
 203       make
 204       make install
 205
 206 and for the profiling version, I specify a different configuration.
 207
 208       configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
 209       make config=optprof
 210       make config=optprof install
 211
 212 8: INSTALLING
 213
 214 If you have done a successful make, then a simple
 215
 216         make install
 217
 218 should do the trick.
 219
 220 If you are doing an upgrade, please remember to remove obsolete
 221 .pk and .tfm files of the fonts.  A script has been
 222 provided to do the work for you, see bin/clean-fonts.sh.
 223
 224 CAVEATS
 225
 226 o The -O2 option to gcc triggers a gcc bug on DEC Alpha in dstream.cc. You
 227     should turn off this flag for this file.
 228
 229 EXAMPLE
 230
 231 This is what I type in my xterm:
 232
 233         lilypond someinput.ly
 234         tex someinput.tex
 235         xdvi someinput&
 236
 237 This is what the output looks like over here:
 238
 239         GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
 240         Parsing ... [/home/hw/share/lilypond/init//
 241                 <..etc..>
 242                 init//performer.ly]]][input/kortjakje.ly]
 243         Creating elements ...[8][16][24][25]
 244         Preprocessing elements...
 245         Calculating column positions ... [14][25]
 246         Postprocessing elements...
 247         TeX output to someinput.tex ...
 248         Creating MIDI elements ...MIDI output to someinput.midi ...
 249
 250         hw:~/musix/spacer$ xdvi someinput&
 251         [1] 855
 252
 253 Check out the input files, some of them have comments
 254 Please refer to the man page for more information.
 255
 256 9: REDHAT LINUX
 257
 258 RedHat Linux users can compile an RPM. A spec file is in
 259 make/out/lilypond.spec.  You should install a gif file called
 260 lelie_icon.gif along with the sources.  You can generate this
 261 gif file by typing
 262
 263      make gifs
 264
 265 in the directory Documentation.
 266
 267 You can make the rpm by issuing
 268
 269         make rpm
 270
 271 10: DEBIAN GNU/LINUX
 272
 273 A Debian package is also available; contact Anthony Fok
 274 <foka@debian.org>.  The build scripts are in the subdirectory debian/
 275
 276 11: WINDOWS NT/95
 277
 278 Separate instructions on building for W32 are avaible
 279 in the file README-W32.yo.
 280
 281 12: AUTHORS
 282
 283 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 284
 285 Jan Nieuwenhuizen <janneke@gnu.org>
 286
 287 Have fun!