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