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