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 processes 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:
185 PDF files generated will be much larger than normal (due to little or no
186 font optimization). However, if two or more PDF files are included
187 within @w{@code{pdftex}}, @w{@code{xetex}} or @w{@code{luatex}}
188 documents they can then be processed further via ghostscript (merging
189 duplicated font data) resulting in @emph{significantly} smaller PDF
196 Then run @code{ghostscript};
199 gs -q -sDEVICE=pdfwrite -o gsout.pdf myfile.pdf
202 @code{pdfsizeopt.py} can then be used to further optimize the size
206 pdfsizeopt.py --use-multivalent=no gsout.pdf final.pdf
210 @item -d, --define-default=@var{var}=@var{val}
211 See @ref{Advanced command line options for LilyPond}.
213 @cindex Scheme, expression evaluation
214 @cindex expression evaluation, Scheme
216 @item -e, --evaluate=@var{expr}
217 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
218 Multiple @option{-e} options may be given, they will be evaluated
221 The expression will be evaluated in the @code{guile-user} module, so
222 if you want to use definitions in @var{expr}, use
225 lilypond -e '(define-public a 42)'
229 on the command-line, and include
232 #(use-modules (guile-user))
236 at the top of the @code{.ly} file.
238 @warning{Windows users must use double quotes instead of single quotes.}
240 @cindex output, format
241 @cindex format, output
243 @item -f, --format=@var{format}
244 which formats should be written. Choices for @code{format} are
245 @code{ps}, @code{pdf}, and @code{png}.
247 Example: @code{lilypond -fpng @var{filename}.ly}
250 For @code{svg} and @code{eps} formats use the @code{-dbackend} option.
251 See @ref{Advanced command line options for LilyPond}.
254 Show a summary of usage.
256 @item -H, --header=@var{FIELD}
257 Dump a header field to file @file{BASENAME.@var{FIELD}}.
259 @item -i, --init=@var{file}
260 Set init file to @var{file} (default: @file{init.ly}).
262 @cindex file searching
265 @item -I, --include=@var{directory}
266 Add @var{directory} to the search path for input files.
268 Multiple -I options may be given. The search will start in the first
269 defined directory, and if the file to be included is not found the
270 search will continue in subsequent directories.
272 @cindex chroot jail, running inside
274 @item -j, --jail=@var{user},@var{group},@var{jail},@var{dir}
275 Run @command{lilypond} in a chroot jail.
277 The @option{--jail} option provides a more flexible alternative to
278 @option{-dsafe}, when LilyPond formatting is being provided via a web
279 server, or whenever LilyPond executes commands sent by external sources
280 (see @ref{Advanced command line options for LilyPond}).
282 It works by changing the root of @command{lilypond} to @var{jail} just
283 before starting the actual compilation process. The user and group are
284 then changed to match those provided, and the current directory is
285 changed to @var{dir}. This setup guarantees that it is not possible (at
286 least in theory) to escape from the jail. Note that for @option{--jail}
287 to work, @command{lilypond} must be run as root, which is usually
288 accomplished in a safe way using @command{sudo}.
290 Setting up a jail can be a relatively complex matter, as we must be sure
291 that LilyPond is able to find whatever it needs to compile the source
292 @emph{inside} the jail itself. A typical chroot jail will comprise the
297 @item Setting up a separate filesystem
298 A separate filesystem should be created for LilyPond, so that it can be
299 mounted with safe options such as @code{noexec}, @code{nodev}, and
300 @code{nosuid}. In this way, it is impossible to run executables or to
301 write directly to a device from LilyPond. If you do not want to create a
302 separate partition, just create a file of reasonable size and use it to
303 mount a loop device. A separate filesystem also guarantees that LilyPond
304 cannot write more space than it is allowed.
306 @item Setting up a separate user
307 A separate user and group (say, @code{lily}/@code{lily}) with low
308 privileges should be used to run LilyPond inside the jail. There should
309 be a single directory writable by this user, which should be passed in
312 @item Preparing the jail
313 LilyPond needs to read a number of files while running. All these files
314 are to be copied into the jail, under the same path they appear in the
315 real root filesystem. The entire content of the LilyPond installation
316 (e.g., @file{/usr/share/lilypond}) should be copied.
318 If problems arise, the simplest way to trace them down is to run
319 LilyPond using @command{strace}, which will allow you to determine which
322 @item Running LilyPond
323 In a jail mounted with @code{noexec} it is impossible to execute any
324 external program. Therefore LilyPond must be run with a backend that
325 does not require any such program. As we have already mentioned, it
326 must be run with superuser privileges (which, of course, it will lose
327 immediately), possibly using @command{sudo}. It is also good practice
328 to limit the number of seconds of CPU time LilyPond can use (e.g., using
329 @command{ulimit@tie{}-t}), and, if your operating system supports it,
330 the amount of memory that can be allocated. Also see
331 @ref{LilyPond in chroot jail}.
335 @cindex output, verbosity
337 @item -l, --loglevel=@var{LEVEL}
338 Set the verbosity of the console output to @var{LEVEL}. Possible values
344 No output at all, not even error messages.
347 Only error messages, no warnings or progress messages.
350 Warnings and error messages, no progress.
353 Basic progress messages (success), warnings and errors.
356 All progress messages, warnings and errors.
359 Progress messages, warnings, errors and further execution information.
362 All possible messages, including verbose debug output.
366 @cindex directory, redirect output
367 @cindex output, setting filename
368 @cindex output, directory
370 @item -o, --output=@var{FILE} or @var{FOLDER}
371 Set the default output file to @var{FILE} or, if a folder with that name
372 exists, direct the output to @var{FOLDER}, taking the file name from the
373 input file. The appropriate suffix will be added (e.g. @code{.pdf} for
376 @cindex PS (Postscript), output
377 @cindex Postscript (PS), output
378 @cindex output, PS (Postscript)
383 @cindex PNG (Portable Network Graphics), output
384 @cindex output, PNG (Portable Network Graphics)
387 Generate pictures of each page, in PNG format. This implies
388 @option{--ps}. The resolution in DPI of the image may be set with
393 @cindex PDF (Portable Document Format), output
394 @cindex output, PDF (Portable Document Format)
397 Generate PDF. This implies @option{--ps}.
400 Show version information.
403 Be verbose: show full paths of all files read, and give timing
407 Show the warranty with which GNU LilyPond comes. (It comes with
408 @strong{NO WARRANTY}!)
413 @node Advanced command line options for LilyPond
414 @unnumberedsubsec Advanced command line options for LilyPond
418 @item -d@var{[option-name]}=@var{[value]},
419 --define-default=@var{[option-name]}=@var{[value]}
420 This sets the equivalent internal Scheme function to @var{value}. For
427 If a @var{value} is not supplied, then the default value is used. The
428 prefix @code{no-} may be added to @var{option-name} to switch @q{off} an
431 @cindex point and click, command line
444 @noindent The following are supported along with their respective
447 @multitable @columnfractions .33 .16 .51
448 @item @strong{Symbol}
450 @tab @strong{Explanation/Options}
452 @item @code{anti-alias-factor}
454 @tab Render at a higher resolution (using the given factor) and scale
455 down the result to prevent @q{jaggies} in @code{PNG} images.
457 @item @code{aux-files}
459 @tab Create @code{.tex}, @code{.texi} and @code{.count} files when used
460 with the @code{eps} backend option.
464 @tab This is the default setting. Postscript files (default) include
465 @code{TTF}, @code{Type1} and @code{OTF} fonts. No @q{subsetting} of
466 these fonts is done. Be aware that using @q{oriental} character sets
467 can lead to very large file sizes.
471 @tab Used as default by the @command{lilypond-book} command. This dumps
472 every page as both a single file with all pages and fonts included and
473 as separate encapsulated postscript files for each page but without fonts
478 @tab Do not output a printed score. This has the same effect as
479 @code{-dno-print-pages}.
483 @tab This dumps out the raw, internal Scheme-based drawing commands.
487 @tab Scalable Vector Graphics.
488 A single SVG file is created for every page of output. Music glyphs
489 are encoded as vector graphics, but text fonts are @emph{not} embedded
490 in the SVG files. Any SVG viewer will therefore need the relevant text
491 fonts to be available to it for proper rendering of both text and
492 lyrics. It is recommended to not use font @q{lists} or @q{aliases}
493 in case an SVG viewer is unable to handle them. When using
494 @emph{Web Open Font Format} (WOFF) files the additional
495 @code{--svg-woff} switch is required.
497 @item @code{check-internal-types}
499 @tab Check every property assignment for types.
501 @item @code{clip-systems}
503 @tab Extract music fragments out of a score. This requires that the
504 @code{clip-regions} function has been defined within the @code{\layout}
505 block. See @ruser{Extracting fragments of music}. No fragments are
506 extracted though if used with the @option{-dno-print-pages} option.
510 @tab Match the size of the normal output to the typeset image.
514 @tab Prefix for data files (read-only).
516 @item @code{debug-gc}
518 @tab Dump memory debugging statistics.
520 @item @code{debug-gc-assert-parsed-dead}
522 @tab For memory debugging: Ensure that all references to parsed objects
523 are dead. This is an internal option, and is switched on automatically
524 for @code{`-ddebug-gc'}.
526 @item @code{debug-lexer}
528 @tab Debug the flex lexer.
530 @item @code{debug-page-breaking-scoring}
532 @tab Dump scores for many different page breaking configurations.
534 @item @code{debug-parser}
536 @tab Debug the bison parser.
538 @item @code{debug-property-callbacks}
540 @tab Debug cyclic callback chains.
542 @item @code{debug-skylines}
546 @item @code{delete-intermediate-files}
548 @tab Delete the unusable, intermediate @code{.ps} files created during
551 @item @code{dump-cpu-profile}
553 @tab Dump timing information (system-dependent).
555 @item @code{dump-profile}
557 @tab Dump memory and time information for each file.
559 @item @code{dump-signatures}
561 @tab Dump output signatures of each system. Used for regression testing.
563 @item @code{embed-source-code}
565 @tab Embed the LilyPond source files inside the generated PDF document.
567 @item @code{eps-box-padding}
569 @tab Pad left edge of the output EPS bounding box by the given amount
572 @item @code{font-export-dir}
574 @tab Directory for exporting fonts as PostScript files.
576 @item @code{gs-load-fonts}
578 @tab Load fonts via Ghostscript.
580 @item @code{gs-load-lily-fonts}
582 @tab Load only the LilyPond fonts via Ghostscript.
584 @item @code{gs-never-embed-fonts}
586 @tab Make Ghostscript embed only TrueType fonts and no other font format.
590 @tab Runs silently and redirect all output to a log file.
594 @strong{Note to Windows users:} By default @code{lilypond.exe} outputs
595 all progress information to the command window,
596 @code{lilypond-windows.exe} does not and returns a prompt, with no
597 progress information, immediately at the command line. The
598 @option{-dgui} option can be used in this case to redirect output to a
601 @multitable @columnfractions .33 .16 .51
606 @item @code{include-book-title-preview}
608 @tab Include book titles in preview images.
610 @item @code{include-eps-fonts}
612 @tab Include fonts in separate-system EPS files.
614 @item @code{include-settings}
616 @tab Include file for global settings, this is included before the score
619 @item @code{job-count}
621 @tab Process in parallel, using the given number of jobs.
623 @item @code{log-file}
624 @tab @code{#f [file]}
625 @tab If string @code{FOO} is given as a second argument,
626 redirect output to the log file @code{FOO.log}.
628 @item @code{max-markup-depth}
630 @tab Maximum depth for the markup tree. If a markup has more levels,
631 assume it will not terminate on its own, print a warning and return a
634 @item @code{midi-extension}
636 @tab Set the default file extension for MIDI output file to given
639 @item @code{music-strings-to-paths}
641 @tab Convert text strings to paths when glyphs belong to a music font.
643 @item @code{paper-size}
645 @tab Set default paper size. Note the string must be enclosed in
646 escaped double quotes.
648 @item @code{pixmap-format}
650 @tab Set GhostScript's output format for pixel images.
652 @item @code{point-and-click}
654 @tab Add @q{point & click} links to PDF and SVG output.
655 See @ref{Point and click}.
659 @tab Create preview images in addition to normal output.
663 This option is supported by all backends; @code{pdf}, @code{png},
664 @code{ps}, @code{eps} and @code{svg}, but not @code{scm}. It generates
665 an output file, in the form @code{myFile.preview.extension}, containing
666 the titles and the first system of music. If @code{\book} or
667 @code{\bookpart} blocks are used, the titles of @code{\book},
668 @code{\bookpart} or @code{\score} will appear in the output, including
669 the first system of every @code{\score} block if the @code{\paper}
670 variable @code{print-all-headers} is set to @code{#t}.
672 To suppress the usual output, use the @option{-dprint-pages} or
673 @option{-dno-print-pages} options according to your requirements.
675 @multitable @columnfractions .33 .16 .51
676 @item @code{print-pages}
678 @tab Generate full pages, the default. @option{-dno-print-pages} is
679 useful in combination with @option{-dpreview} or @option{-dcrop}.
681 @item @code{profile-property-accesses}
683 @tab Keep statistics of @code{get_property()} function calls.
685 @item @code{protected-scheme-parsing}
687 @tab Continue when errors in inline scheme are caught in the parser. If
688 set to @code{#f}, halt on errors and print a stack trace.
690 @item @code{read-file-list}
691 @tab @code{#f [file]}
692 @tab Specify name of a file which contains a list of input files to be
695 @item @code{relative-includes}
697 @tab When processing an @code{\include} command, look for the included
698 file relative to the current file (instead of the root file).
700 @item @code{resolution}
702 @tab Set resolution for generating @code{PNG} pixmaps to given value (in
707 @tab Do not trust the @code{.ly} input.
711 When LilyPond formatting is available through a web server, either the
712 @option{--safe} or the @option{--jail} option @b{MUST} be passed. The
713 @option{--safe} option will prevent inline Scheme code from wreaking
718 #(s ystem "rm -rf /") % too dangerous to write correctly
720 c4^$(ly:gulp-file "/etc/passwd") % malicious but not destructive
725 The @option{-dsafe} option works by evaluating in-line Scheme
726 expressions in a special safe module. This is derived from GUILE
727 @file{safe-r5rs} module, but also adds a number of functions of the
728 LilyPond API which are listed in @file{scm/safe-lily.scm}.
730 In addition, safe mode disallows @code{\include} directives and
731 disables the use of backslashes in @TeX{} strings. It is also not
732 possible to import LilyPond variables into Scheme while in safe mode.
734 @option{-dsafe} does @emph{not} detect resource overuse, so it is still
735 possible to make the program hang indefinitely, for example by feeding
736 cyclic data structures into the backend. Therefore, if using LilyPond
737 on a publicly accessible webserver, the process should be limited in
738 both CPU and memory usage.
740 Safe mode will prevent many useful LilyPond snippets from being
743 The @option{--jail} is an even more secure alternative, but requires
744 more work to set up. See @ref{Basic command line options for LilyPond}.
746 @multitable @columnfractions .33 .16 .51
747 @item @code{separate-log-files}
749 @tab For input files @code{FILE1.ly}, @code{FILE2.ly}, etc. output log
750 data to files @code{FILE1.log}, @code{FILE2.log}@dots{}
752 @item @code{show-available-fonts}
754 @tab List available font names.
756 @item @code{strict-infinity-checking}
758 @tab Force a crash on encountering @code{Inf} and @code{NaN} floating
761 @item @code{strip-output-dir}
763 @tab Don't use directories from input files while constructing output
766 @item @code{strokeadjust}
768 @tab Force PostScript stroke adjustment. This option is mostly
769 relevant when a PDF is generated from PostScript output (stroke
770 adjustment is usually enabled automatically for low-resolution bitmap
771 devices). Without this option, PDF previewers tend to produce widely
772 inconsistent stem widths at resolutions typical for screen display. The
773 option does not noticeably affect print quality and causes large file
774 size increases in PDF files.
776 @item @code{svg-woff}
778 @tab This option is required when using Web Open Font Format (WOFF) font
779 files with the backend @code{svg} command. A single SVG file is created
780 for every page of output. Apart from LilyPond's own music glyphs, no
781 other font information will be included. Any SVG viewer will therefore
782 require the fonts be available to it for the proper rendering of both
783 text and lyrics. It is also recommended not to use any font @q{aliases}
784 or @q{lists} in case the SVG viewer cannot handle them.
786 @item @code{trace-memory-frequency}
788 @tab Record Scheme cell usage this many times per second. Dump the
789 results to @code{FILE.stacks} and @code{FILE.graph}.
791 @item @code{trace-scheme-coverage}
793 @tab Record coverage of Scheme files in @code{FILE.cov}.
797 @tab Verbose output, i.e. loglevel at DEBUG (read-only).
799 @item @code{warning-as-error}
801 @tab Change all warning and @q{programming error} messages into errors.
805 @node Environment variables
806 @unnumberedsubsec Environment variables
809 @cindex LILYPOND_DATADIR
811 @command{lilypond} recognizes the following environment variables:
813 @item LILYPOND_DATADIR
814 This specifies a directory where locale messages and
815 data files will be looked up by default. The directory should contain
816 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
819 This selects the language for the warning messages.
821 @item LILYPOND_LOGLEVEL
822 The default loglevel. If LilyPond is called without an explicit loglevel
823 (i.e. no @option{--loglevel} command line option), this value is used.
825 @item LILYPOND_GC_YIELD
826 A variable, as a percentage, that tunes memory management
827 behavior. A higher values means the program uses more memory, a
828 smaller value means more CPU time is used. The default value is
834 @node LilyPond in chroot jail
835 @unnumberedsubsec LilyPond in chroot jail
837 Setting up the server to run LilyPond in a chroot jail is a complicated
838 task. The steps are listed below. Examples in the steps are from
839 Ubuntu GNU/Linux, and may require the use of @code{sudo} as appropriate.
843 @item Install the necessary packages: LilyPond, GhostScript, and ImageMagick.
845 @item Create a new user by the name of @code{lily}:
852 This will create a new group for the @code{lily} user as well, and a
853 home folder, @code{/home/lily}
855 @item In the home folder of the @code{lily} user create a file to use as a
859 dd if=/dev/zero of=/home/lily/loopfile bs=1k count= 200000
863 This example creates a 200MB file for use as the jail filesystem.
865 @item Create a loop device, make a file system and mount it, then create
866 a folder that can be written by the @code{lily} user:
870 losetup /dev/loop0 /home/lily/loopfile
871 mkfs -t ext3 /dev/loop0 200000
872 mount -t ext3 /dev/loop0 /mnt/lilyloop
873 mkdir /mnt/lilyloop/lilyhome
874 chown lily /mnt/lilyloop/lilyhome
877 @item In the configuration of the servers, the JAIL will be @code{/mnt/lilyloop}
878 and the DIR will be @code{/lilyhome}.
880 @item Create a big directory tree in the jail by copying the necessary files, as
881 shown in the sample script below.
883 You can use @code{sed} to create the necessary copy commands for a given
887 for i in "/usr/local/lilypond/usr/bin/lilypond" "/bin/sh" "/usr/bin/; \
888 do ldd $i | sed 's/.*=> \/\(.*\/\)\([^(]*\).*/mkdir -p \1 \&\& \
889 cp -L \/\1\2 \1\2/' | sed 's/\t\/\(.*\/\)\(.*\) (.*)$/mkdir -p \
890 \1 \&\& cp -L \/\1\2 \1\2/' | sed '/.*=>.*/d'; done
895 @subheading Example script for 32-bit Ubuntu 8.04
903 loopdevice=/dev/loop0
904 jaildir=/mnt/lilyloop
905 # the prefix (without the leading slash!)
907 # the directory where lilypond is installed on the system
908 lilydir=/$lilyprefix/lilypond/
910 userhome=$home/$username
911 loopfile=$userhome/loopfile
913 dd if=/dev/zero of=$loopfile bs=1k count=200000
915 losetup $loopdevice $loopfile
916 mkfs -t ext3 $loopdevice 200000
917 mount -t ext3 $loopdevice $jaildir
918 mkdir $jaildir/lilyhome
919 chown $username $jaildir/lilyhome
922 mkdir -p bin usr/bin usr/share usr/lib usr/share/fonts $lilyprefix tmp
925 cp -r -L $lilydir $lilyprefix
926 cp -L /bin/sh /bin/rm bin
927 cp -L /usr/bin/convert /usr/bin/gs usr/bin
928 cp -L /usr/share/fonts/truetype usr/share/fonts
930 # Now the library copying magic
931 for i in "$lilydir/usr/bin/lilypond" "$lilydir/usr/bin/guile" "/bin/sh" \
932 "/bin/rm" "/usr/bin/gs" "/usr/bin/convert"; do ldd $i | sed 's/.*=> \
933 \/\(.*\/\)\([^(]*\).*/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/' | sed \
934 's/\t\/\(.*\/\)\(.*\) (.*)$/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/' \
935 | sed '/.*=>.*/d'; done | sh -s
937 # The shared files for ghostscript...
938 cp -L -r /usr/share/ghostscript usr/share
939 # The shared files for ImageMagick
940 cp -L -r /usr/lib/ImageMagick* usr/lib
942 ### Now, assuming that you have test.ly in /mnt/lilyloop/lilyhome,
943 ### you should be able to run:
944 ### Note that /$lilyprefix/bin/lilypond is a script, which sets the
945 ### LD_LIBRARY_PATH - this is crucial
946 /$lilyprefix/bin/lilypond -jlily,lily,/mnt/lilyloop,/lilyhome test.ly
949 @c " keep quote signs balanced for context-sensitive editors
952 @section Error messages
954 @cindex error messages
955 Different error messages can appear while compiling a file:
961 Something looks suspect. If you are requesting something out of the
962 ordinary then you will understand the message, and can ignore it.
963 However, warnings usually indicate that something is wrong with the
968 Something is definitely wrong. The current processing step (parsing,
969 interpreting, or formatting) will be finished, but the next step will
974 Something is definitely wrong, and LilyPond cannot continue. This
975 happens rarely. The most usual cause is misinstalled fonts.
978 @cindex trace, Scheme
981 Errors that occur while executing Scheme code are caught by the Scheme
982 interpreter. If running with the verbose option (@option{-V} or
983 @option{--verbose}) then a call trace of the offending
984 function call is printed.
986 @item Programming error
987 @cindex Programming error
988 There was some internal inconsistency. These error messages are
989 intended to help the programmers and debuggers. Usually, they can be
990 ignored. Sometimes, they come in such big quantities that they obscure
993 @item Aborted (core dumped)
994 @cindex Aborted (core dumped)
995 This signals a serious programming error that caused the program to
996 crash. Such errors are considered critical. If you stumble on one,
1000 @cindex errors, message format
1001 If warnings and errors can be linked to some part of the input file,
1002 then error messages have the following form
1005 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
1006 @var{offending input line}
1009 A line-break is inserted in the offending line to indicate the column
1010 where the error was found. For example,
1013 test.ly:2:19: error: not a duration: 5
1018 These locations are LilyPond's best guess about where the warning or
1019 error occurred, but (by their very nature) warnings and errors occur
1020 when something unexpected happens. If you can't see an error in the
1021 indicated line of your input file, try checking one or two lines
1022 above the indicated position.
1024 Please note that diagnostics can be triggered at any point during the
1025 many stages of processing. For example if there are parts of the input
1026 that are processed multiple times (i.e. in midi and layout output), or
1027 if the same music variable is used in multiple contexts the same message
1028 may appear several times. Diagnostics produced at a @q{late} stage (i.e
1029 bar checks) might also be issued multiple times.
1031 More information about errors is given in @ref{Common errors}.
1035 @section Common errors
1037 The error conditions described below occur often, yet the cause
1038 is not obvious or easily found. Once seen and understood, they
1043 * Music runs off the page::
1044 * An extra staff appears::
1045 * Error message Unbound variable %::
1046 * Error message FT_Get_Glyph_Name::
1047 * Warning staff affinities should only decrease::
1048 * Error message unexpected new::
1049 * Warning this voice needs a voiceXx or shiftXx setting::
1052 @node Music runs off the page
1053 @unnumberedsubsec Music runs off the page
1055 Music running off the page over the right margin or appearing
1056 unduly compressed is almost always due to entering an incorrect
1057 duration on a note, causing the final note in a measure to extend
1058 over the bar line. It is not invalid if the final note in a
1059 measure does not end on the automatically entered bar line, as the
1060 note is simply assumed to carry over into the next measure. But
1061 if a long sequence of such carry-over measures occurs the music
1062 can appear compressed or may flow off the page because automatic
1063 line breaks can be inserted only at the end of complete measures,
1064 i.e., where all notes end before or at the end of the measure.
1066 @warning{An incorrect duration can cause line breaks to be
1067 inhibited, leading to a line of highly compressed music or
1068 music which flows off the page.}
1070 The incorrect duration can be found easily if bar checks are used,
1071 see @ruser{Bar and bar number checks}.
1073 If you actually intend to have a series of such carry-over measures
1074 you will need to insert an invisible bar line where you want the
1075 line to break. For details, see @ruser{Bar lines}.
1078 @node An extra staff appears
1079 @unnumberedsubsec An extra staff appears
1081 If contexts are not created explicitly with @code{\new} or
1082 @code{\context}, they will be silently created as soon as a
1083 command is encountered which cannot be applied to an existing
1084 context. In simple scores the automatic creation of contexts is
1085 useful, and most of the examples in the LilyPond manuals take
1086 advantage of this simplification. But occasionally the silent
1087 creation of contexts can give rise to unexpected new staves or
1088 scores. For example, it might be expected that the following code
1089 would cause all note heads within the following staff to be
1090 colored red, but in fact it results in two staves with the note
1091 heads remaining the default black in the lower staff.
1093 @lilypond[quote,verbatim,fragment]
1094 \override Staff.NoteHead.color = #red
1098 This is because a @code{Staff} context does not exist when the
1099 override is processed, so one is implicitly created and the override
1100 is applied to it, but then the @code{\new Staff} command creates
1101 another, separate, staff into which the notes are placed. The
1102 correct code to color all note heads red is
1104 @lilypond[quote,verbatim]
1106 \override Staff.NoteHead.color = #red
1111 @node Error message Unbound variable %
1112 @unnumberedsubsec Error message Unbound variable %
1114 This error message will appear at the bottom of the console
1115 output or log file together with a @qq{GUILE signalled an error @dots{}}
1116 message every time a Scheme routine is called which (invalidly)
1117 contains a @emph{LilyPond} rather than a @emph{Scheme} comment.
1119 LilyPond comments begin with a percent sign, (@code{%}), and must
1120 not be used within Scheme routines. Scheme comments begin with a
1121 semi-colon, (@code{;}).
1123 @node Error message FT_Get_Glyph_Name
1124 @unnumberedsubsec Error message FT_Get_Glyph_Name
1126 This error messages appears in the console output or log file if
1127 an input file contains a non-ASCII character and was not saved in
1128 UTF-8 encoding. For details, see @ruser{Text encoding}.
1131 @node Warning staff affinities should only decrease
1132 @unnumberedsubsec Warning staff affinities should only decrease
1134 This warning can appear if there are no staves in the printed
1135 output, for example if there are just a @code{ChordName} context
1136 and a @code{Lyrics} context as in a lead sheet. The warning
1137 messages can be avoided by making one of the contexts behave as a
1141 \override VerticalAxisGroup.staff-affinity = ##f
1145 at its start. For details, see @qq{Spacing of non-staff lines} in
1146 @ruser{Flexible vertical spacing within systems}.
1149 @node Error message unexpected new
1150 @unnumberedsubsec Error message unexpected @code{@bs{}new}
1152 A @code{\score} block must contain a @emph{single} music expression.
1153 If instead it contains several @code{\new Staff},
1154 @code{\new StaffGroup} or similar contexts introduced with @code{\new}
1155 without them being enclosed in either curly brackets,
1156 @code{@{ @dots{} @}}, or double angle brackets, @code{<< @dots{} >>},
1161 % Invalid! Generates error: syntax error, unexpected \new
1162 \new Staff @{ @dots{} @}
1163 \new Staff @{ @dots{} @}
1168 the error message will be produced.
1170 To avoid the error, enclose all the @code{\new} statements in
1171 curly or double angle brackets.
1173 Using curly brackets will introduce the @code{\new} statements
1176 @lilypond[quote,verbatim]
1179 \new Staff { a' a' a' a' }
1180 \new Staff { g' g' g' g' }
1186 but more likely you should be using double angle brackets so the new
1187 staves are introduced in parallel, i.e. simultaneously:
1189 @lilypond[quote,verbatim]
1192 \new Staff { a' a' a' a' }
1193 \new Staff { g' g' g' g' }
1198 @node Warning this voice needs a voiceXx or shiftXx setting
1199 @unnumberedsubsec Warning this voice needs a @code{@bs{}voiceXx} or @code{@bs{}shiftXx} setting
1201 If notes from two different voices with stems in the same direction
1202 occur at the same musical moment, but the voices have no
1203 voice-specific shifts specified, the warning message
1204 @samp{warning: this voice needs a \voiceXx or \shiftXx setting} will appear
1205 when compiling the LilyPond file. This warning will appear even when
1206 the notes have no visible stems, e.g. whole notes, if the stems for
1207 shorter notes at the same pitch would be in the same direction.
1209 Remember that the stem direction depends on the position of the
1210 note on the staff unless the stem direction is specified, for example
1211 by using @code{\voiceOne}, etc. In this case the warning will appear
1212 only when the stems happen to be in the same direction, i.e. when the
1213 notes are in the same half of the staff.
1215 By placing the notes in voices with stem directions and shifts
1216 specified, for example by using @code{\voiceOne}, etc., these warnings
1219 Notes in higher numbered voices, @code{\voiceThree} etc., are
1220 automatically shifted to avoid clashing note columns. This causes a
1221 visible shift for notes with stems, but whole notes are not visibly
1222 shifted unless an actual clash of the note heads occurs, or when the
1223 voices cross over from their natural order (when @code{\voiceThree}
1224 is higher than @code{\voiceOne}, etc.)
1227 @rlearning{Explicitly instantiating voices},
1228 @rlearning{Real music example},
1229 @ruser{Single-staff polyphony},
1230 @ruser{Collision resolution}.