/usr/share/doc/kildclient/html/ch15s03.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 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>15.3. Chat Functions</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="ch15s02.xhtml" title="15.2. Advanced Features"/><link rel="next" href="chap_serverdata.xhtml" title="Chapter 16. Out-of-band server data"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">15.3. Chat Functions</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="ch15s02.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 15. Using the Chat</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="chap_serverdata.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm2723"><div class="titlepage"><div><div><h2 class="title" style="clear: both">15.3. Chat Functions</h2></div></div></div><p>You can also access the chat features via some Perl functions of
the chat plugin. Here is a list of these functions:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="function">chat::call(<em class="parameter"><code>host</code></em>, [<em class="parameter"><code>port</code></em>])</code></span></dt><dd><p>Tries connection to <em class="parameter"><code>host</code></em>, on
port <em class="parameter"><code>port</code></em> (or 4050, if not specified), using
the MudMaster protocol.</p></dd><dt><span class="term"><code class="function">chat::zcall(<em class="parameter"><code>host</code></em>, [<em class="parameter"><code>port</code></em>])</code></span></dt><dd><p>Tries connection to <em class="parameter"><code>host</code></em>, on
port <em class="parameter"><code>port</code></em> (or 4050, if not specified), using
the zChat protocol.</p></dd><dt><span class="term"><code class="function">chat::accept([<em class="parameter"><code>port</code></em>])</code></span></dt><dd><p>Starts listening for chat connections on the given
port (or 4050 if not specified).</p></dd><dt><span class="term"><code class="function">chat::noaccept()</code></span></dt><dd><p>Stops listening for chat
connections.</p></dd><dt><span class="term"><code class="function">chat::setname(<em class="parameter"><code>nickname</code></em>)</code></span></dt><dd><p>Sets the nickname used in chat
sessions.</p></dd><dt><span class="term"><code class="function">chat::setcolor(<em class="parameter"><code>code</code></em>)</code></span></dt><dd><p>Sets the color used in chat sessions.
<em class="parameter"><code>code</code></em> is a color code as recognized by the <a class="xref" href="func_colorize.xhtml" title="A.1. colorize"><code class="function">colorize</code></a>
function</p></dd><dt><span class="term"><code class="function">chat::chat(<em class="parameter"><code>name</code></em>, <em class="parameter"><code>text</code></em>)</code></span></dt><dd><p>Sends <em class="parameter"><code>text</code></em> to
<em class="parameter"><code>name</code></em>.</p></dd><dt><span class="term"><code class="function">chat::emote(<em class="parameter"><code>name</code></em>, <em class="parameter"><code>text</code></em>)</code></span></dt><dd><p>Sends <em class="parameter"><code>text</code></em> as an emote to
<em class="parameter"><code>name</code></em>.</p></dd><dt><span class="term"><code class="function">chat::chatall(<em class="parameter"><code>text</code></em>)</code></span></dt><dd><p>Sends <em class="parameter"><code>text</code></em> to all chat
connections.</p></dd><dt><span class="term"><code class="function">chat::emoteall(<em class="parameter"><code>text</code></em>)</code></span></dt><dd><p>Sends <em class="parameter"><code>text</code></em> as an emote to all
chat connections.</p></dd><dt><span class="term"><code class="function">chat::group(<em class="parameter"><code>name</code></em>, <em class="parameter"><code>group</code></em>)</code></span></dt><dd><p>Makes the chat connection with
<em class="parameter"><code>name</code></em> a member of the group
<em class="parameter"><code>group</code></em>.</p></dd><dt><span class="term"><code class="function">chat::chatgroup(<em class="parameter"><code>group</code></em>, <em class="parameter"><code>text</code></em>)</code></span></dt><dd><p>Sends <em class="parameter"><code>text</code></em> to all connections
that are members of the group
<em class="parameter"><code>group</code></em>.</p></dd><dt><span class="term"><code class="function">chat::emotegroup(<em class="parameter"><code>group</code></em>, <em class="parameter"><code>text</code></em>)</code></span></dt><dd><p>Sends <em class="parameter"><code>text</code></em> as an emote to all
connections that are members of the group
<em class="parameter"><code>group</code></em>.</p></dd><dt><span class="term"><code class="function">chat::ping(<em class="parameter"><code>name</code></em>)</code></span></dt><dd><p>Pings the other peer. If the connection is alive, they
will reply to this request. Additionally, the time for the reply to be
received is displayed.</p></dd><dt><span class="term"><code class="function">chat::sendfile(<em class="parameter"><code>name</code></em>, [<em class="parameter"><code>file</code></em>])</code></span></dt><dd><p>Attemps to send a file to the peer. If you do not
specify the file, a dialog will be displayed for you to select the
file to send. The file will be offered. If they accept, the file
transfer will start.</p></dd><dt><span class="term"><code class="function">chat::stopfile(<em class="parameter"><code>name</code></em>)</code></span></dt><dd><p>Stops the file transfer currently in
progress.</p></dd><dt><span class="term"><code class="function">chat::snoop(<em class="parameter"><code>name</code></em>)</code></span></dt><dd><p>Asks <em class="parameter"><code>name</code></em> if you can snoop
them, that is, see everything they see in their MUD session. If they
accept, everything they see will be sent to you and
displayed.</p></dd><dt><span class="term"><code class="function">chat::setallowsnoop(<em class="parameter"><code>name</code></em>, <em class="parameter"><code>value</code></em>)</code></span></dt><dd><p>Sets whether <em class="parameter"><code>name</code></em> can snoop you,
that is, wheter they can see everything you see in your MUD session,
according to <em class="parameter"><code>value</code></em>. By default snooping is
disabled.</p></dd><dt><span class="term"><code class="function">chat::info(<em class="parameter"><code>name</code></em>)</code></span></dt><dd><p>Shows some information about the chat
session.</p></dd><dt><span class="term"><code class="function">chat::setstripansi(<em class="parameter"><code>name</code></em>, <em class="parameter"><code>value</code></em>)</code></span></dt><dd><p>Sets whether to trip ANSI color codes in messages
received from <em class="parameter"><code>name</code></em>, according to
<em class="parameter"><code>value</code></em>. If they are, colors sent by the peer
will not be displayed, and that even incoming messages will be
displayed in your chat color.</p></dd><dt><span class="term"><code class="function">chat::hangup(<em class="parameter"><code>name</code></em>)</code></span></dt><dd><p>Stops the chat session with
<em class="parameter"><code>name</code></em>. You will need to connect again to
continue talking.</p></dd></dl></div></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="ch15s02.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="chap_chat.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="chap_serverdata.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">15.2. Advanced Features </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; "> Chapter 16. Out-of-band server data</td></tr></table></div></footer></body></html>
|