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
  35 @section Windows precompiled binaries
  36
  37 @table @code
  38 @item LilyPond
  39 Click @uref{http://appel.lilypond.org/lilypond/gnu-windows/setup.exe,
  40 here} to install LilyPond, or visit @uref{http://appel.lilypond.org/lilypond/gnu-windows,
  41 LilyPond on Windows}.
  42
  43 This will install the minimal set of cygwin tools needed to run
  44 LilyPond.  If you already have cygwin installed, don't worry: nothing
  45 will be installed twice.  To expand on this minimal set, click
  46 @uref{http://sources.redhat.com/cygwin/setup.exe,here},
  47 or visit a Cygwin
  48 @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
  49 @end table
  50
  51 Note that none of the developers uses Windows, of course.  In fact, we
  52 recommend you to use GNU/Linux for running LilyPond.  We provide these
  53 binaries anyway, because it saves us the trouble of helping Windows
  54 users trying to compile LilyPond themselves.
  55
  56 These binaries are cross compiled for Windows on a GNU/Linux box.  You
  57 may want to check out the
  58 @uref{http://appel.lilypond.org/lilypond/gnu-windows/cross-1.1.8.tar.gz,cross
  59 compilation scripts}.
  60
  61 @section Windows running requirements
  62
  63 GNU LilyPond does use a lot of resources.  For operation you need the
  64 following software
  65
  66 @table @code
  67 @item GUILE
  68 Included in binary installation.
  69 @item TeX
  70 A full TeX installation.
  71 Click
  72 @uref{http://prdownloads.sourceforge.net/miktex/miktex-2.0-lvl-1.zip,here}
  73 to install basic MiKTeX commands,
  74 or visit @uref{http://www.miktex.org,www.miktex.org}.
  75 @c See @file{/usr/doc/cygwin/tetex-beta-20001218.README} for details.
  76 @item PostScript tools
  77 @table @code
  78 @item GSView-2.6, or
  79 This old package has two advantages.  It has gsview and ghostscript
  80 bundeled, and it doesn't popup @emph{Register Now|Cancel} windows all
  81 the time.  It doesn't work together with Yap to display PostScript
  82 specials.
  83
  84 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv26w32.exe,here} to
  85 install GSView-2.6 (GhostView for Windows), or visit
  86 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
  87
  88 @item GSView-3.6 and GhostScript-6.50
  89 If you install both these packages, Yap will display PostScript
  90 specials.  You get annoying @emph{Register Now|Cancel} popups, though.
  91
  92 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv36w32.exe,here} for
  93 GSview and
  94 Click @uref{ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/AFPL/gs650/gs650w32.exe
  95 ,here} for GhostScript,
  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 @section Windows running setup
 110
 111 If you're lucky, after running @file{setup.exe} you're all set up.
 112
 113 Open a LilyPond shell (or any bash shell), and type
 114 @example
 115 lilypond --help
 116 @end example
 117
 118 If you don't see something similar to
 119 @example
 120 Usage: lilypond [OPTION]... [FILE]...
 121
 122 Typeset music and or play MIDI from FILE
 123
 124 LilyPond is a music typesetter.  It produces beautiful sheet music
 125 using a high level description file as input.  LilyPond is part of
 126 the GNU Project.
 127
 128 Options:
 129   -h,--help             this help
 130 [..]
 131 @end example
 132
 133 you should try adding @file{/usr/lilypond-x.y.z/bin} to your @var{PATH},
 134 do:
 135 @example
 136 PATH=/usr/lilypond-1.3.147/bin:$PATH
 137 @end example
 138
 139 and try again.
 140
 141 [TODO:
 142
 143 * politely ask windows users not to complain but rather send instructive
 144 bug reports along with patches.
 145
 146 * emacs-mode installation, figure out and describe proper
 147 emacs-on-cygwin setup.
 148
 149 * talk about /etc/profile.d/lilypond-profile.sh
 150
 151 * GUILE errors, simple guile test
 152
 153 * (La)TEX errors, simple tex test
 154
 155
 156 ]
 157 @ignore
 158
 159   guile -v
 160   Guile 1.4.1
 161
 162   guile -e %load-path
 163   ERROR: Wrong type to apply: ("/usr/share/guile/site" /usr/share/guile/1.4.1")
 164
 165
 166
 167 Mats?
 168
 169 Let's take this step by step.
 170
 171 It should not be critical which MikTeX version you use.
 172 Let's first verify that your MikTeX works as it should.
 173 Open a DOS window. Run the commands
 174 >> latex sample2e
 175  Should produce some lines of output
 176 >> yap sample2e
 177  Should display a three page document.
 178
 179 Next step; verify that the geometry package is in place.
 180 Save the attached file to the directory where you run
 181 your DOS window. Run the commands
 182 >> latex geometrytest
 183 >> yap geometrytest
 184 This one you should get a single page document with some text
 185 in each corner.
 186 ]
 187
 188
 189 emacs
 190
 191 http://cygwin.com/ml/cygwin/2000-08/msg01049.html
 192 http://www.cs.unc.edu/~juliano/my_emacs_files/cygwin32-mount.el
 193 http://cygwin.com/ml/cygwin/2000-02/msg00109.html
 194 http://sources.redhat.com/ml/cygwin/2001-01/msg00878/cygwin32-mount.el
 195
 196   ;; setup Bash shell
 197   (setq exec-path (cons "C:/cygwin/bin" exec-path))
 198   (setenv "PATH" (concat "C:\\cygwin\\bin;" (getenv "PATH")))
 199   (setq process-coding-system-alist '(("bash" . undecided-unix)))
 200   (setq w32-quote-process-args ?\")
 201   (setq shell-file-name "bash")
 202   (setenv "SHELL" shell-file-name)
 203   (setq explicit-shell-file-name shell-file-name)
 204   (add-hook 'comint-output-filter-functions 'comint-strip-ctrl-m)
 205
 206 @end ignore
 207
 208