Command Line Reference

This chapter provides a reference to Doxyrest command line options.

General form of command-line tool usage:

doxyrest <doxygen-index.xml> <options>...

When specifying options values, you can use either of the following ways:

• Separate with space:

  -o index.rst
  --output index.rst
  

• Separate with =:

  -o=index.rst
  --output=index.rst
  

• Concatenate (only for single-char options):

  -oindex.rst
  

Options

-h, --help

Prints help screen.

-v, --version

Prints version of Doxyrest.

-c, --config

Overrides the name of configuration file (defaults to doxyrest-config.lua), for example:

-c myconfig.lua
--config myconfig.lua

This file should contains a Lua script which sets up all the necessary language-specific frame settings.

See also: 1.2 Preparing doxyrest-config.lua

-o, --output

Specifies master (index) output file, for example:

-o index.rst
--output index.rst

-f, --frame

Specifies Lua master (index) frame file, for example:

-f index.rst.in
--frame index.rst.in

-F, --frame-dir

Adds Lua frame directory, for example:

-F ./my-doxyrest-frame
--frame-dir ./my-doxyrest-frame

The --frame-dir switch may be used multiple times to add multiple directories.

-D, --define

Defines a Lua variable, for example:

-D myvar=value
--define myvar=value

If value if omitted, then it is assumed to be true, for example.:

-D myvar

is equivalent to:

-D myvar=true

This option allows you to write highly customizable Lua frames which produce different output depending on controlling variables.