444 lines
11 KiB
Perl
444 lines
11 KiB
Perl
#!/usr/bin/perl
|
|
#
|
|
# Copyright (c) March 1995 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions
|
|
# are met:
|
|
# 1. Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# 2. Redistributions in binary form must reproduce the above copyright
|
|
# notice, this list of conditions and the following disclaimer in the
|
|
# documentation and/or other materials provided with the distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
# SUCH DAMAGE.
|
|
#
|
|
# /usr/bin/catman - preformat man pages
|
|
#
|
|
# $FreeBSD$
|
|
|
|
|
|
sub usage {
|
|
|
|
warn <<EOF;
|
|
usage: catman [-f|-force] [-h|-help] [-L|-locale] [-p|-print] [-r|remove]
|
|
[-v|-verbose] [directories ...]
|
|
EOF
|
|
|
|
exit 1;
|
|
}
|
|
|
|
sub variables {
|
|
$force = 0; # force overwriting existing catpages
|
|
$verbose = 0; # more warnings
|
|
$print = 0; # show only, do nothing
|
|
$remove = 0; # unlink forgotten man/catpages
|
|
$locale = 0; # go through localized man directories only
|
|
|
|
# choose localized man directories suffix. If $LC_CTYPE is set, then
|
|
# its value should be used as suffix, otherwise $LANG (if set)
|
|
$local_suffix = "";
|
|
if ($ENV{'LC_CTYPE'}) {
|
|
$local_suffix = $ENV{'LC_CTYPE'}
|
|
} elsif ($ENV{'LANG'}) {
|
|
$local_suffix = $ENV{'LANG'}
|
|
}
|
|
|
|
# if no argument for directories given
|
|
@defaultmanpath = ( '/usr/share/man' );
|
|
|
|
$exit = 0; # exit code
|
|
$ext = ".gz"; # extension
|
|
umask(022);
|
|
|
|
# Signals
|
|
$SIG{'INT'} = 'Exit';
|
|
$SIG{'HUP'} = 'Exit';
|
|
$SIG{'TRAP'} = 'Exit';
|
|
$SIG{'QUIT'} = 'Exit';
|
|
$SIG{'TERM'} = 'Exit';
|
|
$tmp = ''; # tmp file
|
|
|
|
$ENV{'PATH'} = '/bin:/usr/bin';
|
|
}
|
|
|
|
sub Exit {
|
|
unlink($tmp) if $tmp ne ""; # unlink if a filename
|
|
die "$0: die on signal SIG@_\n";
|
|
}
|
|
|
|
sub parse {
|
|
local(@argv) = @_;
|
|
|
|
while($_ = $argv[0], /^-/) {
|
|
shift @argv;
|
|
last if /^--$/;
|
|
if (/^--?(f|force)$/) { $force = 1 }
|
|
elsif (/^--?(p|print)$/) { $print = 1 }
|
|
elsif (/^--?(r|remove)$/) { $remove = 1 }
|
|
elsif (/^--?(v|verbose)$/) { $verbose = 1 }
|
|
elsif (/^--?(L|locale)$/) { $locale = 1 }
|
|
else { &usage }
|
|
}
|
|
warn "Localized man directory suffix is $local_suffix\n"
|
|
if $verbose && $locale;
|
|
|
|
return &absolute_path(@argv) if $#argv >= 0;
|
|
return @defaultmanpath if $#defaultmanpath >= 0;
|
|
|
|
warn "Missing directories\n"; &usage;
|
|
}
|
|
|
|
# make relative path to absolute path
|
|
sub absolute_path {
|
|
local(@dirlist) = @_;
|
|
local($pwd, $dir, @a);
|
|
|
|
$pwd = $ENV{'PWD'};
|
|
|
|
foreach $dir (@dirlist) {
|
|
if ($dir !~ "^/") {
|
|
chop($pwd = `pwd`) if (!$pwd || $pwd !~ /^\//);
|
|
push(@a, "$pwd/$dir");
|
|
} else {
|
|
push(@a, $dir);
|
|
}
|
|
}
|
|
return @a;
|
|
}
|
|
|
|
# strip unused '/'
|
|
# e.g.: //usr///home// -> /usr/home
|
|
sub stripdir {
|
|
local($dir) = @_;
|
|
|
|
$dir =~ s|/+|/|g; # delete double '/'
|
|
$dir =~ s|/$||; # delete '/' at end
|
|
$dir =~ s|/(\.\/)+|/|g; # delete ././././
|
|
|
|
$dir =~ s|/+|/|g; # delete double '/'
|
|
$dir =~ s|/$||; # delete '/' at end
|
|
$dir =~ s|/\.$||; # delete /. at end
|
|
return $dir if $dir ne "";
|
|
return '/';
|
|
}
|
|
|
|
# read man directory
|
|
sub parse_dir {
|
|
local($dir) = @_;
|
|
local($subdir, $catdir);
|
|
local($dev,$ino) = (stat($dir))[01];
|
|
|
|
# already visit
|
|
if ($dir_visit{$dev,$ino}) {
|
|
warn "$dir already parsed: $dir_visit{$dev,$ino}\n";
|
|
return 1;
|
|
}
|
|
$dir_visit{$dev,$ino} = $dir;
|
|
|
|
# Manpath, /usr/local/man or
|
|
# localized manpath /usr/local/man/{$LC_CTYPE|$LANG}
|
|
if (($dir =~ /man$/) ||
|
|
(($locale) && ($dir =~ /man/) && ($dir =~ $local_suffix))) {
|
|
warn "open manpath directory ``$dir''\n" if $verbose;
|
|
if (!opendir(DIR, $dir)) {
|
|
warn "opendir ``$dir'':$!\n"; $exit = 1; return 0;
|
|
}
|
|
|
|
warn "chdir to: $dir\n" if $verbose;
|
|
chdir($dir) || do { warn "$dir: $!\n"; $exit = 1; return 0 };
|
|
|
|
foreach $subdir (sort(readdir(DIR))) {
|
|
if ($subdir =~ /^man\w+$/) {
|
|
$subdir = "$dir/$subdir";
|
|
&catdir_create($subdir) && &parse_subdir($subdir);
|
|
}
|
|
}
|
|
closedir DIR
|
|
|
|
# subdir, /usr/local/man/man1
|
|
} elsif ($dir =~ /man\w+$/) {
|
|
local($parentdir) = $dir;
|
|
$parentdir =~ s|/[^/]+$||;
|
|
warn "chdir to: $parentdir\n" if $verbose;
|
|
chdir($parentdir) || do {
|
|
warn "$parentdir: $!\n"; $exit = 1; return 0 };
|
|
|
|
&catdir_create($dir) && &parse_subdir($dir);
|
|
} else {
|
|
warn "Assume ``$dir'' is not a man directory.\n";
|
|
$exit = 1;
|
|
}
|
|
}
|
|
|
|
# create cat subdirectory if neccessary
|
|
# e.g.: man9 exist, but cat9 not
|
|
sub catdir_create {
|
|
local($subdir) = @_;
|
|
local($catdir) = $subdir;
|
|
|
|
$catdir = &man2cat($subdir);
|
|
if (-d $catdir) {
|
|
return 1 if -w _;
|
|
if (!chmod(0755, $catdir)) {
|
|
warn "Cannot write $catdir, chmod: $!\n";
|
|
$exit = 1;
|
|
return 0;
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
warn "mkdir ``$catdir''\n" if $verbose || $print;
|
|
unless ($print) {
|
|
unlink($catdir); # be paranoid
|
|
if (!mkdir($catdir, 0755)) {
|
|
warn "Cannot make $catdir: $!\n";
|
|
$exit = 1;
|
|
return 0;
|
|
}
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
# I: /usr/share/man/man9
|
|
# O: /usr/share/man/cat9
|
|
sub man2cat {
|
|
local($man) = @_;
|
|
|
|
$man =~ s/man(\w+)$/cat$1/;
|
|
return $man;
|
|
}
|
|
|
|
sub parse_subdir {
|
|
local($subdir) = @_;
|
|
local($file, $f, $catdir, $catdir_short, $mandir, $mandir_short);
|
|
local($mtime_man, $mtime_cat);
|
|
local(%read);
|
|
|
|
$mandir = $subdir;
|
|
$catdir = &man2cat($mandir);
|
|
|
|
($mandir_short = $mandir) =~ s|.*/(.*)|$1|;
|
|
($catdir_short = $catdir) =~ s|.*/(.*)|$1|;
|
|
|
|
warn "open man directory: ``$mandir''\n" if $verbose;
|
|
if (!opendir(D, $mandir)) {
|
|
warn "opendir ``$mandir'': $!\n"; $exit = 1; return 0;
|
|
}
|
|
|
|
foreach $file (readdir(D)) {
|
|
# skip current and parent directory
|
|
next if $file eq "." || $file eq "..";
|
|
|
|
# fo_09-o.bar0
|
|
if ($file !~ /^[\w\-\+\[\.:]+\.\w+$/) {
|
|
&garbage("$mandir/$file", "Assume garbage")
|
|
unless -d "$mandir/$file";
|
|
next;
|
|
}
|
|
|
|
if ($file !~ /\.gz$/) {
|
|
if (-e "$mandir/$file.gz") {
|
|
&garbage("$mandir/$file",
|
|
"Manpage unused, see compressed version");
|
|
next;
|
|
}
|
|
warn "$mandir/$file is uncompressed\n" if $verbose;
|
|
$cfile = "$file.gz";
|
|
} else {
|
|
$cfile = "$file";
|
|
}
|
|
|
|
if (!(($mtime_man = ((stat("$mandir_short/$file"))[9])) && -r _ && -f _)) {
|
|
if (! -d _) {
|
|
warn "Cannot read file: ``$mandir/$file''\n";
|
|
$exit = 1;
|
|
if ($remove && -l "$mandir/$file") {
|
|
&garbage("$mandir/$file", "Assume wrong symlink");
|
|
}
|
|
next;
|
|
}
|
|
warn "Ignore subsubdirectory: ``$mandir/$file''\n"
|
|
if $verbose;
|
|
next;
|
|
}
|
|
|
|
$read{$file} = 1;
|
|
|
|
# Assume catpages always compressed
|
|
if (($mtime_cat = ((stat("$catdir_short/$cfile"))[9]))
|
|
&& -r _ && -f _) {
|
|
if ($mtime_man > $mtime_cat || $force) {
|
|
&nroff("$mandir/$file", "$catdir/$cfile");
|
|
} else {
|
|
warn "up to date: $mandir/$file\n" if $verbose;
|
|
#print STDERR "." if $verbose;
|
|
}
|
|
} else {
|
|
&nroff("$mandir/$file", "$catdir/$cfile");
|
|
}
|
|
}
|
|
closedir D;
|
|
|
|
if (!opendir(D, $catdir)) {
|
|
warn "opendir ``$catdir'': $!\n"; return 0;
|
|
}
|
|
|
|
warn "open cat directory: ``$catdir''\n" if $verbose;
|
|
foreach $file (readdir(D)) {
|
|
next if $file =~ /^(\.|\.\.)$/; # skip current and parent directory
|
|
|
|
if ($file !~ /^[\w\-\+\[\.:]+\.\w+$/) {
|
|
&garbage("$catdir/$file", "Assume garbage")
|
|
unless -d "$catdir/$file";
|
|
next;
|
|
}
|
|
|
|
if ($file !~ /\.gz$/ && $read{"$file.gz"}) {
|
|
&garbage("$catdir/$file",
|
|
"Catpage unused, see compressed version");
|
|
} elsif (!$read{$file}) {
|
|
# maybe a bug in man(1)
|
|
# if both manpage and catpage are uncompressed, man reformats
|
|
# the manpage and puts a compressed catpage to the
|
|
# already existing uncompressed catpage
|
|
($f = $file) =~ s/\.gz$//;
|
|
|
|
# man page is uncompressed, catpage is compressed
|
|
next if $read{$f};
|
|
&garbage("$catdir/$file", "Catpage without manpage");
|
|
}
|
|
}
|
|
closedir D;
|
|
}
|
|
|
|
sub garbage {
|
|
local($file, @text) = @_;
|
|
|
|
warn "@text: ``$file''\n";
|
|
if ($remove) {
|
|
warn "unlink $file\n";
|
|
unless ($print) {
|
|
unlink($file) || warn "unlink $file: $!\n" ;
|
|
}
|
|
}
|
|
}
|
|
|
|
sub nroff {
|
|
local($man,$cat) = @_;
|
|
local($nroff) = "nroff -T" . $dev_name . " -man | col";
|
|
local($dev, $ino) = (stat($man))[01];
|
|
|
|
# It's a link
|
|
if ($link{"$dev.$ino"}) {
|
|
warn "Link: $link{\"$dev.$ino\"} -> $cat\n" if $verbose || $print;
|
|
|
|
return if $print; # done
|
|
unlink($cat); # remove possible old link
|
|
|
|
unless (link($link{"$dev.$ino"}, $cat)) {
|
|
warn "Link $cat: $!\n";
|
|
$exit = 1;
|
|
}
|
|
return;
|
|
} else {
|
|
$cat = "$cat$ext" if $cat !~ /$ext$/;
|
|
warn "Format: $man -> $cat\n" if $verbose || $print;
|
|
|
|
unless($print) {
|
|
# man page is compressed
|
|
if ($man =~ /$ext$/) {
|
|
$nroff = "zcat $man | tbl | $nroff";
|
|
} else {
|
|
$nroff = "tbl $man | $nroff";
|
|
}
|
|
|
|
# start formatting
|
|
$tmp = "$cat.$tmp"; # for cleanup after signals
|
|
system("$nroff | gzip > $cat.tmp");
|
|
if ($?) {
|
|
# assume a fatal signal to nroff
|
|
&Exit("INT to system() function") if ($? == 2);
|
|
} else {
|
|
rename("$cat.tmp", $cat);
|
|
}
|
|
}
|
|
}
|
|
|
|
# dev/ino from manpage, path from catpage
|
|
$link{"$dev.$ino"} = $cat;
|
|
}
|
|
|
|
# Set correct [gn]roff output device name ([ng]roff's "-T" option)
|
|
sub nroff_device {
|
|
# Choose default output device name.
|
|
$dev_name = "ascii";
|
|
|
|
if ($locale) {
|
|
# Use "nroff -Tkoi8-r -man" to format russian manpages (if catman "-L"
|
|
# option specified only).
|
|
if ($local_suffix =~ '\.KOI8-R$') {
|
|
$dev_name = "koi8-r";
|
|
}
|
|
# Use "nroff -Tlatin1 -man" to format ISO 8859-1 manpages
|
|
elsif ($local_suffix =~ '\.ISO_8859-1$') {
|
|
$dev_name = "latin1";
|
|
}
|
|
}
|
|
warn "nroff output device name is $dev_name\n" if $verbose;
|
|
}
|
|
|
|
# process directory
|
|
sub process_dir {
|
|
local($dir) = @_;
|
|
|
|
if (-e $dir && -d _ && -r _ && -x _) {
|
|
warn "``$dir'' is not writable for you,\n" .
|
|
"can only write to existing cat subdirs (if any)\n"
|
|
if ! -w _ && $verbose;
|
|
&parse_dir(&stripdir($dir));
|
|
} else {
|
|
warn "``$dir'' is not a directory or not read-/searchable for you\n";
|
|
$exit = 1;
|
|
}
|
|
}
|
|
|
|
# convert locale name to short notation (ru_RU.KOI8-R -> ru.KOI8-R)
|
|
sub short_locale_name {
|
|
local($lname) = @_;
|
|
|
|
$lname =~ s|_[A-Z][A-Z]||;
|
|
warn "short locale name is $lname\n" if $verbose && $locale;
|
|
}
|
|
|
|
#############
|
|
# main
|
|
warn "Don't start this program as root, use:\n" .
|
|
"echo $0 @ARGV | nice -5 su -m man\n" unless $>;
|
|
|
|
&variables;
|
|
@argv = &parse(split(/[ :]/, join($", @ARGV)));
|
|
&nroff_device;
|
|
foreach $dir (@argv) {
|
|
if ($locale) {
|
|
if ($local_suffix ne "") {
|
|
&process_dir($dir.'/'.$local_suffix);
|
|
&process_dir($dir.'/'.&short_locale_name($local_suffix));
|
|
}
|
|
} else {
|
|
&process_dir($dir);
|
|
}
|
|
}
|
|
exit($exit);
|