Documentation/windows/installing.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename installing.info
   3 @settitle LilyPond on Windows
   4
   5 @node Top
   6 @top
   7
   8 @chapter WINDOWS - Installing GNU LilyPond on Windows
   9
  10 This document explains how to install the binary release for windows
  11 on a Microsoft Windows 95, 98, NT or 2000 machine.
  12
  13 This release is a free extra service of the developers to assist windows
  14 users.  Please remember that we (the developers) rather dislike windows,
  15 and none of us use it.  Don't complain to us that installing LilyPond is
  16 too difficult; rather, if you know something about your Windows, send us
  17 code that works better (see @uref{compiling.html,compiling}).
  18
  19 @section Windows binary setup
  20
  21 Apart from LilyPond itself, you need Cygwin, GUILE, Python, and a TeX
  22 installation, but all this software be installed by running setup.exe:
  23
  24 @table @asis
  25 @item LilyPond
  26 Download and run
  27 @c let's do http, so that people read the README
  28 @uref{http://www.lilypond.org/gnu-windows/setup.exe, setup.exe}
  29 to install LilyPond.
  30
  31 This will install the minimal set of cygwin tools needed to run
  32 LilyPond.  Make sure to install in the default place, @file{c:/cygwin},
  33 and install everything.
  34
  35 As of version 1.3.150, you also have the option to install MiKTeX,
  36 Python and GSView from this installer, which is recommended.  If you
  37 choose to install these by hand (see below), make sure to install them
  38 @strong{before} you install LilyPond, otherwise your LilyPond setup will
  39 be broken.
  40
  41 If you already have cygwin installed, don't worry: nothing will be
  42 installed twice.  To expand on this minimal set, click
  43 @uref{http://sources.redhat.com/cygwin/setup.exe,here}, or visit a
  44 Cygwin @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
  45 @end table
  46
  47
  48 @section Windows running setup
  49
  50 If you're lucky, after running @file{setup.exe} you're all set up.
  51
  52 Open a LilyPond shell (or any bash shell), and type
  53
  54 @quotation
  55 @example
  56 lilypond --help
  57 @end example
  58 @end quotation
  59
  60 If you don't see something similar to
  61
  62 @quotation
  63 @example
  64 Usage: lilypond [OPTION]... [FILE]...
  65
  66 Typeset music and or play MIDI from FILE
  67
  68 LilyPond is a music typesetter.  It produces beautiful sheet music
  69 using a high level description file as input.  LilyPond is part of
  70 the GNU Project.
  71
  72 Options:
  73   -h,--help             this help
  74 [..]
  75 @end example
  76 @end quotation
  77
  78 you should try adding @file{/usr/lilypond-x.y.z/bin} to your @var{PATH},
  79 do:
  80
  81 @quotation
  82 @example
  83 PATH=/usr/lilypond-1.4.2/bin:$PATH
  84 @end example
  85 @end quotation
  86
  87 and try again.
  88
  89
  90 @subsection Trouble
  91
  92 For problems and solutions see
  93 @uref{http://lilypond.org/wiki?TroubleshootingWindows,Troubleshooting
  94 Windows}
  95
  96
  97 @subsection Additional software
  98
  99 LilyPond needs a number of software packages to be really useful.  These
 100 are included in the binary setup program (see above).
 101
 102 If you choose to install this additional software yourself, make sure
 103 you install LilyPond last, otherwise the LilyPond setup will be broken.
 104 Also note that this means that you will probably need to fix some PATH
 105 and TEX environment variables yourself.  If you think you can handle
 106 that, you may do so, but don't complain if it doesn't work.
 107
 108 These software packages are included in the LilyPond installation:
 109
 110 @table @asis
 111 @item A full TeX installation.
 112
 113 Currently, only MikTeX is supported.  Download and install
 114 @uref{http://downloads.sourceforge.net/miktex/miktex-2.0-lvl-1.zip,MikTeX},
 115 or visit @uref{http://www.miktex.org,www.miktex.org}.
 116 @c See @file{/usr/doc/cygwin/tetex-beta-20001218.README} for details.
 117
 118 @item Ghostview.
 119
 120 You can use GSView-2.6.  This old package has two advantages.  It has
 121 gsview and ghostscript bundeled, and it doesn't popup @emph{Register
 122 Now|Cancel} windows all the time.  It doesn't work together with Yap to
 123 display PostScript specials.
 124
 125 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv26w32.exe,here} to
 126 install GSView-2.6 (GhostView for Windows), or visit
 127 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
 128
 129 You can also use the newer versions GSView-3.6 and GhostScript-6.50 If
 130 you install both these packages, Yap will display PostScript specials.
 131 You get annoying @emph{Register Now|Cancel} popups, though.
 132
 133 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv36w32.exe,here} for
 134 GSview and
 135 Click @uref{ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/AFPL/gs650/gs650w32.exe
 136 ,here} for GhostScript.
 137 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
 138 or visit the
 139 @uref{http://www.cs.wisc.edu/~ghost/,Ghostscript, Ghostview and GSview site}.
 140
 141 @item Python
 142 Click @uref{http://www.python.org/ftp/python/win32/py152.exe,here} to
 143 install Python-1.5.2, or visit
 144 @uref{http://www.python.org,www.python.org}.
 145
 146 We have not tried using newer versions than 1.5.2.
 147
 148 @end table
 149
 150
 151
 152 [TODO:
 153
 154
 155 * emacs-mode installation, figure out and describe proper
 156 emacs-on-cygwin setup.
 157
 158 ]
 159
 160
 161 @ignore
 162
 163   guile -v
 164   Guile 1.4.1
 165
 166   guile -e %load-path
 167   ERROR: Wrong type to apply: ("/usr/share/guile/site" /usr/share/guile/1.4.1")
 168
 169
 170
 171 Mats?
 172
 173 Let's take this step by step.
 174
 175 It should not be critical which MikTeX version you use.
 176 Let's first verify that your MikTeX works as it should.
 177 Open a DOS window. Run the commands
 178 >> latex sample2e
 179  Should produce some lines of output
 180 >> yap sample2e
 181  Should display a three page document.
 182
 183 Next step; verify that the geometry package is in place.
 184 Save the attached file to the directory where you run
 185 your DOS window. Run the commands
 186 >> latex geometrytest
 187 >> yap geometrytest
 188 This one you should get a single page document with some text
 189 in each corner.
 190 ]
 191
 192 @end ignore
 193
 194