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