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