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