quickbook(1) [debian man page]

QUICKBOOK(1)							   User Commands						      QUICKBOOK(1)

NAME

       Quickbook - WikiWiki style documentation tool geared towards C++ documentation

DESCRIPTION

       QuickBook  is  a  WikiWiki  style  documentation  tool geared towards C++ documentation using simple rules and markup for simple formatting
       tasks.  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.

       Features include:

	   * 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

   Allowed options:
       --help produce help message

       --version
	      print version string

       --no-pretty-print
	      disable XML pretty printing

       --indent arg
	      indent spaces

       --linewidth arg
	      line width

       --input-file arg
	      input file

       --output-file arg
	      output file

       --debug
	      debug mode (for developers)

       --ms-errors
	      use Microsoft Visual Studio style error & warn message format

       -I [ --include-path ] arg include path

SEE ALSO

       The full documentation for Quickbook is maintained in HTML; see /usr/share/doc/libboostX.Y-doc/HTML/doc/html/quickbook.html

Quickbook Version 1.4						     July 2009							      QUICKBOOK(1)

SYNOPSIS(1)							   User Commands						       SYNOPSIS(1)

NAME

       synopsis  - simple frontend to the Synopsis framework, a multi-language source code introspection tool that provides a variety of represen-
       tations for the parsed code, to enable further processing such as  documentation  extraction,  reverse  engineering,  and  source-to-source
       translation.

DESCRIPTION

       Usage : synopsis [options] <input files>

   List of options:
       -h, --help
	      Display usage summary.

       -V, --version
	      Display version information.

       -v  --verbose
	      Operate verbosely.

       -d  --debug
	      Operate in debug mode.

       -P  --profile
	      Profile execution.

       -o <file>, --output=<file>
	      Write output to <file>.

       -p <lang>, --parser=<lang>
	      Select a parser for <lang>.

       -Wp,<arg>[,<arg>...]
	      Send <args> to the parser.

       -t [<markup>]

       --translate[=<markup>]
	      Translate comments to doc-strings, processing it as <markup> (typical values are 'javadoc' or 'rst').

       --cfilter=<filter>
	      Specify a comment filter.

       --cprocessor=<processor>
	      Specify a comment processor.

       -Wc,<arg>[,<arg>...]
	      Send <args> to the comment translator.

       -l     Run the linker.

       -Wl,<arg>[,<arg>...]
	      Send <args> to the linker.

       --linker=<processor>
	      Link, and invoke <processor>.

       -f <type>,

       --formatter=<type>
	      Select a formatter for <type>.

       -Wf,<arg>[,<arg>...]
	      Send <args> to the formatter.

       -I <path>
	      Add <path> to list of include paths.

       -D <macro>
	      Add <macro> to list of predefined macros.

       -s <directory>,

       --sxr=<directory>
	      Specify sxr directory. If given, process source cross-references.

       --probe
	      Probe the specified processor.

synopsis version devel (revision unknown)			    April 2009							       SYNOPSIS(1)