Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/boostbook/setup/manual.html @ 12

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

added boost
File size: 9.8 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Manual setup for all systems</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="../getting/started.html" title="Chapter 17. Getting Started">
10<link rel="next" href="running.html" title="Running BoostBook">
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="../getting/started.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="running.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.manual"></a>Manual setup for all systems</h2></div></div></div>
28<div class="toc"><dl>
29<dt><span class="section"><a href="manual.html#boostbook.setup.xsltproc">Configuring <span><strong class="command">xsltproc</strong></span></a></span></dt>
30<dt><span class="section"><a href="manual.html#boostbook.setup.docbook">Configuring local DocBook XSL and DTD distributions</a></span></dt>
31<dt><span class="section"><a href="manual.html#boostbook.setup.doxygen">Configuring Doxygen for Documentation Extraction</a></span></dt>
32<dt><span class="section"><a href="manual.html#boostbook.setup.fop">Configuring Apache FOP</a></span></dt>
33</dl></div>
34<p>This section describes how to manually configure Boost
35      Boost version 2 (BBv@) for BoostBook. If you can use the
36      automatic setup script, you should. All configuration will
37      happen in the BBv2 user configuration file,
38      <code class="filename">user-config.jam</code>. If you do not have a copy
39      of this file in your home directory, you should copy the one
40      that resides in <code class="computeroutput">tools/build/v2</code> to your home
41      directory. Alternatively, you can edit
42      <code class="filename">tools/build/v2/user-config.jam</code> directly or
43      a site-wide <code class="filename">site-config.jam</code> file.</p>
44<div class="section" lang="en">
45<div class="titlepage"><div><div><h3 class="title">
46<a name="boostbook.setup.xsltproc"></a>Configuring <span><strong class="command">xsltproc</strong></span></h3></div></div></div>
47<p>To configure <span><strong class="command">xsltproc</strong></span> manually, you
48        will need to add a directive to
49        <code class="filename">user-config.jam</code> telling it where to find
50        <span><strong class="command">xsltproc</strong></span>. If the program is in your path,
51        just add the following line to
52        <code class="filename">user-config.jam</code>:</p>
53<pre class="programlisting">using xsltproc ;</pre>
54<p>If <span><strong class="command">xsltproc</strong></span> is somewhere else, use
55        this directive, where <code class="computeroutput">XSLTPROC</code> is the full
56        pathname to <span><strong class="command">xsltproc</strong></span> (including
57        <span><strong class="command">xsltproc</strong></span>):</p>
58<pre class="programlisting">using xsltproc : XSLTPROC ;</pre>
59</div>
60<div class="section" lang="en">
61<div class="titlepage"><div><div><h3 class="title">
62<a name="boostbook.setup.docbook"></a>Configuring local DocBook XSL and DTD distributions</h3></div></div></div>
63<p>This section describes how to configure Boost.Build to
64        use local copies of the DocBook DTD and XSL stylesheets to
65        improve processing time. You will first need to download two
66        packages:
67
68        </p>
69<div class="itemizedlist"><ul type="disc">
70<li><p>Norman Walsh's DocBook XSL stylesheets,
71          available at the <a href="http://docbook.sourceforge.net" target="_top">DocBook sourceforge
72          site</a>. Extract the DocBook XSL stylesheets to a
73          directory on your hard disk (which we'll refer to as the
74          <code class="computeroutput">DOCBOOK_XSL_DIR</code>).</p></li>
75<li><p>The DocBook DTD, available as a ZIP archive
76          at the <a href="http://www.oasis-open.org/docbook/xml/4.2/index.shtml" target="_top">OASIS
77          DocBook site</a>. The package is called "DocBook XML
78          4.2". Extract the DocBook DTD to a directory on your hard
79          disk (which we'll refer to as the
80          <code class="computeroutput">DOCBOOK_DTD_DIR</code>). You will want to extract this
81          archive in a subdirectory!</p></li>
82</ul></div>
83<p>Add the following directive telling BBv2 where to find
84        the DocBook DTD and XSL stylesheets:</p>
85<pre class="programlisting">#  BoostBook configuration
86using boostbook
87  : DOCBOOK_XSL_DIR
88  : DOCBOOK_DTD_DIR
89  ;</pre>
90<p>Whenever you change this directive, you will need to
91        remove the <code class="computeroutput">bin.v2</code> directory that BBv2 generates.
92        This is due to longstanding bug we are trying to fix.</p>
93<p>At this point, you should be able to build HTML
94        documentation for libraries that do not require Doxygen. To
95        test this, change into the directory <code class="filename">$BOOST_ROOT/libs/function/doc</code> and
96        run the command <code class="computeroutput">bjam --v2</code>: it should produce HTML
97        documentation for the Boost.Function library in the
98        <code class="computeroutput">html</code> subdirectory.</p>
99</div>
100<div class="section" lang="en">
101<div class="titlepage"><div><div><h3 class="title">
102<a name="boostbook.setup.doxygen"></a>Configuring Doxygen for Documentation Extraction</h3></div></div></div>
103<p>Doxygen is required to build the documentation for
104        several Boost libraries. You will need a recent version of
105        <a href="http://www.doxygen.org" target="_top">Doxygen</a> (most of
106        the 1.3.x and 1.4.x versions will suffice). BBv2 by adding the
107        following directive to
108        <code class="filename">user-config.jam</code>:</p>
109<pre class="programlisting">using doxygen : DOXYGEN ;</pre>
110<p><code class="filename">DOXYGEN</code> should be replaced with the
111        name of the <span><strong class="command">doxygen</strong></span> executable (with full
112        path name). If the right <span><strong class="command">doxygen</strong></span> executable
113        can be found via the path, this parameter can be
114        omitted, e.g.</p>
115<pre class="programlisting">using doxygen ;</pre>
116<div class="important" style="margin-left: 0.5in; margin-right: 0.5in;">
117<h3 class="title">Important</h3>
118<p>The relative order of declarations in
119          <code class="filename">user-config.jam</code> /
120          <code class="filename">site-config.jam</code> files is
121          significant. In particular, the <code class="literal">using
122          doxygen</code> line should come
123          <span class="emphasis"><em>after</em></span> the <code class="literal">using
124          boostbook</code> declaration.
125          </p>
126</div>
127</div>
128<div class="section" lang="en">
129<div class="titlepage"><div><div><h3 class="title">
130<a name="boostbook.setup.fop"></a>Configuring Apache FOP</h3></div></div></div>
131<p>In order to generate PDF and PostScript output using
132      Apache FOP, you will need a <a href="http://java.sun.com" target="_top">Java interpreter</a> and <a href="http://xml.apache.org/fop/download.html" target="_top">Apache FOP</a>
133      (version 0.20.5 is best). Unpack Apache FOP to some
134      directory. The top level directory of the FOP tool should
135      contain a main script called <code class="filename">fop.sh</code> on Unix
136      and <code class="filename">fop.bat</code> on Windows. You need to specify
137      the location of that script and Java location to
138      Boost.Build. Add the following to your
139      <code class="filename">user-config.jam</code> or
140      <code class="filename">site-config.jam</code>:
141</p>
142<pre class="programlisting">
143using fop : FOP_COMMAND
144          : JAVA_HOME
145          ;
146</pre>
147<p> replacing
148      <code class="computeroutput">FOP_COMMAND</code> with the full path to the FOP main script, and
149      replacing <code class="computeroutput">JAVA_HOME</code> with the directory where Java is
150      installed. If the <code class="envar">JAVA_HOME</code> environment variable is
151      already set, you don't need to specify it above.
152      </p>
153<p>To test PDF generation, switch to the directory <code class="filename">$BOOST_ROOT/libs/function/doc</code> and
154      execute the command <span><strong class="command">bjam --v2 pdf</strong></span>. In the
155      absence of any errors, Apache FOP will be executed to transform
156      the XSL:FO output of DocBook into a PDF file.</p>
157</div>
158</div>
159<table width="100%"><tr>
160<td align="left"></td>
161<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td>
162</tr></table>
163<hr>
164<div class="spirit-nav">
165<a accesskey="p" href="../getting/started.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="running.html"><img src="../../images/next.png" alt="Next"></a>
166</div>
167</body>
168</html>
Note: See TracBrowser for help on using the repository browser.