diff options
| author | Karl Berry <karl@freefriends.org> | 2006-01-03 00:00:18 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2006-01-03 00:00:18 +0000 |
| commit | a540e256be85df29c60ac323d4460c6cde1d9350 (patch) | |
| tree | d83a3a57112a9ec6966691569ecc2dfe78d82b81 /Master/texmf/doc/chktex | |
| parent | 84a45ba83a3095eb4908d4325981b11fc1b31b05 (diff) | |
trunk/Master/texmf/doc
git-svn-id: svn://tug.org/texlive/trunk@42 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc/chktex')
| -rw-r--r-- | Master/texmf/doc/chktex/ChkTeX.html | 4263 | ||||
| -rw-r--r-- | Master/texmf/doc/chktex/ChkTeX.pdf | bin | 0 -> 201168 bytes |
2 files changed, 4263 insertions, 0 deletions
diff --git a/Master/texmf/doc/chktex/ChkTeX.html b/Master/texmf/doc/chktex/ChkTeX.html new file mode 100644 index 00000000000..1bd0b8fdae4 --- /dev/null +++ b/Master/texmf/doc/chktex/ChkTeX.html @@ -0,0 +1,4263 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" + "http://www.w3.org/TR/html4/loose.dtd"> +<html > +<head><title>ChkTeX v1.6.1</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/mn.html)"> +<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/mn.html)"> +<!-- html --> +<meta name="src" content="ChkTeX.tex"> +<meta name="date" content="2004-10-26 22:15:00"> +<link rel="stylesheet" type="text/css" href="ChkTeX.css"> +</head><body +> + <div class="maketitle"> + + +<h2 class="titleHead">Chk<span class="TEX">T<span +class="E">E</span>X</span> v1.6.1</h2> + <div class="author" ><span +class="cmr-12">Jens</span><span +class="cmr-12"> T. Berger</span><span +class="cmr-12"> Thielemann</span></div> +<br> +<div class="date" ><span +class="cmr-12">October 26, 2004</span></div> + </div> + <h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="x1-10001"></a>Introduction</h3> +<!--l. 99--><p class="noindent">This program has been written in frustration because some constructs in <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> are +sometimes non-intuitive, and easy to forget. It is <span +class="cmti-10">not </span>a replacement for the built-in +checker in <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>; however it catches some typographic errors <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> oversees. In +other words, it is Lint for <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>. Filters are also provided for checking the +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> parts of CWEB documents. +<!--l. 106--><p class="indent"> It is written in ANSI C and compiles silently under GCC using “<span +class="cmtt-10">-Wall -ansi</span> +<span +class="cmtt-10">-pedantic</span>” and almost all warning flags. This means that you can compile & use the +program on your favorite machine. Full source included. +<!--l. 111--><p class="indent"> The program also supports output formats suitable for further processing by editors +or other programs, making errors easy to cycle through. Software is provided for +beautifully interfacing against the AUC-<span class="TEX">T<span +class="E">E</span>X</span> Emacs mode, CygnusED, GoldEd and +various Amiga message browsers. +<!--l. 116--><p class="indent"> The program itself does not have any machine requirements; Amiga, MSDOS and +OS/2 binaries are available. Of course, you’ll need ARexx and ScMsg or VBrowse to +benefit from the ARexx scripts. +<!--l. 122--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">2 </span> <a + id="x1-20002"></a>Features</h3> +<!--l. 123--><p class="noindent">Chk<span class="TEX">T<span +class="E">E</span>X</span> begins to get quite a few bells & whistles now. However, you should be aware +of that in most cases, all this is transparent to the user. As you will see, Chk<span class="TEX">T<span +class="E">E</span>X</span> offers +the ability to adapt to many environments and configurations. +<!--l. 128--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">2.1 </span> <a + id="x1-30002.1"></a>New features</h4> +<!--l. 130--><p class="noindent">Modifications and additions since v1.6: + <ul class="itemize1"> + <li class="itemize">Improved the build system + </li> + <li class="itemize">Better fixes for memory access errors</li></ul> + +<!--l. 136--><p class="indent"> Modifications and additions since v1.5: + <ul class="itemize1"> + <li class="itemize">Fixed a crash when running from emacs + </li> + <li class="itemize">Fixed a crash when checking our own manual + </li> + <li class="itemize">Added <span +class="cmtt-10">\verb* support</span></li></ul> +<!--l. 143--><p class="indent"> Modifications and additions since v1.4: +<!--l. 145--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">2.1.1 </span> <a + id="x1-40002.1.1"></a>Program</h5> +<!--l. 147--><p class="noindent">Modifications to the executable itself: + <ul class="itemize1"> + <li class="itemize">As usual, a few more warnings: + <ul class="itemize2"> + <li class="itemize">No space or similar in front/after parenthesis. + </li> + <li class="itemize">Demands a consistent quote style. + </li> + <li class="itemize">Double spaces in input which will not be rendered as one. + </li> + <li class="itemize">Punctuation malplaced regarding to math mode. + </li> + <li class="itemize">Warns about <span class="TEX">T<span +class="E">E</span>X</span> primitives. + </li> + <li class="itemize">Space in front of footnotes. + </li> + <li class="itemize">Bogus <span +class="cmtt-10">\left </span>and <span +class="cmtt-10">\right </span>commands.</li></ul> + </li> + <li class="itemize">The abbreviation recognizer has (for the last time?) been redesigned. We now + produce far less false warnings, catch more cases and do all this faster than before. + Seems like a win. + <!--l. 164--><p class="noindent">Done much of the same with the italic correction detection part, too... + </li> + <li class="itemize">Some bugs have been silently fixed. Hot spots in the program have been optimized; + in certain cases this in fact doubles the speed! + <!--l. 170--><p class="noindent">Along with this goes more code elegance and utilization of macro processing and + the C language. Take a look at “<span +class="cmtt-10">Resource.[ch]</span>”. + </li> + <li class="itemize">It’s possible to specify separate output-formats depending on whether you are + sending the output to a file/pipe or to a terminal. + </li> + <li class="itemize">Column positions are finally correct; we now expand tabs correctly. + + </li> + <li class="itemize">Chk<span class="TEX">T<span +class="E">E</span>X</span> will now recursively search for <span +class="cmtt-10">\input</span>’ed files, both in the document and + on the commandline. See the “<span +class="cmtt-10">chktexrc</span>” file for more info. + </li> + <li class="itemize">The debug switch is now more intelligent; if you wish to hack a bit on Chk<span class="TEX">T<span +class="E">E</span>X</span> for + yourself, it is possible to produce selective debugging output. The feature can also + be disabled altogether. + </li> + <li class="itemize">MS-DOS and OS/2 version of the program is now more flexible and well-behaved, + thanks to Gerd Böhm. + </li> + <li class="itemize">You may now say “<span +class="cmtt-10">-wall</span>” to make all messages warnings, and turn them + on. + </li> + <li class="itemize">Uses termcap on UNIX boxes; this should ensure that “<span +class="cmtt-10">-v2</span>” (or more precisely: + “<span +class="cmtt-10">%i</span>” and “<span +class="cmtt-10">%I</span>”) works regardless to what terminal you are using.</li></ul> +<!--l. 195--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">2.1.2 </span> <a + id="x1-50002.1.2"></a>Resource file</h5> +<!--l. 197--><p class="noindent">New concepts introduced in the setup file: + <ul class="itemize1"> + <li class="itemize">You may now specify both case-sensitive and case-insensitive user patterns in + the “<span +class="cmtt-10">chktexrc</span>” file. In addition; it is now possible to reset/clear lists. + </li> + <li class="itemize">It is possible to specify how many arguments (optional/required) “<span +class="cmtt-10">WIPEARG</span>” + should wipe; it behaves also somewhat more intelligent when the arguments + stretch over multiple lines. + </li> + <li class="itemize">Global files will be read <span +class="cmti-10">in addition </span>to local ones. The searching order has + also been reversed in order to make this more intelligent.</li></ul> +<!--l. 212--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">2.1.3 </span> <a + id="x1-60002.1.3"></a>Other</h5> +<!--l. 213--><p class="noindent">Various other stuff I’ve done to the product: + <ul class="itemize1"> + <li class="itemize">The documentation has been polished and should now be easier to use in + practical situations. + </li> + <li class="itemize">“<span +class="cmtt-10">check</span>” target in “<span +class="cmtt-10">Makefile</span>”, so you can check that the installation + succeeded. In fact, the “<span +class="cmtt-10">Makefile</span>” has been enhanced in several other ways + too, amongst other it is now GNU conforming. + + </li> + <li class="itemize">“<span +class="cmtt-10">deweb</span>” is now documented; you may say “<span +class="cmtt-10">man</span><span +class="cmtt-10"> deweb</span>” to get a few words + of advice. The support script (<span +class="cmtt-10">chkweb</span>) does now behave as the remaining + package (accepting stdin input and flags). + </li> + <li class="itemize">I’ve written an Emacs hack which magically adds Chk<span class="TEX">T<span +class="E">E</span>X</span> to the list of + AUC-<span class="TEX">T<span +class="E">E</span>X</span> commands; thus making the use of the program even more trivial. + <!--l. 229--><p class="noindent">For those of you who don’t wish to mess with Emacs, I’ve included a trivial + lacheck <span +class="cmsy-10"><img +src="cmsy10-24.png" alt="<-->" class="10x-x-24" /></span> Chk<span class="TEX">T<span +class="E">E</span>X</span> interface. + <!--l. 236--><p class="noindent">This means that you now can use Chk<span class="TEX">T<span +class="E">E</span>X</span> just as easily as lacheck when + you’re running AUC-<span class="TEX">T<span +class="E">E</span>X</span>. + </li> + <li class="itemize">Added an ARexx script which lets Chk<span class="TEX">T<span +class="E">E</span>X</span> talk to VBrowse, the message + browser of Volker Barthelmann’s freely distributable ANSI C compiler. The + browser itself is available on Aminet as “<span +class="cmtt-10">dev/c/vbcc.lha</span>”.</li></ul> +<!--l. 245--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">2.2 </span> <a + id="x1-70002.2"></a>Feature list</h4> + <ul class="itemize1"> + <li class="itemize">Supports over 40 warnings. Warnings include: + <table class="multicols" id="multicols-1"><tr><td class="multicol-1"> + <div class="flushleft" +> +<!--l. 251--><p class="noindent"> + <ul class="itemize2"> + <li class="itemize"> + Commands + terminated + with + space. + Ignores + “<span +class="cmtt-10">\tt</span>”, + etc. + </li> + <li class="itemize"> + Space + in + front + of + references + instead + of + “<span +class="cmtt-10">~</span>”. + + </li> + <li class="itemize"> + Forgetting + to + group + parenthesis + characters + when + sub-/superscripting. + </li> + <li class="itemize"> + Italic + correction + (“<span +class="cmtt-10">\/</span>”) + mistakes + (double, + missing, + unnecessary). + </li> + <li class="itemize"> + Parenthesis + and + environment + matching. + </li> + <li class="itemize"> + Ellipsis + detection; + also + checks + whether + to + use + “<span +class="cmtt-10">\dots</span>”, + “<span +class="cmtt-10">\cdots</span>” + or + “<span +class="cmtt-10">\ldots</span>”. + </li> + <li class="itemize"> + Enforcement + of + normal + space + after + abbreviation. + Detects + most + abbreviations + + automagically. + </li> + <li class="itemize"> + Enforcement + of + end-of-sentence + space + when + the + last + sentence + ended + with + capital + letter. + </li> + <li class="itemize"> + Math-mode + on/off + detection. + </li> + <li class="itemize"> + Quote + checking, + both + wrong + types + (“<span +class="cmtt-10">"</span>”) + and + wrong + direction. + </li> + <li class="itemize"> + Recommends + splitting + three + quotes + in + a + row. + </li> + <li class="itemize"> + Searching + for + user + patterns. + </li> + + <li class="itemize"> + Displays + comments. + </li> + <li class="itemize"> + Space + in + front + of + “<span +class="cmtt-10">\label</span>” + and + similar + commands. + </li> + <li class="itemize"> + Use + of + “<span +class="cmtt-10">x</span>” + instead + of + “<span +class="cmtt-10">$\times$</span>” + between + numbers. + </li> + <li class="itemize"> + Multiple + spaces + in + input + which + will + be + rendered + as + one + space + (or + multiple + spaces, + where + that + is + undesirable). + </li> + <li class="itemize"> + Warns + about + text + + which + may + be + ignored. + </li> + <li class="itemize"> + Mathematical + operators + typeset + as + variables. + </li> + <li class="itemize"> + No + space + in + front + of/after + parenthesis. + </li> + <li class="itemize"> + Demands + a + consistent + quote + style. + </li> + <li class="itemize"> + Punctuation + inside + inner + math + mode/outside + display + math + mode. + </li> + <li class="itemize"> + Use + of + <span class="TEX">T<span +class="E">E</span>X</span> primitives + where + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> equivalents + are + available. + </li> + + <li class="itemize"> + Space + in + front + of + footnotes. + </li> + <li class="itemize"> + Bogus + characters + following + commands.</li></ul> +</div> + </td></tr></table> + </li> + <li class="itemize">Fully customizable. Intelligent resource format makes it possible to make + Chk<span class="TEX">T<span +class="E">E</span>X</span> respect your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> setup. Even command-line options may be specified + globally in the “<span +class="cmtt-10">chktexrc</span>” file. + </li> + <li class="itemize">Supports “<span +class="cmtt-10">\input</span>” command; both <span class="TEX">T<span +class="E">E</span>X</span> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> version. Actually includes + the files. “<span +class="cmtt-10">TEXINPUTS</span>”-equivalent search path. + </li> + <li class="itemize">Intelligent warning/error handling. The user may promote/mute warnings to suit + his preferences. You may also mute warnings in the header of a file; thus killing + much unwanted garbage. + </li> + <li class="itemize">Scripts included for checking CWEB files written in <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>. (Requires perl + v5). + </li> + <li class="itemize">Supports both <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 2.09 and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>2<span +class="cmmi-10"><img +src="cmmi10-22.png" alt="e" class="10x-x-22" /></span>. + </li> + <li class="itemize">Flexible output handling. Has some predefined formats and lets the user + specify his own format. Uses a “<span +class="cmtt-10">printf()</span>” similar syntax. “<span +class="cmtt-10">lacheck</span>” + compatible mode included for interfacing with the AUC-<span class="TEX">T<span +class="E">E</span>X</span> Emacs + mode. + </li> + <li class="itemize">ARexx scripts for interfacing with ScMsg and VBrowse are included. Special scripts + included for CygnusED/GoldED, for binding to hotkey. + </li> + <li class="itemize">Amiga Workbench support. Parameters may be passed by shift-clicking the + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> files and setting the remaining options in the tooltypes. + </li> + <li class="itemize">Wildcard matching (Amiga only). Matches file patterns internally, thus saving a lot + of work. This is, however, platform-specific code -- on UNIX boxes this is done by + the shell. + + </li> + <li class="itemize">Written in ANSI C. “<span +class="cmtt-10">configure</span>” script included for easy setup and installation on + UNIX systems.</li></ul> +<!--l. 320--><p class="noindent">Still, it is important to realize that the output from Chk<span class="TEX">T<span +class="E">E</span>X</span> is only intended as a <span +class="cmti-10">guide</span> +to fixing faults. However, it is by no means always correct. This means that correct +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code may produce errors in Chk<span class="TEX">T<span +class="E">E</span>X</span>, and vice versa: Incorrect <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code +may pass silently through. +<!--l. 328--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-80003"></a>Legal stuff</h3> +<!--l. 330--><p class="noindent">Chk<span class="TEX">T<span +class="E">E</span>X</span>, documentation, installations scripts, CWEB filters and other materials +provided are copyright <span +class="cmsy-10">©</span> 1995-96 Jens T. Berger Thielemann, unless explicitly stated +otherwise. +<!--l. 334--><p class="indent"> This program is free software; you can redistribute it and/or modify it under the +terms of the GNU General Public License as published by the Free Software Foundation; +either version 2 of the License, or (at your option) any later version. +<!--l. 339--><p class="indent"> This program is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +details. +<!--l. 344--><p class="indent"> You should have received a copy of the GNU General Public License along with this +program; if not, write to: + <div class="quote"> + <!--l. 347--><p class="noindent">The Free Software Foundation, Inc. + <br class="newline">675 Mass Ave + <br class="newline">Cambridge + <br class="newline">MA 02139 + <br class="newline">USA</div> +<!--l. 357--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">3.1 </span> <a + id="x1-90003.1"></a>Registration</h4> +<!--l. 359--><p class="noindent">‘Chk<span class="TEX">T<span +class="E">E</span>X</span>’ is made available under the concept of Gift-Ware, which is a variant of +Share-Ware. Share-Ware software authors often release ‘crippled’ versions of their +products, i.e. these programs do not support the same functionality as the registered +versions you get when sending monetary contributions to the authors. It all comes down +to ‘pay for the software you are using’ in Share-Ware terms. With Gift-Ware registration +it is different, you are not required to contribute money, but a gift will do. With +‘Chk<span class="TEX">T<span +class="E">E</span>X</span>’ you always get a fully functional program, there is no ‘crippled’ test release +which you can try for a limited time and then have to pay for in order to receive the +working registered version. +<!--l. 371--><p class="indent"> It may seem as if ‘Chk<span class="TEX">T<span +class="E">E</span>X</span>’ was free, but this is not the case. Although +there is no need to pay the author in order to get a fully functional version of +the program you should consider making a contribution. You don’t need to +feel guilty if you cannot or do not want to give me something in return for +the work I have put into ‘Chk<span class="TEX">T<span +class="E">E</span>X</span>’. Show me that it was worth spending so +much time listening to users, updating, rewriting and enhancing this program. +Your contributions will provide the motivation for me to keep developing the +program. + +<!--l. 381--><p class="indent"> Send your contribution to the following address: + <div class="quote"> + <!--l. 386--><p class="noindent">Jens Berger + <br class="newline">Spektrumvn. 4 + <br class="newline">N-0666 Oslo + <br class="newline">Norway</div> +<!--l. 402--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">4 </span> <a + id="x1-100004"></a>Installation</h3> +<!--l. 404--><p class="noindent">A few words on installation on various platforms: +<!--l. 406--><p class="indent"> + <dl class="description"><dt class="description"> +<span +class="cmbx-10">Amiga:</span> </dt><dd +class="description">Use the supplied Installer script. + </dd><dt class="description"> +<span +class="cmbx-10">MS-DOS & OS/2:</span> </dt><dd +class="description">Copy the binary (“<span +class="cmtt-10">ChkTeX.exe</span>”) to somewhere in your path, + and place the “<span +class="cmtt-10">chktexrc</span>” file in the same directory. + <!--l. 411--><p class="noindent">If you’re running Emacs, you may wish to copy the file “<span +class="cmtt-10">chktex.el</span>” to + your elisp source directory, and add the following line to your “<span +class="cmtt-10">.emacs</span>” + file: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + (require 'chktex) +</div> + </td></tr></table> + <!--l. 416--><p class="nopar"> + </dd><dt class="description"> +<span +class="cmbx-10">UNIX:</span> </dt><dd +class="description">Type “<span +class="cmtt-10">configure</span>”, “<span +class="cmtt-10">make</span>” and finally “<span +class="cmtt-10">make</span><span +class="cmtt-10"> install</span>”. To make sure + everything proceeded correctly, type “<span +class="cmtt-10">make</span><span +class="cmtt-10"> check</span>”. If you don’t have superuser + privileges and thus access to the default system areas, you should type + “<span +class="cmtt-10">configure</span><span +class="cmtt-10"> --help</span>” to help you set up correct paths. + <!--l. 424--><p class="noindent">If you haven’t installed any software like this before, that is distributed in source + form, here are some guidelines to help you install it locally at your account. Please + note that a mail to the system administrator may be less work for you. + :-) + <!--l. 429--><p class="noindent">We assume that you have put the archive (“<span +class="cmtt-10">chktex.tar.gz</span>”) in a subdir of yours, + with path “<span +class="cmtt-10">~/tmp</span>”. We further assume that your shell is “<span +class="cmtt-10">csh</span>” or “<span +class="cmtt-10">tcsh</span>”. Do the + following: + <!--l. 433--><p class="noindent"> + <ol type="1" class="enumerate1" > + <li class="enumerate" value="1" +><a + id="x1-10002x1"></a>First of all, unpack the archive contents. + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + > cd ~/tmp + <br />> gunzip chktex.tar.gz + <br />> tar xf chktex.tar +</div> + </td></tr></table> + <!--l. 440--><p class="nopar"> + </li> + <li class="enumerate" value="2" +><a + id="x1-10004x2"></a>Now, we can configure the program. There are some configuration options you + should know about: + <dl class="description"><dt class="description"> + <span +class="cmbx-10">“</span><span +class="cmtt-10">--enable-emacs-hack</span><span +class="cmbx-10">”:</span> </dt><dd +class="description">Install a small file which adds Chk<span class="TEX">T<span +class="E">E</span>X</span> to + the command menu of AUC-<span class="TEX">T<span +class="E">E</span>X</span>. This is to be considered as a hack, + and may break in future versions of AUC-<span class="TEX">T<span +class="E">E</span>X</span>. It works fine under + AUC-<span class="TEX">T<span +class="E">E</span>X</span> v2.9, though. + <!--l. 450--><p class="noindent">This option needs the path of your elisp directory as argument, e.g. + “<span +class="cmtt-10">--enable-emacs-hack=/home/myself/elisp</span>” or similar. + <!--l. 453--><p class="noindent">You’ll also have to add the following line to your “<span +class="cmtt-10">.emacs</span>” file: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + (require 'chktex) +</div> + </td></tr></table> + <!--l. 457--><p class="nopar">You can now access Chk<span class="TEX">T<span +class="E">E</span>X</span> from the “<span +class="cmtt-10">Command</span>” menu in AUC-<span class="TEX">T<span +class="E">E</span>X</span>. To + cycle through the messages, type <span class="verb"><span +class="cmtt-10">C-x</span><span +class="cmtt-10"> `</span>. + </dd><dt class="description"> + <span +class="cmbx-10">“</span><span +class="cmtt-10">--enable-lacheck-replace</span><span +class="cmbx-10">”</span> </dt><dd +class="description">This enables a quick hack for making the + AUC-<span class="TEX">T<span +class="E">E</span>X</span> Emacs mode use Chk<span class="TEX">T<span +class="E">E</span>X</span> instead of lacheck. This is done by + installing a stub script which “overrides” the original lacheck + executable. + <!--l. 466--><p class="noindent">While more stable than the previous solution, this is also significantly + less elegant -- in computing terms, this is the “brute force” + approach. + </dd><dt class="description"> + <span +class="cmbx-10">“</span><span +class="cmtt-10">--enable-debug-info</span><span +class="cmbx-10">”</span> </dt><dd +class="description">Chk<span class="TEX">T<span +class="E">E</span>X</span> has an ability to spit out various + diagnostic messages using the “<span +class="cmtt-10">-d</span>” flag. This behaviour is on by default. + By adding the flag “<span +class="cmtt-10">--disable-debug-info</span>” to the commandline, this + will not be compiled in. + <!--l. 476--><p class="noindent">This may be useful if you’re running short of disk space (the time savings + are neglible).</dd></dl> + <!--l. 480--><p class="noindent">If you are installing the program on your local account, use the following + command: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + > configure --prefix ~/ +</div> + </td></tr></table> + <!--l. 485--><p class="nopar"> + <!--l. 487--><p class="noindent">Add eventual extra flags as specified above. This command will generate a + significant amount of output, this can usually be ignored. + </li> + <li class="enumerate" value="3" +><a + id="x1-10006x3"></a>Finally, we can just build the program and install it. + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + > make + <br />> make install +</div> + </td></tr></table> + <!--l. 495--><p class="nopar"> + </li> + <li class="enumerate" value="4" +><a + id="x1-10008x4"></a>Finished! The program is now installed and ready to use. You may now + tell other people to put your bindir in their path in order to benefit + from your work. All that remains is to make the shell aware of your + installation. + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + > rehash +</div> + </td></tr></table> + <!--l. 504--><p class="nopar"> + <!--l. 506--><p class="noindent">To make the remaining parts of your system aware of this, you’ll have to log + out and re-log in, I’m afraid. However, you should delay this until you’ve + completed this installation procedure. + </li> + <li class="enumerate" value="5" +><a + id="x1-10010x5"></a>If you wish to make sure that everything is OK (you ought to), you may now + ask Chk<span class="TEX">T<span +class="E">E</span>X</span> to do a self-test: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + > make check +</div> + </td></tr></table> + <!--l. 515--><p class="nopar"> + </li></ol> + </dd><dt class="description"> +<span +class="cmbx-10">Other platforms:</span> </dt><dd +class="description">First of all, you have to copy the “<span +class="cmtt-10">config.h.in</span>” file to a file + named “<span +class="cmtt-10">config.h</span>”. Then, edit it to reflect your system. Do the same + with “<span +class="cmtt-10">OpSys.h</span>” (this file has been reduced significantly). If you wish, you + may define “<span +class="cmtt-10">DATADIR</span>” to the path you want the global resource file to be + put. + <!--l. 526--><p class="noindent">Now, I would suggest that you take a peak at the “<span +class="cmtt-10">OpSys.c</span>” file, and edit it + appropiately, for more comfort. This should not be necessary, though, at least not + the first time. + <!--l. 531--><p class="noindent">Finally, you may now compile and link all <span class="verb"><span +class="cmtt-10">.c </span>files. Define “<span +class="cmtt-10">HAVE</span><span +class="cmtt-10">_CONFIG</span><span +class="cmtt-10">_H</span>” to 1 + (on the command-line, for instance). If the “<span +class="cmtt-10">config.h</span>” you wish to use has + another name, define “<span +class="cmtt-10">CONFIG</span><span +class="cmtt-10">_H</span><span +class="cmtt-10">_NAME</span>” to that (in that case, don’t define + “<span +class="cmtt-10">HAVE</span><span +class="cmtt-10">_CONFIG</span><span +class="cmtt-10">_H</span>”). + <!--l. 537--><p class="noindent">Put the directory path of the “<span +class="cmtt-10">chktexrc</span>” file in a environment variable named + “<span +class="cmtt-10">CHKTEXRC</span>”. The files “<span +class="cmtt-10">deweb.in</span>” and “<span +class="cmtt-10">chkweb</span>” should be moved to a directory in + your path. These files may need further setup, as they haven’t got the location of + perl initialized. + <!--l. 543--><p class="noindent">If your compiler/the compiled program complains (or crashes!), you may try the + hints listed below. Please note that it only makes sense to try these hints if your + compiler fails to produce a working program. + <!--l. 548--><p class="noindent"> + <ol type="1" class="enumerate1" > + <li class="enumerate" value="1" +><a + id="x1-10012x1"></a>Increase the preprocessor buffers and line buffers. The Chk<span class="TEX">T<span +class="E">E</span>X</span> sources + define macros sized 3-4k (expanding to about the same), and passes + arguments sized about 1k. + </li> + <li class="enumerate" value="2" +><a + id="x1-10014x2"></a>Use the magic switch which lets us use large “<span +class="cmtt-10">switch(...)</span><span +class="cmsy-10">{</span><span +class="cmtt-10">...</span><span +class="cmsy-10">}</span>” + statements; some of these statements have about 120 “<span +class="cmtt-10">case</span>” entries. + </li> + <li class="enumerate" value="3" +><a + id="x1-10016x3"></a>The sources require that at least the first 12 of each identifier is + significant.</li></ol> + </dd></dl> +<!--l. 559--><p class="noindent"><span +class="cmbx-10">Note: </span>You <span +class="cmti-10">must </span>install the new “<span +class="cmtt-10">chktexrc</span>” file; Chk<span class="TEX">T<span +class="E">E</span>X</span> will fail to function +unless! +<!--l. 562--><p class="indent"> After doing this, you may enhance Chk<span class="TEX">T<span +class="E">E</span>X</span>’ behaviour by reading/editing the +“<span +class="cmtt-10">chktexrc</span>” file. +<!--l. 566--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">5 </span> <a + id="x1-110005"></a>Usage</h3> + +<!--l. 568--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">5.1 </span> <a + id="x1-120005.1"></a>Chk<span class="TEX">T<span +class="E">E</span>X</span></h4> +<!--l. 570--><p class="noindent">Amiga v2.04+ users may wish to note that you may pass the files that Chk<span class="TEX">T<span +class="E">E</span>X</span> is to +process by shift-clicking them. In addition, you may specify the arguments as tooltypes to +the main program icon, using the <span +class="cmss-10">Info </span>menu option. For instance, if you wish to make the +‘fancy’ output the default when starting from Workbench, enter the following as a +tooltype: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> +Verbosity=2 +</div> +</td></tr></table> +<!--l. 579--><p class="nopar">We use the WB2Argv package (also developed by me, available on Aminet as +“<span +class="cmtt-10">dev/c/WB2Argv.lha</span>”), and will fold case until the “<span +class="cmtt-10">=</span>” character, in tradition with the +case-insensitivity of Amiga OS. In all other respects (and platforms), the options listed +below are case-sensitive. +<!--l. 589--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">5.1.1 </span> <a + id="x1-130005.1.1"></a>Synopsis</h5> +<!--l. 591--><p class="noindent">A UNIX-compliant template format follows: + <table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-4-" ><colgroup id="TBL-4-1g"><col +id="TBL-4-1"><col +id="TBL-4-2"></colgroup><tr + valign="baseline" id="TBL-4-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-4-1-1" +class="td11"> <span +class="cmtt-10">chktex </span></td><td align="left" id="TBL-4-1-2" +class="td11"> <!--l. 599--><p class="noindent"><span +class="cmtt-10">[-hiqrW]</span> + <span +class="cmtt-10">[-v[0-...]]</span> + <span +class="cmtt-10">[-l <rcfile>]</span> + <span +class="cmtt-10">[-[wemn] <[1-42]|all>]</span> + <span +class="cmtt-10">[-d[0-...]]</span> + <span +class="cmtt-10">[-p <pseudoname>]</span> + <span +class="cmtt-10">[-o <outputfile>]</span> + <span +class="cmtt-10">[-[btxgI][0|1]]</span> + <span +class="cmtt-10">file1</span> + <span +class="cmtt-10">file2</span> + <span +class="cmtt-10">...</span> </td> + </tr></table> +<!--l. 602--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">5.1.2 </span> <a + id="x1-140005.1.2"></a>Options</h5> +<!--l. 604--><p class="noindent">These are the options Chk<span class="TEX">T<span +class="E">E</span>X</span> currently accepts. Please note that single-lettered +options requiring a numerical or no argument may be concatenated. E.g. saying +“<span +class="cmtt-10">-v0qb0w2</span>” is the same as saying “<span +class="cmtt-10">-v0</span><span +class="cmtt-10"> -q</span><span +class="cmtt-10"> -b0</span><span +class="cmtt-10"> -w2</span>”, except for being less to +type. +<!--l. 610--><p class="indent"> Enough general talk; here’s a rather detailed description of all options: + <dl class="description"><dt class="description"> +<span +class="cmbx-10">Misc.</span><span +class="cmbx-10"> options:</span> </dt><dd +class="description">General options which aren’t related to some specific subpart of + Chk<span class="TEX">T<span +class="E">E</span>X</span>. + <dl class="description"><dt class="description"> + <span +class="cmtt-10">-h [--help]</span> </dt><dd +class="description">Gives you a command summary. + </dd><dt class="description"> + <span +class="cmtt-10">-i [--license]</span> </dt><dd +class="description">Shows distribution information. + </dd><dt class="description"> + <span +class="cmtt-10">-l [--localrc]</span> </dt><dd +class="description">Reads a resource-file formatted as the global resource-file + “<span +class="cmtt-10">chktexrc</span>”, in addition to the global resource-file. This option needs the + name of the resource-file as a parameter. See also <span +class="cmtt-10">-g</span>. + </dd><dt class="description"> + <span +class="cmtt-10">-r [--reset]</span> </dt><dd +class="description">This will reset all settings to their defaults. This may be useful + if you use the <span +class="cmtt-10">CMDLINE </span>directive in your “<span +class="cmtt-10">chktexrc</span>” file, and wish to do + something unusual. + + </dd><dt class="description"> + <span +class="cmtt-10">-d [--debug]</span> </dt><dd +class="description">Needs a numeric argument; a bitmask telling what to output. + The values below may be added in order to output multiple debugging + info. + <table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-8-" ><colgroup id="TBL-8-1g"><col +id="TBL-8-1"><col +id="TBL-8-2"></colgroup><tr + valign="baseline" id="TBL-8-1-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-8-1-1" +class="td11"> <span +class="cmbx-10">Value </span></td><td align="left" id="TBL-8-1-2" +class="td11"> <!--l. 637--><p class="noindent"><span +class="cmbx-10">Dumps. . .</span> </td> + </tr><tr + valign="baseline" id="TBL-8-2-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-8-2-1" +class="td11"> 1 </td><td align="left" id="TBL-8-2-2" +class="td11"> <!--l. 637--><p class="noindent">All warnings available and their current status. </td> + </tr><tr + valign="baseline" id="TBL-8-3-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-8-3-1" +class="td11"> 2 </td><td align="left" id="TBL-8-3-2" +class="td11"> <!--l. 637--><p class="noindent">Statistics for all lists in the resource file. </td> + </tr><tr + valign="baseline" id="TBL-8-4-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-8-4-1" +class="td11"> 4 </td><td align="left" id="TBL-8-4-2" +class="td11"> <!--l. 637--><p class="noindent">The contents of all lists in the resource file. </td> + </tr><tr + valign="baseline" id="TBL-8-5-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-8-5-1" +class="td11"> 8 </td><td align="left" id="TBL-8-5-2" +class="td11"> <!--l. 637--><p class="noindent">Misc. other status information. </td> + </tr><tr + valign="baseline" id="TBL-8-6-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-8-6-1" +class="td11"> 16 </td><td align="left" id="TBL-8-6-2" +class="td11"> <!--l. 637--><p class="noindent">Run-time info (note that this isn’t widely used). </td> + </tr><tr + valign="baseline" id="TBL-8-7-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-8-7-1" +class="td11"> </td> + </tr></table> + The info is produced after all switches and resource files have been + processed. + <!--l. 641--><p class="noindent">It is possible to install versions of Chk<span class="TEX">T<span +class="E">E</span>X</span> that ignore this flag; this means + that it is not certain that this flag works. + </dd><dt class="description"> + <span +class="cmtt-10">-W [--version]</span> </dt><dd +class="description">Displays version information, and exits.</dd></dl> + </dd><dt class="description"> +<span +class="cmbx-10">Muting warning messages:</span> </dt><dd +class="description">Controls whether and in what form error messages will + appear. Usually they accept a specific warning number (e.g. “<span +class="cmtt-10">-w2</span>”), but + you may also say “<span +class="cmtt-10">all</span>” (e.g. “<span +class="cmtt-10">-wall</span>”) which does the operation on <span +class="cmti-10">all</span> + warnings. + <dl class="description"><dt class="description"> + <span +class="cmtt-10">-w [--warnon]</span> </dt><dd +class="description">Makes the message number passed as parameter a warning + and turns it on. + </dd><dt class="description"> + <span +class="cmtt-10">-e [--erroron]</span> </dt><dd +class="description">Makes the message number passed as parameter an error + and turns it on. + </dd><dt class="description"> + <span +class="cmtt-10">-m [--msgon]</span> </dt><dd +class="description">Makes the message number passed as parameter a message + and turns it on. Messages are not counted. + </dd><dt class="description"> + <span +class="cmtt-10">-n [--nowarn]</span> </dt><dd +class="description">Turns the warning/error number passed as a parameter off.</dd></dl> + </dd><dt class="description"> +<span +class="cmbx-10">Output control flags:</span> </dt><dd +class="description">Determines the appearance and destination of the error + reports. + <dl class="description"><dt class="description"> + <span +class="cmtt-10">-q [--quiet]</span> </dt><dd +class="description">Shuts up about copyright information. + </dd><dt class="description"> + <span +class="cmtt-10">-o [--output]</span> </dt><dd +class="description">Normally, all errors are piped to <span +class="cmtt-10">stdout</span>. Using this option + with a parameter, errors will be sent to the named file instead. Only + information relative to the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> file will be sent to that file. Memory + problems and similar will as as always be sent to <span +class="cmtt-10">stderr</span>. If a file with + the name given already exists, it will be renamed to “<span +class="cmtt-10">foobar.bak</span>” + (“<span +class="cmtt-10">foobar.$cl</span>” under MS-DOS), “<span +class="cmtt-10">foobar</span>” being the name of the file. + See also “<span +class="cmtt-10">-b</span>”. + </dd><dt class="description"> + <span +class="cmtt-10">-v [--verbosity]</span> </dt><dd +class="description">Specifies how much and how you wish the error reports + to be displayed. This is specified in the “<span +class="cmtt-10">chktexrc</span>” file; we’ll list the + + default values below. If you wish, you may thus edit the “<span +class="cmtt-10">chktexrc</span>” file + to add or modify new formats. + <!--l. 677--><p class="noindent">The default is mode 1 (that is, the <span +class="cmti-10">second </span>entry in the “<span +class="cmtt-10">chktexrc</span>” file), + using <span +class="cmtt-10">-v </span>without any parameter will give you mode 2. + <!--l. 681--><p class="noindent"> + <dl class="description"><dt class="description"> + <span +class="cmbx-10">0</span> </dt><dd +class="description">Will show the information in a way that should be suitable for further + parsing by <span +class="cmtt-10">awk</span>, <span +class="cmtt-10">sed </span>or similar. The format is as follows: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + File:Line:Column:Warning number:Warning message +</div> + </td></tr></table> + <!--l. 687--><p class="nopar">The colons may be replaced with another string; use the <span class="verb"><span +class="cmtt-10">-s </span>switch for + this. + <!--l. 691--><p class="noindent">As the program does not output all errors in quite order, this output + format is also suitable for piping through “<span +class="cmtt-10">sort</span>”. + </dd><dt class="description"> + <span +class="cmbx-10">1</span> </dt><dd +class="description">Shows the information in a way which is more comprehensible + for humans, but which still doesn’t need anything but a glass + tty. + </dd><dt class="description"> + <span +class="cmbx-10">2</span> </dt><dd +class="description">Shows the information in a fancy way, using escape codes and stuff. It is the + indeed most readable of all modes; however, it needs proper set up of the + “<span +class="cmtt-10">ChkTeX.h</span>” at compilation time. UNIX boxes, however, will find the + information automatically. + </dd><dt class="description"> + <span +class="cmbx-10">3</span> </dt><dd +class="description">Shows the information suitable for parsing by Emacs; this is the same + format as <span +class="cmtt-10">lacheck </span>uses. More formally, it is the following: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + "File", line Line: Warning message +</div> + </td></tr></table> + <!--l. 706--><p class="nopar"> + <!--l. 708--><p class="noindent">To utilize this, type <span class="verb"><span +class="cmtt-10">M-x</span><span +class="cmtt-10"> compile</span><span +class="cmtt-10"> RET</span>. Delete whatever is written in the + minibuffer, and type <span class="verb"><span +class="cmtt-10">chktex</span><span +class="cmtt-10"> -v3</span><span +class="cmtt-10"> texfile.tex</span>, and you should be able + to browse through the error messages. Use <span class="verb"><span +class="cmtt-10">C-x</span><span +class="cmtt-10"> ` </span>to parse the + messages. + </dd><dt class="description"> + <span +class="cmbx-10">4</span> </dt><dd +class="description">More or less the same as <span class="verb"><span +class="cmtt-10">-v3</span>, but also includes information on where the + error actually was found. Takes somewhat longer time to parse, but much + more informative in use.</dd></dl> + </dd><dt class="description"> + <span +class="cmtt-10">-f [--format]</span> </dt><dd +class="description">Specifies the format of the output. This is done using a + format similar to “<span +class="cmtt-10">printf()</span>”, where we support the specifiers listed + below. + <table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-12-" ><colgroup id="TBL-12-1g"><col +id="TBL-12-1"><col +id="TBL-12-2"></colgroup><tr + valign="baseline" id="TBL-12-1-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-1-1" +class="td11"> <span +class="cmbx-10">Code </span></td><td align="left" id="TBL-12-1-2" +class="td11"> <!--l. 744--><p class="noindent"><span +class="cmbx-10">Description</span> </td> + </tr><tr + valign="baseline" id="TBL-12-2-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-2-1" +class="td11"> <span +class="cmtt-10">%b </span></td><td align="left" id="TBL-12-2-2" +class="td11"> <!--l. 744--><p class="noindent">String to print <span +class="cmbx-10">b</span>etween fields (from <span +class="cmtt-10">-s </span>option). </td> + </tr><tr + valign="baseline" id="TBL-12-3-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-3-1" +class="td11"> <span +class="cmtt-10">%c </span></td><td align="left" id="TBL-12-3-2" +class="td11"> <!--l. 744--><p class="noindent"><span +class="cmbx-10">C</span>olumn position of error. </td> + </tr><tr + valign="baseline" id="TBL-12-4-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-4-1" +class="td11"> <span +class="cmtt-10">%d </span></td><td align="left" id="TBL-12-4-2" +class="td11"> <!--l. 744--><p class="noindent">Length of error (<span +class="cmbx-10">d</span>igit). </td> + </tr><tr + valign="baseline" id="TBL-12-5-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-5-1" +class="td11"> <span +class="cmtt-10">%f </span></td><td align="left" id="TBL-12-5-2" +class="td11"> <!--l. 744--><p class="noindent">Current <span +class="cmbx-10">f</span>ilename. </td> + </tr><tr + valign="baseline" id="TBL-12-6-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-6-1" +class="td11"> <span +class="cmtt-10">%i </span></td><td align="left" id="TBL-12-6-2" +class="td11"> <!--l. 744--><p class="noindent">Turn on <span +class="cmbx-10">i</span>nverse printing mode. </td> + </tr><tr + valign="baseline" id="TBL-12-7-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-7-1" +class="td11"> <span +class="cmtt-10">%I </span></td><td align="left" id="TBL-12-7-2" +class="td11"> <!--l. 744--><p class="noindent">Turn off <span +class="cmbx-10">i</span>nverse printing mode. </td> + </tr><tr + valign="baseline" id="TBL-12-8-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-8-1" +class="td11"> <span +class="cmtt-10">%k </span></td><td align="left" id="TBL-12-8-2" +class="td11"> <!--l. 744--><p class="noindent"><span +class="cmbx-10">k</span>ind of error (warning, error, message). </td> + </tr><tr + valign="baseline" id="TBL-12-9-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-9-1" +class="td11"> <span +class="cmtt-10">%l </span></td><td align="left" id="TBL-12-9-2" +class="td11"> <!--l. 744--><p class="noindent"><span +class="cmbx-10">l</span>ine number of error. </td> + </tr><tr + valign="baseline" id="TBL-12-10-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-10-1" +class="td11"> <span +class="cmtt-10">%m </span></td><td align="left" id="TBL-12-10-2" +class="td11"> <!--l. 744--><p class="noindent">Warning <span +class="cmbx-10">m</span>essage. </td> + </tr><tr + valign="baseline" id="TBL-12-11-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-11-1" +class="td11"> <span +class="cmtt-10">%n </span></td><td align="left" id="TBL-12-11-2" +class="td11"> <!--l. 744--><p class="noindent">Warning <span +class="cmbx-10">n</span>umber. </td> + </tr><tr + valign="baseline" id="TBL-12-12-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-12-1" +class="td11"> <span +class="cmtt-10">%u </span></td><td align="left" id="TBL-12-12-2" +class="td11"> <!--l. 744--><p class="noindent">An <span +class="cmbx-10">u</span>nderlining line (like the one which appears when + using “<span +class="cmtt-10">-v1</span>”). </td> + </tr><tr + valign="baseline" id="TBL-12-13-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-13-1" +class="td11"> <span +class="cmtt-10">%r </span></td><td align="left" id="TBL-12-13-2" +class="td11"> <!--l. 744--><p class="noindent">Part of line in front of error (‘S’ <span +class="cmsy-10">- </span>1). </td> + </tr><tr + valign="baseline" id="TBL-12-14-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-14-1" +class="td11"> <span +class="cmtt-10">%s </span></td><td align="left" id="TBL-12-14-2" +class="td11"> <!--l. 744--><p class="noindent">Part of line which contains error (<span +class="cmbx-10">s</span>tring). </td> + </tr><tr + valign="baseline" id="TBL-12-15-"><td align="center" style="white-space:nowrap; text-align:center;" id="TBL-12-15-1" +class="td11"> <span +class="cmtt-10">%t </span></td><td align="left" id="TBL-12-15-2" +class="td11"> <!--l. 744--><p class="noindent">Part of line after error (‘S’ + 1). </td> + </tr></table> + <!--l. 747--><p class="noindent">Other characters will be passed literally; thus you can say “<span +class="cmtt-10">%%</span>” to achieve a + single percent sign in the output. Please note that we may introduce + other specifiers in the future, so don’t abuse this feature for other + characters. + <!--l. 752--><p class="noindent">Also, note that we do <span +class="cmti-10">not </span>support field lengths (yet). This may come in the + future, if I get the time... + <!--l. 755--><p class="noindent">The <span +class="cmtt-10">-v </span>command is implemented by indexing into the “<span +class="cmtt-10">chktexrc</span>” file; read + that for seeing how each format is implemented. If you find yourself using a + particular format often by using the -f switch, consider putting it in the + “<span +class="cmtt-10">chktexrc</span>” file instead. + </dd><dt class="description"> + <span +class="cmtt-10">-V [--pipeverb]</span> </dt><dd +class="description">Which entry we’ll use in the “<span +class="cmtt-10">chktexrc</span>” file whenever <span +class="cmtt-10">stdout</span> + isn’t a terminal. + <!--l. 762--><p class="noindent">The default is to use the same mode as specified with the <span +class="cmtt-10">-v </span>switch; using <span +class="cmtt-10">-V</span> + without any parameter will give you mode 1. + <!--l. 766--><p class="noindent">This switch was implemented because GNU less has problems with the escape + codes Chk<span class="TEX">T<span +class="E">E</span>X</span> uses for displaying inverse text. Under UNIX, there’s another + + way around, though, which is slightly more elegant. Add the following line to + your “<span +class="cmtt-10">.envir</span>” file: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + setenv LESS -r +</div> + </td></tr></table> + <!--l. 772--><p class="nopar"> + </dd><dt class="description"> + <span +class="cmtt-10">-p [--pseudoname]</span> </dt><dd +class="description">With this switch, you can provide the filename which will + be used when we report the errors. This may be useful in scripts, + especially when doing pipes. It is in other words similar to C’s <span class="verb"><span +class="cmtt-10">#line</span> + directive. + <!--l. 779--><p class="noindent">We will only assume this name for the uppermost file; files that this one in + turn <span class="verb"><span +class="cmtt-10">\</span><span class="verb"><span +class="cmtt-10">input </span>are presented under their original names. This seems most logical + to me. + </dd><dt class="description"> + <span +class="cmtt-10">-s [--splitchar]</span> </dt><dd +class="description">String to use instead of the colons when doing <span +class="cmtt-10">-v0</span>; e.g. this + string will be output between the fields. + </dd></dl> + </dd><dt class="description"> +<span +class="cmbx-10">Boolean switches:</span> </dt><dd +class="description">Common for all of these are that they take an optional parameter. + If it is <span +class="cmtt-10">0</span>, the feature will be disabled, if it is <span +class="cmtt-10">1</span>, it will be enabled. All + these features are on by default; and are toggled if you don’t give any + parameter. + <!--l. 794--><p class="noindent"> + <dl class="description"><dt class="description"> + <span +class="cmtt-10">-b [--backup]</span> </dt><dd +class="description">If you use the <span +class="cmtt-10">-o </span>switch, and the named outputfile exists, it + will be renamed to <span +class="cmtt-10">filename.bak</span>. + </dd><dt class="description"> + <span +class="cmtt-10">-I [--inputfiles]</span> </dt><dd +class="description">Execute <span class="verb"><span +class="cmtt-10">\</span><span class="verb"><span +class="cmtt-10">input </span>statements; e.g. include the file in the + input. Our input parsing does of course nest; we use an input-stack to + keep track of this. + </dd><dt class="description"> + <span +class="cmtt-10">-H [--headererr]</span> </dt><dd +class="description">Show errors found in front of the <span class="verb"><span +class="cmtt-10">\begin{document} </span>line. + Some people keep <span +class="cmti-10">lots </span>of pure <span class="TEX">T<span +class="E">E</span>X</span> code there, which errors can’t be + detected reliably (in other words, we will in most cases just produce a + lot of garbage). + </dd><dt class="description"> + <span +class="cmtt-10">-g [--globalrc]</span> </dt><dd +class="description">Read in the global resource file. This switch may be useful + together with the <span +class="cmtt-10">-l </span>option. + </dd><dt class="description"> + <span +class="cmtt-10">-t [--tictoc]</span> </dt><dd +class="description">Display a twirling baton, to show that we’re working. <span +class="cmtt-10">-v0</span> + does an <span +class="cmtt-10">-t0</span>, too, as it assumes that the user then uses the program + non-interactively. This is now a no-op. + </dd><dt class="description"> + <span +class="cmtt-10">-x [--wipeverb]</span> </dt><dd +class="description">Ignore the “<span class="verb"><span +class="cmtt-10">\verb</span>” + command found within the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> file and its argument is completely + by the checking routines. This is done by simply overwriting them. If you + somehow don’t like that (for instance, you would like to count brackets + inside those commands, too), use this switch.</dd></dl> + + </dd></dl> +<!--l. 820--><p class="indent"> If you don’t specify any input <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>-files on the commandline, we’ll read from +<span +class="cmtt-10">stdin</span>. To abort <span +class="cmtt-10">stdin </span>input, press the following keycombinations: + <div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-13-" ><colgroup id="TBL-13-1g"><col +id="TBL-13-1"><col +id="TBL-13-2"></colgroup><tr + valign="baseline" id="TBL-13-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-1-1" +class="td11"> <span +class="cmbx-10">Machine </span></td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-1-2" +class="td11"> <span +class="cmbx-10">Key-combination </span></td> +</tr><tr + valign="baseline" id="TBL-13-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-2-1" +class="td11"> Amiga </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-2-2" +class="td11"> <span class="fbox"><span +class="cmtt-10">Ctrl</span></span> +<span class="fbox"> <span +class="cmtt-10">\</span></span> </td> +</tr><tr + valign="baseline" id="TBL-13-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-3-1" +class="td11"> UNIX </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-3-2" +class="td11"> <span class="fbox"><span +class="cmtt-10">Ctrl</span></span> +<span class="fbox"> <span +class="cmtt-10">D</span></span> </td> +</tr><tr + valign="baseline" id="TBL-13-4-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-4-1" +class="td11"> MS-DOS </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-13-4-2" +class="td11"> <span class="fbox"><span +class="cmtt-10">Ctrl</span></span> +<span class="fbox"> Z</span>, followed by return. </td> </tr></table> +</div> +<!--l. 833--><p class="indent"> By default, we’re using the 1994 version of GNU’s “<span +class="cmtt-10">getopt()</span>” routine. For those +of you who have only used the Amiga’s “<span +class="cmtt-10">ReadArgs()</span>”, here are some quick +instructions: + <ul class="itemize1"> + <li class="itemize">Options may be given in any order; the names of the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>-files do not have + to be the last arguments. This behaviour may be turned off by creating an + environment variable named “<span +class="cmtt-10">POSIXLY</span><span +class="cmtt-10">_CORRECT</span>”. + </li> + <li class="itemize">The special argument “<span +class="cmtt-10">--</span>” forces an end of option-scanning. + </li> + <li class="itemize">Long-named options begin with “<span +class="cmtt-10">--</span>” instead of “<span +class="cmtt-10">-</span>”. Their names may be + abbreviated as long as the abbreviation is unique or is an exact match for + some defined option. If they have an argument, it follows the option name in + the argument, separated from the option name by a “<span +class="cmtt-10">=</span>”, or else the in next + argument.</li></ul> +<!--l. 850--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">5.1.3 </span> <a + id="x1-150005.1.3"></a>The “<span +class="cmtt-10">chktexrc</span>” file</h5> +<!--l. 852--><p class="noindent">You should also take a look at the “<span +class="cmtt-10">chktexrc</span>” file. As the file is self-documenting; you +should be able to get the meaning of each keyword by simply reading the file. The +method for <span +class="cmti-10">finding it</span>, however, has grown rather complex. An outline is given +below. +<!--l. 857--><p class="indent"> If Chk<span class="TEX">T<span +class="E">E</span>X</span> finds multiple files when searching, each and everyone will be read in the +order specified below. The “<span +class="cmtt-10">Keyword =</span><span +class="cmsy-10">{ </span><span +class="cmtt-10">item item ...</span><span +class="cmsy-10">}</span>” may thus be necessary to +reset previously defined lists. +<!--l. 862--><p class="indent"> In this list, “<span +class="cmtt-10">$foo</span>” is assumed to be the environment variable “<span +class="cmtt-10">foo</span>”: +<!--l. 865--><p class="indent"> + <ol type="1" class="enumerate1" > + <li class="enumerate" value="1" +><a + id="x1-15002x1"></a>First, we’ll take a look at the directory which was specified as “<span +class="cmtt-10">DATADIR</span>” + during compilation (this does not happen on Amiga machines). On UNIX + boxes, this usually evaluates to “<span +class="cmtt-10">/usr/local/share/chktexrc</span>” or similar, + under MS-DOS it is set to “<span +class="cmtt-10">\emtex\data\chktexrc</span>”. + </li> + <li class="enumerate" value="2" +><a + id="x1-15004x2"></a>Look in the following system directories: + <div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-14-" ><colgroup id="TBL-14-1g"><col +id="TBL-14-1"><col +id="TBL-14-2"></colgroup><tr + valign="baseline" id="TBL-14-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-1-1" +class="td11"> <span +class="cmbx-10">Machine </span></td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-1-2" +class="td11"> <span +class="cmbx-10">Directory </span></td> +</tr><tr + valign="baseline" id="TBL-14-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-2-1" +class="td11"> 2.04+ Amiga </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-2-2" +class="td11"> <span +class="cmtt-10">ENV:.chktexrc </span></td> +</tr><tr + valign="baseline" id="TBL-14-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-3-1" +class="td11"> 1.3 Amiga </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-3-2" +class="td11"> <span +class="cmtt-10">S:.chktexrc </span></td> +</tr><tr + valign="baseline" id="TBL-14-4-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-4-1" +class="td11"> UNIX </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-4-2" +class="td11"> “<span +class="cmtt-10">$HOME/.chktexrc</span>” or “<span +class="cmtt-10">$LOGDIR/.chktexrc</span>” </td> +</tr><tr + valign="baseline" id="TBL-14-5-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-5-1" +class="td11"> MSDOS </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-14-5-2" +class="td11"> Program installation path </td> +</tr></table></div> + + </li> + <li class="enumerate" value="3" +><a + id="x1-15006x3"></a>Look for it in the directory pointed to by an environment variable, as specified in + the table below: + <table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-18-" ><colgroup id="TBL-18-1g"><col +id="TBL-18-1"><col +id="TBL-18-2"></colgroup><tr + valign="baseline" id="TBL-18-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-18-1-1" +class="td11"> <span +class="cmbx-10">Machine </span></td><td align="left" id="TBL-18-1-2" +class="td11"> <!--l. 891--><p class="noindent"><span +class="cmbx-10">Directory</span> </td> + </tr><tr + valign="baseline" id="TBL-18-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-18-2-1" +class="td11"> Amiga </td><td align="left" id="TBL-18-2-2" +class="td11"> <!--l. 891--><p class="noindent">“<span +class="cmtt-10">$CHKTEXRC/.chktexrc</span>” </td> + </tr><tr + valign="baseline" id="TBL-18-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-18-3-1" +class="td11"> UNIX </td><td align="left" id="TBL-18-3-2" +class="td11"> <!--l. 891--><p class="noindent">“<span +class="cmtt-10">$CHKTEXRC/.chktexrc</span>” </td> + </tr><tr + valign="baseline" id="TBL-18-4-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-18-4-1" +class="td11"> MSDOS </td><td align="left" id="TBL-18-4-2" +class="td11"> <!--l. 891--><p class="noindent">“<span +class="cmtt-10">$CHKTEXRC\chktexrc</span>”, + “<span +class="cmtt-10">$CHKTEX</span><span +class="cmtt-10">_HOME\chktexrc</span>” + or + “<span +class="cmtt-10">$EMTEXDIR\data\chktexrc</span>” </td> + </tr></table> + </li> + <li class="enumerate" value="4" +><a + id="x1-15008x4"></a>Look for it in the current directory. On UNIX and Amiga boxes, we expect the + filename to be “<span +class="cmtt-10">.chktexrc</span>”; on other machines “<span +class="cmtt-10">chktexrc</span>”. + </li></ol> +<!--l. 899--><p class="indent"> If you for some reason wish to undo what the previous files may have done, you may +say “<span +class="cmtt-10">CmdLine </span><span +class="cmsy-10">{ </span><span +class="cmtt-10">-g0 -r </span><span +class="cmsy-10">}</span>” somewhere in the “<span +class="cmtt-10">chktexrc</span>” file; this will reset all previous +settings. +<!--l. 904--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">5.1.4 </span> <a + id="x1-160005.1.4"></a>Hints</h5> +<!--l. 905--><p class="noindent">I’ve tried to collect some advice that may be useful -- if you have a favourite hint, feel +free to send it to me! + <ul class="itemize1"> + <li class="itemize">If you use “<span +class="cmtt-10">german.sty</span>”; it may be wise to put “<span +class="cmtt-10">-n18</span>” in the “<span +class="cmtt-10">CmdLine</span>” + entry in the “<span +class="cmtt-10">chktexrc</span>” file. This will probably reduce the amount of false + warnings significantly. + </li> + <li class="itemize">Put “<span +class="cmtt-10">-v</span>” in the “<span +class="cmtt-10">CmdLine</span>” entry of the “<span +class="cmtt-10">chktexrc</span>” file; this makes the fancy + printing the default. + </li> + <li class="itemize">If you’re working on a large project, it may pay off to make a local resource file + which is included in addition to the global one. In this one, add the necessary + info to reduce the amount of false warnings -- these usually don’t do anything + but hide the real warnings. + </li> + <li class="itemize">Create a total ignore environment, which Chk<span class="TEX">T<span +class="E">E</span>X</span> will ignore completely. In here, + you can place all that code which outsmarts Chk<span class="TEX">T<span +class="E">E</span>X</span> completely. For instance, + add the following lines at the top of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> file: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> + % ChkTeX will ignore material within this environment + <br />\newenvironment{ignore}{}{} +</div> + </td></tr></table> + <!--l. 926--><p class="nopar">In addition, you should add the item “<span +class="cmtt-10">ignore</span>” to the “<span +class="cmtt-10">VerbEnvir</span>” entry in the + “<span +class="cmtt-10">chktexrc</span>” file.</li></ul> +<!--l. 930--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">5.1.5 </span> <a + id="x1-170005.1.5"></a>Bugs</h5> +<!--l. 932--><p class="noindent">No fatal ones, I think, but the program currently has some problems when a +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> command/parameter stretch over a two lines -- some extra spaces may be +inserted into the input. I regard the program as fairly well tested; using the SAS/C +“<span +class="cmtt-10">cover</span>” utility I was able to make sure that approximately 95% of the code has +actually been run successfully in the final version. This does indeed leave some +lines; most of these are procedure terminating brackets or “can’t happen” lines, +though. +<!--l. 940--><p class="indent"> We’ve got some problems when isolating the arguments of a command. Although +improved, it will certainly fail in certain cases; Chk<span class="TEX">T<span +class="E">E</span>X</span> can for instance not handle +arguments stretching over two lines. This also means that “<span +class="cmtt-10">WIPEARG</span>” entries in the +“<span +class="cmtt-10">chktexrc</span>” file will only have the first half of their argument wiped if the argument +stretches over two lines. We will, however, take care not to wipe parenthesis in such cases, +in order to avoid false warnings. +<!--l. 948--><p class="indent"> Before submitting a bug report, please first see whether the problem can be solved by +editing the “<span +class="cmtt-10">chktexrc</span>” file appropiately. +<!--l. 953--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">5.2 </span> <a + id="x1-180005.2"></a>ChkWEB</h4> +<!--l. 955--><p class="noindent">This shell script is provided for checking CWEB files. The template is as follows: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> +chkweb [options] file1 file2 ... +</div> +</td></tr></table> +<!--l. 959--><p class="nopar">As you may see from the script, it is only a trivial interface towards <span +class="cmtt-10">deweb </span>and Chk<span class="TEX">T<span +class="E">E</span>X</span>. +It does not support any individual options on the command line -- all options found will +be passed onto Chk<span class="TEX">T<span +class="E">E</span>X</span>. If “<span +class="cmtt-10">--</span>” or a filename is found, the remaining parameters will be +ignored. The only real intelligence it features is that it will try to append <span class="verb"><span +class="cmtt-10">.w </span>to filenames +it can’t find. +<!--l. 968--><p class="indent"> If no filenames are given, we will read from <span +class="cmtt-10">stdin</span>. +<!--l. 970--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">5.3 </span> <a + id="x1-190005.3"></a>DeWEB</h4> +<!--l. 972--><p class="noindent">This program strips away C code and CWEB commands from CWEB sources. It is called +with the following synopsis: + + <table width="100%" +class="verbatim"><tr class="verbatim"><td +class="verbatim"><div class="verbatim"> +deweb file1 file2 ... +</div> +</td></tr></table> +<!--l. 977--><p class="nopar"> +<!--l. 979--><p class="indent"> <span +class="cmtt-10">deweb </span>filters away all C & CWEB commands from a CWEB source code. This leaves +only the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code. This stripped code, in turn, may then be passed to a suitable +syntax checker for <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>, like Chk<span class="TEX">T<span +class="E">E</span>X</span> and <span +class="cmtt-10">lacheck</span>, or spell-checkers like +<span +class="cmtt-10">ispell</span>. +<!--l. 984--><p class="indent"> When <span +class="cmtt-10">deweb </span>strips away the C code from your CWEB source, it tries to preserve line +breaks. This means that the error reports from <span +class="cmti-10">your favorite tool </span>will be correct +regarding to line numbers. In most cases, the column position will also be correct. This +significantly simplifies finding the errors in the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> source (in contrast to +the output from <span +class="cmtt-10">cweave</span>, which output is truly difficult to figure anything out +from). +<!--l. 992--><p class="indent"> <span +class="cmtt-10">deweb </span>accepts a list of filenames on the argument line, and will send its output to +<span +class="cmtt-10">stdout</span>. If no filenames are given, it will read from stdin, acting as a filter. No options are +currently accepted. +<!--l. 996--><p class="indent"> Macho users may try to pipe the output from <span +class="cmtt-10">deweb </span>directly into <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>, +theoretically, this should work. This would ease the debugging of the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code +significantly, as when <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> complains about wrong syntax, you’ll be able to find the +erroneous line much more easily. Don’t expect that the output looks very much like the +final one, though. +<!--l. 1002--><p class="indent"> <span +class="cmtt-10">deweb </span>should now understand all correct <span +class="cmtt-10">CWEB </span>opcodes. If it complains about not +understanding a correct opcode, please inform the author. +<!--l. 1006--><p class="noindent"> + <h5 class="subsubsectionHead"><span class="titlemark">5.3.1 </span> <a + id="x1-200005.3.1"></a>Bugs</h5> +<!--l. 1008--><p class="noindent"><span +class="cmtt-10">deweb </span>will not even <span +class="cmti-10">compile </span>under Perl versions before perl v5. Unfortunately, this means +that we can’t even tell the user why we failed; Perl will just complain about not being +able to compile the regexps. +<!--l. 1013--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">6 </span> <a + id="x1-210006"></a>Explanation of error messages</h3> +<!--l. 1014--><p class="noindent">Below is a description of all error-messages Chk<span class="TEX">T<span +class="E">E</span>X</span> outputs. Error messages set in <span +class="cmti-10">italic</span> +<span +class="cmti-10">type </span>are turned off by default. Where margin paragraphs are listed in the text, +they refer to the keyword in the “<span +class="cmtt-10">chktexrc</span>” file which controls the discussed +warning. + <div class="marginpar"> +<!--l. 1022--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Silent</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-21-" ><colgroup id="TBL-21-1g"><col +id="TBL-21-1"><col +id="TBL-21-2"></colgroup><tr + valign="baseline" id="TBL-21-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-21-1-1" +class="td11"> <span +class="cmbx-12">Warning 1: </span></td><td align="left" id="TBL-21-1-2" +class="td11"> <!--l. 1023--><p class="noindent"><span +class="cmtt-12">Command</span> + <span +class="cmtt-12">terminated</span> + <span +class="cmtt-12">with</span> + <span +class="cmtt-12">space.</span> </td> + </tr></table> + <div class="quote"> + + <!--l. 1024--><p class="noindent">You tried to terminate a command with a blank space. Usually, this is + an error as these are ignored by <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>. In most cases, you would like + to have a real space there. + <div class="center" +> +<!--l. 1028--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">\LaTeX</span><span class="underline"></span><span class="verb"><span +class="cmtt-10">is</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> typesetter.</span><br> +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>is a typesetter.<br> +<span class="verb"><span +class="cmtt-10">\LaTeX\</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> typesetter.</span><br> +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is a typesetter.<br> +</div> + </div> + <div class="marginpar"> +<!--l. 1037--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Linker</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-24-" ><colgroup id="TBL-24-1g"><col +id="TBL-24-1"><col +id="TBL-24-2"></colgroup><tr + valign="baseline" id="TBL-24-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-24-1-1" +class="td11"> <span +class="cmbx-12">Warning 2: </span></td><td align="left" id="TBL-24-1-2" +class="td11"> <!--l. 1038--><p class="noindent"><span +class="cmtt-12">Non-breaking</span> + <span +class="cmtt-12">space</span> + <span +class="cmtt-12">(`~')</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">have</span> + <span +class="cmtt-12">been</span> + <span +class="cmtt-12">used.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1039--><p class="noindent">When reading a document, it is not very pretty when references are split + across lines. If you use the <span class="verb"><span +class="cmtt-10">~ </span>character, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> will assign a very high + penalty for splitting a line at that point. Chk<span class="TEX">T<span +class="E">E</span>X</span> issues this warning + if you have forgot to do this. + <div class="center" +> +<!--l. 1044--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">Please</span><span +class="cmtt-10"> refer</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> figure</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">\ref{foo}.</span><br> +Please refer to figure 11.<br> +<span class="verb"><span +class="cmtt-10">Please</span><span +class="cmtt-10"> refer</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> figure~\ref{foo}.</span><br> +Please refer to figure 11.<br> +</div> + </div> +<!--l. 1053--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-27-" ><colgroup id="TBL-27-1g"><col +id="TBL-27-1"><col +id="TBL-27-2"></colgroup><tr + valign="baseline" id="TBL-27-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-27-1-1" +class="td11"> <span +class="cmbx-12">Warning 3: </span></td><td align="left" id="TBL-27-1-2" +class="td11"> <!--l. 1053--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">enclose</span> + <span +class="cmtt-12">the</span> + <span +class="cmtt-12">previous</span> + <span +class="cmtt-12">parenthesis</span> + <span +class="cmtt-12">with</span> + <span +class="cmtt-12">`</span><span +class="cmsy-10x-x-120">{}</span><span +class="cmtt-12">'.</span> </td> + </tr></table> + + <div class="quote"> + <!--l. 1055--><p class="noindent">This is a warning which you may ignore, but for maximum aestethic + pleasure, you should enclose your bracket characters with ‘<span +class="cmsy-10">{}</span>’s. + <div class="center" +> +<!--l. 1058--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">$</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">[(ab)^{-1}]</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">\^{-2}$</span><br> +[(<span +class="cmmi-10">ab</span>)<sup ><span +class="cmsy-7">-</span><span +class="cmr-7">1</span></sup>]<sup ><span +class="cmsy-7">-</span><span +class="cmr-7">2</span></sup><br> +<span class="verb"><span +class="cmtt-10">${[{(ab)}^{-1}]}^{-2}$</span><br> +[(<span +class="cmmi-10">ab</span>)<sup ><span +class="cmsy-7">-</span><span +class="cmr-7">1</span></sup>]<sup ><span +class="cmsy-7">-</span><span +class="cmr-7">2</span></sup><br> +</div> + </div> + <div class="marginpar"> +<!--l. 1067--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Italic</span> +<br class="newline"><span +class="cmtt-12">ItalCmd</span> +<br class="newline"><span +class="cmtt-12">NonItalic</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-30-" ><colgroup id="TBL-30-1g"><col +id="TBL-30-1"><col +id="TBL-30-2"></colgroup><tr + valign="baseline" id="TBL-30-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-30-1-1" +class="td11"> <span +class="cmbx-12">Warning 4: </span></td><td align="left" id="TBL-30-1-2" +class="td11"> <!--l. 1069--><p class="noindent"><span +class="cmtt-12">Italic</span> + <span +class="cmtt-12">correction</span> + <span +class="cmtt-12">(`\/')</span> + <span +class="cmtt-12">found</span> + <span +class="cmtt-12">in</span> + <span +class="cmtt-12">non-italic</span> + <span +class="cmtt-12">buffer.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1070--><p class="noindent">If you try to use the <span class="verb"><span +class="cmtt-10">\/ </span>command when Chk<span class="TEX">T<span +class="E">E</span>X</span> believes that the + buffer is not outputted as italic, you’ll get this warning. + <div class="center" +> +<!--l. 1073--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span class="underline"><span +class="cmtt-10">\/</span></span><span class="verb"><span +class="cmtt-10"> example</span><br> +This is an example.<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> example.</span><br> +This is an example.<br> +</div> + </div> + <div class="marginpar"> +<!--l. 1082--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Italic</span> +<br class="newline"><span +class="cmtt-12">ItalCmd</span> + +<br class="newline"><span +class="cmtt-12">NonItalic</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-33-" ><colgroup id="TBL-33-1g"><col +id="TBL-33-1"><col +id="TBL-33-2"></colgroup><tr + valign="baseline" id="TBL-33-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-33-1-1" +class="td11"> <span +class="cmbx-12">Warning 5: </span></td><td align="left" id="TBL-33-1-2" +class="td11"> <!--l. 1083--><p class="noindent"><span +class="cmtt-12">Italic</span> + <span +class="cmtt-12">correction</span> + <span +class="cmtt-12">(`\/')</span> + <span +class="cmtt-12">found</span> + <span +class="cmtt-12">more</span> + <span +class="cmtt-12">than</span> + <span +class="cmtt-12">once.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1084--><p class="noindent">If the buffer is italic, and you try to use the <span class="verb"><span +class="cmtt-10">\/ </span>command more than + once, you’ll get this warning. + <div class="center" +> +<!--l. 1087--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> {\it</span><span +class="cmtt-10"> example\/</span><span class="underline"><span +class="cmtt-10">\/</span></span><span class="verb"><span +class="cmtt-10">}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> not</span><span +class="cmtt-10"> amusing.</span><br> +This <span +class="cmti-10">example </span>is not amusing.<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> {\it</span><span +class="cmtt-10"> example\/}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> not</span><span +class="cmtt-10"> amusing.</span><br> +This <span +class="cmti-10">example </span>is not amusing.<br> +</div> + </div> + <div class="marginpar"> +<!--l. 1096--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Italic</span> +<br class="newline"><span +class="cmtt-12">ItalCmd</span> +<br class="newline"><span +class="cmtt-12">NonItalic</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-36-" ><colgroup id="TBL-36-1g"><col +id="TBL-36-1"><col +id="TBL-36-2"></colgroup><tr + valign="baseline" id="TBL-36-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-36-1-1" +class="td11"> <span +class="cmbx-12">Warning 6: </span></td><td align="left" id="TBL-36-1-2" +class="td11"> <!--l. 1097--><p class="noindent"><span +class="cmtt-12">No</span> + <span +class="cmtt-12">italic</span> + <span +class="cmtt-12">correction</span> + <span +class="cmtt-12">(`\/')</span> + <span +class="cmtt-12">found.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1098--><p class="noindent">You get this error if Chk<span class="TEX">T<span +class="E">E</span>X</span> believes that you are switching from italic + to non-italic, and you’ve forgot to use the <span class="verb"><span +class="cmtt-10">\/ </span>command to insert that + extra little spacing. If you use the “<span +class="cmtt-10">em</span>” option, you may ignore this + warning. + <div class="center" +> +<!--l. 1103--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> {\it</span><span +class="cmtt-10"> example</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> not</span><span +class="cmtt-10"> amusing,</span><span +class="cmtt-10"> either.</span><br> +This <span +class="cmti-10">example </span>is not amusing, either.<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> {\it</span><span +class="cmtt-10"> example\/}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> not</span><span +class="cmtt-10"> amusing,</span><span +class="cmtt-10"> either.</span><br> +This <span +class="cmti-10">example </span>is not amusing, either.<br> +</div> + </div> + + <div class="marginpar"> +<!--l. 1112--><p class="indent"> +<br class="newline"><span +class="cmtt-12">IJAccent</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-39-" ><colgroup id="TBL-39-1g"><col +id="TBL-39-1"><col +id="TBL-39-2"></colgroup><tr + valign="baseline" id="TBL-39-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-39-1-1" +class="td11"> <span +class="cmbx-12">Warning 7: </span></td><td align="left" id="TBL-39-1-2" +class="td11"> <!--l. 1113--><p class="noindent"><span +class="cmtt-12">Accent</span> + <span +class="cmtt-12">command</span> + <span +class="cmtt-12">`command'</span> + <span +class="cmtt-12">needs</span> + <span +class="cmtt-12">use</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">`command'.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1114--><p class="noindent">If you’re using accenting commands, ‘i’ and ‘j’ should lose their dots + before they get accented. This is accomplished by using the <span class="verb"><span +class="cmtt-10">\i</span>, <span class="verb"><span +class="cmtt-10">\j</span>, + <span class="verb"><span +class="cmtt-10">\imath </span>and <span class="verb"><span +class="cmtt-10">\jmath </span>command. + <div class="center" +> +<!--l. 1118--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> example</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> use</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> accents:</span><span +class="cmtt-10"> \'{</span><span class="underline"><span +class="cmtt-10">i</span></span><span class="verb"><span +class="cmtt-10">}.</span><br> +This is an example of use of accents: í.<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> example</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> use</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> accents:</span><span +class="cmtt-10"> \'{\i}.</span><br> +This is an example of use of accents: í.<br> +</div> + </div> + <div class="marginpar"> +<!--l. 1127--><p class="indent"> +<br class="newline"><span +class="cmtt-12">HyphDash</span> +<br class="newline"><span +class="cmtt-12">NumDash</span> +<br class="newline"><span +class="cmtt-12">WordDash</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-42-" ><colgroup id="TBL-42-1g"><col +id="TBL-42-1"><col +id="TBL-42-2"></colgroup><tr + valign="baseline" id="TBL-42-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-42-1-1" +class="td11"> <span +class="cmbx-12">Warning 8: </span></td><td align="left" id="TBL-42-1-2" +class="td11"> <!--l. 1128--><p class="noindent"><span +class="cmtt-12">Wrong</span> + <span +class="cmtt-12">length</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">dash</span> + <span +class="cmtt-12">may</span> + <span +class="cmtt-12">have</span> + <span +class="cmtt-12">been</span> + <span +class="cmtt-12">used.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1129--><p class="noindent">This warning suggests that a wrong number of dashes may have been + used. It does this by classifying the dash according to the the character + in front and after the dashes. + <!--l. 1133--><p class="noindent">If they are of the same type, Chk<span class="TEX">T<span +class="E">E</span>X</span> will determine which keyword + to use in the “<span +class="cmtt-10">chktexrc</span>” file. If not, it will shut up and accept that it + doesn’t know. + + <div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-43-" ><colgroup id="TBL-43-1g"><col +id="TBL-43-1"><col +id="TBL-43-2"></colgroup><tr + valign="baseline" id="TBL-43-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-1-1" +class="td11"> <span +class="cmbx-10">Character type </span></td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-1-2" +class="td11"> <span +class="cmbx-10">Keyword in “</span><span +class="cmtt-10">chktexrc</span><span +class="cmbx-10">”</span><span +class="cmbx-10"> file </span></td> +</tr><tr + valign="baseline" id="TBL-43-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-2-1" +class="td11"> Space </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-2-2" +class="td11"> <span +class="cmtt-10">WordDash </span></td> +</tr><tr + valign="baseline" id="TBL-43-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-3-1" +class="td11"> Number </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-3-2" +class="td11"> <span +class="cmtt-10">NumDash </span></td> +</tr><tr + valign="baseline" id="TBL-43-4-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-4-1" +class="td11"> Alphabetic character </td><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-4-2" +class="td11"> <span +class="cmtt-10">HyphDash </span></td> +</tr><tr + valign="baseline" id="TBL-43-5-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-43-5-1" +class="td11"> </td> +</tr></table></div> + <!--l. 1144--><p class="noindent">This is more or less correct, according to my references. Hopefully this check + can be even more improved (suggestions?). + <div class="center" +> +<!--l. 1147--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">It</span><span +class="cmtt-10"> wasn't</span><span +class="cmtt-10"> anything</span><span +class="cmtt-10"> </span><span class="underline"><span +class="cmtt-10">-</span></span><span class="verb"><span +class="cmtt-10"> just</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> 2</span><span class="underline"><span +class="cmtt-10">---</span></span><span class="verb"><span +class="cmtt-10">3</span><span +class="cmtt-10"> star</span><span class="underline"><span +class="cmtt-10">--</span></span><span class="verb"><span +class="cmtt-10">shots.</span><br> +It wasn’t anything - just a 2--3 star-shots.<br> +<span class="verb"><span +class="cmtt-10">It</span><span +class="cmtt-10"> wasn't</span><span +class="cmtt-10"> anything</span><span +class="cmtt-10"> ---</span><span +class="cmtt-10"> just</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> 2--3</span><span +class="cmtt-10"> star-shots</span><br> +It wasn’t anything -- just a 2-3 star-shots.<br> +</div> + </div> +<!--l. 1158--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-46-" ><colgroup id="TBL-46-1g"><col +id="TBL-46-1"><col +id="TBL-46-2"></colgroup><tr + valign="baseline" id="TBL-46-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-46-1-1" +class="td11"> <span +class="cmbx-12">Warning 9: </span></td><td align="left" id="TBL-46-1-2" +class="td11"> <!--l. 1158--><p class="noindent"><span +class="cmtt-12">`%s'</span> + <span +class="cmtt-12">expected,</span> + <span +class="cmtt-12">found</span> + <span +class="cmtt-12">`%s'.</span> </td> + </tr></table> + <table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-49-" ><colgroup id="TBL-49-1g"><col +id="TBL-49-1"><col +id="TBL-49-2"></colgroup><tr + valign="baseline" id="TBL-49-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-49-1-1" +class="td11"> <span +class="cmbx-12">Warning 10: </span></td><td align="left" id="TBL-49-1-2" +class="td11"> <!--l. 1159--><p class="noindent"><span +class="cmtt-12">Solo</span> + <span +class="cmtt-12">`%s'</span> + <span +class="cmtt-12">found.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1160--><p class="noindent">You get this warning whenever brackets or environments don’t match. + Chk<span class="TEX">T<span +class="E">E</span>X</span> expect to find matching brackets/environments in the same + order as their opposites were found, and no closing delimiters which + haven’t been preceded by an opening one. + <!--l. 1165--><p class="noindent">While bracket matching is not an explicit error, it is usually a sign that + something is wrong. + </div> + <div class="marginpar"> +<!--l. 1170--><p class="indent"> +<br class="newline"><span +class="cmtt-12">CenterDots</span> +<br class="newline"><span +class="cmtt-12">LowDots</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-52-" ><colgroup id="TBL-52-1g"><col +id="TBL-52-1"><col +id="TBL-52-2"></colgroup><tr + valign="baseline" id="TBL-52-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-52-1-1" +class="td11"> <span +class="cmbx-12">Warning 11: </span></td><td align="left" id="TBL-52-1-2" +class="td11"> <!--l. 1171--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">use</span> + <span +class="cmtt-12">`%s'</span> + <span +class="cmtt-12">to</span> + <span +class="cmtt-12">achieve</span> + <span +class="cmtt-12">an</span> + <span +class="cmtt-12">ellipsis.</span> </td> + </tr></table> + + <div class="quote"> + <!--l. 1172--><p class="noindent">Simply typing three “<span +class="cmtt-10">.</span>” in a row will not give a perfect spacing withing + the between the dots. The <span class="verb"><span +class="cmtt-10">\ldots </span>is much more suitable for this. + <!--l. 1176--><p class="noindent">In math mode, you should also distinguish between <span class="verb"><span +class="cmtt-10">\cdots </span>and <span class="verb"><span +class="cmtt-10">\ldots</span>; + take a look at the example below. + <div class="center" +> +<!--l. 1179--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">Foo</span><span class="underline"><span +class="cmtt-10">...</span></span><span class="verb"><span +class="cmtt-10">bar.</span><span +class="cmtt-10"> $1,</span><span class="underline"><span +class="cmtt-10">...</span></span><span class="verb"><span +class="cmtt-10">,3$.</span><span +class="cmtt-10"> $1+</span><span class="underline"><span +class="cmtt-10">...</span></span><span class="verb"><span +class="cmtt-10">+3$.</span><span +class="cmtt-10"> $1,</span><span class="underline"><span +class="cmtt-10">\cdots</span></span><span class="verb"><span +class="cmtt-10">,3$.</span><br> +Foo...bar. 1<span +class="cmmi-10">,...,</span>3. 1 + <span +class="cmmi-10">... </span>+ 3. 1<span +class="cmmi-10">,</span><img +src="ChkTeX0x.png" alt="..." class="cdots" ><span +class="cmmi-10">,</span>3.<br> +<span class="verb"><span +class="cmtt-10">Foo\dots</span><span +class="cmtt-10"> bar.</span><span +class="cmtt-10"> $1,\ldots,3$.</span><span +class="cmtt-10"> $1+\cdots+3$.</span><span +class="cmtt-10"> $1,\ldots,3$.</span><br> +Foo...bar. 1<span +class="cmmi-10">,</span><span +class="cmmi-10">...</span><span +class="cmmi-10">,</span>3. 1 + <img +src="ChkTeX1x.png" alt="..." class="cdots" > + 3. 1<span +class="cmmi-10">,</span><span +class="cmmi-10">...</span><span +class="cmmi-10">,</span>3.<br> +</div> + </div> + <div class="marginpar"> +<!--l. 1190--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Abbrev</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-55-" ><colgroup id="TBL-55-1g"><col +id="TBL-55-1"><col +id="TBL-55-2"></colgroup><tr + valign="baseline" id="TBL-55-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-55-1-1" +class="td11"> <span +class="cmbx-12">Warning 12: </span></td><td align="left" id="TBL-55-1-2" +class="td11"> <!--l. 1191--><p class="noindent"><span +class="cmtt-12">Interword</span> + <span +class="cmtt-12">spacing</span> + <span +class="cmtt-12">(`\</span><span +class="cmtt-12"> ')</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">perhaps</span> + <span +class="cmtt-12">be</span> + <span +class="cmtt-12">used.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1193--><p class="noindent">One of the specified abbreviations were found. Unless you have + previously said <span class="verb"><span +class="cmtt-10">\frenchspacing</span>, you’ll have incorrect spacing, which + one should avoid if possible. + <div class="center" +> +<!--l. 1197--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> example,</span><span +class="cmtt-10"> i.e.</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">an</span><span +class="cmtt-10"> demonstration.</span><br> +This is an example, i.e. an demonstration.<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> example,</span><span +class="cmtt-10"> i.e.\</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> demonstration.</span><br> +This is an example, i.e. an demonstration.<br> +</div> + </div> +<!--l. 1206--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-58-" ><colgroup id="TBL-58-1g"><col +id="TBL-58-1"><col +id="TBL-58-2"></colgroup><tr + valign="baseline" id="TBL-58-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-58-1-1" +class="td11"> <span +class="cmbx-12">Warning 13: </span></td><td align="left" id="TBL-58-1-2" +class="td11"> <!--l. 1206--><p class="noindent"><span +class="cmtt-12">Intersentence</span> + <span +class="cmtt-12">spacing</span> + <span +class="cmtt-12">(`\@')</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">perhaps</span> + <span +class="cmtt-12">be</span> + <span +class="cmtt-12">used.</span> </td> + </tr></table> + + <div class="quote"> + <!--l. 1208--><p class="noindent"><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>’ detection of whether a period ends a sentence or not, is only + based upon the character in front of the period. If it’s uppercase, it + assumes that it does not end a sentence. While this may be correct in + many cases, it may be incorrect in others. Chk<span class="TEX">T<span +class="E">E</span>X</span> thus outputs this + warning in every such case. + <div class="center" +> +<!--l. 1214--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">I've</span><span +class="cmtt-10"> seen</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> UFO!</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">Right</span><span +class="cmtt-10"> over</span><span +class="cmtt-10"> there!</span><br> +I’ve seen an UFO! Right over there!<br> +<span class="verb"><span +class="cmtt-10">I've</span><span +class="cmtt-10"> seen</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> UFO\@!</span><span +class="cmtt-10"> Right</span><span +class="cmtt-10"> over</span><span +class="cmtt-10"> there!</span><br> +I’ve seen an UFO! Right over there!<br> +</div> + </div> +<!--l. 1223--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-61-" ><colgroup id="TBL-61-1g"><col +id="TBL-61-1"><col +id="TBL-61-2"></colgroup><tr + valign="baseline" id="TBL-61-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-61-1-1" +class="td11"> <span +class="cmbx-12">Warning 14: </span></td><td align="left" id="TBL-61-1-2" +class="td11"> <!--l. 1223--><p class="noindent"><span +class="cmtt-12">Could</span> + <span +class="cmtt-12">not</span> + <span +class="cmtt-12">find</span> + <span +class="cmtt-12">argument</span> + <span +class="cmtt-12">for</span> + <span +class="cmtt-12">command.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1225--><p class="noindent">Chk<span class="TEX">T<span +class="E">E</span>X</span> will in some cases need the argument of a function to detect an + error. As Chk<span class="TEX">T<span +class="E">E</span>X</span> currently processes the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> file on a line-by-line + basis, it won’t find the argument if the command which needed it was + on the previous line. On the other hand, this <span +class="cmti-10">may </span>also be an error; you + ought to check it to be safe. + <div class="center" +> +<!--l. 1231--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">$\hat$</span><br> +This will give a <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> error...<br> +<span class="verb"><span +class="cmtt-10">$\hat{a}$</span><br> +<span +class="cmmi-10">â</span><br> +</div> + </div> +<!--l. 1240--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-64-" ><colgroup id="TBL-64-1g"><col +id="TBL-64-1"><col +id="TBL-64-2"></colgroup><tr + valign="baseline" id="TBL-64-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-64-1-1" +class="td11"> <span +class="cmbx-12">Warning 15: </span></td><td align="left" id="TBL-64-1-2" +class="td11"> <!--l. 1240--><p class="noindent"><span +class="cmtt-12">No</span> + <span +class="cmtt-12">match</span> + <span +class="cmtt-12">found</span> + <span +class="cmtt-12">for</span> + <span +class="cmtt-12">`%s'.</span> </td> + </tr></table> + + <div class="quote"> + <!--l. 1242--><p class="noindent">This warning is triggered if we find a single, <span +class="cmti-10">opening </span>bracket or + environment. While bracket matching is not an explicit error, it is + usually a sign that something is wrong. + </div> + <div class="marginpar"> +<!--l. 1248--><p class="indent"> +<br class="newline"><span +class="cmtt-12">MathEnvir</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-67-" ><colgroup id="TBL-67-1g"><col +id="TBL-67-1"><col +id="TBL-67-2"></colgroup><tr + valign="baseline" id="TBL-67-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-67-1-1" +class="td11"> <span +class="cmbx-12">Warning 16: </span></td><td align="left" id="TBL-67-1-2" +class="td11"> <!--l. 1249--><p class="noindent"><span +class="cmtt-12">Mathmode</span> + <span +class="cmtt-12">still</span> + <span +class="cmtt-12">on</span> + <span +class="cmtt-12">at</span> + <span +class="cmtt-12">end</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">LaTeX</span> + <span +class="cmtt-12">file.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1250--><p class="noindent">This error is triggered if you at some point have turned on mathmode, + and Chk<span class="TEX">T<span +class="E">E</span>X</span> couldn’t see that you remembered to turn it off. + </div> +<!--l. 1256--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-70-" ><colgroup id="TBL-70-1g"><col +id="TBL-70-1"><col +id="TBL-70-2"></colgroup><tr + valign="baseline" id="TBL-70-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-70-1-1" +class="td11"> <span +class="cmbx-12">Warning 17: </span></td><td align="left" id="TBL-70-1-2" +class="td11"> <!--l. 1256--><p class="noindent"><span +class="cmtt-12">Number</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">`character'</span> + <span +class="cmtt-12">doesn't</span> + <span +class="cmtt-12">match</span> + <span +class="cmtt-12">the</span> + <span +class="cmtt-12">number</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">`character'.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1258--><p class="noindent">Should be self-explanatory. Chk<span class="TEX">T<span +class="E">E</span>X</span> didn’t find the same number of an + opening bracket as it found of a closing bracket. + </div> + +<!--l. 1263--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-73-" ><colgroup id="TBL-73-1g"><col +id="TBL-73-1"><col +id="TBL-73-2"></colgroup><tr + valign="baseline" id="TBL-73-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-73-1-1" +class="td11"> <span +class="cmbx-12">Warning 18: </span></td><td align="left" id="TBL-73-1-2" +class="td11"> <!--l. 1263--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">use</span> + <span +class="cmtt-12">either</span> + <span +class="cmtt-12">``</span> + <span +class="cmtt-12">or</span> + <span +class="cmtt-12">''</span> + <span +class="cmtt-12">as</span> + <span +class="cmtt-12">an</span> + <span +class="cmtt-12">alternative</span> + <span +class="cmtt-12">to</span> + <span +class="cmtt-12">`"'.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1264--><p class="noindent">Self-explanatory. Look in the example, and you’ll understand why. + <div class="center" +> +<!--l. 1266--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> </span><span class="underline"><span +class="cmtt-10">"</span></span><span class="verb"><span +class="cmtt-10">example</span><span class="underline"><span +class="cmtt-10">"</span></span><br> +This is an ”example”<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> ``example''</span><br> +This is an “example”<br> +</div> + </div> +<!--l. 1276--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-76-" ><colgroup id="TBL-76-1g"><col +id="TBL-76-1"><col +id="TBL-76-2"></colgroup><tr + valign="baseline" id="TBL-76-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-76-1-1" +class="td11"> <span +class="cmbx-12">Warning 19: </span></td><td align="left" id="TBL-76-1-2" +class="td11"> <!--l. 1276--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">use</span> + <span +class="cmtt-12">"'"</span> + <span +class="cmtt-12">(ASCII</span> + <span +class="cmtt-12">39)</span> + <span +class="cmtt-12">instead</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">"'"</span> + <span +class="cmtt-12">(ASCII</span> + <span +class="cmtt-12">180).</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1276--><p class="noindent">On some keyboards you might get the wrong quote. This quote looks, + IMHO, <span +class="cmti-10">ugly </span>compared to the standard quotes, it doesn’t even come out + as a quote! Just see in the example. + <div class="center" +> + +<!--l. 1282--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">``There</span><span class="underline"><span +class="cmtt-10">'</span></span><span class="verb"><span +class="cmtt-10">s</span><span +class="cmtt-10"> quotes</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> there</span><span class="underline"><span +class="cmtt-10">'</span></span><span class="verb"><span +class="cmtt-10">s</span><span +class="cmtt-10"> quotes </span><span class="underline"><span +class="cmtt-10">''</span></span><br> +“Theres quotes and theres quotes<br> +<span class="verb"><span +class="cmtt-10">``There's</span><span +class="cmtt-10"> quotes</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> there's</span><span +class="cmtt-10"> quotes''</span><br> +“There’s quotes and there’s quotes”<br> +</div> + </div> + <div class="marginpar"> +<!--l. 1292--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Userwarn</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-79-" ><colgroup id="TBL-79-1g"><col +id="TBL-79-1"><col +id="TBL-79-2"></colgroup><tr + valign="baseline" id="TBL-79-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-79-1-1" +class="td11"> <span +class="cmbx-12">Warning 20: </span></td><td align="left" id="TBL-79-1-2" +class="td11"> <!--l. 1293--><p class="noindent"><span +class="cmtt-12">User-specified</span> + <span +class="cmtt-12">pattern</span> + <span +class="cmtt-12">found.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1294--><p class="noindent">A substring you’ve specified using <span +class="cmtt-10">USERWARN </span>in the “<span +class="cmtt-10">chktexrc</span>” file, has + been found.</div> +<!--l. 1298--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-82-" ><colgroup id="TBL-82-1g"><col +id="TBL-82-1"><col +id="TBL-82-2"></colgroup><tr + valign="baseline" id="TBL-82-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-82-1-1" +class="td11"> <span +class="cmbx-12">Warning 21: </span></td><td align="left" id="TBL-82-1-2" +class="td11"> <!--l. 1298--><p class="noindent"><span +class="cmitt-10x-x-120">This</span> + <span +class="cmitt-10x-x-120">command</span> + <span +class="cmitt-10x-x-120">might</span> + <span +class="cmitt-10x-x-120">not</span> + <span +class="cmitt-10x-x-120">be</span> + <span +class="cmitt-10x-x-120">intended.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1299--><p class="noindent">I implemented this because a friend of mine kept on making these + mistakes. Easily done if you haven’t gotten quite into the syntax of + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>. + <div class="center" +> +<!--l. 1303--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">\LaTeX\</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> extension</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> \TeX</span><span class="underline"><span +class="cmtt-10">\.</span></span><span class="verb"><span +class="cmtt-10"> Right?</span><br> +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is an extension of <span class="TEX">T<span +class="E">E</span>X</span>Ṙight?<br> +<span class="verb"><span +class="cmtt-10">\LaTeX\</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> extension</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> \TeX.</span><span +class="cmtt-10"> Right?</span><br> +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is an extension of <span class="TEX">T<span +class="E">E</span>X</span>. Right?<br> +</div> + </div> +<!--l. 1312--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-85-" ><colgroup id="TBL-85-1g"><col +id="TBL-85-1"><col +id="TBL-85-2"></colgroup><tr + valign="baseline" id="TBL-85-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-85-1-1" +class="td11"> <span +class="cmbx-12">Warning 22: </span></td><td align="left" id="TBL-85-1-2" +class="td11"> <!--l. 1312--><p class="noindent"><span +class="cmitt-10x-x-120">Comment</span> + <span +class="cmitt-10x-x-120">displayed.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1313--><p class="noindent">Chk<span class="TEX">T<span +class="E">E</span>X</span> dumps all comments it finds, which in some cases is useful. + I usually keep all my notes in the comments, and like to review + them before I ship the final version. For commenting out parts of the + document, the “<span +class="cmtt-10">comment</span>” environment is better suited. + </div> + +<!--l. 1321--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-88-" ><colgroup id="TBL-88-1g"><col +id="TBL-88-1"><col +id="TBL-88-2"></colgroup><tr + valign="baseline" id="TBL-88-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-88-1-1" +class="td11"> <span +class="cmbx-12">Warning 23: </span></td><td align="left" id="TBL-88-1-2" +class="td11"> <!--l. 1321--><p class="noindent"><span +class="cmtt-12">Either</span> + <span +class="cmtt-12">''\,'</span> + <span +class="cmtt-12">or</span> + <span +class="cmtt-12">'\,''</span> + <span +class="cmtt-12">will</span> + <span +class="cmtt-12">look</span> + <span +class="cmtt-12">better.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1323--><p class="noindent">This error is generated whenever you try to typeset three quotes in a + row; this will not look pretty, and one of them should be separated from + the rest. + <div class="center" +> +<!--l. 1327--><p class="noindent"> + <span class="underline"><span +class="cmtt-10">```</span></span><span class="verb"><span +class="cmtt-10">Hello',</span><span +class="cmtt-10"> I</span><span +class="cmtt-10"> heard</span><span +class="cmtt-10"> him</span><span +class="cmtt-10"> said'',</span><span +class="cmtt-10"> she</span><span +class="cmtt-10"> remembered.</span><br> +“‘Hello’, I heard him said”, she remembered.<br> +<span class="verb"><span +class="cmtt-10">``\,`Hello',</span><span +class="cmtt-10"> I</span><span +class="cmtt-10"> heard</span><span +class="cmtt-10"> him</span><span +class="cmtt-10"> said'',</span><span +class="cmtt-10"> she</span><span +class="cmtt-10"> remembered.</span><br> +“ ‘Hello’, I heard him said”, she remembered.</div> + </div> + <div class="marginpar"> +<!--l. 1336--><p class="indent"> +<br class="newline"><span +class="cmtt-12">PostLink</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-91-" ><colgroup id="TBL-91-1g"><col +id="TBL-91-1"><col +id="TBL-91-2"></colgroup><tr + valign="baseline" id="TBL-91-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-91-1-1" +class="td11"> <span +class="cmbx-12">Warning 24: </span></td><td align="left" id="TBL-91-1-2" +class="td11"> <!--l. 1337--><p class="noindent"><span +class="cmtt-12">Delete</span> + <span +class="cmtt-12">this</span> + <span +class="cmtt-12">space</span> + <span +class="cmtt-12">to</span> + <span +class="cmtt-12">maintain</span> + <span +class="cmtt-12">correct</span> + <span +class="cmtt-12">pagereferences.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1338--><p class="noindent">This message, issued when a space is found in front of a <span class="verb"><span +class="cmtt-10">\index</span>, <span class="verb"><span +class="cmtt-10">\label</span> + or similar command (can be set in the “<span +class="cmtt-10">chktexrc</span>” file). Sometimes, + this space may cause that the word and the index happens on separate + pages, if a pagebreak happens just there. + <!--l. 1343--><p class="noindent">You might also use this warning to warn you about spaces in front of + footnotes; however, the warning text may not be entirely correct then. + <div class="center" +> +<!--l. 1347--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">Indexing</span><span +class="cmtt-10"> text</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">\index{text}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> fun!</span><br> +<span class="verb"><span +class="cmtt-10">Indexing</span><span +class="cmtt-10"> text\index{text}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> fun!</span><br> +</div> + </div> + +<!--l. 1354--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-94-" ><colgroup id="TBL-94-1g"><col +id="TBL-94-1"><col +id="TBL-94-2"></colgroup><tr + valign="baseline" id="TBL-94-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-94-1-1" +class="td11"> <span +class="cmbx-12">Warning 25: </span></td><td align="left" id="TBL-94-1-2" +class="td11"> <!--l. 1354--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">might</span> + <span +class="cmtt-12">wish</span> + <span +class="cmtt-12">to</span> + <span +class="cmtt-12">put</span> + <span +class="cmtt-12">this</span> + <span +class="cmtt-12">between</span> + <span +class="cmtt-12">a</span> + <span +class="cmtt-12">pair</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">`</span><span +class="cmsy-10x-x-120">{}</span><span +class="cmtt-12">'</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1356--><p class="noindent">This warning is given whenever Chk<span class="TEX">T<span +class="E">E</span>X</span> finds a “<img +src="ChkTeX2x.png" alt="^ " class="circ" >”’ or a “<span +class="cmtt-10">_</span>” + followed by either two or more numberic digits or two or more alphabetic + characters. In most situations, this means that you’ve forgotten some + <span +class="cmsy-10">{}</span>’s. + <div class="center" +> +<!--l. 1361--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">$5\cdot10^</span><span class="underline"><span +class="cmtt-10">10</span></span><span class="verb"><span +class="cmtt-10">$</span><br> +5 <span +class="cmsy-10"><sup class="htf"><strong>.</strong></sup> </span>10<sup ><span +class="cmr-7">1</span></sup>0<br> +<span class="verb"><span +class="cmtt-10">$5\cdot10^{10}$</span><br> +5 <span +class="cmsy-10"><sup class="htf"><strong>.</strong></sup> </span>10<sup ><span +class="cmr-7">10</span></sup></div> + </div> +<!--l. 1370--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-97-" ><colgroup id="TBL-97-1g"><col +id="TBL-97-1"><col +id="TBL-97-2"></colgroup><tr + valign="baseline" id="TBL-97-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-97-1-1" +class="td11"> <span +class="cmbx-12">Warning 26: </span></td><td align="left" id="TBL-97-1-2" +class="td11"> <!--l. 1370--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">ought</span> + <span +class="cmtt-12">to</span> + <span +class="cmtt-12">remove</span> + <span +class="cmtt-12">spaces</span> + <span +class="cmtt-12">in</span> + <span +class="cmtt-12">front</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">punctuation.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1372--><p class="noindent">This warning is issued if Chk<span class="TEX">T<span +class="E">E</span>X</span> finds space in front of an + end-of-sentence character. + <div class="center" +> +<!--l. 1375--><p class="noindent"> + + <span class="verb"><span +class="cmtt-10">Do</span><span +class="cmtt-10"> you</span><span +class="cmtt-10"> understand</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">?</span><br> +Do you understand ?<br> +<span class="verb"><span +class="cmtt-10">Do</span><span +class="cmtt-10"> you</span><span +class="cmtt-10"> understand?</span><br> +Do you understand?<br> +</div> + </div> +<!--l. 1384--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-100-" ><colgroup id="TBL-100-1g"><col +id="TBL-100-1"><col +id="TBL-100-2"></colgroup><tr + valign="baseline" id="TBL-100-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-100-1-1" +class="td11"> <span +class="cmbx-12">Warning 27: </span></td><td align="left" id="TBL-100-1-2" +class="td11"> <!--l. 1384--><p class="noindent"><span +class="cmtt-12">Could</span> + <span +class="cmtt-12">not</span> + <span +class="cmtt-12">execute</span> + <span +class="cmtt-12">LaTeX</span> + <span +class="cmtt-12">command.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1386--><p class="noindent">Some <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> commands will be interpreted by Chk<span class="TEX">T<span +class="E">E</span>X</span>; however, + some of them are sensible to errors in the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> source. Most notably, + the <span class="verb"><span +class="cmtt-10">\</span><span class="verb"><span +class="cmtt-10">input </span>command relies on that the input file exists... + </div> + <div class="marginpar"> +<!--l. 1392--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Italic</span> +<br class="newline"><span +class="cmtt-12">ItalCmd</span> +<br class="newline"><span +class="cmtt-12">NonItalic</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-103-" ><colgroup id="TBL-103-1g"><col +id="TBL-103-1"><col +id="TBL-103-2"></colgroup><tr + valign="baseline" id="TBL-103-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-103-1-1" +class="td11"> <span +class="cmbx-12">Warning 28: </span></td><td align="left" id="TBL-103-1-2" +class="td11"> <!--l. 1393--><p class="noindent"><span +class="cmtt-12">Don't</span> + <span +class="cmtt-12">use</span> + <span +class="cmtt-12">\/</span> + <span +class="cmtt-12">in</span> + <span +class="cmtt-12">front</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">small</span> + <span +class="cmtt-12">punctuation.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1394--><p class="noindent">Italic correction should generally <span +class="cmti-10">not </span>be used in front of small + punctuation characters like ‘.’ and ‘,’; as it looks better when the + preceding italic character leans “over” the punctum or comma. + <div class="center" +> +<!--l. 1399--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">It</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> just</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> {\it</span><span +class="cmtt-10"> test</span><span class="underline"><span +class="cmtt-10">\/</span></span><span class="verb"><span +class="cmtt-10">},</span><span +class="cmtt-10"> don't</span><span +class="cmtt-10"> think</span><span +class="cmtt-10"> anything</span><span +class="cmtt-10"> else.</span><br> +It is just a <span +class="cmti-10">test</span>, don’t think anything else.<br> +<span class="verb"><span +class="cmtt-10">It</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> just</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> {\it</span><span +class="cmtt-10"> test},</span><span +class="cmtt-10"> don't</span><span +class="cmtt-10"> think</span><span +class="cmtt-10"> anything</span><span +class="cmtt-10"> else.</span><br> +It is just a <span +class="cmti-10">test</span>, don’t think anything else.</div> + </div> + +<!--l. 1408--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-106-" ><colgroup id="TBL-106-1g"><col +id="TBL-106-1"><col +id="TBL-106-2"></colgroup><tr + valign="baseline" id="TBL-106-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-106-1-1" +class="td11"> <span +class="cmbx-12">Warning 29: </span></td><td align="left" id="TBL-106-1-2" +class="td11"> <!--l. 1408--><p class="noindent"><span +class="cmtt-12">$\times$</span> + <span +class="cmtt-12">may</span> + <span +class="cmtt-12">look</span> + <span +class="cmtt-12">prettier</span> + <span +class="cmtt-12">here.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1409--><p class="noindent">In ASCII environments, it is usual to use the ‘x’ character as an infix + operator to denote a dimension. The mathemathical symbol <span +class="cmsy-10">× </span>provided + by the <span class="verb"><span +class="cmtt-10">$\times$ </span>command is better suited for this. + <div class="center" +> +<!--l. 1414--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">The</span><span +class="cmtt-10"> program</span><span +class="cmtt-10"> opens</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> screen</span><span +class="cmtt-10"> sized</span><span +class="cmtt-10"> 640</span><span class="underline"><span +class="cmtt-10">x</span></span><span class="verb"><span +class="cmtt-10">200</span><span +class="cmtt-10"> pixels.</span><br> +The program opens a screen sized 640x200 pixels.<br> +<span class="verb"><span +class="cmtt-10">The</span><span +class="cmtt-10"> program</span><span +class="cmtt-10"> opens</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> screen</span><span +class="cmtt-10"> sized</span><span +class="cmtt-10"> $640\times200$</span><span +class="cmtt-10"> pixels.</span><br> +The program opens a screen sized 640 <span +class="cmsy-10">× </span>200 pixels.</div> + </div> +<!--l. 1423--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-109-" ><colgroup id="TBL-109-1g"><col +id="TBL-109-1"><col +id="TBL-109-2"></colgroup><tr + valign="baseline" id="TBL-109-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-109-1-1" +class="td11"> <span +class="cmbx-12">Warning 30: </span></td><td align="left" id="TBL-109-1-2" +class="td11"> <!--l. 1423--><p class="noindent"><span +class="cmitt-10x-x-120">Multiple</span> + <span +class="cmitt-10x-x-120">spaces</span> + <span +class="cmitt-10x-x-120">detected</span> + <span +class="cmitt-10x-x-120">in</span> + <span +class="cmitt-10x-x-120">output.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1425--><p class="noindent">This warning, intended for the novice, will remind you that even if you + <span +class="cmti-10">type </span>multiple spaces in your input, only a single space will come out. + Some ways to come around this is listed below. + <div class="center" +> +<!--l. 1429--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">White</span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> beautiful</span><span +class="cmtt-10"> colour.</span><br> +White is a beautiful colour.<br> +<span class="verb"><span +class="cmtt-10">White~~~~~{</span><span +class="cmtt-10"> }{</span><span +class="cmtt-10"> }{</span><span +class="cmtt-10"> }\</span><span +class="cmtt-10"> \</span><span +class="cmtt-10"> \</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> beautiful</span><span +class="cmtt-10"> colour.</span><br> +White is a beautiful colour.<br> +</div> + </div> + <div class="marginpar"> +<!--l. 1438--><p class="indent"> +<br class="newline"><span +class="cmtt-12">VerbEnvir</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-112-" ><colgroup id="TBL-112-1g"><col +id="TBL-112-1"><col +id="TBL-112-2"></colgroup><tr + valign="baseline" id="TBL-112-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-112-1-1" +class="td11"> <span +class="cmbx-12">Warning 31: </span></td><td align="left" id="TBL-112-1-2" +class="td11"> <!--l. 1439--><p class="noindent"><span +class="cmtt-12">This</span> + <span +class="cmtt-12">text</span> + <span +class="cmtt-12">may</span> + <span +class="cmtt-12">be</span> + <span +class="cmtt-12">ignored.</span> </td> + </tr></table> + + <div class="quote"> + <!--l. 1440--><p class="noindent">Certain implementations of the <span class="verb"><span +class="cmtt-10">verbatim </span>environment and derivations + of that, ignore all text on the same line as <span class="verb"><span +class="cmtt-10">\end{verbatim}</span>. This will + warn you about this. + </div> +<!--l. 1447--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-115-" ><colgroup id="TBL-115-1g"><col +id="TBL-115-1"><col +id="TBL-115-2"></colgroup><tr + valign="baseline" id="TBL-115-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-115-1-1" +class="td11"> <span +class="cmbx-12">Warning 32: </span></td><td align="left" id="TBL-115-1-2" +class="td11"> <!--l. 1447--><p class="noindent"><span +class="cmtt-12">Use</span> + <span +class="cmtt-12">`</span> + <span +class="cmtt-12">to</span> + <span +class="cmtt-12">begin</span> + <span +class="cmtt-12">quotation,</span> + <span +class="cmtt-12">not</span> + <span +class="cmtt-12">'.</span> </td> + </tr></table> +<br class="newline"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-118-" ><colgroup id="TBL-118-1g"><col +id="TBL-118-1"><col +id="TBL-118-2"></colgroup><tr + valign="baseline" id="TBL-118-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-118-1-1" +class="td11"> <span +class="cmbx-12">Warning 33: </span></td><td align="left" id="TBL-118-1-2" +class="td11"> <!--l. 1448--><p class="noindent"><span +class="cmtt-12">Use</span> + <span +class="cmtt-12">'</span> + <span +class="cmtt-12">to</span> + <span +class="cmtt-12">end</span> + <span +class="cmtt-12">quotation,</span> + <span +class="cmtt-12">not</span> + <span +class="cmtt-12">`.</span> </td> + </tr></table> +<br class="newline"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-121-" ><colgroup id="TBL-121-1g"><col +id="TBL-121-1"><col +id="TBL-121-2"></colgroup><tr + valign="baseline" id="TBL-121-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-121-1-1" +class="td11"> <span +class="cmbx-12">Warning 34: </span></td><td align="left" id="TBL-121-1-2" +class="td11"> <!--l. 1449--><p class="noindent"><span +class="cmtt-12">Don't</span> + <span +class="cmtt-12">mix</span> + <span +class="cmtt-12">quotes.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1451--><p class="noindent">Proper quotations should start with a <span class="verb"><span +class="cmtt-10">` </span>and end with a <span class="verb"><span +class="cmtt-10">'</span>; anything else + isn’t very pretty. Both these warnings are relative to this; look in the + example below. + <div class="center" +> +<!--l. 1455--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">There</span><span +class="cmtt-10"> are</span><span +class="cmtt-10"> </span><span class="underline"><span +class="cmtt-10">`'</span></span><span class="verb"><span +class="cmtt-10">examples''</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> there</span><span +class="cmtt-10"> are</span><span +class="cmtt-10"> ``examples</span><span class="underline"><span +class="cmtt-10">``</span></span><span class="verb"><span +class="cmtt-10">.</span><br> +There are ‘’examples” and there are “examples“.<br> +<span class="verb"><span +class="cmtt-10">There</span><span +class="cmtt-10"> are</span><span +class="cmtt-10"> ``examples''</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> there</span><span +class="cmtt-10"> are</span><span +class="cmtt-10"> ``examples''.</span><br> +There are “examples” and there are “examples”.</div> + </div> + <div class="marginpar"> +<!--l. 1465--><p class="indent"> +<br class="newline"><span +class="cmtt-12">MathRoman</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-124-" ><colgroup id="TBL-124-1g"><col +id="TBL-124-1"><col +id="TBL-124-2"></colgroup><tr + valign="baseline" id="TBL-124-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-124-1-1" +class="td11"> <span +class="cmbx-12">Warning 35: </span></td><td align="left" id="TBL-124-1-2" +class="td11"> <!--l. 1466--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">perhaps</span> + <span +class="cmtt-12">use</span> + <span +class="cmtt-12">`cmd'</span> + <span +class="cmtt-12">instead.</span> </td> + </tr></table> + + <div class="quote"> + <!--l. 1467--><p class="noindent">Most mathematical operators should be set as standard roman font, + instead of the math italic <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> uses for variables. For many + operators, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> provides a pre-defined command which will typeset + the operator correctly. Look below for an illustration of the point. + <div class="center" +> +<!--l. 1472--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">$</span><span class="underline"><span +class="cmtt-10">sin</span></span><span class="verb"><span +class="cmtt-10">^2</span><span +class="cmtt-10"> x</span><span +class="cmtt-10"> +</span><span +class="cmtt-10"> </span><span class="underline"><span +class="cmtt-10">cos</span></span><span class="verb"><span +class="cmtt-10">^2</span><span +class="cmtt-10"> x</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> 1$</span><br> +<span +class="cmmi-10">sin</span><sup ><span +class="cmr-7">2</span></sup><span +class="cmmi-10">x </span>+ <span +class="cmmi-10">cos</span><sup ><span +class="cmr-7">2</span></sup><span +class="cmmi-10">x </span>= 1<br> +<span class="verb"><span +class="cmtt-10">$\sin^2</span><span +class="cmtt-10"> x</span><span +class="cmtt-10"> +</span><span +class="cmtt-10"> \cos^2</span><span +class="cmtt-10"> x</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> 1$</span><br> +sin<sup ><span +class="cmr-7">2</span></sup><span +class="cmmi-10">x </span>+ cos<sup ><span +class="cmr-7">2</span></sup><span +class="cmmi-10">x </span>= 1</div> + </div> +<!--l. 1481--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-127-" ><colgroup id="TBL-127-1g"><col +id="TBL-127-1"><col +id="TBL-127-2"></colgroup><tr + valign="baseline" id="TBL-127-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-127-1-1" +class="td11"> <span +class="cmbx-12">Warning 36: </span></td><td align="left" id="TBL-127-1-2" +class="td11"> <!--l. 1481--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">put</span> + <span +class="cmtt-12">a</span> + <span +class="cmtt-12">space</span> + <span +class="cmtt-12">in</span> + <span +class="cmtt-12">front</span> + <span +class="cmtt-12">of/after</span> + <span +class="cmtt-12">parenthesis.</span> </td> + </tr></table> +<br class="newline"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-130-" ><colgroup id="TBL-130-1g"><col +id="TBL-130-1"><col +id="TBL-130-2"></colgroup><tr + valign="baseline" id="TBL-130-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-130-1-1" +class="td11"> <span +class="cmbx-12">Warning 37: </span></td><td align="left" id="TBL-130-1-2" +class="td11"> <!--l. 1482--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">avoid</span> + <span +class="cmtt-12">spaces</span> + <span +class="cmtt-12">in</span> + <span +class="cmtt-12">front</span> + <span +class="cmtt-12">of/after</span> + <span +class="cmtt-12">parenthesis.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1483--><p class="noindent">Outside math mode, you should put a space in front of any group of + opening parenthesis, and no spaces after. If you have several after each + other, you should of course not put a space in between each; look in the + example below. Likewise, there should not be spaces in front of closing + parenthesis, but there should be at least one after. + <div class="center" +> +<!--l. 1492--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span class="underline"><span +class="cmtt-10">( </span></span><span class="verb"><span +class="cmtt-10">an</span><span +class="cmtt-10"> example</span><span class="underline"><span +class="cmtt-10">( </span></span><span class="verb"><span +class="cmtt-10">Nuff</span><span +class="cmtt-10"> said</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">)),</span><span +class="cmtt-10"> illustrates</span><span class="underline"><span +class="cmtt-10">( </span></span><span class="verb"><span +class="cmtt-10">``my''</span><span class="underline"><span +class="cmtt-10"> )</span></span><span class="verb"><span +class="cmtt-10">point.</span><br> +This( an example( Nuff said )), illustrates( “my” )point.<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> (an</span><span +class="cmtt-10"> example</span><span +class="cmtt-10"> (Nuff</span><span +class="cmtt-10"> said)),</span><span +class="cmtt-10"> illustrates</span><span +class="cmtt-10"> (``my'')</span><span +class="cmtt-10"> point.</span><br> +This (an example (Nuff said)), illustrates (“my”) point.<br> +</div> + + </div> + <div class="marginpar"> +<!--l. 1503--><p class="indent"> +<br class="newline"><span +class="cmtt-12">QuoteStyle</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-133-" ><colgroup id="TBL-133-1g"><col +id="TBL-133-1"><col +id="TBL-133-2"></colgroup><tr + valign="baseline" id="TBL-133-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-133-1-1" +class="td11"> <span +class="cmbx-12">Warning 38: </span></td><td align="left" id="TBL-133-1-2" +class="td11"> <!--l. 1505--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">not</span> + <span +class="cmtt-12">use</span> + <span +class="cmtt-12">punctuation</span> + <span +class="cmtt-12">in</span> + <span +class="cmtt-12">front</span> + <span +class="cmtt-12">of/after</span> + <span +class="cmtt-12">quotes.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1507--><p class="noindent">For best looking documents, you should decide on how you wish to put quotes + relative to punctuation. Chk<span class="TEX">T<span +class="E">E</span>X</span> recognizes two styles; you may specify + which you use in the “<span +class="cmtt-10">chktexrc</span>” file. A description on each style + follows: + <dl class="description"><dt class="description"> +<span +class="cmbx-10">Traditional:</span> </dt><dd +class="description">This style is the most visually pleasing. It always puts + the punctuation <span +class="cmti-10">in front of </span>the quotes, which gives a continuous + bottom line. + <!--l. 1516--><p class="noindent">However, it may in certain cases be ambigious. Consider the following + example from a fictious “<span +class="cmtt-10">vi(1)</span>” tutorial (quote taken from the Jargon + file): + <div class="center" +> +<!--l. 1519--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">Then</span><span +class="cmtt-10"> delete</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> line</span><span +class="cmtt-10"> from</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> file</span><span +class="cmtt-10"> by</span><span +class="cmtt-10"> typing</span><span +class="cmtt-10"> ``dd.''</span><br> +Then delete a line from the file by typing “dd.”</div> + <!--l. 1523--><p class="noindent">That would be very bad -- because the reader would be prone to type + the string d-d-dot, and it happens that in “<span +class="cmtt-10">vi(1)</span>” dot repeats the last + command accepted. The net result would be to delete <span +class="cmti-10">two </span>lines! + This problem is avoided using logical style, described below. + </dd><dt class="description"> +<span +class="cmbx-10">Logical:</span> </dt><dd +class="description">This style uses quotes as balanced delimiters like parentheses. While + this is not the most visual pleasing, it is can’t be misunderstood. The + above sentence would then become: + <div class="center" +> +<!--l. 1533--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">Then</span><span +class="cmtt-10"> delete</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> line</span><span +class="cmtt-10"> from</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> file</span><span +class="cmtt-10"> by</span><span +class="cmtt-10"> typing</span><span +class="cmtt-10"> ``dd''.</span><br> +Then delete a line from the file by typing “dd”.</div> + </dd></dl> + </div> + +<!--l. 1542--><p class="noindent"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-136-" ><colgroup id="TBL-136-1g"><col +id="TBL-136-1"><col +id="TBL-136-2"></colgroup><tr + valign="baseline" id="TBL-136-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-136-1-1" +class="td11"> <span +class="cmbx-12">Warning 39: </span></td><td align="left" id="TBL-136-1-2" +class="td11"> <!--l. 1542--><p class="noindent"><span +class="cmtt-12">Double</span> + <span +class="cmtt-12">space</span> + <span +class="cmtt-12">found.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1543--><p class="noindent">This warning is triggered whenever Chk<span class="TEX">T<span +class="E">E</span>X</span> finds a space in front of + a hard space, or vice versa. This will be rendered as two spaces (which + you usually don’t wish). + <div class="center" +> +<!--l. 1547--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">For</span><span +class="cmtt-10"> output</span><span +class="cmtt-10"> codes,</span><span +class="cmtt-10"> see</span><span +class="cmtt-10"> table</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">~</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">\ref{foo}.</span><br> +For output codes, see table 1.1.<br> +<span class="verb"><span +class="cmtt-10">For</span><span +class="cmtt-10"> output</span><span +class="cmtt-10"> codes,</span><span +class="cmtt-10"> see</span><span +class="cmtt-10"> table~\ref{foo}.</span><br> +For output codes, see table 1.1.</div> + </div> + <div class="marginpar"> +<!--l. 1557--><p class="indent"> +<br class="newline"><span +class="cmtt-12">MathEnvir</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-139-" ><colgroup id="TBL-139-1g"><col +id="TBL-139-1"><col +id="TBL-139-2"></colgroup><tr + valign="baseline" id="TBL-139-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-139-1-1" +class="td11"> <span +class="cmbx-12">Warning 40: </span></td><td align="left" id="TBL-139-1-2" +class="td11"> <!--l. 1559--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">put</span> + <span +class="cmtt-12">punctuation</span> + <span +class="cmtt-12">outside</span> + <span +class="cmtt-12">inner/inside</span> + <span +class="cmtt-12">display</span> + <span +class="cmtt-12">math</span> + <span +class="cmtt-12">mode.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1560--><p class="noindent">As recommended in the <span class="TEX">T<span +class="E">E</span>X</span>book, you should try to put punctuation + outside inner math mode, as this is gets formatted better. + <!--l. 1563--><p class="noindent">Similarily, you should let any final punctuation in display math mode end up + within it. Look at the following example, which was taken from the + <span class="TEX">T<span +class="E">E</span>X</span>book: + <div class="center" +> +<!--l. 1566--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">for</span><span +class="cmtt-10"> $x</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> a</span><span class="underline"><span +class="cmtt-10">,</span></span><span class="verb"><span +class="cmtt-10">b$,</span><span +class="cmtt-10"> or</span><span +class="cmtt-10"> $c$.</span><br> +for <span +class="cmmi-10">x </span>= <span +class="cmmi-10">a,b</span>, or <span +class="cmmi-10">c</span>.<br> +<span class="verb"><span +class="cmtt-10">for</span><span +class="cmtt-10"> $x</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> a$,</span><span +class="cmtt-10"> $b$,</span><span +class="cmtt-10"> or</span><span +class="cmtt-10"> $c$.</span><br> +for <span +class="cmmi-10">x </span>= <span +class="cmmi-10">a</span>, <span +class="cmmi-10">b</span>, or <span +class="cmmi-10">c</span>.<br> +</div> + </div> + + <div class="marginpar"> +<!--l. 1576--><p class="indent"> +<br class="newline"><span +class="cmtt-12">Primitives</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-142-" ><colgroup id="TBL-142-1g"><col +id="TBL-142-1"><col +id="TBL-142-2"></colgroup><tr + valign="baseline" id="TBL-142-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-142-1-1" +class="td11"> <span +class="cmbx-12">Warning 41: </span></td><td align="left" id="TBL-142-1-2" +class="td11"> <!--l. 1577--><p class="noindent"><span +class="cmitt-10x-x-120">You</span> + <span +class="cmitt-10x-x-120">ought</span> + <span +class="cmitt-10x-x-120">to</span> + <span +class="cmitt-10x-x-120">not</span> + <span +class="cmitt-10x-x-120">use</span> + <span +class="cmitt-10x-x-120">primitive</span> + <span +class="cmitt-10x-x-120">TeX</span> + <span +class="cmitt-10x-x-120">in</span> + <span +class="cmitt-10x-x-120">LaTeX</span> + <span +class="cmitt-10x-x-120">code.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1578--><p class="noindent">This warning is triggered whenever you use a raw <span class="TEX">T<span +class="E">E</span>X</span> command which + has been replaced by a <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> equivalent. If you consider yourself a + purist (or want to be sure your code works under <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>3), you should + use the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> equivalent.</div> + <div class="marginpar"> +<!--l. 1584--><p class="indent"> +<br class="newline"><span +class="cmtt-12">NotPreSpaced</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-145-" ><colgroup id="TBL-145-1g"><col +id="TBL-145-1"><col +id="TBL-145-2"></colgroup><tr + valign="baseline" id="TBL-145-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-145-1-1" +class="td11"> <span +class="cmbx-12">Warning 42: </span></td><td align="left" id="TBL-145-1-2" +class="td11"> <!--l. 1585--><p class="noindent"><span +class="cmtt-12">You</span> + <span +class="cmtt-12">should</span> + <span +class="cmtt-12">remove</span> + <span +class="cmtt-12">spaces</span> + <span +class="cmtt-12">in</span> + <span +class="cmtt-12">front</span> + <span +class="cmtt-12">of</span> + <span +class="cmtt-12">`%s'</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1587--><p class="noindent">Some commands should not be prepended by a space character, for + cosmetical reasons. This notes you of this whenever this has happened. + <div class="center" +> +<!--l. 1590--><p class="noindent"> + <span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> footnote</span><span class="underline"><span +class="cmtt-10"> </span></span><span class="verb"><span +class="cmtt-10">\footnotemark[1]</span><span +class="cmtt-10"> mark.</span><br> +This is a footnote <sup ><span +class="cmr-7">1</span></sup> mark.<br> +<span class="verb"><span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> footnote\footnotemark[1]</span><span +class="cmtt-10"> mark.</span><br> +This is a footnote<sup ><span +class="cmr-7">1</span></sup> mark.<br> +</div> + </div> + + <div class="marginpar"> +<!--l. 1599--><p class="indent"> +<br class="newline"><span +class="cmtt-12">NoCharNext</span></div><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-148-" ><colgroup id="TBL-148-1g"><col +id="TBL-148-1"><col +id="TBL-148-2"></colgroup><tr + valign="baseline" id="TBL-148-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-148-1-1" +class="td11"> <span +class="cmbx-12">Warning 43: </span></td><td align="left" id="TBL-148-1-2" +class="td11"> <!--l. 1600--><p class="noindent"><span +class="cmtt-12">`%s'</span> + <span +class="cmtt-12">is</span> + <span +class="cmtt-12">normally</span> + <span +class="cmtt-12">not</span> + <span +class="cmtt-12">followed</span> + <span +class="cmtt-12">by</span> + <span +class="cmtt-12">`%c'.</span> </td> + </tr></table> + <div class="quote"> + <!--l. 1601--><p class="noindent"><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>’ error message when calling <span class="verb"><span +class="cmtt-10">\left</span><span +class="cmtt-10"> \{ </span>instead of <span class="verb"><span +class="cmtt-10">left</span><span +class="cmtt-10"> \{ </span>is + unfortunately rather poor. This warning detects this and similar errors.</div> +<!--l. 1606--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">7 </span> <a + id="x1-220007"></a>Future plans</h3> +<!--l. 1608--><p class="noindent">In a somewhat prioritized sequence, this is what I’d like to put into the program -- if I +have the time. + <ul class="itemize1"> + <li class="itemize">Do + a final fix for maths mode. Currently, Chk<span class="TEX">T<span +class="E">E</span>X</span> doesn’t recognize embedded + math mode (i.e. constructions like <span class="verb"><span +class="cmtt-10">$$a+b\text{for</span><span +class="cmtt-10"> $a</span><span +class="cmtt-10"> \leq</span><span +class="cmtt-10"> 0$}$$</span>). + </li> + <li class="itemize">Support for regular expressions as user patterns. I’ll do it at once I get the + GNU “<span +class="cmtt-10">rx</span>” package up and running (it doesn’t produce correct include files). + </li> + <li class="itemize">De-linearize the checker. Currently, it works on a line-by-line basis, in most + respects, at least. I hope to be able to remove this barrier; as this will reduce + the amount of false warnings somewhat. + </li> + <li class="itemize">Probably some more warnings/errors; just have to think them out first. + Suggestions are appreciated -- I’ve “stolen” most that similar programs + provides, and am running out of ideas, really. + <!--l. 1629--><p class="noindent">It would also be nice to investigate the field of “globally” oriented + warnings; i.e. warnings regarding the document as a whole. Currently, + Chk<span class="TEX">T<span +class="E">E</span>X</span> operates mainly on a local/“greedy” basis. + <!--l. 1634--><p class="noindent">If you have suggestions/ideas on this topic, they’re certainly welcome, + including references to literature. + </li> + <li class="itemize">Fix a few more bugs. :-)</li></ul> + +<!--l. 1640--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">8 </span> <a + id="x1-230008"></a>Notes</h3> +<!--l. 1642--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">8.1 </span> <a + id="x1-240008.1"></a>Wish to help?</h4> +<!--l. 1644--><p class="noindent">As most other living creatures, I have only a limited amount of time. If you like +Chk<span class="TEX">T<span +class="E">E</span>X</span> and would like to help improving it, here’s a few things I would like to receive. +The following ideas are given: + <ul class="itemize1"> + <li class="itemize">Does anyone have a <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> <span +class="cmsy-10"><img +src="cmsy10-21.png" alt="-->" class="10x-x-21" /></span> <span +class="cmtt-10">troff</span> conversion program? It would be really + nice if I could extract the relevant sections from this manual, and present + them as a man page. I will not, however, convert this manual to <span class="TEX">T<span +class="E">E</span>X</span>info in + order to be able to do this; IMHO <span class="TEX">T<span +class="E">E</span>X</span>info documents have far too limited + typographic possibilities. + <!--l. 1656--><p class="noindent">This doesn’t mean that I’m not willing to restructure the document at all. This + manual already uses some kind of preprocessing in order to achieve HTML + output via <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>2<span +class="cmtt-10">html</span>, I’m willing to do the same in order to produce + <span +class="cmtt-10">troff </span>output. + </li> + <li class="itemize">Help me port the program! This is a prioritized one. It’s no fun writing ANSI + C when people haven’t got a C compiler. + <!--l. 1664--><p class="noindent">Of course, I’ll provide whatever help necessary to modify the sources to fit + to the new platform. Take contact if you’re interested. I will include your + compiled binary in the distribution, and give you credit where appropiate. + <!--l. 1669--><p class="noindent">Just one request: If you have to modify the sources in order to make + Chk<span class="TEX">T<span +class="E">E</span>X</span> compile & work on the new platform, <span +class="cmti-10">please </span>enclose your changes + in something like “<span +class="cmtt-10">#ifdef </span><span +class="cmtt-10">_</span><span +class="cmtt-10">_PLATFORM</span><span +class="cmtt-10">_</span><span +class="cmtt-10">_...code...#endif</span>”! It makes life + so much easier later, when we try to merge the two source trees. + </li> + <li class="itemize">Reports on problems configuring and compiling Chk<span class="TEX">T<span +class="E">E</span>X</span> on supported (and + unsupported) systems are welcomed. + </li> + <li class="itemize">Filters for other file formats. I do believe that there are several formats using + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> for its formatting purposes, combining that with something else. + If you can write a program or script which filters everything away but the + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code, it will surely be appreciated (and included). Look at the <span class="verb"><span +class="cmtt-10">deweb</span> + script to see what I mean. + </li> + <li class="itemize">Arexx interfaces for other editors are also welcomed; these should be rather fast to + write. They should to the following: + <ol type="1" class="enumerate1" > + <li class="enumerate" value="1" +><a + id="x1-24002x1"></a>Get the filename of the active file. + </li> + <li class="enumerate" value="2" +><a + id="x1-24004x2"></a>If possible, save the file to disk if there has been any changes. + </li> + <li class="enumerate" value="3" +><a + id="x1-24006x3"></a>Call the program “<span +class="cmtt-10">ChkTeX.rexx</span>” with the filename as the only + parameter.</li></ol> + + </li> + <li class="itemize">If somebody out there actually possesses (and uses) GoldED, it would be nice if + they checked whether the ARexx script included actually work. If not, + please send me a fixed copy; perhaps also one which supports point 2 + above, too. If it does work, then please tell me so, so I can remove this + item. + <!--l. 1701--><p class="noindent">I don’t have GoldEd in my possession; the script was just modelled after Juergen + Zeschky’s, (<span +class="cmtt-10"><juergen@sokrates.nbg.de></span>) PGP <span +class="cmsy-10"><img +src="cmsy10-24.png" alt="<-->" class="10x-x-24" /></span> GoldED interface. + </li> + <li class="itemize">If you update the “<span +class="cmtt-10">chktexrc</span>” file in anyway that is not strictly local, I would + appreciate to receive your updated version. + </li> + <li class="itemize">Suggestions for new warnings are always welcomed. Both formal (i.e. regexps or + similar) and non-formal (plain English) descriptions are welcomed.</li></ul> +<!--l. 1713--><p class="indent"> Of course, people doing any of this will be mentioned in this document, and thus +receive eternal glory and appreciation. +<!--l. 1716--><p class="noindent"> + <h4 class="subsectionHead"><span class="titlemark">8.2 </span> <a + id="x1-250008.2"></a>Caps and stuff</h4> +<!--l. 1718--><p class="noindent">This program uses the “<span +class="cmtt-10">getopt()</span>” routine, as supplied from GNU. The source +included in this distribution has been modified slightly. To make the use of +C2LOCAL easier, portions which were <span class="verb"><span +class="cmtt-10">#ifdef</span>’ed out, have now been commented +out. +<!--l. 1723--><p class="indent"> Where trademarks have been used, the author is aware of that they belong to +someone, and has tried to stick to the original caps. +<!--l. 1726--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">9 </span> <a + id="x1-260009"></a>About the author</h3> +<!--l. 1728--><p class="noindent">A quick summary of who I am and what I do: +<!--l. 1730--><p class="indent"> I’m 21 years old, and live in Oslo, the capital of Norway. I’m currently studying maths +and computer science at the University of Oslo; planning to get a degree within +mathematical modeling, with a dash of physics and emphazing the computer part of the +study. More precisely, in autumn’96 my studies consist of mathematical analysis, +statistics & probability calculations plus studying the relationship between society and +computers. +<!--l. 1738--><p class="indent"> At home I now possess 4 computers, of which 1 is regular use: A vanilla Amiga +1200, expanded only by a HD. The others are a <span +class="cmtt-10">80286 </span>PC and an Amiga 500, +both semi-out-of-order. The last one is a Commodore VIC-20, which for some +peculiar reason never seems to be used. Plans are to get a Linux-capable PC, +though. +<!--l. 1744--><p class="indent"> Most of the time in front of these computers (including SGI Indy’s and SPARC +stations at our university) is spent on C and shell programming, plus some +text-processing. +<!--l. 1755--><p class="indent"> C and shell programming are not my only knowledge areas regarding computers, +however. I write the following languages more or less: Perl, Motorola <span +class="cmtt-10">68000 </span>assembly +code, ARexx, Simula, C++, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>, HTML, AmigaGuide, Amos Basic and Installer +LISP. Once I also mastered Commodore Basic V2, the “language” included with my +VIC-20. + +<!--l. 1761--><p class="indent"> However, I also try to not to end up as a computer nerd. Thus, in addition to the +compulsory (?) interest for computers, I am a scout. Still running into the woods, +climbing the trees, falling down and climbing up once more, in other words. To be more +specific, I am a now a troop leader for ‘Ulven’ scout-group; Norwegian Scouts +Association. I am also a active rover in ‘Vålerenga’ scout-group. +<!--l. 1768--><p class="indent"> Certainly a lot more to tell (I play the piano and like cross-country skiing, for +instance); but I’ll stop here before you fall asleep...:-) +<!--l. 1773--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">10 </span> <a + id="x1-2700010"></a>Thanks</h3> +<!--l. 1775--><p class="noindent">The author wishes to thank the following people (in alphabetical order): +<!--l. 1786--><p class="indent"> + <dl class="description"><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-149-" ><colgroup id="TBL-149-1g"><col +id="TBL-149-1"></colgroup><tr + valign="baseline" id="TBL-149-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-149-1-1" +class="td11"> <span +class="cmbx-10">Russ Bubley </span></td> +</tr><tr + valign="baseline" id="TBL-149-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-149-2-1" +class="td11"> <span +class="cmtt-10">russ@scs.leeds.ac.uk </span></td> +</tr><tr + valign="baseline" id="TBL-149-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-149-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">He has been the main external beta-tester for this program, sending me loads + and loads of understandable and reproducible bug reports. If you somehow + think that Chk<span class="TEX">T<span +class="E">E</span>X</span> is well-behaved and free from bugs, send warm thoughts + to Russ. He has also provided ideas for enhanced checks and so forth. + <!--l. 1795--><p class="noindent">In addition, he sent me a huge list of 238 common English abbreviations, for + inclusion in the “<span +class="cmtt-10">chktexrc</span>” file! Together with the enhanced abbreviation + recognizer, I do now believe most abbreviations should be catched...:-) + <!--l. 1800--><p class="noindent">Finally, he has also given me valuable hints for improving the program’s + outputting routine, and given me lots of suggestions for filtering + unnecessary/false warnings away. + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-150-" ><colgroup id="TBL-150-1g"><col +id="TBL-150-1"></colgroup><tr + valign="baseline" id="TBL-150-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-150-1-1" +class="td11"> <span +class="cmbx-10">Gerd B</span><span +class="cmbx-10">öhm </span></td> +</tr><tr + valign="baseline" id="TBL-150-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-150-2-1" +class="td11"> <span +class="cmtt-10">Gerd.Boehm@physik.uni-regensburg.de </span></td> +</tr><tr + valign="baseline" id="TBL-150-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-150-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Improved and bug-fixed the MS-DOS port of Chk<span class="TEX">T<span +class="E">E</span>X</span> v1.4, sending me + ready-to-yank code patches. The original port didn’t respect all the peculiarities + of the MS-DOS file-system, unfortunately. + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-151-" ><colgroup id="TBL-151-1g"><col +id="TBL-151-1"></colgroup><tr + valign="baseline" id="TBL-151-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-151-1-1" +class="td11"> <span +class="cmbx-10">Lars Frellesen </span></td> +</tr><tr + valign="baseline" id="TBL-151-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-151-2-1" +class="td11"> <span +class="cmtt-10">frelle@math-tech.dk </span></td> +</tr><tr + valign="baseline" id="TBL-151-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-151-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Sent a few bug reports regarding the filtering of messages. He has also helped + me to expand the “<span +class="cmtt-10">SILENT</span>” keyword in the “<span +class="cmtt-10">chktexrc</span>” file. + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-152-" ><colgroup id="TBL-152-1g"><col +id="TBL-152-1"></colgroup><tr + valign="baseline" id="TBL-152-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-152-1-1" +class="td11"> <span +class="cmbx-10">Wolfgang Fritsch </span></td> +</tr><tr + valign="baseline" id="TBL-152-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-152-2-1" +class="td11"> <span +class="cmtt-10">fritsch@hmi.de </span></td> +</tr><tr + valign="baseline" id="TBL-152-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-152-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Author of the OS/2 port, which he did using the emx compiler. Please direct + questions regarding strictly to that port to him (I would like to receive a + carbon copy, though). + </dd><dt class="description"> + + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-153-" ><colgroup id="TBL-153-1g"><col +id="TBL-153-1"></colgroup><tr + valign="baseline" id="TBL-153-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-153-1-1" +class="td11"> <span +class="cmbx-10">Stefan Gerberding </span></td> +</tr><tr + valign="baseline" id="TBL-153-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-153-2-1" +class="td11"> <span +class="cmtt-10">stefan@inferenzsysteme.informatik.th-darmstadt.de </span></td> +</tr><tr + valign="baseline" id="TBL-153-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-153-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">First one to report the Enforcer hit in v1.2 when using Chk<span class="TEX">T<span +class="E">E</span>X</span> as a pipe. + Also came with suggestions to make Chk<span class="TEX">T<span +class="E">E</span>X</span> more easily compile on early + gcc compilers. + <!--l. 1823--><p class="noindent">He has also kept on beta-testing later versions of Chk<span class="TEX">T<span +class="E">E</span>X</span>, giving me + bug-reports and enhancements requests. + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-154-" ><colgroup id="TBL-154-1g"><col +id="TBL-154-1"></colgroup><tr + valign="baseline" id="TBL-154-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-154-1-1" +class="td11"> <span +class="cmbx-10">Kasper B. Graversen </span></td> +</tr><tr + valign="baseline" id="TBL-154-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-154-2-1" +class="td11"> <span +class="cmtt-10">kbg2001@internet.dk </span></td> +</tr><tr + valign="baseline" id="TBL-154-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-154-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Lots of creative suggestions and improvements. Several of the warnings implemented + were based on his ideas. In addition, he has given advice for improving the + existing warnings. + <!--l. 1831--><p class="noindent">Has also provided some OS-oriented code. + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-155-" ><colgroup id="TBL-155-1g"><col +id="TBL-155-1"></colgroup><tr + valign="baseline" id="TBL-155-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-155-1-1" +class="td11"> <span +class="cmbx-10">Frank Luithle </span></td> +</tr><tr + valign="baseline" id="TBL-155-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-155-2-1" +class="td11"> <span +class="cmtt-10">f</span><span +class="cmtt-10">_luithle@outside.sb.sub.de </span></td> +</tr><tr + valign="baseline" id="TBL-155-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-155-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Wrote a translation for v1.0. Unfortunately, he remained unreachable after + that...:-/ + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-156-" ><colgroup id="TBL-156-1g"><col +id="TBL-156-1"></colgroup><tr + valign="baseline" id="TBL-156-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-156-1-1" +class="td11"> <span +class="cmbx-10">Nat </span></td> +</tr><tr + valign="baseline" id="TBL-156-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-156-2-1" +class="td11"> <span +class="cmtt-10">nat@nataa.frmug.fr.net </span></td> +</tr><tr + valign="baseline" id="TBL-156-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-156-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Reported the same bug as Gerberding. In addition, he taught me a few tricks + regarding the use of gcc + made me understand that the ANSI standard isn’t + unambigious; at least the <span class="verb"><span +class="cmtt-10">getenv() </span>call seem to be open for interpretations. + Many possible incompatibilities have been removed due to these lessons. + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-157-" ><colgroup id="TBL-157-1g"><col +id="TBL-157-1"></colgroup><tr + valign="baseline" id="TBL-157-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-157-1-1" +class="td11"> <span +class="cmbx-10">Michael Sanders </span></td> +</tr><tr + valign="baseline" id="TBL-157-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-157-2-1" +class="td11"> <span +class="cmtt-10">sanders@umich.edu </span></td> +</tr><tr + valign="baseline" id="TBL-157-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-157-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Has found some of the bugs in this beast; both obscure and long-lived. Has + also provided motivation to clarify this document. + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-158-" ><colgroup id="TBL-158-1g"><col +id="TBL-158-1"></colgroup><tr + valign="baseline" id="TBL-158-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-158-1-1" +class="td11"> <span +class="cmbx-10">Bjørn Ove Thue </span></td> +</tr><tr + valign="baseline" id="TBL-158-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-158-2-1" +class="td11"> <span +class="cmtt-10">bjort@ifi.uio.no </span></td> +</tr><tr + valign="baseline" id="TBL-158-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-158-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Author of the MSDOS port; please direct questions regarding strictly to that + port to him (I would like to receive a carbon copy, though). + </dd><dt class="description"> + </dt><dd +class="description"> <!--tex4ht:inline--><div class="tabular"><table class="tabular" +cellspacing="0" cellpadding="0" +frame="void" id="TBL-159-" ><colgroup id="TBL-159-1g"><col +id="TBL-159-1"></colgroup><tr + valign="baseline" id="TBL-159-1-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-159-1-1" +class="td11"> <span +class="cmbx-10">Martin Ward </span></td> +</tr><tr + valign="baseline" id="TBL-159-2-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-159-2-1" +class="td11"> <span +class="cmtt-10">Martin.Ward@durham.ac.uk </span></td> +</tr><tr + valign="baseline" id="TBL-159-3-"><td align="left" style="white-space:nowrap; text-align:left;" id="TBL-159-3-1" +class="td11"> </td> +</tr></table> </div> + <br class="newline">Sent a few bug-reports; also gave me information upon where to find regexp + code. He also provided a Perl script for checking ordinary text, which ideas I + was able to implement in Chk<span class="TEX">T<span +class="E">E</span>X</span>. In addition, he sent me the source code + + for <span class="verb"><span +class="cmtt-10">lacheck</span>; which also inspired some of the warnings.</dd></dl> +<!--l. 1862--><p class="noindent"> + <h3 class="sectionHead"><span class="titlemark">11 </span> <a + id="x1-2800011"></a>Contacting the author</h3> +<!--l. 1864--><p class="noindent">If you wish to contact me for any reason or would like to participate in the development +of Chk<span class="TEX">T<span +class="E">E</span>X</span>, please write to: + <div class="quote"> + <!--l. 1870--><p class="noindent">Jens Berger + <br class="newline">Spektrumvn. 4 + <br class="newline">N-0666 Oslo + <br class="newline">Norway + <br class="newline">E-mail: <span +class="cmtt-10"><jensthi@ifi.uio.no></span></div> +<!--l. 1879--><p class="noindent">Any signs of intelligent life are welcomed; that should exclude piracy. +<!--l. 1881--><p class="indent"> Since the original author is unreachable, the maintainer these days is: + <div class="quote"> + <!--l. 1886--><p class="noindent">Baruch Even + <br class="newline">E-mail: <span +class="cmtt-10"><chktex@ev-en.org></span></div> +<!--l. 1893--><p class="noindent">Have fun. + +</body></html> + + + diff --git a/Master/texmf/doc/chktex/ChkTeX.pdf b/Master/texmf/doc/chktex/ChkTeX.pdf Binary files differnew file mode 100644 index 00000000000..a6bdf6a8ef0 --- /dev/null +++ b/Master/texmf/doc/chktex/ChkTeX.pdf |