[gcc.git] / contrib / texi2pod.pl

#! /usr/bin/perl -w

# This does trivial (and I mean _trivial_) conversion of Texinfo
# markup to Perl POD format.  It's intended to be used to extract
# something suitable for a manpage from a Texinfo document.

$output = 0;
$skipping = 0;
%sects = ();
$section = "";
@icstack = ();
@endwstack = ();
@skstack = ();
$shift = "";
%defs = ();
$fnno = 1;

while ($_ = shift) {
    if (/^-D(.*)$/) {
	if ($1 ne "") {
	    $flag = $1;
	} else {
	    $flag = shift;
	}
	die "no flag specified for -D\n"
	    unless $flag ne "";
	die "flags may only contain letters, digits, hyphens, and underscores\n"
	    unless $flag =~ /^[a-zA-Z0-9_-]+$/;
	$defs{$flag} = "";
    } elsif (/^-/) {
	usage();
    } else {
	$in = $_, next unless defined $in;
	$out = $_, next unless defined $out;
	usage();
    }
}

if (defined $in) {
    open(STDIN, $in) or die "opening \"$in\": $!\n";
}
if (defined $out) {
    open(STDOUT, ">$out") or die "opening \"$out\": $!\n";
}

while(<STDIN>)
{
    # Certain commands are discarded without further processing.
    /^\@(?:
	 [a-z]+index		# @*index: useful only in complete manual
	 |need			# @need: useful only in printed manual
	 |(?:end\s+)?group	# @group .. @end group: ditto
	 |page			# @page: ditto
	 |node			# @node: useful only in .info file
	)\b/x and next;
    
    chomp;

    # Look for filename and title markers.
    /^\@setfilename\s+([^.]+)/ and $fn = $1, next;
    /^\@settitle\s+([^.]+)/ and $tl = $1, next;

    # Look for blocks surrounded by @c man begin SECTION ... @c man end.
    # This really oughta be @ifman ... @end ifman and the like, but such
    # would require rev'ing all other Texinfo translators.
    /^\@c man begin ([A-Z]+)/ and $sect = $1, $output = 1, next;
    /^\@c man end/ and do {
	$sects{$sect} = "" unless exists $sects{$sect};
	$sects{$sect} .= postprocess($section);
	$section = "";
	$output = 0;
	next;
    };
    next unless $output;

    # Discard comments.  (Can't do it above, because then we'd never see
    # @c man lines.)
    /^\@c\b/ and next;

    # End-block handler goes up here because it needs to operate even
    # if we are skipping.
    /^\@end\s+([a-z]+)/ and do {
	# Ignore @end foo, where foo is not an operation which may
	# cause us to skip, if we are presently skipping.
	my $ended = $1;
	next if $skipping && $ended !~ /^(?:ifset|ifclear|ignore|menu)$/;

	die "\@end $ended without \@$ended at line $.\n" unless defined $endw;
	die "\@$endw ended by \@end $ended at line $.\n" unless $ended eq $endw;

	$endw = pop @endwstack;

	if ($ended =~ /^(?:ifset|ifclear|ignore|menu)$/) {
	    $skipping = pop @skstack;
	    next;
	} elsif ($ended =~ /^(?:example|smallexample)$/) {
	    $shift = "";
	    $_ = "";	# need a paragraph break
	} elsif ($ended =~ /^(?:itemize|enumerate|table)$/) {
	    $_ = "\n=back\n";
	    $ic = pop @icstack;
	} else {
	    die "unknown command \@end $ended at line $.\n";
	}
    };

    # We must handle commands which can cause skipping even while we
    # are skipping, otherwise we will not process nested conditionals
    # correctly.
    /^\@ifset\s+([a-zA-Z0-9_-]+)/ and do {
	push @endwstack, $endw;
	push @skstack, $skipping;
	$endw = "ifset";
	$skipping = 1 unless exists $defs{$1};
	next;
    };

    /^\@ifclear\s+([a-zA-Z0-9_-]+)/ and do {
	push @endwstack, $endw;
	push @skstack, $skipping;
	$endw = "ifclear";
	$skipping = 1 if exists $defs{$1};
	next;
    };

    /^\@(ignore|menu)\b/ and do {
	push @endwstack, $endw;
	push @skstack, $skipping;
	$endw = $1;
	$skipping = 1;
	next;
    };

    next if $skipping;

    # Character entities.  First the ones that can be replaced by raw text
    # or discarded outright:
    s/\@copyright\{\}/(c)/g;
    s/\@dots\{\}/.../g;
    s/\@enddots\{\}/..../g;
    s/\@([.!? ])/$1/g;
    s/\@[:-]//g;
    s/\@bullet(?:\{\})?/*/g;
    s/\@TeX\{\}/TeX/g;
    s/\@pounds\{\}/\#/g;
    s/\@minus(?:\{\})?/-/g;

    # Now the ones that have to be replaced by special escapes
    # (which will be turned back into text by unmunge())
    s/&/&amp;/g;
    s/\@\{/&lbrace;/g;
    s/\@\}/&rbrace;/g;
    s/\@\@/&at;/g;
    # POD doesn't interpret E<> inside a verbatim block.
    if ($shift eq "") {
	s/</&lt;/g;
	s/>/&gt;/g;
    } else {
	s/</&LT;/g;
	s/>/&GT;/g;
    }

    # Single line command handlers.
    /^\@set\s+([a-zA-Z0-9_-]+)\s*(.*)$/ and $defs{$1} = $2, next;
    /^\@clear\s+([a-zA-Z0-9_-]+)/ and delete $defs{$1}, next;

    /^\@section\s+(.+)$/ and $_ = "\n=head2 $1\n";
    /^\@subsection\s+(.+)$/ and $_ = "\n=head3 $1\n";

    # Block command handlers:
    /^\@itemize\s+(\@[a-z]+|\*|-)/ and do {
	push @endwstack, $endw;
	push @icstack, $ic;
	$ic = $1;
	$_ = "\n=over 4\n";
	$endw = "itemize";
    };

    /^\@enumerate(?:\s+([A-Z0-9]+))?/ and do {
	push @endwstack, $endw;
	push @icstack, $ic;
	if (defined $1) {
	    $ic = $1 . ".";
	} else {
	    $ic = "1.";
	}
	$_ = "\n=over 4\n";
	$endw = "enumerate";
    };

    /^\@table\s+(\@[a-z]+)/ and do {
	push @endwstack, $endw;
	push @icstack, $ic;
	$ic = $1;
	$ic =~ s/\@(?:samp|strong|key)/B/;
	$ic =~ s/\@(?:code|kbd)/C/;
	$ic =~ s/\@(?:dfn|var|emph|cite|i)/I/;
	$ic =~ s/\@(?:file)/F/;
	$_ = "\n=over 4\n";
	$endw = "table";
    };

    /^\@((?:small)?example)/ and do {
	push @endwstack, $endw;
	$endw = $1;
	$shift = "\t";
	$_ = "";	# need a paragraph break
    };

    /^\@itemx?\s*(.+)?$/ and do {
	if (defined $1) {
	    # Entity escapes prevent munging by the <> processing below.
	    $_ = "\n=item $ic\&LT;$1\&GT;\n";
	} else {
	    $_ = "\n=item $ic\n";
	    $ic =~ y/A-Ya-y1-8/B-Zb-z2-9/;
	}
    };

    $section .= $shift.$_."\n";
}

die "No filename or title\n" unless defined $fn && defined $tl;

$sects{NAME} = "$fn \- $tl\n";
$sects{FOOTNOTES} .= "=back\n" if exists $sects{FOOTNOTES};

for $sect (qw(NAME SYNOPSIS DESCRIPTION OPTIONS ENVIRONMENT FILES
	      BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) {
    if(exists $sects{$sect}) {
	$head = $sect;
	$head =~ s/SEEALSO/SEE ALSO/;
	print "=head1 $head\n\n";
	print scalar unmunge ($sects{$sect});
	print "\n";
    }
}

sub usage
{
    die "usage: $0 [-D toggle...] [infile [outfile]]\n";
}

sub postprocess
{
    local $_ = $_[0];

    # @value{foo} is replaced by whatever 'foo' is defined as.
    s/\@value\{([a-zA-Z0-9_-]+)\}/$defs{$1}/g;

    # Formatting commands.
    s/\@(?:dfn|var|emph|cite|i)\{([^\}]*)\}/I<$1>/g;
    s/\@(?:code|kbd)\{([^\}]*)\}/C<$1>/g;
    s/\@(?:samp|strong|key|b)\{([^\}]*)\}/B<$1>/g;
    s/\@sc\{([^\}]*)\}/\U$1/g;
    s/\@file\{([^\}]*)\}/F<$1>/g;
    s/\@w\{([^\}]*)\}/S<$1>/g;
    s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;

    # Cross references are thrown away, as are @noindent and @refill.
    # (@noindent is impossible in .pod, and @refill is unnecessary.)
    # @* is also impossible in .pod; we discard it and any newline that
    # follows it.

    s/\@xref\{(?:[^\}]*)\}[^.]*.//g;
    s/\s+\(\@pxref\{(?:[^\}]*)\}\)//g;
    s/;\s+\@pxref\{(?:[^\}]*)\}//g;
    s/\@noindent\s*//g;
    s/\@refill//g;
    s/\@\*\s*\n?//g;

    # @uref can take one, two, or three arguments, with different
    # semantics each time.  @url and @email are just like @uref with
    # one argument, for our purposes.
    s/\@(?:uref|url|email)\{([^\},]*)\}/&lt;C<$1>&gt;/g;
    s/\@uref\{([^\},]*),([^\},]*)\}/$2 (C<$1>)/g;
    s/\@uref\{([^\},]*),([^\},]*),([^\},]*)\}/$3/g;

    # Turn B<blah I<blah> blah> into B<blah> I<blah> B<blah> to
    # match Texinfo semantics of @emph inside @samp.
    s/&LT;/</g;
    s/&GT;/>/g;
    1 while (s/B<([^<>]*)I<([^>]+)>/B<$1>I<$2>B</g);
    1 while (s/I<([^<>]*)B<([^>]+)>/I<$1>B<$2>I</g);
    s/[BI]<>//g;
    s/([BI])<(\s+)([^>]+)>/$2$1<$3>/g;
    s/([BI])<([^>]+?)(\s+)>/$1<$2>$3/g;

    # Extract footnotes.  This has to be done after all other
    # processing because otherwise the regexp will choke on formatting
    # inside @footnote.
    while (/\@footnote/g) {
	s/\@footnote\{([^\}]+)\}/[$fnno]/;
	add_footnote($1, $fnno);
	$fnno++;
    }

    return $_;
}

sub unmunge
{
    # Replace escaped symbols with their equivalents.
    local $_ = $_[0];

    s/&lt;/E<lt>/g;
    s/&gt;/E<gt>/g;
    s/&lbrace;/\{/g;
    s/&rbrace;/\}/g;
    s/&at;/\@/g;
    s/&amp;/&/g;
    return $_;
}

sub add_footnote
{
    unless (exists $sects{FOOTNOTES}) {
	$sects{FOOTNOTES} = "\n=over 4\n\n";
    }

    $sects{FOOTNOTES} .= "=item $fnno.\n\n"; $fnno++;
    $sects{FOOTNOTES} .= $_[0];
    $sects{FOOTNOTES} .= "\n\n";
}
Commit	Line	Data
6251188c ZW	1	#! /usr/bin/perl -w
	2
	3	# This does trivial (and I mean _trivial_) conversion of Texinfo
	4	# markup to Perl POD format. It's intended to be used to extract
	5	# something suitable for a manpage from a Texinfo document.
	6
6251188c	7	$output = 0;
3d6f4d76	8	$skipping = 0;
6251188c ZW	9	%sects = ();
	10	$section = "";
	11	@icstack = ();
	12	@endwstack = ();
3d6f4d76	13	@skstack = ();
6251188c	14	$shift = "";
3d6f4d76	15	%defs = ();
b75d998f	16	$fnno = 1;
6251188c	17
b75d998f	18	while ($_ = shift) {
3d6f4d76 ZW	19	if (/^-D(.*)$/) {
	20	if ($1 ne "") {
	21	$flag = $1;
	22	} else {
	23	$flag = shift;
	24	}
	25	die "no flag specified for -D\n"
	26	unless $flag ne "";
	27	die "flags may only contain letters, digits, hyphens, and underscores\n"
	28	unless $flag =~ /^[a-zA-Z0-9_-]+$/;
	29	$defs{$flag} = "";
	30	} elsif (/^-/) {
	31	usage();
	32	} else {
	33	$in = $_, next unless defined $in;
	34	$out = $_, next unless defined $out;
	35	usage();
	36	}
	37	}
	38
	39	if (defined $in) {
	40	open(STDIN, $in) or die "opening \"$in\": $!\n";
	41	}
	42	if (defined $out) {
	43	open(STDOUT, ">$out") or die "opening \"$out\": $!\n";
	44	}
	45
	46	while(<STDIN>)
6251188c	47	{
b75d998f ZW	48	# Certain commands are discarded without further processing.
	49	/^\@(?:
	50	[a-z]+index # @*index: useful only in complete manual
	51	\|need # @need: useful only in printed manual
	52	\|(?:end\s+)?group # @group .. @end group: ditto
	53	\|page # @page: ditto
	54	\|node # @node: useful only in .info file
	55	)\b/x and next;
	56
6251188c	57	chomp;
b75d998f ZW	58
	59	# Look for filename and title markers.
	60	/^\@setfilename\s+([^.]+)/ and $fn = $1, next;
	61	/^\@settitle\s+([^.]+)/ and $tl = $1, next;
	62
	63	# Look for blocks surrounded by @c man begin SECTION ... @c man end.
	64	# This really oughta be @ifman ... @end ifman and the like, but such
	65	# would require rev'ing all other Texinfo translators.
6251188c ZW	66	/^\@c man begin ([A-Z]+)/ and $sect = $1, $output = 1, next;
6251188c ZW	67	/^\@c man end/ and do {
f4e8dec6 ZW	68	$sects{$sect} = "" unless exists $sects{$sect};
f4e8dec6 ZW	69	$sects{$sect} .= postprocess($section);
6251188c ZW	70	$section = "";
	71	$output = 0;
	72	next;
	73	};
b75d998f	74	next unless $output;
3d6f4d76	75
b75d998f ZW	76	# Discard comments. (Can't do it above, because then we'd never see
	77	# @c man lines.)
	78	/^\@c\b/ and next;
6251188c	79
b75d998f ZW	80	# End-block handler goes up here because it needs to operate even
	81	# if we are skipping.
	82	/^\@end\s+([a-z]+)/ and do {
f4e8dec6 ZW	83	# Ignore @end foo, where foo is not an operation which may
	84	# cause us to skip, if we are presently skipping.
	85	my $ended = $1;
	86	next if $skipping && $ended !~ /^(?:ifset\|ifclear\|ignore\|menu)$/;
	87
	88	die "\@end $ended without \@$ended at line $.\n" unless defined $endw;
	89	die "\@$endw ended by \@end $ended at line $.\n" unless $ended eq $endw;
6251188c	90
b75d998f	91	$endw = pop @endwstack;
6251188c	92
f4e8dec6	93	if ($ended =~ /^(?:ifset\|ifclear\|ignore\|menu)$/) {
b75d998f ZW	94	$skipping = pop @skstack;
b75d998f ZW	95	next;
f4e8dec6 ZW	96	} elsif ($ended =~ /^(?:example\|smallexample)$/) {
	97	$shift = "";
	98	$_ = ""; # need a paragraph break
	99	} elsif ($ended =~ /^(?:itemize\|enumerate\|table)$/) {
b75d998f ZW	100	$_ = "\n=back\n";
b75d998f ZW	101	$ic = pop @icstack;
f4e8dec6 ZW	102	} else {
f4e8dec6 ZW	103	die "unknown command \@end $ended at line $.\n";
3d6f4d76 ZW	104	}
3d6f4d76 ZW	105	};
f4e8dec6 ZW	106
	107	# We must handle commands which can cause skipping even while we
	108	# are skipping, otherwise we will not process nested conditionals
	109	# correctly.
	110	/^\@ifset\s+([a-zA-Z0-9_-]+)/ and do {
	111	push @endwstack, $endw;
	112	push @skstack, $skipping;
	113	$endw = "ifset";
	114	$skipping = 1 unless exists $defs{$1};
	115	next;
	116	};
	117
	118	/^\@ifclear\s+([a-zA-Z0-9_-]+)/ and do {
	119	push @endwstack, $endw;
	120	push @skstack, $skipping;
	121	$endw = "ifclear";
	122	$skipping = 1 if exists $defs{$1};
	123	next;
	124	};
	125
	126	/^\@(ignore\|menu)\b/ and do {
	127	push @endwstack, $endw;
	128	push @skstack, $skipping;
	129	$endw = $1;
	130	$skipping = 1;
	131	next;
	132	};
	133
3d6f4d76 ZW	134	next if $skipping;
3d6f4d76 ZW	135
b75d998f ZW	136	# Character entities. First the ones that can be replaced by raw text
	137	# or discarded outright:
	138	s/\@copyright\{\}/(c)/g;
	139	s/\@dots\{\}/.../g;
	140	s/\@enddots\{\}/..../g;
	141	s/\@([.!? ])/$1/g;
	142	s/\@[:-]//g;
	143	s/\@bullet(?:\{\})?/*/g;
	144	s/\@TeX\{\}/TeX/g;
	145	s/\@pounds\{\}/\#/g;
	146	s/\@minus(?:\{\})?/-/g;
6251188c	147
b75d998f ZW	148	# Now the ones that have to be replaced by special escapes
	149	# (which will be turned back into text by unmunge())
	150	s/&/&/g;
	151	s/\@\{/{/g;
	152	s/\@\}/}/g;
	153	s/\@\@/&at;/g;
	154	# POD doesn't interpret E<> inside a verbatim block.
	155	if ($shift eq "") {
	156	s/</</g;
	157	s/>/>/g;
	158	} else {
	159	s/</&LT;/g;
	160	s/>/&GT;/g;
	161	}
	162
	163	# Single line command handlers.
3d6f4d76 ZW	164	/^\@set\s+([a-zA-Z0-9_-]+)\s(.)$/ and $defs{$1} = $2, next;
	165	/^\@clear\s+([a-zA-Z0-9_-]+)/ and delete $defs{$1}, next;
	166
b75d998f ZW	167	/^\@section\s+(.+)$/ and $_ = "\n=head2 $1\n";
	168	/^\@subsection\s+(.+)$/ and $_ = "\n=head3 $1\n";
	169
	170	# Block command handlers:
b75d998f	171	/^\@itemize\s+(\@[a-z]+\|\*\|-)/ and do {
6251188c ZW	172	push @endwstack, $endw;
	173	push @icstack, $ic;
	174	$ic = $1;
6251188c ZW	175	$_ = "\n=over 4\n";
	176	$endw = "itemize";
	177	};
	178
b75d998f	179	/^\@enumerate(?:\s+([A-Z0-9]+))?/ and do {
6251188c ZW	180	push @endwstack, $endw;
6251188c ZW	181	push @icstack, $ic;
b75d998f ZW	182	if (defined $1) {
	183	$ic = $1 . ".";
	184	} else {
	185	$ic = "1.";
	186	}
6251188c ZW	187	$_ = "\n=over 4\n";
	188	$endw = "enumerate";
	189	};
	190
	191	/^\@table\s+(\@[a-z]+)/ and do {
	192	push @endwstack, $endw;
	193	push @icstack, $ic;
	194	$ic = $1;
	195	$ic =~ s/\@(?:samp\|strong\|key)/B/;
	196	$ic =~ s/\@(?:code\|kbd)/C/;
b75d998f	197	$ic =~ s/\@(?:dfn\|var\|emph\|cite\|i)/I/;
6251188c ZW	198	$ic =~ s/\@(?:file)/F/;
	199	$_ = "\n=over 4\n";
	200	$endw = "table";
	201	};
	202
	203	/^\@((?:small)?example)/ and do {
	204	push @endwstack, $endw;
	205	$endw = $1;
	206	$shift = "\t";
f4e8dec6	207	$_ = ""; # need a paragraph break
6251188c ZW	208	};
6251188c ZW	209
6251188c	210	/^\@itemx?\s*(.+)?$/ and do {
b75d998f ZW	211	if (defined $1) {
	212	# Entity escapes prevent munging by the <> processing below.
	213	$_ = "\n=item $ic\&LT;$1\&GT;\n";
	214	} else {
	215	$_ = "\n=item $ic\n";
6251188c ZW	216	$ic =~ y/A-Ya-y1-8/B-Zb-z2-9/;
	217	}
	218	};
3d6f4d76	219
6251188c ZW	220	$section .= $shift.$_."\n";
	221	}
	222
b75d998f ZW	223	die "No filename or title\n" unless defined $fn && defined $tl;
b75d998f ZW	224
6251188c	225	$sects{NAME} = "$fn \- $tl\n";
b75d998f	226	$sects{FOOTNOTES} .= "=back\n" if exists $sects{FOOTNOTES};
6251188c ZW	227
6251188c ZW	228	for $sect (qw(NAME SYNOPSIS DESCRIPTION OPTIONS ENVIRONMENT FILES
b75d998f ZW	229	BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) {
b75d998f ZW	230	if(exists $sects{$sect}) {
6251188c ZW	231	$head = $sect;
	232	$head =~ s/SEEALSO/SEE ALSO/;
	233	print "=head1 $head\n\n";
b75d998f	234	print scalar unmunge ($sects{$sect});
6251188c ZW	235	print "\n";
	236	}
	237	}
3d6f4d76 ZW	238
	239	sub usage
	240	{
	241	die "usage: $0 [-D toggle...] [infile [outfile]]\n";
	242	}
b75d998f ZW	243
	244	sub postprocess
	245	{
	246	local $_ = $_[0];
	247
	248	# @value{foo} is replaced by whatever 'foo' is defined as.
	249	s/\@value\{([a-zA-Z0-9_-]+)\}/$defs{$1}/g;
	250
	251	# Formatting commands.
	252	s/\@(?:dfn\|var\|emph\|cite\|i)\{([^\}]*)\}/I<$1>/g;
	253	s/\@(?:code\|kbd)\{([^\}]*)\}/C<$1>/g;
	254	s/\@(?:samp\|strong\|key\|b)\{([^\}]*)\}/B<$1>/g;
	255	s/\@sc\{([^\}]*)\}/\U$1/g;
	256	s/\@file\{([^\}]*)\}/F<$1>/g;
	257	s/\@w\{([^\}]*)\}/S<$1>/g;
	258	s/\@(?:dmn\|math)\{([^\}]*)\}/$1/g;
	259
	260	# Cross references are thrown away, as are @noindent and @refill.
	261	# (@noindent is impossible in .pod, and @refill is unnecessary.)
	262	# @* is also impossible in .pod; we discard it and any newline that
	263	# follows it.
	264
	265	s/\@xref\{(?:[^\}])\}[^.].//g;
	266	s/\s+\(\@pxref\{(?:[^\}]*)\}\)//g;
	267	s/;\s+\@pxref\{(?:[^\}]*)\}//g;
	268	s/\@noindent\s*//g;
	269	s/\@refill//g;
	270	s/\@\\s\n?//g;
	271
	272	# @uref can take one, two, or three arguments, with different
	273	# semantics each time. @url and @email are just like @uref with
	274	# one argument, for our purposes.
	275	s/\@(?:uref\|url\|email)\{([^\},]*)\}/<C<$1>>/g;
	276	s/\@uref\{([^\},]),([^\},])\}/$2 (C<$1>)/g;
	277	s/\@uref\{([^\},]),([^\},]),([^\},]*)\}/$3/g;
	278
	279	# Turn B<blah I<blah> blah> into B<blah> I<blah> B<blah> to
	280	# match Texinfo semantics of @emph inside @samp.
	281	s/&LT;/</g;
	282	s/&GT;/>/g;
	283	1 while (s/B<([^<>]*)I<([^>]+)>/B<$1>I<$2>B</g);
	284	1 while (s/I<([^<>]*)B<([^>]+)>/I<$1>B<$2>I</g);
	285	s/[BI]<>//g;
	286	s/([BI])<(\s+)([^>]+)>/$2$1<$3>/g;
	287	s/([BI])<([^>]+?)(\s+)>/$1<$2>$3/g;
	288
	289	# Extract footnotes. This has to be done after all other
	290	# processing because otherwise the regexp will choke on formatting
	291	# inside @footnote.
	292	while (/\@footnote/g) {
	293	s/\@footnote\{([^\}]+)\}/[$fnno]/;
	294	add_footnote($1, $fnno);
	295	$fnno++;
	296	}
	297
	298	return $_;
	299	}
	300
	301	sub unmunge
	302	{
	303	# Replace escaped symbols with their equivalents.
	304	local $_ = $_[0];
	305
	306	s/</E<lt>/g;
307	s/>/E<gt>/g;
308	s/{/\{/g;
309	s/}/\}/g;
310	s/&at;/\@/g;
311	s/&/&/g;
312	return $_;
313	}
314
315	sub add_footnote
316	{
317	unless (exists $sects{FOOTNOTES}) {
318	$sects{FOOTNOTES} = "\n=over 4\n\n";
319	}
320
321	$sects{FOOTNOTES} .= "=item $fnno.\n\n"; $fnno++;
322	$sects{FOOTNOTES} .= $_[0];
323	$sects{FOOTNOTES} .= "\n\n";
324	}
325