summaryrefslogtreecommitdiffstats
path: root/misc/manlint.1
blob: ab7600970a010e9a6d348d57d34c7f2d86c38c92 (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
MANLINT(1)                          Linux Programmer's Manual                          MANLINT(1)

NAME
       manlint - program to report errors in man or mdoc pages

SYNOPSIS
       manlint [ options ] [ list of files ]

DESCRIPTION
       manlint is a program that identifies lint (errors) in man or mdoc page formatting, similar
       to a spelling checker for ordinary text.  Manlint has a list of permitted macros  and  es-
       cape  sequences,  and reports the use of any macro or escape sequence not in the permitted
       list.  This permitted list includes all the macros defined in  man(7),  mdoc(7),  and  the
       safe  subset  of  troff defined in man(7).  manlint also checks for conformance to various
       rules.

       If a man page passes manlint, it  should  be  widely  portable,  even  to  tools  such  as
       man2html(1) which don't implement all of troff.

       If  a list of files is omitted, the standard input is used.  A file by the name "-" is in-
       terpreted as the standard input.

BUGS
       Currently the program is very incomplete.  It doesn't have any options, it  doesn't  actu-
       ally  check  escape sequences, and it can't handle mdoc format.  Still, it's clear what it
       should do, and even in its current form it can find  lots  of  problems  in  existing  man
       files.

AUTHOR
       David  A.  Wheeler  (dwheeler@ida.org)  was  the original author of manlint.  Federico Lu-
       cifredi <flucifredi@acm.org> is the current maintainer.

SEE ALSO
       man(7), mdoc(7).

Linux                                      14 July 1999                                MANLINT(1)