release: 0.1.18

[lilypond.git] / INSTALL.text

INSTALL(1)            LilyPond documentation           INSTALL(1)


N\bN\bN\bNA\bA\bA\bAM\bM\bM\bME\bE\bE\bE
       INSTALL - installing GNU LilyPond

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
       This page documents installation and compilation of GNU
       LilyPond

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
       You do something which looks remotely like

               configure
               make
               make install
               tar -C /usr/lib/texmf/fonts/source/ -zxf musixtex-T73.tgz 'mf/*'

       The detailed instructions follow here.


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
       For compilation you need.

       +\bo    A Unix system with GNU tools. GNU LilyPond is known
            to run on these unices: Linux, AIX, Digital Unix and
            Solaris.

            If you have the Cygnus WINDOWS32 port of the GNU
            utils, it will even work in Windows NT/95, but we
            don't promise to support it.

       +\bo    GNU C++ v2.7 or better, with libg++ installed.
            Version 2.7.2 or better recommended.

       +\bo    GNU make.

       +\bo    Flex (2.5.1 or better).

       +\bo    Bison. (Version 1.25 or better)

R\bR\bR\bRU\bU\bU\bUN\bN\bN\bNN\bN\bN\bNI\bI\bI\bIN\bN\bN\bNG\bG\bG\bG
       GNU LilyPond does use a lot of resources. For operation
       you need the following:

       +\bo    TeX

       +\bo    The MusixTeX fonts (I included those found in
            MusixTeX T.73). Beware, the clef symbol seems to have
            changed its position in some versions, (notably
            Egler's, a.k.a. OpusTeX). The MusixTeX fonts are
            included in MusixTeX (T73 or better), which can be
            had from any CTAN site, e.g. at

       ftp://ftp.shsu.edu/tex-archive/macros/musixtex/taupin





26/Sep/97                LilyPond 0.1.18                        1





INSTALL(1)            LilyPond documentation           INSTALL(1)


       ftp://ftp.tex.ac.uk/tex-archive/macros/musixtex/taupin

       ftp://ftp.dante.de/tex-archive/macros/musixtex/taupin

                You only need the contents of the _\bm_\bf_\b/
                subdirectory of the package. The primary site of
                the Taupin version is ftp://hprib.lps.u-
                psud.fr/pub/music_zips/musixtex.zip

                Andreas Egler's version of MusixTeX, now called
                OpusTeX, will also work. Andreas moved some
                characters around in the fonts, so you have to
                edit the definitions in tex/eglerdefs.tex (patch
                appreciated)

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
       Although not strictly necessary, these are recommended to
       have.

       +\bo         Perl-5.  Most scripts are written in Perl. Most
                 documentation was created with the perl's Plain
                 Old Documentation. (I use 5.003)

       +\bo         Python.  Although perl is nice, python is
                 better.  We will shift towards python for build
                 scripts

       +\bo         GNU find

       +\bo         A fast computer (a full page of music typically
                 takes 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 compile. It's lot slower than
                 most MusiXTeX preprocessors)

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
       to install GNU LilyPond, simply type:

               configure
               make install

       This will install the following files:

               /usr/local/man/man1/mi2mu.1
               /usr/local/man/man1/convert-mudela.1
               /usr/local/man/man1/mudela-book.1
               /usr/local/man/man1/lilypond.1
               /usr/local/lib/libflower.{so,a}
               /usr/local/bin/lilypond
               /usr/local/bin/mi2mu
               /usr/local/share/lilypond/*
               /usr/lib/texmf/texmf/tex/lilypond/*

       The TeX include directory is detected dynamically, but it
       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-



26/Sep/97                LilyPond 0.1.18                        2





INSTALL(1)            LilyPond documentation           INSTALL(1)


       d\bd\bd\bdi\bi\bi\bir\br\br\br. The above assumes that you are root and have the GNU
       development tools, and your make is GNU make.  If this is
       not the case, you can adjust your environment variables to
       your taste:

               export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
               configure

       CPPFLAGS are the preprocessor flags.

       the configure script is Cygnus configure, and it will
       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
       to make it with

               configure --prefix=/home/me_myself_and_I/

       In this case, you will have to set MFINPUTS, and TEXINPUTS
       accordingly.

       If you want to install GNU LilyPond in _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl, and
       your TeX has no default hooks for local stuff (mine is
       broken too), you can do:

               configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf

       Since GNU LilyPond currently is beta, you are advised to
       also use

               --enable-debugging
               --enable-checking

       other options include:

       --enable-shared
                Make a shared library (gnu/linux, solaris (?)
                only )

       --enable-printing
                Enable debugging print routines (lilypond -\b-\b-\b-d\bd\bd\bd
                option)

       --enable-optimise
                Set maximum optimisation: compile with -\b-\b-\b-O\bO\bO\bO2\b2\b2\b2

       --enable-profiling
                Compile with support for profiling

       --enable-tex-prefix
                Set the directory where TeX and Metafont live

       --enable-tex-dir
                Set then directory TeX input is in (detected as a
                subdir of tex-prefix)




26/Sep/97                LilyPond 0.1.18                        3





INSTALL(1)            LilyPond documentation           INSTALL(1)


       --enable-mf-dir
                Set the directory mf input is in (idem)
                [obsolete]

       --enable-out-dir
                Set the directory for machine generated output.

                All options are documented in the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be help
                The 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 usage.

                If you do

                        make all

                everything will be compiled, but nothing will be
                installed.  The resulting binaries can be found
                in the subdirectories _\bo_\bu_\bt_\b/ (which contain all
                files generated during compilation).

       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

       LilyPond does not follow the GNU standards when it comes
       to configuring and making Makefiles. In LilyPond, _\bm_\ba_\bk_\be
       generates _\ba_\bl_\bl output in output directories (called _\bo_\bu_\bt_\b/,
       by default).  You can have multiple compiles from the same
       source-tree, by overriding the setting for the output
       directory.

       Example: on my system, I do debugging and lots compiling.
       For this I use the configuration as follows:

               configure --prefix=~ --enable-debugging --enable-printing --enable-checking
               make all

       and I want to do profiling. For that I use

               configure --prefix=~ --enable-debugging --disable-printing\
                       --disable-checking --enable-profiling --enable-optimise\
                       --enable-out-dir=out-profile

               make OUTDIR_NAME=out-profile all

       These two commands build two entirely separate versions of
       LilyPond. In Real Life, you would probably also want to
       have two different prefixes. On my machine this is no
       problem; I never do make install. My prefix dirs are
       linked back to my source directory.

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
       If you have done a successful make, then a simple

               make install




26/Sep/97                LilyPond 0.1.18                        4





INSTALL(1)            LilyPond documentation           INSTALL(1)


       should do the trick.

       Install the musixtex fonts in a directory which TeX and MF
       knows (if you are root, look for a directory which
       contains the directories with AMS and CM source (*.mf)
       files. Create a subdir lilypond or musixtex and copy the
       fonts into that). Do not forget to rehash TeX (if
       applicable)

       Example: my fonts are in
       _\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
       pointing to that in
       _\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
       the files, I ran "texhash"

C\bC\bC\bCA\bA\bA\bAV\bV\bV\bVE\bE\bE\bEA\bA\bA\bAT\bT\bT\bTS\bS\bS\bS
       +\bo         The -O2 option to gcc triggers a gcc bug on DEC
                 Alpha in dstream.cc. You should turn off this
                 flag for this file.

       +\bo         Perl5.003 and Perl5.004 use different syntax for
                 pod2html:

E\bE\bE\bEX\bX\bX\bXA\bA\bA\bAM\bM\bM\bMP\bP\bP\bPL\bL\bL\bLE\bE\bE\bE
       This is what I type in my xterm:

               lilypond someinput.ly
               tex lelie.tex
               xdvi test&

       This is what the output looks like over here:

               GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
               Parsing ... [/home/hw/share/lilypond/init//
                       <..etc..>
                       init//performer.ly]]][input/kortjakje.ly]
               Creating elements ...[8][16][24][25]
               Preprocessing elements...
               Calculating column positions ... [14][25]
               Postprocessing elements...
               TeX output to lelie.tex ...
               Creating MIDI elements ...MIDI output to lelie.midi ...

               hw:~/musix/spacer$ xdvi lelie&
               [1] 855

       Check out the input files, some of them have comments
       Please refer to the man page for more information.

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
       RedHat Linux users should be able to get a RPM. A spec
       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
       create an rpm as a normal user. Be sure you have a
       ~/.rpmrc, and edit the RPM-dir in _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs_\b._\bm_\ba_\bk_\be. (If you



26/Sep/97                LilyPond 0.1.18                        5





INSTALL(1)            LilyPond documentation           INSTALL(1)


       create the RPM as a normal user the permissions will not
       be set correctly, unfortunately)

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
       A Debian package is in the works

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
       So, you're stuck with Windows, eh?  Well, don't worry, you
       just need (to get) Cygnus' windows32 port of gnu
       development stuff; have a look at
       http://www.cygnus.com/gnu-win32.

       To make GNU LilyPond under, brr, aargh, shudder...
       windows32, well, simply type:

               bash configure
               make


A\bA\bA\bAU\bU\bU\bUT\bT\bT\bTH\bH\bH\bHO\bO\bO\bOR\bR\bR\bRS\bS\bS\bS
       Han-Wen Nienhuys <hanwen@stack.nl>

       Jan Nieuwenhuizen <jan@digicash.com>

       Have fun!
































26/Sep/97                LilyPond 0.1.18                        6