summaryrefslogtreecommitdiff
path: root/support/texfilt/readme
blob: bdc97d2a0c0567f7fa36fba4f9b1ac30437cd0f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
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