Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??

... or how to find X<>-refs in Pod and search them in pager

Problem

Did you ever try to find the documentation of the ".." (flip-flop) operator?

typing perldoc -f .. doesn't help ...

$ perldoc -f .. No documentation for perl function `..' found
But perldocs have tags like X<..> indicating the right documentation, only the formatters are missing.

Previous discussions

  • [perldoc] keyword search or
  • So whats new about pod and X<>-tag? How to check current development?

    Approach

  • Grep core-Pods for X<TAGS>.

  • Insert marker in front of every hit.

  • Call pager (here less) with default search pattern to find those markers.

    Usage

  • type pdoc qr to find all references for qr.

  • Typing n and N will jump from marker to marker.

  • After quitting a manpage qthe next is built and displayed

    Prove of concept

    Just a hack ("release often" dogma)

    Tested for linux.

    file "pdoc"
    #!/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") }

    Cheers Rolf


    In reply to Perldoc Keyword Search (update3) by LanX

    Title:
    Use:  <p> text here (a paragraph) </p>
    and:  <code> code here </code>
    to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • Outside of code tags, you may need to use entities for some characters:
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others drinking their drinks and smoking their pipes about the Monastery: (5)
    As of 2014-09-20 05:37 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      How do you remember the number of days in each month?











      Results (153 votes), past polls