1 @c -*- coding: latin-1; mode: texinfo; -*-
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
94 Do not generate the full pages. Useful in combination with
97 Do not trust the @code{.ly} input.
99 When LilyPond formatting is available through a web server, the
100 @code{--safe} @b{MUST} be passed. This will prevent inline Scheme
101 code from wreaking havoc, for example
106 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
110 The @code{--safe} option works by evaluating in-line Scheme
111 expressions in a special safe module. This safe module is derived from
112 GUILE @file{safe-r5rs} module, but adds a number of functions of the
113 LilyPond API. These functions are listed in @file{scm/safe-lily.scm}.
115 In addition, @code{--safe} disallows @code{\include} directives and
116 disables the use of backslashes in @TeX{} strings.
118 In @code{--safe} mode, it is not possible to import LilyPond variables
121 @code{--safe} does @emph{not} detect resource overuse. It is still
122 possible to make the program hang indefinitely, for example by feeding
123 cyclic data structures into the backend. Therefore, if using LilyPond
124 on a publicly accessible webserver, the process should limited in
125 both allowed CPU and memory usage.
128 Show version information.
130 Be verbose: show full paths of all files read, and give timing
134 Show the warranty with which GNU LilyPond comes. (It comes with
135 @strong{NO WARRANTY}!)
138 @section Environment variables
141 For processing both the @TeX{} and the PostScript output, the
142 appropriate environment variables must be set. The following scripts
146 @item @file{buildscripts/out/lilypond-profile}
148 @item @file{buildscripts/out/lilypond-login} (for C-shells)
151 They should normally be sourced as part of the login process. If these
152 scripts are not run from the system wide login process, then you must
155 @cindex installing LilyPond
157 If you use sh, bash, or a similar shell, then add the following to
158 your @file{.profile}:
160 . @var{/the/path/to/}lilypond-profile
163 If you use csh, tcsh or a similar shell, then add the following to
164 your @file{~/.login}:
166 source @var{/the/path/to/}lilypond-login
169 Of course, in both cases, you should substitute the proper location of
172 These scripts set the following variables:
175 To make sure that @TeX{} and lilypond find data files (among
176 others @file{.tex}, @file{.mf} and @file{.tfm}),
177 you have to set @code{TEXMF} to point to the lilypond data
178 file tree. A typical setting would be
180 @{/usr/share/lilypond/1.6.0,@{!!/usr/share/texmf@}@}
188 @cindex printing postscript
190 The binary itself recognizes the following environment variables:
193 This specifies a directory where locale messages and
194 data files will be looked up by default. The directory should contain
195 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
198 This selects the language for the warning messages.
202 @cindex LILYPONDPREFIX
205 @section Error messages
207 @cindex error messages
208 Different error messages can appear while compiling a file:
214 Something looks suspect. If you are requesting something out of the
215 ordinary then you will understand the message, and can ignore it.
216 However, warnings usually indicate that something is wrong with the
220 Something is definitely wrong. The current processing step (parsing,
221 interpreting, or formatting) will be finished, but the next step will
227 Something is definitely wrong, and LilyPond cannot continue. This
228 happens rarely. The most usual cause is misinstalled fonts.
230 @cindex trace, Scheme
234 Errors that occur while executing Scheme code are caught by the Scheme
235 interpreter. If running with the verbose option (@code{-V} or
236 @code{--verbose}) then a call trace is printed of the offending
239 @cindex Programming error
240 @item Programming error
241 There was some internal inconsistency. These error messages are
242 intended to help the programmers and debuggers. Usually, they can be
243 ignored. Sometimes, they come in such big quantities that they obscure
244 other output. In this case, file a bug-report.
246 @item Aborted (core dumped)
247 This signals a serious programming error that caused the program to
248 crash. Such errors are considered critical. If you stumble on one,
254 @cindex errors, message format
255 If warnings and errors can
256 be linked to some part of the input file, then error messages have the
260 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
261 @var{offending input line}
264 A line-break is inserted in offending line to indicate the column
265 where the error was found. For example,
268 test.ly:2:19: error: not a duration: 5:
273 These locations are LilyPond's best guess about where the warning or
274 error occured, but (by their very nature) warning and errors occur
275 when something unexpected happens. If you can't see an error in the
276 indicated line of your input file, try checking one or two lines
277 above the indicated position.
281 @section Reporting bugs
284 @cindex reporting bugs
286 If you have input that results in a crash or an erroneous output, then
287 that is a bug. We try respond to bug-reports promptly, and fix them as
288 soon as possible. Help us by sending a defective input file, so we can
289 reproduce the problem. Make it small, so we can easily debug the
290 problem. Don't forget to tell which version of LilyPond you use! Send
291 the report to @email{bug-lilypond@@gnu.org}.
293 When you've found a bug, have a look at our
294 @uref{http://lilypond.org/doc/v2.3/bugs/,bug database} to see if it
295 has already been reported. You could also try doing a few searches
296 on the mailing list for the bug. Sometimes the bug will have already
297 been reported and a fix or workaround is already known.
299 Here is an example of a good bug report:
303 It seems that placement of accidentals is broken. In the
304 following example, the accidental touches the note head.
306 Using Mac OSX 10.3.5, fink package lilypond-unstable
317 \override Accidental #'extra-offset = #'(1.0 . 0)
323 @section Editor support
328 @cindex modes, editor
329 @cindex syntax coloring
330 @cindex coloring, syntax
332 There is support from different editors for LilyPond.
336 Emacs has a @file{lilypond-mode}, which provides keyword
337 autocompletion, indentation, LilyPond specific parenthesis matching
338 and syntax coloring, handy compile short-cuts and reading LilyPond
339 manuals using Info. If @file{lilypond-mode} is not installed on your
340 platform, then read the
342 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
345 installation instructions.
350 For @uref{http://www.vim.org,VIM}, a @file{vimrc} is supplied, along with
351 syntax coloring tools. For more information, refer to the
353 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
356 installation instructions.
362 The @uref{http://www.jedit.org/,jEdit} editor has a LilyPond plugin.
363 This plugin includes a DVI viewer, integrated help and viewing via
364 GhostScript. It can be installed by doing @key{Plugins > Plugin
365 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
369 All these editors can be made to jump in the input file to the source
370 of a symbol in the graphical output. See @ref{Point and click}.
375 @node Invoking lilypond-latex
376 @section Invoking lilypond-latex
378 Before LilyPond 3.0, the @code{lilypond} program only generated music
379 notation. Titles and page layout was done in a separate wrapper
380 program. For compatibility with older files, this wrapper program has
381 been retained as @code{lilypond-latex}. It uses the LilyPond program
382 and La@TeX{} to create a nicely titled piece of sheet music. Use of
383 this program is only necessary if the input file contains special
384 La@TeX{} options or formatting codes in markup texts.
386 The @code{lilypond-latex} wrapper is invoked from the command-line as
389 @code{lilypond-latex} [@var{option}]@dots{} @var{file}@dots{}
392 To have @code{lilypond-latex} read from stdin, use a dash @code{-} for
393 @var{file}. The program supports the following options.
395 @cindex stdin, reading
399 Keep the temporary directory with all output
400 files. The temporary directory is created in the current directory as @code{@code{lilypond}.dir}.
403 @item -I,--include=@var{dir}
404 Add @var{dir} to LilyPond's include path.
405 @item -o,--output=@var{file}
406 Generate output to @var{file}. The extension of @var{file} is ignored.
408 Also generate pictures of each page, in PNG format.
410 Also generate a picture of the first system of the score.
419 @item -s,--set=@var{key}=@var{val}
420 Add @var{key}= @var{val} to the settings, overriding those specified
421 in the files. Possible keys: @code{language}, @code{latexheaders},
422 @code{latexpackages}, @code{latexoptions}, @code{papersize},
423 @code{linewidth}, @code{orientation},
426 Show version information.
428 Be verbose. This prints out commands as they are executed, and more
429 information about the formatting process is printed.
431 Print even more information. This is useful when generating bug reports.
433 Show the warranty with which GNU LilyPond comes. (It comes with
434 @strong{NO WARRANTY}!)
439 @subsection Additional parameters
441 The @code{lilypond} program responds to several parameters specified
442 in a @code{\layout} section of the input file. They can be overridden
443 by supplying a @code{--set} command line option.
447 Specify La@TeX{} language: the @code{babel} package will be
448 included. Default: unset.
450 Read from the @code{\header} block.
453 Specify additional La@TeX{} headers file.
454 Normally read from the @code{\header} block. Default value: empty.
457 Specify additional La@TeX{} packages file. This works cumulative,
458 so you can add multiple packages using multiple @code{-s=latexpackages} options.
459 Normally read from the @code{\header} block. Default value:
463 Specify additional options for the La@TeX{}
464 @code{\documentclass}. You can put any valid value here. This was
465 designed to allow @code{lilypond} to produce output for double-sided
466 paper, with balanced margins and page numbers on alternating sides. To
467 achieve this specify @code{twoside}.
470 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
471 read from the @code{\layout} block, if set.
474 The vertical extension of the music on the page. It is normally
475 calculated automatically, based on the paper size.
478 The music line width. It is normally read from the @code{\layout}
482 The paper size (as a name, e.g. @code{a4}). It is normally read from
483 the @code{\layout} block.
486 The font encoding, should be set identical to the @code{font-encoding}
487 property in the score.