Documentation/INSTALL.pod

   1 =head1 NAME
   2
   3 INSTALL - installing GNU LilyPond
   4
   5 =head1 DESCRIPTION
   6
   7 This page documents installation  and compilation of GNU LilyPond
   8
   9 =head1 IMPORTANT
  10
  11 if you have downloaded a
  12
  13         *.pre*
  14
  15 version, then this is version is I<not> meant for producing nice
  16 output, but to keep your patchsets up to date.  It might not even compile.
  17
  18 =head1 PREREQUISITES
  19
  20 For compilation you need.
  21
  22 =over 5
  23
  24 =item *
  25
  26 Unix. GNU LilyPond is known to run on Linux, AIX, Digital Unix and
  27 Solaris
  28
  29 If you have the Cygnus WIN32 port of the GNU utils, it will
  30 even work in Lose NT/95, but don't promise to support it.
  31
  32 =item *
  33
  34 GNU C++ v2.7 or better, with libg++ installed.  Version 2.7.2
  35 or better recommended. I almost positive that it will not compile with
  36 AT&T CC.
  37
  38 =item *
  39
  40 GNU make.
  41
  42 =item *
  43
  44 Flex (2.5.1 or better).
  45
  46 =item *
  47
  48 Bison.
  49
  50 =back
  51
  52 =head1 RECOMMENDED
  53
  54 =over 5
  55
  56 =item *
  57
  58 Perl.  Most scripts are written in Perl. The documentation was created
  59 with the perl's Plain Old Documentation.
  60
  61 =item *
  62 (GNU) find
  63
  64 =back
  65
  66
  67
  68 =head1 CONFIGURING and COMPILING
  69
  70 to install GNU LilyPond, simply type:
  71
  72         configure
  73         make install
  74
  75 This will install the following files:
  76
  77         /usr/local/man/man1/lilypond.1
  78         /usr/local/lib/libflower.{so,a}
  79         /usr/local/bin/lilypond
  80         /usr/local/bin/mi2mu
  81         /usr/local/share/lilypond/*
  82         /usr/lib/texmf/texmf/tex/lilypond/*
  83
  84 The TeX include directory is detected dynamically, but it can be
  85 adjusted with B<--enable-tex-prefix> and B<--enable-tex-dir>. The
  86 above assumes that you are root and have the gnu development tools,
  87 and your make is gnu make.  If this is not the case, you can adjust
  88 your environment variables to your taste:
  89
  90         export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
  91         configure
  92
  93 C<CPPFLAGS> are the preprocessor flags.
  94
  95 the configure script is Cygnus configure, and it will accept
  96 B<--help>. If you are not root, you will probably have to make it with
  97
  98         configure --prefix=/home/me_myself_and_I/
  99
 100 If you want to install GNU LilyPond in F</usr/local>, and your TeX has
 101 no default hooks for local stuff (mine is broken too), you can do:
 102
 103         configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
 104
 105 Since GNU LilyPond currently is beta, you are advised to also use
 106
 107         --enable-debug
 108         --enable-checking
 109
 110 other options include:
 111
 112         --enable-shared
 113         --enable-printing
 114         --enable-optimise
 115         --enable-profiling
 116         --enable-tex-prefix
 117         --enable-tex-dir
 118
 119 The option B<--enable-optimise> is recommended for Real Life usage.
 120
 121 If you do
 122
 123         make all
 124
 125 everything will be compiled, but nothing will be installed.  The
 126 resulting binaries can be found in the subdirectory
 127 F<bin/>.
 128
 129 =head1 INSTALLING
 130
 131 If you have done a successful C<make>, then a simple
 132
 133         make install
 134
 135 should do the trick. Install the musixtex fonts in a directory which
 136 TeX and MF knows. Do not forget to rehash TeX (if applicable)
 137
 138 =head1 RUNNING
 139
 140 GNU LilyPond does use a lot of resources. For operation you need the following:
 141
 142
 143 =over 5
 144
 145 =item *
 146
 147 A fast computer (a full page of music typically takes 1 minute
 148 on my 486/66, using the B<--enable-checking> compile. It's lot slower
 149 than most MusiXTeX preprocessors)
 150
 151 =item *
 152
 153 TeX
 154
 155 =item *
 156
 157 The MusixTeX fonts. (I use those found in MusixTeX T.59). Beware, the
 158 clef symbol has changed position in recent versions of MusixTeX)
 159
 160 =back
 161
 162 Please refer to the man page for more information.
 163
 164 =head1 REDHAT LINUX
 165
 166 RedHat Linux users should be able to get a RPM. A spec file is in
 167 F<make/lilypond.spec>. You should be able to create an rpm as a normal
 168 user. Be sure you have a ~/.rpmrc, and edit the RPM-dir in
 169 F<Variables.make>
 170
 171
 172 =head1 WINDOZE
 173
 174 Windows NT:
 175
 176 you need the cygnus win32 gnu port development stuff; have a look
 177 at http://www.cygnus.com/gnu-win32.
 178
 179 to make GNU LilyPond under, brr, aargh, well, simply type:
 180
 181         bash configure
 182         make win32
 183
 184 =head1 PLATFORMS
 185
 186 GNU LilyPond (pl 0.0.39) is known to compile on the following platforms:
 187
 188         * linux 2.0.x, g++ 2.7.2[.1]
 189         * aix 4.1, g++ 2.7.2
 190         * windows-nt 4.0, cygnus gnu-win32 beta17.1 (~=g++ 2.7.2)
 191         * linux 2.0.28 X to doze, gcc-go32 (~=g++ 2.7.2) [exec. untested]
 192
 193 =head1 AUTHORS
 194
 195 Han-Wen Nienhuys <hanwen@stack.nl>
 196
 197 Jan Nieuwenhuizen <jan@digicash.com>
 198
 199
 200 Have fun!