CADiZ

Reference manual / Auxiliary tools / markup


SYNOPSIS

markup [-UTF8 | -UTF16BE | -UCS4] [-t file.mud | -z file.mud] [filename]

DESCRIPTION

The markup tool reads mark-up from the named file (default standard input) and writes a sequence of corresponding UCS characters to its standard output. It is implemented as a script that chooses from separate programs depending on the setting of the MARKUP environment variable.

Mark-up of a specification should be processed by the section tool prior to processing by the markup tool. After processing by the markup tool, the UCS characters cannot be lexed until operator templates have been permuted by the optemp tool.

OPTIONS

-UTF8 | -UTF16BE | -UCS4

Specifies the encoding to use for the output UCS characters, default UTF8.

-t file.mud

Assume that the input is a tactic, expressed using mark-up defined by the directives in file.mud.

-z file.mud

Assume that the input is a Z formula, expressed using mark-up defined by the directives in file.mud.

ENVIRONMENT

ARCH

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

CADIZ

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.

MARKUP

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

EXIT STATUS

The exit status of markup is

0

if no errors are detected in the entire specification,

1

if some errors are detected in the specification,

2

if markup detects something amiss with itself.

SEE ALSO

Section 7 of [Toyn02].


IT 28-Jan-2002