Next: , Previous:   [Contents]


3 Invoking the program

OrgaDoc is usually run by the user who wishes to use it it is used very simply. The command is orgadoc [OPTIONS ...] [File ...] Which would do as the examples show and (depending on the options chosen) will convert your pool to your desired format. If no options are given the program will show the help text.

The program accepts the following options:

-h
--help

Displays the help text.

-v
--version

Displays the version information.

-t
--html

Formats readme.xml into HTML.

-b
--bibtex

Formats readme.xml into BIBTEX.

-l
--latex

Formats readme.xml into LATEX.

-j
--json

Formats readme.xml into JSON.

-p
--text

Formats readme.xml into PLAIN TEXT.