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 MIDI output lets you check if you have entered the correct notes.
  26
  27 =item *
  28 Multiple staffs in one score. Each staff can have a different meters.
  29
  30 =item *
  31 multiple stafftypes (melodic, rhythmic) [broken from  pl28 on]
  32
  33 =item *
  34 beams, slurs, chords, super/subscripts (accents and text),
  35 triplets, general n-plet (triplet, quadruplets, etc.), lyrics
  36
  37 =item *
  38 multiple voices within one staff; beams optionally shared
  39 between voices. (well, more than 2 voices won't look pretty --yet.)
  40
  41 =item *
  42 multiple scores within one input file. Each score is output to
  43 a different file.
  44
  45 =item *
  46 clef changes, meter changes, cadenza-mode, key changes, repeat bars
  47
  48 =back
  49
  50 =head1 DESIGN CONSIDERATIONS
  51
  52 LilyPond was written with some considerations in mind:
  53
  54 =over 5
  55
  56 =item *
  57 Describing a well-defined language for defining music. We call
  58 this language (rather arrogantly) The Musical Definition Language
  59 (mudela for short). LilyPond reads a mudela sourcefile and outputs a
  60 TeX file.  This musical definition language should:
  61
  62 =over 5
  63
  64 =item 1.
  65 define the musical message of the writer as unambigiously as
  66 possible.
  67
  68 =item 2.
  69 be easily readable. (as compared to, say, MusixTeX input)
  70
  71 =item 3.
  72 be writable in ASCII (with a simple texteditor).
  73
  74 =back
  75
  76 At this time, the language isn't yet defined precisely. It is evolving as
  77 LilyPond is getting more complex.
  78
  79 =item *
  80 We want to provide an easy-to-use interface for typesetting music in
  81 its broadest sense. This interface should be intuitive from a musical
  82 point of view. By broadest sense we mean: it is designed for music
  83 printed left to right in staffs, using notes to designate rythm and
  84 pitch.
  85
  86 =item *
  87 LilyPond uses MusiXTeX fonts and TeX for its output. This is not a key
  88 issue: in a future version, LilyPond might bypass TeX, but at the moment
  89 TeX is very convenient for producing output.
  90
  91 =item  *
  92 Generate high-quality output. Ideally it should be of a professional
  93 quality. We'd like to render Herbert Chlapiks words, "Fine music
  94 setting is not possible without a knowledgeable printer,"  untrue.
  95
  96 =item *
  97 LilyPond does not display notes directly, nor will it be rehacked to be
  98 used interactively. LilyPond writes output to a file.  It will not be
  99 extended to play music, or to recognize music.
 100
 101 =item *
 102 LilyPond is intended to run on Unix platforms, but it should
 103 be portable to any platform which can run TeX and the GNU tools
 104
 105 =item *
 106 LilyPond is free. Commercial windows packages for setting music are
 107 abundant. Free musicprinting software is scarce.
 108
 109 =item *
 110 LilyPond is written in GNU C++. It will not be downgraded/ported to fit
 111 broken systems.
 112
 113 =back
 114
 115 =head1 OPTIONS
 116
 117 =over 5
 118
 119 =item B<-I,--include>=F<FILE>,
 120
 121 add F<FILE> to the search path for input files.
 122
 123
 124 =item B<-M,--midi>
 125
 126 do midi output only
 127
 128 =item B<-d,--debug>,
 129
 130 Turn debugging info. LilyPond will read the file F<.dstreamrc>, which
 131 tells for what functions and classes may produce copious debugging
 132 output.
 133
 134 =item B<-w,--warranty>,
 135
 136 Show the warranty with which LilyPond comes. (It comes with B<NO WARRANTY>!)
 137
 138 =item B<-o,--output=>F<FILE>,
 139
 140 Set the default output file to F<FILE>.
 141
 142 =item   B<-h,--help>,
 143
 144 Show a summary of usage
 145
 146 =item   B<-i,--init=>F<FILE>
 147
 148 set init file to F<FILE> (default: F<symbol.ini>)
 149
 150 =item B<--include, -I>=F<DIRECTORY>
 151 add F<DIRECTORY> to the search path for input files.
 152
 153 =back
 154
 155 =head1
 156 DISCLAIMER & COPYING POLICY
 157
 158 LilyPond is copyright 1996,97 by its authors. LilyPond is
 159 distributed under the terms of the GNU General Public
 160 License. LilyPond is provided without any warranty what so ever.
 161 LilyPond may be freely distributed.  For further information consult
 162 the GNU General Public License, which is in the file F<COPYING>
 163
 164 =head1 PREREQUISITES
 165
 166 For compilation you need.
 167
 168 =over 5
 169
 170 =item *
 171 Unix. LilyPond is known to run on Linux, AIX, Digital Unix and
 172 Solaris (if you have the Cygnus WIN32 port of the GNU utils, it will
 173 even work in Lose NT/95)
 174
 175 =item *
 176 GNU C++ v2.7 or better, with libg++ installed.  Version 2.7.2
 177 or better recommended. I doubt if it will compile with AT&T CC.
 178
 179 =item *
 180 GNU make.
 181
 182 =item *
 183 Flex (2.5.1 or better)
 184
 185 =item *
 186 Bison.
 187
 188 =item *
 189 The "Flower" library, which should be available from the same
 190 source you got this from. The version of flower lib should match the
 191 one which is found in the F<configure> script.
 192
 193 =item *
 194 Perl.  The Makefile uses Perl for trivial operations, and you
 195 could tinker with it to use sed or awk.
 196
 197 =back
 198
 199 LilyPond does use a lot of resources. For operation you need the following:
 200
 201 =over 5
 202
 203 =item *
 204 a fast computer (a full page of music typically takes 1 minute
 205 on my 486/66, using the DEBUG compile. It's lot slower than most
 206 MusiXTeX preprocessors)
 207
 208 =item *
 209 TeX
 210
 211 =item *
 212 The MusixTeX fonts. (I use version those found in MusixTeX
 213 Taupin version T.59)
 214
 215 =back
 216
 217 =head1 COMPILING
 218
 219 Do:
 220
 221         tar zxf flower-1.11.9.tar.gz
 222         tar zxf lilypond-1.2.13.tar.gz
 223         cd lilypond-1.2.13
 224         configure
 225         make
 226
 227 You probably want to edit Variables.make to tailor the compilation
 228 flags. If you're not into debugging C++, then you should go for no
 229 debugging and C<-O2>
 230
 231 =head1 AUTHORS
 232
 233 =over 5
 234
 235 =item *
 236 Han-Wen Nienhuys <hanwen@stack.nl>, Main author
 237
 238 =item *
 239 Jan Nieuwenhuizen <jan@digicash.com>, Context errors, Lyrics,
 240 bits of FlowerLib, general comments.
 241
 242 =item *
 243 Mats Bengtsson <matsb@s3.kth.se>, bugfixes, testing, general comments.
 244
 245 =back
 246
 247 Your name could be here! If you want to help, then take a look at the
 248 SMALLISH PROJECTS section of in the file F<TODO>. Some do not involve
 249 coding C++
 250
 251 =head1 EXAMPLES
 252
 253 At this time, LilyPond output looks nice, but is not of production
 254 quality. If you're not discouraged; this is what I type in my xterm:
 255
 256         lilypond someinput.ly
 257         tex test
 258         xdvi test&
 259
 260 This is what the output looks like over here:
 261
 262         LilyPond 0.0.pre32-3/FlowerLib 1.0.27. Compile: Feb 18 1997, 11:21:57 (g++ 2.7.2)
 263         Parsing ... [./init//symbol.ini[./init//dutch.ini][./init//script.ini][./init//table_sixteen.ini]][./input/wohltemperirt.ly]
 264         Setting up music ...Processing music ............
 265         Preprocessing ...
 266         Calculating column positions ... [3][6][9]
 267         Postprocessing ...
 268         warning: slope_index(): beam steeper than 0.5 (-0.555556)
 269         warning: slope_index(): beam steeper than 0.5 (-0.588346)
 270         warning: slope_index(): beam steeper than 0.5 (-0.523166)
 271         warning: slope_index(): beam steeper than 0.5 (0.571915)
 272         warning: slope_index(): beam steeper than 0.5 (-0.555556)
 273         warning: slope_index(): beam steeper than 0.5 (-0.588346)
 274         warning: slope_index(): beam steeper than 0.5 (-0.523166)
 275         warning: slope_index(): beam steeper than 0.5 (0.571915)
 276         output to lelie.out...
 277
 278         hw:~/musix/spacer$ tex test
 279         This is TeX, Version 3.14159 (C version 6.1)
 280         (test.tex
 281         Hyphenation patterns for english, dutch, loaded.
 282         (lilyponddefs.tex) (lelie.uit) [1] [2] )
 283         Output written on test.dvi (2 pages, 8420 bytes).
 284         Transcript written on test.log.
 285
 286         hw:~/musix/spacer$ xdvi test&
 287         [1] 855
 288
 289 Check out the input files, some of them have comments
 290
 291
 292 =head1 PROBLEMS
 293
 294 If LilyPond bombs out, then please recompile using with debugging info
 295 turned on, and send a copy of the input which causes the error and a
 296 gdb stacktrace of the crash. It also helps if you can print the values
 297 of the objects. So if your trace is
 298
 299         (gdb) backtrace 12
 300         #0  Interval::operator+= (this=0x11fffec60..)
 301             at ../flower/interval.hh:50
 302         #1  0x12005195c in Item::width (this=0x14008a680) at src/item.cc:39
 303         #2  0x12008fdbc in itemlist_width (its=0x11fffed58 ..
 304           :
 305           :
 306
 307 Than it would help if you send a dump of the Interval and the Item
 308 (use: C<print *this> or use LilyPond C<print()> methods).
 309
 310 This is a beta version of LilyPond. Please send your helpful comments
 311 and patches to me (see AUTHORS section)
 312
 313 LilyPond is updated very frequently, the latest version is always available at:
 314 ftp://pcnov095.win.tue.nl/pub/lilypond.
 315
 316
 317 =head1 FILES
 318
 319 =over 5
 320
 321 =item F<symbol.ini>
 322 The initialisation file with symbol tables etc. It
 323 includes files from the directory F<init/>.
 324
 325 =back
 326
 327 =head1 SEE ALSO
 328
 329 There are some documentation files  in the subdirectory F<Documentation/>,
 330 among others: lilygut, lilyinput, error, faq,
 331
 332 =head1  REMARKS
 333
 334 LilyPond has no connection with the music package RoseGarden, other
 335 than the names being similar :-)
 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).