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