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} executable 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} file, 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 access to
55 some internal variables. Use @code{-e '(ly:option-usage)'} for more
58 @item -f,--format=@var{format}
59 which formats should be written. Choices are @code{svg}, @code{ps},
60 @code{pdf}, @code{png}, @code{tex}, @code{dvi}.
62 @item -b,--backend=@var{format}
63 the output format to use for the back-end. Choices are
66 for @TeX{} output, to be processed with La@TeX{}. If present, the file
67 @file{file.textmetrics} is read to determine text extents.
69 dump text strings to @file{.texstr} file, which can be run through
70 (La)@TeX{}, resulting in a @code{.textmetrics} file, which contains the
71 extents of strings of text.
74 @cindex PostScript output
76 for SVG (Scalable Vector Graphics)
77 @cindex SVG (Scalable Vector Graphics)
79 for a dump of the raw, internal Scheme-based drawing commands.
83 @cindex output format, setting
86 Show a summary of usage.
88 @item --include, -I=@var{directory}
89 Add @var{directory} to the search path for input files.
90 @cindex file searching
93 @item -i,--init=@var{file}
94 Set init file to @var{file} (default: @file{init.ly}).
96 @item -o,--output=@var{FILE}
97 Set the default output file to @var{FILE}.
103 Generate DVI files. In this case, the @TeX{} backend should be
104 specified, i.e., @code{-f tex}.
107 Generate pictures of each page, in PNG format. This implies @code{--ps}.
110 Generate PDF. This implies @code{--ps}.
113 Generate an output file containing the titles and the first system
116 Do not generate the full pages. Useful in combination with
120 Do not trust the @code{.ly} input.
122 When LilyPond formatting is available through a web server, the
123 @code{--safe} @b{MUST} be passed. This will prevent inline Scheme
124 code from wreaking havoc, for example
130 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
135 The @code{--safe} option works by evaluating in-line Scheme
136 expressions in a special safe module. This safe module is derived from
137 GUILE @file{safe-r5rs} module, but adds a number of functions of the
138 LilyPond API. These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
140 In addition, @code{--safe} disallows @code{\include} directives and
141 disables the use of backslashes in @TeX{} strings.
143 In @code{--safe} mode, it is not possible to import LilyPond variables
146 @code{--safe} does @emph{not} detect resource overuse. It is still
147 possible to make the program hang indefinitely, for example by feeding
148 cyclic data structures into the backend. Therefore, if using LilyPond
149 on a publicly accessible webserver, the process should be limited in
150 both CPU and memory usage.
153 Show version information.
156 Be verbose: show full paths of all files read, and give timing
160 Show the warranty with which GNU LilyPond comes. (It comes with
161 @strong{NO WARRANTY}!)
165 @section Environment variables
167 For processing both the @TeX{} and the PostScript output, the
168 appropriate environment variables must be set. The following scripts
172 @item @file{buildscripts/@/out/@/lilypond@/-profile}
174 @item @file{buildscripts/@/out/@/lilypond@/-login} (for C-shells)
177 They should normally be sourced as part of the login process. If these
178 scripts are not run from the system wide login process, then you must
181 @cindex installing LilyPond
183 If you use sh, bash, or a similar shell, then add the following to
184 your @file{.profile}:
186 . @var{/the/path/to/}lilypond-profile
189 If you use csh, tcsh or a similar shell, then add the following to
190 your @file{~/.login}:
192 source @var{/the/path/to/}lilypond-login
195 Of course, in both cases, you should substitute the proper location of
198 These scripts set the following variables:
201 To make sure that @TeX{} and lilypond find data files (among
202 others @file{.tex}, @file{.mf}, and @file{.tfm}),
203 you have to set @code{TEXMF} to point to the lilypond data
204 file tree. A typical setting would be
206 @{/usr/share/lilypond/2.4.0,@{!!/usr/share/texmf@}@}
214 @cindex printing postscript
216 The binary itself recognizes the following environment variables:
219 This specifies a directory where locale messages and
220 data files will be looked up by default. The directory should contain
221 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
224 This selects the language for the warning messages.
228 @cindex LILYPONDPREFIX
231 @section Error messages
233 @cindex error messages
234 Different error messages can appear while compiling a file:
240 Something looks suspect. If you are requesting something out of the
241 ordinary then you will understand the message, and can ignore it.
242 However, warnings usually indicate that something is wrong with the
246 Something is definitely wrong. The current processing step (parsing,
247 interpreting, or formatting) will be finished, but the next step will
253 Something is definitely wrong, and LilyPond cannot continue. This
254 happens rarely. The most usual cause is misinstalled fonts.
256 @cindex trace, Scheme
260 Errors that occur while executing Scheme code are caught by the Scheme
261 interpreter. If running with the verbose option (@code{-V} or
262 @code{--verbose}) then a call trace of the offending
263 function call is printed.
265 @cindex Programming error
266 @item Programming error
267 There was some internal inconsistency. These error messages are
268 intended to help the programmers and debuggers. Usually, they can be
269 ignored. Sometimes, they come in such big quantities that they obscure
270 other output. In this case, file a bug-report.
272 @item Aborted (core dumped)
273 This signals a serious programming error that caused the program to
274 crash. Such errors are considered critical. If you stumble on one,
280 @cindex errors, message format
281 If warnings and errors can
282 be linked to some part of the input file, then error messages have the
286 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
287 @var{offending input line}
290 A line-break is inserted in the offending line to indicate the column
291 where the error was found. For example,
294 test.ly:2:19: error: not a duration: 5:
299 These locations are LilyPond's best guess about where the warning or
300 error occured, but (by their very nature) warnings and errors occur
301 when something unexpected happens. If you can't see an error in the
302 indicated line of your input file, try checking one or two lines
303 above the indicated position.
307 @section Reporting bugs
310 @cindex reporting bugs
312 If you have input that results in a crash or an erroneous output, then
313 that is a bug. We try to respond to bug-reports promptly, and fix them as
314 soon as possible. Help us by sending a defective input file, so we can
315 reproduce the problem. Make it small, so we can easily debug the
316 problem. Don't forget to tell which version of LilyPond you use! Send
317 the report to @email{bug-lilypond@@gnu.org}.
319 When you've found a bug, have a look at our
320 @uref{http://@/lilypond@/.org/@/doc/@/v2.3/@/bugs/,bug database} to see if
321 it has already been reported. You could also try to do a few searches
322 on the mailing list for the bug. Sometimes the bug will have already
323 been reported and a fix or workaround is already known.
325 Here is an example of a good bug report:
328 It seems that placement of accidentals is broken. In the
329 following example, the accidental touches the note head.
331 Using Mac OSX 10.3.5, fink package lilypond-unstable
342 \override Accidental #'extra-offset = #'(1.0 . 0)
348 @section Editor support
353 @cindex modes, editor
354 @cindex syntax coloring
355 @cindex coloring, syntax
357 There is support from different editors for LilyPond.
361 Emacs has a @file{lilypond-mode}, which provides keyword
362 autocompletion, indentation, LilyPond specific parenthesis matching
363 and syntax coloring, handy compile short-cuts and reading LilyPond
364 manuals using Info. If @file{lilypond-mode} is not installed on your
365 platform, then read the
367 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
370 installation instructions.
375 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along
376 with syntax coloring tools. For more information, refer to the
378 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
381 installation instructions.
387 The @uref{http://@/www@/.jedit@/.org/,jEdit} editor has a LilyPond plugin.
388 This plugin includes a DVI viewer, integrated help and viewing via
389 GhostScript. It can be installed by doing @key{Plugins > Plugin
390 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
394 All these editors can be made to jump into the input file to the source
395 of a symbol in the graphical output. See @ref{Point and click}.
400 @node Invoking lilypond-latex
401 @section Invoking lilypond-latex
403 Before LilyPond 2.4, the @code{lilypond} program only generated music
404 notation. Titles and page layout was done in a separate wrapper
405 program. For compatibility with older files, this wrapper program has
406 been retained as @code{lilypond-latex}. It uses the LilyPond program
407 and La@TeX{} to create a nicely titled piece of sheet music. Use of
408 this program is only necessary if the input file contains special
409 La@TeX{} options or formatting codes in markup texts.
411 The @code{lilypond-latex} wrapper is invoked from the command-line as
414 @code{lilypond-latex} [@var{option}]@dots{} @var{file}@dots{}
417 To have @code{lilypond-latex} read from stdin, use a dash (@code{-}) for
418 @var{file}. The program supports the following options.
420 @cindex stdin, reading
424 Keep the temporary directory with all output files. The temporary
425 directory is created in the current directory as @code{@code{lilypond}.dir}.
430 @item -I,--include=@var{dir}
431 Add @var{dir} to LilyPond's include path.
433 @item -o,--output=@var{file}
434 Generate output to @var{file}. The extension of @var{file} is ignored.
437 Also generate pictures of each page, in PNG format.
440 Also generate a picture of the first system of the score.
449 @item -s,--set=@var{key}=@var{val}
450 Add @var{key}= @var{val} to the settings, overriding those specified
451 in the files. Possible keys: @code{language}, @code{latexheaders},
452 @code{latexpackages}, @code{latexoptions}, @code{papersize},
453 @code{linewidth}, @code{orientation},
457 Show version information.
460 Be verbose. This prints out commands as they are executed, and more
461 information about the formatting process is printed.
464 Print even more information. This is useful when generating bug reports.
467 Show the warranty with which GNU LilyPond comes. (It comes with
468 @strong{NO WARRANTY}!)
472 @subsection Additional parameters
474 The @code{lilypond} program responds to several parameters specified
475 in a @code{\layout} section of the input file. They can be overridden
476 by supplying a @code{--set} command line option.
480 Specify La@TeX{} language: the @code{babel} package will be
481 included. Default: unset.
483 Read from the @code{\header} block.
486 Specify additional La@TeX{} header files.
487 Normally read from the @code{\header} block. Default value: empty.
490 Specify additional La@TeX{} package files. This works cumulative,
491 so you can add multiple packages using multiple @code{-s=latexpackages} options.
492 Normally read from the @code{\header} block. Default value:
496 Specify additional options for the La@TeX{}
497 @code{\documentclass}. You can put any valid value here. This was
498 designed to allow @code{lilypond} to produce output for double-sided
499 paper, with balanced margins and page numbers on alternating sides. To
500 achieve this specify @code{twoside}.
503 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
504 read from the @code{\layout} block, if set.
507 The vertical extension of the music on the page. It is normally
508 calculated automatically, based on the paper size.
511 The music line width. It is normally read from the @code{\layout}
515 The paper size (as a name, e.g., @code{a4}). It is normally read from
516 the @code{\layout} block.
519 The font encoding, should be set identical to the @code{font-encoding}
520 property in the score.