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