summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/chktex.1
blob: a3dcc13e3dcd4d5dc329c25cb83b4783297f022b (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
134
135
136
137
138
139
140
141
142
143
.TH chktex 1 "March 30, 2001"
.AT 3
.SH NAME
chktex \- finds typographic errors in LaTeX.
.SH SYNOPSIS
.B chktex
.I [-hiqrW] [-v[0-...]] [-l <rcfile>] [-[wemn] <[1-42]|all>]
.I [-d[0-...]] [-p <name>] [-o <outfile>] [-[btxgI][0|1]]
.B file1 file2 ...
.SH DESCRIPTION
.I chktex
finds typographic errors in
.I LaTeX
.
.SH OPTIONS
.PP
Miscellaneous options:
.TP
.B "-h --help"
Print a help screen.
.TP
.B "-i --license"
Show distribution information.
.TP
.B "-l --localrc"
Read local .chktexrc formatted  file.
.TP
.B "-d --debug"
Debug information. Give it a number.
.TP
.B "-r --reset"
Reset settings to default.
.PP
Muting warning messages:
.TP
.B "-w --warnon"
Makes msg # given a warning and turns it on.
.TP
.B "-e  --erroron"
Makes msg # given an error and turns it on.
.TP
.B "-m --msgon"
Makes msg # given a message and turns it on.
.TP
.B "-n --nowarn"
Mutes msg # given.
.TP
.B "-L --nolinesupp"
Do not allow per-line suppressions.  These are TeX comments of the form
.I "% chktex ##".

.PP
Output control flags:
.TP
.B "-v --verbosity"
How errors are displayed.
Default 1, 0=Less, 2=Fancy, 3=lacheck.
.TP
.B "-V --pipeverb"
How errors are displayed when stdout != tty.
Defaults to the same as -v.
.TP
.B "-s --splitchar"
String used to split fields when doing -v0
.TP
.B "-o --output"
Redirect error report to a file.
.TP
.B "-q --quiet"
Shuts up about version information.
.TP
.B "-p --pseudoname"
Input file-name when reporting.
.TP
.B "-f --format"
Format to use for output

.PP
Boolean switches (1 -> enables / 0 -> disables):
.TP
.B "-b --backup"
Backup output file.
.TP
.B "-x --wipeverb"
Ignore contents of `\\verb' commands.
.TP
.B "-g --globalrc"
Read global .chktexrc file.
.TP
.B "-I --inputfiles"
Execute \\input statements.
.TP
.B "-H --headererr"
Show errors found in front of \\begin{document}
.PP Miscellaneous switches:
.TP
.B "-W --version"
Version information

.PP
If no LaTeX files are specified on the command line, we will read from
stdin.   For explanation of warning/error messages, please consult the
main document /usr/share/doc/chktex/ChkTeX.dvi.gz.

.SH DISTRIBUTION
Copyright (C) 1996 Jens T. Berger Thielemann
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the
.I GNU General Public License
as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but
.B WITHOUT ANY WARRANTY;
without even the implied warranty of
.B MERCHANTABILITY
or
.B FITNESS FOR A PARTICULAR PURPOSE.
See the
.I GNU General Public License
for more details.
.PP
You should have received a copy of the
.B GNU General Public License
along with this program; if not, write to the
.I Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

.SH ENVIRONMENT
No environment variables are used.
.SH FILES
None.
.SH AUTHOR
Jens T. Berger Thielemann,
.I <jensthi@ifi.uio.no>
.PP
This manual page was cobbled together by Clint Adams <schizo@debian.org>,
based on the output of "chktex --help" and deweb(1).
.SH "SEE ALSO"
.B deweb(1), chkweb(1)