pod/pod2man.PL

   1 #!/usr/local/bin/perl
   2
   3 use Config;
   4 use File::Basename qw(&basename &dirname);
   5
   6 # List explicitly here the variables you want Configure to
   7 # generate.  Metaconfig only looks for shell variables, so you
   8 # have to mention them as if they were shell variables, not
   9 # %Config entries.  Thus you write
  10 #  $startperl
  11 #  $man3ext
  12 # to ensure Configure will look for $Config{startperl}.
  13
  14 # This forces PL files to create target in same directory as PL file.
  15 # This is so that make depend always knows where to find PL derivatives.
  16 chdir dirname($0);
  17 $file = basename($0, '.PL');
  18 $file .= '.com' if $^O eq 'VMS';
  19
  20 open OUT,">$file" or die "Can't create $file: $!";
  21
  22 print "Extracting $file (with variable substitutions)\n";
  23
  24 # In this section, perl variables will be expanded during extraction.
  25 # You can use $Config{...} to use Configure variables.
  26
  27 print OUT <<"!GROK!THIS!";
  28 $Config{startperl}
  29     eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
  30         if \$running_under_some_shell;
  31
  32 \$DEF_PM_SECTION = '$Config{man3ext}' || '3';
  33 !GROK!THIS!
  34
  35 # In the following, perl variables are not expanded during extraction.
  36
  37 print OUT <<'!NO!SUBS!';
  38
  39 =head1 NAME
  40
  41 pod2man - translate embedded Perl pod directives into man pages
  42
  43 =head1 SYNOPSIS
  44
  45 B<pod2man>
  46 [ B<--section=>I<manext> ]
  47 [ B<--release=>I<relpatch> ]
  48 [ B<--center=>I<string> ]
  49 [ B<--date=>I<string> ]
  50 [ B<--fixed=>I<font> ]
  51 [ B<--official> ]
  52 [ B<--lax> ]
  53 I<inputfile>
  54
  55 =head1 DESCRIPTION
  56
  57 B<pod2man> converts its input file containing embedded pod directives (see
  58 L<perlpod>) into nroff source suitable for viewing with nroff(1) or
  59 troff(1) using the man(7) macro set.
  60
  61 Besides the obvious pod conversions, B<pod2man> also takes care of
  62 func(), func(n), and simple variable references like $foo or @bar so
  63 you don't have to use code escapes for them; complex expressions like
  64 C<$fred{'stuff'}> will still need to be escaped, though.  Other nagging
  65 little roffish things that it catches include translating the minus in
  66 something like foo-bar, making a long dash--like this--into a real em
  67 dash, fixing up "paired quotes", putting a little space after the
  68 parens in something like func(), making C++ and PI look right, making
  69 double underbars have a little tiny space between them, making ALLCAPS
  70 a teeny bit smaller in troff(1), and escaping backslashes so you don't
  71 have to.
  72
  73 =head1 OPTIONS
  74
  75 =over 8
  76
  77 =item center
  78
  79 Set the centered header to a specific string.  The default is
  80 "User Contributed Perl Documentation", unless the C<--official> flag is
  81 given, in which case the default is "Perl Programmers Reference Guide".
  82
  83 =item date
  84
  85 Set the left-hand footer string to this value.  By default,
  86 the modification date of the input file will be used.
  87
  88 =item fixed
  89
  90 The fixed font to use for code refs.  Defaults to CW.
  91
  92 =item official
  93
  94 Set the default header to indicate that this page is of
  95 the standard release in case C<--center> is not given.
  96
  97 =item release
  98
  99 Set the centered footer.  By default, this is the current
 100 perl release.
 101
 102 =item section
 103
 104 Set the section for the C<.TH> macro.  The standard conventions on
 105 sections are to use 1 for user commands,  2 for system calls, 3 for
 106 functions, 4 for devices, 5 for file formats, 6 for games, 7 for
 107 miscellaneous information, and 8 for administrator commands.  This works
 108 best if you put your Perl man pages in a separate tree, like
 109 F</usr/local/perl/man/>.  By default, section 1 will be used
 110 unless the file ends in F<.pm> in which case section 3 will be selected.
 111
 112 =item lax
 113
 114 Don't complain when required sections aren't present.
 115
 116 =back
 117
 118 =head1 Anatomy of a Proper Man Page
 119
 120 For those not sure of the proper layout of a man page, here's
 121 an example of the skeleton of a proper man page.  Head of the
 122 major headers should be setout as a C<=head1> directive, and
 123 are historically written in the rather startling ALL UPPER CASE
 124 format, although this is not mandatory.
 125 Minor headers may be included using C<=head2>, and are
 126 typically in mixed case.
 127
 128 =over 10
 129
 130 =item NAME
 131
 132 Mandatory section; should be a comma-separated list of programs or
 133 functions documented by this podpage, such as:
 134
 135     foo, bar - programs to do something
 136
 137 =item SYNOPSIS
 138
 139 A short usage summary for programs and functions, which
 140 may someday be deemed mandatory.
 141
 142 =item DESCRIPTION
 143
 144 Long drawn out discussion of the program.  It's a good idea to break this
 145 up into subsections using the C<=head2> directives, like
 146
 147     =head2 A Sample Subection
 148
 149     =head2 Yet Another Sample Subection
 150
 151 =item OPTIONS
 152
 153 Some people make this separate from the description.
 154
 155 =item RETURN VALUE
 156
 157 What the program or function returns if successful.
 158
 159 =item ERRORS
 160
 161 Exceptions, return codes, exit stati, and errno settings.
 162
 163 =item EXAMPLES
 164
 165 Give some example uses of the program.
 166
 167 =item ENVIRONMENT
 168
 169 Envariables this program might care about.
 170
 171 =item FILES
 172
 173 All files used by the program.  You should probably use the FE<lt>E<gt>
 174 for these.
 175
 176 =item SEE ALSO
 177
 178 Other man pages to check out, like man(1), man(7), makewhatis(8), or catman(8).
 179
 180 =item NOTES
 181
 182 Miscellaneous commentary.
 183
 184 =item CAVEATS
 185
 186 Things to take special care with; sometimes called WARNINGS.
 187
 188 =item DIAGNOSTICS
 189
 190 All possible messages the program can print out--and
 191 what they mean.
 192
 193 =item BUGS
 194
 195 Things that are broken or just don't work quite right.
 196
 197 =item RESTRICTIONS
 198
 199 Bugs you don't plan to fix :-)
 200
 201 =item AUTHOR
 202
 203 Who wrote it (or AUTHORS if multiple).
 204
 205 =item HISTORY
 206
 207 Programs derived from other sources sometimes have this, or
 208 you might keep a modification log here.
 209
 210 =back
 211
 212 =head1 EXAMPLES
 213
 214     pod2man program > program.1
 215     pod2man some_module.pm > /usr/perl/man/man3/some_module.3
 216     pod2man --section=7 note.pod > note.7
 217
 218 =head1 DIAGNOSTICS
 219
 220 The following diagnostics are generated by B<pod2man>.  Items
 221 marked "(W)" are non-fatal, whereas the "(F)" errors will cause
 222 B<pod2man> to immediately exit with a non-zero status.
 223
 224 =over 4
 225
 226 =item bad option in paragraph %d of %s: ``%s'' should be [%s]<%s>
 227
 228 (W) If you start include an option, you should set it off
 229 as bold, italic, or code.
 230
 231 =item can't open %s: %s
 232
 233 (F) The input file wasn't available for the given reason.
 234
 235 =item Improper man page - no dash in NAME header in paragraph %d of %s
 236
 237 (W) The NAME header did not have an isolated dash in it.  This is
 238 considered important.
 239
 240 =item Invalid man page - no NAME line in %s
 241
 242 (F) You did not include a NAME header, which is essential.
 243
 244 =item roff font should be 1 or 2 chars, not `%s'  (F)
 245
 246 (F) The font specified with the C<--fixed> option was not
 247 a one- or two-digit roff font.
 248
 249 =item %s is missing required section: %s
 250
 251 (W) Required sections include NAME, DESCRIPTION, and if you're
 252 using a section starting with a 3, also a SYNOPSIS.  Actually,
 253 not having a NAME is a fatal.
 254
 255 =item Unknown escape: %s in %s
 256
 257 (W) An unknown HTML entity (probably for an 8-bit character) was given via
 258 a C<EE<lt>E<gt>> directive.  Besides amp, lt, gt, and quot, recognized
 259 entities are Aacute, aacute, Acirc, acirc, AElig, aelig, Agrave, agrave,
 260 Aring, aring, Atilde, atilde, Auml, auml, Ccedil, ccedil, Eacute, eacute,
 261 Ecirc, ecirc, Egrave, egrave, ETH, eth, Euml, euml, Iacute, iacute, Icirc,
 262 icirc, Igrave, igrave, Iuml, iuml, Ntilde, ntilde, Oacute, oacute, Ocirc,
 263 ocirc, Ograve, ograve, Oslash, oslash, Otilde, otilde, Ouml, ouml, szlig,
 264 THORN, thorn, Uacute, uacute, Ucirc, ucirc, Ugrave, ugrave, Uuml, uuml,
 265 Yacute, yacute, and yuml.
 266
 267 =item Unmatched =back
 268
 269 (W) You have a C<=back> without a corresponding C<=over>.
 270
 271 =item Unrecognized pod directive: %s
 272
 273 (W) You specified a pod directive that isn't in the known list of
 274 C<=head1>, C<=head2>, C<=item>, C<=over>, C<=back>, or C<=cut>.
 275
 276
 277 =back
 278
 279 =head1 NOTES
 280
 281 If you would like to print out a lot of man page continuously, you
 282 probably want to set the C and D registers to set contiguous page
 283 numbering and even/odd paging, at least on some versions of man(7).
 284 Settting the F register will get you some additional experimental
 285 indexing:
 286
 287     troff -man -rC1 -rD1 -rF1 perl.1 perldata.1 perlsyn.1 ...
 288
 289 The indexing merely outputs messages via C<.tm> for each
 290 major page, section, subsection, item, and any C<XE<lt>E<gt>>
 291 directives.
 292
 293
 294 =head1 RESTRICTIONS
 295
 296 None at this time.
 297
 298 =head1 BUGS
 299
 300 The =over and =back directives don't really work right.  They
 301 take absolute positions instead of offsets, don't nest well, and
 302 making people count is suboptimal in any event.
 303
 304 =head1 AUTHORS
 305
 306 Original prototype by Larry Wall, but so massively hacked over by
 307 Tom Christiansen such that Larry probably doesn't recognize it anymore.
 308
 309 =cut
 310
 311 $/ = "";
 312 $cutting = 1;
 313
 314 # We try first to get the version number from a local binary, in case we're
 315 # running an installed version of Perl to produce documentation from an
 316 # uninstalled newer version's pod files.
 317 if ($^O ne 'plan9') {
 318   ($version,$patch) =
 319     `\PATH=.:..:\$PATH; perl -v` =~ /version (\d\.\d{3})(?:_(\d{2}))?/;
 320 }
 321 # No luck; we'll just go with the running Perl's version
 322 ($version,$patch) = $] =~ /^(.{5})(\d{2})?/ unless $version;
 323 $DEF_RELEASE  = "perl $version";
 324 $DEF_RELEASE .= ", patch $patch" if $patch;
 325
 326
 327 sub makedate {
 328     my $secs = shift;
 329     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($secs);
 330     my $mname = (qw{Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec})[$mon];
 331     return "$mday/$mname/$year";
 332 }
 333
 334 use Getopt::Long;
 335
 336 $DEF_SECTION = 1;
 337 $DEF_CENTER = "User Contributed Perl Documentation";
 338 $STD_CENTER = "Perl Programmers Reference Guide";
 339 $DEF_FIXED = 'CW';
 340 $DEF_LAX = 0;
 341
 342 sub usage {
 343     warn "$0: @_\n" if @_;
 344     die <<EOF;
 345 usage: $0 [options] podpage
 346 Options are:
 347         --section=manext      (default "$DEF_SECTION")
 348         --release=relpatch    (default "$DEF_RELEASE")
 349         --center=string       (default "$DEF_CENTER")
 350         --date=string         (default "$DEF_DATE")
 351         --fixed=font          (default "$DEF_FIXED")
 352         --official            (default NOT)
 353         --lax                 (default NOT)
 354 EOF
 355 }
 356
 357 $uok = GetOptions( qw(
 358         section=s
 359         release=s
 360         center=s
 361         date=s
 362         fixed=s
 363         official
 364         lax
 365         help));
 366
 367 $DEF_DATE = makedate((stat($ARGV[0]))[9] || time());
 368
 369 usage("Usage error!") unless $uok;
 370 usage() if $opt_help;
 371 usage("Need one and only one podpage argument") unless @ARGV == 1;
 372
 373 $section = $opt_section || ($ARGV[0] =~ /\.pm$/
 374                                 ? $DEF_PM_SECTION : $DEF_SECTION);
 375 $RP = $opt_release || $DEF_RELEASE;
 376 $center = $opt_center || ($opt_official ? $STD_CENTER : $DEF_CENTER);
 377 $lax = $opt_lax || $DEF_LAX;
 378
 379 $CFont = $opt_fixed || $DEF_FIXED;
 380
 381 if (length($CFont) == 2) {
 382     $CFont_embed = "\\f($CFont";
 383 }
 384 elsif (length($CFont) == 1) {
 385     $CFont_embed = "\\f$CFont";
 386 }
 387 else {
 388     die "roff font should be 1 or 2 chars, not `$CFont_embed'";
 389 }
 390
 391 $date = $opt_date || $DEF_DATE;
 392
 393 for (qw{NAME DESCRIPTION}) {
 394 # for (qw{NAME DESCRIPTION AUTHOR}) {
 395     $wanna_see{$_}++;
 396 }
 397 $wanna_see{SYNOPSIS}++ if $section =~ /^3/;
 398
 399
 400 $name = @ARGV ? $ARGV[0] : "<STDIN>";
 401 $Filename = $name;
 402 if ($section =~ /^1/) {
 403     require File::Basename;
 404     $name = uc File::Basename::basename($name);
 405 }
 406 $name =~ s/\.(pod|p[lm])$//i;
 407
 408 # Lose everything up to the first of
 409 #     */lib/*perl*      standard or site_perl module
 410 #     */*perl*/lib      from -D prefix=/opt/perl
 411 #     */*perl*/         random module hierarchy
 412 # which works.
 413 $name =~ s-//+-/-g;
 414 if ($name =~ s-^.*?/lib/[^/]*perl[^/]*/--i
 415         or $name =~ s-^.*?/[^/]*perl[^/]*/lib/--i
 416         or $name =~ s-^.*?/[^/]*perl[^/]*/--i) {
 417     # Lose ^arch/version/.
 418     $name =~ s-^[^/]+/\d+\.\d+/--;
 419 }
 420
 421 # Translate Getopt/Long to Getopt::Long, etc.
 422 $name =~ s(/)(::)g;
 423
 424 if ($name ne 'something') {
 425     FCHECK: {
 426         open(F, "< $ARGV[0]") || die "can't open $ARGV[0]: $!";
 427         while (<F>) {
 428             next unless /^=\b/;
 429             if (/^=head1\s+NAME\s*$/) {  # an /m would forgive mistakes
 430                 $_ = <F>;
 431                 unless (/\s*-+\s+/) {
 432                     $oops++;
 433                     warn "$0: Improper man page - no dash in NAME header in paragraph $. of $ARGV[0]\n"
 434                 } else {
 435                     my @n = split /\s+-+\s+/;
 436                     if (@n != 2) {
 437                         $oops++;
 438                         warn "$0: Improper man page - malformed NAME header in paragraph $. of $ARGV[0]\n"
 439                     }
 440                     else {
 441                         %namedesc = @n;
 442                     }
 443                 }
 444                 last FCHECK;
 445             }
 446             next if /^=cut\b/;  # DB_File and Net::Ping have =cut before NAME
 447             next if /^=pod\b/;  # It is OK to have =pod before NAME
 448             die "$0: Invalid man page - 1st pod line is not NAME in $ARGV[0]\n" unless $lax;
 449         }
 450         die "$0: Invalid man page - no documentation in $ARGV[0]\n" unless $lax;
 451     }
 452     close F;
 453 }
 454
 455 print <<"END";
 456 .rn '' }`
 457 ''' \$RCSfile\$\$Revision\$\$Date\$
 458 '''
 459 ''' \$Log\$
 460 '''
 461 .de Sh
 462 .br
 463 .if t .Sp
 464 .ne 5
 465 .PP
 466 \\fB\\\\\$1\\fR
 467 .PP
 468 ..
 469 .de Sp
 470 .if t .sp .5v
 471 .if n .sp
 472 ..
 473 .de Ip
 474 .br
 475 .ie \\\\n(.\$>=3 .ne \\\\\$3
 476 .el .ne 3
 477 .IP "\\\\\$1" \\\\\$2
 478 ..
 479 .de Vb
 480 .ft $CFont
 481 .nf
 482 .ne \\\\\$1
 483 ..
 484 .de Ve
 485 .ft R
 486
 487 .fi
 488 ..
 489 '''
 490 '''
 491 '''     Set up \\*(-- to give an unbreakable dash;
 492 '''     string Tr holds user defined translation string.
 493 '''     Bell System Logo is used as a dummy character.
 494 '''
 495 .tr \\(*W-|\\(bv\\*(Tr
 496 .ie n \\{\\
 497 .ds -- \\(*W-
 498 .ds PI pi
 499 .if (\\n(.H=4u)&(1m=24u) .ds -- \\(*W\\h'-12u'\\(*W\\h'-12u'-\\" diablo 10 pitch
 500 .if (\\n(.H=4u)&(1m=20u) .ds -- \\(*W\\h'-12u'\\(*W\\h'-8u'-\\" diablo 12 pitch
 501 .ds L" ""
 502 .ds R" ""
 503 '''   \\*(M", \\*(S", \\*(N" and \\*(T" are the equivalent of
 504 '''   \\*(L" and \\*(R", except that they are used on ".xx" lines,
 505 '''   such as .IP and .SH, which do another additional levels of
 506 '''   double-quote interpretation
 507 .ds M" """
 508 .ds S" """
 509 .ds N" """""
 510 .ds T" """""
 511 .ds L' '
 512 .ds R' '
 513 .ds M' '
 514 .ds S' '
 515 .ds N' '
 516 .ds T' '
 517 'br\\}
 518 .el\\{\\
 519 .ds -- \\(em\\|
 520 .tr \\*(Tr
 521 .ds L" ``
 522 .ds R" ''
 523 .ds M" ``
 524 .ds S" ''
 525 .ds N" ``
 526 .ds T" ''
 527 .ds L' `
 528 .ds R' '
 529 .ds M' `
 530 .ds S' '
 531 .ds N' `
 532 .ds T' '
 533 .ds PI \\(*p
 534 'br\\}
 535 END
 536
 537 print <<'END';
 538 .\"     If the F register is turned on, we'll generate
 539 .\"     index entries out stderr for the following things:
 540 .\"             TH      Title
 541 .\"             SH      Header
 542 .\"             Sh      Subsection
 543 .\"             Ip      Item
 544 .\"             X<>     Xref  (embedded
 545 .\"     Of course, you have to process the output yourself
 546 .\"     in some meaninful fashion.
 547 .if \nF \{
 548 .de IX
 549 .tm Index:\\$1\t\\n%\t"\\$2"
 550 ..
 551 .nr % 0
 552 .rr F
 553 .\}
 554 END
 555
 556 print <<"END";
 557 .TH $name $section "$RP" "$date" "$center"
 558 .IX Title "$name $section"
 559 .UC
 560 END
 561
 562 while (($name, $desc) = each %namedesc) {
 563     for ($name, $desc) { s/^\s+//; s/\s+$//; }
 564     print qq(.IX Name "$name - $desc"\n);
 565 }
 566
 567 print <<'END';
 568 .if n .hy 0
 569 .if n .na
 570 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 571 .de CQ          \" put $1 in typewriter font
 572 END
 573 print ".ft $CFont\n";
 574 print <<'END';
 575 'if n "\c
 576 'if t \\&\\$1\c
 577 'if n \\&\\$1\c
 578 'if n \&"
 579 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 580 '.ft R
 581 ..
 582 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 583 .       \" AM - accent mark definitions
 584 .bd B 3
 585 .       \" fudge factors for nroff and troff
 586 .if n \{\
 587 .       ds #H 0
 588 .       ds #V .8m
 589 .       ds #F .3m
 590 .       ds #[ \f1
 591 .       ds #] \fP
 592 .\}
 593 .if t \{\
 594 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 595 .       ds #V .6m
 596 .       ds #F 0
 597 .       ds #[ \&
 598 .       ds #] \&
 599 .\}
 600 .       \" simple accents for nroff and troff
 601 .if n \{\
 602 .       ds ' \&
 603 .       ds ` \&
 604 .       ds ^ \&
 605 .       ds , \&
 606 .       ds ~ ~
 607 .       ds ? ?
 608 .       ds ! !
 609 .       ds /
 610 .       ds q
 611 .\}
 612 .if t \{\
 613 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 614 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 615 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 616 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 617 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 618 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 619 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 620 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 621 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 622 .\}
 623 .       \" troff and (daisy-wheel) nroff accents
 624 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 625 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 626 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 627 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 628 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 629 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 630 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 631 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 632 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 633 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 634 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 635 .ds ae a\h'-(\w'a'u*4/10)'e
 636 .ds Ae A\h'-(\w'A'u*4/10)'E
 637 .ds oe o\h'-(\w'o'u*4/10)'e
 638 .ds Oe O\h'-(\w'O'u*4/10)'E
 639 .       \" corrections for vroff
 640 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 641 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 642 .       \" for low resolution devices (crt and lpr)
 643 .if \n(.H>23 .if \n(.V>19 \
 644 \{\
 645 .       ds : e
 646 .       ds 8 ss
 647 .       ds v \h'-1'\o'\(aa\(ga'
 648 .       ds _ \h'-1'^
 649 .       ds . \h'-1'.
 650 .       ds 3 3
 651 .       ds o a
 652 .       ds d- d\h'-1'\(ga
 653 .       ds D- D\h'-1'\(hy
 654 .       ds th \o'bp'
 655 .       ds Th \o'LP'
 656 .       ds ae ae
 657 .       ds Ae AE
 658 .       ds oe oe
 659 .       ds Oe OE
 660 .\}
 661 .rm #[ #] #H #V #F C
 662 END
 663
 664 $indent = 0;
 665
 666 $begun = "";
 667
 668 while (<>) {
 669     if ($cutting) {
 670         next unless /^=/;
 671         $cutting = 0;
 672     }
 673     if ($begun) {
 674         if (/^=end\s+$begun/) {
 675             $begun = "";
 676         }
 677         elsif ($begun =~ /^(roff|man)$/) {
 678             print STDOUT $_;
 679         }
 680         next;
 681     }
 682     chomp;
 683
 684     # Translate verbatim paragraph
 685
 686     if (/^\s/) {
 687         @lines = split(/\n/);
 688         for (@lines) {
 689             1 while s
 690                 {^( [^\t]* ) \t ( \t* ) }
 691                 { $1 . ' ' x (8 - (length($1)%8) + 8 * (length($2))) }ex;
 692             s/\\/\\e/g;
 693             s/\A/\\&/s;
 694         }
 695         $lines = @lines;
 696         makespace() unless $verbatim++;
 697         print ".Vb $lines\n";
 698         print join("\n", @lines), "\n";
 699         print ".Ve\n";
 700         $needspace = 0;
 701         next;
 702     }
 703
 704     $verbatim = 0;
 705
 706     if (/^=for\s+(\S+)\s*/s) {
 707         if ($1 eq "man" or $1 eq "roff") {
 708             print STDOUT $',"\n\n";
 709         } else {
 710             # ignore unknown for
 711         }
 712         next;
 713     }
 714     elsif (/^=begin\s+(\S+)\s*/s) {
 715         $begun = $1;
 716         if ($1 eq "man" or $1 eq "roff") {
 717             print STDOUT $'."\n\n";
 718         }
 719         next;
 720     }
 721
 722     # check for things that'll hosed our noremap scheme; affects $_
 723     init_noremap();
 724
 725     if (!/^=item/) {
 726
 727         # trofficate backslashes; must do it before what happens below
 728         s/\\/noremap('\\e')/ge;
 729
 730 # protect leading periods and quotes against *roff
 731 # mistaking them for directives
 732 s/^(?:[A-Z]<)?[.']/\\&$&/gm;
 733
 734         # first hide the escapes in case we need to
 735         # intuit something and get it wrong due to fmting
 736
 737         s/([A-Z]<[^<>]*>)/noremap($1)/ge;
 738
 739         # func() is a reference to a perl function
 740         s{
 741             \b
 742             (
 743                 [:\w]+ \(\)
 744             )
 745         } {I<$1>}gx;
 746
 747         # func(n) is a reference to a perl function or a man page
 748         s{
 749             ([:\w]+)
 750             (
 751                 \( [^\051]+ \)
 752             )
 753         } {I<$1>\\|$2}gx;
 754
 755         # convert simple variable references
 756         s/(\s+)([\$\@%][\w:]+)(?!\()/${1}C<$2>/g;
 757
 758         if (m{ (
 759                     [\-\w]+
 760                     \(
 761                         [^\051]*?
 762                         [\@\$,]
 763                         [^\051]*?
 764                     \)
 765                 )
 766             }x && $` !~ /([LCI]<[^<>]*|-)$/ && !/^=\w/)
 767         {
 768             warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [LCI]<$1>\n";
 769             $oops++;
 770         }
 771
 772         while (/(-[a-zA-Z])\b/g && $` !~ /[\w\-]$/) {
 773             warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [CB]<$1>\n";
 774             $oops++;
 775         }
 776
 777         # put it back so we get the <> processed again;
 778         clear_noremap(0); # 0 means leave the E's
 779
 780     } else {
 781         # trofficate backslashes
 782         s/\\/noremap('\\e')/ge;
 783
 784     }
 785
 786     # need to hide E<> first; they're processed in clear_noremap
 787     s/(E<[^<>]+>)/noremap($1)/ge;
 788
 789
 790     $maxnest = 10;
 791     while ($maxnest-- && /[A-Z]</) {
 792
 793         # can't do C font here
 794         s/([BI])<([^<>]*)>/font($1) . $2 . font('R')/eg;
 795
 796         # files and filelike refs in italics
 797         s/F<([^<>]*)>/I<$1>/g;
 798
 799         # no break -- usually we want C<> for this
 800         s/S<([^<>]*)>/nobreak($1)/eg;
 801
 802         # LREF: a manpage(3f)
 803         s:L<([a-zA-Z][^\s\/]+)(\([^\)]+\))?>:the I<$1>$2 manpage:g;
 804
 805         # LREF: an =item on another manpage
 806         s{
 807             L<
 808                 ([^/]+)
 809                 /
 810                 (
 811                     [:\w]+
 812                     (\(\))?
 813                 )
 814             >
 815         } {the C<$2> entry in the I<$1> manpage}gx;
 816
 817         # LREF: an =item on this manpage
 818         s{
 819            ((?:
 820             L<
 821                 /
 822                 (
 823                     [:\w]+
 824                     (\(\))?
 825                 )
 826             >
 827             (,?\s+(and\s+)?)?
 828           )+)
 829         } { internal_lrefs($1) }gex;
 830
 831         # LREF: a =head2 (head1?), maybe on a manpage, maybe right here
 832         # the "func" can disambiguate
 833         s{
 834             L<
 835                 (?:
 836                     ([a-zA-Z]\S+?) /
 837                 )?
 838                 "?(.*?)"?
 839             >
 840         }{
 841             do {
 842                 $1      # if no $1, assume it means on this page.
 843                     ?  "the section on I<$2> in the I<$1> manpage"
 844                     :  "the section on I<$2>"
 845             }
 846         }gesx; # s in case it goes over multiple lines, so . matches \n
 847
 848         s/Z<>/\\&/g;
 849
 850         # comes last because not subject to reprocessing
 851         s/C<([^<>]*)>/noremap("${CFont_embed}${1}\\fR")/eg;
 852     }
 853
 854     if (s/^=//) {
 855         $needspace = 0;         # Assume this.
 856
 857         s/\n/ /g;
 858
 859         ($Cmd, $_) = split(' ', $_, 2);
 860
 861         $dotlevel = 1;
 862         if ($Cmd eq 'head1') {
 863            $dotlevel = 1;
 864         }
 865         elsif ($Cmd eq 'head2') {
 866            $dotlevel = 1;
 867         }
 868         elsif ($Cmd eq 'item') {
 869            $dotlevel = 2;
 870         }
 871
 872         if (defined $_) {
 873             &escapes($dotlevel);
 874             s/"/""/g;
 875         }
 876
 877         clear_noremap(1);
 878
 879         if ($Cmd eq 'cut') {
 880             $cutting = 1;
 881         }
 882         elsif ($Cmd eq 'head1') {
 883             s/\s+$//;
 884             delete $wanna_see{$_} if exists $wanna_see{$_};
 885             print qq{.SH "$_"\n};
 886             print qq{.IX Header "$_"\n};
 887         }
 888         elsif ($Cmd eq 'head2') {
 889             print qq{.Sh "$_"\n};
 890             print qq{.IX Subsection "$_"\n};
 891         }
 892         elsif ($Cmd eq 'over') {
 893             push(@indent,$indent);
 894             $indent += ($_ + 0) || 5;
 895         }
 896         elsif ($Cmd eq 'back') {
 897             $indent = pop(@indent);
 898             warn "$0: Unmatched =back in paragraph $. of $ARGV\n" unless defined $indent;
 899             $needspace = 1;
 900         }
 901         elsif ($Cmd eq 'item') {
 902             s/^\*( |$)/\\(bu$1/g;
 903             # if you know how to get ":s please do
 904             s/\\\*\(L"([^"]+?)\\\*\(R"/'$1'/g;
 905             s/\\\*\(L"([^"]+?)""/'$1'/g;
 906             s/[^"]""([^"]+?)""[^"]/'$1'/g;
 907             # here do something about the $" in perlvar?
 908             print STDOUT qq{.Ip "$_" $indent\n};
 909             print qq{.IX Item "$_"\n};
 910         }
 911         elsif ($Cmd eq 'pod') {
 912             # this is just a comment
 913         }
 914         else {
 915             warn "$0: Unrecognized pod directive in paragraph $. of $ARGV: $Cmd\n";
 916         }
 917     }
 918     else {
 919         if ($needspace) {
 920             &makespace;
 921         }
 922         &escapes(0);
 923         clear_noremap(1);
 924         print $_, "\n";
 925         $needspace = 1;
 926     }
 927 }
 928
 929 print <<"END";
 930
 931 .rn }` ''
 932 END
 933
 934 if (%wanna_see && !$lax) {
 935     @missing = keys %wanna_see;
 936     warn "$0: $Filename is missing required section"
 937         .  (@missing > 1 && "s")
 938         .  ": @missing\n";
 939     $oops++;
 940 }
 941
 942 exit;
 943 #exit ($oops != 0);
 944
 945 #########################################################################
 946
 947 sub nobreak {
 948     my $string = shift;
 949     $string =~ s/ /\\ /g;
 950     $string;
 951 }
 952
 953 sub escapes {
 954     my $indot = shift;
 955
 956     s/X<(.*?)>/mkindex($1)/ge;
 957
 958     # translate the minus in foo-bar into foo\-bar for roff
 959     s/([^0-9a-z-])-([^-])/$1\\-$2/g;
 960
 961     # make -- into the string version \*(-- (defined above)
 962     s/\b--\b/\\*(--/g;
 963     s/"--([^"])/"\\*(--$1/g;  # should be a better way
 964     s/([^"])--"/$1\\*(--"/g;
 965
 966     # fix up quotes; this is somewhat tricky
 967     my $dotmacroL = 'L';
 968     my $dotmacroR = 'R';
 969     if ( $indot == 1 ) {
 970         $dotmacroL = 'M';
 971         $dotmacroR = 'S';
 972     }
 973     elsif ( $indot >= 2 ) {
 974         $dotmacroL = 'N';
 975         $dotmacroR = 'T';
 976     }
 977     if (!/""/) {
 978         s/(^|\s)(['"])/noremap("$1\\*($dotmacroL$2")/ge;
 979         s/(['"])($|[\-\s,;\\!?.])/noremap("\\*($dotmacroR$1$2")/ge;
 980     }
 981
 982     #s/(?!")(?:.)--(?!")(?:.)/\\*(--/g;
 983     #s/(?:(?!")(?:.)--(?:"))|(?:(?:")--(?!")(?:.))/\\*(--/g;
 984
 985
 986     # make sure that func() keeps a bit a space tween the parens
 987     ### s/\b\(\)/\\|()/g;
 988     ### s/\b\(\)/(\\|)/g;
 989
 990     # make C++ into \*C+, which is a squinched version (defined above)
 991     s/\bC\+\+/\\*(C+/g;
 992
 993     # make double underbars have a little tiny space between them
 994     s/__/_\\|_/g;
 995
 996     # PI goes to \*(PI (defined above)
 997     s/\bPI\b/noremap('\\*(PI')/ge;
 998
 999     # make all caps a teeny bit smaller, but don't muck with embedded code literals
1000     my $hidCFont = font('C');
1001     if ($Cmd !~ /^head1/) { # SH already makes smaller
1002         # /g isn't enough; 1 while or we'll be off
1003
1004 #       1 while s{
1005 #           (?!$hidCFont)(..|^.|^)
1006 #           \b
1007 #           (
1008 #               [A-Z][\/A-Z+:\-\d_$.]+
1009 #           )
1010 #           (s?)
1011 #           \b
1012 #       } {$1\\s-1$2\\s0}gmox;
1013
1014         1 while s{
1015             (?!$hidCFont)(..|^.|^)
1016             (
1017                 \b[A-Z]{2,}[\/A-Z+:\-\d_\$]*\b
1018             )
1019         } {
1020             $1 . noremap( '\\s-1' .  $2 . '\\s0' )
1021         }egmox;
1022
1023     }
1024 }
1025
1026 # make troff just be normal, but make small nroff get quoted
1027 # decided to just put the quotes in the text; sigh;
1028 sub ccvt {
1029     local($_,$prev) = @_;
1030     noremap(qq{.CQ "$_" \n\\&});
1031 }
1032
1033 sub makespace {
1034     if ($indent) {
1035         print ".Sp\n";
1036     }
1037     else {
1038         print ".PP\n";
1039     }
1040 }
1041
1042 sub mkindex {
1043     my ($entry) = @_;
1044     my @entries = split m:\s*/\s*:, $entry;
1045     print ".IX Xref ";
1046     for $entry (@entries) {
1047         print qq("$entry" );
1048     }
1049     print "\n";
1050     return '';
1051 }
1052
1053 sub font {
1054     local($font) = shift;
1055     return '\\f' . noremap($font);
1056 }
1057
1058 sub noremap {
1059     local($thing_to_hide) = shift;
1060     $thing_to_hide =~ tr/\000-\177/\200-\377/;
1061     return $thing_to_hide;
1062 }
1063
1064 sub init_noremap {
1065         # escape high bit characters in input stream
1066         s/([\200-\377])/"E<".ord($1).">"/ge;
1067 }
1068
1069 sub clear_noremap {
1070     my $ready_to_print = $_[0];
1071
1072     tr/\200-\377/\000-\177/;
1073
1074     # trofficate backslashes
1075     # s/(?!\\e)(?:..|^.|^)\\/\\e/g;
1076
1077     # now for the E<>s, which have been hidden until now
1078     # otherwise the interative \w<> processing would have
1079     # been hosed by the E<gt>
1080     s {
1081             E<
1082             (
1083                 ( \d + )
1084                 | ( [A-Za-z]+ )
1085             )
1086             >
1087     } {
1088          do {
1089              defined $2
1090                 ? chr($2)
1091                 :
1092              exists $HTML_Escapes{$3}
1093                 ? do { $HTML_Escapes{$3} }
1094                 : do {
1095                     warn "$0: Unknown escape in paragraph $. of $ARGV: ``$&''\n";
1096                     "E<$1>";
1097                 }
1098          }
1099     }egx if $ready_to_print;
1100 }
1101
1102 sub internal_lrefs {
1103     local($_) = shift;
1104
1105     s{L</([^>]+)>}{$1}g;
1106     my(@items) = split( /(?:,?\s+(?:and\s+)?)/ );
1107     my $retstr = "the ";
1108     my $i;
1109     for ($i = 0; $i <= $#items; $i++) {
1110         $retstr .= "C<$items[$i]>";
1111         $retstr .= ", " if @items > 2 && $i != $#items;
1112         $retstr .= " and " if $i+2 == @items;
1113     }
1114
1115     $retstr .= " entr" . ( @items > 1  ? "ies" : "y" )
1116             .  " elsewhere in this document "; # terminal space to avoid words running together (pattern used strips terminal spaces)
1117
1118     return $retstr;
1119
1120 }
1121
1122 BEGIN {
1123 %HTML_Escapes = (
1124     'amp'       =>      '&',    #   ampersand
1125     'lt'        =>      '<',    #   left chevron, less-than
1126     'gt'        =>      '>',    #   right chevron, greater-than
1127     'quot'      =>      '"',    #   double quote
1128
1129     "Aacute"    =>      "A\\*'",        #   capital A, acute accent
1130     "aacute"    =>      "a\\*'",        #   small a, acute accent
1131     "Acirc"     =>      "A\\*^",        #   capital A, circumflex accent
1132     "acirc"     =>      "a\\*^",        #   small a, circumflex accent
1133     "AElig"     =>      '\*(AE',        #   capital AE diphthong (ligature)
1134     "aelig"     =>      '\*(ae',        #   small ae diphthong (ligature)
1135     "Agrave"    =>      "A\\*`",        #   capital A, grave accent
1136     "agrave"    =>      "A\\*`",        #   small a, grave accent
1137     "Aring"     =>      'A\\*o',        #   capital A, ring
1138     "aring"     =>      'a\\*o',        #   small a, ring
1139     "Atilde"    =>      'A\\*~',        #   capital A, tilde
1140     "atilde"    =>      'a\\*~',        #   small a, tilde
1141     "Auml"      =>      'A\\*:',        #   capital A, dieresis or umlaut mark
1142     "auml"      =>      'a\\*:',        #   small a, dieresis or umlaut mark
1143     "Ccedil"    =>      'C\\*,',        #   capital C, cedilla
1144     "ccedil"    =>      'c\\*,',        #   small c, cedilla
1145     "Eacute"    =>      "E\\*'",        #   capital E, acute accent
1146     "eacute"    =>      "e\\*'",        #   small e, acute accent
1147     "Ecirc"     =>      "E\\*^",        #   capital E, circumflex accent
1148     "ecirc"     =>      "e\\*^",        #   small e, circumflex accent
1149     "Egrave"    =>      "E\\*`",        #   capital E, grave accent
1150     "egrave"    =>      "e\\*`",        #   small e, grave accent
1151     "ETH"       =>      '\\*(D-',       #   capital Eth, Icelandic
1152     "eth"       =>      '\\*(d-',       #   small eth, Icelandic
1153     "Euml"      =>      "E\\*:",        #   capital E, dieresis or umlaut mark
1154     "euml"      =>      "e\\*:",        #   small e, dieresis or umlaut mark
1155     "Iacute"    =>      "I\\*'",        #   capital I, acute accent
1156     "iacute"    =>      "i\\*'",        #   small i, acute accent
1157     "Icirc"     =>      "I\\*^",        #   capital I, circumflex accent
1158     "icirc"     =>      "i\\*^",        #   small i, circumflex accent
1159     "Igrave"    =>      "I\\*`",        #   capital I, grave accent
1160     "igrave"    =>      "i\\*`",        #   small i, grave accent
1161     "Iuml"      =>      "I\\*:",        #   capital I, dieresis or umlaut mark
1162     "iuml"      =>      "i\\*:",        #   small i, dieresis or umlaut mark
1163     "Ntilde"    =>      'N\*~',         #   capital N, tilde
1164     "ntilde"    =>      'n\*~',         #   small n, tilde
1165     "Oacute"    =>      "O\\*'",        #   capital O, acute accent
1166     "oacute"    =>      "o\\*'",        #   small o, acute accent
1167     "Ocirc"     =>      "O\\*^",        #   capital O, circumflex accent
1168     "ocirc"     =>      "o\\*^",        #   small o, circumflex accent
1169     "Ograve"    =>      "O\\*`",        #   capital O, grave accent
1170     "ograve"    =>      "o\\*`",        #   small o, grave accent
1171     "Oslash"    =>      "O\\*/",        #   capital O, slash
1172     "oslash"    =>      "o\\*/",        #   small o, slash
1173     "Otilde"    =>      "O\\*~",        #   capital O, tilde
1174     "otilde"    =>      "o\\*~",        #   small o, tilde
1175     "Ouml"      =>      "O\\*:",        #   capital O, dieresis or umlaut mark
1176     "ouml"      =>      "o\\*:",        #   small o, dieresis or umlaut mark
1177     "szlig"     =>      '\*8',          #   small sharp s, German (sz ligature)
1178     "THORN"     =>      '\\*(Th',       #   capital THORN, Icelandic
1179     "thorn"     =>      '\\*(th',,      #   small thorn, Icelandic
1180     "Uacute"    =>      "U\\*'",        #   capital U, acute accent
1181     "uacute"    =>      "u\\*'",        #   small u, acute accent
1182     "Ucirc"     =>      "U\\*^",        #   capital U, circumflex accent
1183     "ucirc"     =>      "u\\*^",        #   small u, circumflex accent
1184     "Ugrave"    =>      "U\\*`",        #   capital U, grave accent
1185     "ugrave"    =>      "u\\*`",        #   small u, grave accent
1186     "Uuml"      =>      "U\\*:",        #   capital U, dieresis or umlaut mark
1187     "uuml"      =>      "u\\*:",        #   small u, dieresis or umlaut mark
1188     "Yacute"    =>      "Y\\*'",        #   capital Y, acute accent
1189     "yacute"    =>      "y\\*'",        #   small y, acute accent
1190     "yuml"      =>      "y\\*:",        #   small y, dieresis or umlaut mark
1191 );
1192 }
1193
1194 !NO!SUBS!
1195
1196 close OUT or die "Can't close $file: $!";
1197 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1198 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';