From e0c6872cf40896c7be36b11dcc744620f10adf1d Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Mon, 2 Sep 2019 13:46:59 +0900 Subject: Initial commit --- support/texfilt/readme | 133 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 support/texfilt/readme (limited to 'support/texfilt/readme') diff --git a/support/texfilt/readme b/support/texfilt/readme new file mode 100644 index 0000000000..bdc97d2a0c --- /dev/null +++ b/support/texfilt/readme @@ -0,0 +1,133 @@ + +The TeXFILT program is a filter for TeX/LaTeX log files. The +filter converts the log files into "standard" error messages of +the form: + +[Error|Warning] [FileReference] [Line No]: [Standardized Message] + Context Reference + +Sample: +Error yourfile.tex 18: Undefined control sequence + a representative line of text from yourfile \hfffill + +Once error files of this form are created, most modern +programmer's editors can automatically snap to the `next' and +`previous' errors in the error log file and the source code. +I've tested the program on some large LaTeX and plain TeX files, +which consist of many input files. The system will snap directly +to the source file line, containing the error, with the editor I +use. + +I've tested the code under DOS, OS/2 and Linux (aka UNIX). + +Also, the source code for the program was developed using +NOWEB, the literate programming tool developed by Norman Ramsey +and ported to DOS by Lee Wittenberg. People interested in +literate programming might find the documentation helpful. + +The files included in TeXFILT3.ZIP file include: + + 607 Mar 9 19:45 execrev.tex graphics screen + 656 Mar 9 17:36 execset.tex graphics screen + 1740 Mar 8 22:18 getty1.tex file containing errors + 6918 Mar 8 22:18 getty2.tex file containing errors + 10472 Mar 6 22:12 getty3.tex file containing errors + 1861 Mar 10 10:40 getty4.tex file containing errors + 254 Mar 9 18:25 makefile + 9 Mar 10 19:16 t.aux + 30528 Mar 10 19:16 t.dvi + 152 Feb 20 19:24 t.err + 5587 Mar 10 19:16 t.log + 1503 Mar 10 10:04 t.tex master error file + 7817 Mar 11 08:23 texfilt.aux + 3289 Mar 10 22:53 texfilt.awk NoWeB output file + 36796 Mar 11 08:23 texfilt.dvi WeB documentation file + 64485 Mar 10 23:04 texfilt.exe DOS Compiled version of texfilt.awk + 2636 Mar 11 08:23 texfilt.log + 21587 Mar 11 08:27 texfilt.nw NoWeB Source + 31655 Mar 11 08:23 texfilt.tex NoWeB output file + 2451 Mar 11 08:23 texfilt.toc + 1220 Mar 10 23:01 x.err error file produced by T.TEX + +/fonts: + 62956 Mar 9 19:47 execreva.pk bm2font pixel file + 160 Mar 9 19:47 execreva.tfm bm2font tfm file + 35116 Mar 9 19:47 execrevb.pk + 160 Mar 9 19:47 execrevb.tfm + 61300 Mar 9 17:36 execseta.pk + 156 Mar 9 17:36 execseta.tfm + 61112 Mar 9 17:36 execsetb.pk + 160 Mar 9 17:36 execsetb.tfm + 6356 Mar 9 17:36 execsetc.pk + 148 Mar 9 17:36 execsetc.tfm + +/styles: + 957 Jul 28 10:34 ejbbox.sty Style files used in texfilt.tex + 27344 Jul 27 13:09 fancybox.sty courtesy of Tim Van Zandt + 26676 Jan 18 16:26 noweb.sty courtesy of Norm Ramsey + and Lee Wittenberg + +Installation and Usage: + + DOS Users: + + Create a seperate directory for TeXFILT, if you wish. + + Copy TeXFILT3.ZIP to that directory. + + Use "pkunzip -d texfilt3" to extract the subdirectories + correctly. + + If you plan to use the compiled version of the program, + place "texfilt.exe" in a directory searched by you path. + + Use the following command with an awk interpreter to convert + a TeX log file: + + awk -f texfilt.awk YOURFILE.LOG > x.err + + The compiled version can be executed with: + + texfilt YOURFILE.LOG > x.err + + Unix Users: + + Create a seperate directory for TeXFILT, if you wish. + + Copy TeXFILT3.ZIP to that directory. + + Use "unzip -d texfilt3" to extract the subdirectories + correctly. + + A compiled version does not exist for UNIX. The only file + you actually need to keep is "texfilt.awk". All of the + other files are there for documentation and demonstration + purposes. + + Use the following command with an awk interpreter to convert + a TeX log file: + + awk -f texfilt.awk YOURFILE.LOG > x.err + +Printing the DVI File: + +If you want to print the texfilt.dvi file at your site you'll +have to take a couple of extra steps. + 1. Copy the `tfm' files in the fonts sub-directory to your + local directory for tfm files. + 2. Copy the `pk' files in the fonts sub-directory to your + local location for 300dpi pixel files. + +More info on NoWeb: + +If you want to get into literate programming, and I highly +recommend you do, further information on NoWeB can be found by +anonymous ftp at: + + bellcore.com + directory /pub/norman/noweb.shar.Z + +DOSNOWEB can be found at: + + bart.kean.edu + directory /pub/leew -- cgit v1.2.3