NAME

TeXidate - Heuristical validation of the header of LaTeX files.


SYNOPSIS

TeXidate
[--debug] [--help,-h] [--language,-l language] [--legend|-L] [--version] [--withsource,-s] [--wrapwidth,-w value] [LaTeX-file [output-file]]


OPTIONS

--debug
Toggle debug mode. Default is off.

--help,-h
Show a help message text and exit.

--language,-l language
Set the language of the analyzation output. language should be something like de, de_DE, de_DE@euro, de_CH or similar. Currently only the part before the first ``_'' or ``@'' will be used to select the language. Default language is english, which will be used also, if an unknown language was selected. Known languages are:
de
German

en
English

--legend,-L
Toggle output of legend. The legend describes the composition of the analyzation messages and the meaning of the message classes. Default is off.

--version
Show version information and exit.

--withsource,-s
Toggle output of source with linenumbers at the end of the analyzation. Default is off.

--wrapwidth,-w value
Sets the line width to value. Default is the value of environment variable COLUMNS or 80 if the variable is not set.


ARGUMENTS

LaTeX-file
The name of the file to be analyzed. You may use ``-'' for standard input. Default is standard input.

output-file
The name of the file for the diagnostic messages. Default is standard output.

If only one argument is given, this is the LaTeX-file. Output is written to standard output in this case.

If no argument is given, input will be read from standard input and the message will be written to standard output. This is the default.


DESCRIPTION

TeXidate will read the given LaTeX-file and does some analysis. Some typical mistakes are detected, but it doesn't show all the miracles. It may even fail completely in its diagnostics, because it searches only for patterns and doesn't analyze the real structure. TeXidate doesn't provide a real TeX parser.

You may also call TeXidate as CGI. In that case the contents of the file has to be the value of CGI-parameter contents.


ENVIRONMENT

TeXidate uses the following environment variables:

COLUMNS
Default value for the line length of the analyzation output. You may overwrite this value using option --wrapwidth.

LC_MESSAGES
Default value for the language of the analyzation output. You may overwrite this value using option --language.

LC_ALL
Default value for the language if environment variable LC_MESSAGES was not defined.

LANG
Default value for the language if environment variable LC_MESSAGES and LC_ALL was not defined.


AUTHOR

Copyright (c) 2003 Markus Kohm <kohm@gmx.de>