Next: Invoking lilypond-book, Previous: Integrating HTML and music, Up: LilyPond-book
In the following, a “LilyPond command” refers to any command described in the previous sections which is handled by lilypond-book to produce a music snippet. For simplicity, LilyPond commands are only shown in LaTeX syntax.
Note that the option string is parsed from left to right; if an option occurs multiple times, the last one is taken.
The following options are available for LilyPond commands:
staffsize=htragged-rightragged-right
= ##t is added to the LilyPond snippet). This is the default for the
\lilypond{} command if no line-width option is present.
It is also the default for the lilypond environment if the
fragment option is set, and no line width is explicitly
specified.
packedpacked = ##t is added
to the LilyPond snippet).
line-widthline-width=size\unitcm, mm, in, or
pt. This option affects LilyPond output (this is, the staff
length of the music snippet), not the text layout.
If used without an argument, set line width to a default value (as computed with a heuristic algorithm).
If no line-width option is given, lilypond-book tries to
guess a default for lilypond environments which don't use the
ragged-right option.
notimefragmentc'4
without \layout, \score, etc.
nofragmentnofragment is redundant normally.
indent=size\unitcm, mm, in, or pt. This option affects
LilyPond, not the text layout.
noindentnoindent is redundant normally.
quoteexampleindent option.
exampleindentquote option indents a music snippet.
relativerelative=n1 is middle C.
LilyPond also uses lilypond-book to produce its own documentation. To do that, some more obscure music fragment options are available.
verbatimintertext option (not implemented yet); then the actual music is
displayed. This option does not work well with \lilypond{} if
it is part of a paragraph.
texidoctexidoc field in the \header. The texidoc
option makes lilypond-book include such files, adding its
contents as a documentation block right before the music snippet.
Assuming the file foo.ly contains
\header {
texidoc = "This file demonstrates a single note."
}
{ c'4 }
and we have this in our Texinfo document test.texinfo
@lilypondfile[texidoc]{foo.ly}
the following command line gives the expected result
lilypond-book --process="lilypond --format=tex --tex \
--header=texidoc test.texinfo
Most LilyPond test documents (in the input directory of the
distribution) are small .ly files which look exactly like this.
printfilename\lilypondfile, print
the file name right before the music snippet. For HTML output, this is
a link.
fontload
This page is for LilyPond-2.8.8 (stable-branch).