Re: Using QuickBook

Daniel James <[email protected]> Thu, 4 Aug 2016 16:19:05 +0100
Newsgroups gmane.comp.lib.boost.documentation
Message-ID <CAHOE3yc=gub9kT6V2QUhMSVu8zrQ_QKCp8VmSQrYi8yZS0O7MA@mail.gmail.com>
On 27 July 2016 at 19:25, Stefan Seefeld <[email protected]> wrote:
>
> I'm looking for basic instructions about how to use (run) the
> `quickbook` tool. The documentation at
> http://www.boost.org/doc/libs/1_61_0/doc/html/quickbook.html explains
> the document structure & syntax of a .qbk file, but I can't find any
> information telling me how to invoke the `quickbook` tool itself, i.e.
> what the options mean, and what the input and output files are. The
> output of `quickbook --help` seems a little incomplete, too.

Here's a first draft of some documentation:

http://www.boost.org/doc/libs/develop/doc/html/quickbook/command_line.html

Source code:

https://github.com/boostorg/quickbook/blob/develop/doc/command_line.qbk

'--no-self-linked-headers' doesn't actually do anything at all in
existing versions, but there's a fix in develop which will hopefully
be included in the next release. But it's not particularly useful
anyway.