BOOTSTRAP commands


PROGRAM NAME

ghostwriter - Generates code & doc for all software objects.

DESCRIPTION

Ghostwriter is a code and documentation generation tool which is used to maintain all software objects in the Khoros system.

When used with a program object, ghostwriter generates the main, the code to obtain command line arguments, the usage routine, and skeleton documentation for the program. When used with a library object, ghostwriter generates man pages for each of the public routines in the library as well as a man page for the library as a whole. It also registers a program or library as an object within a toolbox, and maintains the database files associated with a software object that maintain crucial information such as the location of files and values of software object attributes.

Ghostwriter is executed by composer when a software object is created; it is also executed when you click on the "Generate Code" button on composer's main form. If desired, you may run ghostwriter directory from the command line, either by executing it in the src/ directory of the software object for which you want to generate code and documentation, or by specifying the software object using the [-tb] and [-oname] arguments.

Issues concerning documentation and code generated by ghostwriter are covered in Chapter 6 of the Toolbox Programmer's Manual; please see this chapter for more information.

tb: The [-tb] flag specifies the name of the toolbox in which the software object is installed; ghostwriter needs to know which toolbox your software object is installed in so that it can find the files associated with the software object. If ghostwriter is run when the local directory is in the directory structure of the toolbox in question, the [-tb] option can be left off, as the toolbox can be extrapolated from the current directory location.

oname: The [-oname] flag specifies the name of the software object on which ghostwriter is to be run. If ghostwriter is run when the local directory is the src/ directory of the software object in question, the [-oname] option can be left off, as the software object can be extrapolated from the directory location.

force: Setting this flag to TRUE will force over-write of files; that is, it will suppress prompting before a file is over-written.

debug: Generally used only by members of the Khoros programming staff, providing a value of TRUE (1) for [-debug] will cause ghostwriter to put kfprintf() statements in the main() of the generated program, so that values provided on the user on the command line are printed out.

REQUIRED ARGUMENTS

none

OPTIONAL ARGUMENTS

-tb
type: string
desc: toolbox name
default: {none}
-oname
type: string
desc: object name
default: {none}
-force
type: flag
desc: force output?
-debug
type: flag
desc: generate debug stmts?

EXAMPLES

% ghostwriter -tb datamanip -oname karith1

SEE ALSO

Craftsman, composer.

RESTRICTIONS

Ghostwriter is restricted to the generation of C code. Support for other programming languages and scripting languages may be added some time in the future. Resultingly, ghostwriter is unable to generate code to implement a standardized command line user interface for script objects.

REFERENCES

Chapter 6 of the Khoros Toolbox Programming Manual.

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.