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