Documentation/man/out/lilypond.1

   1 .TH "LilyPond" "1" "1998" "The LilyPond package" "The GNU Project Music Typesetter"
   2 .PP
   3 .PP
   4 .SH "NAME"
   5 LilyPond \- the GNU Music Typesetter
   6 .PP
   7 .SH "SYNOPSIS"
   8 \fBlilypond\fP [OPTION]\&.\&.\&. [MUDELA-FILE]\&.\&.\&.
   9 .PP
  10 .SH "DESCRIPTION"
  11 .PP
  12 LilyPond is the GNU Project music typesetter\&.  This program can print
  13 beautiful sheet music from a music definition file\&.  It can also play
  14 mechanical performances to a MIDI file\&.  Features include multiple
  15 staffs, meters, clefs, keys, lyrics, versatile input language, cadenzas,
  16 beams, slurs, triplets, named chords, transposing, formatting scores,
  17 part extraction\&.  It includes a nice font of musical symbols\&.
  18 .PP
  19 .SH "OPTIONS"
  20 .IP "-I,--include=FILE"
  21 add \fBFILE\fP to the search path for input files\&.
  22 .IP "-M,--midi"
  23 This disables TeX output\&. If you have a \emidi definition, it will do the
  24 midi output only\&.
  25 .IP "-d,--dependencies"
  26 Also output rules to be included in Makefile\&.
  27 .IP "-D,--debug"
  28 Turn debugging info on\&.  GNU LilyPond reads the file \fB\&.dstreamrc\fP,
  29 which lists what functions and classes may produce copious debugging
  30 output\&.
  31 .IP "-s,--safe"
  32 Disallow untrusted \f(CW\einclude\fP directives, backslashes in
  33 code and named output\&.
  34 .IP "-t,--test"
  35 Switch on any experimental features\&.  Not for general public use\&.
  36 .IP "-w,--warranty"
  37 Show the warranty with which GNU LilyPond comes\&. (It comes with
  38 \fBNO WARRANTY\fP!)
  39 .IP "-o,--output=FILE"
  40 Set the default output file to \fBFILE\fP\&.
  41 .IP "-h,--help"
  42 Show a summary of usage\&.
  43 .IP "-i,--init=FILE"
  44 Set init file to \fBFILE\fP (default: \fBinit\&.ly\fP)\&.
  45 .IP "--include, -I=DIRECTORY"
  46 Add \fBDIRECTORY\fP to the search path for input files\&.
  47 .IP "--ignore-version, -V"
  48 Make incompatible mudela version non-fatal\&.
  49 .PP
  50 .SH "FEATURES"
  51 .PP
  52 This is an overview of the features that GNU LilyPond supports\&.  For
  53 details on how to use them, you should consult the Mudela tutorial,
  54 which is included with the package\&.
  55 .PP
  56 .IP o
  57 ASCII script input, with identifiers (for music reuse),
  58 customizable notenames, customisable fontset\&.
  59 .IP o
  60 MIDI output lets you check if you have entered the correct notes\&.
  61 .IP o
  62 MIDI to Mudela conversion through the mi2mu program\&.
  63 .IP o
  64 Multiple staffs in one score\&.  Each staff can have different meters\&.
  65 .IP o
  66 Beams, slurs, ties, chords, super/subscripts (accents and text)
  67 triplets, general n-plet (triplet, quadruplets, etc\&.), lyrics,
  68 transposition dynamics (both absolute and hairpin style)\&.
  69 .IP o
  70 Multiple voices within one staff; beams optionally shared
  71 between voices\&.  Up to four voices is handled cleanly\&.
  72 .IP o
  73 Multiple scores within one input file\&.  Each score is output to
  74 a different file\&.
  75 .IP o
  76 Clef changes, meter changes, cadenza-mode, key changes, repeat bars\&.
  77 .PP
  78 .SH "DISCLAIMER"
  79 .PP
  80 GNU LilyPond is copyright 1996-1998 by its authors\&.  GNU LilyPond is
  81 distributed under the terms of the GNU General Public License\&.  GNU LilyPond
  82 is provided without any warranty what so ever\&.
  83 GNU LilyPond may be freely distributed\&.  For further information consult
  84 the GNU General Public License, from the file \fBCOPYING\fP\&.
  85 .PP
  86 .SH "PROBLEMS"
  87 .PP
  88 There is an extensive list of todoes and bugs\&.  See \fBTODO\fP\&.  If you
  89 have a problem you should try to find out
  90 .PP
  91 .IP o
  92 If the bug has been fixed in a newer release\&.
  93 .IP o
  94 If the bug has been found earlier, consult \fBTODO\fP and \fBBUGS\fP\&.
  95 .PP
  96 If you have found a bug, then you should send a bugreport\&.
  97 .PP
  98 .IP o
  99 Send a copy of the input which causes the error\&.
 100 .IP o
 101 Send a description of the platform you use\&.
 102 .IP o
 103 Send a description of the LilyPond version you use
 104 (with compile/configure options please)\&.
 105 .IP o
 106 Send a description of the bug itself\&.
 107 .IP o
 108 Send it to bug-gnu-music@gnu\&.org <bug-gnu-music@gnu\&.org> (you don\'t have to subscribe
 109 to this mailinglist)\&.
 110 .PP
 111 .SH "FILES"
 112 .IP "\fBinit\&.ly\fP"
 113 The initialisation file with symbol tables etc\&.  It
 114 includes files from the directory \fBinit/\fP\&.
 115 .PP
 116 manspagesection(environment)
 117 .PP
 118 .IP "LILYINCLUDE"
 119 additional directories for finding lilypond data\&.  The
 120 format is like the format of \fBPATH\fP\&.
 121 .IP "LANG"
 122 selects the language for the warning messages of LilyPond\&.
 123 .PP
 124 .SH "BUGS"
 125 .PP
 126 Lots of them\&.  See \fBTODO\fP and \fBBUGS\fP
 127 .PP
 128 .SH "SEE ALSO"
 129 .PP
 130 .IP "internals"
 131 On technical details of LilyPond
 132 .IP "mudela-man"
 133 On the input format\&.  This is a LilyPond-enhanced LaTeX document\&.
 134 .IP "MANIFESTO"
 135 Goals of the GNU LilyPond project\&.
 136 .IP "FAQ"
 137 The GNU LilyPond FAQ list
 138 .IP "GNU LilyPond"
 139 has her own webpage\&.  This webpage contains the MIDI, GIF and PS files for
 140 some standard music files\&.  It also has the complete LilyPond documentation
 141 .PP
 142 GNU LilyPond is
 143 updated very frequently, the latest version is always available at:
 144 ftp://pcnov095\&.win\&.tue\&.nl/pub/lilypond\&.  This FTP site is mirrored
 145 at a number of sites; consult the project web pages for information
 146 about mirrors\&.
 147 .PP
 148 For programs which are part of the GNU music project, the following
 149 mailing list have been setup:
 150 .PP
 151 .IP "info-gnu-music@gnu\&.org <info-gnu-music@gnu\&.org>"
 152 For information on the GNU Music project, to subscribe: send mail with
 153 subject "subscribe" to info-gnu-music-request@gnu\&.org <info-gnu-music-request@gnu\&.org>
 154 .IP "help-gnu-music@gnu\&.org <help-gnu-music@gnu\&.org>"
 155 For help with programs from the GNU music project\&.  To subscribe: send
 156 mail with subject "subscribe" to help-gnu-music-request@gnu\&.org <help-gnu-music-request@gnu\&.org>
 157 .IP "bug-gnu-music@gnu\&.org <bug-gnu-music@gnu\&.org>"
 158 If you have bugreports, you should send them to this list\&.  If you want
 159 to read all bugreports, you should subscribe to this list\&.  To
 160 subscribe: send mail with subject "subscribe" to
 161 bug-gnu-music-request@gnu\&.org <bug-gnu-music-request@gnu\&.org>
 162 .IP "gnu-music-discuss@gnu\&.org <gnu-music-discuss@gnu\&.org>"
 163 For discussions concerning the GNU Music project, to subscribe: send
 164 mail with subject "subscribe" to
 165 gnu-music-discuss-request@gnu\&.org <gnu-music-discuss-request@gnu\&.org>
 166 .PP
 167 Announces of new versions will be sent to info-gnu-music and
 168 gnu-music-discuss\&.
 169 .PP
 170 .SH "REMARKS"
 171 .PP
 172 GNU LilyPond has no connection with the music package Rosegarden, other
 173 than the names being similar (:-)
 174 .PP
 175 .SH "HISTORY"
 176 .PP
 177 (for a  detailed changelog, see \fBNEWS\fP)
 178 .PP
 179 GNU LilyPond\'s roots lie in MPP, a preprocessor to the rather arcane
 180 MusiXTeX macro package for TeX\&.  A friend of mine, Jan Nieuwenhuizen
 181 wrote the first 44 versions (0\&.01 to 0\&.44), then his program caught my
 182 attention, and I was slowly sucked in to the interesting problem of
 183 easily producing beautifully printed music\&.  I contributed some
 184 code\&.  We soon realised that MPP\'s design was too fundamentally broken
 185 to be repaired, so it was decided to rewrite MPP\&.  We debated a lot about
 186 the requirements to an inputformat (fall 1995)\&.  I sat down and started
 187 with a parser-first, bottom-up rewrite called mpp95 (which totally
 188 failed, obviously)\&.
 189 .PP
 190 After long and hard thinking, I came up with an algorithm for the
 191 horizontal spacing of multiple staffs (april 1996) I coded it (and did
 192 not test it)\&.  After starting with this fundamental piece, I slowly
 193 added the stages which come before spacing, and after\&.  A half year
 194 later, I had a first working version, (october 1996)\&.  I announced
 195 Patchlevel 0\&.0\&.7 (or 8) to the mutex list after asking some technical
 196 details on spacing; it was downloaded approximately 4 times\&.  Then I
 197 got the hang of it, and in the subsequent two months, I coded until it
 198 had doubled in size (pl 23)\&.
 199 .PP
 200 Most the other history is described in the NEWS file\&.  The first large
 201 scale release (0\&.1) was done after approximately 78 patchlevels on
 202 August 1, 1997\&.
 203 .PP
 204 .SH "AUTHOR"
 205 .PP
 206 Please consult the documentation file \fBAUTHORS\&.txt\fP for more detailed
 207 information, and small contributions\&.
 208 .PP
 209 .IP o
 210 Han-wen Nienhuys <hanwen@cs\&.uu\&.nl>
 211 http://www\&.cs\&.uu\&.nl/people/hanwen
 212 .IP o
 213 Jan Nieuwenhuizen <janneke@gnu\&.org>
 214 http://www\&.xs4all\&.nl/~jantien