2 @node Invoking LilyPond
3 @chapter Invoking LilyPond
5 This chapter details the technicalities of running LilyPond.
9 * Invoking lilypond:: Titling LilyPond scores.
10 * Invoking the lilypond binary::
17 @node Invoking lilypond
18 @section Invoking lilypond
20 Nicely titled output is created through a separate program:
21 @file{@code{lilypond}} is a script that uses the LilyPond formatting
22 engine (which is in a separate program) and La@TeX{} to create a
23 nicely titled piece of sheet music, in PDF (Portable Document Format)
27 @code{lilypond} [@var{option}]@dots{} @var{file}@dots{}
30 To have @code{lilypond} read from stdin, use a dash @code{-} for @var{file}.
32 The @code{lilypond} program supports the following options:
36 Keep the temporary directory with all output
37 files. The temporary directory is created in the current directory as @code{@code{lilypond}.dir}.
38 @item -d,--dependencies
39 Write @code{Makefile} dependencies for every input file.
42 @item -I,--include=@var{dir}
43 Add @var{dir} to LilyPond's include path.
45 Produce MIDI output only.
47 Do not run @file{lilypond-bin}. Useful for debugging @code{lilypond}.
48 @item -o,--output=@var{file}
49 Generate output to @var{file}. The extension of @var{file} is ignored.
51 Do not generate (PDF) or PS.
54 @cindex Scalable fonts
56 @c why is this comment here? --hwn
58 If you use lilypond-book or your own wrapper files, do not use
59 @code{\usepackage[[T1]@{fontenc@}} in the file header but do not forget
60 @code{\usepackage[latin1]@{inputenc@}} if you use any other
61 non-anglosaxian characters.
64 Also generate pictures of each page, in PNG format.
66 Gzip the postscript file.
68 Make a .HTML file with links to all output files.
70 Also generate a picture of the first system of the score.
79 @item -s,--set=@var{key}=@var{val}
80 Add @var{key}= @var{val} to the settings, overriding those specified
81 in the files. Possible keys: @code{language}, @code{latexheaders},
82 @code{latexpackages}, @code{latexoptions}, @code{papersize},
83 @code{pagenumber}, @code{linewidth}, @code{orientation},
86 Show version information.
88 Be verbose. This prints out commands as they are executed, and more
89 information about the formatting process is printed.
91 Print even more information. This is useful when generating bugreports.
93 Show the warranty with which GNU LilyPond comes. (It comes with
94 @strong{NO WARRANTY}!)
97 @subsection Titling layout
99 @code{lilypond} extracts the following header fields from the LY files
100 to generate titling; an example demonstrating all these fields is in
101 @inputfileref{input/test,lilypond-testpage.ly}:
105 The title of the music. Centered on top of the first page.
107 Subtitle, centered below the title.
109 Name of the poet, left flushed below the subtitle.
111 Name of the composer, right flushed below the subtitle.
113 Meter string, left flushed below the poet.
115 Name of the opus, right flushed below the composer.
117 Name of the arranger, right flushed below the opus.
119 Name of the instrument, centered below the arranger.
121 To whom the piece is dedicated.
123 Name of the piece, left flushed below the instrument.
125 A text to print in the header of all pages. It is not called
126 @code{header}, because @code{\header} is a reserved word in LilyPond.
128 A text to print in the footer of the first page. Default is to
129 print the standard footer also on the first page. Note that if the
130 score is only page, the first page is also the last page and in this
131 case, the tagline is printed instead of the copyright.
133 A text to print in the footer of all but the last page.
135 Line to print at the bottom of last page. The default text is ``Lily
136 was here, @var{version-number}''.
147 @subsection Additional parameters
149 The @code{lilypond} program responds to several parameters specified
150 in a @code{\paper} section of the input file. They can be overridden
151 by supplying a @code{--set} command line option.
155 Specify La@TeX{} language: the @code{babel} package will be
156 included. Default: unset.
158 Read from the @code{\header} block.
161 Specify additional La@TeX{} headers file.
163 Normally read from the @code{\header} block. Default value: empty.
166 Specify additional La@TeX{} packages file. This works cumulative,
167 so you can add multiple packages using multiple @code{-s=latexpackages} options.
168 Normally read from the @code{\header} block. Default value:
172 Specify additional options for the La@TeX{}
173 @code{\documentclass}. You can put any valid value here. This was
174 designed to allow @code{lilypond} to produce output for double-sided
175 paper, with balanced margins and pagenumbers on alternating sides. To
176 achieve this specify @code{twoside}.
179 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
180 read from the @code{\paper} block, if set.
183 The vertical extension of the music on the page. It is normally
184 calculated automatically, based on the paper size.
187 The music line width. It is normally read from the @code{\paper}
191 The paper size (as a name, e.g. @code{a4}). It is normally read from
192 the @code{\paper} block.
195 If set to @code{no}, no page numbers will be printed. If set to a
196 positive integer, start with this value as the first page number.
200 The font encoding, should be set identical to the @code{font-encoding}
201 property in the score.
206 @node Invoking the lilypond binary
207 @section Invoking the lilypond binary
208 @cindex Invoking LilyPond
209 @cindex command line options
210 @cindex options, command line
214 The LilyPond system consists of two parts: a binary executable, which
215 is responsible for the formatting functionality, and support scripts,
216 which post-process the resulting output. Normally, the support scripts
217 are called, which in turn invoke the @code{lilypond-bin}
218 binary. However, @code{lilypond-bin} may be called directly as
222 lilypond-bin [@var{option}]@dots{} @var{file}@dots{}
226 When invoked with a filename that has no extension, the @file{.ly}
227 extension is tried first. To read input from stdin, use a
228 dash @code{-} for @var{file}.
230 When @file{filename.ly} is processed it will produce
231 @file{filename.tex} as output (or @file{filename.ps} for PostScript
232 output). If @file{filename.ly} contains more than one @code{\score}
233 block, then the rest of the scores will be output in numbered files,
234 starting with @file{filename-1.tex}. Several files can be specified;
235 they will each be processed independently. @footnote{The status of
236 GUILE is not reset across invocations, so be careful not to change any
237 system defaults from within Scheme.}
240 @section Command line options
242 The following options are supported:
246 @item -e,--evaluate=@var{expr}
247 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
248 Multiple @code{-e} options may be given, they will be evaluated
249 sequentially. The function @code{ly:set-option} allows for access to
250 some internal variables. Use @code{-e '(ly:option-usage')} for more
253 @item -f,--format=@var{format}
256 Output format for sheet music. Choices are @code{tex} (for @TeX{}
257 output, to be processed with plain @TeX{}, or through @code{lilypond}),
258 @code{pdftex} for PDF@TeX{} input, @code{ps} (for PostScript),
259 @code{scm} (for a Scheme dump), @code{sk} (for Sketch) and @code{as}
262 @strong{This option is only for developers}. Only the @TeX{} output of
263 these is usable for real work.
266 @cindex output format, setting
267 @cindex Sketch output
268 @cindex ASCII-art output
269 @cindex PDFTeX output
270 @cindex PostScript output
274 Show a summary of usage.
275 @item --include, -I=@var{directory}
276 Add @var{directory} to the search path for input files.
277 @cindex file searching
279 @item -i,--init=@var{file}
280 Set init file to @var{file} (default: @file{init.ly}).
283 Disable @TeX{} output. If you have a @code{\midi} definition MIDI output
285 @item -M,--dependencies
286 Output rules to be included in Makefile.
287 @item -o,--output=@var{FILE}
288 Set the default output file to @var{FILE}.
292 Disallow untrusted @code{\include} directives, in-line
293 Scheme evaluation, backslashes in @TeX{}, code.
295 @strong{WARNING}: the @code{--safe} option has not been reviewed for a
296 long time. Do not rely on it for automatic invocation (e.g. over the
297 web). Volunteers are welcome to do a new audit.
301 Show version information.
303 Be verbose: show full paths of all files read, and give timing
307 Show the warranty with which GNU LilyPond comes. (It comes with
308 @strong{NO WARRANTY}!)
311 @section Environment variables
314 For processing both the @TeX{} and the PostScript output, the
315 appropriate environment variables must be set. The following scripts
319 @item @file{buildscripts/out/lilypond-profile}
321 @item @file{buildscripts/out/lilypond-login} (for C-shells)
324 They should normally be sourced as part of the login process. If these
325 scripts are not run from the system wide login process, then you must
328 @cindex installing LilyPond
330 If you use sh, bash, or a similar shell, then add the following to
331 your @file{.profile}:
333 . @var{/the/path/to/}lilypond-profile
336 If you use csh, tcsh or a similar shell, then add the following to
337 your @file{~/.login}:
339 source @var{/the/path/to/}lilypond-login
342 Of course, in both cases, you should substitute the proper location of
345 These scripts set the following variables:
348 To make sure that @TeX{} and lilypond find data files (among
349 others @file{.tex}, @file{.mf} and @file{.tfm}),
350 you have to set @code{TEXMF} to point to the lilypond data
351 file tree. A typical setting would be
353 @{/usr/share/lilypond/1.6.0,@{!!/usr/share/texmf@}@}
358 For processing PostScript output (obtained with
359 @code{-f ps}) with Ghostscript you have to set @code{GS_LIB} to
360 point to the directory containing library PS files.
363 For processing PostScript output (obtained with
364 @code{-f ps}) with Ghostscript you have to set @code{GS_FONTPATH} to
365 point to the directory containing PFA files.
367 When you print direct PS output, remember to send the PFA files to the
377 @cindex printing postscript
379 The binary itself recognizes the following environment variables:
382 This specifies a directory where locale messages and
383 data files will be looked up by default. The directory should contain
384 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
387 This selects the language for the warning messages.
391 @cindex LILYPONDPREFIX
394 @section Error messages
396 @cindex error messages
397 Different error messages can appear while compiling a file:
403 Something looks suspect. If you are requesting something out of the
404 ordinary then you will understand the message, and can ignore it.
405 However, warnings usually indicate that something is wrong with the
409 Something is definitely wrong. The current processing step (parsing,
410 interpreting, or formatting) will be finished, but the next step will
416 Something is definitely wrong, and LilyPond cannot continue. This
417 happens rarely. The most usual cause is misinstalled fonts.
422 Errors that occur while executing Scheme code are caught by the Scheme
423 interpreter. If running with the verbose option (@code{-V} or
424 @code{--verbose}) then a call trace is printed of the offending
427 @cindex Programming error
428 @item Programming error
429 There was some internal inconsistency. These error messages are
430 intended to help the programmers and debuggers. Usually, they can be
431 ignored. Sometimes, they come in such big quantities that they obscure
432 other output. In this case, a bug-report should be filed.
436 @cindex errors, message format
437 If warnings and errors can
438 be linked to some part of the input file, then error messages have the
442 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
443 @var{offending input line}
446 A line-break is inserted in offending line to indicate the column
447 where the error was found. For example,
450 test.ly:2:19: error: not a duration: 5:
457 @section Reporting bugs
460 @cindex reporting bugs
462 If you have input that results in a crash or an erroneous output, then
463 that is a bug. We try respond to bug-reports promptly, and fix them as
464 soon as possible. For this, we need to reproduce and isolate the
465 problem. Help us by sending a defective input file, so we can
466 reproduce the problem. Make it small, so we can easily debug the
467 problem. Don't forget to tell which version you use, and on which
468 platform you run it. Send the report to
469 @email{bug-lilypond@@gnu.org}.
472 @section Editor support
477 @cindex modes, editor
478 @cindex syntax coloring
479 @cindex coloring, syntax
481 There is support from different editors for LilyPond.
483 Emacs has a @file{lilypond-mode}, which provides keyword
484 autocompletion, indentation, LilyPond specific parenthesis matching
485 and syntax coloring, handy compile short-cuts and reading LilyPond
486 manuals using Info. If lilypond-mode is not installed on your
487 platform, then refer to the installation instructions for more
490 For @uref{http://www.vim.org,VIM}, a vimrc is supplied, along with
491 syntax coloring tools. For more information, refer to the
493 @uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
497 installation instructions.
500 For both editors, there is also a facility to jump in the input file
501 to the source of errors in the graphical output. See @ref{Point and
504 There exists a plugin for @uref{http://www.jedit.org/,jEdit}. Refer to
505 the @uref{http://lily4jedit.sourceforget.net,plugin website} for more
509 @node Point and click
510 @section Point and click
511 @cindex poind and click
513 Point and click lets you find notes in the input by clicking on them in
514 the Xdvi window. This makes it easier to find input that causes some
515 error in the sheet music.
517 To use it, you need the following software:
519 @item a dvi viewer that supports src specials:
521 @item Xdvi, version 22.36 or newer. Available from
522 @uref{ftp://ftp.math.berkeley.edu/pub/Software/TeX/xdvi.tar.gz,ftp.math.berkeley.edu}.
524 Most @TeX{} distributions ship with xdvik, which is always a few
525 versions behind the official Xdvi. To find out which Xdvi you are
526 running, try @code{xdvi -version} or @code{xdvi.bin -version}.
527 @item KDVI. A dvi viewer for KDE. You need KDVI from KDE 3.0 or
528 newer. Enable option @emph{Inverse search} in the menu @emph{Settings}.
530 Apparently, KDVI does not process PostScript specials correctly. Beams
531 and slurs will not be visible in KDVI.
540 @item an editor with a client/server interface (or a lightweight GUI
546 @item Emacs. Emacs is an extensible text-editor. It is available from
547 @uref{http://www.gnu.org/software/emacs/}. You need version 21 to use
550 @c move this elsewhere?
555 @cindex lilypond-mode for Emacs
556 @cindex syntax coloring
558 @item XEmacs. XEmacs is very similar to Emacs.
562 @item NEdit. NEdit runs under Windows, and Unix.
563 It is available from @uref{http://www.nedit.org}.
567 @item GVim. GVim is a GUI variant of VIM, the popular VI
568 clone. It is available from @uref{http://www.vim.org}.
577 Xdvi must be configured to find the @TeX{} fonts and music
578 fonts. Refer to the Xdvi documentation for more information.
580 To use point-and-click, add one of these lines to the top of your .ly
583 #(ly:set-point-and-click 'line)
585 @cindex line-location
587 When viewing, Control-Mousebutton 1 will take you to the originating
588 spot in the @file{.ly} file. Control-Mousebutton 2 will show all
591 If you correct large files with point-and-click, be sure to start
592 correcting at the end of the file. When you start at the top, and
593 insert one line, all following locations will be off by a line.
596 For using point-and-click with Emacs, add the following
597 In your Emacs startup file (usually @file{~/.emacs}):
602 Make sure that the environment variable @var{XEDITOR} is set to
604 emacsclient --no-wait +%l %f
606 @cindex @var{XEDITOR}
607 If you use XEmacs instead of Emacs, you use @code{(gnuserve-start)} in
608 your @file{.emacs}, and set @code{XEDITOR} to @code{gnuclient -q +%l %f}.
610 For using Vim, set @code{XEDITOR} to @code{gvim --remote +%l %f}, or
611 use this argument with Xdvi's @code{-editor} option.
614 For using NEdit, set @code{XEDITOR} to @code{nc -noask +%l %f}, or
615 use this argument with Xdvi's @code{-editor} option.
617 If can also make your editor jump to the exact location of the note
618 you clicked. This is only supported on Emacs and VIM. Users of Emacs version
619 20 must apply the patch @file{emacsclient.patch}. Users of version 21
620 must apply @file{server.el.patch} (version 21.2 and earlier). At the
621 top of the @code{ly} file, replace the @code{set-point-and-click} line
622 with the following line:
624 #(ly:set-point-and-click 'line-column)
626 @cindex line-colomn-location
627 and set @code{XEDITOR} to @code{emacsclient --no-wait +%l:%c %f}. Vim
628 users can set @var{XEDITOR} to @code{gvim --remote +:%l:norm%c| %f}.
634 When you convert the @TeX{} file to PostScript using @code{dvips}, it
635 will complain about not finding @code{src:X:Y} files. These complaints
636 are harmless, and can be ignored.