Perldoc KIOSlave

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:

How to install

  1. Download the applicable version.
  2. Unpack it somewhere convenient and change to that directory.
  3. 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}.
  4. Run make.
  5. 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.
  6. 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:

  1. Lookup function documentation (as if you were doing perldoc -f) by using a URL of the form perldoc:/functions/funcname.
  2. Lookup FAQ data (as if you were doing perldoc -q) by using a URL of the form perldoc:/faq/search terms.
  3. 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) (Digital signature iconDigitally signed View public key)