]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/lilypond.pod
partial: 0.1.41.jcn
[lilypond.git] / Documentation / lilypond.pod
index faa26928e4363234050abdb7608c4d73bbf6c7e5..26a6664150d5a40b5ac11abe29d02cd75d1bfd72 100644 (file)
@@ -8,9 +8,10 @@ lilypond - the GNU music typesetter
 
 =head1 DESCRIPTION
 
-GNU LilyPond is a program which converts music definition files into
-visual or auditive output: it can typeset formatted sheet music to a
-TeX file and and (mechanical) performances to MIDI files.
+LilyPond is the GNU Project music typesetter.  The program generates
+visual or auditive output from a music definition file: it can typeset 
+formatted sheet music to a TeX file and play (mechanical) performances 
+to a MIDI file.
 
 =head1 OPTIONS
 
@@ -22,14 +23,19 @@ add F<FILE> to the search path for input files.
 
 =item B<-M,--midi>
 
-do midi output only
+This disables TeX output. If you have a \midi definition, it will do
+the midi output only.
 
 =item B<-d,--debug>,
 
-Turn debugging info. GNU LilyPond will read the file F<.dstreamrc>, which
-tells for what functions and classes may produce copious debugging
+Turn debugging info on.  GNU LilyPond reads the file F<.dstreamrc>, 
+which lists what functions and classes may produce copious debugging
 output.
 
+=item B<-t,--test>,
+
+Switch on any experimental features.  Not for general public use.
+
 =item B<-w,--warranty>,
 
 Show the warranty with which GNU LilyPond comes. (It comes with B<NO
@@ -41,33 +47,37 @@ Set the default output file to F<FILE>.
 
 =item B<-h,--help>,
 
-Show a summary of usage
+Show a summary of usage.
+
+=item B<-i,--init=>F<FILE>,
 
-=item B<-i,--init=>F<FILE>
+Set init file to F<FILE> (default: F<lily-init.ly>).
 
-set init file to F<FILE> (default: F<symbol.ly>)
+=item B<--include, -I>=F<DIRECTORY>,
 
-=item B<--include, -I>=F<DIRECTORY>
+Add F<DIRECTORY> to the search path for input files.
 
-add F<DIRECTORY> to the search path for input files.
+=item B<--ignore-version, -V>,
 
-=item B<--ignore-version, -V>
+Make incompatible mudela version non-fatal.
 
-make incompatible mudela version non-fatal 
+=item B<--postscript, -p>,
+
+Try to use PostScript where possible.
 
 =back
 
 =head1 FEATURES
 
-This is an overview of the features that GNU LilyPond supports. For
-details on how to use them, you should consult mudela(5)
+This is an overview of the features that GNU LilyPond supports.  For
+details on how to use them, you should consult mudela(5).
 
 =over 5
 
 =item *
 
 ASCII script input, with identifiers (for music reuse),
-customizable notenames, customizable fontset
+customizable notenames, customisable fontset.
 
 =item *
 
@@ -79,37 +89,37 @@ MIDI to Mudela conversion through the mi2mu program.
 
 =item *
 
-Multiple staffs in one score. Each staff can have a different meters.
+Multiple staffs in one score.  Each staff can have different meters.
 
 =item *
 
-beams, slurs, ties, chords, super/subscripts (accents and text),
+Beams, slurs, ties, chords, super/subscripts (accents and text)
 triplets, general n-plet (triplet, quadruplets, etc.), lyrics,
-transposition dynamics (both absolute and hairpin style)
+transposition dynamics (both absolute and hairpin style).
 
 =item *
 
-multiple voices within one staff; beams optionally shared
-between voices. Up to four voices is handled cleanly.
+Multiple voices within one staff; beams optionally shared
+between voices.  Up to four voices is handled cleanly.
 
 =item *
 
-multiple scores within one input file. Each score is output to
+Multiple scores within one input file.  Each score is output to
 a different file.
 
 =item *
 
-clef changes, meter changes, cadenza-mode, key changes, repeat bars
+Clef changes, meter changes, cadenza-mode, key changes, repeat bars.
 
 =back
 
-=head1 DISCLAIMER & COPYING POLICY
+=head1 DISCLAIMER AND COPYING POLICY
 
-GNU LilyPond is copyright 1996,97 by its authors. GNU LilyPond is
-distributed under the terms of the GNU General Public
-License. GNU LilyPond is provided without any warranty what so ever.
-GNU LilyPond may be freely distributed.  For further information consult
-the GNU General Public License, which is in the file F<COPYING>
+GNU LilyPond is copyright 1996, 1997 by its authors.  GNU LilyPond is
+distributed under the terms of the GNU General Public License.  GNU LilyPond 
+is provided without any warranty what so ever.
+GNU LilyPond may be freely distributed.  For further information consult 
+the GNU General Public License, from the file F<COPYING>.
 
 =head1 AUTHORS
 
@@ -132,18 +142,18 @@ Jan Nieuwenhuizen <jan@digicash.com>,  http://www.digicash.com/~jan.
 =head1 PROBLEMS
 
 
-There is an extensive list of todoes and bugs. See F<TODO>. In
+There is an extensive list of todoes and bugs.  See F<TODO>.  In
 general, try to find out 
 
 =over 4
 
 =item *
 
-if the bug has been fixed in a newer release.  
+If the bug has been fixed in a newer release.  
 
 =item *
 
-if the bug has been found earlier, consult F<TODO> and F<BUGS>
+If the bug has been found earlier, consult F<TODO> and F<BUGS>.
 
 =back 
 
@@ -152,27 +162,27 @@ If you have found a bug, then you should send a bugreport.
 =over 4
 
 =item *
-send a copy of the input which causes the error
+Send a copy of the input which causes the error.
 
 =item *
-send a description of the platform you use
+Send a description of the platform you use.
 
 =item *
-send a description of the LilyPond version you use (with
-compile/config options please)
+Send a description of the LilyPond version you use (with
+compile/configure options please).
 
 =item *
-send a description of the bug itself.
+Send a description of the bug itself.
 
 =item *
-send it to bug-gnu-music@vuse.vanderbilt.edu
+Send it to bug-gnu-music@gnu.org.
 
 =back
 
 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
+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
@@ -191,9 +201,9 @@ Than it would help if you send a dump of the Interval and the Item
 
 =over 5
 
-=item F<symbol.ly>
+=item F<lily-init.ly>
 
-The initialisation file with symbol tables etc. It
+The initialisation file with symbol tables etc.  It
 includes files from the directory F<init/>.
 
 =back
@@ -204,6 +214,8 @@ B<LILYINCLUDE> an (one) additional directory for finding lilypond data.
 
 =head1 BUGS
 
+Lots of them.  See F<TODO> and F<BUGS>
+
 =head1 SEE ALSO
 
 =over 4
@@ -214,7 +226,7 @@ On technical details of LilyPond
 
 =item mudela-man
 
-On the input format. This is a LilyPond-enhanced LaTeX document.
+On the input format.  This is a LilyPond-enhanced LaTeX document.
 
 =item MANIFESTO
 
@@ -227,7 +239,7 @@ The GNU LilyPond FAQ list
 =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
+and PS files for some standard music files.  It also has the complete
 LilyPond documentation
 
 =back
@@ -235,7 +247,7 @@ LilyPond documentation
 GNU LilyPond is
 updated very frequently, the latest version is always available at:
 ftp://pcnov095.win.tue.nl/pub/lilypond and
-ftp://alpha.gnu.ai.mit.edu/gnu/
+ftp://alpha.gnu.org/gnu/lilypond/
 
 
 For programs which are part of the GNU music project, the following
@@ -244,29 +256,29 @@ mailing list have been setup:
 
 =over 4
 
-=item info-gnu-music@vuse.vanderbilt.edu
+=item info-gnu-music@gnu.org
 
 For information on the GNU Music project, to subscribe: send mail with
-subject "subscribe" to info-gnu-music-request@vuse.vanderbilt.edu
+subject "subscribe" to info-gnu-music-request@gnu.org
 
-=item help-gnu-music@vuse.vanderbilt.edu
+=item help-gnu-music@gnu.org
 
-For help with programs from the GNU music project. To subscribe: send
+For help with programs from the GNU music project.  To subscribe: send
 mail with subject "subscribe" to
-help-gnu-music-request@vuse.vanderbilt.edu
+help-gnu-music-request@gnu.org
 
-=item bug-gnu-music@vuse.vanderbilt.edu
+=item bug-gnu-music@gnu.org
 
-If you have bugreports, you should send them to this list. If you want
+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,
+bug-gnu-music-request@gnu.org
+
+=item gnu-music-discuss@gnu.org,
 
 For discussions concerning the GNU Music project, to subscribe: send
 mail with subject "subscribe" to
-gnu-music-discuss-request@vuse.vanderbilt.edu,
+gnu-music-discuss-request@gnu.org,
 
 
 =back
@@ -284,19 +296,19 @@ than the names being similar :-)
 (for a  detailed changelog, see F<NEWS>)
 
 GNU LilyPond's roots lie in MPP, a preprocessor to the rather arcane
-MusiXTeX macro package for TeX. A friend of mine, Jan Nieuwenhuizen
+MusiXTeX macro package for TeX.  A friend of mine, Jan Nieuwenhuizen
 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
+easily producing beautifully printed music.  I contributed some
+code.  We soon realised that MPP's design was too fundamentally broken
 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
+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).
 
 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
+not test it).  After starting with this fundamental piece, I slowly
 added the stages which come before spacing, and after.  A half year
 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
@@ -304,7 +316,7 @@ 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).
 
-Most the other history is described in the NEWS file. The first large
+Most the other history is described in the NEWS file.  The first large
 scale release (0.1) was done after approximately 78 patchlevels on
 August 1, 1997.