Documentation/lilypond.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 Technically 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. 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. 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 LilyPond comes. (It comes with B<NO WARRANTY>!)
  46
  47 =item B<-o,--output=>F<FILE>,
  48
  49 Set the default output file to F<FILE>.
  50
  51 =item B<-h,--help>,
  52
  53 Show a summary of usage
  54
  55 =item B<-i,--init=>F<FILE>
  56
  57 set init file to F<FILE> (default: F<symbol.ini>)
  58
  59 =item B<--include, -I>=F<DIRECTORY>
  60 add F<DIRECTORY> to the search path for input files.
  61
  62 =back
  63
  64 =head1 FEATURES
  65
  66 =over 5
  67
  68 =item *
  69
  70 ASCII script input, with identifiers (for music reuse),
  71 customizable notenames, customizable fontset
  72
  73 =item *
  74
  75 MIDI output lets you check if you have entered the correct notes.
  76
  77 =item *
  78
  79 MIDI to Mudela conversion through the mi2mu program.
  80
  81 =item *
  82
  83 Multiple staffs in one score. Each staff can have a different meters.
  84
  85 =item *
  86
  87 multiple stafftypes (melodic, rhythmic) [broken from  pl28 on]
  88
  89 =item *
  90
  91 beams, slurs, chords, super/subscripts (accents and text), triplets,
  92 general n-plet (triplet, quadruplets, etc.), lyrics, transposition
  93
  94 =item *
  95
  96 multiple voices within one staff; beams optionally shared
  97 between voices. (well, more than 2 voices won't look pretty --yet.)
  98
  99 =item *
 100
 101 multiple scores within one input file. Each score is output to
 102 a different file.
 103
 104 =item *
 105
 106 clef changes, meter changes, cadenza-mode, key changes, repeat bars
 107
 108 =back
 109
 110 =head1 DESIGN CONSIDERATIONS
 111
 112 LilyPond was written with some considerations in mind:
 113
 114 =over 5
 115
 116 =item *
 117
 118 Describing a well-defined language for defining music. We call
 119 this language (rather arrogantly) The Musical Definition Language
 120 (mudela for short). LilyPond reads a mudela sourcefile and outputs a
 121 TeX file.
 122
 123 =item *
 124
 125 We want to provide an easy-to-use interface for typesetting music in
 126 its broadest sense. This interface should be intuitive from a musical
 127 point of view. By broadest sense we mean: it is designed for music
 128 printed left to right in staffs, using notes to designate rythm and
 129 pitch.
 130
 131 =item *
 132
 133 LilyPond uses MusiXTeX fonts and TeX for its output. This is not a key
 134 issue: in a future version, LilyPond might bypass TeX, but at the moment
 135 TeX is very convenient for producing output.
 136
 137 =item  *
 138
 139 Generate high-quality output. Ideally it should be of a professional
 140 quality. We'd like to render Herbert Chlapiks words, "Fine music
 141 setting is not possible without a knowledgeable printer,"  untrue.
 142
 143 =item *
 144
 145 LilyPond does not display notes directly, nor will it be rehacked to be
 146 used interactively. LilyPond writes output to a file.  It will not be
 147 extended to play music, or to recognize music.
 148
 149 =item *
 150
 151 LilyPond is intended to run on Unix platforms, but it should
 152 be portable to any platform which can run TeX and the GNU tools
 153
 154 =item *
 155
 156 LilyPond is free. Commercial windows packages for setting music are
 157 abundant. Free musicprinting software is scarce.
 158
 159 =item *
 160
 161 LilyPond is written in GNU C++. It will not be downgraded/ported to fit
 162 broken systems.
 163
 164 =back
 165
 166 =head1
 167 DISCLAIMER & COPYING POLICY
 168
 169 LilyPond is copyright 1996,97 by its authors. LilyPond is
 170 distributed under the terms of the GNU General Public
 171 License. LilyPond is provided without any warranty what so ever.
 172 LilyPond may be freely distributed.  For further information consult
 173 the GNU General Public License, which is in the file F<COPYING>
 174
 175 =head1 AUTHORS
 176
 177 =over 5
 178
 179 =item *
 180
 181 Han-Wen Nienhuys <hanwen@stack.nl>, Main author
 182
 183 =item *
 184
 185 Jan Nieuwenhuizen <jan@digicash.com>, Context errors, Lyrics,
 186 mi2mu, MIDI stuff, make structure, bits of FlowerLib, general
 187 comments, Mudela design.
 188
 189 =item *
 190
 191 Mats Bengtsson <matsb@s3.kth.se>, bugfixes, testing, general comments.
 192
 193 =back
 194
 195 Your name could be here! If you want to help, then take a look at the
 196 SMALLISH PROJECTS section of in the file F<TODO>. Some do not involve
 197 coding C++
 198
 199 =head1 EXAMPLES
 200
 201 At this time, LilyPond output looks nice, but is not of production
 202 quality. If you're not discouraged; this is what I type in my xterm:
 203
 204         lilypond someinput.ly
 205         tex test
 206         xdvi test&
 207
 208 This is what the output looks like over here:
 209
 210         LilyPond 0.0.40 #0/FlowerLib 1.1.7 #2. Compile: Mar 11 1997, 22:58:47 (g++ 2.7.2)
 211         Parsing ... [./init//symbol.ini[./init//dynamic.ini][./init//dutch.ini][./init//script.ini][./init//table_sixteen.ini]][./input/wohltemperirt.ly]
 212         Setting up music ...Processing music ............
 213         Preprocessing ...
 214         Calculating column positions ... [3][6][9]
 215         Postprocessing ...
 216         TeX output to lelie.out ...
 217         midi output to lelie.midi ...
 218
 219         hw:~/musix/spacer$ tex test
 220         This is TeX, Version 3.14159 (C version 6.1)
 221         (test.tex
 222         Hyphenation patterns for english, dutch, loaded.
 223         (lilyponddefs.tex) (lelie.uit) [1] [2] )
 224         Output written on test.dvi (2 pages, 8420 bytes).
 225         Transcript written on test.log.
 226
 227         hw:~/musix/spacer$ xdvi test&
 228         [1] 855
 229
 230 Check out the input files, some of them have comments
 231
 232
 233 =head1 PROBLEMS
 234
 235 If LilyPond bombs out, then please recompile using with debugging info
 236 turned on, and send a copy of the input which causes the error and a
 237 gdb stacktrace of the crash. It also helps if you can print the values
 238 of the objects. So if your trace is
 239
 240         (gdb) backtrace 12
 241         #0  Interval::operator+= (this=0x11fffec60..)
 242             at ../flower/interval.hh:50
 243         #1  0x12005195c in Item::width (this=0x14008a680) at src/item.cc:39
 244         #2  0x12008fdbc in itemlist_width (its=0x11fffed58 ..
 245           :
 246           :
 247
 248 Than it would help if you send a dump of the Interval and the Item
 249 (use: C<print *this> or use LilyPond C<print()> methods).
 250
 251 This is a beta version of LilyPond. Please send your helpful comments
 252 and patches to me (see AUTHORS section)
 253
 254 LilyPond is updated very frequently, the latest version is always available at:
 255 ftp://pcnov095.win.tue.nl/pub/lilypond.
 256
 257
 258 =head1 FILES
 259
 260 =over 5
 261
 262 =item F<symbol.ini>
 263 The initialisation file with symbol tables etc. It
 264 includes files from the directory F<init/>.
 265
 266 =back
 267
 268 =head1 SEE ALSO
 269
 270 There are some documentation files  in the subdirectory F<Documentation/>,
 271 among others: lilygut, lilyinput, error, faq,
 272
 273 =head1  REMARKS
 274
 275 LilyPond has no connection with the music package RoseGarden, other
 276 than the names being similar :-)
 277
 278 =head1 HISTORY
 279
 280 (for a  detailed changelog, see F<NEWS>)
 281
 282 LilyPond's roots lie in MPP, a preprocessor to the rather arcane
 283 MusiXTeX macro package for TeX. A friend of mine, Jan Nieuwenhuizen
 284 wrote the first 44 versions (0.01 to 0.44), then his program caught my
 285 attention, and I was slowly sucked in to the interesting problem of
 286 easily producing beautifully printed music. I contributed some
 287 code. We soon realised that MPP's design was too fundamentally broken
 288 to be repaired. It was decided to rewrite MPP.  We debated a lot about
 289 the requirements to an inputformat (fall 1995). I sat down and started
 290 with a parser-first, bottom-up rewrite called mpp95 (which totally
 291 failed, obviously).
 292
 293 After long and hard thinking, I came up with an algorithm for the
 294 horizontal spacing of multiple staffs (april 1996) I coded it (and did
 295 not test it). After starting with this fundamental piece, I slowly
 296 added the stages which come before spacing, and after.  A half year
 297 later later, I had a first working version, (october 1996).  I
 298 announced Patchlevel 0.0.7 (or 8) to the mutex list after asking some
 299 technical details on spacing; it was downloaded approximately 4 times.
 300 Then I got the hang of it, and in the subsequent two months, I coded
 301 until it had doubled in size (pl 23).