Category : EmTeX is a TeX/LaTeX document editor
Archive   : DTEX25A.ZIP
Filename : DETEX.MAN

groff -man detex.1l



DETEX(1L) DETEX(1L)


NNAAMMEE
detex - a filter to strip _T_e_X commands from a .tex file.

SSYYNNOOPPSSIISS
ddeetteexx [ --ccllnnssttww ] [ --ee _e_n_v_i_r_o_n_m_e_n_t_-_l_i_s_t ] [ _f_i_l_e_n_a_m_e[.tex]
... ]

DDEESSCCRRIIPPTTIIOONN
_D_e_t_e_x (Version 2.4) reads each file in sequence, removes
all comments and _T_e_X control sequences and writes the
remainder on the standard output. All text in math mode
and display mode is removed. By default, _d_e_t_e_x follows
\input commands. If a file cannot be opened, a warning
message is printed and the command is ignored. If the --nn
option is used, no \input or \include commands will be
processed. This allows single file processing. If no
input file is given on the command line, _d_e_t_e_x reads from
standard input.

If the magic sequence ``\begin{document}'' appears in the
text, _d_e_t_e_x assumes it is dealing with _L_a_T_e_X source and
_d_e_t_e_x recognizes additional constructs used in _L_a_T_e_X.
These include the \include and \includeonly commands. The
--ll option can be used to force _L_a_T_e_X mode and the --tt
option can be used to force _T_e_X mode regardless of input
content.

Text in various environment modes of _L_a_T_e_X is ignored.
The default modes are array, eqnarray, equation, figure,
mathmatica, picture, table and verbatim. The --ee option
can be used to specify a comma separated _e_n_v_i_r_o_n_m_e_n_t_-_l_i_s_t
of environments to ignore. The list replaces the defaults
so specifying an empty list effectively causes no environ-
ments to be ignored.

The --cc option can be used in _L_a_T_e_X mode to have detex echo
the arguments to \cite, \ref, and \pageref macros. This
can be useful when sending the output to a style checker.

_D_e_t_e_x assumes the standard character classes are being
used for _T_e_X. _D_e_t_e_x allows white space between control
sequences and magic characters like `{' when recognizing
things like _L_a_T_e_X environments.

If the --ww flag is given, the output is a word list, one
`word' (string of two or more letters and apostrophes
beginning with a letter) per line, and all other charac-
ters ignored. Without --ww the output follows the original,
with the deletions mentioned above. Newline characters
are preserved where possible so that the lines of output
match the input as closely as possible.

The TEXINPUTS environment variable is used to find \input
and \include files.



Purdue University 21 September 1992 1





DETEX(1L) DETEX(1L)


Detex now handles the basic TeX ligatures as a special
case, replacing the ligatures with acceptable charater
substitutes. This eliminates spelling errors introduced
by merely removing them. The ligatures are \aa, \ae, \oe,
\ss, \o, \l (and their upper-case equivalents). The spe-
cial "dotless" characters \i and \j are also replaced with
i and j respectively.

Note that previous versions of _d_e_t_e_x would replace control
sequences with a space character to prevent words from
running together. However, this caused accents in the
middle of words to break words, generating "spelling
errors" that were not desirable. Therefore, the new ver-
sion merely removes these accents. The old functionality
can be essentially duplicated by using the --ss option.

SSEEEE AALLSSOO
tex(1L)

DDIIAAGGNNOOSSTTIICCSS
Nesting of \input is allowed but the number of opened
files must not exceed the system's limit on the number of
simultaneously opened files. _D_e_t_e_x ignores unrecognized
option characters after printing a warning message.

AAUUTTHHOORR
Daniel Trinkle, Computer Science Department, Purdue Uni-
versity

BBUUGGSS
_D_e_t_e_x is not a complete _T_e_X interpreter, so it can be con-
fused by some constructs. Most errors result in too much
rather than too little output.

Running _L_a_T_e_X source without a ``\begin{document}''
through _d_e_t_e_x may produce errors.

Suggestions for improvements are encouraged.



















Purdue University 21 September 1992 2