← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/texlive-bin/jaunty

« back to all changes in this revision

Viewing changes to build/source/texk/lacheck/lacheck.man

  • Committer: Bazaar Package Importer
  • Author(s): Norbert Preining
  • Date: 2008-06-26 23:14:59 UTC
  • mfrom: (2.1.30 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080626231459-y02rjsrgtafu83yr
Tags: 2007.dfsg.2-3
http://bugs.debian.org/482915
add missing source roadmap.fig of roadmap.eps in fontinst documentation
(Closes: #482915) (urgency medium due to RC bug)
(new patch add-missing-fontinst-source)

Show diffs side-by-side

added added

removed removed

Lines of Context:
build/source/texk/lacheck/lacheck.man
 
1
.TH "LaCheck" "1" "%%LACHECKDATE%%" "%%LACHECKREV%%"
 
2
.SH NAME
 
3
lacheck - A consistency checker for LaTeX documents.
 
4
.SH SYNOPSIS
 
5
.B lacheck 
 
6
.I filename
 
7
[
 
8
.I .tex
 
9
]
 
10
.SH DESCRIPTION
 
11
LaCheck is a general purpose consistency checker for LaTeX documents.
 
12
It reads a LaTeX document and displays warning messages, if it finds
 
13
bad sequences. It should be noted, that the badness is 
 
14
.I very
 
15
subjective.  LaCheck is designed to help find common mistakes in LaTeX
 
16
documents, especially those made by beginners.
 
17
.LP
 
18
The things checked are:
 
19
.LP
 
20
Mismatched groups (braces), environments and math mode
 
21
delimiters.  When a mismatch is found, line numbers for
 
22
.I "both" 
 
23
start and end of the mismatch is given. The error messages comes in
 
24
pairs, one for the end match and one for the beginning, marked with
 
25
\`<-\' and \`->\' respectively.
 
26
.LP
 
27
Bad spacing including missing a \`\\ \' after an abbreviation, missing
 
28
an \`\\@\' before a punctuation mark in a paragraph that is ended by
 
29
an capital letter, double spaces like \` \~\', bad usage of ellipsis
 
30
(like using ... instead of \\ldots, or using \\ldots where \\cdots
 
31
should be used), missing \~ before a \\cite or \\ref commands, space
 
32
before footnotes, italic corrections before comma, point, or italic
 
33
text, italic correction after normal text, missing italic correction
 
34
when switching from italic to normal text, and double italic
 
35
correction.
 
36
.LP
 
37
Badly placed punctuation marks around end of math mode
 
38
delimiters. This is, punctuation placed right after display math end
 
39
or punctuation placed right before text math end.  Sequences of
 
40
whitespace followed by punctuation marks are also caught.
 
41
.LP 
 
42
Bad use of quotation characters, i.e. constructs like "\'word" or
 
43
"word\`" are warned about, tabs in verbatim environments are caught,
 
44
certain TeX primitives are frowned upon, attempts to give font
 
45
specifiers arguments such as \\em{text} are noted, and use of @ in
 
46
LaTeX macros are reported.
 
47
.LP
 
48
LaCheck will read files that are input using \\input or \\include.
 
49
Files with suffix \`.sty\' are omitted, as they probably will cause
 
50
LaCheck to crash.
 
51
.LP 
 
52
LaCheck may be invoked from within Emacs(1) using compile:
 
53
 
 
54
To run:  
 
55
.B "M-x compile RET lacheck RET"
 
56
, and then 
 
57
.B "C-x `"
 
58
to parse the messages
 
59
 
 
60
.SH OUTPUT
 
61
The output is UNIX-error like, and may be parsed using Emacs(1)
 
62
compile mode. Here is a sample:
 
63
 
 
64
.PD 0
 
65
lacheck compiler
 
66
.TP
 
67
"/usr/mef/compiler.tex", line 34: missing \`\\\\\\\\ \' after "etc."
 
68
.TP
 
69
"/usr/mef/compiler.tex", line 179: double space at " ~"
 
70
.TP
 
71
"/usr/mef/compiler.tex", line 186: <- unmatched "}"
 
72
.TP
 
73
"/usr/mef/compiler.tex", line 181: -> unmatched "$$"
 
74
.PD 1
 
75
.LP
 
76
A control space \`\\ \' should be inserted at line 34, to prevent an
 
77
end-of-sentence space. 
 
78
Also, at line 179, the first space of the sequence " ~" should
 
79
probably be deleted.
 
80
The last two lines is an example, where the user mistyped, and
 
81
probably inserted an extra "}" somewhere.
 
82
 
 
83
.SH DIAGNOSTICS
 
84
Some special cases should be explained. In cases where a sentence ends
 
85
with something that LaCheck thinks is an abbreviation an missing \`\\
 
86
\' error may also occur, if the following sentence begins with a
 
87
lowercase letter.
 
88
.LP
 
89
A mismatch error may cause more to follow, due to the chosen
 
90
algorithm. In such cases just correct the
 
91
.I "first"
 
92
error and run LaCheck again
 
93
.LP
 
94
Braces, environments and math mode must be balanced within a file.
 
95
.LP
 
96
LaCheck may be confused by unmatched stuff placed inside verbatim-like
 
97
environments called something else than exactly \`verbatim\'.
 
98
.SH FILES
 
99
%%LACHECKPATH%%
 
100
.SH SEE ALSO
 
101
tex(1), emacs(1), latex(1)
 
102
.SH BUGS
 
103
LaCheck gets confused by advanced macros, is fooled by simple macros,
 
104
can't figure out if you use a non-standard way to switch italic on or
 
105
off, does not like TeX at all, does not provide any options to turn
 
106
off specific warnings, and is at best a crude approximation.
 
107
.LP
 
108
Ideas for improvements and bug reports are very welcome.  Such
 
109
should be directed to the maintainers, their email address is
 
110
<auc-tex_mgr@sunsite.auc.dk>.
 
111
.SH AUTHOR
 
112
Kresten Krab Thorup with modifications by Per Abrahamsen.
 
113