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 @item GUILE 1.4, or newer.
  26 Check out the @uref{http://www.gnu.org/software/guile.html,GUILE webpage}
  27 @end table
  28
  29 You can get the latest version of the GNU + Cygnus tools from cygnus
  30 @uref{http://sources.redhat.com/cygwin/mirrors.html,mirror site}.
  31
  32 @section Windows precompiled binaries
  33
  34 @table @code
  35 @item LilyPond
  36 Click @uref{http://appel.lilypond.org/lilypond/gnu-windows/setup.exe,
  37 here} to install LilyPond, or visit @uref{http://appel.lilypond.org/lilypond/gnu-windows,
  38 LilyPond on Windows}.
  39
  40 This will install the minimal set of cygwin tools needed to run
  41 LilyPond.  If you already have cygwin installed, don't worry: nothing
  42 will be installed twice.
  43
  44 @end table
  45
  46 Note that none of the developers uses Windows, of course.  In fact, we
  47 recommend you to use GNU/Linux for running LilyPond.  We provide these
  48 binaries anyway, because it saves us the trouble of helping Windows
  49 users trying to compile LilyPond themselves.
  50
  51 These binaries are cross compiled for Windows on a GNU/Linux box.  You
  52 may want to check out the
  53 @uref{http://appel.lilypond.org/lilypond/gnu-windows/cross.tar.gz,cross
  54 compilation scripts}.
  55
  56 @section Windows running requirements
  57
  58 GNU LilyPond does use a lot of resources. For operation you need the
  59 following software
  60
  61 @table @code
  62 @item GUILE
  63 Included in binary installation.
  64 @item TeX
  65 A full TeX installation.  See /usr/share/doc/tetex-beta for details.
  66 @item GSView
  67 Click  @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum/gsv36w32.exe,here} to
  68 install GSView (GhostView for Windows), or visit
  69 @uref{ftp://ftp.cs.wisc.edu/ghost/ghostgum,ftp.cs.wisc.edu}.
  70 @item Python
  71 Click @uref{http://www.python.org/ftp/python/win32/py152.exe,here} to
  72 install Python-1.5.2, or visit @uref{http://www.python.org,www.python.org}.
  73 @end table
  74
  75
  76 @section Windows running setup
  77
  78 If you're lucky, after running @file{setup.exe} you're all set up.
  79
  80 Open a LilyPond shell (or any bash shell), and type
  81 @example
  82 lilypond --help
  83 @end example
  84
  85 If you don't see something similar to
  86 @example
  87 Usage: lilypond [OPTION]... [FILE]...
  88
  89 Typeset music and or play MIDI from FILE
  90
  91 LilyPond is a music typesetter.  It produces beautiful sheet music
  92 using a high level description file as input.  LilyPond is part of
  93 the GNU Project.
  94
  95 Options:
  96   -h,--help             this help
  97 [..]
  98 @end example
  99
 100 you should try adding @file{/usr/lilypond-x.y.z/bin} to your path, do:
 101 @example
 102 PATH=/usr/lilypond-1.3.147/bin:$PATH
 103 @end example
 104
 105 and try again.
 106
 107 [TODO:
 108
 109 * talk about /etc/profile.d/lilypond-profile.sh
 110
 111 * GUILE errors
 112
 113 * TEX errors
 114
 115 ]
 116
 117
 118