in reply to Getting man-page info on metacpan and search.cpan.org

MORE-DOCUMENTATION of https://metacpan.org/pod/LWP -> lwp-dump

Just remember, the file name should be unique and match the =head1 NAME, as widget/widget will either find https://metacpan.org/pod/distribution/Tcl-pTk/widgetTclpTk or https://metacpan.org/pod/distribution/Tk/demos/widget based on which was uploaded last

  • Comment on Re: Getting man-page info on metacpan and search.cpan.org

Replies are listed 'Best First'.
Re^2: Getting man-page info on metacpan and search.cpan.org
by rockyb (Scribe) on May 31, 2016 at 02:40 UTC

    Thanks. It took me a while to understand you because of the HTML escaping in the link. I went to that URL, and yes I see a nice link to a man page. (BTW, the first link in that section, to lwp-request, is broken).

    So that answers part of the question. However lwp-dump puts its POD inside the script and I'd like to have that be separate, because it may be shared/duplicated in a github wiki. So my thought was to create in the same directory the something like lwp-dump.pod.

    Again I'll make a little test, and make sure to follow your guidelines and follow the format of lwp-dump.

      (BTW, the first link in that section, to lwp-request, is broken).

      I'm guessing, but probably because it is created at when you run Makefile.PL , so if you install LWP, the link will work, just not on CPAN

      update: well I checked, its a typo in the NAME section of https://metacpan.org/pod/distribution/libwww-perl/bin/lwp-request, must use dash, convention is  NAME - description so it should be

      lwp-request - GET, POST, HEAD - Simple command line user agent

      This is also a bug in PAUSE/CPAN indexer, most folks figure out the right formatting, but it should warn the rest when =head1 NAME doesn't match NAME - description because its used for resolving links

      It took me a while to understand you because of the HTML escaping in the link.

      Aww :) I usually double check ... metamod:// should be smarter and save me when I typo :) https://metacpan.org/pod/LWP#MORE-DOCUMENTATION