cadiz [ options ] file.z
cadiz checks Z specifications for type correctness, and typesets them using troff. The input file.z can be written using either a LATEX or troff mark-up. The output typeset specification is left in file.dit for future previewing or printing. By default, any error reports about the specification are written to the standard output. Alternatively, options are provided to request typesetting and previewing of the error reports on a workstation having a bit-map screen; a previewer for the specification can also be requested. If both previewers are requested, the mouse can be used to select and inspect formulae of interest.
Any unrecognised options are forwarded to troff.
Run a particular release of cadiz. Must be the first option given. If not given, a release nominated when cadiz was installed is run.
Browse an already typeset specification. Both previewing windows appear, and the specification is re-checked so that it can be examined.
Typeset and preview the error reports, but don't typeset or preview the specification.
Use a particular geometry for the user interface. This affects the sizes and positions of windows on the screen, and the line lengths and margins of the text displayed in those windows. Accepted values of geom include SVGA and VGA. The default assumes a 1280x1024 screen (larger than SVGA).
Report space usage statistics to the standard error stream.
Use n kilo-bytes of working space, default 512. Increasing this size will reduce the overall cost of garbage collections, but on a small or overloaded machine may lose through increased paging. May be worth using on a big machine at the start of a big session.
Log copies of the troff input streams in /tmp/cadiz$$ files. (j for journals.)
Keep the abstract syntax built for this file in file.k. (See option -l.)
Load abstract syntax from file file.k to speed imports of its documents and of its imported documents. Only one -l option may be given. The default is to load the mathematical toolkit [Spivey92]; use -l (no file) to start from just core Z.
Typeset and preview the specification, but not any error reports.
As -x, but additionally offer a third window showing a proof tree. (P for prove.)
Replay all proof scripts of named conjectures and proof obligations, and report their validity. Successful proof scripts are touched (their last modification date is revised) as an indication to the script manager command; the original dates of recording are still available within the scripts.
Report the types of all declarations.
Specifies the encoding to use for interchanging UCS characters with auxiliary tools, default UTF8.
Verify only: don't typeset or preview the specification or the error reports.
Report which version of cadiz is being run.
Silence warning messages.
Issue warnings about use of non-standard Z. (Silenced by -w.)
Typeset and browse the specification. The specification and any reports about it appear in two separate windows. (x for examine.)
Omit typesetting the explanatory text between the formal parts of the document.
specifies the processor architecture on which cadiz is to be executed. Unless you are accessing cadiz remotely in a heterogeneous computing network, the default is likely to be appropriate. Recognised values include irix6, solaris2 and i486.
names the directory in which CADiZ is installed. In particular, executables are kept in $CADIZ/mip/bin. If that directory is in your $PATH, then it is not necessary to set the CADIZ variable.
is a search path of directories in which cadiz will look for files. cadiz looks in the directory of toolkits $CADIZ/mip/kits/$MARKUP first, then any directories given by $CADIZPATH, and lastly in the current directory.
specifies the X server of the screen on which the previewing windows should appear. If that is serving a different screen, or a different user, then it may be necessary to grant permission explicitly, perhaps using the xhost command.
should be either latex or groff. This determines which parser cadiz uses. It defaults to groff.
names the directory where typeset errors and proof trees are held while they are previewed. It defaults to /usr/tmp. The typeset specification is also placed there if write permission is denied on the current directory.
The exit status of cadiz is
if no errors are detected in the entire specification,
if some errors are detected in the specification,
if cadiz detects something amiss with itself.