Documentation/lilypond.pod

   1 =head1 NAME
   2
   3 lilypond - the GNU music typesetter
   4
   5 =head1 SYNOPSIS
   6
   7         lilypond [options] [inputfiles]
   8
   9 =head1 DESCRIPTION
  10
  11 Technically GNU LilyPond is a preprocessor which generates TeX
  12 (or LaTeX) output which contains information to typeset a musical
  13 score. Practically it is a typesetter, which only uses TeX as an
  14 output medium. (this is handy because there exist music fonts for TeX)
  15
  16 As a bonus, you can also output a MIDI file of what you typed.
  17
  18 It translates script files (mudela files or F<*.ly>'s) into TeX input.
  19 Typesetting music is a complex task, whereas the message that printed
  20 music conveys is usually a simple one. GNU LilyPond is a try at providing
  21 a simple interface for setting music.
  22
  23
  24 =head1 OPTIONS
  25
  26 =over 5
  27
  28 =item B<-I,--include>=F<FILE>,
  29
  30 add F<FILE> to the search path for input files.
  31
  32
  33 =item B<-M,--midi>
  34
  35 do midi output only
  36
  37 =item B<-d,--debug>,
  38
  39 Turn debugging info. GNU LilyPond will read the file F<.dstreamrc>, which
  40 tells for what functions and classes may produce copious debugging
  41 output.
  42
  43 =item B<-w,--warranty>,
  44
  45 Show the warranty with which GNU LilyPond comes. (It comes with B<NO
  46 WARRANTY>!)
  47
  48 =item B<-o,--output=>F<FILE>,
  49
  50 Set the default output file to F<FILE>.
  51
  52 =item B<-h,--help>,
  53
  54 Show a summary of usage
  55
  56 =item B<-i,--init=>F<FILE>
  57
  58 set init file to F<FILE> (default: F<symbol.ini>)
  59
  60 =item B<--include, -I>=F<DIRECTORY>
  61 add F<DIRECTORY> to the search path for input files.
  62
  63 =back
  64
  65 =head1 FEATURES
  66
  67 This is an overview of the features that GNU LilyPond supports. For
  68 details on how to use them, you should consult mudela(5)
  69
  70 =over 5
  71
  72 =item *
  73
  74 ASCII script input, with identifiers (for music reuse),
  75 customizable notenames, customizable fontset
  76
  77 =item *
  78
  79 MIDI output lets you check if you have entered the correct notes.
  80
  81 =item *
  82
  83 MIDI to Mudela conversion through the mi2mu program.
  84
  85 =item *
  86
  87 Multiple staffs in one score. Each staff can have a different meters.
  88
  89 =item *
  90
  91 multiple stafftypes (melodic, rhythmic) [broken from  pl28 on]
  92
  93 =item *
  94
  95 beams, slurs, chords, super/subscripts (accents and text), triplets,
  96 general n-plet (triplet, quadruplets, etc.), lyrics, transposition
  97 dynamics (both absolute and hairpin style)
  98
  99 =item *
 100
 101 multiple voices within one staff; beams optionally shared
 102 between voices. Up to four voices is handled cleanly.
 103
 104 =item *
 105
 106 multiple scores within one input file. Each score is output to
 107 a different file.
 108
 109 =item *
 110
 111 clef changes, meter changes, cadenza-mode, key changes, repeat bars
 112
 113 =back
 114
 115 =head1
 116 DISCLAIMER & COPYING POLICY
 117
 118 GNU LilyPond is copyright 1996,97 by its authors. GNU LilyPond is
 119 distributed under the terms of the GNU General Public
 120 License. GNU LilyPond is provided without any warranty what so ever.
 121 GNU LilyPond may be freely distributed.  For further information consult
 122 the GNU General Public License, which is in the file F<COPYING>
 123
 124 =head1 AUTHORS
 125
 126 Please consult the documentation file AUTHORS for more detailed
 127 information, and small contributions.
 128
 129 =over 4
 130
 131 =item *
 132
 133 Han-Wen Nienhuys <hanwen@stack.nl>, http://www.stack.nl/~hanwen
 134
 135 Main author
 136
 137 =item *
 138
 139 Jan Nieuwenhuizen <jan@digicash.com>,  http://www.digicash.com/~jan.
 140
 141 Context errors, Lyrics, mi2mu, MIDI stuff, make structure, bits of
 142 FlowerLib, general comments, Mudela design.
 143
 144 =back
 145
 146 Your name could be here! If you want to help, then take a look at the
 147 SMALLISH PROJECTS section of in the file F<TODO>. Some do not involve
 148 coding C++
 149
 150 =head1 EXAMPLES
 151
 152 At this time, GNU LilyPond output looks nice, but is not of production
 153 quality. If you're not discouraged; this is what I type in my xterm:
 154
 155         lilypond someinput.ly
 156         tex test
 157         xdvi test&
 158
 159 This is what the output looks like over here:
 160
 161         hw:~/musix/spacer$ lilypond input/kortjakje.ly
 162         GNU LilyPond 0.0.52 #1/FlowerLib 1.1.12 #1
 163         Parsing ... [/home/hw/share/lilypond/init//symbol.ini[
 164                 <lots of stuff deleted>
 165         ][./input/kortjakje.ly]
 166
 167         Setting up music ...Processing music ...[8][16][24][25]
 168         Preprocessing ...
 169         Calculating column positions ... [3][9][14][18][22][25]
 170         Postprocessing ...
 171         TeX output to lelie.out ...
 172
 173         hw:~/musix/spacer$ tex test
 174         This is TeX, Version 3.14159 (C version 6.1)
 175         (/home/hw/lib/texmf/tex/lilypond/test.tex
 176         Hyphenation patterns for english, dutch, loaded.
 177         (/home/hw/lib/texmf/tex/lilypond/lilyponddefs.tex) (lelie.out) [1] )
 178         Output written on test.dvi (1 page, 9180 bytes).
 179         Transcript written on test.log.
 180
 181         hw:~/musix/spacer$ xdvi test&
 182         [1] 855
 183
 184 Check out the input files, some of them have comments
 185
 186
 187 =head1 PROBLEMS
 188
 189 If GNU LilyPond bombs out, then please recompile using with debugging info
 190 turned on, and send a copy of the input which causes the error and a
 191 gdb stacktrace of the crash. It also helps if you can print the values
 192 of the objects. So if your trace is
 193
 194         (gdb) backtrace 12
 195         #0  Interval::operator+= (this=0x11fffec60..)
 196             at ../flower/interval.hh:50
 197         #1  0x12005195c in Item::width (this=0x14008a680) at src/item.cc:39
 198         #2  0x12008fdbc in itemlist_width (its=0x11fffed58 ..
 199           :
 200           :
 201
 202 Than it would help if you send a dump of the Interval and the Item
 203 (use: C<print *this> or use GNU LilyPond C<print()> methods).
 204
 205 This is a beta version of GNU LilyPond. Please send your helpful comments
 206 and patches to me (see AUTHORS section)
 207
 208 GNU LilyPond is updated very frequently, the latest version is always available at:
 209 ftp://pcnov095.win.tue.nl/pub/lilypond.
 210
 211
 212 =head1 FILES
 213
 214 =over 5
 215
 216 =item F<symbol.ini>
 217
 218 The initialisation file with symbol tables etc. It
 219 includes files from the directory F<init/>.
 220
 221 =back
 222
 223 =head1 ENVIRONMENT
 224
 225 B<LILYINCLUDE> an (one) additional directory for finding lilypond data.
 226
 227 =head1 SEE ALSO
 228
 229 =over 4
 230
 231 =item lilygut(?)
 232
 233 On technical details of LilyPond
 234
 235 =item mudela(5)
 236
 237 On the input format
 238
 239 =item MANIFESTO
 240
 241 Goals of the GNU LilyPond project.
 242
 243 =item The GNU LilyPond FAQ list
 244
 245 =back
 246
 247 GNU LilyPond has her own webpage at
 248 http://www.stack.nl/~hanwen/lilypond/index.html. This webpage contains
 249 the MIDI, GIF and PS files for some standard music files. It also has
 250 the complete LilyPond documentation
 251
 252 =head1  REMARKS
 253
 254 GNU LilyPond has no connection with the music package Rosegarden, other
 255 than the names being similar :-)
 256
 257 =head1 HISTORY
 258
 259 (for a  detailed changelog, see F<NEWS>)
 260
 261 GNU LilyPond's roots lie in MPP, a preprocessor to the rather arcane
 262 MusiXTeX macro package for TeX. A friend of mine, Jan Nieuwenhuizen
 263 wrote the first 44 versions (0.01 to 0.44), then his program caught my
 264 attention, and I was slowly sucked in to the interesting problem of
 265 easily producing beautifully printed music. I contributed some
 266 code. We soon realised that MPP's design was too fundamentally broken
 267 to be repaired. It was decided to rewrite MPP.  We debated a lot about
 268 the requirements to an inputformat (fall 1995). I sat down and started
 269 with a parser-first, bottom-up rewrite called mpp95 (which totally
 270 failed, obviously).
 271
 272 After long and hard thinking, I came up with an algorithm for the
 273 horizontal spacing of multiple staffs (april 1996) I coded it (and did
 274 not test it). After starting with this fundamental piece, I slowly
 275 added the stages which come before spacing, and after.  A half year
 276 later later, I had a first working version, (october 1996).  I
 277 announced Patchlevel 0.0.7 (or 8) to the mutex list after asking some
 278 technical details on spacing; it was downloaded approximately 4 times.
 279 Then I got the hang of it, and in the subsequent two months, I coded
 280 until it had doubled in size (pl 23).