]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/windows/installing.texi
* scm/grob-property-description.scm (minimum-space-pair): Remove.
[lilypond.git] / Documentation / windows / installing.texi
index a06bc0e4769286fd94339f9a1bfc3868eadc995c..024d9ef2b8f271579d52f0192514afdec551d029 100644 (file)
@@ -2,54 +2,41 @@
 @setfilename installing.info
 @settitle LilyPond on Windows
 
+@html
+<!--- @@WEB-TITLE@@=Windows Installation --->
+@end html
+
 @node Top
 @top
 
 @chapter WINDOWS - Installing GNU LilyPond on Windows
 
-This document explains how to install the binary release for windows
-on a Microsoft Windows 95, 98, NT or 2000 machine.
+This document explains how to install the binary release for windows on
+a Microsoft Windows 95, 98, NT or 2000 machine. Please follow the
+instructions carefully. If it doesn't work for you, please send a
+bugreport, following the guidelines in the section on bugreports below.
 
-This release is a free extra service of the developers to assist windows
-users.  Please remember that we (the developers) rather dislike windows,
-and none of us use it.  Don't complain to us that installing LilyPond is
-too difficult; rather, if you know something about your Windows, send us
-code that works better (see @uref{compiling.html,compiling}).
 
 @section Windows binary setup 
 
-Apart from LilyPond itself, you need Cygwin, GUILE, Python, and a TeX
-installation, but all this software be installed by running setup.exe:
-
-@table @asis
-@item LilyPond
-Download and run
-@c let's do http, so that people read the README
-@uref{http://www.lilypond.org/gnu-windows/setup.exe, setup.exe}
-to install LilyPond.
-
-This will install the minimal set of cygwin tools needed to run
-LilyPond.  Make sure to install in the default place, @file{c:/cygwin},
-and install everything.
-
-As of version 1.3.150, you also have the option to install MiKTeX,
-Python and GSView from this installer, which is recommended.  If you
-choose to install these by hand (see below), make sure to install them
-@strong{before} you install LilyPond, otherwise your LilyPond setup will
-be broken.
-
-If you already have cygwin installed, don't worry: nothing will be
-installed twice.  To expand on this minimal set, click
-@uref{http://sources.redhat.com/cygwin/setup.exe,here}, or visit a
-Cygwin @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
-@end table
+If you run Windows NT, 2000 or XP, please become administrator first
+(currently, installing as an ordinary user will not work).  Download and
+run @uref{http://www.lilypond.org/gnu-windows/setup.exe, setup.exe}.
+You will be asked some questions. If you are unsure just click "Next".
+Do not change the default install directory @file{c:/cygwin}.
 
+This installs LilyPond, and Cygwin, GUILE, Python, teTeX (MikTeX is not
+supported) and GSView.  If you already have some of that software under
+@file{c:/cygwin}, then don't worry: nothing will be installed twice.
 
-@section Windows running setup
+If you want to install any of this software by hand, do this
+@strong{before} you run @file{setup.exe}, otherwise your LilyPond setup
+may not work.
 
-If you're lucky, after running @file{setup.exe} you're all set up.
+@section Testing LilyPond
 
-Open a LilyPond shell (or any bash shell), and type
+Open a LilyPond shell (To open a a lilypond shell, click the "GNU
+LilyPond" icon), and type
 
 @quotation
 @example
@@ -57,7 +44,7 @@ lilypond --help
 @end example
 @end quotation
 
-If you don't see something similar to
+You should see something similar to
 
 @quotation
 @example
@@ -75,25 +62,96 @@ Options:
 @end example
 @end quotation
 
-you should try adding @file{/usr/lilypond-x.y.z/bin} to your @var{PATH},
-do:
+Then, prepare a file called @file{foo.ly}, by issuing
+@quotation
+@example
+notepad foo.ly
+@end example
+@end quotation
+Enter the following into the file
+@quotation
+@example
+
+\score @{ \notes @{ c4 ( ) c4 @} @}
+
+@end example
+@end quotation
+Close the file and save it. Run the following command. It should say
+@code{PS output to `foo.ps', DVI output to `foo.dvi'}.
+@quotation
+@example
+
+ly2dvi -P foo
 
+@end example
+@end quotation
+You can now view the file using the following command
 @quotation
 @example
-PATH=/usr/lilypond-1.4.2/bin:$PATH
+
+gsview32 foo.ps
+
 @end example
 @end quotation
 
-and try again.
+If this works, then you can head to the
+@uref{../../user/out-www/lilypond/Tutorial.html,Tutorial} to start using
+LilyPond.
+
+
 
+@section Removing LilyPond
 
-@subsection Trouble
+Start @file{setup.exe}, click Next, select "Install from Local
+Directory". Then click next until you reach "Select packages to
+install". Click "View". Now, for every package, click on the recycle
+icon until it says "Uninstall". Then, click Next.
+
+(If you find this too tedious, you can also simply remove
+@file{c:/cygwin}. This also removes the @file{/home/} directories under
+cygwin (i.e. @file{C:\CYGWIN\HOME}, so make sure that you bring
+important files in safety first.)
+
+@section Troubleshooting
 
 For problems and solutions see
 @uref{http://lilypond.org/wiki?TroubleshootingWindows,Troubleshooting
 Windows}
 
 
+@section Bugreports
+
+We can only help you with a problem if you give a full, detailed
+bugreport. A bugreport includes
+
+@itemize @bullet
+@item A @emph{precise} description of the problem.  
+@item A full description of your platform (machine type, operating
+system)
+@item All version numbers of relevant software you run.  Specifically, we
+want to see the output of the  following commands: 
+@quotation
+@example
+  python --version
+  lilypond --version
+  ly2dvi --version
+  gswin32c  --version
+@end example
+@end quotation
+@item If ly2dvi fails, then please run it as follows and include the
+  output in the 
+@quotation
+@example
+  ly2dvi --verbose MY-FILE
+@end example
+@end quotation
+@end itemize
+
+You can also check out
+@uref{http://lilypond.org/wiki/?TroubleshootingWindows} for more
+instructions on how to make a bug report.
+
+@ignore
 @subsection Additional software
 
 LilyPond needs a number of software packages to be really useful.  These
@@ -110,10 +168,11 @@ These software packages are included in the LilyPond installation:
 @table @asis
 @item A full TeX installation.
 
-Currently, only MikTeX is supported.  Download and install
-@uref{http://downloads.sourceforge.net/miktex/miktex-2.0-lvl-1.zip,MikTeX},
-or visit @uref{http://www.miktex.org,www.miktex.org}.
-@c See @file{/usr/doc/cygwin/tetex-beta-20001218.README} for details.
+As of LilyPond versions 1.4.11 (and 1.5.29), only Cygwin's teTeX
+installation is supported (packages tetex-beta and texmf-base).  It is
+part of Cygwin and much more robust for use with LilyPond than MiKTeX.
+See @file{/usr/doc/Cygwin/tetex-beta-20001218.README} and
+@file{/usr/doc/Cygwin/texmf-20000804-2.README} for details.
 
 @item Ghostview.
 
@@ -137,18 +196,8 @@ Click @uref{ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/AFPL/gs650/gs650w32.exe
 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
 or visit the
 @uref{http://www.cs.wisc.edu/~ghost/,Ghostscript, Ghostview and GSview site}.
-
-@item Python
-Click @uref{http://www.python.org/ftp/python/win32/py152.exe,here} to
-install Python-1.5.2, or visit
-@uref{http://www.python.org,www.python.org}.
-
-We have not tried using newer versions than 1.5.2.
-
 @end table
 
-
-
 [TODO:
 
 
@@ -157,9 +206,6 @@ emacs-on-cygwin setup.
 
 ]
 
-
-@ignore 
-
   guile -v
   Guile 1.4.1
 
@@ -191,4 +237,19 @@ in each corner.
 
 @end ignore
 
+@ignore
+@c irrelevant.
+
+If you want to install more of cygwnTo expand on this minimal set,
+@section If you already have MikTeX, GSView or
 
+If you already have cygwin installed, don't worry: nothing will be
+installed twice.  To expand on this minimal set, click
+@uref{http://sources.redhat.com/cygwin/setup.exe,here}, or visit a
+Cygwin @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
+
+
+This will install the minimal set of cygwin tools needed to run
+LilyPond.  Make sure to install in the default place, @file{c:/cygwin},
+and install everything. 
+@end ignore