<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- header_tag -->
<html lang="en">
<head>
<title>Commands for building documentation - 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="Building-documentation.de.html#Building-documentation" title="Building documentation">
<link rel="next" href="Building-documentation-without-compiling-LilyPond.de.html#Building-documentation-without-compiling-LilyPond" title="Building documentation without compiling LilyPond">
<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="Commands-for-building-documentation"></a>
Next: <a rel="next" accesskey="n" href="Building-documentation-without-compiling-LilyPond.de.html#Building-documentation-without-compiling-LilyPond">Building documentation without compiling LilyPond</a>,
Up: <a rel="up" accesskey="u" href="Building-documentation.de.html#Building-documentation">Building documentation</a>
<hr>
</div>
<h5 class="unnumberedsubsubsec">Commands for building documentation</h5>
<p>The documentation is built by issuing
<pre class="example"> make web
</pre>
<p>After compilation, the HTML documentation tree is available in
<samp><span class="file">out-www/offline-root/</span></samp>, and can be browsed locally.
<p>The HTML and PDF files can be installed into the standard documentation
path by issuing
<pre class="example"> make web-install
</pre>
<p class="noindent">This also installs Info documentation with images if the installation
prefix is properly set; otherwise, instructions for manual installation
of Info documentation are printed on standard output.
<p>It is also possible to build a documentation tree in
<samp><span class="file">out-www/online-root/</span></samp>, with special processing, so it can be used
on a website with content negotiation for automatic language selection;
this can be achieved by issuing
<pre class="example"> make WEB_TARGETS=online web
</pre>
<p class="noindent">and both ‘offline’ and ‘online’ targets can be generated by issuing
<pre class="example"> make WEB_TARGETS="offline online" web
</pre>
<p>Several targets are available to clean the documentation build and
help with maintaining documentation; an overview of these targets is
available with
<pre class="example"> make help
</pre>
<p class="noindent">from every directory in the build tree. Most targets for
documentation maintenance are available from <samp><span class="file">Documentation/</span></samp>;
for more information, see <samp><span class="file">Documentation/user/README.txt</span></samp> and
<samp><span class="file">Documentation/TRANSLATION</span></samp>.
<p class="noindent">
<h5 class="subsubheading">Known issues and warnings</h5>
<p><code>-j</code> command-line option of <samp><span class="command">make</span></samp> is unsupported for
building the documentation. As the most time consuming task is
running LilyPond to build images of music, the makefile variable
<code>CPU_COUNT</code> may be set in <samp><span class="file">local.make</span></samp> or on the command line
to the number of <code>.ly</code> files that LilyPond should process
simultaneously, e.g. on a bi-processor or Dual core machine
<pre class="example"> make CPU_COUNT=2 web
</pre>
<p>If source files have changed since last documentation build, output
files that need to be rebuilt are normally rebuilt, even if you do not
run <code>make web-clean</code> first. However, building dependencies in the
documentation are so complex that rebuilding of some targets may not
be triggered as they should be; a workaround is to force rebuilding
by touching appropriate files, e.g.
<pre class="example"> touch Documentation/user/*.itely
touch input/lsr/*.ly
</pre>
<!-- footer_tag --><br><hr>
<div class="node">
<p>
Next: <a rel="next" accesskey="n" href="Building-documentation-without-compiling-LilyPond.de.html#Building-documentation-without-compiling-LilyPond">Building documentation without compiling LilyPond</a>,
Up: <a rel="up" accesskey="u" href="Building-documentation.de.html#Building-documentation">Building documentation</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="Commands-for-building-documentation.es.html">español</a>.
<BR>
</P>
</BODY></html>
