/usr/share/lintian/checks/manpages is in lintian 2.5.10.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 | # manpages -- lintian check script -*- perl -*-
# Copyright (C) 1998 Christian Schwarz
#
# 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 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, you can find it on the World Wide
# Web at http://www.gnu.org/copyleft/gpl.html, or write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.
package Lintian::manpages;
use strict;
use warnings;
use Lintian::Check qw(check_spelling);
use Lintian::Tags qw(tag);
use Lintian::Util qw(clean_env fail);
use Text::ParseWords ();
use File::Basename;
sub run {
my $pkg = shift;
my $type = shift;
my $info = shift;
my $proc = shift;
my $group = shift;
my $ginfo = $group->info;
my %binary;
my %link;
# my %sect_by_binary;
# my %sect_by_manpage;
my %manpage;
# Read package contents...
foreach my $file ($info->sorted_index) {
my $index_info = $info->index->{$file};
my $file_info = $info->file_info->{$file};
my $link = $index_info->link || '';
my ($fname, $path, $suffix) = fileparse($file);
# Binary that wants a manual page?
#
# It's tempting to check the section of the man page depending on the
# location of the binary, but there are too many mismatches between
# bin/sbin and 1/8 that it's not clear it's the right thing to do.
if (($index_info->is_symlink or $index_info->is_file) and
(($path eq 'bin/') or
($path eq 'sbin/') or
($path eq 'usr/bin/') or
($path eq 'usr/bin/X11/') or
($path eq 'usr/bin/mh/') or
($path eq 'usr/sbin/') or
($path eq 'usr/games/') or
($path eq 'usr/X11R6/bin/') )) {
my $bin = $fname;
$binary{$bin} = $file;
$link{$bin} = $link if $link;
next;
}
if (($path =~ m,usr/(share|X11R6)/man/$,) and ($fname ne '')) {
tag 'manpage-in-wrong-directory', $file;
next;
}
# manual page?
next unless ($index_info->is_symlink or $index_info->is_file) and
(($path =~ m,^usr/man(/\S+),o)
or ($path =~ m,^usr/X11R6/man(/\S+),o)
or ($path =~ m,^usr/share/man(/\S+),o) );
my $t = $1;
if (not $t =~ m,^.*man(\d)/$,o) {
tag 'manpage-in-wrong-directory', $file;
next;
}
my ($section,$name) = ($1,$fname);
my $lang = '';
$lang = $1 if $t =~ m,^/([^/]+)/man\d/$,o;
# The country should not be part of the man page locale directory unless
# it's one of the known cases where the language is significantly
# different between countries.
if ($lang =~ /_/ && $lang !~ /^(?:pt_BR|zh_[A-Z][A-Z])$/) {
tag 'manpage-locale-dir-country-specific', $file;
}
my @pieces = split(/\./, $name);
my $ext = pop @pieces;
if ($ext ne 'gz') {
push @pieces, $ext;
tag 'manpage-not-compressed', $file;
} elsif ($index_info->is_file) { # so it's .gz... files first; links later
if ($file_info !~ m/gzip compressed data/o) {
tag 'manpage-not-compressed-with-gzip', $file;
} elsif ($file_info !~ m/max compression/o) {
tag 'manpage-not-compressed-with-max-compression', $file;
}
}
my $fn_section = pop @pieces;
my $section_num = $fn_section;
if (scalar @pieces && $section_num =~ s/^(\d).*$/$1/) {
my $bin = join('.', @pieces);
$manpage{$bin} = [] unless $manpage{$bin};
push @{$manpage{$bin}}, { file => $file, lang => $lang };
# number of directory and manpage extension equal?
if ($section_num != $section) {
tag 'manpage-in-wrong-directory', $file;
}
} else {
tag 'manpage-has-wrong-extension', $file;
}
# check symbolic links to other manual pages
if ($index_info->is_symlink) {
if ($link =~ m,(^|/)undocumented,o) {
if ($path =~ m,^usr/share/man,o) {
# undocumented link in /usr/share/man -- possibilities
# undocumented... (if in the appropriate section)
# ../man?/undocumented...
# ../../man/man?/undocumented...
# ../../../share/man/man?/undocumented...
# ../../../../usr/share/man/man?/undocumented...
if ((($link =~ m,^undocumented\.([237])\.gz,o) and
($path =~ m,^usr/share/man/man$1,)) or
($link =~ m,^\.\./man[237]/undocumented\.[237]\.gz$,o) or
($link =~ m,^\.\./\.\./man/man[237]/undocumented\.[237]\.gz$,o) or
($link =~ m,^\.\./\.\./\.\./share/man/man[237]/undocumented\.[237]\.gz$,o) or
($link =~ m,^\.\./\.\./\.\./\.\./usr/share/man/man[237]/undocumented\.[237]\.gz$,o)) {
tag 'link-to-undocumented-manpage', $file;
} else {
tag 'bad-link-to-undocumented-manpage', $file;
}
} else {
# undocumented link in /usr/X11R6/man -- possibilities:
# ../../../share/man/man?/undocumented...
# ../../../../usr/share/man/man?/undocumented...
if (($link =~ m,^\.\./\.\./\.\./share/man/man[237]/undocumented\.[237]\.gz$,o) or
($link =~ m,^\.\./\.\./\.\./\.\./usr/share/man/man[237]/undocumented\.[237]\.gz$,o)) {
tag 'link-to-undocumented-manpage', $file;
} else {
tag 'bad-link-to-undocumented-manpage', $file;
}
}
}
} else { # not a symlink
my $path = $info->unpacked($file);
open (MANFILE, '-|', "zcat \Q$path\E 2>/dev/null")
or fail("cannot open $file: $!");
my @manfile = ();
while (<MANFILE>) { push @manfile, $_; }
close MANFILE;
# Is it a .so link?
if ($index_info->size < 256) {
my ($i, $first) = (0, '');
do {
$first = $manfile[$i++] || '';
} while ($first =~ /^\.\\"/ && $manfile[$i]); #");
unless ($first) {
tag 'empty-manual-page', $file;
} elsif ($first =~ /^\.so\s+(.+)?$/) {
my $dest = $1;
if ($dest =~ m,^([^/]+)/(.+)$,) {
my ($manxorlang, $rest) = ($1, $2);
if ($manxorlang !~ /^man\d+$/) {
# then it's likely a language subdir, so let's run
# the other component through the same check
if ($rest =~ m,^([^/]+)/(.+)$,) {
my ($lang, $rest) = ($1, $2);
if ($rest !~ m,^[^/]+\.\d(?:\S+)?(?:\.gz)?$,) {
tag 'bad-so-link-within-manual-page', $file;
}
} else {
tag 'bad-so-link-within-manual-page', $file;
}
}
} else {
tag 'bad-so-link-within-manual-page', $file;
}
next;
}
}
# If it's not a .so link, use lexgrog to find out if the man page
# parses correctly and make sure the short description is reasonable.
#
# This check is currently not applied to pages in language-specific
# hierarchies, because those pages are not currently scanned by
# mandb (bug #29448), and because lexgrog can't handle pages in all
# languages at the moment, leading to huge numbers of false
# negatives. When man-db is fixed, this limitation should be
# removed.
if ($path =~ m,/man/man\d/,) {
my $pid = open LEXGROG, '-|';
if (not defined $pid) {
fail("cannot run lexgrog: $!");
} elsif ($pid == 0) {
clean_env;
exec "lexgrog \Q$path\E 2>&1"
or fail("cannot run lexgrog: $!");
}
my $desc = <LEXGROG>;
$desc =~ s/^[^:]+: \"(.*)\"$/$1/;
if ($desc =~ /(\S+)\s+-\s+manual page for \1/i) {
tag 'manpage-has-useless-whatis-entry', $file;
} elsif ($desc =~ /(\S+)\s+-\s+programs? to do something/i) {
tag 'manpage-is-dh_make-template', $file;
}
1 while <LEXGROG>;
close LEXGROG;
tag 'manpage-has-bad-whatis-entry', $file if $? != 0;
}
# If it's not a .so link, run it through 'man' to check for errors.
# If it is in a directory with the standard man layout, cd to the
# parent directory before running man so that .so directives are
# processed properly. (Yes, there are man pages that include other
# pages with .so but aren't simple links; rbash, for instance.)
my $cmd;
if ($path =~ m,^(.*)/(man\d/.*)$,) {
$cmd = "cd \Q$1\E && man --warnings -E UTF-8 -l \Q$2\E";
} else {
$cmd = "man --warnings -E UTF-8 -l \Q$path\E";
}
my $pid = open MANERRS, '-|';
if (not defined $pid) {
fail("cannot run man -E UTF-8 -l: $!");
} elsif ($pid == 0) {
clean_env;
$ENV{MANWIDTH} = 80;
exec "($cmd >/dev/null) 2>&1"
or fail("cannot run man -E UTF-8 -l: $!");
}
while (<MANERRS>) {
# ignore progress information from man
next if /^Reformatting/;
next if /^\s*$/;
# ignore errors from gzip, will be dealt with at other places
next if /^(man|gzip)/;
# ignore wrapping failures for Asian man pages (groff problem)
if ($lang =~ /^(?:ja|ko|zh)/) {
next if /warning \[.*\]: cannot adjust line/;
next if /warning \[.*\]: can\'t break line/;
}
# ignore wrapping failures if they contain URLs (.UE is an
# extension for marking the end of a URL).
next if /:(\d+): warning \[.*\]: (can\'t break|cannot adjust) line/
and ( $manfile[$1 - 1] =~ m,(?:https?|ftp|file)://.+,i
or $manfile[$1 - 1] =~ m,^\s*\.\s*UE\b,);
# ignore common undefined macros from pod2man << Perl 5.10
next if /warning: (?:macro )?\`(Tr|IX)\' not defined/;
chomp;
s/^[^:]+://o;
tag 'manpage-has-errors-from-man', $file, $_;
last;
}
close(MANERRS);
# Now we search through the whole man page for some common errors
my $lc = 0;
my $hc = 0;
my $draft_mode = 0;
foreach my $line (@manfile) {
$lc++;
chomp $line;
next if $line =~ /^\.\\\"/o; # comments .\"
if ($line =~ /^\.TH\s/) { # header
my ($th_command, $th_title, $th_section, $th_date ) =
Text::ParseWords::parse_line( '\s+', 0, $line);
if ($th_section && (lc($fn_section) ne lc($th_section))) {
tag 'manpage-section-mismatch', "$file:$lc $fn_section != $th_section";
}
}
# Catch hyphens used as minus signs by looking for ones at the
# beginning of a word, but don't generate false positives on \s-1
# (small font), \*(-- (pod2man long dash), or things like \h'-1'.
# Ignoring hyphens contained in draft mode (.eo). Do catch
# hyphens after \f[C], a groff font change.
$draft_mode = 1 if $line =~ /^\.\s*eo/;
$draft_mode = 0 if $line =~ /^\.\s*ec/;
if (not $draft_mode
and $line =~ /^(
([^\.].*)?
[\s\'\"\`\(\[\]]
(?<! \\s | \*\( | \(- | \w\' )
)?
(--?\w+)/ox) {
$hc++;
tag 'hyphen-used-as-minus-sign', "$file:$lc"
if $hc <= 10 or $ENV{'LINTIAN_DEBUG'};
}
if (($line =~ m,(/usr/(dict|doc|etc|info|man|adm|preserve)/),o)
|| ($line =~ m,(/var/(adm|catman|named|nis|preserve)/),o)) {
# FSSTND dirs in man pages
# regexes taken from checks/files
tag 'FSSTND-dir-in-manual-page', "$file:$lc $1";
}
if ($line eq '.SH "POD ERRORS"') {
tag 'manpage-has-errors-from-pod2man', "$file:$lc";
}
# Check for spelling errors if the manpage is English
check_spelling('spelling-error-in-manpage', $line, $file, { $pkg => 1 })
if ($path =~ m,/man/man\d/,);
}
tag 'hyphen-used-as-minus-sign', $file, ($hc - 10),
'more occurrences not shown'
if ($hc > 10 && ! $ENV{'LINTIAN_DEBUG'});
}
}
# Check our dependencies:
foreach my $depproc (@{ $ginfo->direct_dependencies ($proc) }) {
# Find the manpages in our related dependencies
my $depinfo = $depproc->info();
foreach my $file ($depinfo->sorted_index){
next if $file eq '';
my $index_info = $depinfo->index->{$file};
my ($fname, $path, $suffix) = fileparse($file, qr,\..+$,o);
my $lang = '';
next unless ($index_info->is_file or $index_info->is_symlink) and
(($path =~ m,^usr/man/\S+,o)
or ($path =~ m,^usr/X11R6/man/\S+,o)
or ($path =~ m,^usr/share/man/\S+,o) );
next unless ($path =~ m,man\d/$,o);
$manpage{$fname} = [] unless exists $manpage{$fname};
$lang = $1 if $path =~ m,/([^/]+)/man\d/$,o;
$lang = '' if $lang eq 'man';
push @{$manpage{$fname}}, {file => $file, lang => $lang};
}
}
for my $f (sort keys %binary) {
if (exists $manpage{$f}) {
if (not grep { $_->{lang} eq '' } @{$manpage{$f}}) {
tag 'binary-without-english-manpage', "$binary{$f}";
}
} else {
tag 'binary-without-manpage', "$binary{$f}";
}
}
}
1;
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|