@node Invoking LilyPond
@chapter Invoking LilyPond
+This chapter details the technicalities of running LilyPond.
+
+
@menu
+* Invoking lilypond:: Titling LilyPond scores.
+* Invoking the lilypond binary::
+* Error messages::
* Reporting bugs::
-* Website::
+* Editor support::
* Point and click::
-* Invoking ly2dvi:: Titling LilyPond scores.
@end menu
+@node Invoking lilypond
+@section Invoking lilypond
+
+Nicely titled output is created through a separate program:
+@file{@code{lilypond}} is a script that uses the LilyPond formatting
+engine (which is in a separate program) and La@TeX{} to create a
+nicely titled piece of sheet music, in PDF (Portable Document Format)
+format.
+
+@example
+ @code{lilypond} [@var{option}]@dots{} @var{file}@dots{}
+@end example
+
+To have @code{lilypond} read from stdin, use a dash @code{-} for @var{file}.
+
+The @code{lilypond} program supports the following options:
+
+@table @code
+@item -k,--keep
+ Keep the temporary directory with all output
+files. The temporary directory is created in the current directory as @code{@code{lilypond}.dir}.
+@item -d,--dependencies
+ Write @code{Makefile} dependencies for every input file.
+@item -h,--help
+ Print usage help.
+@item -I,--include=@var{dir}
+ Add @var{dir} to LilyPond's include path.
+@item -m,--no-paper
+ Produce MIDI output only.
+@item --no-lily
+ Do not run @file{lilypond-bin}. Useful for debugging @code{lilypond}.
+@item -o,--output=@var{file}
+ Generate output to @var{file}. The extension of @var{file} is ignored.
+@item --no-pdf
+ Do not generate (PDF) or PS.
+
+@cindex PDF
+@cindex Scalable fonts
+
+@c why is this comment here? --hwn
+
+ If you use lilypond-book or your own wrapper files, do not use
+@code{\usepackage[[T1]@{fontenc@}} in the file header but do not forget
+@code{\usepackage[latin1]@{inputenc@}} if you use any other
+non-anglosaxian characters.
+
+@item --png
+ Also generate pictures of each page, in PNG format.
+@item --psgz
+ Gzip the postscript file.
+@item --html
+ Make a .HTML file with links to all output files.
+@item --preview
+ Also generate a picture of the first system of the score.
+
+@cindex preview
+@cindex picture
+@cindex bitmap
+@cindex pixmap
+@cindex thumbnail
+@cindex screenshot
+
+@item -s,--set=@var{key}=@var{val}
+ Add @var{key}= @var{val} to the settings, overriding those specified
+in the files. Possible keys: @code{language}, @code{latexheaders},
+@code{latexpackages}, @code{latexoptions}, @code{papersize},
+@code{pagenumber}, @code{linewidth}, @code{orientation},
+@code{textheight}.
+@item -v,--version
+Show version information.
+@item -V,--verbose
+Be verbose. This prints out commands as they are executed, and more
+information about the formatting process is printed.
+@item --debug
+Print even more information. This is useful when generating bugreports.
+@item -w,--warranty
+Show the warranty with which GNU LilyPond comes. (It comes with
+@strong{NO WARRANTY}!)
+@end table
+
+@subsection Titling layout
+
+@code{lilypond} extracts the following header fields from the LY files
+to generate titling; an example demonstrating all these fields is in
+@inputfileref{input/test,lilypond-testpage.ly}:
+
+@table @code
+@item title
+ The title of the music. Centered on top of the first page.
+@item subtitle
+ Subtitle, centered below the title.
+@item poet
+ Name of the poet, left flushed below the subtitle.
+@item composer
+ Name of the composer, right flushed below the subtitle.
+@item meter
+ Meter string, left flushed below the poet.
+@item opus
+ Name of the opus, right flushed below the composer.
+@item arranger
+ Name of the arranger, right flushed below the opus.
+@item instrument
+ Name of the instrument, centered below the arranger.
+@item dedication
+ To whom the piece is dedicated.
+@item piece
+ Name of the piece, left flushed below the instrument.
+@item head
+ A text to print in the header of all pages. It is not called
+@code{header}, because @code{\header} is a reserved word in LilyPond.
+@item copyright
+ A text to print in the footer of the first page. Default is to
+ print the standard footer also on the first page. Note that if the
+ score consists of only a single page, the first page is also the
+ last page, and in this case, the tagline is printed instead of the
+ copyright.
+@item footer
+ A text to print in the footer of all but the last page.
+@item tagline
+ Line to print at the bottom of last page. The default text is ``Engraved
+by LilyPond @var{version-number}''.
+@end table
+
+
+@cindex header
+@cindex footer
+@cindex page layout
+@cindex titles
+
+
+
+@subsection Additional parameters
+
+The @code{lilypond} program responds to several parameters specified
+in a @code{\paper} section of the input file. They can be overridden
+by supplying a @code{--set} command line option.
+
+@table @code
+@item language
+ Specify La@TeX{} language: the @code{babel} package will be
+included. Default: unset.
+
+ Read from the @code{\header} block.
+
+@item latexheaders
+ Specify additional La@TeX{} headers file.
+
+ Normally read from the @code{\header} block. Default value: empty.
+
+@item latexpackages
+ Specify additional La@TeX{} packages file. This works cumulative,
+so you can add multiple packages using multiple @code{-s=latexpackages} options.
+ Normally read from the @code{\header} block. Default value:
+@code{geometry}.
+
+@item latexoptions
+ Specify additional options for the La@TeX{}
+@code{\documentclass}. You can put any valid value here. This was
+designed to allow @code{lilypond} to produce output for double-sided
+paper, with balanced margins and pagenumbers on alternating sides. To
+achieve this specify @code{twoside}.
+
+@item orientation
+ Set orientation. Choices are @code{portrait} or @code{landscape}. Is
+read from the @code{\paper} block, if set.
+
+@item textheight
+ The vertical extension of the music on the page. It is normally
+ calculated automatically, based on the paper size.
+
+@item linewidth
+ The music line width. It is normally read from the @code{\paper}
+block.
+
+@item papersize
+ The paper size (as a name, e.g. @code{a4}). It is normally read from
+the @code{\paper} block.
+
+@item pagenumber
+ If set to @code{no}, no page numbers will be printed. If set to a
+positive integer, start with this value as the first page number.
+
+
+ @item fontenc
+ The font encoding, should be set identical to the @code{font-encoding}
+ property in the score.
+@end table
+
+
+
+@node Invoking the lilypond binary
+@section Invoking the lilypond binary
@cindex Invoking LilyPond
@cindex command line options
@cindex options, command line
@cindex switches
-Usage:
+
+The LilyPond system consists of two parts: a binary executable, which
+is responsible for the formatting functionality, and support scripts,
+which post-process the resulting output. Normally, the support scripts
+are called, which in turn invoke the @code{lilypond-bin}
+binary. However, @code{lilypond-bin} may be called directly as
+follows.
@example
- lilypond [@var{option}]@dots{} @var{file}@dots{}
+ lilypond-bin [@var{option}]@dots{} @var{file}@dots{}
@end example
starting with @file{filename-1.tex}. Several files can be specified;
they will each be processed independently. @footnote{The status of
GUILE is not reset across invocations, so be careful not to change any
- default settings from within Scheme .}
+ system defaults from within Scheme.}
@section Command line options
@c
@c
Output format for sheet music. Choices are @code{tex} (for @TeX{}
-output, to be processed with plain @TeX{}, or through ly2dvi),
+output, to be processed with plain @TeX{}, or through @code{lilypond}),
@code{pdftex} for PDF@TeX{} input, @code{ps} (for PostScript),
@code{scm} (for a Scheme dump), @code{sk} (for Sketch) and @code{as}
(for ASCII-art).
@end ignore
@item -v,--version
-Show version information
+Show version information.
@item -V,--verbose
Be verbose: show full paths of all files read, and give timing
information.
@cindex installing LilyPond
If you use sh, bash, or a similar shell, then add the following to
-your @file{.profile}
+your @file{.profile}:
@example
- . lilypond-profile
+ . @var{/the/path/to/}lilypond-profile
@end example
If you use csh, tcsh or a similar shell, then add the following to
-your @file{~/.login}
+your @file{~/.login}:
@example
- source lilypond-login
+ source @var{/the/path/to/}lilypond-login
@end example
-These scripts set the following variables
+Of course, in both cases, you should substitute the proper location of
+either script.
+
+These scripts set the following variables:
@table @code
@item TEXMF
To make sure that @TeX{} and lilypond find data files (among
@cindex TEXMF
@cindex printing postscript
-The binary itself recognizes the following environment variables
+The binary itself recognizes the following environment variables:
@table @code
@item LILYPONDPREFIX
This specifies a directory where locale messages and
subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
@item LANG
-This selects the language for the warning messages
+This selects the language for the warning messages.
@end table
@cindex LANG
@cindex LILYPONDPREFIX
+@node Error messages
+@section Error messages
+
+@cindex error messages
+Different error messages can appear while compiling a file:
+
+@table @emph
+@cindex warning
+
+@item Warning
+ Something looks suspect. If you are requesting something out of the
+ordinary then you will understand the message, and can ignore it.
+However, warnings usually indicate that something is wrong with the
+input file.
+
+@item Error
+Something is definitely wrong. The current processing step (parsing,
+interpreting, or formatting) will be finished, but the next step will
+be skipped.
+
+@cindex error
+@cindex fatal error
+@item Fatal error
+Something is definitely wrong, and LilyPond cannot continue. This
+happens rarely. The most usual cause is misinstalled fonts.
+
+@cindex call trace
+@cindex Scheme error
+@item Scheme error
+Errors that occur while executing Scheme code are caught by the Scheme
+interpreter. If running with the verbose option (@code{-V} or
+@code{--verbose}) then a call trace is printed of the offending
+function call.
+
+@cindex Programming error
+@item Programming error
+There was some internal inconsistency. These error messages are
+intended to help the programmers and debuggers. Usually, they can be
+ignored. Sometimes, they come in such big quantities that they obscure
+other output. In this case, a bug-report should be filed.
+@end table
-@cindex bugs
-@cindex reporting bugs
+@cindex errors, message format
+If warnings and errors can
+be linked to some part of the input file, then error messages have the
+following form
-@node Reporting bugs
-@section Reporting bugs
+@example
+ @var{filename}:@var{lineno}:@var{columnno}: @var{message}
+ @var{offending input line}
+@end example
-Since there is no finder's fee which doubles every year, there is no
-need to wait for the prize money to grow. Send a bug report today!
+A line-break is inserted in offending line to indicate the column
+where the error was found. For example,
-Development moves quickly, so if you have a problem, it is
-wise to check if it has been fixed in a newer release. If not, please
-send in a bugreport. When you send us a bugreport, we have to
-diagnose the problem and if necessary, duplicate it. To make this
-possible, it is important that you include the following information
-in your report:
+@example
+test.ly:2:19: error: not a duration: 5:
+ \notes @{ c'4 e'5
+ g' @}
+@end example
-@itemize @bullet
-@item A sample input which causes the error. Please have mercy on the
-developers, send a @emph{small} sample file.
+@node Reporting bugs
+@section Reporting bugs
-@item The version number
+@cindex bugs
+@cindex reporting bugs
-@item A description of the platform you use (i.e., operating system,
-system libraries, whether you downloaded a binary release)
+If you have input that results in a crash or an erroneous output, then
+that is a bug. We try respond to bug-reports promptly, and fix them as
+soon as possible. For this, we need to reproduce and isolate the
+problem. Help us by sending a defective input file, so we can
+reproduce the problem. Make it small, so we can easily debug the
+problem. Don't forget to tell which version you use, and on which
+platform you run it. Send the report to
+@email{bug-lilypond@@gnu.org}.
-@item If necessary, send a description of the bug itself. If you
-include output a ly2dvi run, please use @code{--debug} option of
-ly2dvi.
+@node Editor support
+@section Editor support
-@end itemize
+@cindex editors
+@cindex vim
+@cindex emacs
+@cindex modes, editor
+@cindex syntax coloring
+@cindex coloring, syntax
+
+There is support from different editors for LilyPond.
-You can send the report to @email{bug-lilypond@@gnu.org}. This is a
-mailinglist, but you do not have to be subscribed to it to post.
+Emacs has a @file{lilypond-mode}, which provides keyword
+autocompletion, indentation, LilyPond specific parenthesis matching
+and syntax coloring, handy compile short-cuts and reading LilyPond
+manuals using Info. If lilypond-mode is not installed on your
+platform, then refer to the installation instructions for more
+information.
-@node Website
-@section Website
+For @uref{http://www.vim.org,VIM}, a vimrc is supplied, along with
+syntax coloring tools. For more information, refer to the
+@ifhtml
+@uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
+@end ifhtml
-If you are reading this manual in print, it is possible that the
-website contains updates to the manual. You can find the website at
-@uref{http://www.lilypond.org/}.
+@ifnothtml
+installation instructions.
+@end ifnothtml
+For both editors, there is also a facility to jump in the input file
+to the source of errors in the graphical output. See @ref{Point and
+click}.
+
+There exists a plugin for @uref{http://www.jedit.org/,jEdit}. Refer to
+the @uref{http://lily4jedit.sourceforge.net,plugin website} for more
+information.
@node Point and click
@section Point and click
@cindex poind and click
+@cindex source specials
+@cindex specials, source
+
Point and click lets you find notes in the input by clicking on them in
the Xdvi window. This makes it easier to find input that causes some
error in the sheet music.
-To use it, you need the following software
+To use it, you need the following software:
@itemize @bullet
-@item A dvi viewer that supports src specials.
+@item a dvi viewer that supports src specials:
@itemize @bullet
@item Xdvi, version 22.36 or newer. Available from
@uref{ftp://ftp.math.berkeley.edu/pub/Software/TeX/xdvi.tar.gz,ftp.math.berkeley.edu}.
- Most @TeX{} distributions ship with xdvik, which is always
- a few versions behind the official Xdvi. To find out which Xdvi you
- are running, try @code{xdvi -version} or @code{xdvi.bin -version}.
+ Most @TeX{} distributions ship with xdvik, which is always a few
+versions behind the official Xdvi. To find out which Xdvi you are
+running, try @code{xdvi -version} or @code{xdvi.bin -version}.
@item KDVI. A dvi viewer for KDE. You need KDVI from KDE 3.0 or
newer. Enable option @emph{Inverse search} in the menu @emph{Settings}.
@end itemize
-@item An editor with a client/server interface (or a lightweight GUI
-editor).
+@item an editor with a client/server interface (or a lightweight GUI
+editor):
@cindex editor
@c move this elsewhere?
-There is also support for emacs: lilypond-mode for emacs provides
-keyword autocompletion, indentation, LilyPond specific parenthesis matching
-and syntax coloring, handy compile short-cuts and reading LilyPond manuals
-using Info. If lilypond-mode
-is not installed on your platform, then refer to the installation
-instructions for more information.
-@cindex emacs
-@cindex emacs mode
-@cindex lilypond-mode for emacs
+@cindex Emacs
+@cindex Emacs mode
+@cindex lilypond-mode for Emacs
@cindex syntax coloring
-@item XEmacs. Xemacs is very similar to emacs.
+@item XEmacs. XEmacs is very similar to Emacs.
@cindex XEmacs
fonts. Refer to the Xdvi documentation for more information.
To use point-and-click, add one of these lines to the top of your .ly
-file.
+file:
@example
#(ly:set-point-and-click 'line)
@end example
insert one line, all following locations will be off by a line.
@cindex Emacs
-For using point-and-click with emacs, add the following
-In your emacs startup file (usually @file{~/.emacs}),
+For using point-and-click with Emacs, add the following
+In your Emacs startup file (usually @file{~/.emacs}):
@example
(server-start)
@end example
emacsclient --no-wait +%l %f
@end example
@cindex @var{XEDITOR}
-If you use xemacs instead of emacs, you use @code{(gnuserve-start)} in
-your @file{.emacs}, and set @code{XEDITOR} to @code{gnuclient -q +%l %f}
+If you use XEmacs instead of Emacs, you use @code{(gnuserve-start)} in
+your @file{.emacs}, and set @code{XEDITOR} to @code{gnuclient -q +%l %f}.
For using Vim, set @code{XEDITOR} to @code{gvim --remote +%l %f}, or
use this argument with Xdvi's @code{-editor} option.
20 must apply the patch @file{emacsclient.patch}. Users of version 21
must apply @file{server.el.patch} (version 21.2 and earlier). At the
top of the @code{ly} file, replace the @code{set-point-and-click} line
-with the following line,
+with the following line:
@example
#(ly:set-point-and-click 'line-column)
@end example
-@node Invoking ly2dvi
-@section Invoking ly2dvi
-
-Nicely titled output is created through a separate program:
-@file{ly2dvi} is a script that uses LilyPond and La@TeX{} to create a
-nicely titled piece of sheet music, in DVI format or PostScript.
-
-@example
- ly2dvi [@var{option}]@dots{} @var{file}@dots{}
-@end example
-
-To have ly2dvi read from stdin, use a dash @code{-} for @var{file}.
-
-Ly2dvi supports the following options:
-
-@table @code
-@item -k,--keep
- Keep the temporary directory including LilyPond and ly2dvi output
-files. The temporary directory is created in the current directory as @code{ly2dvi.dir}.
-@item -d,--dependencies
- Write @code{Makefile} dependencies for every input file.
-@item -h,--help
- Print usage help.
-@item -I,--include=@var{dir}
- Add @var{dir} to LilyPond's include path.
-@item -m,--no-paper
- Produce MIDI output only.
-@item --no-lily
- Do not run LilyPond; useful for debugging ly2dvi.
-@item -o,--output=@var{file}
- Generate output to @var{file}. The extension of @var{file} is ignored.
-@item -P,--postscript
- Also generate PostScript output, using dvips. The postscript uses
-the standard @TeX{} bitmap fonts for your printer.
-@item -p,--pdf
- Also generate Portable Document Format (PDF). This option will
-generate a PS file using scalable fonts, and will run the PS file
-through @code{ps2pdf} producing a PDF file.
-
-@cindex PDF
-@cindex Scalable fonts
-
- If you use lilypond-book or your own wrapper files, do not use
-@code{\usepackage[[T1]@{fontenc@}} in the file header but do not forget
-@code{\usepackage[latin1]@{inputenc@}} if you use any other
-non-anglosaxian characters.
-
-@item --png
- Also generate pictures of each page, in PNG format.
-@item --psgz
- Gzip the postscript files
-@item --html
- Make a .HTML file with links to all output files.
-@item --preview
- Also generate a picture of the first system of the score.
-
-@cindex preview
-@cindex picture
-@cindex bitmap
-@cindex pixmap
-@cindex thumbnail
-@cindex screenshot
-
-@item -s,--set=@var{key}=@var{val}
- Add @var{key}= @var{val} to the settings, overriding those specified
-in the files. Possible keys: @code{language}, @code{latexheaders},
-@code{latexpackages}, @code{latexoptions}, @code{papersize},
-@code{pagenumber}, @code{linewidth}, @code{orientation},
-@code{textheight}.
-@item -v,--version
-Show version information .
-@item -V,--verbose
-Be verbose.
-@item --debug
-Print even more information. This is useful when generating bugreports.
-@item -w,--warranty
-Show the warranty with which GNU LilyPond comes. (It comes with
-@strong{NO WARRANTY}!)
-@end table
-
-@subsection Titling layout
-
-Ly2dvi extracts the following header fields from the LY files to
-generate titling. An example demonstrating all these fields is in
-@inputfileref{input/test,ly2dvi-testpage.ly}.
-
-@table @code
-@item title
- The title of the music. Centered on top of the first page.
-@item subtitle
- Subtitle, centered below the title.
-@item poet
- Name of the poet, left flushed below the subtitle.
-@item composer
- Name of the composer, right flushed below the subtitle.
-@item meter
- Meter string, left flushed below the poet.
-@item opus
- Name of the opus, right flushed below the composer.
-@item arranger
- Name of the arranger, right flushed below the opus.
-@item instrument
- Name of the instrument, centered below the arranger
-@item dedication
- To whom the piece is dedicated.
-@item piece
- Name of the piece, left flushed below the instrument
-@item head
- A text to print in the header of all pages. It is not called
-@code{header}, because @code{\header} is a reserved word in LilyPond.
-@item copyright
- A text to print in the footer of the first page. Default is to
- print the standard footer also on the first page.
-@item footer
- A text to print in the footer of all but the last page.
-@item tagline
- Line to print at the bottom of last page. The default text is ``Lily
-was here, @var{version-number}''.
-@end table
-
-
-@cindex header
-@cindex footer
-@cindex page layout
-@cindex titles
-
-
-
-@subsection Additional parameters
-
-Ly2dvi responds to several parameters specified in a @code{\paper}
-section of the input file. They can be overridden by supplying a
-@code{--set} command line option.
-
-@table @code
-@item language
- Specify La@TeX{} language: the @code{babel} package will be
-included. Default: unset.
-
- Read from the @code{\header} block.
-
-@item latexheaders
- Specify additional La@TeX{} headers file.
-
- Normally read from the @code{\header} block. Default value: empty
-
-@item latexpackages
- Specify additional La@TeX{} packages file. This works cumulative,
-so you can add multiple packages using multiple @code{-s=latexpackages} options.
- Normally read from the @code{\header} block. Default value:
-@code{geometry}.
-
-@item latexoptions
- Specify additional options for the La@TeX{}
-@code{\documentclass}. You can put any valid value here. This was
-designed to allow ly2dvi to produce output for double-sided paper,
-with balanced margins and pagenumbers on alternating sides. To achieve
-this specify @code{twoside}
-
-@item orientation
- Set orientation. Choices are @code{portrait} or @code{landscape}. Is
-read from the @code{\paper} block, if set.
-
-@item textheight
- The vertical extension of the music on the page. It is normally
- calculated automatically, based on the paper size.
-
-@item linewidth
- The music line width. It is normally read from the @code{\paper}
-block.
-
-@item papersize
- The paper size (as a name, e.g. @code{a4}). It is normally read from
-the @code{\paper} block.
-
-@item pagenumber
- If set to @code{no}, no page numbers will be printed. If set to a
-positive integer, start with this value as the first page number.
-
-
- @item fontenc
- The font encoding, should be set identical to the @code{font-encoding}
- property in the score.
-@end table
-
-
projects / lilypond.git / blobdiff