CADiZ

Reference manual / Auxiliary tools / putzml


SYNOPSIS

putzml [-Xn] [-Xp] [-Xs scriptname ] [-Xt] [cadiz-options] filename

DESCRIPTION

The putzml tool reads the Z specification that starts at filename.z (or filename.tex). It writes just those sections that are in filename.z, writing them in an XML mark-up that conforms to the ZML XML Schema definition. It uses cadiz's API to acquire the Z specification, so it works only for type-correct Z. Any cadiz-options on the command line are forwarded to that cadiz. If those include a mark-up encoding option, such as -UTF8, then the XML mark-up is written using the same encoding. The output is written with sections in definition before use order, with operator templates moved to immediately after section headers.

OPTIONS

-Xn

Output the namespace prefix Z: on all tags.

-Xp

Do not output tags; just output parentheses.

-Xs scriptname

Parse the named proof script in the context of the given Z specification and output just its ZML not that of the Z specification.

-Xt

Output type annotations.

Other options are forwarded to cadiz.

ENVIRONMENT

ARCH

specifies the processor architecture on which putzml is to be executed. Unless you are accessing putzml remotely in a heterogeneous computing network, the default is likely to be appropriate. Recognised values include i486 and cygwin.

CADIZ

names the directory in which CADiZ is installed. In particular, commands are kept in $CADIZ/mip/bin. If that directory is in your $PATH, then it is not necessary to set the CADIZ variable.

CADIZPATH

is a search path of directories in which putzml will look for files. putzml looks in the directory of toolkits $CADIZ/mip/kits/$MARKUP first, then any directories given by $CADIZPATH, and lastly in the current directory.

MARKUP

should be either latex or groff. This determines which mark-up putzml assumes is used in the input files. It defaults to groff.

EXIT STATUS

The exit status of putzml is

0

if no errors are detected in the entire specification,

1

if some errors are detected in the specification,

2

if putzml detects something amiss with itself.


IT 31-Jan-2006