Documentation/topdocs/WINDOWS.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename WINDOWS.info
   3 @settitle WINDOWS - compiling and installing GNU LilyPond on Windows
   4
   5 @node Top
   6 @top
   7
   8 @chapter WINDOWS - compiling and installing GNU LilyPond on Windows
   9
  10 This document is a supplement to INSTALL.txt, you may want to read
  11 that too.
  12
  13 @section Obtaining LilyPond
  14
  15 You can get the latest version of LilyPond at
  16 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,
  17 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.
  18
  19 @section Windows build requirements
  20 You need the following packages to compile Lilypond on Windows.
  21
  22 @table @code
  23 @item The GNU + Cygnus tools, 1.1.7 or newer.
  24 Check out the @uref{http://sources.redhat.com/cygwin,Cygwin webpage}.
  25 You can get the latest version of the GNU + Cygnus tools from cygnus
  26 @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
  27 Install everything, including tetex.
  28 @item GUILE 1.4, or newer.
  29 Check out the @uref{http://www.gnu.org/software/guile.html,GUILE
  30 webpage}.  You may need the patch @file{guile-1.4-gnu-windows.patch}
  31 included in LilyPond's source distribution.
  32 @end table
  33
  34 @section Windows precompiled binaries
  35
  36 @table @code
  37 @item LilyPond
  38 Click @uref{http://appel.lilypond.org/lilypond/gnu-windows/setup.exe,
  39 here} to install LilyPond, or visit @uref{http://appel.lilypond.org/lilypond/gnu-windows,
  40 LilyPond on Windows}.
  41
  42 This will install the minimal set of cygwin tools needed to run
  43 LilyPond.  If you already have cygwin installed, don't worry: nothing
  44 will be installed twice.  To expand on this minimal set, click
  45 @uref{http://sources.redhat.com/cygwin/setup.exe,here},
  46 or visit a Cygwin
  47 @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
  48 @end table
  49
  50 Note that none of the developers uses Windows, of course.  In fact, we
  51 recommend you to use GNU/Linux for running LilyPond.  We provide these
  52 binaries anyway, because it saves us the trouble of helping Windows
  53 users trying to compile LilyPond themselves.
  54
  55 These binaries are cross compiled for Windows on a GNU/Linux box.  You
  56 may want to check out the
  57 @uref{http://appel.lilypond.org/lilypond/gnu-windows/cross-1.1.8.tar.gz,cross
  58 compilation scripts}.
  59
  60 @section Windows running requirements
  61
  62 GNU LilyPond does use a lot of resources. For operation you need the
  63 following software
  64
  65 @table @code
  66 @item GUILE
  67 Included in binary installation.
  68 @item TeX
  69 A full TeX installation.
  70 Click
  71 @uref{http://prdownloads.sourceforge.net/miktex/miktex-2.0-lvl-1.zip,here}
  72 to install basic MiKTeX commands,
  73 or visit @uref{http://www.miktex.org,www.miktex.org}.
  74 @c See @file{/usr/doc/cygwin/tetex-beta-20001218.README} for details.
  75 @item PostScript tools
  76 @table @code
  77 @item GSView-2.6, or
  78 This old package has two advantages.  It has gsview and ghostscript
  79 bundeled, and it doesn't popup @emph{Register Now|Cancel} windows all
  80 the time.  It doesn't work together with Yap to display PostScript
  81 specials.
  82
  83 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv26w32.exe,here} to
  84 install GSView-2.6 (GhostView for Windows), or visit
  85 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
  86
  87 @item GSView-3.6 and GhostScript-6.50
  88 If you install both these packages, Yap will display PostScript
  89 specials.  You get annoying @emph{Register Now|Cancel} popups, though.
  90
  91 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv36w32.exe,here} for
  92 GSview and
  93 Click @uref{ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/AFPL/gs650/gs650w32.exe
  94 ,here} for GhostScript.
  95 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
  96 or visit the
  97 @uref{http://www.cs.wisc.edu/~ghost/,Ghostscript, Ghostview and GSview site}.
  98 @end table
  99
 100 @item Python
 101 Click @uref{http://www.python.org/ftp/python/win32/py152.exe,here} to
 102 install Python-1.5.2, or visit
 103 @uref{http://www.python.org,www.python.org}.
 104
 105 Python > 1.5.2 has ugly licensing issues, so we only used and tested
 106 1.5.2.
 107 @end table
 108
 109
 110 @section Windows running setup
 111
 112 If you're lucky, after running @file{setup.exe} you're all set up.
 113
 114 Open a LilyPond shell (or any bash shell), and type
 115 @example
 116 lilypond --help
 117 @end example
 118
 119 If you don't see something similar to
 120 @example
 121 Usage: lilypond [OPTION]... [FILE]...
 122
 123 Typeset music and or play MIDI from FILE
 124
 125 LilyPond is a music typesetter.  It produces beautiful sheet music
 126 using a high level description file as input.  LilyPond is part of
 127 the GNU Project.
 128
 129 Options:
 130   -h,--help             this help
 131 [..]
 132 @end example
 133
 134 you should try adding @file{/usr/lilypond-x.y.z/bin} to your @var{PATH},
 135 do:
 136 @example
 137 PATH=/usr/lilypond-1.3.147/bin:$PATH
 138 @end example
 139
 140 and try again.
 141
 142 [TODO:
 143
 144 * politely ask windows users not to complain but rather send instructive
 145 bug reports along with patches.
 146
 147 * emacs-mode installation, figure out and describe proper
 148 emacs-on-cygwin setup.
 149
 150 * talk about /etc/profile.d/lilypond-profile.sh
 151
 152 * GUILE errors, simple guile test
 153
 154 * (La)TEX errors, simple tex test
 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