]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/topdocs/INSTALL.texi
* Documentation/topdocs/INSTALL.texi: give even more detailed orders.
[lilypond.git] / Documentation / topdocs / INSTALL.texi
index 9db4fcd3770ccd165f766d17fd190ec08a891296..7c34d3c6a3bc14f5a0c8776ff4057adc5e7141bd 100644 (file)
 
 @section Downloading
 
-Even numbered versions are `stable'. The webpages for the stable version
-(1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
-servers}. Big enhancements go into the latest odd numbered version
-(1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
-site}.
-
-Building LilyPond is an involved process. We advise to use binary
-packages if these are available for your platform.
-
+Even numbered versions are `stable' (2.0, 1.8 etc), while odd version
+are development releases (2.1, 1.9, etc).  Building LilyPond is an
+involved process, so if possible, download a precompiled binary from
+@uref{http://www.lilypond.org/,the lilypond site}.
 
 
 @subsection Source code
@@ -31,8 +26,7 @@ packages if these are available for your platform.
 Download source tarballs from here:
 @itemize @bullet
 @item Download development releases from
-@uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
-@uref{http://www.lilypond.org/ftp/} by HTTP.
+@uref{http://www.lilypond.org/download/} by HTTP.
 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror).
 @end itemize
 
@@ -44,7 +38,7 @@ Use Xdelta to patch tarballs, e.g. to patch
 @end example
 
 For information on packaging and CVS, see  
-@uref{http://lilypond.org/}, under ``develoment''.
+@uref{http://lilypond.org/}, under ``development''.
 
 
 @subsection Precompiled binaries
@@ -72,16 +66,14 @@ script automating this has been included, see
 You need the following packages to compile LilyPond:
 
 @itemize
-@item
- @uref{http://gcc.gnu.org/,
-The GNU c++ compiler} (version 3.1 or newer).
-EGCS and 2.x are known to cause crashes.
 
-@item @uref{http://www.python.org,Python} (version 2.1 or newer).
+@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
+newer),
 
-@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
+  You will need to install some additional packages to get mftrace to
+work.
 
-@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
+@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version 1.6.0 or newer).
 
 @item  @uref{http://www.gnu.org/software/flex/,Flex} (version 2.5.4a or newer). 
 
@@ -90,9 +82,6 @@ chokes on this.  If you wish to use GCC 3.x, make sure that your
 distribution supports g++ 3.x and flex.  For workarounds, see
 lexer-gcc-3.1.sh in the source directory.
 
-@item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
-newer, but not 1.50 or 1.75).
-
 @item @TeX{}.
 
 @TeX{} is used as an output backend.
@@ -102,7 +91,7 @@ Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
 (1.0.6 is known to work).  You may need to install a tetex-devel (or
 tetex-dev or libkpathsea-dev) package too.
 
-@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.2 or newer).
+@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.6 or newer).
 
 @item The
 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,geometry
@@ -112,12 +101,16 @@ package for LaTeX}.
 
 @item kpathsea, a library for searching (@TeX{}) files.
 
-@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.0.17 or
-newer),
+@item
+ @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.1 or
+newer).  EGCS and 2.x are known to cause crashes.
 
-  You will need to install some additional packages to get mftrace to
-work.
+@item @uref{http://www.python.org,Python} (version 2.1 or newer).
 
+@item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
+
+@item @uref{http://www.gnu.org/software/bison/,Bison} (version 1.25 or
+newer, but not 1.50 or 1.75).
 @end itemize
 
 @subsection Running requirements
@@ -131,8 +124,6 @@ following software:
 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} 1.6.0, or newer.
 @end itemize
 
-For running LilyPond successfully
-
 You have to help @TeX{} and MetaFont find LilyPond support
 files. After compiling, scripts to do this can be found in
 @file{buildscripts/out/lilypond-profile} and
@@ -151,7 +142,7 @@ documentation is built by issuing:
 Building the website requires some additional tools: 
 
 @itemize @bullet
-@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} see 
+@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities} 
 @item ImageMagick
 @end itemize
 
@@ -175,29 +166,14 @@ make install
 sh buildscripts/clean-fonts.sh      
 @end example 
 
-If, in addition, you want to generate PDF files of your scores and have 
-installed mftrace, type
-@example 
-make pfa-fonts
-make install-pfa-fonts
-texhash
-@end example 
-
-PFA versions of the fonts for the latest LilyPond version can also be
-obtained from the internet: download the .deb file that corresponds to
-your version, eg.  
+The most time-consuming part of compiling LilyPond is tracing the
+Type1 fonts. You can shortcut this operation by issuing
+one of the following commands:
 
 @example
-wget http://ftp.us.debian.org/debian/pool/main/l/lilypond/lilypond_1.8.0-1_i386.deb
-@c ar p lilypond_1.8.0-1_i386.deb data.tar.gz | tar -C / -zxf - '.*.pfa' '.*.map'
-ar x lilypond_1.8.0-1_i386.deb data.tar.gz
-tar -C / -zxf data.tar.gz /usr/share/lilypond/1.8.0/fonts/type1/
-tar -C / -zxf data.tar.gz /usr/share/lilypond/1.8.0/dvips/
-texhash
+  make -C mf get-pfa                # requires rpm2cpio
+  make -C mf get-debian-pfa         # may not be up to date   
 @end example
-If you are installing LilyPond somewhere else, unpack the appropriate
-files as shown, and move them to the appropriate paths. Of course, the
-.deb version number should correspond to what you are installing.
 
 If you are doing an upgrade, you should remove all @file{feta}
 @code{.pk} and @code{.tfm} files.  A script has been provided to do the
@@ -224,7 +200,7 @@ option of configure.  You should use @samp{make conf=CONF} to generate
 the output in @file{out-CONF}.  Example: Suppose I want to build with
 and without profiling.  Then I'd use the following for the normal
 build:
-@c prefix=~ ?
+
 @example 
        ./configure --prefix=$HOME/usr/ --enable-checking
        make
@@ -244,53 +220,70 @@ and for the profiling version, I specify a different configuration:
 @section Emacs mode
 
 An Emacs mode for entering music and running LilyPond is contained in
-the source archive as @file{lilypond-mode.el},
-@file{lilypond-indent.el}, @file{lilypond-font-lock.el} and
-@file{lilypond.words.el}.  You should install these files to a directory
-included in your @var{load-path}. File @file{lilypond-init.el} should
-be placed to @var{load-path}@file{/site-start.d/} or appended to your
-@file{~/.emacs} or @file{~/.emacs.el}.
+the source archive in the @file{elisp} directory.  @command{make
+install} installs it @var{elispdir}.  The file @file{lilypond-init.el}
+should be placed to @var{load-path}@file{/site-start.d/} or appended
+to your @file{~/.emacs} or @file{~/.emacs.el}.
 
 As a user, you may want add your source path or, e.g., @file{~/site-lisp/} 
 to your @var{load-path}. Append the following line (modified) to your 
 @file{~/.emacs}:
+@c any reason we do not advise:  (push "~/site-lisp" load-path)
 @quotation
 @example
-       (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
+(setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
 @end example
 @end quotation
 
 
 @section Vim mode
 
-A Vim mode for entering music and running LilyPond is contained in
-the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
-to get shortcuts. Install file @file{lilypond.words.el} to @file{~/.vim/} to 
-get auto-completion. Syntax highlighting you get by installing files
-@file{lilypond.vim} and @file{lilypond.words.vim} to @file{~/.vim/syntax/} 
-and appending the following to @file{~/.vim/filetype.vim}:
-@quotation
+A Vim mode for entering music and running LilyPond is contained in the 
+source archive. For version 6.2 and newer, Vim-mode works directly after 
+installing LilyPond. Otherwise, complete the following two steps.
+
+For earlier versions (and if @code{$VIM} environment variable does not
+fall-back to @file{/usr/local/share/vim}, see @code{:version} in vim), 
+the LilyPond file type is detected if your file @file{~/.vim/filetype.vim} @c
+has the following content:
 @example
-       " my filetype file
        if exists("did_load_filetypes")
-         finish
+         finish
        endif
        augroup filetypedetect
-         au! BufRead,BufNewFile  *.ly          setfiletype lilypond
-       augroup
+         au! BufNewFile,BufRead *.ly           setf lilypond
+       augroup END
+@end example
+If Vim has been (pre-)installed to @file{/usr/...} (or any other place) 
+instead of @file{/usr/local/...}, then @file{/usr/local/share/vim} may not 
+be specified in your @code{$VIMRUNTIME} environment variable and you have to 
+include this path explicitly by appending the following line to your 
+@file{~/.vimrc}:
+@example
+       set runtimepath+=/usr/local/share/vim/
 @end example
-@end quotation
-
-
 
 @section Problems
 
-For help and questions use @email{lilypond-user@@gnu.org}.  Please
-consult the FAQ before mailing your problems.  If you find bugs, please
-send bug reports to @email{bug-lilypond@@gnu.org}.
+For help and questions use @email{lilypond-user@@gnu.org}.  Send bug
+reports to @email{bug-lilypond@@gnu.org}.
 
 Bugs that are not fault of LilyPond are documented here.
 
+@subsection Bison 1.875
+
+There is a bug in bison-1.875: compilation fails with "parse error
+before `goto'" in line 4922 due to a bug in bison. To fix, either
+recompile bison 1.875 with the following fix:
+
+@example
+   $ cd lily; make out/parser.cc
+   $ vi +4919 out/parser.cc
+   # append a semicolon to the line containing "__attribute__ ((__unused__))
+   # save
+   $ make
+@end example
+
 @subsection Linking to kpathsea
 
 If kpathsea and the corresponding header files are installed in some
@@ -340,18 +333,6 @@ set include paths for kpathsea.
 @itemize @bullet
 @item The flex precompiled in NetBSD-1.4.2 is broken.
 Upgrade to flex-2.5.4a.
-
-@ignore
-@c is this current?
-@item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
-release)) does not include @file{/usr/pkg} paths.  Configure it using:
-@example
-
-       CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
-
-@end example
-@end ignore
-
 @end itemize
 
 @unnumberedsubsec  Solaris
@@ -361,7 +342,7 @@ release)) does not include @file{/usr/pkg} paths.  Configure it using:
 
 @file{./configure} needs a POSIX compliant shell.  On Solaris7,
 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
-is.  Please run configure like:
+is.   Run configure like:
 @example
        CONFIG_SHELL=/bin/ksh ksh -c ./configure
 @end example
@@ -370,39 +351,7 @@ or:
        CONFIG_SHELL=/bin/bash bash -c ./configure
 @end example
 
-@item Sparc64/Solaris 2.6, ld
-
-Not yet resolved.
 @end itemize
 
-
-@unnumberedsubsec   AIX
-
-@itemize @bullet
-@item AIX 4.3 ld
-
-The following is from the gcc install/SPECIFIC file:
-@quotation
-   Some versions of the AIX binder (linker) can fail with a relocation
-   overflow severe error when the -bbigtoc option is used to link
-   GCC-produced object files into an executable that overflows the TOC.
-   A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND  
-   -BBIGTOC) is available from IBM Customer Support and from its
-   27service.boulder.ibm.com website as PTF U455193.   
-
-   Binutils does not support AIX 4.3 (at least through release 2.9). GNU
-   as and GNU ld will not work properly and one should not configure GCC
-   to use those GNU utilities. Use the native AIX tools which do
-   interoperate with GCC.
-@end quotation
-
-add -Wl,-bbigtoc to USER_LDFLAGS, i.e.:
-@example
-       LDFLAGS='-Wl,-bbigtoc' ./configure
-@end example
-
-@end itemize
-
-
 @bye