Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/boostbook/setup/running.html @ 25

Last change on this file since 25 was 12, checked in by landauf, 17 years ago

added boost
File size: 5.0 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Running BoostBook</title>
5<link rel="stylesheet" href="../../boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
8<link rel="up" href="../getting/started.html" title="Chapter 17. Getting Started">
9<link rel="prev" href="manual.html" title="Manual setup for all systems">
10<link rel="next" href="troubleshooting.html" title="Troubleshooting">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td>
15<td align="center"><a href="../../../../index.htm">Home</a></td>
16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../../../people/people.htm">People</a></td>
18<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="manual.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting/started.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="troubleshooting.html"><img src="../../images/next.png" alt="Next"></a>
24</div>
25<div class="section" lang="en">
26<div class="titlepage"><div><div><h2 class="title" style="clear: both">
27<a name="boostbook.setup.running"></a>Running BoostBook</h2></div></div></div>
28<p>Once BoostBook has been configured, we can build some
29    documentation. First, change to the directory
30    <code class="computeroutput">$BOOST_ROOT/doc</code> and remove (or make writable) the
31    <code class="computeroutput">.html</code> files in
32    <code class="computeroutput">$BOOST_ROOT/doc/html</code>. Then, run <code class="computeroutput">bjam
33    --v2</code> to build HTML documentation. You should see several
34    warnings like these while DocBook documentation is being built
35    from BoostBook documentation:</p>
36<pre class="programlisting">Cannot find function named 'checked_delete'
37Cannot find function named 'checked_array_delete'
38Cannot find function named 'next'</pre>
39<p>These warnings are emitted when the Boost documentation
40    tools cannot find documentation for functions, methods, or classes
41    that are referenced in the source, and are not harmful in any
42    way. Once Boost.Jam has completed its execution, HTML
43    documentation for Boost will be available in
44    <code class="computeroutput">$BOOST_ROOT/doc/html</code>. You can also create HTML
45    documentation in a single (large!) HTML file with the command line
46    <code class="computeroutput">bjam --v2 onehtml</code>, or Unix man pages with the command
47    line <code class="computeroutput">bjam --v2 man</code>. The complete list of output
48    formats is listed in <a href="running.html#boostbook.output.formats" title="Table 17.1. BoostBook Output Formats">Table 17.1, &#8220;BoostBook Output Formats&#8221;</a>. Several output formats can
49    be passed to a single invocation of <code class="computeroutput">bjam</code>, e.g.,
50    <code class="computeroutput">bjam --v2 html man docbook</code> would generate HTML
51    (multiple files), man pages, and DocBook documentation.</p>
52<div class="table">
53<a name="boostbook.output.formats"></a><p class="title"><b>Table 17.1. BoostBook Output Formats</b></p>
54<table class="table" summary="BoostBook Output Formats">
55<colgroup>
56<col>
57<col>
58</colgroup>
59<thead><tr>
60<th>Format</th>
61<th>Description</th>
62</tr></thead>
63<tbody>
64<tr>
65<td>html</td>
66<td><p>HTML output (multiple files). This is the default</p></td>
67</tr>
68<tr>
69<td>onehtml</td>
70<td><p>HTML output in a single HTML file.</p></td>
71</tr>
72<tr>
73<td>man</td>
74<td><p>Unix man pages.</p></td>
75</tr>
76<tr>
77<td>pdf</td>
78<td><p>PDF. Requires <a href="http://xml.apache.org/fop/index.html" target="_top">Apache FOP</a>.</p></td>
79</tr>
80<tr>
81<td>ps</td>
82<td><p>Postscript. Requires <a href="http://xml.apache.org/fop/index.html" target="_top">Apache FOP</a>.</p></td>
83</tr>
84<tr>
85<td>docbook</td>
86<td>
87<a href="http://www.docbook.org/" target="_top">DocBook</a>.</td>
88</tr>
89<tr>
90<td>fo</td>
91<td><a href="http://www.w3.org/TR/xsl/" target="_top">XSL Formatting Objects</a></td>
92</tr>
93</tbody>
94</table>
95</div>
96</div>
97<table width="100%"><tr>
98<td align="left"></td>
99<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td>
100</tr></table>
101<hr>
102<div class="spirit-nav">
103<a accesskey="p" href="manual.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting/started.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="troubleshooting.html"><img src="../../images/next.png" alt="Next"></a>
104</div>
105</body>
106</html>
Note: See TracBrowser for help on using the repository browser.