INSTALL.txt

   1
   2
   3
   4 INSTALL(1)            LilyPond documentation           INSTALL(1)
   5
   6
   7 NAME
   8        INSTALL - installing GNU LilyPond
   9
  10 DESCRIPTION
  11        This page documents installation and compilation of GNU
  12        LilyPond
  13
  14 ABSTRACT
  15        You do something which looks remotely like
  16
  17                configure
  18                make
  19                make install
  20
  21        The detailed instructions follow here.
  22
  23 PREREQUISITES
  24        For compilation you need.
  25
  26        o    A GNU system: GNU LilyPond is known to run on these
  27             GNU systems: Linux (PPC, intel), FreeBSD, AIX,
  28             NeXTStep, IRIX, Digital Unix and Solaris.
  29
  30             If you have the Cygnus WINDOWS32 port of the GNU
  31             utils, it will even work in Windows NT/95, but we
  32             don't promise to support it.
  33
  34        o    GNU C++ version 2.7 or newer (yes, 2.8 is fine).
  35
  36        o    Python
  37
  38 RUNNING
  39        GNU LilyPond does use a lot of resources. For operation
  40        you need the following:
  41
  42        o    TeX
  43
  44        o    A PostScript printer and/or viewer (such as
  45             Ghostscript) is strongly recommended.  Xdvi will show
  46             all embedded PostScript too if you have Ghostscript
  47             installed.
  48
  49 RECOMMENDED
  50        Although not strictly necessary, these are recommended to
  51        have.
  52
  53        o    GNU make.
  54
  55        o    Flex (version 2.5.4 or newer).
  56
  57        o    Bison (version 1.25 or newer).
  58
  59        o    Perl-5.  Most documentation was created with the
  60             perl's Plain Old Documentation. (I use 5.003)
  61
  62
  63
  64 6/May/98                 LilyPond 0.1.62                        1
  65
  66
  67
  68
  69
  70 INSTALL(1)            LilyPond documentation           INSTALL(1)
  71
  72
  73        o    Python.  Although perl is nice, python is better.  We
  74             will shift towards python for build scripts
  75
  76        o    GNU find
  77
  78        o    A fast computer (a full page of music typically takes
  79             1 minute on my 486/133, using the --enable-checking
  80             compile. It's lot slower than most MusiXTeX
  81             preprocessors)
  82
  83 CONFIGURING and COMPILING
  84        to install GNU LilyPond, simply type:
  85
  86                configure
  87                make
  88                make install
  89
  90        This will install the following files:
  91
  92                /usr/local/man/man1/mi2mu.1
  93                /usr/local/man/man1/convert-mudela.1
  94                /usr/local/man/man1/mudela-book.1
  95                /usr/local/man/man1/lilypond.1
  96                /usr/local/lib/libflower.{so,a}
  97                /usr/local/bin/lilypond
  98                /usr/local/bin/mi2mu
  99                /usr/local/share/lilypond/*
 100                /usr/lib/texmf/texmf/tex/lilypond/*
 101
 102        The TeX include directory is detected dynamically, but it
 103        can be adjusted with --enable-tex-prefix and --enable-tex-
 104        dir. The above assumes that you are root and have the GNU
 105        development tools, and your make is GNU make.  If this is
 106        not the case, you can adjust your environment variables to
 107        your taste:
 108
 109                export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 110                configure
 111
 112        CPPFLAGS are the preprocessor flags.
 113
 114        the configure script is Cygnus configure, and it will
 115        accept --help. If you are not root, you will probably have
 116        to make it with
 117
 118                configure --prefix=/home/me_myself_and_I/
 119
 120        In this case, you will have to set MFINPUTS, and TEXINPUTS
 121        accordingly.
 122
 123        If you want to install GNU LilyPond in /usr/local, and
 124        your TeX has no default hooks for local stuff (mine is
 125        broken too), you can do:
 126
 127
 128
 129
 130 6/May/98                 LilyPond 0.1.62                        2
 131
 132
 133
 134
 135
 136 INSTALL(1)            LilyPond documentation           INSTALL(1)
 137
 138
 139                configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
 140
 141        Since GNU LilyPond currently is beta, you are advised to
 142        also use
 143
 144                --enable-debugging
 145                --enable-checking
 146
 147        other options include:
 148
 149        --enable-shared
 150            Make a shared library (gnu/linux, solaris (?) only )
 151
 152        --enable-printing
 153            Enable debugging print routines (lilypond -d option)
 154
 155        --enable-optimise
 156            Set maximum optimisation: compile with -O2
 157
 158        --enable-profiling
 159            Compile with support for profiling
 160
 161        --enable-tex-prefix
 162            Set the directory where TeX and Metafont live
 163
 164        --enable-tex-dir
 165            Set then directory TeX input is in (detected as a
 166            subdir of tex-prefix).  This should be a directory
 167            that is reachable both for tex and latex.  On my
 168            system the best choice would be
 169            /usr/lib/texmf/texmf/tex/generic//.
 170
 171        --enable-mf-dir
 172            Set the directory mf input is in (idem).   On my
 173            system the best choice would be
 174            /usr/lib/texmf/texmf/fonts/source/public/.
 175
 176        --enable-config
 177            Output to different configuration files.  Needed for
 178            multi-platform builds
 179
 180        All options are documented in the configure help The
 181        option --enable-optimise is recommended for Real Life
 182        usage.
 183
 184        If you do
 185
 186                make all
 187
 188        everything will be compiled, but nothing will be
 189        installed.  The resulting binaries can be found in the
 190        subdirectories out/ (which contain all files generated
 191        during compilation).
 192
 193
 194
 195
 196 6/May/98                 LilyPond 0.1.62                        3
 197
 198
 199
 200
 201
 202 INSTALL(1)            LilyPond documentation           INSTALL(1)
 203
 204
 205 CONFIGURING FOR MULTIPLE PLATFORMS
 206        If you want to compile LilyPond with different
 207        configuration settings, then, you can use the --enable-
 208        config option.  Example: suppose I want to build with and
 209        without profiling.  Then I'd use the following for the
 210        normal build,
 211
 212              configure --prefix=~ --disable-optimise --enable-checking
 213              make
 214              make install
 215
 216        and for the profiling version, I specify a different
 217        configuration.
 218
 219              configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
 220              make configuration=optprof
 221              make configuration=optprof install
 222
 223
 224 INSTALLING
 225        If you have done a successful make, then a simple
 226
 227                make install
 228
 229        should do the trick.
 230
 231        If you are doing an upgrade, please remember to remove
 232        obsolete .pk and .tfm files of the fonts.  A script has
 233        been provided to do the work, see bin/clean-fonts.sh.
 234
 235 CAVEATS
 236        o    The -O2 option to gcc triggers a gcc bug on DEC Alpha
 237             in dstream.cc. You should turn off this flag for this
 238             file.
 239
 240        o    Perl5.003 and Perl5.004 use different syntax for
 241             pod2html.
 242
 243 EXAMPLE
 244        This is what I type in my xterm:
 245
 246                lilypond someinput.ly
 247                tex someinput.tex
 248                xdvi someinput&
 249
 250        This is what the output looks like over here:
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262 6/May/98                 LilyPond 0.1.62                        4
 263
 264
 265
 266
 267
 268 INSTALL(1)            LilyPond documentation           INSTALL(1)
 269
 270
 271                GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
 272                Parsing ... [/home/hw/share/lilypond/init//
 273                        <..etc..>
 274                        init//performer.ly]]][input/kortjakje.ly]
 275                Creating elements ...[8][16][24][25]
 276                Preprocessing elements...
 277                Calculating column positions ... [14][25]
 278                Postprocessing elements...
 279                TeX output to someinput.tex ...
 280                Creating MIDI elements ...MIDI output to someinput.midi ...
 281
 282                hw:~/musix/spacer$ xdvi someinput&
 283                [1] 855
 284
 285        Check out the input files, some of them have comments
 286        Please refer to the man page for more information.
 287
 288 REDHAT LINUX
 289        RedHat Linux users can compile an RPM. A spec file is in
 290        make/out/lilypond.spec.  You should install a gif file
 291        called lelie_icon.gif along with the sources.  You can
 292        generate this gif file by typing
 293
 294             make gifs
 295
 296        in the directory Documentation.
 297
 298 DEBIAN GNU/LINUX
 299        A Debian package is also available; contact Anthony Fok
 300        <foka@debian.org>.  The build scripts are in the
 301        subdirectory debian/
 302
 303 WINDOWS NT/95
 304        So, you're stuck with Windows, eh?  Well, don't worry, you
 305        just need (to get) Cygnus' windows32 port of gnu
 306        development stuff; have a look at
 307        http://www.cygnus.com/gnu-win32.
 308
 309        To make GNU LilyPond under, brr, aargh, shudder...
 310        windows32, well, simply type:
 311
 312                bash configure
 313                make
 314
 315        Note If you rely on broken DOS/Windows tools such as
 316        pkzip/WinZIP to unpack the distribution, make sure the
 317        entire source tree is unpacked correctly, in particular
 318        the empty out directories (flower/out, lib/out et. al.)
 319
 320 AUTHORS
 321        Han-Wen Nienhuys <hanwen@cs.ruu.nl>
 322
 323        Jan Nieuwenhuizen <jan@digicash.com>
 324
 325
 326
 327
 328 6/May/98                 LilyPond 0.1.62                        5
 329
 330
 331
 332
 333
 334 INSTALL(1)            LilyPond documentation           INSTALL(1)
 335
 336
 337        Have fun!
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394 6/May/98                 LilyPond 0.1.62                        6
 395
 396