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::
16 @node Invoking lilypond
17 @section Invoking lilypond
19 Nicely titled output is created through a separate program:
20 @file{@code{lilypond}} is a script that uses the LilyPond formatting
21 engine (which is in a separate program) and La@TeX{} to create a
22 nicely titled piece of sheet music, in PDF (Portable Document Format)
26 @code{lilypond} [@var{option}]@dots{} @var{file}@dots{}
29 To have @code{lilypond} read from stdin, use a dash @code{-} for @var{file}.
31 The @code{lilypond} program supports the following options:
35 Keep the temporary directory with all output
36 files. The temporary directory is created in the current directory as @code{@code{lilypond}.dir}.
37 @item -d,--dependencies
38 Write @code{Makefile} dependencies for every input file.
41 @item -I,--include=@var{dir}
42 Add @var{dir} to LilyPond's include path.
44 Produce MIDI output only.
46 Do not run @file{lilypond-bin}. Useful for debugging @code{lilypond}.
47 @item -o,--output=@var{file}
48 Generate output to @var{file}. The extension of @var{file} is ignored.
50 Do not generate (PDF) or PS.
53 @cindex Scalable fonts
55 @c why is this comment here? --hwn
57 If you use lilypond-book or your own wrapper files, do not use
58 @code{\usepackage[[T1]@{fontenc@}} in the file header but do not forget
59 @code{\usepackage[latin1]@{inputenc@}} if you use any other
60 non-anglosaxian characters.
63 Also generate pictures of each page, in PNG format.
65 Gzip the postscript file.
67 Make a .HTML file with links to all output files.
69 Also generate a picture of the first system of the score.
78 @item -s,--set=@var{key}=@var{val}
79 Add @var{key}= @var{val} to the settings, overriding those specified
80 in the files. Possible keys: @code{language}, @code{latexheaders},
81 @code{latexpackages}, @code{latexoptions}, @code{papersize},
82 @code{pagenumber}, @code{linewidth}, @code{orientation},
85 Show version information.
89 Print even more information. This is useful when generating bugreports.
91 Show the warranty with which GNU LilyPond comes. (It comes with
92 @strong{NO WARRANTY}!)
95 @subsection Titling layout
97 @code{lilypond} extracts the following header fields from the LY files
98 to generate titling; an example demonstrating all these fields is in
99 @inputfileref{input/test,ly2dvi-testpage.ly}:
103 The title of the music. Centered on top of the first page.
105 Subtitle, centered below the title.
107 Name of the poet, left flushed below the subtitle.
109 Name of the composer, right flushed below the subtitle.
111 Meter string, left flushed below the poet.
113 Name of the opus, right flushed below the composer.
115 Name of the arranger, right flushed below the opus.
117 Name of the instrument, centered below the arranger.
119 To whom the piece is dedicated.
121 Name of the piece, left flushed below the instrument.
123 A text to print in the header of all pages. It is not called
124 @code{header}, because @code{\header} is a reserved word in LilyPond.
126 A text to print in the footer of the first page. Default is to
127 print the standard footer also on the first page.
129 A text to print in the footer of all but the last page.
131 Line to print at the bottom of last page. The default text is ``Lily
132 was here, @var{version-number}''.
143 @subsection Additional parameters
145 The @code{lilypond} program responds to several parameters specified
146 in a @code{\paper} section of the input file. They can be overridden
147 by supplying a @code{--set} command line option.
151 Specify La@TeX{} language: the @code{babel} package will be
152 included. Default: unset.
154 Read from the @code{\header} block.
157 Specify additional La@TeX{} headers file.
159 Normally read from the @code{\header} block. Default value: empty.
162 Specify additional La@TeX{} packages file. This works cumulative,
163 so you can add multiple packages using multiple @code{-s=latexpackages} options.
164 Normally read from the @code{\header} block. Default value:
168 Specify additional options for the La@TeX{}
169 @code{\documentclass}. You can put any valid value here. This was
170 designed to allow @code{lilypond} to produce output for double-sided
171 paper, with balanced margins and pagenumbers on alternating sides. To
172 achieve this specify @code{twoside}.
175 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
176 read from the @code{\paper} block, if set.
179 The vertical extension of the music on the page. It is normally
180 calculated automatically, based on the paper size.
183 The music line width. It is normally read from the @code{\paper}
187 The paper size (as a name, e.g. @code{a4}). It is normally read from
188 the @code{\paper} block.
191 If set to @code{no}, no page numbers will be printed. If set to a
192 positive integer, start with this value as the first page number.
196 The font encoding, should be set identical to the @code{font-encoding}
197 property in the score.
202 @node Invoking the lilypond binary
203 @section Invoking the lilypond binary
204 @cindex Invoking LilyPond
205 @cindex command line options
206 @cindex options, command line
210 The LilyPond system consists of two parts: a binary executable, which
211 is responsible for the formatting functionality, and support scripts,
212 which post-process the resulting output. Normally, the support scripts
213 are called, which in turn invoke the @code{lilypond-bin}
214 binary. However, @code{lilypond-bin} may be called directly as
218 lilypond-bin [@var{option}]@dots{} @var{file}@dots{}
222 When invoked with a filename that has no extension, the @file{.ly}
223 extension is tried first. To read input from stdin, use a
224 dash @code{-} for @var{file}.
226 When @file{filename.ly} is processed it will produce
227 @file{filename.tex} as output (or @file{filename.ps} for PostScript
228 output). If @file{filename.ly} contains more than one @code{\score}
229 block, then the rest of the scores will be output in numbered files,
230 starting with @file{filename-1.tex}. Several files can be specified;
231 they will each be processed independently. @footnote{The status of
232 GUILE is not reset across invocations, so be careful not to change any
233 system defaults from within Scheme.}
236 @section Command line options
238 The following options are supported:
242 @item -e,--evaluate=@var{expr}
243 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
244 Multiple @code{-e} options may be given, they will be evaluated
245 sequentially. The function @code{ly:set-option} allows for access to
246 some internal variables. Use @code{-e '(ly:option-usage')} for more
249 @item -f,--format=@var{format}
252 Output format for sheet music. Choices are @code{tex} (for @TeX{}
253 output, to be processed with plain @TeX{}, or through @code{lilypond}),
254 @code{pdftex} for PDF@TeX{} input, @code{ps} (for PostScript),
255 @code{scm} (for a Scheme dump), @code{sk} (for Sketch) and @code{as}
258 @strong{This option is only for developers}. Only the @TeX{} output of
259 these is usable for real work.
262 @cindex output format, setting
263 @cindex Sketch output
264 @cindex ASCII-art output
265 @cindex PDFTeX output
266 @cindex PostScript output
270 Show a summary of usage.
271 @item --include, -I=@var{directory}
272 Add @var{directory} to the search path for input files.
273 @cindex file searching
275 @item -i,--init=@var{file}
276 Set init file to @var{file} (default: @file{init.ly}).
279 Disable @TeX{} output. If you have a @code{\midi} definition MIDI output
281 @item -M,--dependencies
282 Output rules to be included in Makefile.
283 @item -o,--output=@var{FILE}
284 Set the default output file to @var{FILE}.
288 Disallow untrusted @code{\include} directives, in-line
289 Scheme evaluation, backslashes in @TeX{}, code.
291 @strong{WARNING}: the @code{--safe} option has not been reviewed for a
292 long time. Do not rely on it for automatic invocation (e.g. over the
293 web). Volunteers are welcome to do a new audit.
297 Show version information.
299 Be verbose: show full paths of all files read, and give timing
303 Show the warranty with which GNU LilyPond comes. (It comes with
304 @strong{NO WARRANTY}!)
307 @section Environment variables
310 For processing both the @TeX{} and the PostScript output, the
311 appropriate environment variables must be set. The following scripts
315 @item @file{buildscripts/out/lilypond-profile}
317 @item @file{buildscripts/out/lilypond-login} (for C-shells)
320 They should normally be sourced as part of the login process. If these
321 scripts are not run from the system wide login process, then you must
324 @cindex installing LilyPond
326 If you use sh, bash, or a similar shell, then add the following to
327 your @file{.profile}:
329 . @var{/the/path/to/}lilypond-profile
332 If you use csh, tcsh or a similar shell, then add the following to
333 your @file{~/.login}:
335 source @var{/the/path/to/}lilypond-login
338 Of course, in both cases, you should substitute the proper location of
341 These scripts set the following variables:
344 To make sure that @TeX{} and lilypond find data files (among
345 others @file{.tex}, @file{.mf} and @file{.tfm}),
346 you have to set @code{TEXMF} to point to the lilypond data
347 file tree. A typical setting would be
349 @{/usr/share/lilypond/1.6.0,@{!!/usr/share/texmf@}@}
354 For processing PostScript output (obtained with
355 @code{-f ps}) with Ghostscript you have to set @code{GS_LIB} to
356 point to the directory containing library PS files.
359 For processing PostScript output (obtained with
360 @code{-f ps}) with Ghostscript you have to set @code{GS_FONTPATH} to
361 point to the directory containing PFA files.
363 When you print direct PS output, remember to send the PFA files to the
373 @cindex printing postscript
375 The binary itself recognizes the following environment variables:
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.
387 @cindex LILYPONDPREFIX
390 @section Error messages
392 @cindex error messages
393 Different error messages can appear while compiling a file:
399 Something looks suspect. If you are requesting something out of the
400 ordinary then you will understand the message, and can ignore it.
401 However, warnings usually indicate that something is wrong with the
405 Something is definitely wrong. The current processing step (parsing,
406 interpreting, or formatting) will be finished, but the next step will
412 Something is definitely wrong, and LilyPond cannot continue. This
413 happens rarely. The most usual cause is misinstalled fonts.
418 Errors that occur while executing Scheme code are caught by the Scheme
419 interpreter. When they occur, a call trace of the offending function
422 @cindex Programming error
423 @item Programming error
424 There was some internal inconsistency. These error messages are
425 intended to help the programmers and debuggers. Usually, they can be
426 ignored. Sometimes, they come in such big quantities that they obscure
427 other output. In this case, a bug-report should be filed.
431 @cindex errors, message format
432 If warnings and errors can
433 be linked to some part of the input file, then error messages have the
437 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
438 @var{offending input line}
441 A line-break is inserted in offending line to indicate the column
442 where the error was found. For example,
445 test.ly:2:19: error: not a duration: 5:
452 @section Reporting bugs
455 @cindex reporting bugs
457 If you have input that results in a crash or an erroneous output, then
458 that is a bug. We try respond to bug-reports promptly, and fix them as
459 soon as possible. For this, we need to replicate and isolate the
460 problem. Please help us by sending a good bug-report: an input file
461 that will reproduce the problem. Please make it small, so we can
462 easily isolate the problem. Don't forget to tell which version you
463 use, and on which platform you run it. Send the report to
464 @email{bug-lilypond@@gnu.org}.
466 @node Point and click
467 @section Point and click
468 @cindex poind and click
470 Point and click lets you find notes in the input by clicking on them in
471 the Xdvi window. This makes it easier to find input that causes some
472 error in the sheet music.
474 To use it, you need the following software:
476 @item a dvi viewer that supports src specials:
478 @item Xdvi, version 22.36 or newer. Available from
479 @uref{ftp://ftp.math.berkeley.edu/pub/Software/TeX/xdvi.tar.gz,ftp.math.berkeley.edu}.
481 Most @TeX{} distributions ship with xdvik, which is always
482 a few versions behind the official Xdvi. To find out which Xdvi you
483 are running, try @code{xdvi -version} or @code{xdvi.bin -version}.
484 @item KDVI. A dvi viewer for KDE. You need KDVI from KDE 3.0 or
485 newer. Enable option @emph{Inverse search} in the menu @emph{Settings}.
487 Apparently, KDVI does not process PostScript specials correctly. Beams
488 and slurs will not be visible in KDVI.
497 @item an editor with a client/server interface (or a lightweight GUI
503 @item Emacs. Emacs is an extensible text-editor. It is available from
504 @uref{http://www.gnu.org/software/emacs/}. You need version 21 to use
507 @c move this elsewhere?
509 There is also support for Emacs: lilypond-mode for Emacs provides
510 keyword autocompletion, indentation, LilyPond specific parenthesis
511 matching and syntax coloring, handy compile short-cuts and reading
512 LilyPond manuals using Info. If lilypond-mode is not installed on
513 your platform, then refer to the installation instructions for more
518 @cindex lilypond-mode for Emacs
519 @cindex syntax coloring
521 @item XEmacs. XEmacs is very similar to Emacs.
525 @item NEdit. NEdit runs under Windows, and Unix.
526 It is available from @uref{http://www.nedit.org}.
530 @item GVim. GVim is a GUI variant of VIM, the popular VI
531 clone. It is available from @uref{http://www.vim.org}.
540 Xdvi must be configured to find the @TeX{} fonts and music
541 fonts. Refer to the Xdvi documentation for more information.
543 To use point-and-click, add one of these lines to the top of your .ly
546 #(ly:set-point-and-click 'line)
548 @cindex line-location
550 When viewing, Control-Mousebutton 1 will take you to the originating
551 spot in the @file{.ly} file. Control-Mousebutton 2 will show all
554 If you correct large files with point-and-click, be sure to start
555 correcting at the end of the file. When you start at the top, and
556 insert one line, all following locations will be off by a line.
559 For using point-and-click with Emacs, add the following
560 In your Emacs startup file (usually @file{~/.emacs}):
565 Make sure that the environment variable @var{XEDITOR} is set to
567 emacsclient --no-wait +%l %f
569 @cindex @var{XEDITOR}
570 If you use XEmacs instead of Emacs, you use @code{(gnuserve-start)} in
571 your @file{.emacs}, and set @code{XEDITOR} to @code{gnuclient -q +%l %f}.
573 For using Vim, set @code{XEDITOR} to @code{gvim --remote +%l %f}, or
574 use this argument with Xdvi's @code{-editor} option.
577 For using NEdit, set @code{XEDITOR} to @code{nc -noask +%l %f}, or
578 use this argument with Xdvi's @code{-editor} option.
580 If can also make your editor jump to the exact location of the note
581 you clicked. This is only supported on Emacs and VIM. Users of Emacs version
582 20 must apply the patch @file{emacsclient.patch}. Users of version 21
583 must apply @file{server.el.patch} (version 21.2 and earlier). At the
584 top of the @code{ly} file, replace the @code{set-point-and-click} line
585 with the following line:
587 #(ly:set-point-and-click 'line-column)
589 @cindex line-colomn-location
590 and set @code{XEDITOR} to @code{emacsclient --no-wait +%l:%c %f}. Vim
591 users can set @var{XEDITOR} to @code{gvim --remote +:%l:norm%c| %f}.
597 When you convert the @TeX{} file to PostScript using @code{dvips}, it
598 will complain about not finding @code{src:X:Y} files. These complaints
599 are harmless, and can be ignored.