Console Application Options

The Console Application is a .NET 2.0 console application. Its purpose is to accept various command line parameters, and to load and execute a spy.doc project in order to generate the documentation help file, depending on the specific command line parameters. Once this is done the application quits. See the following section for more information:

Application Execution

The application can be executed with the following command line:

• spy.doc[.exe] [/h] [["]spydocProject["]]

The '[]' parentheses are used to indicate optional parameters. The spydocProject parameter should be enclosed in quotation symbols, if the file path contains spaces or other symbols that may affect the way the path is interpreted as a command line parameter. If no parameters are provided, the application will assume the '/h' parameter is specified.

/h

If present, this parameter causes the application information to be displayed, and the application quits.

spydocProject

This parameter is the full or relative path of the spy.doc project file to load and execute. The application will quit once the documentation generation is completed, or an error is encountered.

Application Information

The application displays the information message box, if it cannot determine which of the Windows or Console application to execute, or if the '/h' parameter is also present. When the message box is dismissed by the user, the application quits. The displayed information text is shown below:

• spy.doc Version 2007.1
  Copyright(c) Businessware Architects 2007
  Command: spy.doc [/h] [["]spydocProject["]]
      h:  Show help text.
      spydocProject: spy.doc project path (including file extension) to load and execute.