aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Irssi/Channel.pod
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Irssi/Channel.pod')
-rw-r--r--docs/Irssi/Channel.pod67
1 files changed, 37 insertions, 30 deletions
diff --git a/docs/Irssi/Channel.pod b/docs/Irssi/Channel.pod
index bb6789d..baeff6c 100644
--- a/docs/Irssi/Channel.pod
+++ b/docs/Irssi/Channel.pod
@@ -6,7 +6,8 @@ Irssi::Channel
=head1 FIELDS
-Channel->{}
+C<Channel-E<gt>{}>
+
type - "CHANNEL" text
chat_type - String ID of chat protocol, for example "IRC"
@@ -35,45 +36,51 @@ Channel->{}
-Server::channels_join(channels, automatic)
- Join to channels in server. `channels' may also contain keys for
- channels just like with /JOIN command. `automatic' specifies if this
- channel was joined "automatically" or if it was joined because join
- was requested by user. If channel join is "automatic", irssi doesn't
- jump to the window where the channel was joined.
+=head2 C<channels_join(channels, automatic)>
+
+Join to channels in server. `channels' may also contain keys for
+channels just like with /JOIN command. `automatic' specifies if this
+channel was joined "automatically" or if it was joined because join
+was requested by user. If channel join is "automatic", irssi doesn't
+jump to the window where the channel was joined.
+
+=head2 C<destroy>
+
+Destroy channel.
+
+=head2 C<bans>
+
+Return a list of bans in channel.
+
+=head2 C<ban_get_mask $nick>
+
+Get ban mask for `nick'.
+
+=head2 C<banlist_add $ban, $nick, $time>
+
+Add a new ban to channel.
+=head2 C<banlist_remove $ban>
-Channel::destroy()
- Destroy channel.
+Remove a ban from channel.
-Channel::bans()
- Return a list of bans in channel.
+=head2 C<nick_insert $nick, $op, $voice, $send_massjoin>
-Channel::ban_get_mask(nick)
- Get ban mask for `nick'.
+Add nick to nicklist. Returns a L<Irssi::Nick>.
-Channel::banlist_add(ban, nick, time)
- Add a new ban to channel.
+=head2 C<nick_remove $nick>
-Channel::banlist_remove(ban)
- Remove a ban from channel.
+Remove nick from nicklist.
+=head2 C<nick_find $nick>
-Nick
-Channel::nick_insert(nick, op, voice, send_massjoin)
- Add nick to nicklist.
+Find nick from nicklist. Returns L<Irssi::Nick>.
-Channel::nick_remove(nick)
- Remove nick from nicklist.
+=head2 C<nick_find_mask $mask>
-Nick
-Channel::nick_find(nick)
- Find nick from nicklist.
+Find nick mask from nicklist, wildcards allowed. Returns L<Irssi::Nick>.
-Nick
-Channel::nick_find_mask(mask)
- Find nick mask from nicklist, wildcards allowed.
+=head2 C<nicks>
-Channel::nicks()
- Return a list of all nicks in channel.
+Return a list of all nicks in channel.