\begindata{text,538334184}
\textdsversion{12}
\template{help}
\define{global
}
\chapter{Toez: Convert to Andrew File Format

}
\section{What Toez is

}\leftindent{
Toez is a non-interactive ATK application program that converts non-Andrew 
files to Andrew (\helptopic{EZ}) file format.  The program is most useful for 
converting \helptopic{Scribe} and troff/nroff files to EZ readable format. 
 The program can also be used to convert any ascii text file to EZ format (by 
putting in line wraps, etc.)

}
\section{Warnings

}\leftindent{
Toez is not designed to convert every possible Scribe or 
\helptopic{troff}/\helptopic{nroff} command to an EZ format.  Format commands 
that do not have EZ equivalents will not be translated -- instead the command 
itself will be reproduced as text wrapped in formatnote style in the resulting 
EZ file. This may cause some irregularities in printing on occasion.  Also, 
user-defined formats and styles will also not be converted.  The best way to 
use toez is to run the conversion, then check the resulting file for any 
formats that were not converted and change those individually.


@indexentry items in the Scribe format are converted only by the placement of 
a space before the value of the "Entry=" portion of the item.  In other words, 
any item with @indexentry will appear first in the resulting EZ index in the 
converted version.


Sometimes the EZ definition of a style is different from the Scribe definition 
of that style, and you may see some differences in the output.

}
\section{How Toez works


}\leftindent{Toez reads the file to be converted and tries to determine if the 
file is in Scribe, troff, or nroff format, then converts the format commands 
in the file to their EZ equivalents.  If an extension (such as .mss) is 
provided, toez will use the extension to determine the filetype.  


Formats that cannot be translated are left alone and reproduced as text 
wrapped in formatnote style.  If the file to be converted is not identified as 
Scribe or nroff/troff, toez treats the file as an ascii text and runs a 
conversion of ascii to ATK.  


Newlines in the input file are translated to blanks to convert sequential 
lines into paragraphs (i.e. so the lines will wrap).  Some newlines are left 
alone -- these include:


multiple newlines

newlines around lines that contain tabs

newlines around a sequence of three or more blank spaces

newlines that precede or follow certain known Scribe commands

newlines before a line that begin with a space

newlines inside a style such as Example, Formatnote, or Display


Newlines will be converted to two spaces if the preceding line ends with one 
of the five characters \bold{. : ; ! ? }or one of these characters followed 
by\bold{ )} or \bold{"}.\section{

}
Note:  Toez subsumes an old \helptopic{rofftext} application (although the 
application is still needed -- toez uses it).

}
\section{Quick reference

}\leftindent{
toez \italic{filename}  -o \italic{EZfilename}


where\italic{ filename} is the name of the file to be converted (include 
extensions) and \italic{EZfilename }is the name of the file that will contain 
the converted form of the original file.


If no input file is given, input is from stdin.

If no output file is given, stdout is assumed.


}\section{Options}


\leftindent{Main switches:


-h, -help	print help message

-scribe 	tells the program explicitly that the input is in Scribe

-nroff	tells the program explicitly that the input is in

-troff	tells the program explicitly that the input is in

-	input from stdin  (analysis is limited)

-o FILE	output to file named FILE



Switches for nroff/troff:


-H	special mode for help system

-m MAC	/usr/lib/tmac/tmac.MAC



Examples:


toez -h

toez -scribe thesis.mss -o thesis.d

}
\section{Program Author}

\leftindent{
WJ Hansen}


\section{Related tools}  


Select (highlight) one of the italicized names and choose "Show Help on 
Selected Word" from the pop-up menu to see the help file for:


\leftindent{\italic{\helptopic{ez}}

\helptopic{\italic{scribe}}

\helptopic{\italic{troff}}

\helptopic{\italic{nroff}}

\helptopic{\italic{rofftext}}}


\begindata{bp,537558784}
\enddata{bp,537558784}
\view{bpv,537558784,170,0,0}
Copyright 1992 Carnegie Mellon University and IBM.  All rights reserved.

\smaller{\smaller{$Disclaimer: This software is part of version 6.1 of the 

Andrew User Interface System and is 

the property of IBM, Carnegie Mellon University, 

and the other copyright holders.  The source 

code of this version is for the sole use of 

the individual named in ./config/allsys.h.  

This source code is not to be redistributed.  

Binary object code compiled or derived from 

these sources is not to be distributed to non-

members.  Members may have additional 

distribution rights granted by prior written 

permission of Carnegie Mellon University.



IBM, CARNEGIE MELLON UNIVERSITY, 

AND THE OTHER COPYRIGHT HOLDERS

 DISCLAIM ALL WARRANTIES WITH 

REGARD TO THIS SOFTWARE, INCLUDING 

ALL IMPLIED WARRANTIES OF MERCHANT-

ABILITY AND FITNESS. IN 

NO EVENT SHALL  IBM, CARNEGIE 

MELLON UNIVERSITY, OR ANY OTHER 

COPYRIGHT HOLDER BE LIABLE FOR 

ANY SPECIAL, INDIRECT OR CONSE-

QUENTIAL DAMAGES OR ANY DAMAGES 

WHATSOEVER RESULTING FROM LOSS OF

USE, DATA OR PROFITS, WHETHER IN AN

ACTION OF CONTRACT, NEGLIGENCE OR

OTHER TORTIOUS ACTION, ARISING OUT 

OF OR IN CONNECTION WITH THE USE OR

PERFORMANCE OF THIS SOFTWARE.

 $

}}\enddata{text,538334184}
