Re: Perldoc on the web

James Taylor wrote:

> Well, I've recently discovered http://perldoc.perl.org/ from
> which I have been able to download a complete HTML-ised and
> locally browsable copy of the docs. Sincere thanks to Jon Allen!
>
> However, this still doesn't offer a way for me, or anyone else in
> my situation, to follow the perldoc references so commonly given
> in this group as there's no way to translate "perldoc -q whatever"
> into the precise document that this command locates.

It's really not that hard to figure out and remember the pattern.
There are four basic styles to a `perldoc` command:
1) a straight manpage:
perldoc perlrun
becomes
http://perldoc.perl.org/perlrun.html

2) a specific function name:
perldoc -f push:
tells you to look at perlfunc, at the section on "push", or on the
specific push page:
http://perldoc.perl/org/perlfunc.html
http://perldoc.perl.org/functions/push.html

3) a keyword from the FAQ:
perldoc -q quoting:
means to look through the overal list of FAQ questions for that
keyword, and then follow the link to the correct FAQ page:
http://perldoc.perl.org/perlfaq.html
searching for 'quoting' above takes you to:
http://perldoc.perl.org/perlfaq4.html#What's-wrong-with-always-quoting-%22%24vars%22%3f

4) a specific module's documentation:
perldoc File::Find
tells you to look at the documentation for Find in the directory File:
http://perldoc.perl.org/File/Find.html

If you can memorize those four basic patterns, you should not have
difficulty following along with the 'normal' way of directing people to
the standard documentation.

.

Relevant Pages

  • Re: perl almost an adult? [was: s/// w/o RE]
    ... I couldn't find any reference to the birthdate. ... the answer is right there in perldoc perlre!" ... No documentation for perl function `birthdate' found ... No documentation for perl FAQ keyword `birthdate' found ...
    (perl.beginners)
  • Re: seek/tell usage
    ... perldoc -f seek ... seek(FILE, $curpos, 0); ... is an infinite loop, as there is no condition telling the loop when to ... You want the documentation for seekto explain to ...
    (perl.beginners)
  • Re: perl almost an adult? [was: s/// w/o RE]
    ... the answer is right there in perldoc perlre!" ... > Isn't perl great? ... It's sometimes also usefull to grep through the perl documentation, ... For a more visual browsing experience, ...
    (perl.beginners)
  • Re: regex to convert 1000000 -> 1,000,000 ?
    ... >> is a big chunk of that documentation and pretty hard to miss, ... the whole situation is like this: Perl is like a software ... If the newbie is an idiot, and uses grep not to search and then check the ... > have to first KNOW of perldoc. ...
    (comp.lang.perl.misc)
  • Re: Beginner question on @INC
    ... > familiar with the included Perl documentation. ... I admit that I had completely forgotten about the Perldoc stuff ... I have found that if I remove 5.8.0 completely and then install ...
    (comp.lang.perl.misc)