summaryrefslogtreecommitdiff
path: root/Build/source/texk/chktex/deweb.doc
blob: 2636687602deae84451947f482813c0e510bacb9 (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



deweb(1)                                                 deweb(1)


NAME
       deweb - strips away C & CWEB commands from CWEB sources

SYNOPSIS
       deweb [ file1 file2 ...  ]

DESCRIPTION
       deweb  filters  away  all  C  &  CWEB commands from a CWEB
       source  code.  This  leaves  only  the  LaTeX  code.  This
       stripped  code,  in turn, may then be passed to a suitable
       syntax checker for LaTeX,  like  ChkTeX  and  lacheck,  or
       spell-checkers like ispell.

       The  chkweb tool, included in the ChkTeX distribution will
       do just this; writing similar scripts should be trivial.

       When deweb strips away the C code from your  CWEB  source,
       it  tries  to  preserve  line breaks.  This means that the
       error reports  from <your favorite tool> will  be  correct
       regarding to line numbers. In most cases, the column posi­
       tion will also be correct. This  significantly  simplifies
       finding the errors in the LaTeX source (in contrast to the
       output from cweave, which output  is  truly  difficult  to
       figure anything out from).

       deweb  accepts  a  list of filenames on the argument line,
       and will send its output to stdout.  If no  filenames  are
       given,  it  will  read  from stdin, acting as a filter. No
       options are currently accepted.

       Macho users may try to pipe the output from deweb directly
       into  LaTeX,  theoretically,  this should work. This would
       ease the debugging of the  LaTeX  code  significantly,  as
       when LaTeX 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.

       deweb should now understand all correct CWEB  opcodes.  If
       it  complains  about  not  understanding a correct opcode,
       please inform the author.

DISTRIBUTION
       Copyright (C) 1996 Jens T. Berger Thielemann

       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.

       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



                           June 8, 1996                         1





deweb(1)                                                 deweb(1)


       PURPOSE.   See  the  GNU  General  Public License for more
       details.

       You should have received a copy of the GNU General  Public
       License along with this program; if not, write to the Free
       Software Foundation, Inc., 675  Mass  Ave,  Cambridge,  MA
       02139, USA.

ENVIRONMENT
       No environment variables are used.

FILES
       None.

AUTHOR
       Jens T. Berger Thielemann, <jensthi@ifi.uio.no>

SEE ALSO
       cweave(1), perl(1), chktex, lacheck(1), ispell(1)

BUGS
       Doesn't  even  compile 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.

       The program will try to swallow the whole  input  file  at
       once, instead of processing it on a line-by-line basis.





























                           June 8, 1996                         2