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 =over 5
 127
 128 =item *
 129
 130 Han-Wen Nienhuys <hanwen@stack.nl>, http://www.stack.nl/~hanwen
 131
 132 Main author
 133
 134 =item *
 135
 136 Jan Nieuwenhuizen <jan@digicash.com>,  http://www.digicash.com/~jan.
 137
 138 Context errors, Lyrics, mi2mu, MIDI stuff, make structure, bits of
 139 FlowerLib, general comments, Mudela design.
 140
 141 =item *
 142
 143 Mats Bengtsson <matsb@s3.kth.se>, bugfixes, testing, general comments.
 144
 145 =back
 146
 147 Your name could be here! If you want to help, then take a look at the
 148 SMALLISH PROJECTS section of in the file F<TODO>. Some do not involve
 149 coding C++
 150
 151 =head1 EXAMPLES
 152
 153 At this time, GNU LilyPond output looks nice, but is not of production
 154 quality. If you're not discouraged; this is what I type in my xterm:
 155
 156         lilypond someinput.ly
 157         tex test
 158         xdvi test&
 159
 160 This is what the output looks like over here:
 161
 162         hw:~/musix/spacer$ lilypond input/kortjakje.ly
 163         GNU LilyPond 0.0.52 #1/FlowerLib 1.1.12 #1
 164         Parsing ... [/home/hw/share/lilypond/init//symbol.ini[
 165                 <lots of stuff deleted>
 166         ][./input/kortjakje.ly]
 167
 168         Setting up music ...Processing music ...[8][16][24][25]
 169         Preprocessing ...
 170         Calculating column positions ... [3][9][14][18][22][25]
 171         Postprocessing ...
 172         TeX output to lelie.out ...
 173
 174         hw:~/musix/spacer$ tex test
 175         This is TeX, Version 3.14159 (C version 6.1)
 176         (/home/hw/lib/texmf/tex/lilypond/test.tex
 177         Hyphenation patterns for english, dutch, loaded.
 178         (/home/hw/lib/texmf/tex/lilypond/lilyponddefs.tex) (lelie.out) [1] )
 179         Output written on test.dvi (1 page, 9180 bytes).
 180         Transcript written on test.log.
 181
 182         hw:~/musix/spacer$ xdvi test&
 183         [1] 855
 184
 185 Check out the input files, some of them have comments
 186
 187
 188 =head1 PROBLEMS
 189
 190 If GNU LilyPond bombs out, then please recompile using with debugging info
 191 turned on, and send a copy of the input which causes the error and a
 192 gdb stacktrace of the crash. It also helps if you can print the values
 193 of the objects. So if your trace is
 194
 195         (gdb) backtrace 12
 196         #0  Interval::operator+= (this=0x11fffec60..)
 197             at ../flower/interval.hh:50
 198         #1  0x12005195c in Item::width (this=0x14008a680) at src/item.cc:39
 199         #2  0x12008fdbc in itemlist_width (its=0x11fffed58 ..
 200           :
 201           :
 202
 203 Than it would help if you send a dump of the Interval and the Item
 204 (use: C<print *this> or use GNU LilyPond C<print()> methods).
 205
 206 This is a beta version of GNU LilyPond. Please send your helpful comments
 207 and patches to me (see AUTHORS section)
 208
 209 GNU LilyPond is updated very frequently, the latest version is always available at:
 210 ftp://pcnov095.win.tue.nl/pub/lilypond.
 211
 212
 213 =head1 FILES
 214
 215 =over 5
 216
 217 =item F<symbol.ini>
 218
 219 The initialisation file with symbol tables etc. It
 220 includes files from the directory F<init/>.
 221
 222 =back
 223
 224 =head1 ENVIRONMENT
 225
 226 B<LILYINCLUDE> an (one) additional directory for finding lilypond data.
 227
 228 =head1 SEE ALSO
 229
 230 =over 4
 231
 232 =item lilygut(?)
 233
 234 On technical details of LilyPond
 235
 236 =item mudela(5)
 237
 238 On the input format
 239
 240 =item MANIFESTO
 241
 242 Goals of the GNU LilyPond project.
 243
 244 =item The GNU LilyPond FAQ list
 245
 246 =back
 247
 248 GNU LilyPond has her own webpage at
 249 http://www.stack.nl/~hanwen/lilypond/index.html. This webpage contains
 250 the MIDI, GIF and PS files for some standard music files. It also has
 251 the complete LilyPond documentation
 252
 253 =head1  REMARKS
 254
 255 GNU LilyPond has no connection with the music package Rosegarden, other
 256 than the names being similar :-)
 257
 258 =head1 HISTORY
 259
 260 (for a  detailed changelog, see F<NEWS>)
 261
 262 GNU LilyPond's roots lie in MPP, a preprocessor to the rather arcane
 263 MusiXTeX macro package for TeX. A friend of mine, Jan Nieuwenhuizen
 264 wrote the first 44 versions (0.01 to 0.44), then his program caught my
 265 attention, and I was slowly sucked in to the interesting problem of
 266 easily producing beautifully printed music. I contributed some
 267 code. We soon realised that MPP's design was too fundamentally broken
 268 to be repaired. It was decided to rewrite MPP.  We debated a lot about
 269 the requirements to an inputformat (fall 1995). I sat down and started
 270 with a parser-first, bottom-up rewrite called mpp95 (which totally
 271 failed, obviously).
 272
 273 After long and hard thinking, I came up with an algorithm for the
 274 horizontal spacing of multiple staffs (april 1996) I coded it (and did
 275 not test it). After starting with this fundamental piece, I slowly
 276 added the stages which come before spacing, and after.  A half year
 277 later later, I had a first working version, (october 1996).  I
 278 announced Patchlevel 0.0.7 (or 8) to the mutex list after asking some
 279 technical details on spacing; it was downloaded approximately 4 times.
 280 Then I got the hang of it, and in the subsequent two months, I coded
 281 until it had doubled in size (pl 23).