]> 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 57c4c85f012b3812953eaa9478f1d971253f8b50..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
 
@@ -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.
@@ -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
@@ -245,26 +238,30 @@ to your @var{load-path}. Append the following line (modified) to your
 
 @section Vim mode
 
-@c lilypond.words.el for vim auto-completion?
-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
 
@@ -273,6 +270,20 @@ 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
@@ -322,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