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