Documentation/windows/installing.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename installing.info
   3 @settitle LilyPond on Windows
   4
   5 @html
   6 <!--- @@WEB-TITLE@@=Windows Installation --->
   7 @end html
   8
   9 @node Top
  10 @top
  11
  12 @chapter WINDOWS - Installing GNU LilyPond on Windows
  13
  14 This document explains how to install the binary release for windows on
  15 a Microsoft Windows 95, 98, NT or 2000 machine. Please follow the
  16 instructions carefully. If it doesn't work for you, please send a
  17 bugreport, following the guidelines in the section on bugreports below.
  18
  19
  20 @section Windows binary setup
  21
  22 If you run Windows NT, 2000 or XP, please become administrator first
  23 (currently, installing as an ordinary user will not work).  All the
  24 software you need is installed by downloading and running
  25 @uref{http://www.lilypond.org/gnu-windows/setup.exe, setup.exe}.  You
  26 will be asked some questions. If you are unsure just click "Next".  Do
  27 not change the default install directory @file{c:/cygwin}.
  28
  29 This installs LilyPond, and Cygwin, GUILE, Python, teTeX and GSView.  If
  30 you already have some of that software under @file{c:/cygwin}, then
  31 don't worry: nothing will be installed twice.
  32
  33 If you want to install any of this software by hand, do this
  34 @strong{before} you run @file{setup.exe}, otherwise your LilyPond setup
  35 may not work.
  36
  37 @section Testing LilyPond
  38
  39 Open a LilyPond shell (To open a a lilypond shell, click the "GNU
  40 LilyPond" icon), and type
  41
  42 @quotation
  43 @example
  44 lilypond --help
  45 @end example
  46 @end quotation
  47
  48 You should see something similar to
  49
  50 @quotation
  51 @example
  52 Usage: lilypond [OPTION]... [FILE]...
  53
  54 Typeset music and or play MIDI from FILE
  55
  56 LilyPond is a music typesetter.  It produces beautiful sheet music
  57 using a high level description file as input.  LilyPond is part of
  58 the GNU Project.
  59
  60 Options:
  61   -h,--help             this help
  62 [..]
  63 @end example
  64 @end quotation
  65
  66 Then, prepare a file called @file{foo.ly}, by issuing
  67 @example
  68 notepad foo.ly
  69 @end example
  70 Enter the following into the file
  71 @example
  72
  73 \score @{ \notes @{ c4 ( ) c4 @} @}
  74
  75 @end example
  76 Close the file and save it. Run the following command a few times (at
  77 least three times) until it says @code{PS output to `foo.ps', DVI output
  78 to `foo.dvi'}.
  79 @example
  80
  81 ly2dvi -P foo
  82
  83 @end example
  84 You can now view the file using the following command
  85 @example
  86
  87 gsview32 foo.ps
  88
  89 @end example
  90
  91 If this works, then you can head to the
  92 @uref{../../user/out-www/lilypond/Tutorial.html,Tutorial} to start using
  93 LilyPond.
  94
  95
  96
  97 @section Removing LilyPond
  98
  99 Start @file{setup.exe}, click Next, select "Install from Local
 100 Directory". Then click next until you reach "Select packages to
 101 install". Click "View". Now, for every package, click on the recycle
 102 icon until it says "Uninstall". Then, click Next.
 103
 104 (If you find this too tedious, you can also simply remove
 105 @file{c:/cygwin}. This also removes the @file{/home/} directories under
 106 cygwin (i.e. @file{C:\CYGWIN\HOME}, so make sure that you bring
 107 important files in safety first.)
 108
 109 @section Troubleshooting
 110
 111 For problems and solutions see
 112 @uref{http://lilypond.org/wiki?TroubleshootingWindows,Troubleshooting
 113 Windows}
 114
 115
 116 @section Bugreports
 117
 118 We can only help you with a problem if you give a full, detailed
 119 bugreport. A bugreport includes
 120
 121 @itemize @bullet
 122 @item A @emph{precise} description of the problem.
 123 @item A full description of your platform (machine type, operating
 124 system)
 125 @item All version numbers of relevant software you run.  Specifically, we
 126 want to see the output of the  following commands:
 127 @example
 128   python --version
 129   lilypond --version
 130   ly2dvi --version
 131   gswin32  --version
 132 @end example
 133 @item If ly2dvi fails, then please run it as follows and include the
 134   output in the
 135 @example
 136   ly2dvi --verbose MY-FILE
 137 @end example
 138 @end itemize
 139
 140 You can also check out
 141 @uref{http://lilypond.org/wiki/?TroubleshootingWindows} for more
 142 instructions on how to make a bug report.
 143 @ignore
 144 @subsection Additional software
 145
 146 LilyPond needs a number of software packages to be really useful.  These
 147 are included in the binary setup program (see above).
 148
 149 If you choose to install this additional software yourself, make sure
 150 you install LilyPond last, otherwise the LilyPond setup will be broken.
 151 Also note that this means that you will probably need to fix some PATH
 152 and TEX environment variables yourself.  If you think you can handle
 153 that, you may do so, but don't complain if it doesn't work.
 154
 155 These software packages are included in the LilyPond installation:
 156
 157 @table @asis
 158 @item A full TeX installation.
 159
 160 As of LilyPond versions 1.4.11 (and 1.5.29), only Cygwin's teTeX
 161 installation is supported (packages tetex-beta and texmf-base).  It is
 162 part of Cygwin and much more robust for use with LilyPond than MiKTeX.
 163 See @file{/usr/doc/Cygwin/tetex-beta-20001218.README} and
 164 @file{/usr/doc/Cygwin/texmf-20000804-2.README} for details.
 165
 166
 167 @item Ghostview.
 168
 169 You can use GSView-2.6.  This old package has two advantages.  It has
 170 gsview and ghostscript bundeled, and it doesn't popup @emph{Register
 171 Now|Cancel} windows all the time.  It doesn't work together with Yap to
 172 display PostScript specials.
 173
 174 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv26w32.exe,here} to
 175 install GSView-2.6 (GhostView for Windows), or visit
 176 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
 177
 178 You can also use the newer versions GSView-3.6 and GhostScript-6.50 If
 179 you install both these packages, Yap will display PostScript specials.
 180 You get annoying @emph{Register Now|Cancel} popups, though.
 181
 182 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv36w32.exe,here} for
 183 GSview and
 184 Click @uref{ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/AFPL/gs650/gs650w32.exe
 185 ,here} for GhostScript.
 186 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
 187 or visit the
 188 @uref{http://www.cs.wisc.edu/~ghost/,Ghostscript, Ghostview and GSview site}.
 189 @end table
 190
 191 [TODO:
 192
 193
 194 * emacs-mode installation, figure out and describe proper
 195 emacs-on-cygwin setup.
 196
 197 ]
 198
 199   guile -v
 200   Guile 1.4.1
 201
 202   guile -e %load-path
 203   ERROR: Wrong type to apply: ("/usr/share/guile/site" /usr/share/guile/1.4.1")
 204
 205
 206
 207 Mats?
 208
 209 Let's take this step by step.
 210
 211 It should not be critical which MikTeX version you use.
 212 Let's first verify that your MikTeX works as it should.
 213 Open a DOS window. Run the commands
 214 >> latex sample2e
 215  Should produce some lines of output
 216 >> yap sample2e
 217  Should display a three page document.
 218
 219 Next step; verify that the geometry package is in place.
 220 Save the attached file to the directory where you run
 221 your DOS window. Run the commands
 222 >> latex geometrytest
 223 >> yap geometrytest
 224 This one you should get a single page document with some text
 225 in each corner.
 226 ]
 227
 228 @end ignore
 229
 230 @ignore
 231 @c irrelevant.
 232
 233 If you want to install more of cygwnTo expand on this minimal set,
 234 @section If you already have MikTeX, GSView or
 235
 236 If you already have cygwin installed, don't worry: nothing will be
 237 installed twice.  To expand on this minimal set, click
 238 @uref{http://sources.redhat.com/cygwin/setup.exe,here}, or visit a
 239 Cygwin @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
 240
 241
 242 This will install the minimal set of cygwin tools needed to run
 243 LilyPond.  Make sure to install in the default place, @file{c:/cygwin},
 244 and install everything.
 245 @end ignore