/usr/share/doc/kildclient/html/ch13s02.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 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>13.2. Getting Information About Plugins</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="ch13s01.xhtml" title="13.1. Loading Plugins from the Command Line"/><link rel="next" href="ch13s03.xhtml" title="13.3. Standard Plugins"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">13.2. Getting Information About Plugins</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="ch13s01.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 13. Plugins</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="ch13s03.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm2450"><div class="titlepage"><div><div><h2 class="title" style="clear: both">13.2. Getting Information About Plugins</h2></div></div></div><p>All plugins should contain a <code class="function">help</code> function
that, when called, prints information about the plugin. If you want to
get help on a plugin, call its <code class="function">help</code> function. The
example below shows how to call the <code class="function">help</code> of the
<code class="literal">keypad</code> sec_plugin_</p><div class="example" id="idm2458"><div class="example-title">Example 13.3. Getting help about a plugin</div><div class="example-contents"><pre class="programlisting">
keypad::help()
</pre></div></div><br class="example-break"/><p>Note that the name of the function is prefixed with the name of
the plugin and <code class="literal">::</code>. This is a convention so that one
plugin's functions do not interfere with other plugins' ones.</p><p>It is possible to get a list of all the currently loaded plugins
with the <code class="function">$world->listplugin</code> function. If called
without arguments, it lists briefly all loaded plugins. But you can
pass as argument either a plugin number or a plugin name, and it will
give more detailed information about that plugin, including a listing
of the triggers, aliases, macros and timers that the plugin defines
(if any).</p></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="ch13s01.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="chap_plugins.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="ch13s03.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">13.1. Loading Plugins from the Command Line </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; "> 13.3. Standard Plugins</td></tr></table></div></footer></body></html>
|