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 RUNNING
  37        GNU LilyPond does use a lot of resources. For operation
  38        you need the following:
  39
  40        o    TeX
  41
  42        o    A PostScript printer and/or viewer (such as
  43             Ghostscript) is strongly recommended.  Xdvi will show
  44             all embedded PostScript too if you have Ghostscript
  45             installed.
  46
  47 RECOMMENDED
  48        Although not strictly necessary, these are recommended to
  49        have.
  50
  51        o    GNU make.
  52
  53        o    Flex (version 2.5.4 or newer).
  54
  55        o    Bison (version 1.25 or newer).  =item *
  56
  57             Perl-5.  Most documentation was created with the
  58             perl's Plain Old Documentation. (I use 5.003)
  59
  60
  61
  62
  63
  64 21/Apr/98                LilyPond 0.1.58                        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 install
  88
  89        This will install the following files:
  90
  91                /usr/local/man/man1/mi2mu.1
  92                /usr/local/man/man1/convert-mudela.1
  93                /usr/local/man/man1/mudela-book.1
  94                /usr/local/man/man1/lilypond.1
  95                /usr/local/lib/libflower.{so,a}
  96                /usr/local/bin/lilypond
  97                /usr/local/bin/mi2mu
  98                /usr/local/share/lilypond/*
  99                /usr/lib/texmf/texmf/tex/lilypond/*
 100
 101        The TeX include directory is detected dynamically, but it
 102        can be adjusted with --enable-tex-prefix and --enable-tex-
 103        dir. The above assumes that you are root and have the GNU
 104        development tools, and your make is GNU make.  If this is
 105        not the case, you can adjust your environment variables to
 106        your taste:
 107
 108                export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 109                configure
 110
 111        CPPFLAGS are the preprocessor flags.
 112
 113        the configure script is Cygnus configure, and it will
 114        accept --help. If you are not root, you will probably have
 115        to make it with
 116
 117                configure --prefix=/home/me_myself_and_I/
 118
 119        In this case, you will have to set MFINPUTS, and TEXINPUTS
 120        accordingly.
 121
 122        If you want to install GNU LilyPond in /usr/local, and
 123        your TeX has no default hooks for local stuff (mine is
 124        broken too), you can do:
 125
 126                configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
 127
 128
 129
 130 21/Apr/98                LilyPond 0.1.58                        2
 131
 132
 133
 134
 135
 136 INSTALL(1)            LilyPond documentation           INSTALL(1)
 137
 138
 139        Since GNU LilyPond currently is beta, you are advised to
 140        also use
 141
 142                --enable-debugging
 143                --enable-checking
 144
 145        other options include:
 146
 147        --enable-shared
 148            Make a shared library (gnu/linux, solaris (?) only )
 149
 150        --enable-printing
 151            Enable debugging print routines (lilypond -d option)
 152
 153        --enable-optimise
 154            Set maximum optimisation: compile with -O2
 155
 156        --enable-profiling
 157            Compile with support for profiling
 158
 159        --enable-tex-prefix
 160            Set the directory where TeX and Metafont live
 161
 162        --enable-tex-dir
 163            Set then directory TeX input is in (detected as a
 164            subdir of tex-prefix)
 165
 166        --enable-mf-dir
 167            Set the directory mf input is in (idem)
 168
 169        All options are documented in the configure help The
 170        option --enable-optimise is recommended for Real Life
 171        usage.
 172
 173        If you do
 174
 175                make all
 176
 177        everything will be compiled, but nothing will be
 178        installed.  The resulting binaries can be found in the
 179        subdirectories out/ (which contain all files generated
 180        during compilation).
 181
 182 INSTALLING
 183        If you have done a successful make, then a simple
 184
 185                make install
 186
 187        should do the trick.
 188
 189        If you are doing an upgrade, please remember to remove
 190        obsolete .pk and .tfm files of the fonts.  A script has
 191        been provided to do the work, see bin/clean-fonts.sh.
 192
 193
 194
 195
 196 21/Apr/98                LilyPond 0.1.58                        3
 197
 198
 199
 200
 201
 202 INSTALL(1)            LilyPond documentation           INSTALL(1)
 203
 204
 205 CAVEATS
 206        o    The -O2 option to gcc triggers a gcc bug on DEC Alpha
 207             in dstream.cc. You should turn off this flag for this
 208             file.
 209
 210        o    Perl5.003 and Perl5.004 use different syntax for
 211             pod2html.
 212
 213 EXAMPLE
 214        This is what I type in my xterm:
 215
 216                lilypond someinput.ly
 217                tex someinput.tex
 218                xdvi someinput&
 219
 220        This is what the output looks like over here:
 221
 222                GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
 223                Parsing ... [/home/hw/share/lilypond/init//
 224                        <..etc..>
 225                        init//performer.ly]]][input/kortjakje.ly]
 226                Creating elements ...[8][16][24][25]
 227                Preprocessing elements...
 228                Calculating column positions ... [14][25]
 229                Postprocessing elements...
 230                TeX output to someinput.tex ...
 231                Creating MIDI elements ...MIDI output to someinput.midi ...
 232
 233                hw:~/musix/spacer$ xdvi someinput&
 234                [1] 855
 235
 236        Check out the input files, some of them have comments
 237        Please refer to the man page for more information.
 238
 239 REDHAT LINUX
 240        RedHat Linux users should be able to get a RPM. A spec
 241        file is in make/out/lilypond.spec. You should be able to
 242        create an rpm as a normal user. Be sure you have a
 243        ~/.rpmrc, and edit the RPM-dir in Variables.make. (If you
 244        create the RPM as a normal user the permissions will not
 245        be set correctly, unfortunately)
 246
 247 DEBIAN GNU/LINUX
 248        A Debian package is also available; contact Anthony Fok
 249        <foka@debian.org>.  The build scripts are in the
 250        subdirectory debian/
 251
 252 WINDOWS NT/95
 253        So, you're stuck with Windows, eh?  Well, don't worry, you
 254        just need (to get) Cygnus' windows32 port of gnu
 255        development stuff; have a look at
 256        http://www.cygnus.com/gnu-win32.
 257
 258        To make GNU LilyPond under, brr, aargh, shudder...
 259
 260
 261
 262 21/Apr/98                LilyPond 0.1.58                        4
 263
 264
 265
 266
 267
 268 INSTALL(1)            LilyPond documentation           INSTALL(1)
 269
 270
 271        windows32, well, simply type:
 272
 273                bash configure
 274                make
 275
 276        Note If you rely on broken DOS/Windows tools such as
 277        pkzip/WinZIP to unpack the distribution, make sure the
 278        entire source tree is unpacked correctly, in particular
 279        the empty out directories (flower/out, lib/out et. al.)
 280
 281 MUSIXTEX
 282        Previous versions (before 0.1.39) used fonts from the TeX
 283        macro package "MusixTeX".  You can still use these, but
 284        they are not supported.  Since LilyPond's Feta font is
 285        much prettier, you'd be seriously misguided if you used
 286        them, but anyway, here are the installation instructions
 287        for those deprecated fonts.
 288
 289        [obsolete] I use the MusixTeX fonts those found in
 290        MusixTeX T.73. Beware, the clef symbol seems to have
 291        changed its position in some versions, (notably Egler's,
 292        a.k.a. OpusTeX). The MusixTeX fonts are included in
 293        MusixTeX (T73 or newer), which can be had from any CTAN
 294        site, e.g. at
 295
 296        ftp://ftp.shsu.edu/tex-archive/macros/musixtex/taupin
 297
 298        ftp://ftp.tex.ac.uk/tex-archive/macros/musixtex/taupin
 299
 300        ftp://ftp.dante.de/tex-archive/macros/musixtex/taupin
 301
 302        You only need the contents of the mf/ subdirectory of the
 303        package. The primary site of the Taupin version is
 304        ftp://hprib.lps.u-psud.fr/pub/music_zips/musixtex.zip
 305
 306        Install the musixtex fonts in a directory which TeX and MF
 307        knows (if you are root, look for a directory which
 308        contains the directories with AMS and CM source (*.mf)
 309        files. Create a subdir lilypond or musixtex and copy the
 310        fonts into that). Do not forget to rehash TeX (if
 311        applicable)
 312
 313        Example: my fonts are in
 314        /usr/local/lib/texfonts/musixtex/, and I have a symlink
 315        pointing to that in
 316        /usr/lib/texmf/texmf/fonts/source/public/. After I copied
 317        the files, I ran "texhash"
 318
 319        Andreas Egler's version of MusixTeX, now called OpusTeX,
 320        will also work. Andreas moved some characters around in
 321        the fonts, so you have to edit the definitions in
 322        tex/eglerdefs.tex.
 323
 324
 325
 326
 327
 328 21/Apr/98                LilyPond 0.1.58                        5
 329
 330
 331
 332
 333
 334 INSTALL(1)            LilyPond documentation           INSTALL(1)
 335
 336
 337 AUTHORS
 338        Han-Wen Nienhuys <hanwen@cs.ruu.nl>
 339
 340        Jan Nieuwenhuizen <jan@digicash.com>
 341
 342        Have fun!
 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 21/Apr/98                LilyPond 0.1.58                        6
 395
 396