/usr/share/doc/kildclient/html/apes01.xhtml is in kildclient-doc 3.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>E.1. The File Format</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="ape.xhtml" title="Appendix E. Writing Plugins"/><link rel="next" href="apes02.xhtml" title="E.2. A Sample Plugin"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">E.1. The File Format</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="ape.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Appendix E. Writing Plugins</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="apes02.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm5293"><div class="titlepage"><div><div><h2 class="title" style="clear: both">E.1. The File Format</h2></div></div></div><p>The plugin file is just a Perl file that is read and run by
KildClient when the plugin is loaded. This file can call KildClient's
functions to add triggers, aliases, macros or timers, to set permanent
variables, etc. It usually also defines new subroutines for use in the
triggers, etc, or to be called directly by the user.</p><p>However, the plugin file must with a header, which has a fixed
format. If the header is not in this format, the plugin will not be
recognized. The header is shown in <a class="xref" href="apes01.xhtml#fig_plugin_header" title="Figure E.1. The Plugin Header">Figure E.1, “The Plugin Header”</a>.</p><div class="figure" id="fig_plugin_header"><div class="figure-title">Figure E.1. The Plugin Header</div><div class="figure-contents"><pre class="programlisting">
package NAME;
#: Version: VERSION
#: Description: ONE LINE DESCRIPTION
#: Author: AUTHOR'S NAME (OPTIONAL)
</pre></div></div><br class="figure-break"/><p>The first line defines the plugin's name, which will be used to
refer to it later. It also starts a Perl package. All plugins define a
package, so that one plugin's functions do not interfere with other
plugin's ones.</p><p>The second line specifies the plugin's version. This is most
informative, but is also used by KildClient to ensure that only one
version of the plugin is loaded.</p><p>Next, there comes a short one-line description of the plugin.
It should be brief but descriptive, and it is shown in the output of
the <code class="function">$world->listplugin</code> function.</p><p>Finally, it is possible to inform the author of the plugin. This
line, however, is not required, but the author's name will appear in
the plugin listing if it is informed.</p><p>After that, comes the plugin code. This is just Perl code,
executed by KildClient when the plugin is loaded (with
<code class="function">do</code>).</p></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="ape.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="ape.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="apes02.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">Appendix E. Writing Plugins </td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> E.2. A Sample Plugin</td></tr></table></div></footer></body></html>
|