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 encapsulated PostScript. This dumps every page (system) as a separate
77 @file{EPS} file, without fonts, and as one collated @file{EPS} file with
78 all pages (systems) including fonts.
80 This mode is used by default by lilypond-book.
83 for SVG (Scalable Vector Graphics)
84 @cindex SVG (Scalable Vector Graphics)
86 for a dump of the raw, internal Scheme-based drawing commands.
90 @cindex output format, setting
93 Show a summary of usage.
95 @item --include, -I=@var{directory}
96 Add @var{directory} to the search path for input files.
97 @cindex file searching
100 @item -i,--init=@var{file}
101 Set init file to @var{file} (default: @file{init.ly}).
103 @item -o,--output=@var{FILE}
104 Set the default output file to @var{FILE}. The appropriate
105 suffix will be added (ie @code{.pdf} for pdf, @code{.tex}
112 Generate DVI files. In this case, the @TeX{} backend should be
113 specified, i.e., @code{-f tex}.
116 Generate pictures of each page, in PNG format. This implies @code{--ps}.
119 Generate PDF. This implies @code{--ps}.
122 Generate an output file containing the titles and the first system
125 Do not generate the full pages. Useful in combination with
129 Do not trust the @code{.ly} input.
131 When LilyPond formatting is available through a web server, the
132 @code{--safe} @b{MUST} be passed. This will prevent inline Scheme
133 code from wreaking havoc, for example
139 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
144 The @code{--safe} option works by evaluating in-line Scheme
145 expressions in a special safe module. This safe module is derived from
146 GUILE @file{safe-r5rs} module, but adds a number of functions of the
147 LilyPond API. These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
149 In addition, @code{--safe} disallows @code{\include} directives and
150 disables the use of backslashes in @TeX{} strings.
152 In @code{--safe} mode, it is not possible to import LilyPond variables
155 @code{--safe} does @emph{not} detect resource overuse. It is still
156 possible to make the program hang indefinitely, for example by feeding
157 cyclic data structures into the backend. Therefore, if using LilyPond
158 on a publicly accessible webserver, the process should be limited in
159 both CPU and memory usage.
162 Show version information.
165 Be verbose: show full paths of all files read, and give timing
169 Show the warranty with which GNU LilyPond comes. (It comes with
170 @strong{NO WARRANTY}!)
174 @section Environment variables
176 For processing both the @TeX{} and the PostScript output, the
177 appropriate environment variables must be set. The following scripts
181 @item @file{buildscripts/@/out/@/lilypond@/-profile}
183 @item @file{buildscripts/@/out/@/lilypond@/-login} (for C-shells)
186 They should normally be sourced as part of the login process. If these
187 scripts are not run from the system wide login process, then you must
190 @cindex installing LilyPond
192 If you use sh, bash, or a similar shell, then add the following to
193 your @file{.profile}:
195 . @var{/the/path/to/}lilypond-profile
198 If you use csh, tcsh or a similar shell, then add the following to
199 your @file{~/.login}:
201 source @var{/the/path/to/}lilypond-login
204 Of course, in both cases, you should substitute the proper location of
207 These scripts set the following variables:
210 To make sure that @TeX{} and lilypond find data files (among
211 others @file{.tex}, @file{.mf}, and @file{.tfm}),
212 you have to set @code{TEXMF} to point to the lilypond data
213 file tree. A typical setting would be
215 @{/usr/share/lilypond/2.4.0,@{!!/usr/share/texmf@}@}
223 @cindex printing postscript
225 The binary itself recognizes the following environment variables:
228 This specifies a directory where locale messages and
229 data files will be looked up by default. The directory should contain
230 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
233 This selects the language for the warning messages.
237 @cindex LILYPONDPREFIX
240 @section Error messages
242 @cindex error messages
243 Different error messages can appear while compiling a file:
249 Something looks suspect. If you are requesting something out of the
250 ordinary then you will understand the message, and can ignore it.
251 However, warnings usually indicate that something is wrong with the
255 Something is definitely wrong. The current processing step (parsing,
256 interpreting, or formatting) will be finished, but the next step will
262 Something is definitely wrong, and LilyPond cannot continue. This
263 happens rarely. The most usual cause is misinstalled fonts.
265 @cindex trace, Scheme
269 Errors that occur while executing Scheme code are caught by the Scheme
270 interpreter. If running with the verbose option (@code{-V} or
271 @code{--verbose}) then a call trace of the offending
272 function call is printed.
274 @cindex Programming error
275 @item Programming error
276 There was some internal inconsistency. These error messages are
277 intended to help the programmers and debuggers. Usually, they can be
278 ignored. Sometimes, they come in such big quantities that they obscure
279 other output. In this case, file a bug-report.
281 @item Aborted (core dumped)
282 This signals a serious programming error that caused the program to
283 crash. Such errors are considered critical. If you stumble on one,
289 @cindex errors, message format
290 If warnings and errors can
291 be linked to some part of the input file, then error messages have the
295 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
296 @var{offending input line}
299 A line-break is inserted in the offending line to indicate the column
300 where the error was found. For example,
303 test.ly:2:19: error: not a duration: 5:
308 These locations are LilyPond's best guess about where the warning or
309 error occured, but (by their very nature) warnings and errors occur
310 when something unexpected happens. If you can't see an error in the
311 indicated line of your input file, try checking one or two lines
312 above the indicated position.
316 @section Reporting bugs
319 @cindex reporting bugs
321 If you have input that results in a crash or an erroneous output, then
322 that is a bug. We try to respond to bug-reports promptly, and fix them as
323 soon as possible. Help us by sending a defective input file, so we can
324 reproduce the problem. Make it small, so we can easily debug the
325 problem. Don't forget to tell which version of LilyPond you use! Send
326 the report to @email{bug-lilypond@@gnu.org}.
328 When you've found a bug, have a look at our
329 @uref{http://@/lilypond@/.org/@/doc/@/v2.3/@/bugs/,bug database} to see if
330 it has already been reported. You could also try to do a few searches
331 on the mailing list for the bug. Sometimes the bug will have already
332 been reported and a fix or workaround is already known.
334 Here is an example of a good bug report:
337 It seems that placement of accidentals is broken. In the
338 following example, the accidental touches the note head.
340 Using Mac OSX 10.3.5, fink package lilypond-unstable
351 \override Accidental #'extra-offset = #'(1.0 . 0)
357 @section Editor support
362 @cindex modes, editor
363 @cindex syntax coloring
364 @cindex coloring, syntax
366 There is support from different editors for LilyPond.
370 Emacs has a @file{lilypond-mode}, which provides keyword
371 autocompletion, indentation, LilyPond specific parenthesis matching
372 and syntax coloring, handy compile short-cuts and reading LilyPond
373 manuals using Info. If @file{lilypond-mode} is not installed on your
374 platform, then read the
376 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
379 installation instructions.
384 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along
385 with syntax coloring tools. For more information, refer to the
387 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
390 installation instructions.
396 The @uref{http://@/www@/.jedit@/.org/,jEdit} editor has a LilyPond plugin.
397 This plugin includes a DVI viewer, integrated help and viewing via
398 GhostScript. It can be installed by doing @key{Plugins > Plugin
399 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
403 All these editors can be made to jump into the input file to the source
404 of a symbol in the graphical output. See @ref{Point and click}.
409 @node Invoking lilypond-latex
410 @section Invoking lilypond-latex
412 Before LilyPond 2.4, the @code{lilypond} program only generated music
413 notation. Titles and page layout was done in a separate wrapper
414 program. For compatibility with older files, this wrapper program has
415 been retained as @code{lilypond-latex}. It uses the LilyPond program
416 and La@TeX{} to create a nicely titled piece of sheet music. Use of
417 this program is only necessary if the input file contains special
418 La@TeX{} options or formatting codes in markup texts.
420 The @code{lilypond-latex} wrapper is invoked from the command-line as
423 @code{lilypond-latex} [@var{option}]@dots{} @var{file}@dots{}
426 To have @code{lilypond-latex} read from stdin, use a dash (@code{-}) for
427 @var{file}. The program supports the following options.
429 @cindex stdin, reading
433 Keep the temporary directory with all output files. The temporary
434 directory is created in the current directory as @code{@code{lilypond}.dir}.
439 @item -I,--include=@var{dir}
440 Add @var{dir} to LilyPond's include path.
442 @item -o,--output=@var{file}
443 Generate output to @var{file}. The extension of @var{file} is ignored.
446 Also generate pictures of each page, in PNG format.
449 Also generate a picture of the first system of the score.
458 @item -s,--set=@var{key}=@var{val}
459 Add @var{key}= @var{val} to the settings, overriding those specified
460 in the files. Possible keys: @code{language}, @code{latexheaders},
461 @code{latexpackages}, @code{latexoptions}, @code{papersize},
462 @code{linewidth}, @code{orientation},
466 Show version information.
469 Be verbose. This prints out commands as they are executed, and more
470 information about the formatting process is printed.
473 Print even more information. This is useful when generating bug reports.
476 Show the warranty with which GNU LilyPond comes. (It comes with
477 @strong{NO WARRANTY}!)
481 @subsection Additional parameters
483 The @code{lilypond} program responds to several parameters specified
484 in a @code{\layout} section of the input file. They can be overridden
485 by supplying a @code{--set} command line option.
489 Specify La@TeX{} language: the @code{babel} package will be
490 included. Default: unset.
492 Read from the @code{\header} block.
495 Specify additional La@TeX{} header files.
496 Normally read from the @code{\header} block. Default value: empty.
499 Specify additional La@TeX{} package files. This works cumulative,
500 so you can add multiple packages using multiple @code{-s=latexpackages} options.
501 Normally read from the @code{\header} block. Default value:
505 Specify additional options for the La@TeX{}
506 @code{\documentclass}. You can put any valid value here. This was
507 designed to allow @code{lilypond} to produce output for double-sided
508 paper, with balanced margins and page numbers on alternating sides. To
509 achieve this specify @code{twoside}.
512 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
513 read from the @code{\layout} block, if set.
516 The vertical extension of the music on the page. It is normally
517 calculated automatically, based on the paper size.
520 The music line width. It is normally read from the @code{\layout}
524 The paper size (as a name, e.g., @code{a4}). It is normally read from
525 the @code{\layout} block.
528 The font encoding, should be set identical to the @code{font-encoding}
529 property in the score.