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.
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') {
319 `\PATH=.:..:\$PATH; perl -v` =~ /version (\d\.\d{3})(?:_(\d{2}))?/;
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;
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";
337 $DEF_CENTER = "User Contributed Perl Documentation";
338 $STD_CENTER = "Perl Programmers Reference Guide";
343 warn "$0: @_\n" if @_;
345 usage: $0 [options] podpage
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)
357 $uok = GetOptions( qw(
367 $DEF_DATE = makedate((stat($ARGV[0]))[9] || time());
369 usage("Usage error!") unless $uok;
370 usage() if $opt_help;
371 usage("Need one and only one podpage argument") unless @ARGV == 1;
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;
379 $CFont = $opt_fixed || $DEF_FIXED;
381 if (length($CFont) == 2) {
382 $CFont_embed = "\\f($CFont";
384 elsif (length($CFont) == 1) {
385 $CFont_embed = "\\f$CFont";
388 die "roff font should be 1 or 2 chars, not `$CFont_embed'";
391 $date = $opt_date || $DEF_DATE;
393 for (qw{NAME DESCRIPTION}) {
394 # for (qw{NAME DESCRIPTION AUTHOR}) {
397 $wanna_see{SYNOPSIS}++ if $section =~ /^3/;
400 $name = @ARGV ? $ARGV[0] : "<STDIN>";
402 if ($section =~ /^1/) {
403 require File::Basename;
404 $name = uc File::Basename::basename($name);
406 $name =~ s/\.(pod|p[lm])$//i;
407 $name =~ s(/)(::)g; # translate Getopt/Long to Getopt::Long, etc.
409 if ($name ne 'something') {
411 open(F, "< $ARGV[0]") || die "can't open $ARGV[0]: $!";
414 if (/^=head1\s+NAME\s*$/) { # an /m would forgive mistakes
416 unless (/\s*-+\s+/) {
418 warn "$0: Improper man page - no dash in NAME header in paragraph $. of $ARGV[0]\n"
420 %namedesc = split /\s+-+\s+/;
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;
427 die "$0: Invalid man page - no documentation in $ARGV[0]\n" unless $lax;
434 ''' \$RCSfile\$\$Revision\$\$Date\$
452 .ie \\\\n(.\$>=3 .ne \\\\\$3
454 .IP "\\\\\$1" \\\\\$2
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.
472 .tr \\(*W-|\\(bv\\*(Tr
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
495 .\" If the F register is turned on, we'll generate
496 .\" index entries out stderr for the following things:
501 .\" X<> Xref (embedded
502 .\" Of course, you have to process the output yourself
503 .\" in some meaninful fashion.
506 .tm Index:\\$1\t\\n%\t"\\$2"
514 .TH $name $section "$RP" "$date" "$center"
515 .IX Title "$name $section"
519 while (($name, $desc) = each %namedesc) {
520 for ($name, $desc) { s/^\s+//; s/\s+$//; }
521 print qq(.IX Name "$name - $desc"\n);
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
530 print ".ft $CFont\n";
536 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
539 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
540 . \" AM - accent mark definitions
542 . \" fudge factors for nroff and troff
551 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
557 . \" simple accents for nroff and troff
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'
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 \
604 . ds v \h'-1'\o'\(aa\(ga'
631 if (/^=end\s+$begun/) {
634 elsif ($begun =~ /^(roff|man)$/) {
641 # Translate verbatim paragraph
644 @lines = split(/\n/);
647 {^( [^\t]* ) \t ( \t* ) }
648 { $1 . ' ' x (8 - (length($1)%8) + 8 * (length($2))) }ex;
653 makespace() unless $verbatim++;
654 print ".Vb $lines\n";
655 print join("\n", @lines), "\n";
663 if (/^=for\s+(\S+)\s*/s) {
664 if ($1 eq "man" or $1 eq "roff") {
665 print STDOUT $',"\n\n";
671 elsif (/^=begin\s+(\S+)\s*/s) {
673 if ($1 eq "man" or $1 eq "roff") {
674 print STDOUT $'."\n\n";
679 # check for things that'll hosed our noremap scheme; affects $_
684 # trofficate backslashes; must do it before what happens below
685 s/\\/noremap('\\e')/ge;
687 # first hide the escapes in case we need to
688 # intuit something and get it wrong due to fmting
690 s/([A-Z]<[^<>]*>)/noremap($1)/ge;
692 # func() is a reference to a perl function
700 # func(n) is a reference to a perl function or a man page
708 # convert simple variable references
709 s/(\s+)([\$\@%][\w:]+)(?!\()/${1}C<$2>/g;
719 }x && $` !~ /([LCI]<[^<>]*|-)$/ && !/^=\w/)
721 warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [LCI]<$1>\n";
725 while (/(-[a-zA-Z])\b/g && $` !~ /[\w\-]$/) {
726 warn "$0: bad option in paragraph $. of $ARGV: ``$1'' should be [CB]<$1>\n";
730 # put it back so we get the <> processed again;
731 clear_noremap(0); # 0 means leave the E's
734 # trofficate backslashes
735 s/\\/noremap('\\e')/ge;
739 # need to hide E<> first; they're processed in clear_noremap
740 s/(E<[^<>]+>)/noremap($1)/ge;
744 while ($maxnest-- && /[A-Z]</) {
746 # can't do C font here
747 s/([BI])<([^<>]*)>/font($1) . $2 . font('R')/eg;
749 # files and filelike refs in italics
750 s/F<([^<>]*)>/I<$1>/g;
752 # no break -- usually we want C<> for this
753 s/S<([^<>]*)>/nobreak($1)/eg;
755 # LREF: a manpage(3f)
756 s:L<([a-zA-Z][^\s\/]+)(\([^\)]+\))?>:the I<$1>$2 manpage:g;
758 # LREF: an =item on another manpage
768 } {the C<$2> entry in the I<$1> manpage}gx;
770 # LREF: an =item on this manpage
782 } { internal_lrefs($1) }gex;
784 # LREF: a =head2 (head1?), maybe on a manpage, maybe right here
785 # the "func" can disambiguate
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>"
799 }gesx; # s in case it goes over multiple lines, so . matches \n
803 # comes last because not subject to reprocessing
804 s/C<([^<>]*)>/noremap("${CFont_embed}${1}\\fR")/eg;
808 $needspace = 0; # Assume this.
812 ($Cmd, $_) = split(' ', $_, 2);
824 elsif ($Cmd eq 'head1') {
826 delete $wanna_see{$_} if exists $wanna_see{$_};
827 print qq{.SH "$_"\n};
828 print qq{.IX Header "$_"\n};
830 elsif ($Cmd eq 'head2') {
831 print qq{.Sh "$_"\n};
832 print qq{.IX Subsection "$_"\n};
834 elsif ($Cmd eq 'over') {
835 push(@indent,$indent);
836 $indent += ($_ + 0) || 5;
838 elsif ($Cmd eq 'back') {
839 $indent = pop(@indent);
840 warn "$0: Unmatched =back in paragraph $. of $ARGV\n" unless defined $indent;
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};
853 elsif ($Cmd eq 'pod') {
854 # this is just a comment
857 warn "$0: Unrecognized pod directive in paragraph $. of $ARGV: $Cmd\n";
876 if (%wanna_see && !$lax) {
877 @missing = keys %wanna_see;
878 warn "$0: $Filename is missing required section"
879 . (@missing > 1 && "s")
887 #########################################################################
891 $string =~ s/ /\\ /g;
897 s/X<(.*?)>/mkindex($1)/ge;
899 # translate the minus in foo-bar into foo\-bar for roff
900 s/([^0-9a-z-])-([^-])/$1\\-$2/g;
902 # make -- into the string version \*(-- (defined above)
904 s/"--([^"])/"\\*(--$1/g; # should be a better way
905 s/([^"])--"/$1\\*(--"/g;
907 # fix up quotes; this is somewhat tricky
909 s/(^|\s)(['"])/noremap("$1\\*(L$2")/ge;
910 s/(['"])($|[\-\s,;\\!?.])/noremap("\\*(R$1$2")/ge;
913 #s/(?!")(?:.)--(?!")(?:.)/\\*(--/g;
914 #s/(?:(?!")(?:.)--(?:"))|(?:(?:")--(?!")(?:.))/\\*(--/g;
917 # make sure that func() keeps a bit a space tween the parens
918 ### s/\b\(\)/\\|()/g;
919 ### s/\b\(\)/(\\|)/g;
921 # make C++ into \*C+, which is a squinched version (defined above)
924 # make double underbars have a little tiny space between them
927 # PI goes to \*(PI (defined above)
928 s/\bPI\b/noremap('\\*(PI')/ge;
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
936 # (?!$hidCFont)(..|^.|^)
939 # [A-Z][\/A-Z+:\-\d_$.]+
943 # } {$1\\s-1$2\\s0}gmox;
946 (?!$hidCFont)(..|^.|^)
948 \b[A-Z]{2,}[\/A-Z+:\-\d_\$]*\b
951 $1 . noremap( '\\s-1' . $2 . '\\s0' )
957 # make troff just be normal, but make small nroff get quoted
958 # decided to just put the quotes in the text; sigh;
960 local($_,$prev) = @_;
961 noremap(qq{.CQ "$_" \n\\&});
975 my @entries = split m:\s*/\s*:, $entry;
977 for $entry (@entries) {
985 local($font) = shift;
986 return '\\f' . noremap($font);
990 local($thing_to_hide) = shift;
991 $thing_to_hide =~ tr/\000-\177/\200-\377/;
992 return $thing_to_hide;
996 # escape high bit characters in input stream
997 s/([\200-\377])/"E<".ord($1).">"/ge;
1001 my $ready_to_print = $_[0];
1003 tr/\200-\377/\000-\177/;
1005 # trofficate backslashes
1006 # s/(?!\\e)(?:..|^.|^)\\/\\e/g;
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>
1023 exists $HTML_Escapes{$3}
1024 ? do { $HTML_Escapes{$3} }
1026 warn "$0: Unknown escape in paragraph $. of $ARGV: ``$&''\n";
1030 }egx if $ready_to_print;
1033 sub internal_lrefs {
1036 s{L</([^>]+)>}{$1}g;
1037 my(@items) = split( /(?:,?\s+(?:and\s+)?)/ );
1038 my $retstr = "the ";
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;
1046 $retstr .= " entr" . ( @items > 1 ? "ies" : "y" )
1047 . " elsewhere in this document "; # terminal space to avoid words running together (pattern used strips terminal spaces)
1055 'amp' => '&', # ampersand
1056 'lt' => '<', # left chevron, less-than
1057 'gt' => '>', # right chevron, greater-than
1058 'quot' => '"', # double quote
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
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 ':';