1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Command Line Usage</title> 6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../quickbook.html" title="Chapter 50. Quickbook 1.7"> 10<link rel="prev" href="change_log.html" title="Change Log"> 11<link rel="next" href="syntax.html" title="Syntax Summary"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 16<td align="center"><a href="../../../index.html">Home</a></td> 17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="change_log.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.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="syntax.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="section"> 27<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 28<a name="quickbook.command_line"></a>Command Line Usage</h2></div></div></div> 29<div class="toc"><dl class="toc"><dt><span class="section"><a href="command_line.html#quickbook.command_line.options">Command Line Options</a></span></dt></dl></div> 30<p> 31 Quickbook is generally run by a build tool, but if you want to run it manually, 32 it's pretty simple to use. Basic usage is: 33 </p> 34<pre class="programlisting">quickbook filename.qbk 35</pre> 36<p> 37 Which, if successful, will print out something like: 38 </p> 39<pre class="programlisting">Generating Output File: filename.xml 40</pre> 41<div class="section"> 42<div class="titlepage"><div><div><h3 class="title"> 43<a name="quickbook.command_line.options"></a><a class="link" href="command_line.html#quickbook.command_line.options" title="Command Line Options">Command Line Options</a> 44</h3></div></div></div> 45<div class="variablelist"> 46<p class="title"><b></b></p> 47<dl class="variablelist"> 48<dt><span class="term">--help</span></dt> 49<dd><p> 50 Prints out a summary of the options supported by quickbook, and exits. 51 </p></dd> 52<dt><span class="term">--version</span></dt> 53<dd><p> 54 Prints out the version of the quickbook executable, and exists. 55 </p></dd> 56<dt><span class="term">--no-pretty-print</span></dt> 57<dd><p> 58 Disable XML pretty printing. Normally quickbook runs its output through 59 a post processor which generates consistent XML indentation, this flag 60 disables it. 61 </p></dd> 62<dt><span class="term">--strict</span></dt> 63<dd><p> 64 Strict mode. Adds extra errors for possible issues, including sections 65 that weren't closed, and square brackets that don't match any tags 66 or templates. 67 </p></dd> 68<dt><span class="term">--no-self-linked-headers</span></dt> 69<dd><p> 70 By default quickbook generates docbook headers that link to themselves, 71 so that in a web browser you can get a link to the header by right 72 clicking on the header and copying the link. This requires generating 73 slightly odd boostbook markup, so this head disables the feature and 74 generates plain headers. 75 </p></dd> 76<dt><span class="term">--indent</span></dt> 77<dd><p> 78 Indentation to use in the pretty printer. 79 </p></dd> 80<dt><span class="term">--linewidth</span></dt> 81<dd><p> 82 Line width to use in the pretty printer. 83 </p></dd> 84<dt><span class="term">--input-file path</span></dt> 85<dd> 86<p> 87 Used to explicitly specify that the argument is an input file. Normally 88 not used, as you can just write: 89 </p> 90<pre class="programlisting">quickbook filename.qbk</pre> 91<p> 92 . But if you wish to you can also write: 93 </p> 94<pre class="programlisting">quickbook --input-file filename.qbk</pre> 95<p> 96 . This could be useful if a file path could be confused with an option, 97 for example to use a file called <code class="computeroutput">--filename.qbk</code>: 98 </p> 99<pre class="programlisting">quickbook --input-file --filename.qbk</pre> 100<p> 101 Only one input file can be specified. 102 </p> 103</dd> 104<dt><span class="term">--output-file path</span></dt> 105<dd><p> 106 Explicitly specifiy the path of the file to be generated. By default, 107 it's just the input file name with the extension replaced by <code class="computeroutput">.xml</code>. 108 </p></dd> 109<dt><span class="term">--no-output</span></dt> 110<dd><p> 111 Don't write out a boostbook file. This is useful for checking that 112 a document doesn't have any sytax errors, or for running with <code class="computeroutput">--output-deps</code>. 113 If <code class="computeroutput">--output-file-path</code> is also defined, that overwrites 114 this. 115 </p></dd> 116<dt><span class="term">--output-deps path</span></dt> 117<dd><p> 118 Writes the full path of all the files read in by quickbook to the given 119 path. This is useful for build tools so that they can tell when to 120 rebuild the documentation. 121 </p></dd> 122<dt><span class="term">--ms-errors</span></dt> 123<dd><p> 124 Use Microsoft Visual Studio style error and warn message format, so 125 that Visual Studio IDE will understand them. 126 </p></dd> 127<dt><span class="term">--include-path path, -I path</span></dt> 128<dd><p> 129 Add the given path to the include path, can be specified multiple times. 130 </p></dd> 131<dt><span class="term">--define macro, -D macro</span></dt> 132<dd> 133<p> 134 Define a quickbook macro. This can have a value: 135 </p> 136<pre class="programlisting">quickbook -D __foo__=bar</pre> 137<p> 138 Or you can just define an empty macro: 139 </p> 140<pre class="programlisting">quickbook -D __foo__</pre> 141<p> 142 This can be useful for <a class="link" href="syntax/phrase.html#quickbook.ref.cond">conditional 143 generation</a>. 144 </p> 145</dd> 146<dt><span class="term">--image-location path</span></dt> 147<dd><p> 148 Path the image elements are relative to. This is only used for reading 149 in SVG details. 150 </p></dd> 151</dl> 152</div> 153</div> 154</div> 155<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 156<td align="left"></td> 157<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman, 158 Eric Niebler<br>Copyright © 2010-2017 Daniel James<p> 159 Distributed under the Boost Software License, Version 1.0. (See accompanying 160 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>) 161 </p> 162</div></td> 163</tr></table> 164<hr> 165<div class="spirit-nav"> 166<a accesskey="p" href="change_log.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.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="syntax.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 167</div> 168</body> 169</html> 170
