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 $name =~ s(/)(::)g; # translate Getopt/Long to Getopt::Long, etc.
 408
 409 if ($name ne 'something') {
 410     FCHECK: {
 411         open(F, "< $ARGV[0]") || die "can't open $ARGV[0]: $!";
 412         while (<F>) {
 413             next unless /^=\b/;
 414             if (/^=head1\s+NAME\s*$/) {  # an /m would forgive mistakes
 415                 $_ = <F>;
 416                 unless (/\s*-+\s+/) {
 417                     $oops++;
 418                     warn "$0: Improper man page - no dash in NAME header in paragraph $. of $ARGV[0]\n"
 419                   } else {
 420                     %namedesc = split /\s+-+\s+/;
 421                   }
 422                 last FCHECK;
 423             }
 424             next if /^=cut\b/;  # DB_File and Net::Ping have =cut before NAME
 425             die "$0: Invalid man page - 1st pod line is not NAME in $ARGV[0]\n" unless $lax;
 426         }
 427         die "$0: Invalid man page - no documentation in $ARGV[0]\n" unless $lax;
 428     }
 429     close F;
 430 }
 431
 432 print <<"END";
 433 .rn '' }`
 434 ''' \$RCSfile\$\$Revision\$\$Date\$
 435 '''
 436 ''' \$Log\$
 437 '''
 438 .de Sh
 439 .br
 440 .if t .Sp
 441 .ne 5
 442 .PP
 443 \\fB\\\\\$1\\fR
 444 .PP
 445 ..
 446 .de Sp
 447 .if t .sp .5v
 448 .if n .sp
 449 ..
 450 .de Ip
 451 .br
 452 .ie \\\\n(.\$>=3 .ne \\\\\$3
 453 .el .ne 3
 454 .IP "\\\\\$1" \\\\\$2
 455 ..
 456 .de Vb
 457 .ft $CFont
 458 .nf
 459 .ne \\\\\$1
 460 ..
 461 .de Ve
 462 .ft R
 463
 464 .fi
 465 ..
 466 '''
 467 '''
 468 '''     Set up \\*(-- to give an unbreakable dash;
 469 '''     string Tr holds user defined translation string.
 470 '''     Bell System Logo is used as a dummy character.
 471 '''
 472 .tr \\(*W-|\\(bv\\*(Tr
 473 .ie n \\{\\
 474 .ds -- \\(*W-
 475 .ds PI pi
 476 .if (\\n(.H=4u)&(1m=24u) .ds -- \\(*W\\h'-12u'\\(*W\\h'-12u'-\\" diablo 10 pitch
 477 .if (\\n(.H=4u)&(1m=20u) .ds -- \\(*W\\h'-12u'\\(*W\\h'-8u'-\\" diablo 12 pitch
 478 .ds L" ""
 479 .ds R" ""
 480 .ds L' '
 481 .ds R' '
 482 'br\\}
 483 .el\\{\\
 484 .ds -- \\(em\\|
 485 .tr \\*(Tr
 486 .ds L" ``
 487 .ds R" ''
 488 .ds L' `
 489 .ds R' '
 490 .ds PI \\(*p
 491 'br\\}
 492 END
 493
 494 print <<'END';
 495 .\"     If the F register is turned on, we'll generate
 496 .\"     index entries out stderr for the following things:
 497 .\"             TH      Title
 498 .\"             SH      Header
 499 .\"             Sh      Subsection
 500 .\"             Ip      Item
 501 .\"             X<>     Xref  (embedded
 502 .\"     Of course, you have to process the output yourself
 503 .\"     in some meaninful fashion.
 504 .if \nF \{
 505 .de IX
 506 .tm Index:\\$1\t\\n%\t"\\$2"
 507 ..
 508 .nr % 0
 509 .rr F
 510 .\}
 511 END
 512
 513 print <<"END";
 514 .TH $name $section "$RP" "$date" "$center"
 515 .IX Title "$name $section"
 516 .UC
 517 END
 518
 519 while (($name, $desc) = each %namedesc) {
 520     for ($name, $desc) { s/^\s+//; s/\s+$//; }
 521     print qq(.IX Name "$name - $desc"\n);
 522 }
 523
 524 print <<'END';
 525 .if n .hy 0
 526 .if n .na
 527 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 528 .de CQ          \" put $1 in typewriter font
 529 END
 530 print ".ft $CFont\n";
 531 print <<'END';
 532 'if n "\c
 533 'if t \\&\\$1\c
 534 'if n \\&\\$1\c
 535 'if n \&"
 536 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 537 '.ft R
 538 ..
 539 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 540 .       \" AM - accent mark definitions
 541 .bd B 3
 542 .       \" fudge factors for nroff and troff
 543 .if n \{\
 544 .       ds #H 0
 545 .       ds #V .8m
 546 .       ds #F .3m
 547 .       ds #[ \f1
 548 .       ds #] \fP
 549 .\}
 550 .if t \{\
 551 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 552 .       ds #V .6m
 553 .       ds #F 0
 554 .       ds #[ \&
 555 .       ds #] \&
 556 .\}
 557 .       \" simple accents for nroff and troff
 558 .if n \{\
 559 .       ds ' \&
 560 .       ds ` \&
 561 .       ds ^ \&
 562 .       ds , \&
 563 .       ds ~ ~
 564 .       ds ? ?
 565 .       ds ! !
 566 .       ds /
 567 .       ds q
 568 .\}
 569 .if t \{\
 570 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 571 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 572 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 573 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 574 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 575 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 576 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 577 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 578 .       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'
 579 .\}
 580 .       \" troff and (daisy-wheel) nroff accents
 581 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 582 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 583 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 584 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 585 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 586 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 587 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 588 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 589 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 590 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 591 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 592 .ds ae a\h'-(\w'a'u*4/10)'e
 593 .ds Ae A\h'-(\w'A'u*4/10)'E
 594 .ds oe o\h'-(\w'o'u*4/10)'e
 595 .ds Oe O\h'-(\w'O'u*4/10)'E
 596 .       \" corrections for vroff
 597 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 598 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 599 .       \" for low resolution devices (crt and lpr)
 600 .if \n(.H>23 .if \n(.V>19 \
 601 \{\
 602 .       ds : e
 603 .       ds 8 ss
 604 .       ds v \h'-1'\o'\(aa\(ga'
 605 .       ds _ \h'-1'^
 606 .       ds . \h'-1'.
 607 .       ds 3 3
 608 .       ds o a
 609 .       ds d- d\h'-1'\(ga
 610 .       ds D- D\h'-1'\(hy
 611 .       ds th \o'bp'
 612 .       ds Th \o'LP'
 613 .       ds ae ae
 614 .       ds Ae AE
 615 .       ds oe oe
 616 .       ds Oe OE
 617 .\}
 618 .rm #[ #] #H #V #F C
 619 END
 620
 621 $indent = 0;
 622
 623 $begun = "";
 624
 625 while (<>) {
 626     if ($cutting) {
 627         next unless /^=/;
 628         $cutting = 0;
 629     }
 630     if ($begun) {
 631         if (/^=end\s+$begun/) {
 632             $begun = "";
 633         }
 634         elsif ($begun =~ /^(roff|man)$/) {
 635             print STDOUT $_;
 636         }
 637         next;
 638     }
 639     chomp;
 640
 641     # Translate verbatim paragraph
 642
 643     if (/^\s/) {
 644         @lines = split(/\n/);
 645         for (@lines) {
 646             1 while s
 647                 {^( [^\t]* ) \t ( \t* ) }
 648                 { $1 . ' ' x (8 - (length($1)%8) + 8 * (length($2))) }ex;
 649             s/\\/\\e/g;
 650             s/\A/\\&/s;
 651         }
 652         $lines = @lines;
 653         makespace() unless $verbatim++;
 654         print ".Vb $lines\n";
 655         print join("\n", @lines), "\n";
 656         print ".Ve\n";
 657         $needspace = 0;
 658         next;
 659     }
 660
 661     $verbatim = 0;
 662
 663     if (/^=for\s+(\S+)\s*/s) {
 664         if ($1 eq "man" or $1 eq "roff") {
 665             print STDOUT $',"\n\n";
 666         } else {
 667             # ignore unknown for
 668         }
 669         next;
 670     }
 671     elsif (/^=begin\s+(\S+)\s*/s) {
 672         $begun = $1;
 673         if ($1 eq "man" or $1 eq "roff") {
 674             print STDOUT $'."\n\n";
 675         }
 676         next;
 677     }
 678
 679     # check for things that'll hosed our noremap scheme; affects $_
 680     init_noremap();
 681
 682     if (!/^=item/) {
 683
 684         # trofficate backslashes; must do it before what happens below
 685         s/\\/noremap('\\e')/ge;
 686
 687         # first hide the escapes in case we need to
 688         # intuit something and get it wrong due to fmting
 689
 690         s/([A-Z]<[^<>]*>)/noremap($1)/ge;
 691
 692         # func() is a reference to a perl function
 693         s{
 694             \b
 695             (
 696                 [:\w]+ \(\)
 697             )
 698         } {I<$1>}gx;
 699
 700         # func(n) is a reference to a perl function or a man page
 701         s{
 702             ([:\w]+)
 703             (
 704                 \( [^\051]+ \)
 705             )
 706         } {I<$1>\\|$2}gx;
 707
 708         # convert simple variable references
 709         s/(\s+)([\$\@%][\w:]+)(?!\()/${1}C<$2>/g;
 710
 711         if (m{ (
 712                     [\-\w]+
 713                     \(
 714                         [^\051]*?
 715                         [\@\$,]
 716                         [^\051]*?
 717                     \)
 718                 )
 719             }x && $` !~ /([LCI]<[^<>]*|-)$/ && !/^=\w/)
 720         {
 721             warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [LCI]<$1>\n";
 722             $oops++;
 723         }
 724
 725         while (/(-[a-zA-Z])\b/g && $` !~ /[\w\-]$/) {
 726             warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [CB]<$1>\n";
 727             $oops++;
 728         }
 729
 730         # put it back so we get the <> processed again;
 731         clear_noremap(0); # 0 means leave the E's
 732
 733     } else {
 734         # trofficate backslashes
 735         s/\\/noremap('\\e')/ge;
 736
 737     }
 738
 739     # need to hide E<> first; they're processed in clear_noremap
 740     s/(E<[^<>]+>)/noremap($1)/ge;
 741
 742
 743     $maxnest = 10;
 744     while ($maxnest-- && /[A-Z]</) {
 745
 746         # can't do C font here
 747         s/([BI])<([^<>]*)>/font($1) . $2 . font('R')/eg;
 748
 749         # files and filelike refs in italics
 750         s/F<([^<>]*)>/I<$1>/g;
 751
 752         # no break -- usually we want C<> for this
 753         s/S<([^<>]*)>/nobreak($1)/eg;
 754
 755         # LREF: a manpage(3f)
 756         s:L<([a-zA-Z][^\s\/]+)(\([^\)]+\))?>:the I<$1>$2 manpage:g;
 757
 758         # LREF: an =item on another manpage
 759         s{
 760             L<
 761                 ([^/]+)
 762                 /
 763                 (
 764                     [:\w]+
 765                     (\(\))?
 766                 )
 767             >
 768         } {the C<$2> entry in the I<$1> manpage}gx;
 769
 770         # LREF: an =item on this manpage
 771         s{
 772            ((?:
 773             L<
 774                 /
 775                 (
 776                     [:\w]+
 777                     (\(\))?
 778                 )
 779             >
 780             (,?\s+(and\s+)?)?
 781           )+)
 782         } { internal_lrefs($1) }gex;
 783
 784         # LREF: a =head2 (head1?), maybe on a manpage, maybe right here
 785         # the "func" can disambiguate
 786         s{
 787             L<
 788                 (?:
 789                     ([a-zA-Z]\S+?) /
 790                 )?
 791                 "?(.*?)"?
 792             >
 793         }{
 794             do {
 795                 $1      # if no $1, assume it means on this page.
 796                     ?  "the section on I<$2> in the I<$1> manpage"
 797                     :  "the section on I<$2>"
 798             }
 799         }gesx; # s in case it goes over multiple lines, so . matches \n
 800
 801         s/Z<>/\\&/g;
 802
 803         # comes last because not subject to reprocessing
 804         s/C<([^<>]*)>/noremap("${CFont_embed}${1}\\fR")/eg;
 805     }
 806
 807     if (s/^=//) {
 808         $needspace = 0;         # Assume this.
 809
 810         s/\n/ /g;
 811
 812         ($Cmd, $_) = split(' ', $_, 2);
 813
 814         if (defined $_) {
 815             &escapes;
 816             s/"/""/g;
 817         }
 818
 819         clear_noremap(1);
 820
 821         if ($Cmd eq 'cut') {
 822             $cutting = 1;
 823         }
 824         elsif ($Cmd eq 'head1') {
 825             s/\s+$//;
 826             delete $wanna_see{$_} if exists $wanna_see{$_};
 827             print qq{.SH "$_"\n};
 828             print qq{.IX Header "$_"\n};
 829         }
 830         elsif ($Cmd eq 'head2') {
 831             print qq{.Sh "$_"\n};
 832             print qq{.IX Subsection "$_"\n};
 833         }
 834         elsif ($Cmd eq 'over') {
 835             push(@indent,$indent);
 836             $indent += ($_ + 0) || 5;
 837         }
 838         elsif ($Cmd eq 'back') {
 839             $indent = pop(@indent);
 840             warn "$0: Unmatched =back in paragraph $. of $ARGV\n" unless defined $indent;
 841             $needspace = 1;
 842         }
 843         elsif ($Cmd eq 'item') {
 844             s/^\*( |$)/\\(bu$1/g;
 845             # if you know how to get ":s please do
 846             s/\\\*\(L"([^"]+?)\\\*\(R"/'$1'/g;
 847             s/\\\*\(L"([^"]+?)""/'$1'/g;
 848             s/[^"]""([^"]+?)""[^"]/'$1'/g;
 849             # here do something about the $" in perlvar?
 850             print STDOUT qq{.Ip "$_" $indent\n};
 851             print qq{.IX Item "$_"\n};
 852         }
 853         elsif ($Cmd eq 'pod') {
 854             # this is just a comment
 855         }
 856         else {
 857             warn "$0: Unrecognized pod directive in paragraph $. of $ARGV: $Cmd\n";
 858         }
 859     }
 860     else {
 861         if ($needspace) {
 862             &makespace;
 863         }
 864         &escapes;
 865         clear_noremap(1);
 866         print $_, "\n";
 867         $needspace = 1;
 868     }
 869 }
 870
 871 print <<"END";
 872
 873 .rn }` ''
 874 END
 875
 876 if (%wanna_see && !$lax) {
 877     @missing = keys %wanna_see;
 878     warn "$0: $Filename is missing required section"
 879         .  (@missing > 1 && "s")
 880         .  ": @missing\n";
 881     $oops++;
 882 }
 883
 884 exit;
 885 #exit ($oops != 0);
 886
 887 #########################################################################
 888
 889 sub nobreak {
 890     my $string = shift;
 891     $string =~ s/ /\\ /g;
 892     $string;
 893 }
 894
 895 sub escapes {
 896
 897     s/X<(.*?)>/mkindex($1)/ge;
 898
 899     # translate the minus in foo-bar into foo\-bar for roff
 900     s/([^0-9a-z-])-([^-])/$1\\-$2/g;
 901
 902     # make -- into the string version \*(-- (defined above)
 903     s/\b--\b/\\*(--/g;
 904     s/"--([^"])/"\\*(--$1/g;  # should be a better way
 905     s/([^"])--"/$1\\*(--"/g;
 906
 907     # fix up quotes; this is somewhat tricky
 908     if (!/""/) {
 909         s/(^|\s)(['"])/noremap("$1\\*(L$2")/ge;
 910         s/(['"])($|[\-\s,;\\!?.])/noremap("\\*(R$1$2")/ge;
 911     }
 912
 913     #s/(?!")(?:.)--(?!")(?:.)/\\*(--/g;
 914     #s/(?:(?!")(?:.)--(?:"))|(?:(?:")--(?!")(?:.))/\\*(--/g;
 915
 916
 917     # make sure that func() keeps a bit a space tween the parens
 918     ### s/\b\(\)/\\|()/g;
 919     ### s/\b\(\)/(\\|)/g;
 920
 921     # make C++ into \*C+, which is a squinched version (defined above)
 922     s/\bC\+\+/\\*(C+/g;
 923
 924     # make double underbars have a little tiny space between them
 925     s/__/_\\|_/g;
 926
 927     # PI goes to \*(PI (defined above)
 928     s/\bPI\b/noremap('\\*(PI')/ge;
 929
 930     # make all caps a teeny bit smaller, but don't muck with embedded code literals
 931     my $hidCFont = font('C');
 932     if ($Cmd !~ /^head1/) { # SH already makes smaller
 933         # /g isn't enough; 1 while or we'll be off
 934
 935 #       1 while s{
 936 #           (?!$hidCFont)(..|^.|^)
 937 #           \b
 938 #           (
 939 #               [A-Z][\/A-Z+:\-\d_$.]+
 940 #           )
 941 #           (s?)
 942 #           \b
 943 #       } {$1\\s-1$2\\s0}gmox;
 944
 945         1 while s{
 946             (?!$hidCFont)(..|^.|^)
 947             (
 948                 \b[A-Z]{2,}[\/A-Z+:\-\d_\$]*\b
 949             )
 950         } {
 951             $1 . noremap( '\\s-1' .  $2 . '\\s0' )
 952         }egmox;
 953
 954     }
 955 }
 956
 957 # make troff just be normal, but make small nroff get quoted
 958 # decided to just put the quotes in the text; sigh;
 959 sub ccvt {
 960     local($_,$prev) = @_;
 961     noremap(qq{.CQ "$_" \n\\&});
 962 }
 963
 964 sub makespace {
 965     if ($indent) {
 966         print ".Sp\n";
 967     }
 968     else {
 969         print ".PP\n";
 970     }
 971 }
 972
 973 sub mkindex {
 974     my ($entry) = @_;
 975     my @entries = split m:\s*/\s*:, $entry;
 976     print ".IX Xref ";
 977     for $entry (@entries) {
 978         print qq("$entry" );
 979     }
 980     print "\n";
 981     return '';
 982 }
 983
 984 sub font {
 985     local($font) = shift;
 986     return '\\f' . noremap($font);
 987 }
 988
 989 sub noremap {
 990     local($thing_to_hide) = shift;
 991     $thing_to_hide =~ tr/\000-\177/\200-\377/;
 992     return $thing_to_hide;
 993 }
 994
 995 sub init_noremap {
 996         # escape high bit characters in input stream
 997         s/([\200-\377])/"E<".ord($1).">"/ge;
 998 }
 999
1000 sub clear_noremap {
1001     my $ready_to_print = $_[0];
1002
1003     tr/\200-\377/\000-\177/;
1004
1005     # trofficate backslashes
1006     # s/(?!\\e)(?:..|^.|^)\\/\\e/g;
1007
1008     # now for the E<>s, which have been hidden until now
1009     # otherwise the interative \w<> processing would have
1010     # been hosed by the E<gt>
1011     s {
1012             E<
1013             (
1014                 ( \d + )
1015                 | ( [A-Za-z]+ )
1016             )
1017             >
1018     } {
1019          do {
1020              defined $2
1021                 ? chr($2)
1022                 :
1023              exists $HTML_Escapes{$3}
1024                 ? do { $HTML_Escapes{$3} }
1025                 : do {
1026                     warn "$0: Unknown escape in paragraph $. of $ARGV: ``$&''\n";
1027                     "E<$1>";
1028                 }
1029          }
1030     }egx if $ready_to_print;
1031 }
1032
1033 sub internal_lrefs {
1034     local($_) = shift;
1035
1036     s{L</([^>]+)>}{$1}g;
1037     my(@items) = split( /(?:,?\s+(?:and\s+)?)/ );
1038     my $retstr = "the ";
1039     my $i;
1040     for ($i = 0; $i <= $#items; $i++) {
1041         $retstr .= "C<$items[$i]>";
1042         $retstr .= ", " if @items > 2 && $i != $#items;
1043         $retstr .= " and " if $i+2 == @items;
1044     }
1045
1046     $retstr .= " entr" . ( @items > 1  ? "ies" : "y" )
1047             .  " elsewhere in this document "; # terminal space to avoid words running together (pattern used strips terminal spaces)
1048
1049     return $retstr;
1050
1051 }
1052
1053 BEGIN {
1054 %HTML_Escapes = (
1055     'amp'       =>      '&',    #   ampersand
1056     'lt'        =>      '<',    #   left chevron, less-than
1057     'gt'        =>      '>',    #   right chevron, greater-than
1058     'quot'      =>      '"',    #   double quote
1059
1060     "Aacute"    =>      "A\\*'",        #   capital A, acute accent
1061     "aacute"    =>      "a\\*'",        #   small a, acute accent
1062     "Acirc"     =>      "A\\*^",        #   capital A, circumflex accent
1063     "acirc"     =>      "a\\*^",        #   small a, circumflex accent
1064     "AElig"     =>      '\*(AE',        #   capital AE diphthong (ligature)
1065     "aelig"     =>      '\*(ae',        #   small ae diphthong (ligature)
1066     "Agrave"    =>      "A\\*`",        #   capital A, grave accent
1067     "agrave"    =>      "A\\*`",        #   small a, grave accent
1068     "Aring"     =>      'A\\*o',        #   capital A, ring
1069     "aring"     =>      'a\\*o',        #   small a, ring
1070     "Atilde"    =>      'A\\*~',        #   capital A, tilde
1071     "atilde"    =>      'a\\*~',        #   small a, tilde
1072     "Auml"      =>      'A\\*:',        #   capital A, dieresis or umlaut mark
1073     "auml"      =>      'a\\*:',        #   small a, dieresis or umlaut mark
1074     "Ccedil"    =>      'C\\*,',        #   capital C, cedilla
1075     "ccedil"    =>      'c\\*,',        #   small c, cedilla
1076     "Eacute"    =>      "E\\*'",        #   capital E, acute accent
1077     "eacute"    =>      "e\\*'",        #   small e, acute accent
1078     "Ecirc"     =>      "E\\*^",        #   capital E, circumflex accent
1079     "ecirc"     =>      "e\\*^",        #   small e, circumflex accent
1080     "Egrave"    =>      "E\\*`",        #   capital E, grave accent
1081     "egrave"    =>      "e\\*`",        #   small e, grave accent
1082     "ETH"       =>      '\\*(D-',       #   capital Eth, Icelandic
1083     "eth"       =>      '\\*(d-',       #   small eth, Icelandic
1084     "Euml"      =>      "E\\*:",        #   capital E, dieresis or umlaut mark
1085     "euml"      =>      "e\\*:",        #   small e, dieresis or umlaut mark
1086     "Iacute"    =>      "I\\*'",        #   capital I, acute accent
1087     "iacute"    =>      "i\\*'",        #   small i, acute accent
1088     "Icirc"     =>      "I\\*^",        #   capital I, circumflex accent
1089     "icirc"     =>      "i\\*^",        #   small i, circumflex accent
1090     "Igrave"    =>      "I\\*`",        #   capital I, grave accent
1091     "igrave"    =>      "i\\*`",        #   small i, grave accent
1092     "Iuml"      =>      "I\\*:",        #   capital I, dieresis or umlaut mark
1093     "iuml"      =>      "i\\*:",        #   small i, dieresis or umlaut mark
1094     "Ntilde"    =>      'N\*~',         #   capital N, tilde
1095     "ntilde"    =>      'n\*~',         #   small n, tilde
1096     "Oacute"    =>      "O\\*'",        #   capital O, acute accent
1097     "oacute"    =>      "o\\*'",        #   small o, acute accent
1098     "Ocirc"     =>      "O\\*^",        #   capital O, circumflex accent
1099     "ocirc"     =>      "o\\*^",        #   small o, circumflex accent
1100     "Ograve"    =>      "O\\*`",        #   capital O, grave accent
1101     "ograve"    =>      "o\\*`",        #   small o, grave accent
1102     "Oslash"    =>      "O\\*/",        #   capital O, slash
1103     "oslash"    =>      "o\\*/",        #   small o, slash
1104     "Otilde"    =>      "O\\*~",        #   capital O, tilde
1105     "otilde"    =>      "o\\*~",        #   small o, tilde
1106     "Ouml"      =>      "O\\*:",        #   capital O, dieresis or umlaut mark
1107     "ouml"      =>      "o\\*:",        #   small o, dieresis or umlaut mark
1108     "szlig"     =>      '\*8',          #   small sharp s, German (sz ligature)
1109     "THORN"     =>      '\\*(Th',       #   capital THORN, Icelandic
1110     "thorn"     =>      '\\*(th',,      #   small thorn, Icelandic
1111     "Uacute"    =>      "U\\*'",        #   capital U, acute accent
1112     "uacute"    =>      "u\\*'",        #   small u, acute accent
1113     "Ucirc"     =>      "U\\*^",        #   capital U, circumflex accent
1114     "ucirc"     =>      "u\\*^",        #   small u, circumflex accent
1115     "Ugrave"    =>      "U\\*`",        #   capital U, grave accent
1116     "ugrave"    =>      "u\\*`",        #   small u, grave accent
1117     "Uuml"      =>      "U\\*:",        #   capital U, dieresis or umlaut mark
1118     "uuml"      =>      "u\\*:",        #   small u, dieresis or umlaut mark
1119     "Yacute"    =>      "Y\\*'",        #   capital Y, acute accent
1120     "yacute"    =>      "y\\*'",        #   small y, acute accent
1121     "yuml"      =>      "y\\*:",        #   small y, dieresis or umlaut mark
1122 );
1123 }
1124
1125 !NO!SUBS!
1126
1127 close OUT or die "Can't close $file: $!";
1128 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1129 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';