< VisDoc main page

Command-line interface to VisDoc

Although VisDoc is not really a command-line application, it is possible to launch VisDoc through the command line with parameters. This document describes the parameters that can be passed to VisDoc.

Updated: 17 Mar 2007

Invoking VisDoc

Using the Terminal, go to the folder where VisDoc resides. Type:
./VisDoc.app/Contents/MacOS/VisDoc

Parameters

Type:
./VisDoc.app/Contents/MacOS/VisDoc -h
or
./VisDoc.app/Contents/MacOS/VisDoc -help
to get the instructions listed below:

VisDoc version 2.0, 2007. Usage of command line options:

VisDoc [command-line-options-and-input-files-and-output-directory]
Use -h or -help to get this menu

FILES
	-process		1. List of (paths to) files to process, each separated by a comma (no spaces)
				2. (Path to) VisDoc project file to process
	-out			(Path to) output directory

CONTENTS
	-preserveLinebreaks	Preserve linebreaks (old style javadoc)
				values: 0 or 1; default: 1
	-listPrivate		List private members
				values: 0 or 1; default: 0
	-includeSourceCode	Include source code
				values: 0 or 1; default: 0
	-colorizeCode		Colorize code examples
				values: 0 or 1; default: 1
	-eventHandlerPrefixes	Distinguish event handlers by given prefixes
				value: string in quotes; default: "on,allow"

HTML
	-indexTitle		Generate frameset with title
				value: string; default: none (no frameset)
	-sidebarWidth		Width of left bar in percentage or pixels
				value: a number appended with px or %; default: 22%

FORMATTING
	-xsltFile		Path of XSLT file to use instead of the default template
				value: file path string; default: Default template
	-cssFile		Path of CSS file to use instead of the default template
				value: file path string; default: Default template
	-saveXML		Save intermediairy XML files
				values: 0 or 1; default: 0

OTHER
	-copyrightNotice	Write given copyright notice to the footer of each document
				value: string; default: none (no copyright notice)
	-giveCredits		Give VisDoc credits
				values: 0 or 1; default: 0