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