perldoc works fine on Windows, but the output is raw POD, which can be a little distracting while reading. I know there is an HTML sub-directory under C:\Perl, but it is annoying to have to leave the cmd window, open Windows Explorer, drill down to the HTML path, and find the module documentation.

I wrote a two-line batch file (pm.bat) which takes a module name as input, processes the perldoc output through pod2html, saves the output in a temporary file, and displays the output as a web page. The (pm.bat) batch file is shown below:

@echo off
perldoc -m %* | pod2html > \tmp\perldoc_temp.htm & \tmp\perldoc_temp.h
+tm & del pod2htmd.tmp pod2htmi.tmp

[download]

Example: pm File::Find

[download]

I tried creating a similar batch file to display functions, but the batch file processor does NOT like the "-f" in perldoc -f ..., so I'm off to search batch file documentation to see if there is a workaround. Meanwhile, (pm.bat) is working great for displaying module documentation in HTML format.

Update

My bad, it was not the batch file objecting to "-f". perldoc displays function help as plain text, not POD, so it is not a candidate to run through pod2html.

"Its not how hard you work, its how much you get done."

In reply to Better perldoc on Windows by roho

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!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • 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, details, 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, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            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.