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