NAME
gi - Generates TOM Interfaces
SYNOPSIS
gi [options] [files]
DESCRIPTION
gi generates TOM interface files from implementation files. Implementation files are those written by the programmer; they have the extension `.t'. The interface files have the same name, with the extension `.j'.
When the files are not specified, gi will update every interface file in the unit which is out of date with respect to the implementation file.
When the files are specified, the -u option is not optional, and gi will create the unit file of the unit named with the -u option. In this case, any units depended upon can be specified using the -U option.
COMMON OPTIONS
- -I dir
-
Add the directory dir to the search path. A unit foo is searched for in the directories along the search path. If it is not found, it is searched for in the subdirectory foo of every directory along the search path.
The default search path is . (the current directory) and /usr/tom.
- -u unit
-
Name the unit for which to compile. A unit is defined by its unit file, a file with the extension
.u.
- --version
-
Output the version information and exit.
GI OPTIONS
- -fcomments
-
Include /* ... */ comments in the files generated.
- -fdocumentation
-
Include <doc> ... </doc> documentation comments in the files generated. With this option, interface files can be created which can be distributed without the implementations and still allowing the user to create html or texinfo documentation from them.
- -F
-
Force the generation of the interfaces irrespective of their modification time.
- -k
-
Continue with the remaining files after an error.
- -precious
-
Do not unlink the output files in case of an error.
- -U unit
-
When creating a unit file, every unit named with the -U option will be included in the unit file as a unit on which the current unit depends.
- -v
-
Increase verbosity.
EXAMPLES
gi -U tom -u hello hello.t
Create the unit file for the hello unit, which only contains the file hello.t, and which depends upon the tom unit.
gi -u hello
Update the interface files of the hello unit in the current directory.
SEE ALSO
AUTHOR
Pieter J. Schoenmakers <[email protected]>
Department of Electrical Engineering, room EH 9.26
Eindhoven University of Technology
P.O. Box 513
NL-5600 MB Eindhoven
the Netherlands
BUG REPORTS
Bugs can be reported to the author, at [email protected].
MORE INFORMATION
For more information, visit the TOM homepage at http://www.gerbil.org/tom/. To subscribe to the TOM mailing list, send mail to [email protected].