1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
.TH QUICKBOOK "1" "July 2009" "Quickbook Version 1.4" "User Commands"
.SH NAME
Quickbook \- WikiWiki style documentation tool geared towards C++ documentation
.SH DESCRIPTION
.B QuickBook
is a WikiWiki style documentation tool geared towards C++
documentation using simple rules and markup for simple formatting
tasks.
.B QuickBook
extends the WikiWiki concept. Like the WikiWiki,
QuickBook documents are simple text files. A single QuickBook document
can generate a fully linked set of nice HTML and PostScript/PDF
documents complete with images and syntax- colorized source code.
.PP
Features include:
.PP
* generate BoostBook xml, to generate HTML, PostScript and PDF
* simple markup to link to Doxygen-generated entities
* macro system for simple text substitution
* simple markup for italics, bold, preformatted, blurbs, code samples, tables, URLs, anchors, images, etc.
* automatic syntax coloring of code samples
* CSS support
.SS "Allowed options:"
.TP
\fB\-\-help\fR
produce help message
.TP
\fB\-\-version\fR
print version string
.TP
\fB\-\-no\-pretty\-print\fR
disable XML pretty printing
.TP
\fB\-\-indent\fR arg
indent spaces
.TP
\fB\-\-linewidth\fR arg
line width
.TP
\fB\-\-input\-file\fR arg
input file
.TP
\fB\-\-output\-file\fR arg
output file
.TP
\fB\-\-debug\fR
debug mode (for developers)
.TP
\fB\-\-ms\-errors\fR
use Microsoft Visual Studio style error & warn
message format
.HP
\fB\-I\fR [ \fB\-\-include\-path\fR ] arg include path
.SH "SEE ALSO"
The full documentation for
.B Quickbook
is maintained in HTML; see
/usr/share/doc/libboostX.Y-doc/HTML/doc/html/quickbook.html
|
