4 use File::Basename qw(&basename &dirname);
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
12 # to ensure Configure will look for $Config{startperl}.
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.
17 $file = basename($0, '.PL');
18 $file .= '.com' if $^O eq 'VMS';
20 open OUT,">$file" or die "Can't create $file: $!";
22 print "Extracting $file (with variable substitutions)\n";
24 # In this section, perl variables will be expanded during extraction.
25 # You can use $Config{...} to use Configure variables.
27 print OUT <<"!GROK!THIS!";
29 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
30 if \$running_under_some_shell;
32 \$DEF_PM_SECTION = '$Config{man3ext}' || '3';
35 # In the following, perl variables are not expanded during extraction.
37 print OUT <<'!NO!SUBS!';
41 pod2man - translate embedded Perl pod directives into man pages
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> ]
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.
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
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".
85 Set the left-hand footer string to this value. By default,
86 the modification date of the input file will be used.
90 The fixed font to use for code refs. Defaults to CW.
94 Set the default header to indicate that this page is of
95 the standard release in case C<--center> is not given.
99 Set the centered footer. By default, this is the current
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.
114 Don't complain when required sections aren't present.
118 =head1 Anatomy of a Proper Man Page
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.
132 Mandatory section; should be a comma-separated list of programs or
133 functions documented by this podpage, such as:
135 foo, bar - programs to do something
139 A short usage summary for programs and functions, which
140 may someday be deemed mandatory.
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
147 =head2 A Sample Subection
149 =head2 Yet Another Sample Subection
153 Some people make this separate from the description.
157 What the program or function returns if successful.
161 Exceptions, return codes, exit stati, and errno settings.
165 Give some example uses of the program.
169 Envariables this program might care about.
173 All files used by the program. You should probably use the FE<lt>E<gt>
178 Other man pages to check out, like man(1), man(7), makewhatis(8), or catman(8).
182 Miscellaneous commentary.
186 Things to take special care with; sometimes called WARNINGS.
190 All possible messages the program can print out--and
195 Things that are broken or just don't work quite right.
199 Bugs you don't plan to fix :-)
203 Who wrote it (or AUTHORS if multiple).
207 Programs derived from other sources sometimes have this, or
208 you might keep a modification log here.
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
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.
226 =item bad option in paragraph %d of %s: ``%s'' should be [%s]<%s>
228 (W) If you start include an option, you should set it off
229 as bold, italic, or code.
231 =item can't open %s: %s
233 (F) The input file wasn't available for the given reason.
235 =item Improper man page - no dash in NAME header in paragraph %d of %s
237 (W) The NAME header did not have an isolated dash in it. This is
238 considered important.
240 =item Invalid man page - no NAME line in %s
242 (F) You did not include a NAME header, which is essential.
244 =item roff font should be 1 or 2 chars, not `%s' (F)
246 (F) The font specified with the C<--fixed> option was not
247 a one- or two-digit roff font.
249 =item %s is missing required section: %s
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.
255 =item Unknown escape: %s in %s
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.
267 =item Unmatched =back
269 (W) You have a C<=back> without a corresponding C<=over>.
271 =item Unrecognized pod directive: %s
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>.
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
287 troff -man -rC1 -rD1 -rF1 perl.1 perldata.1 perlsyn.1 ...
289 The indexing merely outputs messages via C<.tm> for each
290 major page, section, subsection, item, and any C<XE<lt>E<gt>>
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.
306 Original prototype by Larry Wall, but so massively hacked over by
307 Tom Christiansen such that Larry probably doesn't recognize it anymore.
315 # We try first to get the version number from a local binary, in case we're
316 # running an installed version of Perl to produce documentation from an
317 # uninstalled newer version's pod files.
318 if ($^O ne 'plan9' && $^O ne 'dos') {
320 `\PATH=.:..:\$PATH; perl -v` =~ /version (\d\.\d{3})(?:_(\d{2}))?/;
322 # No luck; we'll just go with the running Perl's version
323 ($version,$patch) = $] =~ /^(.{5})(\d{2})?/ unless $version;
324 $DEF_RELEASE = "perl $version";
325 $DEF_RELEASE .= ", patch $patch" if $patch;
330 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($secs);
331 my $mname = (qw{Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec})[$mon];
332 return "$mday/$mname/$year";
338 $DEF_CENTER = "User Contributed Perl Documentation";
339 $STD_CENTER = "Perl Programmers Reference Guide";
344 warn "$0: @_\n" if @_;
346 usage: $0 [options] podpage
348 --section=manext (default "$DEF_SECTION")
349 --release=relpatch (default "$DEF_RELEASE")
350 --center=string (default "$DEF_CENTER")
351 --date=string (default "$DEF_DATE")
352 --fixed=font (default "$DEF_FIXED")
353 --official (default NOT)
358 $uok = GetOptions( qw(
368 $DEF_DATE = makedate((stat($ARGV[0]))[9] || time());
370 usage("Usage error!") unless $uok;
371 usage() if $opt_help;
372 usage("Need one and only one podpage argument") unless @ARGV == 1;
374 $section = $opt_section || ($ARGV[0] =~ /\.pm$/
375 ? $DEF_PM_SECTION : $DEF_SECTION);
376 $RP = $opt_release || $DEF_RELEASE;
377 $center = $opt_center || ($opt_official ? $STD_CENTER : $DEF_CENTER);
378 $lax = $opt_lax || $DEF_LAX;
380 $CFont = $opt_fixed || $DEF_FIXED;
382 if (length($CFont) == 2) {
383 $CFont_embed = "\\f($CFont";
385 elsif (length($CFont) == 1) {
386 $CFont_embed = "\\f$CFont";
389 die "roff font should be 1 or 2 chars, not `$CFont_embed'";
392 $date = $opt_date || $DEF_DATE;
394 for (qw{NAME DESCRIPTION}) {
395 # for (qw{NAME DESCRIPTION AUTHOR}) {
398 $wanna_see{SYNOPSIS}++ if $section =~ /^3/;
401 $name = @ARGV ? $ARGV[0] : "<STDIN>";
403 if ($section =~ /^1/) {
404 require File::Basename;
405 $name = uc File::Basename::basename($name);
407 $name =~ s/\.(pod|p[lm])$//i;
409 # Lose everything up to the first of
410 # */lib/*perl* standard or site_perl module
411 # */*perl*/lib from -D prefix=/opt/perl
412 # */*perl*/ random module hierarchy
415 if ($name =~ s-^.*?/lib/[^/]*perl[^/]*/--i
416 or $name =~ s-^.*?/[^/]*perl[^/]*/lib/--i
417 or $name =~ s-^.*?/[^/]*perl[^/]*/--i) {
418 # Lose ^arch/version/.
419 $name =~ s-^[^/]+/\d+\.\d+/--;
422 # Translate Getopt/Long to Getopt::Long, etc.
425 if ($name ne 'something') {
427 open(F, "< $ARGV[0]") || die "can't open $ARGV[0]: $!";
430 if (/^=head1\s+NAME\s*$/) { # an /m would forgive mistakes
432 unless (/\s*-+\s+/) {
434 warn "$0: Improper man page - no dash in NAME header in paragraph $. of $ARGV[0]\n"
436 my @n = split /\s+-+\s+/;
439 warn "$0: Improper man page - malformed NAME header in paragraph $. of $ARGV[0]\n"
447 next if /^=cut\b/; # DB_File and Net::Ping have =cut before NAME
448 next if /^=pod\b/; # It is OK to have =pod before NAME
449 die "$0: Invalid man page - 1st pod line is not NAME in $ARGV[0]\n" unless $lax;
451 die "$0: Invalid man page - no documentation in $ARGV[0]\n" unless $lax;
458 ''' \$RCSfile\$\$Revision\$\$Date\$
476 .ie \\\\n(.\$>=3 .ne \\\\\$3
478 .IP "\\\\\$1" \\\\\$2
492 ''' Set up \\*(-- to give an unbreakable dash;
493 ''' string Tr holds user defined translation string.
494 ''' Bell System Logo is used as a dummy character.
496 .tr \\(*W-|\\(bv\\*(Tr
500 .if (\\n(.H=4u)&(1m=24u) .ds -- \\(*W\\h'-12u'\\(*W\\h'-12u'-\\" diablo 10 pitch
501 .if (\\n(.H=4u)&(1m=20u) .ds -- \\(*W\\h'-12u'\\(*W\\h'-8u'-\\" diablo 12 pitch
504 ''' \\*(M", \\*(S", \\*(N" and \\*(T" are the equivalent of
505 ''' \\*(L" and \\*(R", except that they are used on ".xx" lines,
506 ''' such as .IP and .SH, which do another additional levels of
507 ''' double-quote interpretation
539 .\" If the F register is turned on, we'll generate
540 .\" index entries out stderr for the following things:
545 .\" X<> Xref (embedded
546 .\" Of course, you have to process the output yourself
547 .\" in some meaninful fashion.
550 .tm Index:\\$1\t\\n%\t"\\$2"
558 .TH $name $section "$RP" "$date" "$center"
562 push(@Indices, qq{.IX Title "$name $section"});
564 while (($name, $desc) = each %namedesc) {
565 for ($name, $desc) { s/^\s+//; s/\s+$//; }
566 push(@Indices, qq(.IX Name "$name - $desc"\n));
572 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
573 .de CQ \" put $1 in typewriter font
575 print ".ft $CFont\n";
581 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
584 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
585 . \" AM - accent mark definitions
587 . \" fudge factors for nroff and troff
596 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
602 . \" simple accents for nroff and troff
615 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
616 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
617 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
618 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
619 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
620 . ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
621 . ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
622 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
623 . 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'
625 . \" troff and (daisy-wheel) nroff accents
626 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
627 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
628 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
629 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
630 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
631 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
632 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
633 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
634 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
635 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
636 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
637 .ds ae a\h'-(\w'a'u*4/10)'e
638 .ds Ae A\h'-(\w'A'u*4/10)'E
639 .ds oe o\h'-(\w'o'u*4/10)'e
640 .ds Oe O\h'-(\w'O'u*4/10)'E
641 . \" corrections for vroff
642 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
643 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
644 . \" for low resolution devices (crt and lpr)
645 .if \n(.H>23 .if \n(.V>19 \
649 . ds v \h'-1'\o'\(aa\(ga'
676 if (/^=end\s+$begun/) {
679 elsif ($begun =~ /^(roff|man)$/) {
686 # Translate verbatim paragraph
689 @lines = split(/\n/);
692 {^( [^\t]* ) \t ( \t* ) }
693 { $1 . ' ' x (8 - (length($1)%8) + 8 * (length($2))) }ex;
698 makespace() unless $verbatim++;
699 print ".Vb $lines\n";
700 print join("\n", @lines), "\n";
708 if (/^=for\s+(\S+)\s*/s) {
709 if ($1 eq "man" or $1 eq "roff") {
710 print STDOUT $',"\n\n";
716 elsif (/^=begin\s+(\S+)\s*/s) {
718 if ($1 eq "man" or $1 eq "roff") {
719 print STDOUT $'."\n\n";
724 # check for things that'll hosed our noremap scheme; affects $_
729 # trofficate backslashes; must do it before what happens below
730 s/\\/noremap('\\e')/ge;
732 # protect leading periods and quotes against *roff
733 # mistaking them for directives
734 s/^(?:[A-Z]<)?[.']/\\&$&/gm;
736 # first hide the escapes in case we need to
737 # intuit something and get it wrong due to fmting
739 s/([A-Z]<[^<>]*>)/noremap($1)/ge;
741 # func() is a reference to a perl function
749 # func(n) is a reference to a perl function or a man page
757 # convert simple variable references
758 s/(\s+)([\$\@%][\w:]+)(?!\()/${1}C<$2>/g;
768 }x && $` !~ /([LCI]<[^<>]*|-)$/ && !/^=\w/)
770 warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [LCI]<$1>\n";
774 while (/(-[a-zA-Z])\b/g && $` !~ /[\w\-]$/) {
775 warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [CB]<$1>\n";
779 # put it back so we get the <> processed again;
780 clear_noremap(0); # 0 means leave the E's
783 # trofficate backslashes
784 s/\\/noremap('\\e')/ge;
788 # need to hide E<> first; they're processed in clear_noremap
789 s/(E<[^<>]+>)/noremap($1)/ge;
793 while ($maxnest-- && /[A-Z]</) {
795 # can't do C font here
796 s/([BI])<([^<>]*)>/font($1) . $2 . font('R')/eg;
798 # files and filelike refs in italics
799 s/F<([^<>]*)>/I<$1>/g;
801 # no break -- usually we want C<> for this
802 s/S<([^<>]*)>/nobreak($1)/eg;
804 # LREF: a manpage(3f)
805 s:L<([a-zA-Z][^\s\/]+)(\([^\)]+\))?>:the I<$1>$2 manpage:g;
807 # LREF: an =item on another manpage
817 } {the C<$2> entry in the I<$1> manpage}gx;
819 # LREF: an =item on this manpage
831 } { internal_lrefs($1) }gex;
833 # LREF: a =head2 (head1?), maybe on a manpage, maybe right here
834 # the "func" can disambiguate
844 $1 # if no $1, assume it means on this page.
845 ? "the section on I<$2> in the I<$1> manpage"
846 : "the section on I<$2>"
848 }gesx; # s in case it goes over multiple lines, so . matches \n
852 # comes last because not subject to reprocessing
853 s/C<([^<>]*)>/noremap("${CFont_embed}${1}\\fR")/eg;
857 $needspace = 0; # Assume this.
861 ($Cmd, $_) = split(' ', $_, 2);
864 if ($Cmd eq 'head1') {
867 elsif ($Cmd eq 'head2') {
870 elsif ($Cmd eq 'item') {
884 elsif ($Cmd eq 'head1') {
886 delete $wanna_see{$_} if exists $wanna_see{$_};
887 print qq{.SH "$_"\n};
888 push(@Indices, qq{.IX Header "$_"\n});
890 elsif ($Cmd eq 'head2') {
891 print qq{.Sh "$_"\n};
892 push(@Indices, qq{.IX Subsection "$_"\n});
894 elsif ($Cmd eq 'over') {
895 push(@indent,$indent);
896 $indent += ($_ + 0) || 5;
898 elsif ($Cmd eq 'back') {
899 $indent = pop(@indent);
900 warn "$0: Unmatched =back in paragraph $. of $ARGV\n" unless defined $indent;
903 elsif ($Cmd eq 'item') {
904 s/^\*( |$)/\\(bu$1/g;
905 # if you know how to get ":s please do
906 s/\\\*\(L"([^"]+?)\\\*\(R"/'$1'/g;
907 s/\\\*\(L"([^"]+?)""/'$1'/g;
908 s/[^"]""([^"]+?)""[^"]/'$1'/g;
909 # here do something about the $" in perlvar?
910 print STDOUT qq{.Ip "$_" $indent\n};
911 push(@Indices, qq{.IX Item "$_"\n});
913 elsif ($Cmd eq 'pod') {
914 # this is just a comment
917 warn "$0: Unrecognized pod directive in paragraph $. of $ARGV: $Cmd\n";
936 if (%wanna_see && !$lax) {
937 @missing = keys %wanna_see;
938 warn "$0: $Filename is missing required section"
939 . (@missing > 1 && "s")
944 foreach (@Indices) { print "$_\n"; }
949 #########################################################################
953 $string =~ s/ /\\ /g;
960 s/X<(.*?)>/mkindex($1)/ge;
962 # translate the minus in foo-bar into foo\-bar for roff
963 s/([^0-9a-z-])-([^-])/$1\\-$2/g;
965 # make -- into the string version \*(-- (defined above)
967 s/"--([^"])/"\\*(--$1/g; # should be a better way
968 s/([^"])--"/$1\\*(--"/g;
970 # fix up quotes; this is somewhat tricky
977 elsif ( $indot >= 2 ) {
982 s/(^|\s)(['"])/noremap("$1\\*($dotmacroL$2")/ge;
983 s/(['"])($|[\-\s,;\\!?.])/noremap("\\*($dotmacroR$1$2")/ge;
986 #s/(?!")(?:.)--(?!")(?:.)/\\*(--/g;
987 #s/(?:(?!")(?:.)--(?:"))|(?:(?:")--(?!")(?:.))/\\*(--/g;
990 # make sure that func() keeps a bit a space tween the parens
991 ### s/\b\(\)/\\|()/g;
992 ### s/\b\(\)/(\\|)/g;
994 # make C++ into \*C+, which is a squinched version (defined above)
997 # make double underbars have a little tiny space between them
1000 # PI goes to \*(PI (defined above)
1001 s/\bPI\b/noremap('\\*(PI')/ge;
1003 # make all caps a teeny bit smaller, but don't muck with embedded code literals
1004 my $hidCFont = font('C');
1005 if ($Cmd !~ /^head1/) { # SH already makes smaller
1006 # /g isn't enough; 1 while or we'll be off
1009 # (?!$hidCFont)(..|^.|^)
1012 # [A-Z][\/A-Z+:\-\d_$.]+
1016 # } {$1\\s-1$2\\s0}gmox;
1019 (?!$hidCFont)(..|^.|^)
1021 \b[A-Z]{2,}[\/A-Z+:\-\d_\$]*\b
1024 $1 . noremap( '\\s-1' . $2 . '\\s0' )
1030 # make troff just be normal, but make small nroff get quoted
1031 # decided to just put the quotes in the text; sigh;
1033 local($_,$prev) = @_;
1034 noremap(qq{.CQ "$_" \n\\&});
1048 my @entries = split m:\s*/\s*:, $entry;
1049 push @Indices, ".IX Xref " . join ' ', map {qq("$_")} @entries;
1050 for $entry (@entries) {
1051 print qq("$entry" );
1058 local($font) = shift;
1059 return '\\f' . noremap($font);
1063 local($thing_to_hide) = shift;
1064 $thing_to_hide =~ tr/\000-\177/\200-\377/;
1065 return $thing_to_hide;
1069 # escape high bit characters in input stream
1070 s/([\200-\377])/"E<".ord($1).">"/ge;
1074 my $ready_to_print = $_[0];
1076 tr/\200-\377/\000-\177/;
1078 # trofficate backslashes
1079 # s/(?!\\e)(?:..|^.|^)\\/\\e/g;
1081 # now for the E<>s, which have been hidden until now
1082 # otherwise the interative \w<> processing would have
1083 # been hosed by the E<gt>
1096 exists $HTML_Escapes{$3}
1097 ? do { $HTML_Escapes{$3} }
1099 warn "$0: Unknown escape in paragraph $. of $ARGV: ``$&''\n";
1103 }egx if $ready_to_print;
1106 sub internal_lrefs {
1108 local $trailing_and = s/and\s+$// ? "and " : "";
1110 s{L</([^>]+)>}{$1}g;
1111 my(@items) = split( /(?:,?\s+(?:and\s+)?)/ );
1112 my $retstr = "the ";
1114 for ($i = 0; $i <= $#items; $i++) {
1115 $retstr .= "C<$items[$i]>";
1116 $retstr .= ", " if @items > 2 && $i != $#items;
1117 $retstr .= " and " if $i+2 == @items;
1120 $retstr .= " entr" . ( @items > 1 ? "ies" : "y" )
1121 . " elsewhere in this document "; # terminal space to avoid words running together (pattern used strips terminal spaces)
1122 $retstr .= $trailing_and;
1130 'amp' => '&', # ampersand
1131 'lt' => '<', # left chevron, less-than
1132 'gt' => '>', # right chevron, greater-than
1133 'quot' => '"', # double quote
1135 "Aacute" => "A\\*'", # capital A, acute accent
1136 "aacute" => "a\\*'", # small a, acute accent
1137 "Acirc" => "A\\*^", # capital A, circumflex accent
1138 "acirc" => "a\\*^", # small a, circumflex accent
1139 "AElig" => '\*(AE', # capital AE diphthong (ligature)
1140 "aelig" => '\*(ae', # small ae diphthong (ligature)
1141 "Agrave" => "A\\*`", # capital A, grave accent
1142 "agrave" => "A\\*`", # small a, grave accent
1143 "Aring" => 'A\\*o', # capital A, ring
1144 "aring" => 'a\\*o', # small a, ring
1145 "Atilde" => 'A\\*~', # capital A, tilde
1146 "atilde" => 'a\\*~', # small a, tilde
1147 "Auml" => 'A\\*:', # capital A, dieresis or umlaut mark
1148 "auml" => 'a\\*:', # small a, dieresis or umlaut mark
1149 "Ccedil" => 'C\\*,', # capital C, cedilla
1150 "ccedil" => 'c\\*,', # small c, cedilla
1151 "Eacute" => "E\\*'", # capital E, acute accent
1152 "eacute" => "e\\*'", # small e, acute accent
1153 "Ecirc" => "E\\*^", # capital E, circumflex accent
1154 "ecirc" => "e\\*^", # small e, circumflex accent
1155 "Egrave" => "E\\*`", # capital E, grave accent
1156 "egrave" => "e\\*`", # small e, grave accent
1157 "ETH" => '\\*(D-', # capital Eth, Icelandic
1158 "eth" => '\\*(d-', # small eth, Icelandic
1159 "Euml" => "E\\*:", # capital E, dieresis or umlaut mark
1160 "euml" => "e\\*:", # small e, dieresis or umlaut mark
1161 "Iacute" => "I\\*'", # capital I, acute accent
1162 "iacute" => "i\\*'", # small i, acute accent
1163 "Icirc" => "I\\*^", # capital I, circumflex accent
1164 "icirc" => "i\\*^", # small i, circumflex accent
1165 "Igrave" => "I\\*`", # capital I, grave accent
1166 "igrave" => "i\\*`", # small i, grave accent
1167 "Iuml" => "I\\*:", # capital I, dieresis or umlaut mark
1168 "iuml" => "i\\*:", # small i, dieresis or umlaut mark
1169 "Ntilde" => 'N\*~', # capital N, tilde
1170 "ntilde" => 'n\*~', # small n, tilde
1171 "Oacute" => "O\\*'", # capital O, acute accent
1172 "oacute" => "o\\*'", # small o, acute accent
1173 "Ocirc" => "O\\*^", # capital O, circumflex accent
1174 "ocirc" => "o\\*^", # small o, circumflex accent
1175 "Ograve" => "O\\*`", # capital O, grave accent
1176 "ograve" => "o\\*`", # small o, grave accent
1177 "Oslash" => "O\\*/", # capital O, slash
1178 "oslash" => "o\\*/", # small o, slash
1179 "Otilde" => "O\\*~", # capital O, tilde
1180 "otilde" => "o\\*~", # small o, tilde
1181 "Ouml" => "O\\*:", # capital O, dieresis or umlaut mark
1182 "ouml" => "o\\*:", # small o, dieresis or umlaut mark
1183 "szlig" => '\*8', # small sharp s, German (sz ligature)
1184 "THORN" => '\\*(Th', # capital THORN, Icelandic
1185 "thorn" => '\\*(th',, # small thorn, Icelandic
1186 "Uacute" => "U\\*'", # capital U, acute accent
1187 "uacute" => "u\\*'", # small u, acute accent
1188 "Ucirc" => "U\\*^", # capital U, circumflex accent
1189 "ucirc" => "u\\*^", # small u, circumflex accent
1190 "Ugrave" => "U\\*`", # capital U, grave accent
1191 "ugrave" => "u\\*`", # small u, grave accent
1192 "Uuml" => "U\\*:", # capital U, dieresis or umlaut mark
1193 "uuml" => "u\\*:", # small u, dieresis or umlaut mark
1194 "Yacute" => "Y\\*'", # capital Y, acute accent
1195 "yacute" => "y\\*'", # small y, acute accent
1196 "yuml" => "y\\*:", # small y, dieresis or umlaut mark
1202 close OUT or die "Can't close $file: $!";
1203 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1204 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';