]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/lilypond.pod
release: 0.0.76
[lilypond.git] / Documentation / lilypond.pod
index 1de734b053cdc47d000623450a37a0cf74b36163..c0181bc645013e3c33646fd3a8c5c520b89c5d11 100644 (file)
@@ -8,18 +8,9 @@ lilypond - the GNU music typesetter
 
 =head1 DESCRIPTION
 
-Technically GNU LilyPond is a preprocessor which generates TeX
-(or LaTeX) output which contains information to typeset a musical
-score. Practically it is a typesetter, which only uses TeX as an
-output medium. (this is handy because there exist music fonts for TeX)
-
-As a bonus, you can also output a MIDI file of what you typed.
-
-It translates script files (mudela files or F<*.ly>'s) into TeX input.
-Typesetting music is a complex task, whereas the message that printed
-music conveys is usually a simple one. GNU LilyPond is a try at providing
-a simple interface for setting music.
-
+GNU LilyPond which converts music definition files into visual or
+audio output: it can produce formatted sheet music in TeX and 
+and mechanical perfomances to MIDI files.
 
 =head1 OPTIONS
 
@@ -58,6 +49,7 @@ Show a summary of usage
 set init file to F<FILE> (default: F<symbol.ini>)
 
 =item B<--include, -I>=F<DIRECTORY>
+
 add F<DIRECTORY> to the search path for input files.
 
 =back
@@ -88,13 +80,9 @@ Multiple staffs in one score. Each staff can have a different meters.
 
 =item *
 
-multiple stafftypes (melodic, rhythmic) [broken from  pl28 on]
-
-=item *
-
-beams, slurs, chords, super/subscripts (accents and text), triplets,
-general n-plet (triplet, quadruplets, etc.), lyrics, transposition
-dynamics (both absolute and hairpin style)
+beams, slurs, ties, chords, super/subscripts (accents and text),
+triplets, general n-plet (triplet, quadruplets, etc.), lyrics,
+transposition dynamics (both absolute and hairpin style)
 
 =item *
 
@@ -131,61 +119,46 @@ information, and small contributions.
 
 Han-Wen Nienhuys <hanwen@stack.nl>, http://www.stack.nl/~hanwen
 
-Main author
-
 =item *
 
 Jan Nieuwenhuizen <jan@digicash.com>,  http://www.digicash.com/~jan.
 
-Context errors, Lyrics, mi2mu, MIDI stuff, make structure, bits of
-FlowerLib, general comments, Mudela design.
-
 =back
 
-Your name could be here! If you want to help, then take a look at the
-SMALLISH PROJECTS section of in the file F<TODO>. Some do not involve
-coding C++
 
-=head1 EXAMPLES
+=head1 PROBLEMS
 
-At this time, GNU LilyPond output looks nice, but is not of production
-quality. If you're not discouraged; this is what I type in my xterm:
 
-       lilypond someinput.ly
-       tex lelie.tex
-       xdvi test&
+There is an extensive list of todoes and bugs. See F<TODO>. In
+general, try to find out 
 
-This is what the output looks like over here:
+=over 4
 
-       hw:~/musix/spacer$ GNU LilyPond 0.0.60 #8/FlowerLib 1.1.14 #2
-       Parsing ... [./input/kortjakje.ly[lots of stuff]]
-       Setting up requests...Processing requests ...[8][16][24][25]
-       Preprocessing elements... 
-       Calculating column positions ... [3][7][12][16][20][25]
-       Postprocessing elements...
-       TeX output to lelie.tex ...
+=item *
 
-       hw:~/musix/spacer$ tex lelie
-       This is TeX, Version 3.14159 (C version 6.1)
-       (lelie.tex
-       Hyphenation patterns for english, dutch, german, loaded.
-       (/home/hw/lib/texmf/tex/lilypond/lilyponddefs.tex) [1] )
-       Output written on lelie.dvi (1 page, 8944 bytes).
-       Transcript written on lelie.log.
+if the bug has been fixed in a newer release.  
 
-       hw:~/musix/spacer$ xdvi lelie&
-       [1] 855
+=item *
 
-Check out the input files, some of them have comments
+if the bug has been found earlier, consult F<TODO> and F<BUGS>
 
+=back 
 
-=head1 PROBLEMS
+If you have found a bug, then you should send a bugreport.
 
-If GNU LilyPond bombs out, then please recompile using with debugging info
-turned on, and send a copy of the input which causes the error and a
-gdb stacktrace of the crash. It also helps if you can print the values
-of the objects. So if your trace is
+       - send a copy of the input which causes the error
+       - send a description of the platform you use
+       - send a description of the LilyPond version you use (with
+       compile/config options please)
+       - send a description of the bug itself.
+       - send it to bug-gnu-music@vuse.vanderbilt.edu
 
+It does help if you can find out where the bug comes from: if GNU
+LilyPond bombs out, then please recompile using with debugging info
+turned on, and send gdb stacktrace of the crash. It also helps if you
+can print the values of the objects. So if your trace is
+
+       received SIGSEGV 
        (gdb) backtrace 12
        #0  Interval::operator+= (this=0x11fffec60..)
            at ../flower/interval.hh:50
@@ -195,13 +168,7 @@ of the objects. So if your trace is
          :
 
 Than it would help if you send a dump of the Interval and the Item
-(use: C<print *this> or use GNU LilyPond C<print()> methods).
-
-This is a beta version of GNU LilyPond. Please send your helpful comments
-and patches to me (see AUTHORS section)
-
-GNU LilyPond is updated very frequently, the latest version is always available at:
-ftp://pcnov095.win.tue.nl/pub/lilypond.
+(use: C<print *this> or use LilyPond C<print()> methods).
 
 
 =head1 FILES
@@ -219,11 +186,13 @@ includes files from the directory F<init/>.
 
 B<LILYINCLUDE> an (one) additional directory for finding lilypond data.
 
+=head1 BUGS
+
 =head1 SEE ALSO
 
 =over 4
 
-=item lilygut(?)
+=item lilygut
 
 On technical details of LilyPond
 
@@ -235,14 +204,63 @@ On the input format
 
 Goals of the GNU LilyPond project.
 
-=item The GNU LilyPond FAQ list
+=item FAQ
+
+The GNU LilyPond FAQ list
+
+=item http://
+
+The GNU Music project. GNU LilyPond is part of the GNU Music
+project. For more information on the GNU Music project, 
+
+=item http://www.stack.nl/~hanwen/lilypond/index.html
+
+GNU LilyPond has her own webpage.  This webpage contains the MIDI, GIF
+and PS files for some standard music files. It also has the complete
+LilyPond documentation
+
+
+=back
+
+GNU LilyPond is
+updated very frequently, the latest version is always available at:
+ftp://pcnov095.win.tue.nl/pub/lilypond.
+
+For programs which are part of the GNU music project, the following
+mailing list have been setup:
+
+
+=over 4
+
+=item info-gnu-music@vuse.vanderbilt.edu
+
+For information on the GNU Music project, to subscribe: send mail with
+subject "subscribe" to info-gnu-music-request@vuse.vanderbilt.edu
+
+=item help-gnu-music@vuse.vanderbilt.edu
+
+For help with programs from the GNU music project. To subscribe: send
+mail with subject "subscribe" to
+help-gnu-music-request@vuse.vanderbilt.edu
+
+=item bug-gnu-music@vuse.vanderbilt.edu
+
+If you have bugreports, you should send them to this list. If you want
+to read all bugreports, you should subscribe to this list.  To
+subscribe: send mail with subject "subscribe" to
+bug-gnu-music-request@vuse.vanderbilt.edu
+       
+=item gnu-music-discuss@vuse.vanderbilt.edu,
+
+For discussions concerning the GNU Music project, to subscribe: send
+mail with subject "subscribe" to
+gnu-music-discuss-request@vuse.vanderbilt.edu,
+
 
 =back
 
-GNU LilyPond has her own webpage at
-http://www.stack.nl/~hanwen/lilypond/index.html. This webpage contains
-the MIDI, GIF and PS files for some standard music files. It also has
-the complete LilyPond documentation
+Announces of new versions will be sent to info-gnu-music and
+gnu-music-discuss.
 
 =head1  REMARKS
 
@@ -259,7 +277,7 @@ wrote the first 44 versions (0.01 to 0.44), then his program caught my
 attention, and I was slowly sucked in to the interesting problem of
 easily producing beautifully printed music. I contributed some
 code. We soon realised that MPP's design was too fundamentally broken
-to be repaired. It was decided to rewrite MPP.  We debated a lot about
+to be repaired, so it was decided to rewrite MPP.  We debated a lot about
 the requirements to an inputformat (fall 1995). I sat down and started
 with a parser-first, bottom-up rewrite called mpp95 (which totally
 failed, obviously).
@@ -268,8 +286,11 @@ After long and hard thinking, I came up with an algorithm for the
 horizontal spacing of multiple staffs (april 1996) I coded it (and did
 not test it). After starting with this fundamental piece, I slowly
 added the stages which come before spacing, and after.  A half year
-later later, I had a first working version, (october 1996).  I
-announced Patchlevel 0.0.7 (or 8) to the mutex list after asking some
-technical details on spacing; it was downloaded approximately 4 times.
-Then I got the hang of it, and in the subsequent two months, I coded
-until it had doubled in size (pl 23).
+later, I had a first working version, (october 1996).  I announced
+Patchlevel 0.0.7 (or 8) to the mutex list after asking some technical
+details on spacing; it was downloaded approximately 4 times.  Then I
+got the hang of it, and in the subsequent two months, I coded until it
+had doubled in size (pl 23).
+
+The first large scale release (0.1) was planned after approximately 80
+patchlevels on August 1, 1997.