ceph/src/boost/tools/auto_index/doc/html/boost_autoindex/tut/build.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Step 1: Build the AutoIndex tool</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="../../index.html" title="Boost.AutoIndex">
   8 <link rel="up" href="../tut.html" title="Getting Started and Tutorial">
   9 <link rel="prev" href="../tut.html" title="Getting Started and Tutorial">
  10 <link rel="next" href="configure.html" title="Step 2: Configure Boost.Build jamfile to use AutoIndex">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../tut.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tut.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="configure.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_autoindex.tut.build"></a><a class="link" href="build.html" title="Step 1: Build the AutoIndex tool">Step 1: Build the AutoIndex
  28       tool</a>
  29 </h3></div></div></div>
  30 <div class="note"><table border="0" summary="Note">
  31 <tr>
  32 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  33 <th align="left">Note</th>
  34 </tr>
  35 <tr><td align="left" valign="top"><p>
  36           This step is strictly optional, but very desirable to speed up build times.
  37         </p></td></tr>
  38 </table></div>
  39 <p>
  40         cd into <code class="computeroutput"><span class="identifier">tools</span><span class="special">/</span><span class="identifier">auto_index</span><span class="special">/</span><span class="identifier">build</span></code> and invoke bjam as:
  41       </p>
  42 <pre class="programlisting"><span class="identifier">bjam</span> <span class="identifier">release</span>
  43 </pre>
  44 <p>
  45         Optionally pass the name of the compiler toolset you want to use to bjam
  46         as well:
  47       </p>
  48 <pre class="programlisting"><span class="identifier">bjam</span> <span class="identifier">release</span> <span class="identifier">gcc</span>
  49 </pre>
  50 <p>
  51         This will build the tool and place a copy in the current directory (which
  52         is to say <code class="computeroutput"><span class="identifier">tools</span><span class="special">/</span><span class="identifier">auto_index</span><span class="special">/</span><span class="identifier">build</span></code>)
  53       </p>
  54 <p>
  55         Now open up your <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code> file and at the end of the file add
  56         the line:
  57       </p>
  58 <pre class="programlisting">using auto-index : <span class="emphasis"><em>full-path-to-boost-tree</em></span>/tools/auto_index/build/auto-index.exe ;
  59 </pre>
  60 <div class="note"><table border="0" summary="Note">
  61 <tr>
  62 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  63 <th align="left">Note</th>
  64 </tr>
  65 <tr><td align="left" valign="top">
  66 <p>
  67           This declaration must go towards the end of <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>,
  68           or in any case after the Boostbook initialisation.
  69         </p>
  70 <p>
  71           Also note that Windows users must use forward slashes in the paths in
  72           <code class="computeroutput"><span class="identifier">user</span><span class="special">-</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">jam</span></code>
  73         </p>
  74 </td></tr>
  75 </table></div>
  76 </div>
  77 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  78 <td align="left"></td>
  79 <td align="right"><div class="copyright-footer">Copyright &#169; 2008, 2011 John Maddock<p>
  80         Distributed under the Boost Software License, Version 1.0. (See accompanying
  81         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  82       </p>
  83 </div></td>
  84 </tr></table>
  85 <hr>
  86 <div class="spirit-nav">
  87 <a accesskey="p" href="../tut.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tut.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="configure.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  88 </div>
  89 </body>
  90 </html>