1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @c This file is part of lilypond.tely
5 @chapter Running LilyPond
7 This chapter details the technicalities of running LilyPond.
12 * Notes for the MacOS X app::
13 * Updating files with convert-ly::
20 @node Invoking lilypond
21 @section Invoking lilypond
22 @cindex Invoking LilyPond
23 @cindex command line options
24 @cindex options, command line
28 The @code{lilypond} executable may be called as follows from the command line.
31 lilypond [@var{option}]@dots{} @var{file}@dots{}
35 When invoked with a filename that has no extension, the @file{.ly}
36 extension is tried first. To read input from stdin, use a
37 dash (@code{-}) for @var{file}.
39 When @file{filename.ly} is processed it will produce
40 @file{filename.tex} as output (or @file{filename.ps} for PostScript
41 output). If @file{filename.ly} contains more than one @code{\score}
42 block, then the rest of the scores will be output in numbered files,
43 starting with @file{filename-1.tex}. Several files can be specified;
44 they will each be processed independently. @footnote{The status of
45 GUILE is not reset after processing a @code{.ly} file, so be careful
46 not to change any system defaults from within Scheme.}
49 @subsection Command line options
51 The following options are supported:
55 @item -e,--evaluate=@var{expr}
56 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
57 Multiple @code{-e} options may be given, they will be evaluated
60 The expression will be evaluated in the @code{guile-user} module, so
61 if you want to use definitions in @var{expr}, use
64 lilypond -e '(define-public a 42)'
68 on the command-line, and include
71 #(use-modules (guile-user))
75 at the top of the @code{.ly} file.
77 @item -f,--format=@var{format}
78 which formats should be written. Choices are @code{svg}, @code{ps},
79 @code{pdf}, @code{png}, @code{tex}, @code{dvi}.
81 @item -b,--backend=@var{format}
82 the output format to use for the back-end. Choices are
85 for @TeX{} output, to be processed with La@TeX{}. If present, the file
86 @file{file.textmetrics} is read to determine text extents.
88 dump text strings to @file{.texstr} file, which can be run through
89 (La)@TeX{}, resulting in a @code{.textmetrics} file, which contains the
90 extents of strings of text.
93 @cindex PostScript output
95 Postscript files include TTF, Type1 and OTF fonts. No subsetting of
96 these fonts is done. When using oriental character sets, this can
100 for encapsulated PostScript. This dumps every page (system) as a separate
101 @file{EPS} file, without fonts, and as one collated @file{EPS} file with
102 all pages (systems) including fonts.
104 This mode is used by default by lilypond-book.
107 for SVG (Scalable Vector Graphics). This dumps every page as a separate
108 @file{SVG} file, with embedded fonts.
109 @cindex SVG (Scalable Vector Graphics)
110 You need a SVG viewer which supports embedded fonts, or a SVG
111 viewer which is able to replace the embedded fonts with OTF fonts.
112 Under Unix, you may use @uref{http://www.inkscape.org,Inkscape}
113 (version 0.42 or later), after copying the OTF fonts in directory
114 @file{PATH/TO/share/lilypond/VERSION/fonts/otf/} to @file{~/.fonts/}.
116 for a dump of the raw, internal Scheme-based drawing commands.
120 @cindex output format, setting
122 @item -d,--define-default=@var{var}=@var{val}
123 This sets the internal program option @var{var} to the Scheme value
124 @var{val}. If @var{val} is not supplied, then @var{#t} is used. To
125 switch off an option, @code{no-} may be prefixed to @var{var}, e.g.
127 @cindex point and click, command line
136 -dpoint-and-click='#f'
139 Another notable option is
142 -dpaper-size=\"letter\"
146 Note that the string must be enclosed in escaped quotes ( @code{\"} ).
148 Setting the @code{-dhelp} option will print a summary of the options
152 Show a summary of usage.
154 @item -H,--header=FIELD
155 Dump a header field to file BASENAME.FIELD
157 @item --include, -I=@var{directory}
158 Add @var{directory} to the search path for input files.
159 @cindex file searching
162 @item -i,--init=@var{file}
163 Set init file to @var{file} (default: @file{init.ly}).
165 @item -o,--output=@var{FILE}
166 Set the default output file to @var{FILE}. The appropriate
167 suffix will be added (ie @code{.pdf} for pdf, @code{.tex}
174 Generate DVI files. In this case, the @TeX{} backend should be
175 specified, i.e., @code{-b tex}.
178 Generate pictures of each page, in PNG format. This implies
179 @code{--ps}. The resolution in DPI of the image may be set with
185 Generate PDF. This implies @code{--ps}.
188 Generate an output file containing the titles and the first system
191 Do not generate the full pages. Useful in combination with
195 Do not trust the @code{.ly} input.
197 When LilyPond formatting is available through a web server, either the
198 @code{--safe} or the @code{--jail} option @b{MUST} be passed. The
199 @code{--safe} option will prevent inline Scheme code from wreaking
206 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
211 The @code{--safe} option works by evaluating in-line Scheme
212 expressions in a special safe module. This safe module is derived from
213 GUILE @file{safe-r5rs} module, but adds a number of functions of the
214 LilyPond API. These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
216 In addition, @code{--safe} disallows @code{\include} directives and
217 disables the use of backslashes in @TeX{} strings.
219 In @code{--safe} mode, it is not possible to import LilyPond variables
222 @code{--safe} does @emph{not} detect resource overuse. It is still
223 possible to make the program hang indefinitely, for example by feeding
224 cyclic data structures into the backend. Therefore, if using LilyPond
225 on a publicly accessible webserver, the process should be limited in
226 both CPU and memory usage.
228 Note that @code{--safe} will prevent many useful LilyPond snippets from
229 being compiled. For a softer but secure alternative you can use the
230 @code{--jail} option.
233 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
234 Run LilyPond in a chroot jail.
236 The @code{--jail} option provides a more flexible alternative to
237 @code{--safe} when LilyPond formatting is available through a web
238 server or whenever LilyPond executes externally provided
241 The @code{--jail} option works by changing the root of LilyPond to
242 @var{jail} just before starting the actual compilation process. The user
243 and group are then changed to match those provided, and the current
244 directory is changed to @var{dir}. This setup guarantees that it is not
245 possible (at least in theory) to escape from the jail. Note that for
246 @code{--jail} to work LilyPond must be run as root, which is usually
247 accomplished in a safe way using @command{sudo}.
249 Setting up a jail is a slightly delicate matter, as we must be sure that
250 LilyPond is able to find whatever it needs to compile the source
251 @emph{inside the jail}. A typical setup comprises the following items:
254 @item Setting up a separate filesystem
255 A separate filesystem should be created for LilyPond, so that it can be
256 mounted with safe options such as @code{noexec}, @code{nodev}, and
257 @code{nosuid}. In this way, it is impossible to run executables or to
258 write directly to a device from LilyPond. If you do not want to create a
259 separate partition, just create a file of reasonable size and use it to
260 mount a loop device. A separate filesystem also guarantees that LilyPond
261 cannot write more space than it is allowed.
263 @item Setting up a separate user
264 A separate user and group (say, @samp{lily}/@samp{lily}) with low
265 privileges should be used to run LilyPond inside the jail. There should
266 be a single directory writable by this user, which should be passed in
269 @item Preparing the jail
270 LilyPond needs to read a number of files while running. All these files
271 are to be copied into the jail, under the same path they appear in the
272 real root filesystem. The entire content of the LilyPond installation
273 (e.g., @file{/usr/share/lilypond})
276 If problems arise, the simplest way to trace them down is to run
277 LilyPond using @command{strace}, which will allow you to determine which
280 @item Running LilyPond
281 In a jail mounted with @code{noexec} it is impossible to execute any external
282 program. Therefore LilyPond must be run with a backend that does not
283 require any such program. As we already mentioned, it must be also run
284 with superuser privileges (which, of course, it will lose immediately),
285 possibly using @command{sudo}. It is a good idea to limit the number of
286 seconds of CPU time LilyPond can use (e.g., using @command{ulimit
287 -t}), and, if your operating system supports it, the amount of memory
288 that can be allocated.
293 Show version information.
296 Be verbose: show full paths of all files read, and give timing
300 Show the warranty with which GNU LilyPond comes. (It comes with
301 @strong{NO WARRANTY}!)
305 @subsection Environment variables
309 @cindex LILYPONDPREFIX
311 @code{Lilypond} recognizes the following environment variables:
314 This specifies a directory where locale messages and
315 data files will be looked up by default. The directory should contain
316 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
319 This selects the language for the warning messages.
321 @item LILYPOND_GC_YIELD
322 With this variable the memory footprint and performance can be
323 adjusted. It is a percentage tunes memory management behavior. With
324 higher values, the program uses more memory, with smaller values, it
325 uses more CPU time. The default value is @code{70}.
330 @node Notes for the MacOS X app
331 @section Notes for the MacOS X app
333 The scripts (such as lilypond-book, convert-ly, abc2ly, etc.) are also
334 included inside MacOS X .app. They can be run from the command line by
335 invoking them directly, e.g.
338 @var{path/to}/LilyPond.app/Contents/Resources/bin/convert-ly
341 Alternatively, you may add this directory to your path. Modify (or create)
342 a file called @code{.profile} in your home directory such that it contains
345 export PATH=$PATH:@var{path/to}/LilyPond.app/Contents/Resources/bin
349 This file should end with a blank line.
351 Note that @var{path/to} will generally be @code{/Applications/}.
354 @node Updating files with convert-ly
355 @section Updating with @command{convert-ly}
357 @cindex Updating a LilyPond file
360 The LilyPond input syntax is routinely changed to simplify it or improve
361 it in different ways. As a side effect of this, the LilyPond interpreter
362 often is no longer compatible with older input files. To remedy this,
363 the program @command{convert-ly} can be used to deal with most of the
364 syntax changes between LilyPond versions.
366 It uses @code{\version} statements in the input files to detect the
367 old version number. In most cases, to upgrade your input file it is
368 sufficient to run@footnote{MacOS X users may execute this command
369 under the menu entry @samp{Compile > Update syntax}.}
372 convert-ly -e myfile.ly
375 If there are no changes to myfile.ly and file called myfile.ly.NEW
376 is created, then myfile.ly is already updated.
378 @command{convert-ly} always converts up to the last syntax change handled by
379 it. This means that the @code{\version} number left in the file is
380 usually lower than the version of @command{convert-ly} itself.
382 To upgrade LilyPond fragments in texinfo files, use
385 convert-ly --from=... --to=... --no-version *.itely
388 To upgrade many files at once, combine @code{convert-ly} with
389 standard unix commands. This example will upgrade all @code{.ly}
390 files in the current directory
393 for f in *.ly; do convert-ly -e $f; done;
396 In general, the program is invoked as follows:
399 convert-ly [@var{option}]@dots{} @var{file}@dots{}
403 The following options can be given:
407 Do an inline edit of the input file. Overrides @code{--output}.
409 @item -f,--from=@var{from-patchlevel}
410 Set the version to convert from. If this is not set, @command{convert-ly}
411 will guess this, on the basis of @code{\version} strings in the file.
413 @item -n,--no-version
414 Normally, @command{convert-ly} adds a @code{\version} indicator
415 to the output. Specifying this option suppresses this.
417 @item -s, --show-rules
418 Show all known conversions and exit.
420 @item --to=@var{to-patchlevel}
421 Set the goal version of the conversion. It defaults to the latest
431 Not all language changes are handled. Only one output option can be
435 @c We might want to make this a completely new section, along with more
436 @c info about how to upgrade old input files. -gp
439 Copy and paste from CVS, last updated
442 http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/lilypond/lily-bugs/bugs/
443 convert-ly.txt?rev=HEAD&content-type=text/plain
445 NEW: not exactly copied; this list has been modified. Since we're
446 changing the bug system, it doesn't make sense to copy from
447 the bug CVS any more. I'll figure out something else. -gp
451 There are a few things that the convert-ly cannot handle. Here's a list of
453 that the community has complained about.
455 This bug report structure has been chosen because convert-ly has a structure
457 allow to smoothly implement all needed changes. Thus this is just a wishlist,
462 Doesn't always convert figured bass correctly, specifically things like {<
463 >}. Mats' comment on working around this:
464 To be able to run convert-ly
465 on it, I first replaced all occurencies of '{<' to some dummy like '{#'
466 and similarly I replaced '>}' with '&}'. After the conversion, I could
467 then change back from '{ #' to '{ <' and from '& }' to '> }'.
468 Doesn't convert all text markup correctly. In the old markup syntax,
469 it was possible to group a number of markup commands together within
471 -#'((bold italic) "string")
472 This will incorrectly be converted into
473 -\markup{{\bold italic} "string"}
474 instead of the correct
475 -\markup{\bold \italic "string"}
477 Doesn't handle \partcombine
478 Doesn't do \addlyrics => \lyricsto, this breaks some scores with multiple
481 \magnify isn't changed to \fontsize.
482 - \magnify #m => \fontsize #f, where f = 6ln(m)/ln(2)
483 remove-tag isn't changed.
484 - \applyMusic #(remove-tag '. . .) => \keepWithTag #'. . .
485 first-page-number isn't changed.
486 - first-page-number no => printfirst-page-number = ##f
487 Line breaks in header strings aren't converted.
488 - \\\\ as line break in \header strings => \markup \center-align <
489 "First Line" "Second Line" >
490 Crescendo and decrescendo terminators aren't converted.
494 \turnOff (used in \set Staff.VoltaBracket = \turnOff) is not properly
497 \markup{ \center-align <{ ... }> } should be converted to:
498 \markup{ \center-align {\line { ... }} }
499 but now, \line is missing.
501 Special LaTeX characters such as $~$ in text are not converted to UTF8.
503 \score{} must now begin with a music expression. Anything else
504 (particularly \header{}) must come after the music.
509 @section Reporting bugs
512 @cindex reporting bugs
514 If you have input that results in a crash or an erroneous output, then
515 that is a bug. We try to respond to bug-reports promptly, and fix them as
516 soon as possible. Help us by sending a defective input file, so we can
517 reproduce the problem. Send the report via:
520 @uref{http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs}
526 @item Try to produce a very small input file which demonstrates the problem;
527 one or two bars is often sufficient to reproduce a bug. The smaller the
528 input file is, the easier it is for us to debug the problem.
530 @item Don't forget to tell which version of LilyPond you use!
532 @item If possible, use @code{ragged-right} in your example. This makes sure
533 that the bug can be reproduced in all paper sizes.
537 @c the bug database is not up to date enough.
539 When you've found a bug, have a look at our
540 @uref{http://@/lilypond@/.org/@/bugs/@/v2.8/@/,bug database} to see if
541 it has already been reported. You could also try to do a few searches
542 on the mailing list for the bug. Sometimes the bug will have already
543 been reported and a fix or workaround is already known.
546 Here is an example of a good bug report:
549 It seems that placement of accidentals is broken. In the
550 following example, the accidental touches the note head.
552 Using Mac OSX 10.3.7, lilypond 2.7.32
555 \layout { ragged-right = ##t }
562 \layout { ragged-right = ##t }
564 \override Accidental #'extra-offset = #'(1.0 . 0)
570 @section Error messages
572 @cindex error messages
573 Different error messages can appear while compiling a file:
579 Something looks suspect. If you are requesting something out of the
580 ordinary then you will understand the message, and can ignore it.
581 However, warnings usually indicate that something is wrong with the
585 Something is definitely wrong. The current processing step (parsing,
586 interpreting, or formatting) will be finished, but the next step will
592 Something is definitely wrong, and LilyPond cannot continue. This
593 happens rarely. The most usual cause is misinstalled fonts.
595 @cindex trace, Scheme
599 Errors that occur while executing Scheme code are caught by the Scheme
600 interpreter. If running with the verbose option (@code{-V} or
601 @code{--verbose}) then a call trace of the offending
602 function call is printed.
604 @cindex Programming error
605 @item Programming error
606 There was some internal inconsistency. These error messages are
607 intended to help the programmers and debuggers. Usually, they can be
608 ignored. Sometimes, they come in such big quantities that they obscure
609 other output. In this case, file a bug-report.
611 @item Aborted (core dumped)
612 This signals a serious programming error that caused the program to
613 crash. Such errors are considered critical. If you stumble on one,
619 @cindex errors, message format
620 If warnings and errors can
621 be linked to some part of the input file, then error messages have the
625 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
626 @var{offending input line}
629 A line-break is inserted in the offending line to indicate the column
630 where the error was found. For example,
633 test.ly:2:19: error: not a duration: 5:
638 These locations are LilyPond's best guess about where the warning or
639 error occurred, but (by their very nature) warnings and errors occur
640 when something unexpected happens. If you can't see an error in the
641 indicated line of your input file, try checking one or two lines
642 above the indicated position.
646 @section Editor support
651 @cindex modes, editor
652 @cindex syntax coloring
653 @cindex coloring, syntax
655 There is support from different editors for LilyPond.
659 Emacs has a @file{lilypond-mode}, which provides keyword
660 autocompletion, indentation, LilyPond specific parenthesis matching
661 and syntax coloring, handy compile short-cuts and reading LilyPond
662 manuals using Info. If @file{lilypond-mode} is not installed on your
663 platform, then read the
665 @uref{source/Documentation/topdocs/INSTALL.html,installation instructions}.
668 installation instructions.
673 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along
674 with syntax coloring tools. For more information, refer to the
676 @uref{source/Documentation/topdocs/INSTALL.html,installation instructions}.
679 installation instructions.
685 The @uref{http://@/www@/.jedit@/.org@/,jEdit} editor has a LilyPond plugin.
686 This plugin includes a DVI viewer, integrated help and viewing via
687 GhostScript. It can be installed by doing @key{Plugins > Plugin
688 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
692 All these editors can be made to jump into the input file to the source
693 of a symbol in the graphical output. See @ref{Point and click}.
696 @node Point and click
697 @section Point and click
698 @cindex point and click
701 Point and click lets you find notes in the input by clicking on them
702 in the PDF viewer. This makes it easier to find input that causes
703 some error in the sheet music.
705 When this functionality is active, LilyPond adds hyperlinks to the PDF
706 file. These hyperlinks are sent to the web-browser, which opens a
707 text-editor with the cursor in the right place.
709 To make this chain work, you should configure your PDF viewer to
710 follow hyperlinks using the @file{lilypond-invoke-editor} script
711 supplied with LilyPond.
713 For Xpdf on Unix, the following should be present in
714 @file{xpdfrc}@footnote{On unix, this file is found either in
715 @file{/etc/xpdfrc} or as @file{.xpdfrc} in your home directory.}
718 urlCommand "lilypond-invoke-editor %s"
721 The program @file{lilypond-invoke-editor} is a small helper
722 program. It will invoke an editor for the special @code{textedit}
723 URIs, and run a web browser for others. It tests the environment
724 variable @code{EDITOR} for the following patterns,
730 emacsclient --no-wait +@var{line}:@var{column} @var{file}
735 gvim --remote +:@var{line}:norm@var{char} @var{file}
741 nc -noask +@var{line} @var{file}'
745 The environment variable @code{LYEDITOR} is used to override this. It
746 contains the command line to start the editor, where @code{%(file)s},
747 @code{%(column)s}, @code{%(line)s} is replaced with the file, column
748 and line respectively. The setting
751 emacsclient --no-wait +%(line)s:%(column)s %(file)s
755 for @code{LYEDITOR} is equivalent to the standard emacsclient
759 @cindex file size, output
761 The point and click links enlarge the output files significantly. For
762 reducing the size of PDF and PS files, point and click may be switched
766 #(ly:set-option 'point-and-click #f)
770 in a @file{.ly} file. Alternately, you may pass this as an command-line
774 lilypond -dno-point-and-click file.ly