1 @c -*- coding: utf-8; mode: texinfo; -*-
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. For details, see the Contributors'
8 Guide, node Updating translation committishes..
14 @node Running lilypond
15 @chapter Running @command{lilypond}
17 This chapter details the technicalities of running LilyPond.
21 * Command-line usage::
30 Most users run LilyPond through a GUI; if you have not done so
31 already, please read the @rlearning{Tutorial}. If you use an alternate
32 editor to write lilypond files, see the documentation for that
36 @node Command-line usage
37 @section Command-line usage
39 This section contains extra information about using LilyPond on the
40 command-line. This may be desirable to pass extra options to the
41 program. In addition, there are certain extra @q{helper} programs (such
42 as @code{midi2ly}) which are only available on the command-line.
44 By @q{command-line}, we mean the command line in the operating system.
45 Windows users might be more familiar with the terms @q{DOS shell} or
46 @q{command shell}. MacOS@tie{}X users might be more familiar with the terms
47 @q{terminal} or @q{console}. Some additional setup is required
48 for MacOS@tie{}X users; please see @rweb{MacOS X}.
50 Describing how to use this part of an operating system is outside the
51 scope of this manual; please consult other documentation on this topic
52 if you are unfamiliar with the command-line.
56 * Basic command line options for LilyPond::
57 * Advanced command line options for LilyPond::
58 * Environment variables::
59 * LilyPond in chroot jail::
62 @node Invoking LilyPond
63 @unnumberedsubsec Invoking @command{lilypond}
65 The @command{lilypond} executable may be called as follows from
69 lilypond [@var{option}]@dots{} @var{file}@dots{}
72 When invoked with a filename that has no extension, the @file{.ly}
73 extension is tried first. To read input from stdin, use a
74 dash (@code{-}) for @var{file}.
76 When @file{filename.ly} is processed it will produce @file{filename.ps}
77 and @file{filename.pdf} as output. Several files can be specified;
78 they will each be processed independently. @footnote{The status of
79 GUILE is not reset after processing a @code{.ly} file, so be careful
80 not to change any system defaults from within Scheme.}
82 If @file{filename.ly} contains more than one @code{\book}
83 block, then the rest of the scores will be output in numbered files,
84 starting with @file{filename-1.pdf}. In addition, the value of
85 @code{output-suffix} will be inserted between the basename and the
86 number. An input file containing
89 #(define output-suffix "violin")
91 #(define output-suffix "cello")
96 will output @var{base}@file{-violin.pdf} and
97 @var{base}@file{-cello-1.pdf}.
100 @unnumberedsubsubsec Using LilyPond with standard shell features
102 Since LilyPond is a command line application, features of the @q{shell}
103 used for calling LilyPond can also be put to good use.
112 will process all LilyPond files in the current directory.
114 Redirecting the console output (e.g. to a file) may also be useful:
117 lilypond file.ly 1> stdout.txt
119 lilypond file.ly 2> stderr.txt
121 lilypond file.ly &> all.txt
125 Redirects @q{normal} output, @q{errors} only or @q{everything},
126 respectively, to a text file. Consult the documentation for your
127 particular shell, Command (Windows), Terminal or Console
128 applications (MacOS X) to see if output redirection is supported or if
129 the syntax is different.
131 The following example searches and converts all input files in the
132 current directory and all directories below it recursively. The output
133 files will be located in the same directory that the command was run in,
134 rather than in the same directories as the original input files.
137 find . -name '*.ly' -exec lilypond '@{@}' \;
141 This should also work for MacOS@tie{}X users.
143 A Windows user would run;
146 forfiles /s /M *.ly /c "cmd /c lilypond @@file"
150 entering these commands in a @code{command prompt} usually found under
151 @code{Start > Accessories > Command Prompt} or for version 8 users,
152 by typing in the search window @q{command prompt}.
154 Alternatively, an explicit path to the top-level of your folder
155 containing all the sub-folders that have input files in them can be
156 stated using the @code{/p} option;
159 forfiles /s /p C:\Documents\MyScores /M *.ly /c "cmd /c lilypond @@file"
162 If there are spaces in the path to the top-level folder, then the whole
163 path needs to be inside double quotes;
166 forfiles /s /p "C:\Documents\My Scores" /M *.ly /c "cmd /c lilypond @@file"
170 @node Basic command line options for LilyPond
171 @unnumberedsubsec Basic command line options for LilyPond
173 @cindex Invoking @command{lilypond}
174 @cindex command line options for @command{lilypond}
175 @cindex options, command line
178 The following options are supported:
182 @item -d, --define-default=@var{var}=@var{val}
183 See @ref{Advanced command line options for LilyPond}.
185 @cindex Scheme, expression evaluation
186 @cindex expression evaluation, Scheme
188 @item -e, --evaluate=@var{expr}
189 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
190 Multiple @option{-e} options may be given, they will be evaluated
193 The expression will be evaluated in the @code{guile-user} module, so
194 if you want to use definitions in @var{expr}, use
197 lilypond -e '(define-public a 42)'
201 on the command-line, and include
204 #(use-modules (guile-user))
208 at the top of the @code{.ly} file.
210 @warning{Windows users must use double quotes instead of single quotes.}
212 @cindex output, format
213 @cindex format, output
215 @item -f, --format=@var{format}
216 which formats should be written. Choices for @code{format} are
217 @code{ps}, @code{pdf}, and @code{png}.
219 Example: @code{lilypond -fpng @var{filename}.ly}
222 Show a summary of usage.
224 @item -H, --header=@var{FIELD}
225 Dump a header field to file @file{BASENAME.@var{FIELD}}.
227 @item -i, --init=@var{file}
228 Set init file to @var{file} (default: @file{init.ly}).
230 @cindex file searching
233 @item -I, --include=@var{directory}
234 Add @var{directory} to the search path for input files.
236 Multiple -I options may be given. The search will start in the first
237 defined directory, and if the file to be included is not found the
238 search will continue in subsequent directories.
240 @cindex chroot jail, running inside
242 @item -j, --jail=@var{user},@var{group},@var{jail},@var{dir}
243 Run @command{lilypond} in a chroot jail.
245 The @option{--jail} option provides a more flexible alternative to
246 @option{-dsafe}, when LilyPond formatting is being provided via a web
247 server, or whenever LilyPond executes commands sent by external sources
248 (see @ref{Advanced command line options for LilyPond}).
250 It works by changing the root of @command{lilypond} to @var{jail} just
251 before starting the actual compilation process. The user and group are
252 then changed to match those provided, and the current directory is
253 changed to @var{dir}. This setup guarantees that it is not possible (at
254 least in theory) to escape from the jail. Note that for @option{--jail}
255 to work, @command{lilypond} must be run as root, which is usually
256 accomplished in a safe way using @command{sudo}.
258 Setting up a jail can be a relatively complex matter, as we must be sure
259 that LilyPond is able to find whatever it needs to compile the source
260 @emph{inside} the jail itself. A typical chroot jail will comprise the
265 @item Setting up a separate filesystem
266 A separate filesystem should be created for LilyPond, so that it can be
267 mounted with safe options such as @code{noexec}, @code{nodev}, and
268 @code{nosuid}. In this way, it is impossible to run executables or to
269 write directly to a device from LilyPond. If you do not want to create a
270 separate partition, just create a file of reasonable size and use it to
271 mount a loop device. A separate filesystem also guarantees that LilyPond
272 cannot write more space than it is allowed.
274 @item Setting up a separate user
275 A separate user and group (say, @code{lily}/@code{lily}) with low
276 privileges should be used to run LilyPond inside the jail. There should
277 be a single directory writable by this user, which should be passed in
280 @item Preparing the jail
281 LilyPond needs to read a number of files while running. All these files
282 are to be copied into the jail, under the same path they appear in the
283 real root filesystem. The entire content of the LilyPond installation
284 (e.g., @file{/usr/share/lilypond}) should be copied.
286 If problems arise, the simplest way to trace them down is to run
287 LilyPond using @command{strace}, which will allow you to determine which
290 @item Running LilyPond
291 In a jail mounted with @code{noexec} it is impossible to execute any
292 external program. Therefore LilyPond must be run with a backend that
293 does not require any such program. As we have already mentioned, it
294 must be run with superuser privileges (which, of course, it will lose
295 immediately), possibly using @command{sudo}. It is also good practice
296 to limit the number of seconds of CPU time LilyPond can use (e.g., using
297 @command{ulimit@tie{}-t}), and, if your operating system supports it,
298 the amount of memory that can be allocated. Also see
299 @ref{LilyPond in chroot jail}.
303 @cindex output, verbosity
305 @item -l, --loglevel=@var{LEVEL}
306 Set the verbosity of the console output to @var{LEVEL}. Possible values
312 No output at all, not even error messages.
315 Only error messages, no warnings or progress messages.
318 Warnings and error messages, no progress.
321 Basic progress messages (success), warnings and errors.
324 All progress messages, warnings and errors.
327 Progress messages, warnings, errors and further execution information.
330 All possible messages, including verbose debug output.
334 @cindex directory, redirect output
335 @cindex output, setting filename
336 @cindex output, directory
338 @item -o, --output=@var{FILE} or @var{FOLDER}
339 Set the default output file to @var{FILE} or, if a folder with that name
340 exists, direct the output to @var{FOLDER}, taking the file name from the
341 input file. The appropriate suffix will be added (e.g. @code{.pdf} for
344 @cindex PS (Postscript), output
345 @cindex Postscript (PS), output
346 @cindex output, PS (Postscript)
351 @cindex PNG (Portable Network Graphics), output
352 @cindex output, PNG (Portable Network Graphics)
355 Generate pictures of each page, in PNG format. This implies
356 @option{--ps}. The resolution in DPI of the image may be set with
361 @cindex PDF (Portable Document Format), output
362 @cindex output, PDF (Portable Document Format)
365 Generate PDF. This implies @option{--ps}.
368 Show version information.
371 Be verbose: show full paths of all files read, and give timing
375 Show the warranty with which GNU LilyPond comes. (It comes with
376 @strong{NO WARRANTY}!)
381 @node Advanced command line options for LilyPond
382 @unnumberedsubsec Advanced command line options for LilyPond
386 @item -d@var{[option-name]}=@var{[value]},--define-default=@var{[option-name]}=@var{[value]}
387 This sets the equivalent internal Scheme function to @var{value}.
393 If a @var{value} is not supplied, then the default value is used. The
394 prefix @code{no-} may be added to @var{option-name} to switch @q{off} an
397 @cindex point and click, command line
410 @noindent The following are supported along with their respective
413 @multitable @columnfractions .33 .16 .51
414 @item @strong{Symbol}
416 @tab @strong{Explanation/Options}
418 @item @code{anti-alias-factor}
420 @tab Render at higher resolution (using given factor) and scale down
421 result to prevent @q{jaggies} in @code{PNG} images.
423 @item @code{aux-files}
425 @tab Create @code{.tex}, @code{.texi}, @code{.count} files in the
430 @tab Select backend. Postscript files (default) include @code{TTF},
431 @code{Type1} and @code{OTF} fonts. No subsetting of these fonts is
432 done. Using @q{oriental} character sets can lead to very large files.
436 @tab Encapsulated PostScript. This dumps every page (system) as a
437 separate @file{EPS} file, without fonts, and as one collated @file{EPS}
438 file with all pages (systems) including fonts. Used as default by
439 @command{lilypond-book}.
443 @tab Do not output a printed score; has the same effect as
444 @code{-dno-print-pages}.
448 @tab Scalable Vector Graphics. This creates a single SVG file,
449 without embedded fonts, for every page of output. It is recommended to
450 install the Century Schoolbook fonts, included with your LilyPond
451 installation, for optimal rendering. Under UNIX, simply copy these
452 fonts from the LilyPond directory (typically
453 @file{/usr/share/lilypond/VERSION/fonts/otf/}) to @file{~/.fonts/}.
454 There is also an option @code{svg-woff} (below) for use of woff font
455 files in the SVG backend.
459 @tab Dump of the raw, internal Scheme-based drawing commands.
461 @item @code{check-internal-types}
463 @tab Check every property assignment for types.
465 @item @code{clip-systems}
467 @tab Generate cut-out snippets of a score.
471 @tab Prefix for data files (read-only).
473 @item @code{debug-gc}
475 @tab Dump memory debugging statistics.
477 @item @code{debug-gc-assert-parsed-dead}
479 @tab For memory debugging: Ensure that all references to parsed objects
480 are dead. This is an internal option, and is switched on automatically
481 for @code{`-ddebug-gc'}.
483 @item @code{debug-lexer}
485 @tab Debug the flex lexer.
487 @item @code{debug-page-breaking-scoring}
489 @tab Dump scores for many different page breaking configurations.
491 @item @code{debug-parser}
493 @tab Debug the bison parser.
495 @item @code{debug-property-callbacks}
497 @tab Debug cyclic callback chains.
499 @item @code{debug-skylines}
503 @item @code{delete-intermediate-files}
505 @tab Delete the unusable, intermediate @code{.ps} files created during
508 @item @code{dump-cpu-profile}
510 @tab Dump timing information (system-dependent).
512 @item @code{dump-profile}
514 @tab Dump memory and time information for each file.
516 @item @code{dump-signatures}
518 @tab Dump output signatures of each system. Used for regression testing.
520 @item @code{eps-box-padding}
522 @tab Pad left edge of the output EPS bounding box by the given amount
525 @item @code{gs-load-fonts}
527 @tab Load fonts via Ghostscript.
529 @item @code{gs-load-lily-fonts}
531 @tab Load only the LilyPond fonts via Ghostscript.
535 @tab Runs silently and redirect all output to a log file.
539 @strong{Note to Windows users:} By default @code{lilypond.exe} outputs
540 all progress information to the command window,
541 @code{lilypond-windows.exe} does not and returns a prompt, with no
542 progress information, immediately at the command line. The
543 @option{-dgui} option can be used in this case to redirect output to a
546 @multitable @columnfractions .33 .16 .51
551 @item @code{include-book-title-preview}
553 @tab Include book titles in preview images.
555 @item @code{include-eps-fonts}
557 @tab Include fonts in separate-system EPS files.
559 @item @code{include-settings}
561 @tab Include file for global settings, this is included before the score
564 @item @code{job-count}
566 @tab Process in parallel, using the given number of jobs.
568 @item @code{log-file}
569 @tab @code{#f [file]}
570 @tab If string @code{FOO} is given as a second argument,
571 redirect output to the log file @code{FOO.log}.
573 @item @code{max-markup-depth}
575 @tab Maximum depth for the markup tree. If a markup has more levels,
576 assume it will not terminate on its own, print a warning and return a
579 @item @code{midi-extension}
581 @tab Set the default file extension for MIDI output file to given
584 @item @code{music-strings-to-paths}
586 @tab Convert text strings to paths when glyphs belong to a music font.
588 @item @code{paper-size}
590 @tab Set default paper size. Note the string must be enclosed in
591 escaped double quotes.
593 @item @code{pixmap-format}
595 @tab Set GhostScript's output format for pixel images.
597 @item @code{point-and-click}
599 @tab Add @q{point & click} links to PDF and SVG output.
600 See @ref{Point and click}.
604 @tab Create preview images in addition to normal output.
608 This option is supported by all backends; @code{pdf}, @code{png},
609 @code{ps}, @code{eps} and @code{svg}, but not @code{scm}. It generates
610 an output file, in the form @code{myFile.preview.extension}, containing
611 the titles and the first system of music. If @code{\book} or
612 @code{\bookpart} blocks are used, the titles of @code{\book},
613 @code{\bookpart} or @code{\score} will appear in the output, including
614 the first system of every @code{\score} block if the @code{\paper}
615 variable @code{print-all-headers} is set to @code{#t}.
617 To suppress the usual output, use the @option{-dprint-pages} or
618 @option{-dno-print-pages} options according to your requirements.
620 @multitable @columnfractions .33 .16 .51
621 @item @code{print-pages}
623 @tab Generate full pages, the default. @option{-dno-print-pages} is
624 useful in combination with @option{-dpreview}.
626 @item @code{profile-property-accesses}
628 @tab Keep statistics of @code{get_property()} function calls.
630 @item @code{protected-scheme-parsing}
632 @tab Continue when errors in inline scheme are caught in the parser. If
633 set to @code{#f}, halt on errors and print a stack trace.
635 @item @code{read-file-list}
636 @tab @code{#f [file]}
637 @tab Specify name of a file which contains a list of input files to be
640 @item @code{relative-includes}
642 @tab When processing an @code{\include} command, look for the included
643 file relative to the current file (instead of the root file).
645 @item @code{resolution}
647 @tab Set resolution for generating @code{PNG} pixmaps to given value (in
652 @tab Do not trust the @code{.ly} input.
656 When LilyPond formatting is available through a web server, either the
657 @option{--safe} or the @option{--jail} option @b{MUST} be passed. The
658 @option{--safe} option will prevent inline Scheme code from wreaking
663 #(s ystem "rm -rf /") % too dangerous to write correctly
665 c4^$(ly:gulp-file "/etc/passwd") % malicious but not destructive
670 The @option{-dsafe} option works by evaluating in-line Scheme
671 expressions in a special safe module. This is derived from GUILE
672 @file{safe-r5rs} module, but also adds a number of functions of the
673 LilyPond API which are listed in @file{scm/safe-lily.scm}.
675 In addition, safe mode disallows @code{\include} directives and
676 disables the use of backslashes in @TeX{} strings. It is also not
677 possible to import LilyPond variables into Scheme while in safe mode.
679 @option{-dsafe} does @emph{not} detect resource overuse, so it is still
680 possible to make the program hang indefinitely, for example by feeding
681 cyclic data structures into the backend. Therefore, if using LilyPond
682 on a publicly accessible webserver, the process should be limited in
683 both CPU and memory usage.
685 Safe mode will prevent many useful LilyPond snippets from being
688 The @option{--jail} is an even more secure alternative, but requires
689 more work to set up. See @ref{Basic command line options for LilyPond}.
691 @multitable @columnfractions .33 .16 .51
692 @item @code{separate-log-files}
694 @tab For input files @code{FILE1.ly}, @code{FILE2.ly}, etc. output log
695 data to files @code{FILE1.log}, @code{FILE2.log}@dots{}
697 @item @code{show-available-fonts}
699 @tab List available font names.
701 @item @code{strict-infinity-checking}
703 @tab Force a crash on encountering @code{Inf} and @code{NaN} floating
706 @item @code{strip-output-dir}
708 @tab Don't use directories from input files while constructing output
711 @item @code{strokeadjust}
713 @tab Force PostScript stroke adjustment. This option is mostly
714 relevant when a PDF is generated from PostScript output (stroke
715 adjustment is usually enabled automatically for low-resolution bitmap
716 devices). Without this option, PDF previewers tend to produce widely
717 inconsistent stem widths at resolutions typical for screen display. The
718 option does not noticeably affect print quality and causes large file
719 size increases in PDF files.
721 @item @code{svg-woff}
723 @tab Use woff font files in SVG backend.
725 @item @code{trace-memory-frequency}
727 @tab Record Scheme cell usage this many times per second. Dump the
728 results to @code{FILE.stacks} and @code{FILE.graph}.
730 @item @code{trace-scheme-coverage}
732 @tab Record coverage of Scheme files in @code{FILE.cov}.
736 @tab Verbose output, i.e. loglevel at DEBUG (read-only).
738 @item @code{warning-as-error}
740 @tab Change all warning and @q{programming error} messages into errors.
744 @node Environment variables
745 @unnumberedsubsec Environment variables
748 @cindex LILYPOND_DATADIR
750 @command{lilypond} recognizes the following environment variables:
752 @item LILYPOND_DATADIR
753 This specifies a directory where locale messages and
754 data files will be looked up by default. The directory should contain
755 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
758 This selects the language for the warning messages.
760 @item LILYPOND_LOGLEVEL
761 The default loglevel. If LilyPond is called without an explicit loglevel
762 (i.e. no @option{--loglevel} command line option), this value is used.
764 @item LILYPOND_GC_YIELD
765 A variable, as a percentage, that tunes memory management
766 behavior. A higher values means the program uses more memory, a
767 smaller value means more CPU time is used. The default value is
773 @node LilyPond in chroot jail
774 @unnumberedsubsec LilyPond in chroot jail
776 Setting up the server to run LilyPond in a chroot jail is a complicated
777 task. The steps are listed below. Examples in the steps are from
778 Ubuntu GNU/Linux, and may require the use of @code{sudo} as appropriate.
782 @item Install the necessary packages: LilyPond, GhostScript, and ImageMagick.
784 @item Create a new user by the name of @code{lily}:
791 This will create a new group for the @code{lily} user as well, and a
792 home folder, @code{/home/lily}
794 @item In the home folder of the @code{lily} user create a file to use as a
798 dd if=/dev/zero of=/home/lily/loopfile bs=1k count= 200000
802 This example creates a 200MB file for use as the jail filesystem.
804 @item Create a loop device, make a file system and mount it, then create
805 a folder that can be written by the @code{lily} user:
809 losetup /dev/loop0 /home/lily/loopfile
810 mkfs -t ext3 /dev/loop0 200000
811 mount -t ext3 /dev/loop0 /mnt/lilyloop
812 mkdir /mnt/lilyloop/lilyhome
813 chown lily /mnt/lilyloop/lilyhome
816 @item In the configuration of the servers, the JAIL will be @code{/mnt/lilyloop}
817 and the DIR will be @code{/lilyhome}.
819 @item Create a big directory tree in the jail by copying the necessary files, as
820 shown in the sample script below.
822 You can use @code{sed} to create the necessary copy commands for a given
826 for i in "/usr/local/lilypond/usr/bin/lilypond" "/bin/sh" "/usr/bin/; \
827 do ldd $i | sed 's/.*=> \/\(.*\/\)\([^(]*\).*/mkdir -p \1 \&\& \
828 cp -L \/\1\2 \1\2/' | sed 's/\t\/\(.*\/\)\(.*\) (.*)$/mkdir -p \
829 \1 \&\& cp -L \/\1\2 \1\2/' | sed '/.*=>.*/d'; done
834 @subheading Example script for 32-bit Ubuntu 8.04
842 loopdevice=/dev/loop0
843 jaildir=/mnt/lilyloop
844 # the prefix (without the leading slash!)
846 # the directory where lilypond is installed on the system
847 lilydir=/$lilyprefix/lilypond/
849 userhome=$home/$username
850 loopfile=$userhome/loopfile
852 dd if=/dev/zero of=$loopfile bs=1k count=200000
854 losetup $loopdevice $loopfile
855 mkfs -t ext3 $loopdevice 200000
856 mount -t ext3 $loopdevice $jaildir
857 mkdir $jaildir/lilyhome
858 chown $username $jaildir/lilyhome
861 mkdir -p bin usr/bin usr/share usr/lib usr/share/fonts $lilyprefix tmp
864 cp -r -L $lilydir $lilyprefix
865 cp -L /bin/sh /bin/rm bin
866 cp -L /usr/bin/convert /usr/bin/gs usr/bin
867 cp -L /usr/share/fonts/truetype usr/share/fonts
869 # Now the library copying magic
870 for i in "$lilydir/usr/bin/lilypond" "$lilydir/usr/bin/guile" "/bin/sh" \
871 "/bin/rm" "/usr/bin/gs" "/usr/bin/convert"; do ldd $i | sed 's/.*=> \
872 \/\(.*\/\)\([^(]*\).*/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/' | sed \
873 's/\t\/\(.*\/\)\(.*\) (.*)$/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/' \
874 | sed '/.*=>.*/d'; done | sh -s
876 # The shared files for ghostscript...
877 cp -L -r /usr/share/ghostscript usr/share
878 # The shared files for ImageMagick
879 cp -L -r /usr/lib/ImageMagick* usr/lib
881 ### Now, assuming that you have test.ly in /mnt/lilyloop/lilyhome,
882 ### you should be able to run:
883 ### Note that /$lilyprefix/bin/lilypond is a script, which sets the
884 ### LD_LIBRARY_PATH - this is crucial
885 /$lilyprefix/bin/lilypond -jlily,lily,/mnt/lilyloop,/lilyhome test.ly
888 @c " keep quote signs balanced for context-sensitive editors
891 @section Error messages
893 @cindex error messages
894 Different error messages can appear while compiling a file:
900 Something looks suspect. If you are requesting something out of the
901 ordinary then you will understand the message, and can ignore it.
902 However, warnings usually indicate that something is wrong with the
907 Something is definitely wrong. The current processing step (parsing,
908 interpreting, or formatting) will be finished, but the next step will
913 Something is definitely wrong, and LilyPond cannot continue. This
914 happens rarely. The most usual cause is misinstalled fonts.
917 @cindex trace, Scheme
920 Errors that occur while executing Scheme code are caught by the Scheme
921 interpreter. If running with the verbose option (@option{-V} or
922 @option{--verbose}) then a call trace of the offending
923 function call is printed.
925 @item Programming error
926 @cindex Programming error
927 There was some internal inconsistency. These error messages are
928 intended to help the programmers and debuggers. Usually, they can be
929 ignored. Sometimes, they come in such big quantities that they obscure
932 @item Aborted (core dumped)
933 @cindex Aborted (core dumped)
934 This signals a serious programming error that caused the program to
935 crash. Such errors are considered critical. If you stumble on one,
939 @cindex errors, message format
940 If warnings and errors can be linked to some part of the input file,
941 then error messages have the following form
944 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
945 @var{offending input line}
948 A line-break is inserted in the offending line to indicate the column
949 where the error was found. For example,
952 test.ly:2:19: error: not a duration: 5
957 These locations are LilyPond's best guess about where the warning or
958 error occurred, but (by their very nature) warnings and errors occur
959 when something unexpected happens. If you can't see an error in the
960 indicated line of your input file, try checking one or two lines
961 above the indicated position.
963 Please note that diagnostics can be triggered at any point during the
964 many stages of processing. For example if there are parts of the input
965 that are processed multiple times (i.e. in midi and layout output), or
966 if the same music variable is used in multiple contexts the same message
967 may appear several times. Diagnostics produced at a @q{late} stage (i.e
968 bar checks) might also be issued multiple times.
970 More information about errors is given in @ref{Common errors}.
974 @section Common errors
976 The error conditions described below occur often, yet the cause
977 is not obvious or easily found. Once seen and understood, they
982 * Music runs off the page::
983 * An extra staff appears::
984 * Error message Unbound variable %::
985 * Error message FT_Get_Glyph_Name::
986 * Warning staff affinities should only decrease::
987 * Error message unexpected new::
988 * Warning ignoring too many clashing note columns::
991 @node Music runs off the page
992 @unnumberedsubsec Music runs off the page
994 Music running off the page over the right margin or appearing
995 unduly compressed is almost always due to entering an incorrect
996 duration on a note, causing the final note in a measure to extend
997 over the bar line. It is not invalid if the final note in a
998 measure does not end on the automatically entered bar line, as the
999 note is simply assumed to carry over into the next measure. But
1000 if a long sequence of such carry-over measures occurs the music
1001 can appear compressed or may flow off the page because automatic
1002 line breaks can be inserted only at the end of complete measures,
1003 i.e., where all notes end before or at the end of the measure.
1005 @warning{An incorrect duration can cause line breaks to be
1006 inhibited, leading to a line of highly compressed music or
1007 music which flows off the page.}
1009 The incorrect duration can be found easily if bar checks are used,
1010 see @ruser{Bar and bar number checks}.
1012 If you actually intend to have a series of such carry-over measures
1013 you will need to insert an invisible bar line where you want the
1014 line to break. For details, see @ruser{Bar lines}.
1017 @node An extra staff appears
1018 @unnumberedsubsec An extra staff appears
1020 If contexts are not created explicitly with @code{\new} or
1021 @code{\context}, they will be silently created as soon as a
1022 command is encountered which cannot be applied to an existing
1023 context. In simple scores the automatic creation of contexts is
1024 useful, and most of the examples in the LilyPond manuals take
1025 advantage of this simplification. But occasionally the silent
1026 creation of contexts can give rise to unexpected new staves or
1027 scores. For example, it might be expected that the following code
1028 would cause all note heads within the following staff to be
1029 colored red, but in fact it results in two staves with the note
1030 heads remaining the default black in the lower staff.
1032 @lilypond[quote,verbatim,relative=2]
1033 \override Staff.NoteHead.color = #red
1037 This is because a @code{Staff} context does not exist when the
1038 override is processed, so one is implicitly created and the override
1039 is applied to it, but then the @code{\new Staff} command creates
1040 another, separate, staff into which the notes are placed. The
1041 correct code to color all note heads red is
1043 @lilypond[quote,verbatim,relative=2]
1045 \override Staff.NoteHead.color = #red
1050 @node Error message Unbound variable %
1051 @unnumberedsubsec Error message Unbound variable %
1053 This error message will appear at the bottom of the console
1054 output or log file together with a @qq{GUILE signalled an error @dots{}}
1055 message every time a Scheme routine is called which (invalidly)
1056 contains a @emph{LilyPond} rather than a @emph{Scheme} comment.
1058 LilyPond comments begin with a percent sign, (@code{%}), and must
1059 not be used within Scheme routines. Scheme comments begin with a
1060 semi-colon, (@code{;}).
1062 @node Error message FT_Get_Glyph_Name
1063 @unnumberedsubsec Error message FT_Get_Glyph_Name
1065 This error messages appears in the console output or log file if
1066 an input file contains a non-ASCII character and was not saved in
1067 UTF-8 encoding. For details, see @ruser{Text encoding}.
1070 @node Warning staff affinities should only decrease
1071 @unnumberedsubsec Warning staff affinities should only decrease
1073 This warning can appear if there are no staves in the printed
1074 output, for example if there are just a @code{ChordName} context
1075 and a @code{Lyrics} context as in a lead sheet. The warning
1076 messages can be avoided by making one of the contexts behave as a
1080 \override VerticalAxisGroup.staff-affinity = ##f
1084 at its start. For details, see @qq{Spacing of non-staff lines} in
1085 @ruser{Flexible vertical spacing within systems}.
1088 @node Error message unexpected new
1089 @unnumberedsubsec Error message unexpected @code{@bs{}new}
1091 A @code{\score} block must contain a @emph{single} music expression.
1092 If instead it contains several @code{\new Staff},
1093 @code{\new StaffGroup} or similar contexts introduced with @code{\new}
1094 without them being enclosed in either curly brackets,
1095 @code{@{ @dots{} @}}, or double angle brackets, @code{<< @dots{} >>},
1100 % Invalid! Generates error: syntax error, unexpected \new
1101 \new Staff @{ @dots{} @}
1102 \new Staff @{ @dots{} @}
1107 the error message will be produced.
1109 To avoid the error, enclose all the @code{\new} statements in
1110 curly or double angle brackets.
1112 Using curly brackets will introduce the @code{\new} statements
1115 @lilypond[quote,verbatim]
1118 \new Staff { a' a' a' a' }
1119 \new Staff { g' g' g' g' }
1125 but more likely you should be using double angle brackets so the new
1126 staves are introduced in parallel, i.e. simultaneously:
1128 @lilypond[quote,verbatim]
1131 \new Staff { a' a' a' a' }
1132 \new Staff { g' g' g' g' }
1137 @node Warning ignoring too many clashing note columns
1138 @unnumberedsubsec Warning ignoring too many clashing note columns
1140 If notes from two different voices with stems in the same direction
1141 occur at the same musical moment, but the voices have no
1142 voice-specific shifts specified, the warning message
1143 @samp{warning: ignoring too many clashing note columns} will appear
1144 when compiling the LilyPond file. This warning will appear even when
1145 the notes have no visible stems, e.g. whole notes, if the stems for
1146 shorter notes at the same pitch would be in the same direction.
1148 Remember that the stem direction depends on the position of the
1149 note on the staff unless the stem direction is specified, for example
1150 by using @code{\voiceOne}, etc. In this case the warning will appear
1151 only when the stems happen to be in the same direction, i.e. when the
1152 notes are in the same half of the staff.
1154 By placing the notes in voices with stem directions and shifts
1155 specified, for example by using @code{\voiceOne}, etc., these warnings
1158 Notes in higher numbered voices, @code{\voiceThree} etc., are
1159 automatically shifted to avoid clashing note columns. This causes a
1160 visible shift for notes with stems, but whole notes are not visibly
1161 shifted unless an actual clash of the note heads occurs, or when the
1162 voices cross over from their natural order (when @code{\voiceThree}
1163 is higher than @code{\voiceOne}, etc.)
1166 @rlearning{Explicitly instantiating voices},
1167 @rlearning{Real music example},
1168 @ruser{Single-staff polyphony},
1169 @ruser{Collision resolution}.