I've made some major updates to what was once my cobbled-together cgi script.

http://ericwilhelm.homeip.net/svn/CGI-perldoc/trunk/data/scripts/perldoc

This allows you to access the documentation for all installed modules and 
scripts via your browser (provided that you have a cgi-enabled webserver on 
your workstation.)

It also provides some other query functionality, including fetching a list of 
installed modules or scripts and listing the subroutines which are defined in 
a module (handy for rooting-out undocumented functions.)

I keep it under /var/www/cgi-bin/perldoc, so I don't consider the name to be a 
clash with the 'official' perldoc.  YOMV.

It is a work in progress, so any feedback you have would be great.

Also, if anybody knows of similar scripts, I would like to hear about them.

I'm particularly disappointed in the fact that in order to have it host it's 
own end-user documentation, the internals documentation cannot be done with 
pod.  I've adopted a feeble convention of a commented-out pod, but might be 
better off with just plain comments.

I originally wrote this to have a dynamic pod2html setup.  It also turned into 
a good way to keep multiple pages of documentation open at once (since my 
konsoles don't re-title themselves but my browser does.)

Hyperlinks should work in most cases, including builtin functions which link 
to other builtins (like grep->map.)

I wouldn't bet on security, so use at your own risk (my workstation is not on 
the public network.)  However, I have begun to move away from the backticked 
captured commands to IPC::Run (and using list-format arguments), so it is 
getting better.

Once you get it installed, fire-up your browser, go to the cgi-bin/perldoc 
page and click 'help'.

Enjoy.

--Eric
-- 
"Chess is a foolish expedient for making idle people believe 
they are doing something very clever when they are only wasting 
their time."
                                        --George Bernard Shaw

Reply via email to