Documentation/INSTALL.pod

   1 =head1 NAME
   2
   3 INSTALL - installing LilyPond
   4
   5 =head1 DESCRIPTION
   6
   7 This page documents installation  and compilation of 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 Unix. LilyPond is known to run on Linux, AIX, Digital Unix and
  26 Solaris
  27
  28 If you have the Cygnus WIN32 port of the GNU utils, it will
  29 even work in Lose NT/95, but don't promise to support it.
  30
  31 =item *
  32 GNU C++ v2.7 or better, with libg++ installed.  Version 2.7.2
  33 or better recommended. I almost positive that it will not compile with
  34 AT&T CC.
  35
  36 =item *
  37 Bash. Most scripts will continue to work with a stock sh, but they
  38 will generate (harmless) syntax errors
  39
  40 =item *
  41 GNU make.
  42
  43 =item *
  44 Flex (2.5.1 or better).
  45
  46 =item *
  47 Bison.
  48
  49 =back
  50
  51 =head1 RECOMMENDED
  52
  53 =over 5
  54
  55 =item *
  56 Perl.  Some (mostly unimportant scripts) use Perl for trivial
  57 operations. The documentation was created with the perl's Plain Old
  58 Documentation.
  59
  60 =item *
  61 (GNU) find
  62
  63 =back
  64
  65
  66
  67 =head1 CONFIGURING and COMPILING
  68
  69 to install LilyPond, simply type:
  70
  71         configure
  72         make install
  73
  74 This will install the following files:
  75
  76         /usr/local/man/man1/lilypond.1
  77         /usr/local/bin/lilypond
  78         /usr/local/bin/mi2mu
  79         /usr/local/share/lilypond/*
  80         /usr/lib/texmf/texmf/tex/lilypond/*
  81
  82 The TeX include directory is detected dynamically, but it can be
  83 adjusted with B<--enable-texprefix>. The above assumes that you are root and
  84 have the gnu
  85 development tools, and your make is gnu make.  If this is not the
  86 case, you can adjust your environment variables to your taste:
  87
  88         CXXFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR" configure
  89
  90 the configure script is Cygnus configure, and it will accept
  91 B<--help>. If you are not root, you will probably have to make it with
  92
  93         configure --prefix=/home/me_myself_and_I/
  94
  95 Since LilyPond currently is beta, You are advised to also use
  96
  97         --enable-debug
  98         --enable-checking
  99
 100 other options include:
 101
 102         --enable-printing
 103         --enable-optimise
 104         --enable-profiling
 105
 106 The option B<--enable-optimise> is recommended for Real Life usage.
 107
 108 If you do
 109
 110         make all
 111
 112 everything will be compiled, but nothing will be installed.  The
 113 resulting binaries can be found in the subdirectory
 114 F<bin/>.
 115
 116 =head1 RUNNING
 117
 118 LilyPond does use a lot of resources. For operation you need the following:
 119
 120
 121 =over 5
 122
 123 =item *
 124 A fast computer (a full page of music typically takes 1 minute
 125 on my 486/66, using the B<--enable-checking> compile. It's lot slower
 126 than most MusiXTeX preprocessors)
 127
 128 =item *
 129 TeX
 130
 131 =item *
 132 The MusixTeX fonts. (I use those found in MusixTeX
 133 T.59)
 134
 135 =back
 136
 137 Please refer to the man page for more information.
 138
 139 =head1 REDHAT LINUX
 140
 141 RedHat Linux users should be able to get a RPM. A spec file is in
 142 F<make/lilypond.spec>.
 143
 144
 145 =head1 WINDOZE
 146
 147 Windows NT:
 148
 149 you need the cygnus win32 gnu port development stuff; have a look
 150 at http://www.cygnus.com/gnu-win32.
 151
 152 to make LilyPond under, brr, aargh, well, simply type:
 153
 154         bash configure
 155         make win32
 156
 157 =head1 PLATFORMS
 158
 159 LilyPond (pl 0.0.39) is known to compile on the following platforms:
 160
 161         * linux 2.0.28, g++ 2.7.2[.1]
 162         * aix 4.1, g++ 2.7.2
 163         * windows-nt 4.0, cygnus gnu-win32 beta17.1 (~=g++ 2.7.2)
 164         * linux 2.0.28 X to doze, gcc-go32 (~=g++ 2.7.2) [exec. untested]
 165
 166 =head1 AUTHORS
 167
 168         Han-Wen Nienhuys <hanwen@stack.nl>
 169
 170         Jan Nieuwenhuizen <jan@digicash.com>
 171
 172
 173 Have fun!