This chapter details the technicalities of running LilyPond.
-
+
@menu
-* Invoking lilypond::
-* Error messages::
-* Reporting bugs::
-* Editor support::
-* Invoking lilypond-latex::
+* Invoking lilypond::
+* Error messages::
+* Updating files with convert-ly::
+* Reporting bugs::
+* Editor support::
@end menu
@node Invoking lilypond
@cindex switches
-The @code{lilypond} may be called as follows from the command line.
+The @code{lilypond} executable may be called as follows from the command line.
@example
- lilypond [@var{option}]@dots{} @var{file}@dots{}
+lilypond [@var{option}]@dots{} @var{file}@dots{}
@end example
When invoked with a filename that has no extension, the @file{.ly}
extension is tried first. To read input from stdin, use a
-dash @code{-} for @var{file}.
+dash (@code{-}) for @var{file}.
When @file{filename.ly} is processed it will produce
@file{filename.tex} as output (or @file{filename.ps} for PostScript
block, then the rest of the scores will be output in numbered files,
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 after processing a @code{.ly} files, so be careful
+GUILE is not reset after processing a @code{.ly} file, so be careful
not to change any system defaults from within Scheme.}
@item -e,--evaluate=@var{expr}
Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
Multiple @code{-e} options may be given, they will be evaluated
-sequentially. The function @code{ly:set-option} allows for access to
+sequentially. The function @code{ly:set-option} allows access to
some internal variables. Use @code{-e '(ly:option-usage)'} for more
information.
@item -f,--format=@var{format}
-@c
-@c
-A comma separated list of back-end output formats to use. Choices are
-@code{tex} (for @TeX{} output, to be processed with La@TeX{}, and
-@code{ps} for PostScript.
-
-There are other output options, but they are intended for developers.
-
+which formats should be written. Choices are @code{svg}, @code{ps},
+@code{pdf}, @code{png}, @code{tex}, @code{dvi}.
-@cindex output format, setting
+@item -b,--backend=@var{format}
+the output format to use for the back-end. Choices are
+@table @code
+@item tex
+for @TeX{} output, to be processed with La@TeX{}. If present, the file
+@file{file.textmetrics} is read to determine text extents.
+@item texstr
+dump text strings to @file{.texstr} file, which can be run through
+(La)@TeX{}, resulting in a @code{.textmetrics} file, which contains the
+extents of strings of text.
+@item ps
+ for PostScript.
@cindex PostScript output
+
+ Postscript files include TTF, Type1 and OTF fonts. No subsetting of
+ these fonts is done. When using oriental character sets, this can
+ lead to huge files.
+
+@item eps
+ for encapsulated PostScript. This dumps every page (system) as a separate
+@file{EPS} file, without fonts, and as one collated @file{EPS} file with
+all pages (systems) including fonts.
+
+This mode is used by default by lilypond-book.
+
+@item svg
+ for SVG (Scalable Vector Graphics)
+@cindex SVG (Scalable Vector Graphics)
+@item scm
+ for a dump of the raw, internal Scheme-based drawing commands.
@cindex Scheme dump
+@end table
+
+@cindex output format, setting
@item -h,--help
Show a summary of usage.
+
@item --include, -I=@var{directory}
Add @var{directory} to the search path for input files.
@cindex file searching
@cindex search path
+
@item -i,--init=@var{file}
Set init file to @var{file} (default: @file{init.ly}).
+
@item -o,--output=@var{FILE}
- Set the default output file to @var{FILE}.
+Set the default output file to @var{FILE}. The appropriate
+suffix will be added (ie @code{.pdf} for pdf, @code{.tex}
+for tex, etc).
+
@item --ps
- Generate PostScript.
+Generate PostScript.
+
@item --dvi
- Generate DVI files. In this case, the @TeX{} backend should be
- specified, i.e. @code{-f tex}.
+Generate DVI files. In this case, the @TeX{} backend should be
+specified, i.e., @code{-f tex}.
+
@item --png
- Generate pictures of each page, in PNG format. This implies @code{--ps}.
+Generate pictures of each page, in PNG format. This implies @code{--ps}.
+
@item --pdf
- Generate PDF. This implies @code{--ps}.
+Generate PDF. This implies @code{--ps}.
+
@item --preview
- Generate an output file containing the titles and the first system
-of the score.
+Generate an output file containing the titles and the first system
+
+@item --no-pages
+Do not generate the full pages. Useful in combination with
+@code{--preview}.
@item -s,--safe
-Do not trust the @code{.ly} input.
+Do not trust the @code{.ly} input.
When LilyPond formatting is available through a web server, the
@code{--safe} @b{MUST} be passed. This will prevent inline Scheme
-code from wreaking havoc, for example
+code from wreaking havoc, for example
+@quotation
@verbatim
- #(system "rm -rf /")
- {
- c4^#(ly:export (ly:gulp-file "/etc/passwd"))
- }
+#(system "rm -rf /")
+{
+ c4^#(ly:export (ly:gulp-file "/etc/passwd"))
+}
@end verbatim
+@end quotation
The @code{--safe} option works by evaluating in-line Scheme
expressions in a special safe module. This safe module is derived from
GUILE @file{safe-r5rs} module, but adds a number of functions of the
-LilyPond API. These functions are listed in @file{scm/safe-lily.scm}.
+LilyPond API. These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
In addition, @code{--safe} disallows @code{\include} directives and
disables the use of backslashes in @TeX{} strings.
In @code{--safe} mode, it is not possible to import LilyPond variables
-into Scheme.
+into Scheme.
+
+@code{--safe} does @emph{not} detect resource overuse. It is still
+possible to make the program hang indefinitely, for example by feeding
+cyclic data structures into the backend. Therefore, if using LilyPond
+on a publicly accessible webserver, the process should be limited in
+both CPU and memory usage.
@item -v,--version
Show version information.
+
@item -V,--verbose
Be verbose: show full paths of all files read, and give timing
information.
@item -w,--warranty
-Show the warranty with which GNU LilyPond comes. (It comes with
+Show the warranty with which GNU LilyPond comes. (It comes with
@strong{NO WARRANTY}!)
@end table
-@section Environment variables
+@section Environment variables
For processing both the @TeX{} and the PostScript output, the
appropriate environment variables must be set. The following scripts
do this:
@itemize @bullet
-@item @file{buildscripts/out/lilypond-profile}
+@item @file{buildscripts/@/out/@/lilypond@/-profile}
(for SH shells)
-@item @file{buildscripts/out/lilypond-login} (for C-shells)
+@item @file{buildscripts/@/out/@/lilypond@/-login} (for C-shells)
@end itemize
They should normally be sourced as part of the login process. If these
scripts are not run from the system wide login process, then you must
-run it yourself.
+run them yourself.
@cindex installing LilyPond
If you use sh, bash, or a similar shell, then add the following to
your @file{.profile}:
@example
- . @var{/the/path/to/}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}:
@example
- source @var{/the/path/to/}lilypond-login
+source @var{/the/path/to/}lilypond-login
@end example
Of course, in both cases, you should substitute the proper location of
These scripts set the following variables:
@table @code
@item TEXMF
- To make sure that @TeX{} and lilypond find data files (among
-others @file{.tex}, @file{.mf} and @file{.tfm}),
+To make sure that @TeX{} and lilypond find data files (among
+others @file{.tex}, @file{.mf}, and @file{.tfm}),
you have to set @code{TEXMF} to point to the lilypond data
file tree. A typical setting would be
@example
-@{/usr/share/lilypond/1.6.0,@{!!/usr/share/texmf@}@}
+@{/usr/share/lilypond/2.4.0,@{!!/usr/share/texmf@}@}
@end example
@end table
@cindex warning
@item Warning
- Something looks suspect. If you are requesting something out of the
+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 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.
+@code{--verbose}) then a call trace of the offending
+function call is printed.
@cindex Programming error
@item Programming error
@item Aborted (core dumped)
This signals a serious programming error that caused the program to
crash. Such errors are considered critical. If you stumble on one,
-send a bugreport.
+send a bug-report.
@end table
following form
@example
- @var{filename}:@var{lineno}:@var{columnno}: @var{message}
- @var{offending input line}
-@end example
+@var{filename}:@var{lineno}:@var{columnno}: @var{message}
+@var{offending input line}
+@end example
-A line-break is inserted in offending line to indicate the column
-where the error was found. For example,
+A line-break is inserted in the offending line to indicate the column
+where the error was found. For example,
@example
test.ly:2:19: error: not a duration: 5:
- @{ c'4 e'5
+ @{ c'4 e'5
g' @}
@end example
These locations are LilyPond's best guess about where the warning or
-error occured, but (by their very nature) warning and errors occur
+error occured, but (by their very nature) warnings and errors occur
when something unexpected happens. If you can't see an error in the
indicated line of your input file, try checking one or two lines
above the indicated position.
+@node Updating files with convert-ly
+@section Updating with @command{convert-ly}
+
+The LilyPond input syntax is routinely changed to simplify it or improve
+it in different ways. As a side effect of this, the LilyPond interpreter
+often is no longer compatible with older input files. To remedy this,
+the program @command{convert-ly} can be used to deal with most of the
+syntax changes between LilyPond versions.
+
+It uses @code{\version} statements in the input files to detect the old
+version number. In most cases, to upgrade your input file it is sufficient
+to run
+
+@example
+covert-ly -e myfile.ly
+@end example
+
+If there are no changes to myfile.ly and file called myfile.ly.NEW
+is created, then myfile.ly is already updated.
+
+To upgrade LilyPond fragments in texinfo files, use
+
+@example
+convert-ly --from=... --to=... --no-version *.itely
+@end example
+
+In general, the program is invoked as follows:
+
+@example
+convert-ly [@var{option}]@dots{} @var{file}@dots{}
+@end example
+
+
+The following options can be given:
+
+@table @code
+@item -e,--edit
+Do an inline edit of the input file. Overrides @code{--output}.
+
+@item -f,--from=@var{from-patchlevel}
+Set the version to convert from. If this is not set, @command{convert-ly}
+will guess this, on the basis of @code{\version} strings in the file.
+
+@item -o,--output=@var{file}
+Set the output file to write.
+
+@item -n,--no-version
+Normally, @command{convert-ly} adds a @code{\version} indicator
+to the output. Specifying this option suppresses this.
+
+@item -s, --show-rules
+Show all known conversions and exit.
+
+@item --to=@var{to-patchlevel}
+Set the goal version of the conversion. It defaults to the latest
+available version.
+
+@item -h, --help
+Print usage help.
+@end table
+
+@command{convert-ly} always converts up to the last syntax change handled by
+it. This means that the @code{\version} number left in the file is
+usually lower than the version of @command{convert-ly} itself.
+
+@refbugs
+
+Not all language changes are handled. Only one output option can be
+specified.
+
+
+@c We might want to make this a completely new section, along with more
+@c info about how to upgrade old input files. -gp
+
+@ignore
+Copy and paste from CVS, last updated
+Feb 14, 2005
+
+http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/lilypond/lily-bugs/bugs/convert-ly.txt?rev=HEAD&content-type=text/plain
+@end ignore
+@verbatim
+
+There are a few things that the convert-ly cannot handle. Here's a list of limitations
+that the community has complained about.
+
+This bug report structure has been chosen because convert-ly has a structure that doesn't
+allow to smoothly implement all needed changes. Thus this is just a wishlist, placed
+here for reference.
+
+1.6->2.0:
+ Doesn't always convert figured bass correctly, specifically things like {< >}. Mats' comment on working around this:
+ To be able to run convert-ly
+ on it, I first replaced all occurencies of '{<' to some dummy like '{#'
+ and similarly I replaced '>}' with '&}'. After the conversion, I could
+ then change back from '{ #' to '{ <' and from '& }' to '> }'.
+ Doesn't convert all text markup correctly. Only very simple cases are fixed.
+2.0->2.2:
+ Doesn't handle \partcombine
+ Doesn't do \addlyrics => \lyricsto, this breaks some scores with multiple stanzas.
+2.2->2.4:
+ \turnOff (used in \set Staff.VoltaBracket = \turnOff) is not properly converted.
+2.4.2->2.5.9
+ \markup{ \center-align <{ ... }> } should be converted to:
+ \markup{ \center-align {\line { ... }} }
+ but now, \line is missing.
+@end verbatim
+
+
@node Reporting bugs
@section Reporting bugs
@cindex reporting bugs
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
+that is a bug. We try to respond to bug-reports promptly, and fix them as
soon as possible. 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 of LilyPond you use! Send
the report to @email{bug-lilypond@@gnu.org}.
When you've found a bug, have a look at our
-@uref{http://lilypond.org/doc/v2.3/bugs/,bug database} to see if it
-has already been reported. You could also try doing a few searches
+@uref{http://@/lilypond@/.org/@/doc/@/v2.3/@/bugs/,bug database} to see if
+it has already been reported. You could also try to do a few searches
on the mailing list for the bug. Sometimes the bug will have already
been reported and a fix or workaround is already known.
Here is an example of a good bug report:
-@verbatim
-
-It seems that placement of accidentals is broken. In the
+@example
+It seems that placement of accidentals is broken. In the
following example, the accidental touches the note head.
Using Mac OSX 10.3.5, fink package lilypond-unstable
\version "2.3.22"
-\relative c''{
+\relative c''@{
a4 b cis d
-}
-@end verbatim
+@}
+@end example
-@lilypond
+@lilypond[quote]
\version "2.3.22"
\relative c''{
- \override Accidental #'extra-offset = #'(1.0 . 0)
- a4 b cis d
+ \override Accidental #'extra-offset = #'(1.0 . 0)
+ a4 b cis d
}
@end lilypond
@cindex editors
@cindex vim
@cindex emacs
-@cindex modes, editor
+@cindex modes, editor
@cindex syntax coloring
@cindex coloring, syntax
@item VIM
-For @uref{http://www.vim.org,VIM}, a @file{vimrc} is supplied, along with
-syntax coloring tools. For more information, refer to the
+For @uref{http://@/www@/.vim@/.org,VIM}, a @file{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
@item JEdit
-The @uref{http://www.jedit.org/,jEdit} editor has a LilyPond plugin.
+The @uref{http://@/www@/.jedit@/.org/,jEdit} editor has a LilyPond plugin.
This plugin includes a DVI viewer, integrated help and viewing via
GhostScript. It can be installed by doing @key{Plugins > Plugin
Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
@end table
-All these editors can be made to jump in the input file to the source
+All these editors can be made to jump into the input file to the source
of a symbol in the graphical output. See @ref{Point and click}.
-
-
-@node Invoking lilypond-latex
-@section Invoking lilypond-latex
-
-Before LilyPond 3.0, the @code{lilypond} program only generated music
-notation. Titles and page layout was done in a separate wrapper
-program. For compatibility with older files, this wrapper program has
-been retained as @code{lilypond-latex}. It uses the LilyPond program
-and La@TeX{} to create a nicely titled piece of sheet music. Use of
-this program is only necessary if the input file contains special
-La@TeX{} options or formatting codes in markup texts.
-
-The @code{lilypond-latex} wrapper is invoked from the command-line as
-follows
-@example
- @code{lilypond-latex} [@var{option}]@dots{} @var{file}@dots{}
-@end example
-
-To have @code{lilypond-latex} read from stdin, use a dash @code{-} for
-@var{file}. The program supports the following options.
-
-@cindex stdin, reading
-
-@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 -h,--help
- Print usage help.
-@item -I,--include=@var{dir}
- Add @var{dir} to LilyPond's include path.
-@item -o,--output=@var{file}
- Generate output to @var{file}. The extension of @var{file} is ignored.
-@item --png
- Also generate pictures of each page, in PNG format.
-@item --preview
- Also generate a picture of the first system of the score.
-
-@cindex preview
-@cindex picture
-@cindex bitmap
-@cindex pixmap
-@cindex thumbnail
-@cindex screen shot
-
-@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{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 bug reports.
-@item -w,--warranty
-Show the warranty with which GNU LilyPond comes. (It comes with
-@strong{NO WARRANTY}!)
-@end table
-
-
-
-@subsection Additional parameters
-
-The @code{lilypond} program responds to several parameters specified
-in a @code{\layout} 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 page numbers 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{\layout} 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{\layout}
-block.
-
-@item papersize
- The paper size (as a name, e.g. @code{a4}). It is normally read from
-the @code{\layout} block.
-
-@item fontenc
- The font encoding, should be set identical to the @code{font-encoding}
- property in the score.
-@end table
-
-
-
projects / lilypond.git / blobdiff