Command Line Options

Doctran can be supplied with the command-line options shown below.

Help

These options force Doctran to display various information meant to be helpful to the user.

 Option name Description --help Displays usage information. --license Run Doctran with this options to enter a license key and view license information. --plugins This option forces Doctran to check the plugins path for any plugins present and write their names and version. Doctran will exit immediately after plugins have been checked. --time-run Specifies that an XML file should be generated containing timing information of the run. --verbose VALUE Sets how much information should written to the screen. VALUE can be the following: 1 - No output apart from fatal errors. 2 - (Default) Basic information output. Statement of the current operation, warning messages and fatal errors are written to the screen. 3 - Detailed information output. Everything from 2 with a lot of information on what is processing.

I/O

These options allow the user to affect the input and output.

 Option name Description --output, -o DIR DIR is the output directory for the documentation. (Default: Docs). --overwrite If this option is specified, then the auxiliary files (css, scripts, etc.) and html files in the output directory will be overwritten. If not, then just the html files will be overwritten, which is the default behaviour. --no-output Instructs the program not to generate any documentation. If --save-xmls appears, XML data will still be saved. (Default: false). --save-xmls Specify the intermediary XML documents will be saved int he output directory. By default these documents are not saved.

Project

These options allow the user to specify information relating to their project.

 Option name Description --project-info FILE, FILE is the name and/or path of the project's information file.