INSTALL.text

   1
   2
   3
   4 INSTALL(1)            LilyPond documentation           INSTALL(1)
   5
   6
   7 N\bN\bN\bNA\bA\bA\bAM\bM\bM\bME\bE\bE\bE
   8        INSTALL - installing GNU LilyPond
   9
  10 D\bD\bD\bDE\bE\bE\bES\bS\bS\bSC\bC\bC\bCR\bR\bR\bRI\bI\bI\bIP\bP\bP\bPT\bT\bT\bTI\bI\bI\bIO\bO\bO\bON\bN\bN\bN
  11        This page documents installation and compilation of GNU
  12        LilyPond
  13
  14 A\bA\bA\bAB\bB\bB\bBS\bS\bS\bST\bT\bT\bTR\bR\bR\bRA\bA\bA\bAC\bC\bC\bCT\bT\bT\bT
  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 P\bP\bP\bPR\bR\bR\bRE\bE\bE\bER\bR\bR\bRE\bE\bE\bEQ\bQ\bQ\bQU\bU\bU\bUI\bI\bI\bIS\bS\bS\bSI\bI\bI\bIT\bT\bT\bTE\bE\bE\bES\bS\bS\bS
  24        For compilation you need.
  25
  26        +\bo    A GNU system: GNU LilyPond is known to run on these
  27             GNU systems: Linux, AIX, Digital Unix and Solaris.
  28
  29             If you have the Cygnus WINDOWS32 port of the GNU
  30             utils, it will even work in Windows NT/95, but we
  31             don't promise to support it.
  32
  33        +\bo    GNU C++ v2.7 or better, with libg++ installed.
  34             Version 2.7.2 or better recommended.
  35
  36        +\bo    GNU make.
  37
  38        +\bo    Flex (2.5.1 or better).
  39
  40        +\bo    Bison. (Version 1.25 or better)
  41
  42 R\bR\bR\bRU\bU\bU\bUN\bN\bN\bNN\bN\bN\bNI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
  43        GNU LilyPond does use a lot of resources. For operation
  44        you need the following:
  45
  46        +\bo    TeX
  47
  48        +\bo    A PostScript printer and/or viewer (such as
  49             Ghostscript).
  50
  51 R\bR\bR\bRE\bE\bE\bEC\bC\bC\bCO\bO\bO\bOM\bM\bM\bMM\bM\bM\bME\bE\bE\bEN\bN\bN\bND\bD\bD\bDE\bE\bE\bED\bD\bD\bD
  52        Although not strictly necessary, these are recommended to
  53        have.
  54
  55        +\bo    Perl-5.  Most documentation was created with the
  56             perl's Plain Old Documentation. (I use 5.003)
  57
  58        +\bo    Python.  Although perl is nice, python is better.  We
  59             will shift towards python for build scripts
  60
  61
  62
  63
  64 5/Jan/98                 LilyPond 0.1.39                        1
  65
  66
  67
  68
  69
  70 INSTALL(1)            LilyPond documentation           INSTALL(1)
  71
  72
  73        +\bo    GNU find
  74
  75        +\bo    A fast computer (a full page of music typically takes
  76             1 minute on my 486/133, using the -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-c\bc\bc\bch\bh\bh\bhe\be\be\bec\bc\bc\bck\bk\bk\bki\bi\bi\bin\bn\bn\bng\bg\bg\bg
  77             compile. It's lot slower than most MusiXTeX
  78             preprocessors)
  79
  80 C\bC\bC\bCO\bO\bO\bON\bN\bN\bNF\bF\bF\bFI\bI\bI\bIG\bG\bG\bGU\bU\bU\bUR\bR\bR\bRI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG a\ba\ba\ban\bn\bn\bnd\bd\bd\bd C\bC\bC\bCO\bO\bO\bOM\bM\bM\bMP\bP\bP\bPI\bI\bI\bIL\bL\bL\bLI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
  81        to install GNU LilyPond, simply type:
  82
  83                configure
  84                make install
  85
  86        This will install the following files:
  87
  88                /usr/local/man/man1/mi2mu.1
  89                /usr/local/man/man1/convert-mudela.1
  90                /usr/local/man/man1/mudela-book.1
  91                /usr/local/man/man1/lilypond.1
  92                /usr/local/lib/libflower.{so,a}
  93                /usr/local/bin/lilypond
  94                /usr/local/bin/mi2mu
  95                /usr/local/share/lilypond/*
  96                /usr/lib/texmf/texmf/tex/lilypond/*
  97
  98        The TeX include directory is detected dynamically, but it
  99        can be adjusted with -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-t\bt\bt\bte\be\be\bex\bx\bx\bx-\b-\b-\b-p\bp\bp\bpr\br\br\bre\be\be\bef\bf\bf\bfi\bi\bi\bix\bx\bx\bx and -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-t\bt\bt\bte\be\be\bex\bx\bx\bx-\b-\b-\b-
 100        d\bd\bd\bdi\bi\bi\bir\br\br\br. The above assumes that you are root and have the GNU
 101        development tools, and your make is GNU make.  If this is
 102        not the case, you can adjust your environment variables to
 103        your taste:
 104
 105                export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
 106                configure
 107
 108        CPPFLAGS are the preprocessor flags.
 109
 110        the configure script is Cygnus configure, and it will
 111        accept -\b-\b-\b--\b-\b-\b-h\bh\bh\bhe\be\be\bel\bl\bl\blp\bp\bp\bp. If you are not root, you will probably have
 112        to make it with
 113
 114                configure --prefix=/home/me_myself_and_I/
 115
 116        In this case, you will have to set MFINPUTS, and TEXINPUTS
 117        accordingly.
 118
 119        If you want to install GNU LilyPond in _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl, and
 120        your TeX has no default hooks for local stuff (mine is
 121        broken too), you can do:
 122
 123                configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
 124
 125        Since GNU LilyPond currently is beta, you are advised to
 126        also use
 127
 128
 129
 130 5/Jan/98                 LilyPond 0.1.39                        2
 131
 132
 133
 134
 135
 136 INSTALL(1)            LilyPond documentation           INSTALL(1)
 137
 138
 139                --enable-debugging
 140                --enable-checking
 141
 142        other options include:
 143
 144        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-s\bs\bs\bsh\bh\bh\bha\ba\ba\bar\br\br\bre\be\be\bed\bd\bd\bd
 145            Make a shared library (gnu/linux, solaris (?) only )
 146
 147        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-p\bp\bp\bpr\br\br\bri\bi\bi\bin\bn\bn\bnt\bt\bt\bti\bi\bi\bin\bn\bn\bng\bg\bg\bg
 148            Enable debugging print routines (lilypond -\b-\b-\b-d\bd\bd\bd option)
 149
 150        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-o\bo\bo\bop\bp\bp\bpt\bt\bt\bti\bi\bi\bim\bm\bm\bmi\bi\bi\bis\bs\bs\bse\be\be\be
 151            Set maximum optimisation: compile with -\b-\b-\b-O\bO\bO\bO2\b2\b2\b2
 152
 153        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-p\bp\bp\bpr\br\br\bro\bo\bo\bof\bf\bf\bfi\bi\bi\bil\bl\bl\bli\bi\bi\bin\bn\bn\bng\bg\bg\bg
 154            Compile with support for profiling
 155
 156        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-t\bt\bt\bte\be\be\bex\bx\bx\bx-\b-\b-\b-p\bp\bp\bpr\br\br\bre\be\be\bef\bf\bf\bfi\bi\bi\bix\bx\bx\bx
 157            Set the directory where TeX and Metafont live
 158
 159        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-t\bt\bt\bte\be\be\bex\bx\bx\bx-\b-\b-\b-d\bd\bd\bdi\bi\bi\bir\br\br\br
 160            Set then directory TeX input is in (detected as a
 161            subdir of tex-prefix)
 162
 163        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-m\bm\bm\bmf\bf\bf\bf-\b-\b-\b-d\bd\bd\bdi\bi\bi\bir\br\br\br
 164            Set the directory mf input is in (idem)
 165
 166        -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-o\bo\bo\bou\bu\bu\but\bt\bt\bt-\b-\b-\b-d\bd\bd\bdi\bi\bi\bir\br\br\br
 167            Set the directory for machine generated output.
 168
 169        All options are documented in the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be help The
 170        option -\b-\b-\b--\b-\b-\b-e\be\be\ben\bn\bn\bna\ba\ba\bab\bb\bb\bbl\bl\bl\ble\be\be\be-\b-\b-\b-o\bo\bo\bop\bp\bp\bpt\bt\bt\bti\bi\bi\bim\bm\bm\bmi\bi\bi\bis\bs\bs\bse\be\be\be 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 _\bo_\bu_\bt_\b/ (which contain all files generated
 180        during compilation).
 181
 182        B\bB\bB\bBu\bu\bu\bui\bi\bi\bil\bl\bl\bld\bd\bd\bdi\bi\bi\bin\bn\bn\bng\bg\bg\bg f\bf\bf\bfo\bo\bo\bor\br\br\br m\bm\bm\bmu\bu\bu\bul\bl\bl\blt\bt\bt\bti\bi\bi\bip\bp\bp\bpl\bl\bl\ble\be\be\be h\bh\bh\bho\bo\bo\bos\bs\bs\bst\bt\bt\bts\bs\bs\bs
 183
 184        LilyPond does not follow the GNU standards when it comes
 185        to configuring and making Makefiles. In LilyPond, _\bm_\ba_\bk_\be
 186        generates _\ba_\bl_\bl output in output directories (called _\bo_\bu_\bt_\b/,
 187        by default).  You can have multiple compiles from the same
 188        source-tree, by overriding the setting for the output
 189        directory.
 190
 191        Example: on my system, I do debugging and lots compiling.
 192        For this I use the configuration as follows:
 193
 194
 195
 196 5/Jan/98                 LilyPond 0.1.39                        3
 197
 198
 199
 200
 201
 202 INSTALL(1)            LilyPond documentation           INSTALL(1)
 203
 204
 205                configure --prefix=~ --enable-debugging --enable-printing --enable-checking
 206                make all
 207
 208        and I want to do profiling. For that I use
 209
 210                configure --prefix=~ --enable-debugging --disable-printing\
 211                        --disable-checking --enable-profiling --enable-optimise\
 212                        --enable-out-dir=out-profile
 213
 214                make OUTDIR_NAME=out-profile all
 215
 216        These two commands build two entirely separate versions of
 217        LilyPond. In Real Life, you would probably also want to
 218        have two different prefixes. On my machine this is no
 219        problem; I never do make install. My prefix dirs are
 220        linked back to my source directory.
 221
 222 I\bI\bI\bIN\bN\bN\bNS\bS\bS\bST\bT\bT\bTA\bA\bA\bAL\bL\bL\bLL\bL\bL\bLI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
 223        If you have done a successful make, then a simple
 224
 225                make install
 226
 227        should do the trick.
 228
 229 C\bC\bC\bCA\bA\bA\bAV\bV\bV\bVE\bE\bE\bEA\bA\bA\bAT\bT\bT\bTS\bS\bS\bS
 230        +\bo    The -O2 option to gcc triggers a gcc bug on DEC Alpha
 231             in dstream.cc. You should turn off this flag for this
 232             file.
 233
 234        +\bo    Perl5.003 and Perl5.004 use different syntax for
 235             pod2html.
 236
 237 E\bE\bE\bEX\bX\bX\bXA\bA\bA\bAM\bM\bM\bMP\bP\bP\bPL\bL\bL\bLE\bE\bE\bE
 238        This is what I type in my xterm:
 239
 240                lilypond someinput.ly
 241                tex someinput.tex
 242                xdvi someinput&
 243
 244        This is what the output looks like over here:
 245
 246                GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
 247                Parsing ... [/home/hw/share/lilypond/init//
 248                        <..etc..>
 249                        init//performer.ly]]][input/kortjakje.ly]
 250                Creating elements ...[8][16][24][25]
 251                Preprocessing elements...
 252                Calculating column positions ... [14][25]
 253                Postprocessing elements...
 254                TeX output to someinput.tex ...
 255                Creating MIDI elements ...MIDI output to someinput.midi ...
 256
 257                hw:~/musix/spacer$ xdvi someinput&
 258                [1] 855
 259
 260
 261
 262 5/Jan/98                 LilyPond 0.1.39                        4
 263
 264
 265
 266
 267
 268 INSTALL(1)            LilyPond documentation           INSTALL(1)
 269
 270
 271        Check out the input files, some of them have comments
 272        Please refer to the man page for more information.
 273
 274 R\bR\bR\bRE\bE\bE\bED\bD\bD\bDH\bH\bH\bHA\bA\bA\bAT\bT\bT\bT L\bL\bL\bLI\bI\bI\bIN\bN\bN\bNU\bU\bU\bUX\bX\bX\bX
 275        RedHat Linux users should be able to get a RPM. A spec
 276        file is in _\bm_\ba_\bk_\be_\b/_\bo_\bu_\bt_\b/_\bl_\bi_\bl_\by_\bp_\bo_\bn_\bd_\b._\bs_\bp_\be_\bc. You should be able to
 277        create an rpm as a normal user. Be sure you have a
 278        _\b~_\b/_\b._\br_\bp_\bm_\br_\bc, and edit the RPM-dir in _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs_\b._\bm_\ba_\bk_\be. (If you
 279        create the RPM as a normal user the permissions will not
 280        be set correctly, unfortunately)
 281
 282 D\bD\bD\bDE\bE\bE\bEB\bB\bB\bBI\bI\bI\bIA\bA\bA\bAN\bN\bN\bN G\bG\bG\bGN\bN\bN\bNU\bU\bU\bU/\b/\b/\b/L\bL\bL\bLI\bI\bI\bIN\bN\bN\bNU\bU\bU\bUX\bX\bX\bX
 283        A Debian package is also available; contact Anthony Fok
 284        <foka@debian.org>.  The build scripts are in the
 285        subdirectory debian/
 286
 287 W\bW\bW\bWI\bI\bI\bIN\bN\bN\bND\bD\bD\bDO\bO\bO\bOW\bW\bW\bWS\bS\bS\bS N\bN\bN\bNT\bT\bT\bT/\b/\b/\b/9\b9\b9\b95\b5\b5\b5
 288        So, you're stuck with Windows, eh?  Well, don't worry, you
 289        just need (to get) Cygnus' windows32 port of gnu
 290        development stuff; have a look at
 291        http://www.cygnus.com/gnu-win32.
 292
 293        To make GNU LilyPond under, brr, aargh, shudder...
 294        windows32, well, simply type:
 295
 296                bash configure
 297                make
 298
 299        N\bN\bN\bNo\bo\bo\bot\bt\bt\bte\be\be\be If you rely on broken DOS/Windows tools such as
 300        pkzip/WinZIP to unpack the distribution, make sure the
 301        e\be\be\ben\bn\bn\bnt\bt\bt\bti\bi\bi\bir\br\br\bre\be\be\be source tree is unpacked correctly, in particular
 302        the empty out directories (_\bf_\bl_\bo_\bw_\be_\br_\b/_\bo_\bu_\bt, _\bl_\bi_\bb_\b/_\bo_\bu_\bt et. al.)
 303
 304 M\bM\bM\bMU\bU\bU\bUS\bS\bS\bSI\bI\bI\bIX\bX\bX\bXT\bT\bT\bTE\bE\bE\bEX\bX\bX\bX
 305        Previous versions (before 0.1.39) used fonts from the TeX
 306        macro package "MusixTeX".  You can still use these, but
 307        they are not supported.  Since LilyPond's Feta font is
 308        much prettier, you'd be stupid to use them, but anyway,
 309        here are the installation instructions for those
 310        deprecated fonts.
 311
 312        [obsolete] I use the MusixTeX fonts those found in
 313        MusixTeX T.73. Beware, the clef symbol seems to have
 314        changed its position in some versions, (notably Egler's,
 315        a.k.a. OpusTeX). The MusixTeX fonts are included in
 316        MusixTeX (T73 or better), which can be had from any CTAN
 317        site, e.g. at
 318
 319        ftp://ftp.shsu.edu/tex-archive/macros/musixtex/taupin
 320
 321        ftp://ftp.tex.ac.uk/tex-archive/macros/musixtex/taupin
 322
 323        ftp://ftp.dante.de/tex-archive/macros/musixtex/taupin
 324
 325
 326
 327
 328 5/Jan/98                 LilyPond 0.1.39                        5
 329
 330
 331
 332
 333
 334 INSTALL(1)            LilyPond documentation           INSTALL(1)
 335
 336
 337        You only need the contents of the _\bm_\bf_\b/ subdirectory of the
 338        package. The primary site of the Taupin version is
 339        ftp://hprib.lps.u-psud.fr/pub/music_zips/musixtex.zip
 340
 341        Install the musixtex fonts in a directory which TeX and MF
 342        knows (if you are root, look for a directory which
 343        contains the directories with AMS and CM source (*.mf)
 344        files. Create a subdir lilypond or musixtex and copy the
 345        fonts into that). Do not forget to rehash TeX (if
 346        applicable)
 347
 348        Example: my fonts are in
 349        _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl_\b/_\bl_\bi_\bb_\b/_\bt_\be_\bx_\bf_\bo_\bn_\bt_\bs_\b/_\bm_\bu_\bs_\bi_\bx_\bt_\be_\bx_\b/, and I have a symlink
 350        pointing to that in
 351        _\b/_\bu_\bs_\br_\b/_\bl_\bi_\bb_\b/_\bt_\be_\bx_\bm_\bf_\b/_\bt_\be_\bx_\bm_\bf_\b/_\bf_\bo_\bn_\bt_\bs_\b/_\bs_\bo_\bu_\br_\bc_\be_\b/_\bp_\bu_\bb_\bl_\bi_\bc_\b/. After I copied
 352        the files, I ran "texhash"
 353
 354        Andreas Egler's version of MusixTeX, now called OpusTeX,
 355        will also work. Andreas moved some characters around in
 356        the fonts, so you have to edit the definitions in
 357        _\bt_\be_\bx_\b/_\be_\bg_\bl_\be_\br_\bd_\be_\bf_\bs_\b._\bt_\be_\bx.
 358
 359 A\bA\bA\bAU\bU\bU\bUT\bT\bT\bTH\bH\bH\bHO\bO\bO\bOR\bR\bR\bRS\bS\bS\bS
 360        Han-Wen Nienhuys <hanwen@stack.nl>
 361
 362        Jan Nieuwenhuizen <jan@digicash.com>
 363
 364        Have fun!
 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 5/Jan/98                 LilyPond 0.1.39                        6
 395
 396