.\"	manual page for lot2mml(1)
.\"
.\"	Copyright (c) 1996 Daniel Amyot <damyot@csi.uottawa.ca>
.\"
.\"	Permission is granted to anyone to use this software for any
.\"	purpose on any computer system, and to alter it and redistribute
.\"	it freely, subject to the following restrictions:
.\"
.\"	1. The author is not responsible for any consequences of use of
.\"	   this software, even if they arise from flaws in it.
.\"
.\"	2. The origin of this software must not be misrepresented, either
.\"	   by explicit claim or by omission.  Credits must appear in the
.\"	   documentation.
.\"
.\"	3. Altered versions must be plainly marked as such, and must not
.\"	   be misrepresented as being the original software.  Credits must
.\"	   appear in the documentation.
.\"
.\"	4. This notice may not be removed or altered.
.nr ES 5n
.de ES
.PP
.in +\\n(ESu
.nf
..
.de EE
.in -\\n(ESu
.fi
.PP
..
.de PT
.ie \\n(.$>1 .TP "\\$2"
.el .TP
.ie !'\\$1'' \\$1
.el \(bu
..
.ds Nr \fInroff\fR
.TH LOT2MML 1 "14 September, 1996"
.BY "Daniel Amyot"
.SH NAME
lot2mml \- 
translates a LOTOS specification into a MML document readable by FrameMaker
.SH SYNOPSIS
lot2mml
[
.BI \-d " DefFile"
] [
.I InFile
] [ > 
.I OutFile
]
.PP
.B lot2mml \-h 

.SH DESCRIPTION
lot2mml is a filter for documentation of LOTOS specifications.
It outputs a simple MML document enhencing the readability of the
specification when using FrameMaker. The resulting MML documents can
be imported and included in larger documents.
.PP
The filter has a number of features:
.IP \(bu 2
Keywords and comments are enhanced with user-defined tags.
.PT
Default settings are implemented, but MML macros-tags used for
enhancement are fully configurable via a simple definition
file 
.I (lot2mml.def)
.PT
The structure of the specification and upper/lowercase characters
remain unchanged.  No syntactical or grammatical checking is done.
.PP
lot2mml can be used as an independent application, or as a filter
(it can use standard input and output).
.SH OPTIONS
lot2mml
[
.BI \-d " DefFile"
] [
.I InFile
] [ >
.I OutFile
]
.PP
lot2mml \-h
.PP
Where:
.TP
.I "DefFile"
Definition file (MML macros). Internal default values.
.TP
.I InFile
Input file (in LOTOS). Default is stdin
.TP
.I OutFile
Output file (in MML). Default is stdout
.TP
.BI \-d " DefFile"
Overrides the default tag definitions with the ones defined in 
.I DefFile. 
Default definitions are:
.LP
         LOTOS keywords: Bold
         Comments:       Italic
.LP
.IP
This file will be referenced (included) by the output file,
so make sure it is in the same directory, or provide the
full path.
.TP
.BI \-h
Displays a short help message.
.SH DEFINITION FILE
Included here are the default definitions in the input format
for 
.I DefFile
: a set of MML macros. 2 pairs of macros 
.I (BKW, EKW, BCom, ECom) 
must be defined by the user.
Macros 
.I S, LC 
and
.I p
must not be modified.
Macros 
.I code
(character definition) and 
.I LotosCode
(paragraph definition) can be modified, but they must be present.
.PP
Please, read the Maker Markup Language (MML) Reference Manual from
Adobe (FrameMaker) for more details on how to define macros.
.PP
.I NOTE
You should make sure that the End tag variable (E??) 
contains a MML macro that matches the one in the Begin tag variable (B??).
.ES
<Comment *** lot2mml.def *** - Macro definitions>
<Comment Daniel Amyot, September 14, 1996>

<Comment - Do not modify this section>
<!DefineMacro S "<HardSpace>">
<!DefineMacro LC "<LotosCode>">
<!DefineMacro p "<S><par>"> 

<Comment - These macros can be modified but MUST BE DEFINED>
<!DefineFont code
    <Family Courier>
    <FirstIndent 0>
    <pts 9>
>
<!DefinePar LotosCode
   <code>
>

<Comment - Make sure that Begin and End tags match!>
<Comment - BeginKeyWord, EndKeyWord>
<!DefineMacro BKW "<bold>">
<!DefineMacro EKW "<nobold>">
<Comment - BeginComment, EndComment>
<!DefineMacro BCom "<oblique>">
<!DefineMacro ECom "<nooblique>">

<Comment - End of definitions>
.EE
.SH COMPILING
.B lot2mml
is written in GNU flex. It should be easy to port it to any platform. It has been tested under SunOS 4, DOS 6 (with GO32) and Linux. In order to compile, you need flex and gcc or something equivalent:
.TP
.BI DOS
.LP
    flex -i lot2mml.lex
    gcc -O2 lexyy.c -o lot2mml.exe
.LP
.TP
.BI UNIX
.LP
    flex -i lot2mml.lex
    gcc -O2 lex.yy.c -o lot2mml
.LP
.SH NOTE
MML does not have the color and hyperlink capacities of MIF (Maker Interchange Format, a more complex language) or HTML. Therefore, this filter is simpler than
.B lot2html.
.SH VERSION
Version 0.2, September 14, 1996
.SH SEE ALSO
Other filter: lot2html(1)
.PP
Configuration file: lot2mml.def
.PP
Source file: lot2mml.lex
.SH AUTHOR
.I Daniel Amyot, damyot@csi.uottawa.ca
.PP
http://www.csi.uottawa.ca/~damyot