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