<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- header_tag -->
<html lang="en">
<head>
<title>Invoking lilypond-book - GNU LilyPond program usage</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="GNU LilyPond program usage">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.de.html#Top">
<link rel="up" href="LilyPond_002dbook.de.html#LilyPond_002dbook" title="LilyPond-book">
<link rel="prev" href="Music-fragment-options.de.html#Music-fragment-options" title="Music fragment options">
<link rel="next" href="Filename-extensions.de.html#Filename-extensions" title="Filename extensions">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1999--2007 by the authors
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections. A copy of the license is
included in the section entitled ``GNU Free Documentation
License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
hr { border:0; height:1; color: #000000; background-color: #000000; }
/* hr {
border: none;
height: 1px;
color: #666666;
background-color: #666666;
}
body {
border-left: 1px solid #666666;
border-right: 1px solid #666666;
color: #332d28;
margin-right: auto;
margin-left: auto;
width: 60em;
list-style-type: square;
font-family: Arial,Helvetica,sans-serif;
padding-right: 1em;
padding-left: 1em;
}
a {
border-bottom: 1px dashed #344242;
text-decoration: none;
color: #344242;
}
a:link {
text-decoration: none;
}
a:visited {
border-bottom: 1px dashed #666666;
color: #666666;
}
a:active {
border-bottom: 1px solid #00cccc;
color: #00cccc;
}
a:hover {
border-bottom: 1px solid #1d7b85;
color: #1d7b85;
}
blockquote {
border: 1px solid #cccccc;
padding: 3px;
width: 40em;
}
.node {
border-left: 1px solid #666666;
margin: -0.5em 0px 1em;
padding: 2px 1px 0px;
font-style: italic;
}
.node a {
border: none;
text-decoration: underline;
font-style: normal;
font-weight: bold;
}
.verbatim {
font-family: "Courier New",Courier,monospace;
}
.unnumberedsubsubsec {
font-size: large;
color: #1d7b85;
}
.subsubheading {
font-size: large;
color: #3b220d;
}
.contents {
border: 1px dashed #339999;
margin: 3px 2em;
list-style-type: square;
padding-right: 1em;
width: 40em;
background-color: #fcfff9;
}
.contents a {
border-bottom: 1px dashed #423d34;
text-decoration: none;
color: #423d34;
}
.contents a:visited {
border-bottom: 1px dashed #666666;
color: #666666;
}
.contents a:active {
border-bottom: 1px solid #f0d86d;
color: #f0d86d;
}
.contents a:hover {
border-bottom: 1px solid #3b220d;
color: #3b220d;
}
.menu {
border-left: 1px dashed #339999;
margin: 3px 2em 1em;
list-style-type: square;
padding-left: 1.4em;
width: 40em;
}
.unnumbered {
}
h2 {
font-size: x-large;
color: #1d7b85;
}
*/
--></style>
</head>
<BODY BGCOLOR=WHITE TEXT=BLACK>
<div class="node">
<p>
<a name="Invoking-lilypond-book"></a>
<a name="Invoking-lilypond_002dbook"></a>
Next: <a rel="next" accesskey="n" href="Filename-extensions.de.html#Filename-extensions">Filename extensions</a>,
Previous: <a rel="previous" accesskey="p" href="Music-fragment-options.de.html#Music-fragment-options">Music fragment options</a>,
Up: <a rel="up" accesskey="u" href="LilyPond_002dbook.de.html#LilyPond_002dbook">LilyPond-book</a>
<hr>
</div>
<h3 class="section">4.4 Invoking <samp><span class="command">lilypond-book</span></samp></h3>
<p><samp><span class="command">lilypond-book</span></samp> produces a file with one of the following
extensions: <samp><span class="file">.tex</span></samp>, <samp><span class="file">.texi</span></samp>, <samp><span class="file">.html</span></samp> or <samp><span class="file">.xml</span></samp>,
depending on the output format. All of <samp><span class="file">.tex</span></samp>, <samp><span class="file">.texi</span></samp> and
<samp><span class="file">.xml</span></samp> files need further processing.
<h4 class="subheading">Format-specific instructions</h4>
<h5 class="subsubheading">LaTeX</h5>
<p>There are two ways of processing your LaTeX document for printing or
publishing: getting a PDF file directly with PDFLaTeX, or getting a
PostScript file with LaTeX via a DVI to PostScript translator like
<samp><span class="command">dvips</span></samp>. The first way is simpler and recommended<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>, and whichever
way you use, you can easily convert between PostScript and PDF with
tools, like <samp><span class="command">ps2pdf</span></samp> and <samp><span class="command">pdf2ps</span></samp> included in
Ghostscript package.
<p>To produce a PDF file through PDFLaTeX, use
<pre class="example">lilypond-book --pdf yourfile.pdftex
pdflatex yourfile.tex
</pre>
<p><a name="index-outline-fonts-56"></a><a name="index-type1-fonts-57"></a><a name="index-dvips-58"></a><a name="index-invoking-dvips-59"></a>To produce PDF output via LaTeX/<samp><span class="command">dvips</span></samp>/<samp><span class="command">ps2pdf</span></samp>, you
should do
<pre class="example">lilypond-book yourfile.lytex
latex yourfile.tex
dvips -Ppdf yourfile.dvi
ps2pdf yourfile.ps
</pre>
<p class="noindent">The <samp><span class="file">.dvi</span></samp> file created by this process will not contain
note heads. This is normal; if you follow the instructions, they
will be included in the <samp><span class="file">.ps</span></samp> and <samp><span class="file">.pdf</span></samp> files.
<p>Running <samp><span class="command">dvips</span></samp> may produce some warnings about fonts; these
are harmless and may be ignored. If you are running <samp><span class="command">latex</span></samp> in
twocolumn mode, remember to add <code>-t landscape</code> to the
<samp><span class="command">dvips</span></samp> options.
<h5 class="subsubheading">Texinfo</h5>
<p>To produce a Texinfo document (in any output format), follow the normal
procedures for Texinfo; this is, either call <samp><span class="command">texi2pdf</span></samp> or
<samp><span class="command">texi2dvi</span></samp> or <samp><span class="command">makeinfo</span></samp>, depending on the output format
you want to create.
See the documentation of Texinfo for further details.
<h4 class="subheading">Command line options</h4>
<p><samp><span class="command">lilypond-book</span></samp> accepts the following command line options:
<dl>
<dt><code>-f </code><var>format</var><dt><code>--format=</code><var>format</var><dd>Specify the document type to process: <code>html</code>, <code>latex</code>,
<code>texi</code> (the default) or <code>docbook</code>. If this option is missing,
<samp><span class="command">lilypond-book</span></samp> tries to detect the format automatically, see
<a href="Filename-extensions.de.html#Filename-extensions">Filename extensions</a>. Currently, <code>texi</code> is the same as
<code>texi-html</code>.
<!-- This complicated detail is not implemented, comment it out -jm -->
<br><dt><code>-F </code><var>filter</var><dt><code>--filter=</code><var>filter</var><dd>Pipe snippets through <var>filter</var>. <code>lilypond-book</code> will
not –filter and –process at the same time. For example,
<pre class="example"> lilypond-book --filter='convert-ly --from=2.0.0 -' my-book.tely
</pre>
<br><dt><code>-h</code><dt><code>--help</code><dd>Print a short help message.
<br><dt><code>-I </code><var>dir</var><dt><code>--include=</code><var>dir</var><dd>Add <var>dir</var> to the include path. <samp><span class="command">lilypond-book</span></samp> also looks
for already compiled snippets in the include path, and does not write
them back to the output directory, so in some cases it is necessary to
invoke further processing commands such as <samp><span class="command">makeinfo</span></samp> or
<samp><span class="command">latex</span></samp> with the same <code>-I </code><var>dir</var> options.
<br><dt><code>-o </code><var>dir</var><dt><code>--output=</code><var>dir</var><dd>Place generated files in directory <var>dir</var>. Running
<samp><span class="command">lilypond-book</span></samp> generates lots of small files that LilyPond will
process. To avoid all that garbage in the source directory, use the
<samp><span class="option">--output</span></samp> command line option, and change to that directory
before running <samp><span class="command">latex</span></samp> or <samp><span class="command">makeinfo</span></samp>.
<pre class="example"> lilypond-book --output=out yourfile.lytex
cd out
...
</pre>
<dt><code>--skip-lily-check</code><dd>Do not fail if no lilypond output is found. It is used for LilyPond
Info documentation without images.
<dt><code>--skip-png-check</code><dd>Do not fail if no PNG images are found for EPS files. It is used for
LilyPond Info documentation without images.
<dt><code>--lily-output-dir=</code><var>dir</var><dd>Write lily-XXX files to directory <var>dir</var>, link into <code>--output</code>
directory. Use this option to save building time for documents in
different directories which share a lot of identical snippets.
<dt><code>--info-images-dir=</code><var>dir</var><dd>Format Texinfo output so that Info will look for images of music in
<var>dir</var>.
<dt><code>--latex-program=</code><var>prog</var><dd>Run executable <samp><span class="command">prog</span></samp> instead of <samp><span class="command">latex</span></samp>. This is
useful if your document is processed with <samp><span class="command">xelatex</span></samp>, for
example.
<dt><code>--left-padding=</code><var>amount</var><dd>Pad EPS boxes by this much. <var>amount</var> is measured in millimeters,
and is 3.0 by default. This option should be used if the lines of
music stick out of the right margin.
<p>The width of a tightly clipped systems can vary, due to notation
elements that stick into the left margin, such as bar numbers and
instrument names. This option will shorten each line and move each
line to the right by the same amount.
<br><dt><code>-P </code><var>process</var><dt><code>--process=</code><var>command</var><dd>Process LilyPond snippets using <var>command</var>. The default command is
<code>lilypond</code>. <code>lilypond-book</code> will not <code>--filter</code> and
<code>--process</code> at the same time.
<br><dt><code>--pdf</code><dd>Create PDF files for use with PDFLaTeX.
<br><dt><code>-V</code><dt><code>--verbose</code><dd>Be verbose.
<br><dt><code>-v</code><dt><code>--version</code><dd>Print version information.
</dl>
<p class="noindent">
<h5 class="subsubheading">Known issues and warnings</h5>
<p>The Texinfo command <code>@pagesizes</code> is not interpreted. Similarly,
LaTeX commands that change margins and line widths after the preamble
are ignored.
<p>Only the first <code>\score</code> of a LilyPond block is processed.
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> Note
that PDFLaTeX and LaTeX may not be both usable to compile any
LaTeX document, that is why we explain the two ways.</p>
<hr></div>
<!-- footer_tag --><div class="node">
<p>
<a name="Invoking-lilypond_002dbook"></a>
Next: <a rel="next" accesskey="n" href="Filename-extensions.de.html#Filename-extensions">Filename extensions</a>,
Previous: <a rel="previous" accesskey="p" href="Music-fragment-options.de.html#Music-fragment-options">Music fragment options</a>,
Up: <a rel="up" accesskey="u" href="LilyPond_002dbook.de.html#LilyPond_002dbook">LilyPond-book</a>
</div>
<div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;">
<p>
<font size="-1">
Diese Seite ist für LilyPond-2.11.57 (Entwicklungszweig).
<br>
<address>
Fehler bitte an <a href="http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs">http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs</a> melden. </address>
<br>
Ihre <a href="http://lilypond.org/web/devel/participating/documentation-adding">Vorschläge für die Dokumentation</a> sind willkommen.
</font>
</p>
</div>
<P>
Andere Sprachen: <a href="Invoking-lilypond_002dbook.es.html">español</a>.
<BR>
</P>
</BODY></html>
