]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/topdocs/INSTALL.yo
release: 1.1.1
[lilypond.git] / Documentation / topdocs / INSTALL.yo
index 19716b51d68d91cbf4d06a76f4eb8df28fb09c65..54147f74e19a612023899c00aee23dc20c92d5ba 100644 (file)
@@ -24,16 +24,25 @@ it()A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
     (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
 Solaris.
 
+it()Lots of disk space: LilyPond takes between 50 and 100 mb to
+compile if you use debugging information.  If you are short on
+disk-space run configure with code(--disable-debugging).
+
 Although we recommend to use Unix, LilyPond is known to run on Windows
 NT/95/98 as well.  See Section ref(w32).
 
 it() GNU C++ version 2.7 or newer (2.8 and egcs are also fine).
-it() Python 1.5
+it() Python 1.5 (Strictly speaking, you shouldn't need Python for 
+   compiling and installing, but you'll need it to regenerate the font
+   tables, e.g.). 
+
+it() GUILE 1.3 (no, GUILE 1.2 won't work)
 )
 
 sect(RUNNING)
 
-GNU LilyPond does use a lot of resources. For operation you need the following:
+GNU LilyPond does use a lot of resources. For operation you need the
+following:
 
 itemize(
 it()TeX
@@ -42,21 +51,57 @@ it()A PostScript printer and/or viewer (such as Ghostscript) is strongly
     Ghostscript installed.
 )
 
+
+For running LilyPond successfully you have to help TeX and MetaFont
+find various files.  The recommended way of doing so is adjusting the
+environment variables in the start-up scripts of your shell.  An
+example is given here for the Bourne shell:
+verb(export MFINPUTS="/usr/local/share/lilypond/mf:"
+export TEXINPUTS="/usr/local/share/lilypond/tex:"
+)
+The empty path component
+represents TeX() and MetaFont's default search paths.  Scripts with
+the proper paths for the bourne and C-shell respectively are generated in
+file(buildscripts/out/lilypond-profile) and
+file(buildscripts/out/lilypond-login) during compilation.
+
+
 sect(RECOMMENDED)
 
 Although not strictly necessary, these are recommended to have.
 
 itemize(
 it()GNU make. 
+Check out lurl(ftp://ftp.gnu.org)
+or any mirror of this site.
+
 it()Flex (version 2.5.4 or newer). 
+Check out lurl(ftp://ftp.gnu.org)
+or any mirror of this site.
 it()Bison (version 1.25 or newer).
-it()Python (version 1.5 or newer).
+Check out lurl(ftp://ftp.gnu.org)
+or any mirror of this site.
+
+it()GUILE (version 1.2)
+Check out lurl(http://www.gnu.org/programs/guile.html)
+
+it()Python (version 1.5 or newer).  Check out
+lurl(ftp://ftp.python.org) or lurl(ftp://ftp.cwi.nl/pub/python).
+
 it()Yodl.  All documentation will be in Yodl. (1.30.17)
 lurl(ftp://pcnov095.win.tue.nl/pub/yodl)
     lurl(http://www.cs.uu.nl/~hanwen/yodl)
 it()Texinfo. (version 3.12 or newer)
 
 it()GNU find
+Check out lurl(ftp://ftp.gnu.org)
+or any mirror of this site.
+
+it()The geometry package for LaTeX is needed to use ly2dvi.  
+    Available at 
+lurl(ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
+or at mirror site lurl(ftp://ftp.dante.de)
+
 it() A fast computer (a full page of music typically takes 1 minute on my
     486/133, using the bf(--enable-checking) compile. It's lot slower than
     most MusiXTeX preprocessors)
@@ -77,11 +122,26 @@ man2html can be had from lurl(http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Ne
     TeTeX users should not forget to rerun texhash.
 )
 
+Building the website requires pnmtopng.  The version of file(pnmtopng)
+that is distributed with RedHat 5.1 contains a bug (pnmtopng is
+dynamically linked to the wrong version of libpng).  Recompile it from
+source, and make sure that the pnmtopng binary is linked statically to
+the libpng that is included in libgr.
+
+verb( tar xzf libgr-2.0.13.tar.gz
+      make
+      cd png
+      rm libpng.so*
+      make pnmtopng
+)
+
+You can then install the new pnmtopng into /usr/local/bin/
+
 sect(CONFIGURING and COMPILING)
 
 to install GNU LilyPond, simply type:
 verb(
-       configure  --enable-tex-dir=XXXX --enable-mf-dir=YYYY
+       configure
        make
        make install
 )
@@ -96,17 +156,12 @@ verb(
        /usr/local/bin/mi2mu
        /usr/local/share/lilypond/*
        /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
-       /usr/lib/texmf/texmf/tex/lilypond/* 
 )
 
 
-You should specify directories that are in TeX()'s and MetaFont's
-include path with the options (--enable-tex-dir) and
-bf(--enable-mf-dir).  If you don't specify any directories, the TeX()
-include directory is detected dynamically, which is unreliable.  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:
+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:
 
 verb(
        export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR" 
@@ -125,13 +180,6 @@ verb(
 
 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
 
-If you want to install GNU LilyPond in file(/usr/local), and your TeX has
-no default hooks for local stuff, you can do:
-
-verb(
-       configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
-)
-
 Since GNU LilyPond currently is beta, you are advised to also use
 
 verb(
@@ -139,29 +187,18 @@ verb(
        --enable-checking
 )
 
-Other options include:
+Options to configure include:
 
 description(
-dit(bf(--enable-shared))
-    Make a shared library (gnu/linux, solaris (?) only )  (TEMPORARILY
-OUT OF ORDER)
-
+dit(bf(--enable-guile))
+    Link in GUILE (experimental)
 dit(bf(--enable-printing))
     Enable debugging print routines (lilypond bf(-D) option)
 dit(bf(--enable-optimise))
-    Set maximum optimisation: compile with bf(-O2)
+    Set maximum optimisation: compile with bf(-O2).  This can be
+unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
 dit(bf(--enable-profiling))
     Compile with support for profiling.
-dit(bf(--enable-tex-prefix))
-    Set the directory where TeX and Metafont live.
-dit(bf(--enable-tex-dir))
-    Set then directory TeX input is in (detected as a subdir of
-    tex-prefix).  This should be a directory that is reachable both for
-    tex and latex.  On my system the best choice would be
-    file(/usr/lib/texmf/texmf/tex/generic//).
-dit(bf(--enable-mf-dir))
-    Set the directory metafont input is in (idem).   On my system the best
-    choice would be file(/usr/lib/texmf/texmf/fonts/source/public/).
 dit(bf(--enable-config))
     Output to a different configuration file.  Needed for multi-platform
     builds
@@ -197,8 +234,8 @@ and for the profiling version, I specify a different configuration.
 
 verb(
       configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
-      make configuration=optprof
-      make configuration=optprof install
+      make config=optprof
+      make config=optprof install
 )