[ceph.git] / ceph / src / boost / tools / auto_index / doc / html / boost_autoindex / tut / configure.html

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Step 2: Configure Boost.Build jamfile to use AutoIndex</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<link rel="home" href="../../index.html" title="Boost.AutoIndex">
<link rel="up" href="../tut.html" title="Getting Started and Tutorial">
<link rel="prev" href="build.html" title="Step 1: Build the AutoIndex tool">
<link rel="next" href="configure/options.html" title="Available Indexing Options">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="build.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/options.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_autoindex.tut.configure"></a><a class="link" href="configure.html" title="Step 2: Configure Boost.Build jamfile to use AutoIndex">Step 2: Configure Boost.Build
      jamfile to use AutoIndex</a>
</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="configure/options.html">Available Indexing
        Options</a></span></dt>
<dt><span class="section"><a href="configure/optional.html">Making AutoIndex
        optional</a></span></dt>
</dl></div>
<p>
        Assuming you have a Jamfile for building your documentation that looks something
        like:
      </p>
<pre class="programlisting">boostbook standalone
    :
        mylibrary
    :
        # build requirements go here:
    ;
</pre>
<p>
        Then add the line:
      </p>
<pre class="programlisting">using auto-index ; </pre>
<p>
        to the start of the Jamfile, and then add whatever auto-index options you
        want to the <span class="emphasis"><em>build requirements section</em></span>, for example:
      </p>
<pre class="programlisting">boostbook standalone
    :
        mylibrary
    :
        # Build requirements go here:

        # &lt;auto-index&gt;on (or off) one turns on (or off) indexing:
        &lt;auto-index&gt;on

        # Turns on (or off) auto-index-verbose for diagnostic info.
        # This is highly recommended until you have got all the many details correct!
        &lt;auto-index-verbose&gt;on

        # Choose the indexing method (separately for html and PDF) - see manual.
        # Choose indexing method for PDFs:
        &lt;format&gt;pdf:&lt;auto-index-internal&gt;off

        # Choose indexing method for html:
        &lt;format&gt;html:&lt;auto-index-internal&gt;on

        # Set the name of the script file to use (index.idx is popular):
        &lt;auto-index-script&gt;index.idx
        # Commands in the script file should all use RELATIVE PATHS
        # otherwise the script will not be portable to other machines.
        # Relative paths are normally taken as relative to the location
        # of the script file, but we can add a prefix to all
        # those relative paths using the &lt;auto-index-prefix&gt; feature.
        # The path specified by &lt;auto-index-prefix&gt; may be either relative or
        # absolute, for example the following will get us up to the boost root
        # directory for most Boost libraries:
        &lt;auto-index-prefix&gt;../../..

        # Tell Quickbook that it should enable indexing.
        &lt;quickbook-define&gt;enable_index ;

    ;
</pre>
<div class="tip"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/src/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
<tr><td align="left" valign="top"><p>
          Always send the output to a log file. It will contain of lot of stuff,
          but is invaluable to check if all has gone right, or else diagnose what
          has gone wrong.
        </p></td></tr>
</table></div>
<div class="tip"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/src/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
<tr><td align="left" valign="top"><p>
          A return code of 0 is not a reliable indication that you have got what
          you really want - inspecting the log file is the only certain way.
        </p></td></tr>
</table></div>
<div class="tip"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/src/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
<tr><td align="left" valign="top"><p>
          If you upgrade compiler version, for example MSVC from 9 to 10, then you
          may need to rebuild Autoindex to avoid what Microsoft call a 'side-by-side'
          error. And make sure that the autoindex.exe version you are using is the
          new one.
        </p></td></tr>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2008, 2011 John Maddock<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="build.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/options.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Commit	Line	Data
7c673cae FG	1	<html>
	2	<head>
	3	<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
	4	<title>Step 2: Configure Boost.Build jamfile to use AutoIndex</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="build.html" title="Step 1: Build the AutoIndex tool">
	10	<link rel="next" href="configure/options.html" title="Available Indexing Options">
	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="build.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/options.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.configure"></a><a class="link" href="configure.html" title="Step 2: Configure Boost.Build jamfile to use AutoIndex">Step 2: Configure Boost.Build
	28	jamfile to use AutoIndex</a>
	29	</h3></div></div></div>
	30	<div class="toc"><dl>
	31	<dt><span class="section"><a href="configure/options.html">Available Indexing
	32	Options</a></span></dt>
	33	<dt><span class="section"><a href="configure/optional.html">Making AutoIndex
	34	optional</a></span></dt>
	35	</dl></div>
	36	<p>
	37	Assuming you have a Jamfile for building your documentation that looks something
	38	like:
	39	</p>
	40	<pre class="programlisting">boostbook standalone
	41	:
	42	mylibrary
	43	:
	44	# build requirements go here:
	45	;
	46	</pre>
	47	<p>
	48	Then add the line:
	49	</p>
	50	<pre class="programlisting">using auto-index ; </pre>
	51	<p>
	52	to the start of the Jamfile, and then add whatever auto-index options you
	53	want to the <span class="emphasis"><em>build requirements section</em></span>, for example:
	54	</p>
	55	<pre class="programlisting">boostbook standalone
	56	:
	57	mylibrary
	58	:
	59	# Build requirements go here:
	60
	61	# <auto-index>on (or off) one turns on (or off) indexing:
	62	<auto-index>on
	63
	64	# Turns on (or off) auto-index-verbose for diagnostic info.
65	# This is highly recommended until you have got all the many details correct!
66	<auto-index-verbose>on
67
68	# Choose the indexing method (separately for html and PDF) - see manual.
69	# Choose indexing method for PDFs:
70	<format>pdf:<auto-index-internal>off
71
72	# Choose indexing method for html:
73	<format>html:<auto-index-internal>on
74
75	# Set the name of the script file to use (index.idx is popular):
76	<auto-index-script>index.idx
77	# Commands in the script file should all use RELATIVE PATHS
78	# otherwise the script will not be portable to other machines.
79	# Relative paths are normally taken as relative to the location
80	# of the script file, but we can add a prefix to all
81	# those relative paths using the <auto-index-prefix> feature.
82	# The path specified by <auto-index-prefix> may be either relative or
83	# absolute, for example the following will get us up to the boost root
84	# directory for most Boost libraries:
85	<auto-index-prefix>../../..
86
87	# Tell Quickbook that it should enable indexing.
88	<quickbook-define>enable_index ;
89
90	;
91	</pre>
92	<div class="tip"><table border="0" summary="Tip">
93	<tr>
94	<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/src/images/tip.png"></td>
95	<th align="left">Tip</th>
96	</tr>
97	<tr><td align="left" valign="top"><p>
98	Always send the output to a log file. It will contain of lot of stuff,
99	but is invaluable to check if all has gone right, or else diagnose what
100	has gone wrong.
101	</p></td></tr>
102	</table></div>
103	<div class="tip"><table border="0" summary="Tip">
104	<tr>
105	<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/src/images/tip.png"></td>
106	<th align="left">Tip</th>
107	</tr>
108	<tr><td align="left" valign="top"><p>
109	A return code of 0 is not a reliable indication that you have got what
110	you really want - inspecting the log file is the only certain way.
111	</p></td></tr>
112	</table></div>
113	<div class="tip"><table border="0" summary="Tip">
114	<tr>
115	<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/src/images/tip.png"></td>
116	<th align="left">Tip</th>
117	</tr>
118	<tr><td align="left" valign="top"><p>
119	If you upgrade compiler version, for example MSVC from 9 to 10, then you
120	may need to rebuild Autoindex to avoid what Microsoft call a 'side-by-side'
121	error. And make sure that the autoindex.exe version you are using is the
122	new one.
123	</p></td></tr>
124	</table></div>
125	</div>
126	<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
127	<td align="left"></td>
128	<td align="right"><div class="copyright-footer">Copyright © 2008, 2011 John Maddock<p>
129	Distributed under the Boost Software License, Version 1.0. (See accompanying
130	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>)
131	</p>
132	</div></td>
133	</tr></table>
134	<hr>
135	<div class="spirit-nav">
136	<a accesskey="p" href="build.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/options.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
137	</div>
138	</body>
139	</html>