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 Click  @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv26w32.exe,here} to
  79 install GSView-2.6 (GhostView for Windows), or visit
  80 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
  81
  82 @item GSView-3.6 and GhostScript-6.50
  83 Click @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv36w32.exe,here} for
  84 GSview and
  85 Click @uref{ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/AFPL/gs650/gs650w32.exe
  86 ,here} for GhostScript.
  87 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
  88 or visit the
  89 @uref{http://www.cs.wisc.edu/~ghost/,Ghostscript, Ghostview and GSview site}.
  90 @end table
  91
  92 @item Python
  93 Click @uref{http://www.python.org/ftp/python/win32/py152.exe,here} to
  94 install Python-1.5.2, or visit @uref{http://www.python.org,www.python.org}.
  95 @end table
  96
  97
  98 @section Windows running setup
  99
 100 If you're lucky, after running @file{setup.exe} you're all set up.
 101
 102 Open a LilyPond shell (or any bash shell), and type
 103 @example
 104 lilypond --help
 105 @end example
 106
 107 If you don't see something similar to
 108 @example
 109 Usage: lilypond [OPTION]... [FILE]...
 110
 111 Typeset music and or play MIDI from FILE
 112
 113 LilyPond is a music typesetter.  It produces beautiful sheet music
 114 using a high level description file as input.  LilyPond is part of
 115 the GNU Project.
 116
 117 Options:
 118   -h,--help             this help
 119 [..]
 120 @end example
 121
 122 you should try adding @file{/usr/lilypond-x.y.z/bin} to your path, do:
 123 @example
 124 PATH=/usr/lilypond-1.3.147/bin:$PATH
 125 @end example
 126
 127 and try again.
 128
 129 [TODO:
 130
 131 * talk about /etc/profile.d/lilypond-profile.sh
 132
 133 * GUILE errors
 134
 135 * TEX errors
 136
 137 ]
 138
 139
 140