man-page-html-generation-hack-20080713
authorRuss Allbery <rra@stanford.edu>
Mon, 14 Jul 2008 02:45:14 +0000 (02:45 +0000)
committerRuss Allbery <rra@stanford.edu>
Mon, 14 Jul 2008 02:45:14 +0000 (02:45 +0000)
LICENSE BSD

Pod::Simple::Search ignores every POD file that doesn't "look right," which
means it skips files containing a period (like krb.conf.pod) unless you set
a search option.  Pod::Simple::HTMLBatch has no way to set search options.

Apply a truly horrible hack to get around this.

doc/man-pages/generate-html

index 9bde41b..610a7db 100755 (executable)
@@ -59,6 +59,24 @@ $Pod::Simple::HTML::Tagmap{'/item-bullet'} = '</p></li>';
 $Pod::Simple::HTML::Tagmap{'item-number'} = '<li><p>';
 $Pod::Simple::HTML::Tagmap{'/item-number'} = '</p></li>';
 
+# This horrific hack is required because Pod::Simple::HTMLBatch has no way
+# of setting search options and we have to set laborious to true in order
+# to pick up man pages like krb.conf(5).
+package OpenAFS::Search;
+
+use strict;
+use vars qw(@ISA);
+
+use Pod::Simple::Search;
+@ISA = qw(Pod::Simple::HTML);
+
+sub new {
+    my $class = shift;
+    my $object = Pod::Simple::Search->new;
+    $object->laborious (1);
+    return $object;
+}
+
 package main;
 
 use strict;
@@ -66,6 +84,9 @@ use strict;
 use File::Copy;
 use Pod::Simple::HTMLBatch;
 
+# Override the search class to set laborious.
+$Pod::Simple::HTMLBatch::SEARCH_CLASS = 'OpenAFS::Search';
+
 our $HEADER = <<'EOH';
 <html>
 <head>