3 @chapter Running LilyPond
5 This chapter details the technicalities of running LilyPond.
13 * Invoking lilypond-latex::
16 @node Invoking lilypond
17 @section Invoking lilypond
18 @cindex Invoking LilyPond
19 @cindex command line options
20 @cindex options, command line
24 The @code{lilypond} may be called as follows from the command line.
27 lilypond [@var{option}]@dots{} @var{file}@dots{}
31 When invoked with a filename that has no extension, the @file{.ly}
32 extension is tried first. To read input from stdin, use a
33 dash @code{-} for @var{file}.
35 When @file{filename.ly} is processed it will produce
36 @file{filename.tex} as output (or @file{filename.ps} for PostScript
37 output). If @file{filename.ly} contains more than one @code{\score}
38 block, then the rest of the scores will be output in numbered files,
39 starting with @file{filename-1.tex}. Several files can be specified;
40 they will each be processed independently. @footnote{The status of
41 GUILE is not reset after processing a @code{.ly} files, so be careful
42 not to change any system defaults from within Scheme.}
45 @section Command line options
47 The following options are supported:
51 @item -e,--evaluate=@var{expr}
52 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
53 Multiple @code{-e} options may be given, they will be evaluated
54 sequentially. The function @code{ly:set-option} allows for access to
55 some internal variables. Use @code{-e '(ly:option-usage)'} for more
58 @item -f,--format=@var{format}
61 A comma separated list of back-end output formats to use. Choices are
62 @code{tex} (for @TeX{} output, to be processed with La@TeX{}, and
63 @code{ps} for PostScript.
65 There are other output options, but they are intended for developers.
68 @cindex output format, setting
69 @cindex PostScript output
73 Show a summary of usage.
74 @item --include, -I=@var{directory}
75 Add @var{directory} to the search path for input files.
76 @cindex file searching
78 @item -i,--init=@var{file}
79 Set init file to @var{file} (default: @file{init.ly}).
80 @item -o,--output=@var{FILE}
81 Set the default output file to @var{FILE}.
85 Generate DVI files. In this case, the @TeX{} backend should be
86 specified, i.e. @code{-f tex}.
88 Generate pictures of each page, in PNG format. This implies @code{--ps}.
90 Generate PDF. This implies @code{--ps}.
92 Generate an output file containing the titles and the first system
96 Do not trust the @code{.ly} input.
98 When LilyPond formatting is available through a web server, the
99 @code{--safe} @b{MUST} be passed. This will prevent inline Scheme
100 code from wreaking havoc, for example
105 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
109 The @code{--safe} option works by evaluating in-line Scheme
110 expressions in a special safe module. This safe module is derived from
111 GUILE @file{safe-r5rs} module, but adds a number of functions of the
112 LilyPond API. These functions are listed in @file{scm/safe-lily.scm}.
114 In addition, @code{--safe} disallows @code{\include} directives and
115 disables the use of backslashes in @TeX{} strings.
117 In @code{--safe} mode, it is not possible to import LilyPond variables
121 Show version information.
123 Be verbose: show full paths of all files read, and give timing
127 Show the warranty with which GNU LilyPond comes. (It comes with
128 @strong{NO WARRANTY}!)
131 @section Environment variables
134 For processing both the @TeX{} and the PostScript output, the
135 appropriate environment variables must be set. The following scripts
139 @item @file{buildscripts/out/lilypond-profile}
141 @item @file{buildscripts/out/lilypond-login} (for C-shells)
144 They should normally be sourced as part of the login process. If these
145 scripts are not run from the system wide login process, then you must
148 @cindex installing LilyPond
150 If you use sh, bash, or a similar shell, then add the following to
151 your @file{.profile}:
153 . @var{/the/path/to/}lilypond-profile
156 If you use csh, tcsh or a similar shell, then add the following to
157 your @file{~/.login}:
159 source @var{/the/path/to/}lilypond-login
162 Of course, in both cases, you should substitute the proper location of
165 These scripts set the following variables:
168 To make sure that @TeX{} and lilypond find data files (among
169 others @file{.tex}, @file{.mf} and @file{.tfm}),
170 you have to set @code{TEXMF} to point to the lilypond data
171 file tree. A typical setting would be
173 @{/usr/share/lilypond/1.6.0,@{!!/usr/share/texmf@}@}
181 @cindex printing postscript
183 The binary itself recognizes the following environment variables:
186 This specifies a directory where locale messages and
187 data files will be looked up by default. The directory should contain
188 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
191 This selects the language for the warning messages.
195 @cindex LILYPONDPREFIX
198 @section Error messages
200 @cindex error messages
201 Different error messages can appear while compiling a file:
207 Something looks suspect. If you are requesting something out of the
208 ordinary then you will understand the message, and can ignore it.
209 However, warnings usually indicate that something is wrong with the
213 Something is definitely wrong. The current processing step (parsing,
214 interpreting, or formatting) will be finished, but the next step will
220 Something is definitely wrong, and LilyPond cannot continue. This
221 happens rarely. The most usual cause is misinstalled fonts.
223 @cindex trace, Scheme
227 Errors that occur while executing Scheme code are caught by the Scheme
228 interpreter. If running with the verbose option (@code{-V} or
229 @code{--verbose}) then a call trace is printed of the offending
232 @cindex Programming error
233 @item Programming error
234 There was some internal inconsistency. These error messages are
235 intended to help the programmers and debuggers. Usually, they can be
236 ignored. Sometimes, they come in such big quantities that they obscure
237 other output. In this case, file a bug-report.
239 @item Aborted (core dumped)
240 This signals a serious programming error that caused the program to
241 crash. Such errors are considered critical. If you stumble on one,
247 @cindex errors, message format
248 If warnings and errors can
249 be linked to some part of the input file, then error messages have the
253 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
254 @var{offending input line}
257 A line-break is inserted in offending line to indicate the column
258 where the error was found. For example,
261 test.ly:2:19: error: not a duration: 5:
266 These locations are LilyPond's best guess about where the warning or
267 error occured, but (by their very nature) warning and errors occur
268 when something unexpected happens. If you can't see an error in the
269 indicated line of your input file, try checking one or two lines
270 above the indicated position.
274 @section Reporting bugs
277 @cindex reporting bugs
279 If you have input that results in a crash or an erroneous output, then
280 that is a bug. We try respond to bug-reports promptly, and fix them as
281 soon as possible. Help us by sending a defective input file, so we can
282 reproduce the problem. Make it small, so we can easily debug the
283 problem. Don't forget to tell which version you use, and on which
284 platform you run it. Send the report to
285 @email{bug-lilypond@@gnu.org}.
287 FIXME: devel bug reports go to...?
289 @c yeah, normally these go in comments, but they'll be fixed -very- soon,
290 @c and I wanted to make it clear to people reading the devel docs that
291 @c these facts need clarification. -gp
292 FIXME: does bug-lilypond get archived?
294 @c TODO: make a link to the archive/search for html output
295 When you've found a bug, do a few searches on the mailing list for
296 the bug. Sometimes the bug will have already been reported and a fix
297 or workaround is already known.
299 @c I'm not going to mention the bug CVS. Newbies won't know how to
300 @c use it, and it would only scare them. Besides, Erik says he doesn't
301 @c mind getting multiple bug reports, so who cares if it makes more work
302 @c for him? :) (in addition, multiple bug reports about the same
303 @c thing could be useful in judging the severity of a problem) -gp
305 Here's an example of a good bug report:
308 % LilyPond 2.3.11, Mac OSX 10.3.4, fink package lilypond-unstable
309 % slur does not look at accidentals
318 @section Editor support
323 @cindex modes, editor
324 @cindex syntax coloring
325 @cindex coloring, syntax
327 There is support from different editors for LilyPond.
331 Emacs has a @file{lilypond-mode}, which provides keyword
332 autocompletion, indentation, LilyPond specific parenthesis matching
333 and syntax coloring, handy compile short-cuts and reading LilyPond
334 manuals using Info. If @file{lilypond-mode} is not installed on your
335 platform, then read the
337 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
340 installation instructions.
345 For @uref{http://www.vim.org,VIM}, a @file{vimrc} is supplied, along with
346 syntax coloring tools. For more information, refer to the
348 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
351 installation instructions.
357 There exists a plugin for @uref{http://www.jedit.org/,jEdit}. Refer to
358 the @uref{http://lily4jedit.sourceforge.net,plugin website} for more
363 For both VIM and Emacs editors, there is also a facility to jump in
364 the input file to the source of errors in the graphical output. See
365 @ref{Point and click}.
370 @node Invoking lilypond-latex
371 @section Invoking lilypond-latex
373 Before LilyPond 3.0, the @code{lilypond} program only generated music
374 notation. Titles and page layout was done in a separate wrapper
375 program. For compatibility with older files, this wrapper program has
376 been retained as @code{lilypond-latex}. It uses the LilyPond program
377 and La@TeX{} to create a nicely titled piece of sheet music. Use of
378 this program is only necessary if the input file contains special
379 La@TeX{} options or formatting codes in markup texts.
381 The @code{lilypond-latex} wrapper is invoked from the command-line as
384 @code{lilypond-latex} [@var{option}]@dots{} @var{file}@dots{}
387 To have @code{lilypond-latex} read from stdin, use a dash @code{-} for
388 @var{file}. The program supports the following options.
390 @cindex stdin, reading
394 Keep the temporary directory with all output
395 files. The temporary directory is created in the current directory as @code{@code{lilypond}.dir}.
398 @item -I,--include=@var{dir}
399 Add @var{dir} to LilyPond's include path.
400 @item -o,--output=@var{file}
401 Generate output to @var{file}. The extension of @var{file} is ignored.
403 Also generate pictures of each page, in PNG format.
405 Also generate a picture of the first system of the score.
414 @item -s,--set=@var{key}=@var{val}
415 Add @var{key}= @var{val} to the settings, overriding those specified
416 in the files. Possible keys: @code{language}, @code{latexheaders},
417 @code{latexpackages}, @code{latexoptions}, @code{papersize},
418 @code{linewidth}, @code{orientation},
421 Show version information.
423 Be verbose. This prints out commands as they are executed, and more
424 information about the formatting process is printed.
426 Print even more information. This is useful when generating bug reports.
428 Show the warranty with which GNU LilyPond comes. (It comes with
429 @strong{NO WARRANTY}!)
434 @subsection Additional parameters
436 The @code{lilypond} program responds to several parameters specified
437 in a @code{\paper} section of the input file. They can be overridden
438 by supplying a @code{--set} command line option.
442 Specify La@TeX{} language: the @code{babel} package will be
443 included. Default: unset.
445 Read from the @code{\header} block.
448 Specify additional La@TeX{} headers file.
449 Normally read from the @code{\header} block. Default value: empty.
452 Specify additional La@TeX{} packages file. This works cumulative,
453 so you can add multiple packages using multiple @code{-s=latexpackages} options.
454 Normally read from the @code{\header} block. Default value:
458 Specify additional options for the La@TeX{}
459 @code{\documentclass}. You can put any valid value here. This was
460 designed to allow @code{lilypond} to produce output for double-sided
461 paper, with balanced margins and page numbers on alternating sides. To
462 achieve this specify @code{twoside}.
465 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
466 read from the @code{\paper} block, if set.
469 The vertical extension of the music on the page. It is normally
470 calculated automatically, based on the paper size.
473 The music line width. It is normally read from the @code{\paper}
477 The paper size (as a name, e.g. @code{a4}). It is normally read from
478 the @code{\paper} block.
481 The font encoding, should be set identical to the @code{font-encoding}
482 property in the score.