Bug 50628 - would like perldoc IO Slave
Summary: would like perldoc IO Slave
Status: RESOLVED FIXED
Alias: None
Product: kio
Classification: Frameworks and Libraries
Component: general (show other bugs)
Version: unspecified
Platform: Compiled Sources All
: NOR wishlist
Target Milestone: ---
Assignee: Michael Pyne
URL:
Keywords:
: 70540 84324 (view as bug list)
Depends on:
Blocks:
 
Reported: 2002-11-13 01:21 UTC by mark
Modified: 2008-08-01 23:33 UTC (History)
3 users (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description mark 2002-11-13 01:21:39 UTC
Version:            (using KDE Devel)
Installed from:    Compiled sources
OS:          FreeBSD

I like using Konqueror to browse system documentation using the "man:/" IO Slave. I would like to be able to browse the Perl documentation on the system like as well. I usually access this through "perldoc" on the command line, and the information is stored in POD format, so a new IO Slave for this might be named "pod:/" or "perldoc:/". This might be really easy since "pod2man" is a standard tool. You could run the perl documentation through "pod2man" and then recycle the "man:/" IO Slave.
Comment 1 mark 2004-05-16 17:13:03 UTC
I suppose this bug could technically be marked as "Resolved" because this has been implemented in KDE 3.2.2.

However, if it is, I'll be tempted to open a new bug report about /how well/ it works. :)

- If the 'perldoc' command is not installed, a white screen is shown instead of a useful message that it needs to be installed. 

- "perldoc:/" should do something useful by default, it doesn't for me. I get an error: "Can't enter folder /". This gives me no clue how to address the issue. 

- Using the IO slave on a known-to-exist module doesn't work for me:
"perldoc:/Fatal" returns "The only existing directories are functions and faq". 

- Based on that message, you might think these syntaxes would return some result, but they don't:
"perldoc:/faq/" or "perldoc:/functions/"

- The only variation that worked for me was this, and I had to guess at the syntax: 
perldoc:/functions/push

- Even when a result comes up, the results are not formatted. The function name, arguments and description are all run together. Looking at the page source, I see that a simple "blockquote" is used.  It should be quite easy to generate some nicely formatted HTML. This would work for the above case:

perldoc -uf push | pod2html

That just passes the unformatted POD to an HTML formatter. 

I'm glad to see some progress has been made here and I look forward to a higher quality implementation of it. 
Comment 2 George Staikos 2004-07-24 20:21:51 UTC
*** Bug 84324 has been marked as a duplicate of this bug. ***
Comment 3 George Staikos 2004-07-24 20:22:14 UTC
*** Bug 70540 has been marked as a duplicate of this bug. ***
Comment 4 Nicolas Goutte 2005-06-11 12:42:08 UTC
To comment #1: where is the KIO slave?

As for supporting by the standard way, it means supporting the man output given by the corresponding Perl tool (which perldoc uses). However there is a problem supporting this man output with the current man: KIO slave.

Have a nice day!
Comment 5 Rafał Rzepecki 2007-03-26 13:29:35 UTC
*** This bug has been confirmed by popular vote. ***
Comment 6 Michael Pyne 2008-06-17 00:07:46 UTC
I have imported the Perldoc ioslave I wrote back in December into playground/ioslaves.  Once I have moved it to kdesdk (probably when the 4.2 window opens) I will close this bug but until then this is probably what you want...
Comment 7 Michael Pyne 2008-08-01 23:33:46 UTC
kio_perldoc is available from kdesdk, and will be released with KDE 4.2.