1 @c -*- coding: utf-8; mode: texinfo; -*-
3 @chapter Running LilyPond
5 This chapter details the technicalities of running LilyPond.
10 * Notes for the MacOS X app::
12 * Updating files with convert-ly::
17 @node Invoking lilypond
18 @section Invoking lilypond
19 @cindex Invoking LilyPond
20 @cindex command line options
21 @cindex options, command line
25 The @code{lilypond} executable may be called as follows from the command line.
28 lilypond [@var{option}]@dots{} @var{file}@dots{}
32 When invoked with a filename that has no extension, the @file{.ly}
33 extension is tried first. To read input from stdin, use a
34 dash (@code{-}) for @var{file}.
36 When @file{filename.ly} is processed it will produce
37 @file{filename.tex} as output (or @file{filename.ps} for PostScript
38 output). If @file{filename.ly} contains more than one @code{\score}
39 block, then the rest of the scores will be output in numbered files,
40 starting with @file{filename-1.tex}. Several files can be specified;
41 they will each be processed independently. @footnote{The status of
42 GUILE is not reset after processing a @code{.ly} file, so be careful
43 not to change any system defaults from within Scheme.}
46 @section Command line options
48 The following options are supported:
52 @item -e,--evaluate=@var{expr}
53 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
54 Multiple @code{-e} options may be given, they will be evaluated
57 The expression will be evaluated in the @code{guile-user} module, so
58 if you want to use definitions in @var{expr}, use
61 lilypond -e '(define-public a 42)'
65 on the command-line, and include
68 #(use-modules (guile-user))
72 at the top of the @code{.ly} file.
74 @item -f,--format=@var{format}
75 which formats should be written. Choices are @code{svg}, @code{ps},
76 @code{pdf}, @code{png}, @code{tex}, @code{dvi}.
78 @item -b,--backend=@var{format}
79 the output format to use for the back-end. Choices are
82 for @TeX{} output, to be processed with La@TeX{}. If present, the file
83 @file{file.textmetrics} is read to determine text extents.
85 dump text strings to @file{.texstr} file, which can be run through
86 (La)@TeX{}, resulting in a @code{.textmetrics} file, which contains the
87 extents of strings of text.
90 @cindex PostScript output
92 Postscript files include TTF, Type1 and OTF fonts. No subsetting of
93 these fonts is done. When using oriental character sets, this can
97 for encapsulated PostScript. This dumps every page (system) as a separate
98 @file{EPS} file, without fonts, and as one collated @file{EPS} file with
99 all pages (systems) including fonts.
101 This mode is used by default by lilypond-book.
104 for SVG (Scalable Vector Graphics). This dumps every page as a separate
105 @file{SVG} file, with embedded fonts.
106 @cindex SVG (Scalable Vector Graphics)
107 You need a SVG viewer which supports embedded fonts, or a SVG
108 viewer which is able to replace the embedded fonts with OTF fonts.
109 Under Unix, you may use @uref{http://www.inkscape.org,Inkscape}
110 (version 0.42 or later), after copying the OTF fonts in directory
111 @file{PATH/TO/share/lilypond/VERSION/fonts/otf/} to @file{~/.fonts/}.
113 for a dump of the raw, internal Scheme-based drawing commands.
117 @cindex output format, setting
119 @item -d,--define-default=@var{var}=@var{val}
120 This sets the internal program option @var{var} to the Scheme value
121 @var{val}. If @var{val} is not supplied, then @var{#t} is used. To
122 switch off an option, @code{no-} may be prefixed to @var{var}, eg.
130 -dpoint-and-click='#f'
133 @cindex point and click
135 Setting the @code{help} option will print a summary of the options
139 Show a summary of usage.
141 @item -H,--header=FIELD
142 Dump a header field to file BASENAME.FIELD
144 @item --include, -I=@var{directory}
145 Add @var{directory} to the search path for input files.
146 @cindex file searching
149 @item -i,--init=@var{file}
150 Set init file to @var{file} (default: @file{init.ly}).
152 @item -o,--output=@var{FILE}
153 Set the default output file to @var{FILE}. The appropriate
154 suffix will be added (ie @code{.pdf} for pdf, @code{.tex}
161 Generate DVI files. In this case, the @TeX{} backend should be
162 specified, i.e., @code{-b tex}.
165 Generate pictures of each page, in PNG format. This implies
166 @code{--ps}. The resolution in DPI of the image may be set with
172 Generate PDF. This implies @code{--ps}.
175 Generate an output file containing the titles and the first system
178 Do not generate the full pages. Useful in combination with
182 Do not trust the @code{.ly} input.
184 When LilyPond formatting is available through a web server, either the
185 @code{--safe} or the @code{--jail} option @b{MUST} be passed. The
186 @code{--safe} option will prevent inline Scheme code from wreaking
189 When LilyPond formatting is available through a web server, the
190 @code{--safe} @b{MUST} be passed. This will prevent inline Scheme
191 code from wreaking havoc, for example
197 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
202 The @code{--safe} option works by evaluating in-line Scheme
203 expressions in a special safe module. This safe module is derived from
204 GUILE @file{safe-r5rs} module, but adds a number of functions of the
205 LilyPond API. These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
207 In addition, @code{--safe} disallows @code{\include} directives and
208 disables the use of backslashes in @TeX{} strings.
210 In @code{--safe} mode, it is not possible to import LilyPond variables
213 @code{--safe} does @emph{not} detect resource overuse. It is still
214 possible to make the program hang indefinitely, for example by feeding
215 cyclic data structures into the backend. Therefore, if using LilyPond
216 on a publicly accessible webserver, the process should be limited in
217 both CPU and memory usage.
219 Note that @code{--safe} will prevent many useful LilyPond snippets from
220 being compiled. For a softer but secure alternative you can use the
221 @code{--jail} option.
224 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
225 Run LilyPond in a chroot jail.
227 The @code{--jail} option provides a more flexible alternative to
228 @code{--safe} when LilyPond formatting is available through a web
229 server or whenever LilyPond executes externally provided
232 The @code{--jail} option works by changing the root of LilyPond to
233 @var{jail} just before starting the actual compilation process. The user
234 and group are then changed to match those provided, and the current
235 directory is changed to @var{dir}. This setup guarantees that it is not
236 possible (at least in theory) to escape from the jail. Note that for
237 @code{--jail} to work LilyPond must be run as root, which is usually
238 accomplished in a safe way using @command{sudo}.
240 Setting up a jail is a slightly delicate matter, as we must be sure that
241 LilyPond is able to find whatever it needs to compile the source
242 @emph{inside the jail}. A typical setup comprises the following items:
245 @item Setting up a separate filesystem
246 A separate filesystem should be created for LilyPond, so that it can be
247 mounted with safe options such as @code{noexec}, @code{nodev}, and
248 @code{nosuid}. In this way, it is impossible to run executables or to
249 write directly to a device from LilyPond. If you do not want to create a
250 separate partition, just create a file of reasonable size and use it to
251 mount a loop device. A separate filesystem also guarantees that LilyPond
252 cannot write more space than it is allowed.
254 @item Setting up a separate user
255 A separate user and group (say, @samp{lily}/@samp{lily}) with low
256 privileges should be used to run LilyPond inside the jail. There should
257 be a single directory writable by this user, which should be passed in
260 @item Preparing the jail
261 LilyPond needs to read a number of files while running. All these files
262 are to be copied into the jail, under the same path they apper in the
263 real root filesystem. The entire content of the LilyPond installation
264 (e.g., @file{/usr/share/lilypond})
267 If problems arise, the simplest way to trace them down is to run
268 LilyPond using @command{strace}, which will allow you to determine which
271 @item Running LilyPond
272 In a jail mounted with @code{noexec} it is impossible to execute any external
273 program. Therefore LilyPond must be run with a backend that does not
274 require any such program. As we already mentioned, it must be also run
275 with superuser privileges (which, of course, it will lose immediately),
276 possibly using @command{sudo}. It is a good idea to limit the number of
277 seconds of CPU time LilyPond can use (e.g., using @command{ulimit
278 -t}), and, if your operating system supports it, the amount of memory
279 that can be allocated.
284 Show version information.
287 Be verbose: show full paths of all files read, and give timing
291 Show the warranty with which GNU LilyPond comes. (It comes with
292 @strong{NO WARRANTY}!)
296 @section Environment variables
300 @cindex LILYPONDPREFIX
302 @code{Lilypond} recognizes the following environment variables:
305 This specifies a directory where locale messages and
306 data files will be looked up by default. The directory should contain
307 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
310 This selects the language for the warning messages.
312 @item LILYPOND_GC_YIELD
313 With this variable the memory footprint and performance can be
314 adjusted. It is a percentage tunes memory management behavior. With
315 higher values, the program uses more memory, with smaller values, it
316 uses more CPU time. The default value is @code{70}.
321 @node Notes for the MacOS X app
322 @section Notes for the MacOS X app
324 The scripts (such as lilypond-book, convert-ly, abc2ly, etc.) are also
325 included inside MacOS X .app. They can be run from the command line by
326 invoking them directly, e.g.
329 @var{path/to}/LilyPond.app/Contents/Resources/bin/convert-ly
333 @section Error messages
335 @cindex error messages
336 Different error messages can appear while compiling a file:
342 Something looks suspect. If you are requesting something out of the
343 ordinary then you will understand the message, and can ignore it.
344 However, warnings usually indicate that something is wrong with the
348 Something is definitely wrong. The current processing step (parsing,
349 interpreting, or formatting) will be finished, but the next step will
355 Something is definitely wrong, and LilyPond cannot continue. This
356 happens rarely. The most usual cause is misinstalled fonts.
358 @cindex trace, Scheme
362 Errors that occur while executing Scheme code are caught by the Scheme
363 interpreter. If running with the verbose option (@code{-V} or
364 @code{--verbose}) then a call trace of the offending
365 function call is printed.
367 @cindex Programming error
368 @item Programming error
369 There was some internal inconsistency. These error messages are
370 intended to help the programmers and debuggers. Usually, they can be
371 ignored. Sometimes, they come in such big quantities that they obscure
372 other output. In this case, file a bug-report.
374 @item Aborted (core dumped)
375 This signals a serious programming error that caused the program to
376 crash. Such errors are considered critical. If you stumble on one,
382 @cindex errors, message format
383 If warnings and errors can
384 be linked to some part of the input file, then error messages have the
388 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
389 @var{offending input line}
392 A line-break is inserted in the offending line to indicate the column
393 where the error was found. For example,
396 test.ly:2:19: error: not a duration: 5:
401 These locations are LilyPond's best guess about where the warning or
402 error occured, but (by their very nature) warnings and errors occur
403 when something unexpected happens. If you can't see an error in the
404 indicated line of your input file, try checking one or two lines
405 above the indicated position.
408 @node Updating files with convert-ly
409 @section Updating with @command{convert-ly}
411 @cindex Updating a LilyPond file
412 @cindex @code{convert-ly}
414 The LilyPond input syntax is routinely changed to simplify it or improve
415 it in different ways. As a side effect of this, the LilyPond interpreter
416 often is no longer compatible with older input files. To remedy this,
417 the program @command{convert-ly} can be used to deal with most of the
418 syntax changes between LilyPond versions.
420 It uses @code{\version} statements in the input files to detect the
421 old version number. In most cases, to upgrade your input file it is
422 sufficient to run@footnote{MacOS X users may execute this command
423 under the menu entry @samp{Compile > Update syntax}.}
426 convert-ly -e myfile.ly
429 If there are no changes to myfile.ly and file called myfile.ly.NEW
430 is created, then myfile.ly is already updated.
432 @command{convert-ly} always converts up to the last syntax change handled by
433 it. This means that the @code{\version} number left in the file is
434 usually lower than the version of @command{convert-ly} itself.
436 To upgrade LilyPond fragments in texinfo files, use
439 convert-ly --from=... --to=... --no-version *.itely
442 To upgrade many files at once, combine @code{convert-ly} with
443 standard unix commands. This example will upgrade all @code{.ly}
444 files in the current directory
447 for f in *.ly; do convert-ly -e $f; done;
450 In general, the program is invoked as follows:
453 convert-ly [@var{option}]@dots{} @var{file}@dots{}
457 The following options can be given:
461 Do an inline edit of the input file. Overrides @code{--output}.
463 @item -f,--from=@var{from-patchlevel}
464 Set the version to convert from. If this is not set, @command{convert-ly}
465 will guess this, on the basis of @code{\version} strings in the file.
467 @item -n,--no-version
468 Normally, @command{convert-ly} adds a @code{\version} indicator
469 to the output. Specifying this option suppresses this.
471 @item -s, --show-rules
472 Show all known conversions and exit.
474 @item --to=@var{to-patchlevel}
475 Set the goal version of the conversion. It defaults to the latest
485 Not all language changes are handled. Only one output option can be
489 @c We might want to make this a completely new section, along with more
490 @c info about how to upgrade old input files. -gp
493 Copy and paste from CVS, last updated
496 http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/lilypond/lily-bugs/bugs/convert-ly.txt?rev=HEAD&content-type=text/plain
500 There are a few things that the convert-ly cannot handle. Here's a list of limitations
501 that the community has complained about.
503 This bug report structure has been chosen because convert-ly has a structure that doesn't
504 allow to smoothly implement all needed changes. Thus this is just a wishlist, placed
508 Doesn't always convert figured bass correctly, specifically things like {< >}. Mats' comment on working around this:
509 To be able to run convert-ly
510 on it, I first replaced all occurencies of '{<' to some dummy like '{#'
511 and similarly I replaced '>}' with '&}'. After the conversion, I could
512 then change back from '{ #' to '{ <' and from '& }' to '> }'.
513 Doesn't convert all text markup correctly. In the old markup syntax,
514 it was possible to group a number of markup commands together within parentheses, e.g.
515 -#'((bold italic) "string")
516 This will incorrectly be converted into
517 -\markup{{\bold italic} "string"}
518 instead of the correct
519 -\markup{\bold \italic "string"}
521 Doesn't handle \partcombine
522 Doesn't do \addlyrics => \lyricsto, this breaks some scores with multiple stanzas.
524 \magnify isn't changed to \fontsize.
525 - \magnify #m => \fontsize #f, where f = 6ln(m)/ln(2)
526 remove-tag isn't changed.
527 - \applyMusic #(remove-tag '. . .) => \keepWithTag #'. . .
528 first-page-number isn't changed.
529 - first-page-number no => printfirst-page-number = ##f
530 Line breaks in header strings aren't converted.
531 - \\\\ as line break in \header strings => \markup \center-align <
532 "First Line" "Second Line" >
533 Crescendo and decrescendo terminators aren't converted.
537 \turnOff (used in \set Staff.VoltaBracket = \turnOff) is not properly converted.
539 \markup{ \center-align <{ ... }> } should be converted to:
540 \markup{ \center-align {\line { ... }} }
541 but now, \line is missing.
543 Special LaTeX characters such as $~$ in text are not converted to UTF8.
549 @section Reporting bugs
552 @cindex reporting bugs
554 If you have input that results in a crash or an erroneous output, then
555 that is a bug. We try to respond to bug-reports promptly, and fix them as
556 soon as possible. Help us by sending a defective input file, so we can
557 reproduce the problem. Send the report via:
560 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs}
566 @item Try to produce a very small input file which demonstrates the problem;
567 one or two bars is often sufficient to reproduce a bug. The smaller the
568 input file is, the easier it is for us to debug the problem.
570 @item Don't forget to tell which version of LilyPond you use!
572 @item If possible, use @code{ragged-right} in your example. This makes sure
573 that the bug can be reproduced in all paper sizes.
577 @c the bug database is not up to date enough.
579 When you've found a bug, have a look at our
580 @uref{http://@/lilypond@/.org/@/doc/@/v2.5/@/bugs/,bug database} to see if
581 it has already been reported. You could also try to do a few searches
582 on the mailing list for the bug. Sometimes the bug will have already
583 been reported and a fix or workaround is already known.
586 Here is an example of a good bug report:
589 It seems that placement of accidentals is broken. In the
590 following example, the accidental touches the note head.
592 Using Mac OSX 10.3.7, fink package lilypond-devel
595 \layout { ragged-right = ##t }
603 \layout { ragged-right = ##t }
605 \override Accidental #'extra-offset = #'(1.0 . 0)
611 @section Editor support
616 @cindex modes, editor
617 @cindex syntax coloring
618 @cindex coloring, syntax
620 There is support from different editors for LilyPond.
624 Emacs has a @file{lilypond-mode}, which provides keyword
625 autocompletion, indentation, LilyPond specific parenthesis matching
626 and syntax coloring, handy compile short-cuts and reading LilyPond
627 manuals using Info. If @file{lilypond-mode} is not installed on your
628 platform, then read the
630 @uref{source/Documentation/topdocs/INSTALL.html,installation instructions}.
633 installation instructions.
638 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along
639 with syntax coloring tools. For more information, refer to the
641 @uref{source/Documentation/topdocs/INSTALL.html,installation instructions}.
644 installation instructions.
650 The @uref{http://@/www@/.jedit@/.org@/,jEdit} editor has a LilyPond plugin.
651 This plugin includes a DVI viewer, integrated help and viewing via
652 GhostScript. It can be installed by doing @key{Plugins > Plugin
653 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
657 All these editors can be made to jump into the input file to the source
658 of a symbol in the graphical output. See @ref{Point and click}.