Documentation/README.pod

   1 =head1 NAME
   2
   3 LilyPond - a music typesetter
   4
   5 =head1 SYNOPSIS
   6
   7         lilypond [options] [inputfiles]
   8
   9 =head1 DESCRIPTION
  10
  11 LilyPond typesets music. It translates script files (mudela files or
  12 F<*.ly>'s) into TeX input.  Typesetting music is a complex task,
  13 whereas the message that printed music conveys is usually a simple
  14 one. LilyPond is a try at providing a simple interface for setting
  15 music. LilyPond has these features:
  16
  17
  18 =over 5
  19
  20 =item *
  21 ASCII script input, with identifiers (for music reuse),
  22 customizable notenames, customizable fontset
  23
  24 =item *
  25 multiple staffs in one score
  26
  27 =item *
  28 multiple stafftypes (melodic, rhythmic)
  29
  30 =item *
  31 beams, slurs, chords, super/subscripts (accents and text),
  32 triplets, general n-plet (triplet, quadruplets, etc.), lyrics
  33
  34 =item *
  35 multiple voices within one staff; beams optionally shared
  36 between voices.
  37
  38 =item *
  39 multiple scores within one input file. Each score is output to
  40 a different file.
  41
  42 =item *
  43 clef changes, meter changes, cadenza-mode, declaring markings
  44 in the music, repeat bars
  45
  46
  47 =back
  48
  49 =head1 DESIGN CONSIDERATIONS
  50
  51 LilyPond was written with some considerations in mind:
  52
  53 =over 5
  54
  55 =item *
  56 Describing a well-defined language for defining music. We call
  57 this language (rather arrogantly) The Musical Definition Language
  58 (mudela for short). LilyPond reads a mudela sourcefile and outputs a
  59 TeX file.  This musical definition language should:
  60
  61 =over 5
  62
  63 =item 1.
  64 define the musical message of the writer as unambigiously as
  65 possible.
  66
  67 =item 2.
  68 be easily readable. (as compared to, say, MusixTeX input)
  69
  70 =item 3.
  71 be writable in ASCII (with a simple texteditor).
  72
  73 =back
  74
  75 At this time, the language isn't yet defined precisely. It is evolving as
  76 LilyPond is getting more complex.
  77
  78 =item *
  79 We want to provide an easy-to-use interface for typesetting music in
  80 its broadest sense. This interface should be intuitive from a musical
  81 point of view. By broadest sense we mean: it is designed for music
  82 printed left to right in staffs, using notes to designate rythm and
  83 pitch.
  84
  85 =item *
  86 LilyPond uses MusiXTeX fonts and TeX for its output. This is not a key
  87 issue: in a future version, LilyPond might bypass TeX, but at the moment
  88 TeX is very convenient for producing output.
  89
  90 =item  *
  91 Generate high-quality output. Ideally it should be of a professional
  92 quality. We'd like to render Herbert Chlapiks words, "Fine music
  93 setting is not possible without a knowledgeable printer,"  untrue.
  94
  95 =item *
  96 LilyPond does not display notes directly, nor will it be rehacked to be
  97 used interactively. LilyPond writes output to a file.  It will not be
  98 extended to play music, or to recognize music.
  99
 100 We're thinking about adding MIDI output, though
 101
 102 =item *
 103 LilyPond is intended to run on Unix platforms, but it should
 104 be portable to any platform which can run TeX and the GNU tools
 105
 106 =item *
 107 LilyPond is free. Commercial windows packages for setting music are
 108 abundant. Free musicprinting software is scarce.
 109
 110 =item *
 111 LilyPond is written in GNU C++. It will not be downgraded/ported to fit
 112 broken systems.
 113
 114 =back
 115
 116
 117
 118 =head1 OPTIONS
 119
 120 =over 5
 121
 122 =item   B<-I,--include>=F<FILE>
 123
 124 add F<FILE> to the search path for input files.
 125
 126 =item   B<-d,--debug>,
 127
 128 debugging. LilyPond will read the file F<.dstreamrc>, which tells for what functions to produce copious debugging output.
 129
 130 =item   B<-w,--warranty>,
 131
 132 Show the warranty with which LilyPond comes. (It comes with B<NO WARRANTY>!)
 133
 134 =item  B<-o,--output=>F<FILE>,
 135
 136 Set the default output file to F<FILE>.
 137
 138 =item   B<-h,--help>,
 139
 140 Show a summary of usage
 141
 142 =item   B<--init, -i>
 143
 144 set init file (default: symbol.ini)
 145
 146 =item B<--include, -I>
 147 add to file search path.
 148
 149 =back
 150
 151 =head1
 152 DISCLAIMER & COPYING POLICY
 153
 154 LilyPond is copyright 1996,97 by its authors. LilyPond is
 155 distributed under the terms of the GNU General Public
 156 License. LilyPond is provided without any warranty what so ever.
 157 LilyPond may be freely distributed.  For further information consult
 158 the GNU General Public License, which is in the file F<COPYING>
 159
 160 =head1 PREREQUISITES
 161
 162 Compilation:
 163
 164 =over 5
 165
 166 =item *
 167  Unix. Any decent Linux distribution is fine. LilyPond is known to run
 168 on Linux, AIX, Digital Unix and Solaris
 169
 170 =item *
 171 GNU C++ v2.7  or better, with libg++. Version 2.7.2 or better recommended.
 172
 173 =item *
 174 GNU make.
 175
 176 =item *
 177 flex (2.5.1 or better)
 178
 179 =item *
 180 Bison or YACC.
 181
 182 =item *
 183 The "Flower" library, which should be available from the same
 184 source you got this from.
 185
 186 =item *
 187 perl.  The Makefile uses perl for trivial operations, and you
 188 could tinker with it to use sed or awk.
 189
 190 =back
 191
 192 LilyPond does use a lot of resources. For operation you need the following:
 193
 194 =over 5
 195
 196 =item *
 197 TeX
 198
 199 =item *
 200 The MusixTeX fonts. (I use version T.59)
 201
 202 =back
 203
 204 =head1 COMPILING
 205
 206 Do:
 207
 208         tar zxf flower-1.11.9.tar.gz
 209         tar zxf lilypond-1.2.13.tar.gz
 210         cd lilypond-1.2.13
 211         configure
 212         make
 213
 214 You might want to edit Variables.make to tailor the compilation flags.
 215 why G++ >= 2.7? LilyPond & flower lib uses:
 216
 217 =over 5
 218
 219 =item *
 220 builtin bool
 221
 222 =item *
 223 typeof
 224
 225 =item *
 226 operator <?, operator >?
 227
 228 =item *
 229 the new for-scope
 230
 231 =item    *
 232 class Rational (libg++)
 233
 234 =item *
 235 named return values
 236
 237 =back
 238
 239 =head1 AUTHORS
 240
 241 =over 5
 242
 243 =item *
 244 Han-Wen Nienhuys <hanwen@stack.nl>, Main author
 245
 246 =item *
 247 Jan Nieuwenhuizen <jan@digicash.com>, Context errors, Lyrics,
 248 bits of FlowerLib, general comments.
 249
 250 =item *
 251 Mats Bengtsson <matsb@s3.kth.se>, bugfixes, testing, general comments.
 252
 253 =back
 254
 255 Your name could be here! If you want to help, then take a look at the
 256 SMALLISH PROJECTS section of in the file F<TODO>. Some do not involve
 257 coding C++
 258
 259 =head1 EXAMPLES
 260
 261 At this time, LilyPond is only suited for Quick & Dirty jobs (the
 262 output quality of multistaff material still is too low). If you're not
 263 discouraged; this is what I type in my xterm:
 264
 265         lilypond someinput.ly
 266         tex test
 267         xdvi test&
 268
 269 This is what the output looks like over here:
 270
 271         hw:~/musix/spacer$ lilypond input/maartje.ly
 272         LilyPond 0.0.27/FlowerLib 1.0.23. Compile: Feb  5 1997, 00:28:13 (g++ 2.7.2)
 273         Parsing ... [./init//symbol.ini[./init/dutch.ini][./init/script.ini][./init/table_sixteen.ini]][./input/maartje.ly]
 274         Processing music ... Preprocessing ... Calculating ... Postprocessing ...
 275         output to lelie.out...
 276
 277         hw:~/musix/spacer$ tex test
 278         This is TeX, Version 3.14159 (C version 6.1)
 279         (test.tex
 280         Hyphenation patterns for english, dutch, loaded.
 281         (lilyponddefs.tex) (lelie.uit) [1] [2] )
 282         Output written on test.dvi (2 pages, 8420 bytes).
 283         Transcript written on test.log.
 284
 285         hw:~/musix/spacer$ xdvi test&
 286         [1] 855
 287
 288 Check out F<kortjakje.ly>, it has some comments
 289
 290
 291 =head1 PROBLEMS
 292
 293 If LilyPond bombs out, then please recompile using B<-g>, and send a
 294 copy of the input which causes the error and a gdb stacktrace of the
 295 crash. It also helps if you can print the values of the objects. So if
 296 your trace is
 297
 298         (gdb) backtrace 12
 299         #0  Interval::operator+= (this=0x11fffec60..)
 300             at ../flower/interval.hh:50
 301         #1  0x12005195c in Item::width (this=0x14008a680) at src/item.cc:39
 302         #2  0x12008fdbc in itemlist_width (its=0x11fffed58 ..
 303           :
 304           :
 305
 306 Than it would help if you send a dump of the Interval and the Item
 307 (use: C<print *this> or use LilyPond C<print()> methods).
 308
 309 This is a beta version of LilyPond. Please send your helpful comments
 310 and patches to me (see AUTHORS section)
 311
 312 LilyPond is updated very frequently, the latest version is always available at:
 313 ftp://pcnov095.win.tue.nl/pub/lilypond.
 314
 315
 316 =head1 FILES
 317
 318 =over 5
 319
 320 =item F<symbol.ini>
 321 The initialisation file with symbol tables etc. It
 322 includes files from the directory F<init/>.
 323
 324 =back
 325
 326 =head1 SEE ALSO
 327
 328 There are some documentation files  in the subdirectory F<Documentation/>,
 329 among others: lilygut, lilyinput, error, faq,
 330
 331 =head1  REMARKS
 332
 333 LilyPond has no connection with the music package RoseGarden, other
 334 than the names being similar.
 335
 336
 337 =head1 HISTORY
 338
 339 (for a  detailed changelog, see F<NEWS>)
 340
 341 LilyPond's roots lie in MPP, a preprocessor to the rather arcane
 342 MusiXTeX macro package for TeX. A friend of mine, Jan Nieuwenhuizen
 343 wrote the first 44 versions (0.01 to 0.44), then his program caught my
 344 attention, and I was slowly sucked in to the interesting problem of
 345 easily producing beautifully printed music. I contributed some
 346 code. We soon realised that MPP's design was too fundamentally broken
 347 to be repaired. It was decided to rewrite MPP.  We debated a lot about
 348 the requirements to an inputformat (fall 1995). I sat down and started
 349 with a parser-first, bottom-up rewrite called mpp95 (which totally
 350 failed, obviously).
 351
 352 After long and hard thinking, I came up with an algorithm for the
 353 horizontal spacing of multiple staffs (april 1996) I coded it (and did
 354 not test it). After starting with this fundamental piece, I slowly
 355 added the stages which come before spacing, and after.  A half year
 356 later later, I had a first working version, (october 1996).  I
 357 announced Patchlevel 0.0.7 (or 8) to the mutex list after asking some
 358 technical details on spacing; it was downloaded approximately 4 times.
 359 Then I got the hang of it, and in the subsequent two months, I coded
 360 until it had doubled in size (pl 23).