2 @node Invoking LilyPond
3 @chapter Invoking LilyPond
5 This chapter details the technicalities of running LilyPond.
9 * Invoking the lilypond binary::
13 * Invoking ly2dvi:: Titling LilyPond scores.
18 @node Invoking the lilypond binary
19 @section Invoking the lilypond binary
20 @cindex Invoking LilyPond
21 @cindex command line options
22 @cindex options, command line
26 The LilyPond system consists of two parts: a binary executable, which
27 is responsible for the formatting functionality, and support scripts,
28 which post-process the resulting output. Normally, the support scripts
29 are called, which in turn invoke the @code{lilypond} binary. However,
30 @code{lilypond} may be called directly as follows.
33 lilypond [@var{option}]@dots{} @var{file}@dots{}
37 When invoked with a filename that has no extension, the @file{.ly}
38 extension is tried first. To read input from stdin, use a
39 dash @code{-} for @var{file}.
41 When @file{filename.ly} is processed it will produce
42 @file{filename.tex} as output (or @file{filename.ps} for PostScript
43 output). If @file{filename.ly} contains more than one @code{\score}
44 block, then the rest of the scores will be output in numbered files,
45 starting with @file{filename-1.tex}. Several files can be specified;
46 they will each be processed independently. @footnote{The status of
47 GUILE is not reset across invocations, so be careful not to change any
48 default settings from within Scheme.}
51 @section Command line options
53 The following options are supported:
57 @item -e,--evaluate=@var{expr}
58 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
59 Multiple @code{-e} options may be given, they will be evaluated
60 sequentially. The function @code{ly:set-option} allows for access to
61 some internal variables. Use @code{-e '(ly:option-usage')} for more
64 @item -f,--format=@var{format}
67 Output format for sheet music. Choices are @code{tex} (for @TeX{}
68 output, to be processed with plain @TeX{}, or through ly2dvi),
69 @code{pdftex} for PDF@TeX{} input, @code{ps} (for PostScript),
70 @code{scm} (for a Scheme dump), @code{sk} (for Sketch) and @code{as}
73 @strong{This option is only for developers}. Only the @TeX{} output of
74 these is usable for real work.
77 @cindex output format, setting
79 @cindex ASCII-art output
81 @cindex PostScript output
85 Show a summary of usage.
86 @item --include, -I=@var{directory}
87 Add @var{directory} to the search path for input files.
88 @cindex file searching
90 @item -i,--init=@var{file}
91 Set init file to @var{file} (default: @file{init.ly}).
94 Disable @TeX{} output. If you have a @code{\midi} definition MIDI output
96 @item -M,--dependencies
97 Output rules to be included in Makefile.
98 @item -o,--output=@var{FILE}
99 Set the default output file to @var{FILE}.
103 Disallow untrusted @code{\include} directives, in-line
104 Scheme evaluation, backslashes in @TeX{}, code.
106 @strong{WARNING}: the @code{--safe} option has not been reviewed for a
107 long time. Do not rely on it for automatic invocation (e.g. over the
108 web). Volunteers are welcome to do a new audit.
112 Show version information.
114 Be verbose: show full paths of all files read, and give timing
118 Show the warranty with which GNU LilyPond comes. (It comes with
119 @strong{NO WARRANTY}!)
122 @section Environment variables
125 For processing both the @TeX{} and the PostScript output, the
126 appropriate environment variables must be set. The following scripts
130 @item @file{buildscripts/out/lilypond-profile}
132 @item @file{buildscripts/out/lilypond-login} (for C-shells)
135 They should normally be sourced as part of the login process. If these
136 scripts are not run from the system wide login process, then you must
139 @cindex installing LilyPond
141 If you use sh, bash, or a similar shell, then add the following to
142 your @file{.profile}:
144 . @var{/the/path/to/}lilypond-profile
147 If you use csh, tcsh or a similar shell, then add the following to
148 your @file{~/.login}:
150 source @var{/the/path/to/}lilypond-login
153 Of course, in both cases, you should substitute the proper location of
156 These scripts set the following variables:
159 To make sure that @TeX{} and lilypond find data files (among
160 others @file{.tex}, @file{.mf} and @file{.tfm}),
161 you have to set @code{TEXMF} to point to the lilypond data
162 file tree. A typical setting would be
164 @{/usr/share/lilypond/1.6.0,@{!!/usr/share/texmf@}@}
169 For processing PostScript output (obtained with
170 @code{-f ps}) with Ghostscript you have to set @code{GS_LIB} to
171 point to the directory containing library PS files.
174 For processing PostScript output (obtained with
175 @code{-f ps}) with Ghostscript you have to set @code{GS_FONTPATH} to
176 point to the directory containing PFA files.
178 When you print direct PS output, remember to send the PFA files to the
188 @cindex printing postscript
190 The binary itself recognizes the following environment variables:
193 This specifies a directory where locale messages and
194 data files will be looked up by default. The directory should contain
195 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
198 This selects the language for the warning messages.
202 @cindex LILYPONDPREFIX
205 @section Error messages
207 @cindex error messages
208 Different error messages can appear while compiling a file:
214 Something looks suspect. If you are requesting something out of the
215 ordinary then you will understand the message, and can ignore it.
216 However, warnings usually indicate that something is wrong with the
220 Something is definitely wrong. The current processing step (parsing,
221 interpreting, or formatting) will be finished, but the next step will
227 Something is definitely wrong, and LilyPond cannot continue. This
228 happens rarely. The most usual cause is misinstalled fonts.
233 Errors that occur while executing Scheme code are caught by the Scheme
234 interpreter. When they occur, a call trace of the offending function
237 @cindex Programming error
238 @item Programming error
239 There was some internal inconsistency. These error messages are
240 intended to help the programmers and debuggers. Usually, they can be
241 ignored. Sometimes, they come in such big quantities that they obscure
242 other output. In this case, a bug-report should be filed.
246 @cindex errors, message format
247 If warnings and errors can
248 be linked to some part of the input file, then error messages have the
252 @var{filename}:@var{lineno}:@var{columnno}: @var{message}
253 @var{offending input line}
256 A line-break is inserted in offending line to indicate the column
257 where the error was found. For example,
260 test.ly:2:19: error: not a duration: 5:
267 @section Reporting bugs
270 @cindex reporting bugs
272 If you have input that results in a crash or an erroneous output, then
273 that is a bug. We try respond to bug-reports promptly, and fix them as
274 soon as possible. For this, we need to replicate and isolate the
275 problem. Please help us by sending a good bug-report: an input file
276 that will reproduce the problem. Please make it small, so we can
277 easily isolate the problem. Don't forget to tell which version you
278 use, and on which platform you run it. Send the report to
279 @email{bug-lilypond@@gnu.org}.
281 @node Point and click
282 @section Point and click
283 @cindex poind and click
285 Point and click lets you find notes in the input by clicking on them in
286 the Xdvi window. This makes it easier to find input that causes some
287 error in the sheet music.
289 To use it, you need the following software:
291 @item a dvi viewer that supports src specials:
293 @item Xdvi, version 22.36 or newer. Available from
294 @uref{ftp://ftp.math.berkeley.edu/pub/Software/TeX/xdvi.tar.gz,ftp.math.berkeley.edu}.
296 Most @TeX{} distributions ship with xdvik, which is always
297 a few versions behind the official Xdvi. To find out which Xdvi you
298 are running, try @code{xdvi -version} or @code{xdvi.bin -version}.
299 @item KDVI. A dvi viewer for KDE. You need KDVI from KDE 3.0 or
300 newer. Enable option @emph{Inverse search} in the menu @emph{Settings}.
302 Apparently, KDVI does not process PostScript specials correctly. Beams
303 and slurs will not be visible in KDVI.
312 @item an editor with a client/server interface (or a lightweight GUI
318 @item Emacs. Emacs is an extensible text-editor. It is available from
319 @uref{http://www.gnu.org/software/emacs/}. You need version 21 to use
322 @c move this elsewhere?
324 There is also support for Emacs: lilypond-mode for Emacs provides
325 keyword autocompletion, indentation, LilyPond specific parenthesis
326 matching and syntax coloring, handy compile short-cuts and reading
327 LilyPond manuals using Info. If lilypond-mode is not installed on
328 your platform, then refer to the installation instructions for more
333 @cindex lilypond-mode for Emacs
334 @cindex syntax coloring
336 @item XEmacs. XEmacs is very similar to Emacs.
340 @item NEdit. NEdit runs under Windows, and Unix.
341 It is available from @uref{http://www.nedit.org}.
345 @item GVim. GVim is a GUI variant of VIM, the popular VI
346 clone. It is available from @uref{http://www.vim.org}.
355 Xdvi must be configured to find the @TeX{} fonts and music
356 fonts. Refer to the Xdvi documentation for more information.
358 To use point-and-click, add one of these lines to the top of your .ly
361 #(ly:set-point-and-click 'line)
363 @cindex line-location
365 When viewing, Control-Mousebutton 1 will take you to the originating
366 spot in the @file{.ly} file. Control-Mousebutton 2 will show all
369 If you correct large files with point-and-click, be sure to start
370 correcting at the end of the file. When you start at the top, and
371 insert one line, all following locations will be off by a line.
374 For using point-and-click with Emacs, add the following
375 In your Emacs startup file (usually @file{~/.emacs}):
380 Make sure that the environment variable @var{XEDITOR} is set to
382 emacsclient --no-wait +%l %f
384 @cindex @var{XEDITOR}
385 If you use XEmacs instead of Emacs, you use @code{(gnuserve-start)} in
386 your @file{.emacs}, and set @code{XEDITOR} to @code{gnuclient -q +%l %f}.
388 For using Vim, set @code{XEDITOR} to @code{gvim --remote +%l %f}, or
389 use this argument with Xdvi's @code{-editor} option.
392 For using NEdit, set @code{XEDITOR} to @code{nc -noask +%l %f}, or
393 use this argument with Xdvi's @code{-editor} option.
395 If can also make your editor jump to the exact location of the note
396 you clicked. This is only supported on Emacs and VIM. Users of Emacs version
397 20 must apply the patch @file{emacsclient.patch}. Users of version 21
398 must apply @file{server.el.patch} (version 21.2 and earlier). At the
399 top of the @code{ly} file, replace the @code{set-point-and-click} line
400 with the following line:
402 #(ly:set-point-and-click 'line-column)
404 @cindex line-colomn-location
405 and set @code{XEDITOR} to @code{emacsclient --no-wait +%l:%c %f}. Vim
406 users can set @var{XEDITOR} to @code{gvim --remote +:%l:norm%c| %f}.
412 When you convert the @TeX{} file to PostScript using @code{dvips}, it
413 will complain about not finding @code{src:X:Y} files. These complaints
414 are harmless, and can be ignored.
418 @node Invoking ly2dvi
419 @section Invoking ly2dvi
421 Nicely titled output is created through a separate program:
422 @file{ly2dvi} is a script that uses LilyPond and La@TeX{} to create a
423 nicely titled piece of sheet music, in DVI format or PostScript:
426 ly2dvi [@var{option}]@dots{} @var{file}@dots{}
429 To have ly2dvi read from stdin, use a dash @code{-} for @var{file}.
431 Ly2dvi supports the following options:
435 Keep the temporary directory including LilyPond and ly2dvi output
436 files. The temporary directory is created in the current directory as @code{ly2dvi.dir}.
437 @item -d,--dependencies
438 Write @code{Makefile} dependencies for every input file.
441 @item -I,--include=@var{dir}
442 Add @var{dir} to LilyPond's include path.
444 Produce MIDI output only.
446 Do not run LilyPond; useful for debugging ly2dvi.
447 @item -o,--output=@var{file}
448 Generate output to @var{file}. The extension of @var{file} is ignored.
449 @item -P,--postscript
450 Also generate PostScript output, using dvips. The postscript uses
451 the standard @TeX{} bitmap fonts for your printer.
453 Also generate Portable Document Format (PDF). This option will
454 generate a PS file using scalable fonts, and will run the PS file
455 through @code{ps2pdf} producing a PDF file.
458 @cindex Scalable fonts
460 If you use lilypond-book or your own wrapper files, do not use
461 @code{\usepackage[[T1]@{fontenc@}} in the file header but do not forget
462 @code{\usepackage[latin1]@{inputenc@}} if you use any other
463 non-anglosaxian characters.
466 Also generate pictures of each page, in PNG format.
468 Gzip the postscript file.
470 Make a .HTML file with links to all output files.
472 Also generate a picture of the first system of the score.
481 @item -s,--set=@var{key}=@var{val}
482 Add @var{key}= @var{val} to the settings, overriding those specified
483 in the files. Possible keys: @code{language}, @code{latexheaders},
484 @code{latexpackages}, @code{latexoptions}, @code{papersize},
485 @code{pagenumber}, @code{linewidth}, @code{orientation},
488 Show version information.
492 Print even more information. This is useful when generating bugreports.
494 Show the warranty with which GNU LilyPond comes. (It comes with
495 @strong{NO WARRANTY}!)
498 @subsection Titling layout
500 Ly2dvi extracts the following header fields from the LY files to
501 generate titling; an example demonstrating all these fields is in
502 @inputfileref{input/test,ly2dvi-testpage.ly}:
506 The title of the music. Centered on top of the first page.
508 Subtitle, centered below the title.
510 Name of the poet, left flushed below the subtitle.
512 Name of the composer, right flushed below the subtitle.
514 Meter string, left flushed below the poet.
516 Name of the opus, right flushed below the composer.
518 Name of the arranger, right flushed below the opus.
520 Name of the instrument, centered below the arranger.
522 To whom the piece is dedicated.
524 Name of the piece, left flushed below the instrument.
526 A text to print in the header of all pages. It is not called
527 @code{header}, because @code{\header} is a reserved word in LilyPond.
529 A text to print in the footer of the first page. Default is to
530 print the standard footer also on the first page.
532 A text to print in the footer of all but the last page.
534 Line to print at the bottom of last page. The default text is ``Lily
535 was here, @var{version-number}''.
546 @subsection Additional parameters
548 Ly2dvi responds to several parameters specified in a @code{\paper}
549 section of the input file. They can be overridden by supplying a
550 @code{--set} command line option.
554 Specify La@TeX{} language: the @code{babel} package will be
555 included. Default: unset.
557 Read from the @code{\header} block.
560 Specify additional La@TeX{} headers file.
562 Normally read from the @code{\header} block. Default value: empty.
565 Specify additional La@TeX{} packages file. This works cumulative,
566 so you can add multiple packages using multiple @code{-s=latexpackages} options.
567 Normally read from the @code{\header} block. Default value:
571 Specify additional options for the La@TeX{}
572 @code{\documentclass}. You can put any valid value here. This was
573 designed to allow ly2dvi to produce output for double-sided paper,
574 with balanced margins and pagenumbers on alternating sides. To achieve
575 this specify @code{twoside}.
578 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
579 read from the @code{\paper} block, if set.
582 The vertical extension of the music on the page. It is normally
583 calculated automatically, based on the paper size.
586 The music line width. It is normally read from the @code{\paper}
590 The paper size (as a name, e.g. @code{a4}). It is normally read from
591 the @code{\paper} block.
594 If set to @code{no}, no page numbers will be printed. If set to a
595 positive integer, start with this value as the first page number.
599 The font encoding, should be set identical to the @code{font-encoding}
600 property in the score.