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

Searching POD documentation on windoz

by NatureFocus (Scribe)
on Dec 10, 2006 at 04:06 UTC ( [id://588845]=perlquestion: print w/replies, xml ) Need Help??

NatureFocus has asked for the wisdom of the Perl Monks concerning the following question:

hi,

Is there a good way to search Perl documentation on Windoz? I use the Active State HTML files locally, but there is no search feature that I could find. The Active State online ASPN search finds stuff, but the links are many times broken. I have tried the online O'Reilly CD bookshelf (mastering Tk) search, but its links are broken. The Pod does not seem to have a search. I read somewhere about a windows help file for perl. Does it have a good search and how do you get it or make it?

What do you suggest for searching Perl documentation? I am working a lot with Tk right now chasing down events and it is slow going.

Thanks. -Eugene

================================================

Thanks for all the good suggestions. I will be exploring many of them. -Eugene

Replies are listed 'Best First'.
Re: Searching POD documentation on windoz
by ikegami (Patriarch) on Dec 10, 2006 at 04:59 UTC
    • You could use the perldoc tool that comes with Perl.
    • You could google for site:perldoc.perl.orgkeyword.
    • If you're looking for a specific man page, you could type doc://perlxxx in the Perlmonks search bar.
    • If you're looking for the documentation on a specific function, you could type doc://funcname in the Perlmonks search bar.
    • If you're looking for the documentation on a specific module, you could type mod://modname in the Perlmonks search bar.
    • If you're looking for a module, you could search on CPAN.
Re: Searching POD documentation on windoz
by liverpole (Monsignor) on Dec 10, 2006 at 04:54 UTC
    Hi NatureFocus,

    Another good option, particularly with regards to Perl/Tk, is to read the Active State documentation.

    In fact, if you've loaded ActiveState Perl on your machine, you probably have it as a local file (eg. "C:\Perl\html\index.html").

    You can get a lot of what you need from their Tk documentation (eg. "C:\Perl\html\site\lib\Tk.html">).


    s''(q.S:$/9=(T1';s;(..)(..);$..=substr+crypt($1,$2),2,3;eg;print$..$/
Re: Searching POD documentation on windoz
by EvanK (Chaplain) on Dec 10, 2006 at 04:56 UTC
    As far as online resources, I use http://perldoc.perl.org/ for the core docs, and http://search.cpan.org/ for modules.

    If you're looking for a local resource for offline use, I don't personally know of anything aside from the perldoc command.

    __________
    Build a man a fire, and he'll be warm for a day. Set a man on fire, and he'll be warm for the rest of his life.
    - Terry Pratchett

Re: Searching POD documentation on windoz
by Devanchya (Beadle) on Dec 10, 2006 at 04:29 UTC
    I use Komondo on my home machine for programming... (work it's all vi but that really isn't the point)

    With Activeperl, if it is installed properly (and if you did the exe it should be) perldoc still works from the command line.

    Simply do: start -> run -> cmd ->
    perldoc -f print

    Everything else it's internet search engines. search.cpan.org is always your friend.
    --

    Even smart people are dumb in most things...
      Somewhat off topic, but you should try the new Komodo 4 beta. I'm in your situation (vim at work, Komodo at home), and the vi keybindings in Komodo 4 are great (though incomplete).

      Hi,

      Maybe you should try Vim with perlsupport (plugin for vim: http://www.vim.org/scripts/script.php?script_id=556).

      With Vim you have variuos plugins (I recommend: perlsupport, taglist, perlcomp, minibufexpl, AutoFold, NERD_comments) that will make your life easier at writing/debbuging perl code. Screenshots here.

      Key bindings are a little bit different from usual windows editors, but once learned they'll prove very usefull if you work in a mixed environment (I work with Windows, Solaris, HPUX, Linux - and I use vim/vi on each to edit text files).

      Another big advantage is that you don't have to pay (or worse - use without paying) for Komodo or other commercial IDE.

Re: Searching POD documentation on windoz
by Util (Priest) on Dec 10, 2006 at 05:04 UTC
    1. Perldoc works on Win32 just like on Unix, but I see no index capabilities.
      perldoc Tk::Event
    2. You could download `tcgrep` from the Perl Power Tools project (which seeks to re-implement Unix in pure Perl), and use it to scan the HTML files. This is the solution I use on Windows; `tcgrep` rocks!
      tcgrep -ir TK_EVENTTYPE_ATOM C:\a\Perl\html\site\lib\Tk
    3. You could try `podgrep` from the pmtools distribution. I just now discovered this, and have not tried it yet.
Re: Searching POD documentation on windoz
by tsee (Curate) on Dec 10, 2006 at 13:26 UTC

    As an additional means of accessing the locally installed Perl documentation, I would suggest Slaven Rezic's Tk::Pod and the tkpod program that comes with it.

    Tk applications might look a little old-fashioned to most, but I found this tool to be valuable.

    Instructions:

    • Install Tk::Pod (using PPM or from CPAN using "cpan")
    • Install perlindex the same way. If installing via CPAN, you should type "cpan Text::English". (perlindex might be what you're looking for anyway.)
    • Run "perlindex -index" (wait).
    • Run "tkpod".
    • Select "Search Fulltext" from the "Search" menu.
    • Type the keyword.
    • Enjoy

    Cheers,
    Steffen

      Hi Steffen,

      I downloaded perlindex and tkpod from Active State (I am running on Windoz XP) and tried them out. perlindex -index created the indexes (at c:\ ). I tried tkpod, but the search failed because it could not find the indexes. Checking around I believe that perlindex is not recognizing windows correctly and also some config settings are not set right on my Active state perl.

      I can probably hack it up and get it to work, but I noticed on your website you have a hacked up version already. Would it be closer to what I need, or should I hack up my own?

      Thanks -Eugene

      UPDATE- I found a patched version of perlindex (CPAN bugs area) that works with Windoz. It fixes the missing Config settings and TTY device errors on windows.

      I also have tkpod mostly working except for some problems with Config again, but it looks like it will do most of what I need. Thanks

Re: Searching POD documentation on windoz
by swampyankee (Parson) on Dec 10, 2006 at 06:38 UTC

    • Use, as mentioned by util, use perldoc, and tcgrep.
    • You could use Windows find or search features.
    • You could install grep; you can find it at http://gnuwin32.sourceforge.net/
    • You could print the entire documentation tree out (it's in html), get a 3 hole punch, numerous tabs, and make yourself a set of printed documents, and spend some time building a table of contents and an index

    emc

    At that time [1909] the chief engineer was almost always the chief test pilot as well. That had the fortunate result of eliminating poor engineering early in aviation.

    —Igor Sikorsky, reported in AOPA Pilot magazine February 2003.
Re: Searching POD documentation on windoz
by converter (Priest) on Dec 10, 2006 at 16:55 UTC
Re: Searching POD documentation on windoz
by rahed (Scribe) on Dec 10, 2006 at 21:14 UTC
    Another alternative:
    Install Pod::Webserver module and start podwebserver from the command line.
    Then you can browse your docs with a web browser.
    In the address bar type http://localhost:8020.
Re: Searching POD documentation on windoz
by Popcorn Dave (Abbot) on Dec 10, 2006 at 23:48 UTC
    You say you've got the O'Reilly CD, so why not just make a folder on your HD and copy it there? That's what I did because I got sick and tired of having to remember to haul the CD between work and home. Plus it's a lot faster to search it from your HD than the CD.

    And as far as the links being broken, I've never had that problem on mine. Perhaps you should contact O'Reilly about that. Also, I believe that the new version of the Perl CD Bookshelf does not have the Tk book on it.

    Revolution. Today, 3 O'Clock. Meet behind the monkey bars.
Re: Searching POD documentation on windoz
by sgt (Deacon) on Dec 10, 2006 at 17:54 UTC

    use perldoc that comes with the perl distribution.

    on windows I find it useful to have also cygwin installed. And from the cygwin shell I use perldoc...the latest perl package is 5.8.7 but you can compile it yourself

    hth --stephan
Re: Searching POD documentation on windoz
by INSYDE (Novice) on Dec 10, 2006 at 09:06 UTC
    Yes, documentation on ActivePerl is very great :-)
Re: Searching POD documentation on windoz
by logie17 (Friar) on Dec 11, 2006 at 16:53 UTC
    I personally highly recommend that you install cygwin. Within the setup you can specify Perl to be installed. This would enable you to use perldocs.

    Cheers,
    Logan
    s;;5776?12321=10609$d=9409:12100$xx;;s;(\d*);push @_,$1;eg;map{print chr(sqrt($_))."\n"} @_;
      I personally highly recommend that you install cygwin. Within the setup you can specify Perl to be installed. This would enable you to use perldocs.

      Saying so seems to imply that you can't use perldoc unless you install cygwin('s perl), which is not true. That's not what you say and I know the difference between a sufficient and a necessary condition, but then again the particular wording conveys a sense for the latter in addition to clearly stating the former, so your claim is likely to be misleading.

        I did not intend to be misleading, just offering my personal preference. I have used both Active State and Cygwin's Perl, and I prefer the latter. To each his own.

        Cheers,
        Logan
        s;;5776?12321=10609$d=9409:12100$xx;;s;(\d*);push @_,$1;eg;map{print chr(sqrt($_))."\n"} @_;

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: perlquestion [id://588845]
Approved by ysth
Front-paged by ysth
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others contemplating the Monastery: (7)
As of 2024-04-19 07:36 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found