]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/man/lilypond.yo
511f63ba5c335f77e4887026b99cb7e69618b8f4
[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 redef(cindex)(1)(\
8     whenlatex(latexcommand(\index{)ARG1+latexcommand(}))\
9     whentexinfo(XXnl()texinfocommand(@cindex )ARG1XXnl())\
10 )
11
12 redef(cindex)(1)(\
13     whenlatex(latexcommand(\index{)ARG1+latexcommand(}))\
14     whentexinfo(XXnl()texinfocommand(@cindex )ARG1XXnl())\
15 )
16
17 manpage(LilyPond)
18        (1)
19         (1999)
20        (The LilyPond package)
21        (The GNU Project Music Typesetter)
22
23 metalC(Automatically generated by yodl(1) from lilypond.yo.)
24
25 manpagename(LilyPond)(the GNU Music Typesetter)
26 cindex(LilyPond)
27
28 manpagesynopsis()
29         bf(lilypond) [OPTION]... [MUDELA-FILE]...
30
31 manpagedescription()
32
33 includefile(../BLURB.in)
34
35 manpageoptions()
36 description(
37 dit(-f,--format=)
38         Output format for sheet music. Choices are tex (for TeX
39         output), ps (for PostScript) and scm (for GUILE)
40 dit(-I,--include=)
41     add file(FILE) to the search path for input files.
42 dit(-m,--midi)
43     Disable TeX output. If you have a \midi definition, it will do the 
44     midi output only.
45 dit(-M,--dependencies)
46     Also output rules to be included in Makefile.
47 dit(-d,--debug)
48     Turn debugging info on.  GNU LilyPond reads the file file(.dstreamrc), 
49     which lists what functions and classes may produce copious debugging
50     output.
51 dit(-s,--safe)
52     Disallow untrusted code(\include) directives, backslashes in TeX()
53 code and named output.
54 dit(-t,--test)
55     Switch on any experimental features.  Not for general public use.
56 dit(-w,--warranty)
57     Show the warranty with which GNU LilyPond comes. (It comes with 
58     bf(NO WARRANTY)!)
59 dit(-o,--output=FILE)
60     Set the default output file to file(FILE).
61 dit(-h,--help)
62     Show a summary of usage.
63 dit(-i,--init=FILE)
64     Set init file to file(FILE) (default: file(init.ly)).
65 dit(--include, -I=DIRECTORY)
66     Add file(DIRECTORY) to the search path for input files.
67 dit(--ignore-version, -V)
68     Make the incompatible mudela version warning non-fatal.
69 )
70
71 manpagesection(FEATURES)
72
73 This is an overview of the features that GNU LilyPond supports.  For
74 details on how to use them, you should consult the Mudela tutorial,
75 which is included with the package.
76
77
78 itemize(
79 it()ASCII script input, with identifiers (for music reuse),
80     customizable notenames, customisable fontset.
81 it()MIDI output lets you check if you have entered the correct notes.
82 it()MIDI to Mudela conversion through the mi2mu program.
83 it()Multiple staffs in one score.  Each staff can have different time signatures.
84 it()Beams, slurs, ties, chords, super/subscripts (accents and text)
85     triplets, general n-plet (triplet, quadruplets, etc.), lyrics,
86     transposition, dynamics (both absolute and hairpin style).
87 it()Multiple voices within one staff; beams optionally shared
88     between voices.  Up to four voices is handled cleanly.
89 it()Multiple scores within one input file.  Each score is output to
90     a different file.
91 it()Clef changes, meter changes, cadenza-mode, key changes, repeat bars.
92 )
93
94 manpagesection(DISCLAIMER)
95
96 GNU LilyPond is copyright 1996-1999 by its authors.  GNU LilyPond is
97 distributed under the terms of the GNU General Public License.  GNU LilyPond 
98 is provided without any warranty what so ever.
99 GNU LilyPond may be freely distributed.  For further information consult 
100 the GNU General Public License, from the file file(COPYING).
101
102 manpagesection(PROBLEMS)
103
104 There is an extensive list of todoes and bugs.  See the file
105 file(TODO) distributed with the sources.  If you have a problem you
106 should try to find out
107
108 itemize(
109 it()If the bug has been fixed in a newer release.
110 it()If the bug has been found earlier, consult file(TODO) and file(BUGS).
111 )
112
113 If you have found a bug, then we would appreciate it if you sent a
114 bugreport.
115
116 itemize(
117 it()Send a copy of the input which causes the error.
118 it()Send a description of the platform you use.
119 it()Send a description of the LilyPond version you use 
120     (with compile/configure options please).
121 it()Send a description of the bug itself.
122 it()Send it to email(bug-gnu-music@gnu.org); you don't have to be subscribed
123     to this mailinglist.
124 )
125
126 manpagefiles()
127 description(
128 dit(file(init.ly)) 
129     The initialisation file with symbol tables etc.  It
130     includes files from the directory
131     file(PREFIX/share/lilypond/ly/). (file(PREFIX) typically is file(/usr/local)
132 ))
133
134 manpagesection(environment)
135
136 description(
137 dit(LILYINCLUDE)
138     additional directories for finding lilypond data.  The
139     format is like the format of file(PATH).
140 dit(LILYPREFIX)
141         [FIXME]
142 dit(LANG)
143     selects the language for the warning messages of LilyPond.
144 )
145
146 manpagebugs()
147
148 Lots of them.  See file(TODO) and file(BUGS)
149
150 manpageseealso()
151
152 LilyPond comes with various other documentation files.  They are
153 included in the source package.
154
155 A further source for information is the website, which can be found at
156 lurl(http://www.lilypond.org/).  The website contains on-line versions
157 of the documentation
158
159
160 GNU LilyPond is updated very frequently, the latest version is always
161 available at: lurl(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond).  This FTP
162 site is mirrored at a number of sites; consult the project web pages
163 for information about mirrors.
164
165 For programs which are part of the GNU music project, the following
166 mailing list have been setup:
167
168 description(
169 dit(email(info-gnu-music@gnu.org)) 
170     For information on the GNU Music project, to subscribe: send mail with
171     subject "subscribe" to email(info-gnu-music-request@gnu.org)
172 dit(email(help-gnu-music@gnu.org)) 
173     For help with programs from the GNU music project.  To subscribe: send
174     mail with subject "subscribe" to email(help-gnu-music-request@gnu.org)
175 dit(email(bug-gnu-music@gnu.org))
176     If you have bugreports, you should send them to this list.  If you want
177     to read all bugreports, you should subscribe to this list.  To
178     subscribe: send mail with subject "subscribe" to
179     email(bug-gnu-music-request@gnu.org)
180 dit(email(gnu-music-discuss@gnu.org))
181     For discussions concerning the GNU Music project, to subscribe: send
182     mail with subject "subscribe" to
183     email(gnu-music-discuss-request@gnu.org)
184 )
185
186 Announces of new versions will be sent to info-gnu-music and
187 gnu-music-discuss.
188
189 manpagesection(REMARKS)
190
191 GNU LilyPond has no connection with the music package Rosegarden, other
192 than the names being similar :-)
193
194 manpageauthor()
195 cindex(Author)
196
197 itemize(
198 it()nemail(Han-Wen Nienhuys)(hanwen@cs.uu.nl)
199     lurl(http://www.cs.uu.nl/people/hanwen)
200 it()nemail(Jan Nieuwenhuizen)(janneke@gnu.org)
201     lurl(http://www.xs4all.nl/~jantien)
202 )
203
204 Please consult the documentation file file(AUTHORS) for more detailed
205 information, and small contributions.