]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/man/out/lilypond.1
release: 1.1.47
[lilypond.git] / Documentation / man / out / lilypond.1
1 .TH "LilyPond" "1" "1999" "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=" 
21 add \fBFILE\fP to the search path for input files\&.
22 .IP "-M,--midi" 
23 Disable 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 the incompatible mudela version warning 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 time signatures\&.
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-1999 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 the file
89 \fBTODO\fP distributed with the sources\&.  If you have a problem you
90 should try to find out
91 .PP 
92 .IP o 
93 If the bug has been fixed in a newer release\&.
94 .IP o 
95 If the bug has been found earlier, consult \fBTODO\fP and \fBBUGS\fP\&.
96 .PP 
97 If you have found a bug, then we would appreciate it if you sent a
98 bugreport\&.
99 .PP 
100 .IP o 
101 Send a copy of the input which causes the error\&.
102 .IP o 
103 Send a description of the platform you use\&.
104 .IP o 
105 Send a description of the LilyPond version you use 
106 (with compile/configure options please)\&.
107 .IP o 
108 Send a description of the bug itself\&.
109 .IP o 
110 Send it to bug-gnu-music@gnu\&.org; you don\'t have to be subscribed
111 to this mailinglist\&.
112 .PP 
113 .SH "FILES" 
114 .IP "\fBinit\&.ly\fP" 
115 The initialisation file with symbol tables etc\&.  It
116 includes files from the directory
117 \fBPREFIX/share/lilypond/ly/\fP\&. (\fBPREFIX\fP typically is \fB/usr/local\fP
118 )
119 .IP 
120 manspagesection(environment)
121 .IP 
122 .IP "LILYINCLUDE" 
123 additional directories for finding lilypond data\&.  The
124 format is like the format of \fBPATH\fP\&.
125 .IP "LILYPREFIX" 
126 [FIXME]
127 .IP "LANG" 
128 selects the language for the warning messages of LilyPond\&.
129 .IP 
130 .SH "BUGS" 
131 .IP 
132 Lots of them\&.  See \fBTODO\fP and \fBBUGS\fP
133 .IP 
134 .SH "SEE ALSO" 
135 .IP 
136 LilyPond comes with various other documentation files, but most are in
137 the form of manual pages\&.  They are included in the source
138 package\&. Interesting documents include 
139 .IP 
140 .IP "MANIFESTO" 
141 Goals of the GNU LilyPond project\&.
142 .IP "FAQ" 
143 The GNU LilyPond FAQ list
144 .IP 
145 A further source for information is the website, which can be found at
146 http://www\&.lilypond\&.org/\&.  The website contains on-line versions
147 of the documentation
148 .IP 
149 GNU LilyPond is updated very frequently, the latest version is always
150 available at: ftp://ftp\&.cs\&.uu\&.nl/pub/GNU/LilyPond\&.  This FTP
151 site is mirrored at a number of sites; consult the project web pages
152 for information about mirrors\&.
153 .IP 
154 For programs which are part of the GNU music project, the following
155 mailing list have been setup:
156 .IP 
157 .IP "info-gnu-music@gnu\&.org" 
158 For information on the GNU Music project, to subscribe: send mail with
159 subject "subscribe" to info-gnu-music-request@gnu\&.org
160 .IP "help-gnu-music@gnu\&.org" 
161 For help with programs from the GNU music project\&.  To subscribe: send
162 mail with subject "subscribe" to help-gnu-music-request@gnu\&.org
163 .IP "bug-gnu-music@gnu\&.org" 
164 If you have bugreports, you should send them to this list\&.  If you want
165 to read all bugreports, you should subscribe to this list\&.  To
166 subscribe: send mail with subject "subscribe" to
167 bug-gnu-music-request@gnu\&.org
168 .IP "gnu-music-discuss@gnu\&.org" 
169 For discussions concerning the GNU Music project, to subscribe: send
170 mail with subject "subscribe" to
171 gnu-music-discuss-request@gnu\&.org
172 .IP 
173 Announces of new versions will be sent to info-gnu-music and
174 gnu-music-discuss\&.
175 .IP 
176 .SH "REMARKS" 
177 .IP 
178 GNU LilyPond has no connection with the music package Rosegarden, other
179 than the names being similar :-
180 .PP 
181 .SH "AUTHOR" 
182 .PP 
183 .IP o 
184 Han-wen Nienhuys <hanwen@cs\&.uu\&.nl>
185 http://www\&.cs\&.uu\&.nl/people/hanwen
186 .IP o 
187 Jan Nieuwenhuizen <janneke@gnu\&.org>
188 http://www\&.xs4all\&.nl/~jantien
189 .PP 
190 Please consult the documentation file \fBAUTHORS\fP for more detailed
191 information, and small contributions\&.
192 .PP