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 @example
  67 notepad foo.ly
  68 @end example
  69 Enter the following into the file
  70 @example
  71
  72 \score @{ \notes @{ c4 ( ) c4 @} @}
  73
  74 @end example
  75 Close the file and save it. Run the following command a few times (at
  76 least three times) until it says @code{PS output to `foo.ps', DVI output
  77 to `foo.dvi'}.
  78 @example
  79
  80 ly2dvi -P foo
  81
  82 @end example
  83 You can now view the file using the following command
  84 @example
  85
  86 gsview32 foo.ps
  87
  88 @end example
  89
  90 If this works, then you can head to the
  91 @uref{../../user/out-www/lilypond/Tutorial.html,Tutorial} to start using
  92 LilyPond.
  93
  94
  95
  96 @section Removing LilyPond
  97
  98 Start @file{setup.exe}, click Next, select "Install from Local
  99 Directory". Then click next until you reach "Select packages to
 100 install". Click "View". Now, for every package, click on the recycle
 101 icon until it says "Uninstall". Then, click Next.
 102
 103 (If you find this too tedious, you can also simply remove
 104 @file{c:/cygwin}. This also removes the @file{/home/} directories under
 105 cygwin (i.e. @file{C:\CYGWIN\HOME}, so make sure that you bring
 106 important files in safety first.)
 107
 108 @section Troubleshooting
 109
 110 For problems and solutions see
 111 @uref{http://lilypond.org/wiki?TroubleshootingWindows,Troubleshooting
 112 Windows}
 113
 114
 115 @section Bugreports
 116
 117 We can only help you with a problem if you give a full, detailed
 118 bugreport. A bugreport includes
 119
 120 @itemize @bullet
 121 @item A @emph{precise} description of the problem.
 122 @item A full description of your platform (machine type, operating
 123 system)
 124 @item All version numbers of relevant software you run.  Specifically, we
 125 want to see the output of the  following commands:
 126 @example
 127   python --version
 128   lilypond --version
 129   ly2dvi --version
 130   gswin32  --version
 131 @end example
 132 @item If ly2dvi fails, then please run it as follows and include the
 133   output in the
 134 @example
 135   ly2dvi --verbose MY-FILE
 136 @end example
 137 @end itemize
 138
 139 You can also check out
 140 @uref{http://lilypond.org/wiki/?TroubleshootingWindows} for more
 141 instructions on how to make a bug report.
 142
 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 @item Ghostview.
 167
 168 You can use GSView-2.6.  This old package has two advantages.  It has
 169 gsview and ghostscript bundeled, and it doesn't popup @emph{Register
 170 Now|Cancel} windows all the time.  It doesn't work together with Yap to
 171 display PostScript specials.
 172
 173 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv26w32.exe,here} to
 174 install GSView-2.6 (GhostView for Windows), or visit
 175 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
 176
 177 You can also use the newer versions GSView-3.6 and GhostScript-6.50 If
 178 you install both these packages, Yap will display PostScript specials.
 179 You get annoying @emph{Register Now|Cancel} popups, though.
 180
 181 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv36w32.exe,here} for
 182 GSview and
 183 Click @uref{ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/AFPL/gs650/gs650w32.exe
 184 ,here} for GhostScript.
 185 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
 186 or visit the
 187 @uref{http://www.cs.wisc.edu/~ghost/,Ghostscript, Ghostview and GSview site}.
 188 @end table
 189
 190 [TODO:
 191
 192
 193 * emacs-mode installation, figure out and describe proper
 194 emacs-on-cygwin setup.
 195
 196 ]
 197
 198   guile -v
 199   Guile 1.4.1
 200
 201   guile -e %load-path
 202   ERROR: Wrong type to apply: ("/usr/share/guile/site" /usr/share/guile/1.4.1")
 203
 204
 205
 206 Mats?
 207
 208 Let's take this step by step.
 209
 210 It should not be critical which MikTeX version you use.
 211 Let's first verify that your MikTeX works as it should.
 212 Open a DOS window. Run the commands
 213 >> latex sample2e
 214  Should produce some lines of output
 215 >> yap sample2e
 216  Should display a three page document.
 217
 218 Next step; verify that the geometry package is in place.
 219 Save the attached file to the directory where you run
 220 your DOS window. Run the commands
 221 >> latex geometrytest
 222 >> yap geometrytest
 223 This one you should get a single page document with some text
 224 in each corner.
 225 ]
 226
 227 @end ignore
 228
 229 @ignore
 230 @c irrelevant.
 231
 232 If you want to install more of cygwnTo expand on this minimal set,
 233 @section If you already have MikTeX, GSView or
 234
 235 If you already have cygwin installed, don't worry: nothing will be
 236 installed twice.  To expand on this minimal set, click
 237 @uref{http://sources.redhat.com/cygwin/setup.exe,here}, or visit a
 238 Cygwin @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
 239
 240
 241 This will install the minimal set of cygwin tools needed to run
 242 LilyPond.  Make sure to install in the default place, @file{c:/cygwin},
 243 and install everything.
 244 @end ignore