]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/topdocs/INSTALL.texi
release: 1.2.12
[lilypond.git] / Documentation / topdocs / INSTALL.texi
index 3ee7823855ccd8921dc36b4a766897d5c9fcf238..47e2a0277a9a0106a7bd8cfb045113d7a62b85ee 100644 (file)
@@ -4,33 +4,11 @@
 
 @node Top, , , (dir)
 @top
-@menu
-* INSTALL - compiling and installing GNU LilyPond::INSTALL - compiling and installing GNU LilyPond
-@end menu
-
-
-@node INSTALL - compiling and installing GNU LilyPond, abstract, , Top
-@menu
-* abstract::                      abstract
-* obtaining::                     obtaining
-* PREREQUISITES::                 PREREQUISITES
-* running::                       running
-* WEBSITE::                       WEBSITE
-* CONFIGURING and COMPILING::     CONFIGURING and COMPILING
-* CONFIGURING FOR MULTIPLE PLATFORMS::CONFIGURING FOR MULTIPLE PLATFORMS
-* INSTALLING::                    INSTALLING
-* REDHAT LINUX::                  REDHAT LINUX
-* DEBIAN GNU/LINUX::              DEBIAN GNU/LINUX
-* WINDOWS NT/95::                 WINDOWS NT/95
-* w32::                           w32
-* BUGS::                          BUGS
-* AUTHORS::                       AUTHORS
-@end menu
+
 @chapter INSTALL - compiling and installing GNU LilyPond
 
 
-@node abstract, obtaining, INSTALL - compiling and installing GNU LilyPond, INSTALL - compiling and installing GNU LilyPond
-@section abstract
+@section Abstract
 
 TODO: document xdeltas
 
@@ -41,18 +19,16 @@ e.g. when doing development, you might want to check out the
 variables and symlinks, which comes in handly when you have to compile 
 LilyPond more often.  
 
-@node obtaining, PREREQUISITES, abstract, INSTALL - compiling and installing GNU LilyPond
-@section obtaining
+@section Obtaining
 
 You can get the latest version of LilyPond at
-@url{ ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.  Refer to the links
+@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.  Refer to the links
 document for mirror sites.
 
 @emph{If you upgrade by patching do remember to rerun autoconf after
 applying the patch}.
 
-@node PREREQUISITES, running, obtaining, INSTALL - compiling and installing GNU LilyPond
-@section PREREQUISITES
+@section Prerequisites
 
 For compilation you need:
 
@@ -66,32 +42,32 @@ 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 @xref{w32}.
+NT/95/98 as well.  See Section Windows NT/95,es.
 
-@item  EGCS 1.1 or newer. Check out @url{ ftp://ftp.gnu.org/pub/gcc/}
+@item  EGCS 1.1 or newer. Check out @uref{ ftp://ftp.gnu.org/pub/gcc/, ftp://ftp.gnu.org/pub/gcc/}
 
 @item  Python 1.5,
 Check out
-@url{ftp://ftp.python.org} or @url{ftp://ftp.cwi.nl/pub/python}.
+@uref{ftp://ftp.python.org,ftp://ftp.python.org} or @uref{ftp://ftp.cwi.nl/pub/python,ftp://ftp.cwi.nl/pub/python}.
 
-@item  GUILE 1.3,  check out @url{http://www.gnu.org/software/guile/guile.html}.
+@item  GUILE 1.3,  check out @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
 
 @item GNU make. 
-Check out @url{ftp://ftp.gnu.org/make/}.
+Check out @uref{ftp://ftp.gnu.org/make/,ftp://ftp.gnu.org/make/}.
 
 @item Flex (version 2.5.4 or newer). 
-Check out @url{ftp://ftp.gnu.org/flex/}.
+Check out @uref{ftp://ftp.gnu.org/flex/,ftp://ftp.gnu.org/flex/}.
 
 @item Bison (version 1.25 or newer).
-Check out @url{ftp://ftp.gnu.org/bison/}.
+Check out @uref{ftp://ftp.gnu.org/bison/,ftp://ftp.gnu.org/bison/}.
 
-@item Texinfo. Check out @url{ftp://ftp.gnu.org/pub/texinfo/}.
+@item Texinfo. Check out @uref{ftp://ftp.gnu.org/pub/texinfo/,ftp://ftp.gnu.org/pub/texinfo/}.
 Most documentation is in texinfo.
 
 @item The geometry package for LaTeX is needed to use ly2dvi.  
 Available at 
-@url{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
-or at mirror site @url{ftp://ftp.dante.de}
+@uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
+or at mirror site @uref{ftp://ftp.dante.de,ftp://ftp.dante.de}
 
 @item MetaPost, if you want to use direct PostScript output. Please
 note  that  tetex-0.4pl8 (included with Redhat 5.x) does not include
@@ -99,8 +75,7 @@ note  that  tetex-0.4pl8 (included with Redhat 5.x) does not include
 
 @end itemize
 
-@node running, WEBSITE, PREREQUISITES, INSTALL - compiling and installing GNU LilyPond
-@section running
+@section Running
 
 GNU LilyPond does use a lot of resources. For operation you need the
 following software
@@ -110,7 +85,7 @@ following software
 @item A PostScript printer and/or viewer (such as Ghostscript) is strongly
     recommended.  Xdvi will show all embedded PostScript too if you have
     Ghostscript installed.
-@item  GUILE 1.3, check out @url{http://www.gnu.org/programs/guile.html}
+@item  GUILE 1.3, check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/programs/guile.html}
 @end itemize
 
 For running LilyPond successfully you have to help TeX and MetaFont
@@ -132,8 +107,7 @@ the proper paths for the bourne and C-shell respectively are generated in
 LilyPond is a hiddeously big, slow and bloated program.  A fast CPU
 and plenty of RAM is recommended for comfortable use.
 
-@node WEBSITE, CONFIGURING and COMPILING, running, INSTALL - compiling and installing GNU LilyPond
-@section WEBSITE
+@section Website
 
 The website is the most convenient form to use for reading the
 documentation on-line documentation. It is made by entering @example 
@@ -150,11 +124,11 @@ conversion tools.
 @item xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
             users: it is included within the package libgr-progs).
        the original is at
-@url{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz}
+@uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz}
 
 @item pnmtopng, which is also in libgr-progs for RedHat. The original is
 at
-@url{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz}.i
+@uref{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz,ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz}.i
 
 The version of @file{pnmtopng} that is distributed with RedHat 5.1 and
 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
@@ -174,9 +148,9 @@ problem.
 
 You can then install the new pnmtopng into @file{/usr/local/bin/}
 
-@item Bib2html @url{http://pertsserver.cs.uiuc.edu/~hull/bib2html.}
+@item Bib2html @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html.,http://pertsserver.cs.uiuc.edu/~hull/bib2html.}
     Which, in turn depends on man2html for proper installation.
-man2html can be had from @url{http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05}.
+man2html can be had from @uref{http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05,http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05}.
 
 The website will build without this utility, but you will not see our
 hypertextified bibliography.
@@ -188,8 +162,7 @@ hypertextified bibliography.
 You also have to install @file{buildscripts/out/ps-to-gifs} in a
 directory that is in the path.
 
-@node CONFIGURING and COMPILING, CONFIGURING FOR MULTIPLE PLATFORMS, WEBSITE, INSTALL - compiling and installing GNU LilyPond
-@section CONFIGURING and COMPILING
+@section configuring and compiling
 
 to install GNU LilyPond, simply type:
 @example 
@@ -231,8 +204,8 @@ adjust your environment variables to your taste:
 @code{CPPFLAGS} are the preprocessor flags. 
 
 The configure script is Cygnus configure, and it will accept
-@strong{--help}. If you are not root, you will probably have to make it
-with a different @strong{--prefix} option.  Our favourite location is
+@code{--help}. If you are not root, you will probably have to make it
+with a different @code{--prefix} option.  Our favourite location is
 
 @example 
 
@@ -254,20 +227,20 @@ Since GNU LilyPond currently is beta, you are advised to also use
 Options to configure include:
 
 @table @samp
-@item @strong{--enable-printing}
-    Enable debugging print routines (lilypond @strong{-D} option)
-@item @strong{--enable-optimise}
-    Set maximum optimisation: compile with @strong{-O2}.  This can be
+@item @code{--enable-printing}
+    Enable debugging print routines (lilypond @code{-D} option)
+@item @code{--enable-optimise}
+    Set maximum optimisation: compile with @code{-O2}.  This can be
 unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
-@item @strong{--enable-profiling}
+@item @code{--enable-profiling}
     Compile with support for profiling.
-@item @strong{--enable-config}
+@item @code{--enable-config}
     Output to a different configuration file.  Needed for multi-platform
     builds
 @end table
 
 All options are documented in the @file{configure} help
-The option @strong{--enable-optimise} is recommended for Real Life usage.
+The option @code{--enable-optimise} is recommended for Real Life usage.
 
 If you do
 
@@ -281,11 +254,10 @@ everything will be compiled, but nothing will be installed.  The
 resulting binaries can be found in the subdirectories @file{out/} (which
 contain all files generated during compilation).
 
-@node CONFIGURING FOR MULTIPLE PLATFORMS, INSTALLING, CONFIGURING and COMPILING, INSTALL - compiling and installing GNU LilyPond
-@section CONFIGURING FOR MULTIPLE PLATFORMS
+@section configuring for multiple platforms
 
 If you want to compile LilyPond with different configuration settings,
-then, you can use the @strong{--enable-config} option.  Example: suppose I
+then, you can use the @code{--enable-config} option.  Example: suppose I
 want to build with and   without profiling.  Then I'd use the
 following for the normal build, 
 
@@ -308,10 +280,9 @@ and for the profiling version, I specify a different configuration.
 @end example 
 
 
-@node INSTALLING, REDHAT LINUX, CONFIGURING FOR MULTIPLE PLATFORMS, INSTALL - compiling and installing GNU LilyPond
-@section INSTALLING
+@section Installing
 
-If you have done a successful @code{make}, then a simple
+if you have done a successful @code{make}, then a simple
 
 @example 
 
@@ -335,8 +306,7 @@ provided to do the work for you, see @file{bin/clean-fonts.sh}.
 @item  On PPC you need at least EGCS-1.1.2f.
 @end itemize
 
-@node REDHAT LINUX, DEBIAN GNU/LINUX, INSTALLING, INSTALL - compiling and installing GNU LilyPond
-@section REDHAT LINUX
+@section Redhat linux
 
 RedHat Linux users can compile an RPM. A spec file is in
 @file{make/out/lilypond.spec}, it is distributed along with the
@@ -351,8 +321,8 @@ You can make the rpm by issuing
 @end example 
 
 Precompiled i386 RedHat RPMS are available from
-@url{ftp://freshmeat.net/pub/rpms/lilypond/} and
-@url{http://linux.umbc.edu/software/lilypond/rpms/}.
+@uref{ftp://freshmeat.net/pub/rpms/lilypond/,ftp://freshmeat.net/pub/rpms/lilypond/} and
+@uref{http://linux.umbc.edu/software/lilypond/rpms/,http://linux.umbc.edu/software/lilypond/rpms/}.
 
 For compilation on a RedHat system you need these packages,
 in addition to the those needed for running:
@@ -365,30 +335,24 @@ in addition to the those needed for running:
 @item texinfo
 @end itemize
 
-@node DEBIAN GNU/LINUX, WINDOWS NT/95, REDHAT LINUX, INSTALL - compiling and installing GNU LilyPond
-@section DEBIAN GNU/LINUX
+@section Debian GNU/linux
 
 A Debian package is also available; contact Anthony Fok
 @email{foka@@debian.org}.  The build scripts are in the subdirectory
 @file{debian/}.
 
-@node WINDOWS NT/95, w32, DEBIAN GNU/LINUX, INSTALL - compiling and installing GNU LilyPond
-@section WINDOWS NT/95
-@node w32, BUGS, WINDOWS NT/95, INSTALL - compiling and installing GNU LilyPond
-
+@section Windows NT/95
 
-Separate instructions on building for W32 are available
-@url{../../outdir/README-W32.html}.
+Separate instructions on building for W32 are available; See file
+README-W32, included with the sources.
 
-@node BUGS, AUTHORS, w32, INSTALL - compiling and installing GNU LilyPond
-@section BUGS
+@section Bugs
 
 Send bug reports to bug-gnu-music@@gnu.org.  For help and questions use
 help-gnu-music@@gnu.org and gnu-music-discuss@@gnu.org.  Please consult
 the faq before mailing your problems.
 
-@node AUTHORS, Top, BUGS, INSTALL - compiling and installing GNU LilyPond
-@section AUTHORS
+@section Authors
 
 @email{hanwen@@cs.uu.nl, Han-Wen Nienhuys}