This program is a KIOSlave to read the documentation included with Perl in Konqueror, or any other program that supports KIO.
You can see a screenshot of Konqueror viewing documentation using kio_perldoc.
Requirements
kio_perldoc has both KDE 3 and KDE 4 versions, although the KDE 4 version is most up to date. Either way the requirements are fairly light:
- Perl version 5.8 or later is required. The actual script which produces the HTML output you receive is a Perl script, which is based on a program called Pod::HtmlEasy by M. P. Graciliano and Geoffrey Leach. The version included with kio_perldoc was modified from 0.9 with some fixes applied. Pod::HtmlEasy has been updated in the interim, it may be interesting for someone to integrate those changes back or better yet help Mr. Leach make the script directly usable without changes. ;)
- In addition you actually have to have the Perl documentation installed and accessible from the "perldoc" program. perldoc itself is also required as it finds the correct documentation page for kio_perldoc to read.
- Of course you'll need the C++ development framework that was required to build whichever of the KDE 3 or 4 version that you're building.
- Both the KDE 3 and KDE 4 versions of kio_perldoc require CMake to be installed to handle configuration and building. KDE 4 itself requires CMake but you may need to install it separately if you are using KDE 3. Version 2.4 should be sufficient.
How to install
- Download the applicable version.
- Unpack it somewhere convenient and change to that directory.
- Run cmake. Make sure to pass -DCMAKE_INSTALL_PREFIX=/path/to/prefix if you want to install it somewhere special. If in doubt use -DCMAKE_INSTALL_PREFIX=${KDEDIRS}.
- Run make.
- If it built successfuly then run make install. You may have to use sudo if administrator privileges are needed to install to where you want to install to.
- In theory you should now be able to run konqueror and type something like: perldoc:CGI in the address bar.
Using the software
There are three different ways to use the software:
- Lookup function documentation (as if you were doing perldoc -f) by using a URL of the form perldoc:/functions/funcname.
- Lookup FAQ data (as if you were doing perldoc -q) by using a URL of the form perldoc:/faq/search terms.
- Lookup documentation on a perl programming page (such as perldata) or a module's documentation by using perldoc:module or page name.
Example: To bring up the documentation for the perlre page, just use perldoc:perlre.
Downloading
Time to grab the software:
KDE 3 version: Current version: kio_perldoc 0.8.1
(20.9 K)
KDE 4 version: Current version: kio_perldoc 0.9.1
(22.0 K) (Digitally signed View public key)