Debian Codegraph @

perldoc/README

raw
1 kio_perldoc - A KIO worker interface to the embedded Perl documentation.
2
3 It requires Perl 5.10 and the perl standard perldoc program to be installed.
4
5 Also required is the Switch module (emulates the Perl 6 switch feature in Perl 6). It
6 looks to me like it's also included with Perl 5.8, but if this doesn't work, try that
7 first.
8
9 It uses a stripped-down version of the Pod::HtmlEasy module from CPAN, by M. P.
10 Graciliano and Geoffrey Leach. (Specifically, the 0.9 version)
11
12 Installing:
13 This KIO worker is for KF KIO 5, and it requires CMake to build. Installing is
14 about as easy as:
15
16 $ cmake . -DCMAKE_INSTALL_PREFIX=/opt/kf5 (Replace /opt/kf5 with your KF5 prefix)
17 $ make && make install (or sudo make install as appropriate)
18
19 Usage:
20 In konq: perldoc:/functions/foo to get the perldoc info for the given perl function
21 (as if you ran perldoc -f foo).
22
23 or, perldoc:/faq/search_terms to search perlfaq* for the given search terms, and display
24 all the matches. (like perldoc -q foo)
25
26 Finally, perldoc:/foo will show the perldoc results just as if you ran perldoc foo.
27 Both module names (i.e. Test::More) and pod pages (i.e. perl58delta) work.
28
29 TODO:
30 * If a faq or function is not found you currently just get a very empty page.
31 * Probably not quite up to par for translators. :(
32 * Looks like perl.com, it should look like kde.org, however the CSS can be changed
33 fairly easily so this may be easy to fix.
34
35 - Michael Pyne <[email protected]>