1 | <html> |
---|
2 | <head> |
---|
3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
---|
4 | <title>Chapter 17. Getting Started</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="../../boostbook.html" title="Part II. The BoostBook Documentation Format"> |
---|
9 | <link rel="prev" href="../introduction.html" title="Chapter 16. Introduction"> |
---|
10 | <link rel="next" href="../setup/manual.html" title="Manual setup for all systems"> |
---|
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="../introduction.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boostbook.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="../setup/manual.html"><img src="../../images/next.png" alt="Next"></a> |
---|
24 | </div> |
---|
25 | <div class="chapter" lang="en"> |
---|
26 | <div class="titlepage"><div><div><h2 class="title"> |
---|
27 | <a name="boostbook.getting.started"></a>Chapter 17. Getting Started</h2></div></div></div> |
---|
28 | <div class="toc"> |
---|
29 | <p><b>Table of Contents</b></p> |
---|
30 | <dl> |
---|
31 | <dt><span class="section"><a href="started.html#boostbook.setup.autounix">Automatic setup for Unix-like systems</a></span></dt> |
---|
32 | <dt><span class="section"><a href="../setup/manual.html">Manual setup for all systems</a></span></dt> |
---|
33 | <dd><dl> |
---|
34 | <dt><span class="section"><a href="../setup/manual.html#boostbook.setup.xsltproc">Configuring <span><strong class="command">xsltproc</strong></span></a></span></dt> |
---|
35 | <dt><span class="section"><a href="../setup/manual.html#boostbook.setup.docbook">Configuring local DocBook XSL and DTD distributions</a></span></dt> |
---|
36 | <dt><span class="section"><a href="../setup/manual.html#boostbook.setup.doxygen">Configuring Doxygen for Documentation Extraction</a></span></dt> |
---|
37 | <dt><span class="section"><a href="../setup/manual.html#boostbook.setup.fop">Configuring Apache FOP</a></span></dt> |
---|
38 | </dl></dd> |
---|
39 | <dt><span class="section"><a href="../setup/running.html">Running BoostBook</a></span></dt> |
---|
40 | <dt><span class="section"><a href="../setup/troubleshooting.html">Troubleshooting</a></span></dt> |
---|
41 | </dl> |
---|
42 | </div> |
---|
43 | <p>To use the Boost documentation tools, you will need several tools:</p> |
---|
44 | <div class="itemizedlist"><ul type="disc"> |
---|
45 | <li> |
---|
46 | <p><span><strong class="command">xsltproc</strong></span>:</p> |
---|
47 | <div class="itemizedlist"><ul type="circle"> |
---|
48 | <li>Windows with <a href="http://www.cygwin.com/" target="_top">Cygwin</a>: select the libxml2 and libxslt packages.</li> |
---|
49 | <li>Windows without Cygwin: Download packages <a href="http://www.meta-comm.com/engineering/boost/xsltproc-win32.zip" target="_top"> |
---|
50 | here</a>.</li> |
---|
51 | <li>Mac OS X with Fink: Get the <code class="computeroutput">libxslt</code> package.</li> |
---|
52 | <li>Mac OS X without Fink: <a href="http://www.zveno.com/open_source/libxml2xslt.html" target="_top">Download the libxslt binaries</a> |
---|
53 | </li> |
---|
54 | <li>Any platform: <a href="http://xmlsoft.org/XSLT/" target="_top">libxslt source</a>.</li> |
---|
55 | </ul></div> |
---|
56 | </li> |
---|
57 | <li> |
---|
58 | <p><span><strong class="command">doxygen</strong></span>:</p> Available from <a href="http://www.doxygen.org" target="_top">http://www.doxygen.org</a> |
---|
59 | </li> |
---|
60 | </ul></div> |
---|
61 | <div class="section" lang="en"> |
---|
62 | <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
---|
63 | <a name="boostbook.setup.autounix"></a>Automatic setup for Unix-like systems</h2></div></div></div> |
---|
64 | <p>BoostBook provides a nearly-automatic setup script. Once |
---|
65 | you have downloaded and |
---|
66 | installed <span><strong class="command">xsltproc</strong></span>, <span><strong class="command">doxygen</strong></span>, |
---|
67 | and (optionally) <span><strong class="command">java</strong></span>, the setup script can |
---|
68 | download the required DocBook stylesheets, DocBook DTD, and |
---|
69 | (when Java is enabled) Apache FOP for PDF output. It will then |
---|
70 | configure Boost.Build version 2 to build BoostBook |
---|
71 | documentation. To perform the installation, execute the |
---|
72 | script <span><strong class="command">tools/boostbook/setup_boostbook.sh</strong></span> |
---|
73 | from a directory where you would like the resulting XSL, DTD, |
---|
74 | and Apache FOP installations to occur. </p> |
---|
75 | </div> |
---|
76 | </div> |
---|
77 | <table width="100%"><tr> |
---|
78 | <td align="left"></td> |
---|
79 | <td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> |
---|
80 | </tr></table> |
---|
81 | <hr> |
---|
82 | <div class="spirit-nav"> |
---|
83 | <a accesskey="p" href="../introduction.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boostbook.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="../setup/manual.html"><img src="../../images/next.png" alt="Next"></a> |
---|
84 | </div> |
---|
85 | </body> |
---|
86 | </html> |
---|