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. See TRANSLATION for details.
13 @node Running lilypond
14 @chapter Running @command{lilypond}
16 This chapter details the technicalities of running LilyPond.
20 * Command-line usage::
28 Most users run LilyPond through a GUI; see
30 @c @rlearning{First steps} if
31 you have not read this already.
34 @node Command-line usage
35 @section Command-line usage
37 This section contains extra information about using LilyPond on the
38 command-line. This may be desirable to pass extra options to the
39 program. In addition, there are certain extra @q{helper} programs (such
40 as @code{midi2ly}) which are only available on the command-line.
42 By @q{command-line}, we mean the command line in the operating system.
43 Windows users might be more familiar with the terms @q{DOS shell} or
44 @q{command shell}; MacOS@tie{}X users might be more familiar with the terms
45 @q{terminal} or @q{console}. They should also consult
46 FIXME @c @ref{Setup for MacOS X}.
48 Describing how to use this part of an operating system is outside the
49 scope of this manual; please consult other documentation on this topic
50 if you are unfamiliar with the command-line.
54 * Command line options for lilypond::
55 * Environment variables::
58 @node Invoking lilypond
59 @subsection Invoking @command{lilypond}
61 @cindex Invoking @command{lilypond}
62 @cindex command line options for @command{lilypond}
63 @cindex options, command line
67 The @command{lilypond} executable may be called as follows from the command line.
70 lilypond [@var{option}]@dots{} @var{file}@dots{}
74 When invoked with a filename that has no extension, the @file{.ly}
75 extension is tried first. To read input from stdin, use a
76 dash (@code{-}) for @var{file}.
78 When @file{filename.ly} is processed it will produce @file{filename.ps}
79 and @file{filename.pdf} as output. Several files can be specified;
80 they will each be processed independently. @footnote{The status of
81 GUILE is not reset after processing a @code{.ly} file, so be careful
82 not to change any system defaults from within Scheme.}
84 If @file{filename.ly} contains more than one @code{\score}
85 block, then the rest of the scores will be output in numbered files,
86 starting with @file{filename-1.pdf}. In addition, the value of
87 @code{output-suffix} will be inserted between the basename and the
88 number. An input file containing
91 #(define output-suffix "violin")
93 #(define output-suffix "cello")
98 will output @var{base}@file{-violin.pdf} and
99 @var{base}@file{-cello-1.pdf}.
102 @node Command line options for lilypond
103 @subsection Command line options for @command{lilypond}
105 The following options are supported:
109 @item -e,--evaluate=@var{expr}
110 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
111 Multiple @code{-e} options may be given, they will be evaluated
114 The expression will be evaluated in the @code{guile-user} module, so
115 if you want to use definitions in @var{expr}, use
118 lilypond -e '(define-public a 42)'
122 on the command-line, and include
125 #(use-modules (guile-user))
129 at the top of the @code{.ly} file.
131 @item -f,--format=@var{format}
132 which formats should be written. Choices for @code{format} are
133 @code{svg}, @code{ps}, @code{pdf}, and @code{png}.
135 Example: @code{lilypond -fpng @var{filename}.ly}
139 @item -d,--define-default=@var{var}=@var{val}
140 This sets the internal program option @var{var} to the Scheme value
141 @var{val}. If @var{val} is not supplied, then @var{#t} is used. To
142 switch off an option, @code{no-} may be prefixed to @var{var}, e.g.
144 @cindex point and click, command line
153 -dpoint-and-click='#f'
156 Here are a few interesting options.
160 Running @code{lilypond -dhelp} will print all of the @code{-d} options
164 This option sets the default paper-size,
166 -dpaper-size=\"letter\"
170 Note that the string must be enclosed in escaped quotes ( @code{\"} ).
171 @c Match " in previous line to help context-sensitive editors
174 Do not trust the @code{.ly} input.
176 When LilyPond formatting is available through a web server, either the
177 @code{--safe} or the @code{--jail} option @b{MUST} be passed. The
178 @code{--safe} option will prevent inline Scheme code from wreaking
185 c4^#(ly:export (ly:gulp-file "/etc/passwd"))
190 The @code{-dsafe} option works by evaluating in-line Scheme
191 expressions in a special safe module. This safe module is derived from
192 GUILE @file{safe-r5rs} module, but adds a number of functions of the
193 LilyPond API. These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
195 In addition, safe mode disallows @code{\include} directives and
196 disables the use of backslashes in @TeX{} strings.
198 In safe mode, it is not possible to import LilyPond variables
201 @code{-dsafe} does @emph{not} detect resource overuse. It is still possible to
202 make the program hang indefinitely, for example by feeding cyclic data
203 structures into the backend. Therefore, if using LilyPond on a
204 publicly accessible webserver, the process should be limited in both
205 CPU and memory usage.
207 The safe mode will prevent many useful LilyPond snippets from being
208 compiled. The @code{--jail} is a more secure alternative, but
209 requires more work to set up.
211 @cindex output format, setting
213 the output format to use for the back-end. Choices for @code{format} are
216 @cindex PostScript output
219 Postscript files include TTF, Type1 and OTF fonts. No subsetting of
220 these fonts is done. When using oriental character sets, this can
224 for encapsulated PostScript. This dumps every page (system) as a separate
225 @file{EPS} file, without fonts, and as one collated @file{EPS} file with
226 all pages (systems) including fonts.
228 This mode is used by default by @command{lilypond-book}.
231 @cindex SVG (Scalable Vector Graphics)
232 for SVG (Scalable Vector Graphics).
234 This creates a single SVG file containing the entire music output
235 with no embedded fonts. It is recommended to install the Century
236 Schoolbook fonts, included with your LilyPond installation, for
237 optimal rendering. Under UNIX, simply copy these fonts from the
238 LilyPond directory (typically
239 @file{/usr/share/lilypond/VERSION/fonts/otf/}) to
240 @file{~/.fonts/}. The SVG output should be compatible with any
241 SVG editor or user agent.
245 for a dump of the raw, internal Scheme-based drawing commands.
248 do not output a printed score; has the same effect as @code{-dno-print-pages}.
251 Example: @code{lilypond -dbackend=svg @var{filename}.ly}
254 Generate an output file containing the titles and the first system
257 Generate the full pages, the default. @code{-dno-print-pages} is
258 useful in combination with @code{-dpreview}.
265 Show a summary of usage.
267 @item -H,--header=@var{FIELD}
268 Dump a header field to file @file{BASENAME.@var{FIELD}}.
270 @item --include, -I=@var{directory}
271 Add @var{directory} to the search path for input files.
272 @cindex file searching
275 @item -i,--init=@var{file}
276 Set init file to @var{file} (default: @file{init.ly}).
278 @item -o,--output=@var{FILE}
279 Set the default output file to @var{FILE}. The appropriate
280 suffix will be added (e.g. @code{.pdf} for pdf)
286 Generate pictures of each page, in PNG format. This implies
287 @code{--ps}. The resolution in DPI of the image may be set with
293 Generate PDF. This implies @code{--ps}.
297 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
298 Run @command{lilypond} in a chroot jail.
300 The @code{--jail} option provides a more flexible alternative to
301 @code{--safe} when LilyPond formatting is available through a web
302 server or whenever LilyPond executes externally provided
305 The @code{--jail} option works by changing the root of @command{lilypond} to
306 @var{jail} just before starting the actual compilation process. The user
307 and group are then changed to match those provided, and the current
308 directory is changed to @var{dir}. This setup guarantees that it is not
309 possible (at least in theory) to escape from the jail. Note that for
310 @code{--jail} to work @command{lilypond} must be run as root, which is usually
311 accomplished in a safe way using @command{sudo}.
313 Setting up a jail is a slightly delicate matter, as we must be sure that
314 LilyPond is able to find whatever it needs to compile the source
315 @emph{inside the jail}. A typical setup comprises the following items:
318 @item Setting up a separate filesystem
319 A separate filesystem should be created for LilyPond, so that it can be
320 mounted with safe options such as @code{noexec}, @code{nodev}, and
321 @code{nosuid}. In this way, it is impossible to run executables or to
322 write directly to a device from LilyPond. If you do not want to create a
323 separate partition, just create a file of reasonable size and use it to
324 mount a loop device. A separate filesystem also guarantees that LilyPond
325 cannot write more space than it is allowed.
327 @item Setting up a separate user
328 A separate user and group (say, @code{lily}/@code{lily}) with low
329 privileges should be used to run LilyPond inside the jail. There should
330 be a single directory writable by this user, which should be passed in
333 @item Preparing the jail
334 LilyPond needs to read a number of files while running. All these files
335 are to be copied into the jail, under the same path they appear in the
336 real root filesystem. The entire content of the LilyPond installation
337 (e.g., @file{/usr/share/lilypond})
340 If problems arise, the simplest way to trace them down is to run
341 LilyPond using @command{strace}, which will allow you to determine which
344 @item Running LilyPond
345 In a jail mounted with @code{noexec} it is impossible to execute any external
346 program. Therefore LilyPond must be run with a backend that does not
347 require any such program. As we already mentioned, it must be also run
348 with superuser privileges (which, of course, it will lose immediately),
349 possibly using @command{sudo}. It is a good idea to limit the number of
350 seconds of CPU time LilyPond can use (e.g., using @command{ulimit
351 -t}), and, if your operating system supports it, the amount of memory
352 that can be allocated.
357 Show version information.
360 Be verbose: show full paths of all files read, and give timing
364 Show the warranty with which GNU LilyPond comes. (It comes with
365 @strong{NO WARRANTY}!)
368 @node Environment variables
369 @subsection Environment variables
373 @cindex LILYPOND_DATADIR
375 @command{lilypond} recognizes the following environment variables:
377 @item LILYPOND_DATADIR
378 This specifies a directory where locale messages and
379 data files will be looked up by default. The directory should contain
380 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
383 This selects the language for the warning messages.
385 @item LILYPOND_GC_YIELD
386 With this variable the memory footprint and performance can be
387 adjusted. It is a percentage tunes memory management behavior. With
388 higher values, the program uses more memory, with smaller values, it
389 uses more CPU time. The default value is @code{70}.
395 @section Error messages
397 @cindex error messages
398 Different error messages can appear while compiling a file:
404 Something looks suspect. If you are requesting something out of the
405 ordinary then you will understand the message, and can ignore it.
406 However, warnings usually indicate that something is wrong with the
410 Something is definitely wrong. The current processing step (parsing,
411 interpreting, or formatting) will be finished, but the next step will
417 Something is definitely wrong, and LilyPond cannot continue. This
418 happens rarely. The most usual cause is misinstalled fonts.
421 @cindex trace, Scheme
424 Errors that occur while executing Scheme code are caught by the Scheme
425 interpreter. If running with the verbose option (@code{-V} or
426 @code{--verbose}) then a call trace of the offending
427 function call is printed.
429 @item Programming error
430 @cindex Programming error
431 There was some internal inconsistency. These error messages are
432 intended to help the programmers and debuggers. Usually, they can be
433 ignored. Sometimes, they come in such big quantities that they obscure
436 @item Aborted (core dumped)
437 This signals a serious programming error that caused the program to
438 crash. Such errors are considered critical. If you stumble on one,
442 @cindex errors, message format
443 If warnings and errors can
444 be linked to some part of the input file, then error messages have the
448 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
449 @var{offending input line}
452 A line-break is inserted in the offending line to indicate the column
453 where the error was found. For example,
456 test.ly:2:19: error: not a duration: 5
461 These locations are LilyPond's best guess about where the warning or
462 error occurred, but (by their very nature) warnings and errors occur
463 when something unexpected happens. If you can't see an error in the
464 indicated line of your input file, try checking one or two lines
465 above the indicated position.