1 @c -*- coding: latin-1; mode: texinfo; -*-
3 @chapter Running LilyPond
5 This chapter details the technicalities of running LilyPond.
11 * Updating files with convert-ly::
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 Postscript files include TTF, Type1 and OTF fonts. No subsetting of
77 these fonts is done. When using oriental character sets, this can
81 for encapsulated PostScript. This dumps every page (system) as a separate
82 @file{EPS} file, without fonts, and as one collated @file{EPS} file with
83 all pages (systems) including fonts.
85 This mode is used by default by lilypond-book.
88 for SVG (Scalable Vector Graphics)
89 @cindex SVG (Scalable Vector Graphics)
91 for a dump of the raw, internal Scheme-based drawing commands.
95 @cindex output format, setting
98 Show a summary of usage.
100 @item --include, -I=@var{directory}
101 Add @var{directory} to the search path for input files.
102 @cindex file searching
105 @item -i,--init=@var{file}
106 Set init file to @var{file} (default: @file{init.ly}).
108 @item -o,--output=@var{FILE}
109 Set the default output file to @var{FILE}. The appropriate
110 suffix will be added (ie @code{.pdf} for pdf, @code{.tex}
117 Generate DVI files. In this case, the @TeX{} backend should be
118 specified, i.e., @code{-f tex}.
121 Generate pictures of each page, in PNG format. This implies @code{--ps}.
124 Generate PDF. This implies @code{--ps}.
127 Generate an output file containing the titles and the first system
130 Do not generate the full pages. Useful in combination with
134 Do not trust the @code{.ly} input.
136 When LilyPond formatting is available through a web server, either the
137 @code{--safe} or the @code{--jail} option @b{MUST} be passed. The
138 @code{--safe} option will prevent inline Scheme code from wreaking
141 When LilyPond formatting is available through a web server, the
142 @code{--safe} @b{MUST} be passed. This will prevent inline Scheme
143 code from wreaking havoc, for example
149 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
154 The @code{--safe} option works by evaluating in-line Scheme
155 expressions in a special safe module. This safe module is derived from
156 GUILE @file{safe-r5rs} module, but adds a number of functions of the
157 LilyPond API. These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
159 In addition, @code{--safe} disallows @code{\include} directives and
160 disables the use of backslashes in @TeX{} strings.
162 In @code{--safe} mode, it is not possible to import LilyPond variables
165 @code{--safe} does @emph{not} detect resource overuse. It is still
166 possible to make the program hang indefinitely, for example by feeding
167 cyclic data structures into the backend. Therefore, if using LilyPond
168 on a publicly accessible webserver, the process should be limited in
169 both CPU and memory usage.
171 Note that @code{--safe} will prevent many useful LilyPond snippets from
172 being compiled. For a softer but secure alternative you can use the
173 @code{--jail} option.
176 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
177 Run LilyPond in a jail.
179 The @code{--jail} option provides a more flexible alternative to
180 @code{--safe} when LilyPond formatting is available through a web
181 server or whenever LilyPond executes externally provided
184 The @code{--jail} option works by changing the root of LilyPond to
185 @var{jail} just before starting the actual compilation process. The user
186 and group are then changed to match those provided, and the current
187 directory is changed to @var{dir}. This setup guarantees that it is not
188 possible (at least in theory) to escape from the jail. Note that for
189 @code{--jail} to work LilyPond must be run as root, which is usually
190 accomplished in a safe way using @command{sudo}.
192 Setting up a jail is a slightly delicate matter, as we must be sure that
193 LilyPond is able to find whatever it needs to compile the source
194 @emph{inside the jail}. A typical setup comprises the following items:
197 @item Setting up a separate filesystem
198 A separate filesystem should be created for LilyPond, so that it can be
199 mounted with safe options such as @code{noexec}, @code{nodev}, and
200 @code{nosuid}. In this way, it is impossible to run executables or to
201 write directly to a device from LilyPond. If you do not want to create a
202 separate partition, just create a file of reasonable size and use it to
203 mount a loop device. A separate filesystem also guarantees that LilyPond
204 cannot write more space than it is allowed.
206 @item Setting up a separate user
207 A separate user and group (say, @samp{lily}/@samp{lily}) with low
208 privileges should be used to run LilyPond inside the jail. There should
209 be a single directory writable by this user, which should be passed in
212 @item Preparing the jail
213 LilyPond needs to read a number of files while running. All these files
214 are to be copied into the jail, under the same path they apper in the
215 real root filesystem. The entire content of the LilyPond installation
216 (e.g., @file{/usr/share/lilypond})
220 FIXME: fact-check; delete very soon. -gp
221 , and the content of the @file{fonts},
222 @file{dvips} and @file{web2c} directories of the @TeX{} installation
223 (usually under @file{/usr/share/texmf}) should be copied, too. If your
224 @TeX{} installation uses @file{ls-R} caches, copy also the cache inside the root
228 If problems arise, the simplest way to trace them down is to run
229 LilyPond using @command{strace}, which will allow you to determine which
232 @item Running LilyPond
233 In a jail mounted with @code{noexec} it is impossible to execute any external
234 program. Therefore LilyPond must be run with a backend that does not
235 require any such program. As we already mentioned, it must be also run
236 with superuser privileges (which, of course, it will lose immediately),
237 possibly using @command{sudo}. It is a good idea to limit the number of
238 seconds of CPU time LilyPond can use (e.g., using @command{ulimit
239 -t}), and, if your operating system supports it, the amount of memory
240 that can be allocated.
245 Show version information.
248 Be verbose: show full paths of all files read, and give timing
252 Show the warranty with which GNU LilyPond comes. (It comes with
253 @strong{NO WARRANTY}!)
257 @section Environment variables
259 For processing both the @TeX{} and the PostScript output, the
260 appropriate environment variables must be set. The following scripts
264 @item @file{buildscripts/@/out/@/lilypond@/-profile}
266 @item @file{buildscripts/@/out/@/lilypond@/-login} (for C-shells)
269 They should normally be sourced as part of the login process. If these
270 scripts are not run from the system wide login process, then you must
273 @cindex installing LilyPond
275 If you use sh, bash, or a similar shell, then add the following to
276 your @file{.profile}:
278 . @var{/the/path/to/}lilypond-profile
281 If you use csh, tcsh or a similar shell, then add the following to
282 your @file{~/.login}:
284 source @var{/the/path/to/}lilypond-login
287 Of course, in both cases, you should substitute the proper location of
290 These scripts set the following variables:
293 To make sure that @TeX{} and lilypond find data files (among
294 others @file{.tex}, @file{.mf}, and @file{.tfm}),
295 you have to set @code{TEXMF} to point to the lilypond data
296 file tree. A typical setting would be
298 @{/usr/share/lilypond/2.4.0,@{!!/usr/share/texmf@}@}
306 @cindex printing postscript
308 The binary itself recognizes the following environment variables:
311 This specifies a directory where locale messages and
312 data files will be looked up by default. The directory should contain
313 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
316 This selects the language for the warning messages.
320 @cindex LILYPONDPREFIX
323 @section Error messages
325 @cindex error messages
326 Different error messages can appear while compiling a file:
332 Something looks suspect. If you are requesting something out of the
333 ordinary then you will understand the message, and can ignore it.
334 However, warnings usually indicate that something is wrong with the
338 Something is definitely wrong. The current processing step (parsing,
339 interpreting, or formatting) will be finished, but the next step will
345 Something is definitely wrong, and LilyPond cannot continue. This
346 happens rarely. The most usual cause is misinstalled fonts.
348 @cindex trace, Scheme
352 Errors that occur while executing Scheme code are caught by the Scheme
353 interpreter. If running with the verbose option (@code{-V} or
354 @code{--verbose}) then a call trace of the offending
355 function call is printed.
357 @cindex Programming error
358 @item Programming error
359 There was some internal inconsistency. These error messages are
360 intended to help the programmers and debuggers. Usually, they can be
361 ignored. Sometimes, they come in such big quantities that they obscure
362 other output. In this case, file a bug-report.
364 @item Aborted (core dumped)
365 This signals a serious programming error that caused the program to
366 crash. Such errors are considered critical. If you stumble on one,
372 @cindex errors, message format
373 If warnings and errors can
374 be linked to some part of the input file, then error messages have the
378 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
379 @var{offending input line}
382 A line-break is inserted in the offending line to indicate the column
383 where the error was found. For example,
386 test.ly:2:19: error: not a duration: 5:
391 These locations are LilyPond's best guess about where the warning or
392 error occured, but (by their very nature) warnings and errors occur
393 when something unexpected happens. If you can't see an error in the
394 indicated line of your input file, try checking one or two lines
395 above the indicated position.
398 @node Updating files with convert-ly
399 @section Updating with @command{convert-ly}
401 The LilyPond input syntax is routinely changed to simplify it or improve
402 it in different ways. As a side effect of this, the LilyPond interpreter
403 often is no longer compatible with older input files. To remedy this,
404 the program @command{convert-ly} can be used to deal with most of the
405 syntax changes between LilyPond versions.
407 It uses @code{\version} statements in the input files to detect the old
408 version number. In most cases, to upgrade your input file it is sufficient
412 convert-ly -e myfile.ly
415 If there are no changes to myfile.ly and file called myfile.ly.NEW
416 is created, then myfile.ly is already updated.
418 To upgrade LilyPond fragments in texinfo files, use
421 convert-ly --from=... --to=... --no-version *.itely
424 To upgrade many files at once, combine @code{convert-ly} with
425 standard unix commands. This example will upgrade all @code{.ly}
426 files in the current directory
429 for f in *.ly; do convert-ly -e $f; done;
432 In general, the program is invoked as follows:
435 convert-ly [@var{option}]@dots{} @var{file}@dots{}
439 The following options can be given:
443 Do an inline edit of the input file. Overrides @code{--output}.
445 @item -f,--from=@var{from-patchlevel}
446 Set the version to convert from. If this is not set, @command{convert-ly}
447 will guess this, on the basis of @code{\version} strings in the file.
449 @item -o,--output=@var{file}
450 Set the output file to write.
452 @item -n,--no-version
453 Normally, @command{convert-ly} adds a @code{\version} indicator
454 to the output. Specifying this option suppresses this.
456 @item -s, --show-rules
457 Show all known conversions and exit.
459 @item --to=@var{to-patchlevel}
460 Set the goal version of the conversion. It defaults to the latest
467 @command{convert-ly} always converts up to the last syntax change handled by
468 it. This means that the @code{\version} number left in the file is
469 usually lower than the version of @command{convert-ly} itself.
473 Not all language changes are handled. Only one output option can be
477 @c We might want to make this a completely new section, along with more
478 @c info about how to upgrade old input files. -gp
481 Copy and paste from CVS, last updated
484 http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/lilypond/lily-bugs/bugs/convert-ly.txt?rev=HEAD&content-type=text/plain
488 There are a few things that the convert-ly cannot handle. Here's a list of limitations
489 that the community has complained about.
491 This bug report structure has been chosen because convert-ly has a structure that doesn't
492 allow to smoothly implement all needed changes. Thus this is just a wishlist, placed
496 Doesn't always convert figured bass correctly, specifically things like {< >}. Mats' comment on working around this:
497 To be able to run convert-ly
498 on it, I first replaced all occurencies of '{<' to some dummy like '{#'
499 and similarly I replaced '>}' with '&}'. After the conversion, I could
500 then change back from '{ #' to '{ <' and from '& }' to '> }'.
501 Doesn't convert all text markup correctly. Only very simple cases are fixed.
503 Doesn't handle \partcombine
504 Doesn't do \addlyrics => \lyricsto, this breaks some scores with multiple stanzas.
506 \turnOff (used in \set Staff.VoltaBracket = \turnOff) is not properly converted.
508 \markup{ \center-align <{ ... }> } should be converted to:
509 \markup{ \center-align {\line { ... }} }
510 but now, \line is missing.
515 @section Reporting bugs
518 @cindex reporting bugs
520 If you have input that results in a crash or an erroneous output, then
521 that is a bug. We try to respond to bug-reports promptly, and fix them as
522 soon as possible. Help us by sending a defective input file, so we can
523 reproduce the problem. Make it small, so we can easily debug the
524 problem. Don't forget to tell which version of LilyPond you use! Send
525 the report to @email{bug-lilypond@@gnu.org}.
527 When you've found a bug, have a look at our
528 @uref{http://@/lilypond@/.org/@/doc/@/v2.5/@/bugs/,bug database} to see if
529 it has already been reported. You could also try to do a few searches
530 on the mailing list for the bug. Sometimes the bug will have already
531 been reported and a fix or workaround is already known.
533 Here is an example of a good bug report:
536 It seems that placement of accidentals is broken. In the
537 following example, the accidental touches the note head.
539 Using Mac OSX 10.3.5, fink package lilypond-unstable
550 \override Accidental #'extra-offset = #'(1.0 . 0)
556 @section Editor support
561 @cindex modes, editor
562 @cindex syntax coloring
563 @cindex coloring, syntax
565 There is support from different editors for LilyPond.
569 Emacs has a @file{lilypond-mode}, which provides keyword
570 autocompletion, indentation, LilyPond specific parenthesis matching
571 and syntax coloring, handy compile short-cuts and reading LilyPond
572 manuals using Info. If @file{lilypond-mode} is not installed on your
573 platform, then read the
575 @uref{source/Documentation/topdocs/out-www/INSTALL.html,installation instructions}.
578 installation instructions.
583 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along
584 with syntax coloring tools. For more information, refer to the
586 @uref{source/Documentation/topdocs/out-www/INSTALL.html,installation instructions}.
589 installation instructions.
595 The @uref{http://@/www@/.jedit@/.org@/,jEdit} editor has a LilyPond plugin.
596 This plugin includes a DVI viewer, integrated help and viewing via
597 GhostScript. It can be installed by doing @key{Plugins > Plugin
598 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
602 All these editors can be made to jump into the input file to the source
603 of a symbol in the graphical output. See @ref{Point and click}.