CUFP
LanX
<h3> ... or how to find X<>-refs in Pod and search them in pager</h3><P>
<h4>Problem</h4><P>
Did you ever try to find the documentation of the ".." (flip-flop) operator?<P>
typing <c>perldoc -f ..</c> doesn't help ...<P>
<c>$ perldoc -f ..
No documentation for perl function `..' found
</c>
But perldocs have tags like X<..> indicating the right documentation, only the formatters are missing.
<h4>Previous discussions</h4>
<li> [id://786762] or
<li>[id://951485]<P>
<h4>Approach</h4>
<li>Grep core-Pods for [doc://perlpod#Formatting-Codes|X<TAGS>].<P><P>
<li>Insert marker in front of every hit.<P><P>
<li>Call pager (here less) with default search pattern to find those markers. <P><P>
<h4>Usage</h4>
<li> type <c>pdoc qr</c> to find all references for qr.<P><P>
<li>Typing <c>n</c> and <c>N</c> will jump from marker to marker.<P><P>
<li>After quitting a manpage <c>q</c>the next is built and displayed<P>
<h4> Prove of concept</h4><P>
Just a hack ("release often" dogma)<P>
Tested for linux.<P>
<h5>file "pdoc"</h5>
<c>
#!/usr/bin/perl
use strict;
# use Data::Dump;
my $poddir = `perldoc -l perltoc`;
chomp $poddir;
$poddir =~ s/perltoc/*/;
my $pattern = $ARGV[0];
my @pods= grep {! /perltoc/} `grep -l -F 'X<$pattern>' $poddir`;
chomp @pods;
# dd @pods;
for my $infile (@pods) {
open my $in, "<", $infile;
my $outfile = "/tmp/". (split "/",$infile)[-1];
open my $out,">", $outfile;
local $/="\n\n";
my $marker =
">>> X<$pattern> <<<"; #"MARK";
while (my $para = <$in>){
print $out "\nC<<<< $marker >>>>\n\n"
if $para =~ /X<\Q$pattern\E>/;
print $out $para;
}
close $out;
my $ret = `pod2man $outfile |nroff -man > /tmp/tmp.man`;
print system("less -p \"$marker\" /tmp/tmp.man")
}
</c><P><P>
<!-- Node text goes above. Div tags should contain sig only -->
<div class="pmsig"><div class="pmsig-708738">
<p>Cheers Rolf
</div></div>