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