1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> 4<title>Command Line Reference</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="../index.html" title="Boost.AutoIndex"> 9<link rel="prev" href="qbk.html" title="Quickbook Support"> 10<link rel="next" href="../index/s08.html" title="Index"> 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="qbk.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../index/s08.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 27<a name="boost_autoindex.comm_ref"></a><a class="link" href="comm_ref.html" title="Command Line Reference">Command Line Reference</a> 28</h2></div></div></div> 29<p> 30 The following command line options are supported by AutoIndex: 31 </p> 32<div class="variablelist"> 33<p class="title"><b></b></p> 34<dl class="variablelist"> 35<dt><span class="term">--in=infilename</span></dt> 36<dd><p> 37 Specifies the name of the XML input file to be indexed. 38 </p></dd> 39<dt><span class="term">--out=outfilename</span></dt> 40<dd><p> 41 Specifies the name of the new XML file to create. 42 </p></dd> 43<dt><span class="term">--scan=source-filename</span></dt> 44<dd><p> 45 Specifies that <span class="emphasis"><em>source-filename</em></span> should be scanned 46 for terms to index. 47 </p></dd> 48<dt><span class="term">--script=script-filename</span></dt> 49<dd><p> 50 Specifies the name of the script file to process. 51 </p></dd> 52<dt><span class="term">--no-duplicates</span></dt> 53<dd><p> 54 If a term occurs more than once in the same section, then include only 55 one index entry. 56 </p></dd> 57<dt><span class="term">--internal-index</span></dt> 58<dd><p> 59 Specifies that AutoIndex should generate the actual indexes rather than 60 inserting <code class="computeroutput"><span class="special"><</span><span class="identifier">indexterm</span><span class="special">></span></code>s and leaving index generation to 61 the XSL stylesheets. 62 </p></dd> 63<dt><span class="term">--no-section-names</span></dt> 64<dd><p> 65 Prevents AutoIndex from using section names as index entries. 66 </p></dd> 67<dt><span class="term">--prefix=pathname</span></dt> 68<dd><p> 69 Specifies a directory to apply as a prefix to all relative file paths 70 in the script file. 71 </p></dd> 72<dt><span class="term">--index-type=element-name</span></dt> 73<dd><p> 74 Specifies the name of the XML element to enclose internally generated 75 indexes in: defaults to <span class="emphasis"><em>section</em></span>, but could equally 76 be <span class="emphasis"><em>appendix</em></span> or <span class="emphasis"><em>chapter</em></span> or some 77 other block level element that has a formal title. 78 </p></dd> 79</dl> 80</div> 81</div> 82<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 83<td align="left"></td> 84<td align="right"><div class="copyright-footer">Copyright © 2008, 2011 John Maddock<p> 85 Distributed under the Boost Software License, Version 1.0. (See accompanying 86 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>) 87 </p> 88</div></td> 89</tr></table> 90<hr> 91<div class="spirit-nav"> 92<a accesskey="p" href="qbk.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../index/s08.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 93</div> 94</body> 95</html> 96
