diff options
author | Tom Feist <shabble@cowu.be> | 2010-07-16 19:13:58 +0000 |
---|---|---|
committer | Tom Feist <shabble@cowu.be> | 2010-07-16 19:13:58 +0000 |
commit | 0d5275d51acf53e4fbfbffd392ae5b7ed53e8827 (patch) | |
tree | 6180e0faf288ba86389740cecfc07f7fa1e879b0 /docs/Irssi | |
parent | renamed everything to .pod since they are not actually perl modules (diff) | |
download | irssi-scripts-0d5275d51acf53e4fbfbffd392ae5b7ed53e8827.tar.gz irssi-scripts-0d5275d51acf53e4fbfbffd392ae5b7ed53e8827.zip |
hmm, apparently git didn\'t notice my renaming
Diffstat (limited to 'docs/Irssi')
30 files changed, 768 insertions, 0 deletions
diff --git a/docs/Irssi/Ban.pod b/docs/Irssi/Ban.pod new file mode 100644 index 0000000..ba8381f --- /dev/null +++ b/docs/Irssi/Ban.pod @@ -0,0 +1,15 @@ +__END__ + +=head1 NAME + +Irssi::Ban + +=head1 FIELDS + +Ban->{} + ban - The ban + setby - Nick of who set the ban + time - Timestamp when ban was set + + +=head1 METHODS diff --git a/docs/Irssi/Channel.pod b/docs/Irssi/Channel.pod new file mode 100644 index 0000000..bb6789d --- /dev/null +++ b/docs/Irssi/Channel.pod @@ -0,0 +1,79 @@ +__END__ + +=head1 NAME + +Irssi::Channel + +=head1 FIELDS + +Channel->{} + type - "CHANNEL" text + chat_type - String ID of chat protocol, for example "IRC" + + (..contains all the same data as Windowitem above..) + + topic - Channel topic + topic_by - Nick who set the topic + topic_time - Timestamp when the topic was set + + no_modes - Channel is modeless + mode - Channel mode + limit - Max. users in channel (+l mode) + key - Channel key (password) + + chanop - You are channel operator + names_got - /NAMES list has been received + wholist - /WHO list has been received + synced - Channel is fully synchronized + + joined - JOIN event for this channel has been received + left - You just left the channel (for "channel destroyed" event) + kicked - You was just kicked out of the channel (for + "channel destroyed" event) + +=head1 METHODS + + + +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. + + +Channel::destroy() + Destroy channel. + + +Channel::bans() + Return a list of bans in channel. + +Channel::ban_get_mask(nick) + Get ban mask for `nick'. + +Channel::banlist_add(ban, nick, time) + Add a new ban to channel. + +Channel::banlist_remove(ban) + Remove a ban from channel. + + +Nick +Channel::nick_insert(nick, op, voice, send_massjoin) + Add nick to nicklist. + +Channel::nick_remove(nick) + Remove nick from nicklist. + +Nick +Channel::nick_find(nick) + Find nick from nicklist. + +Nick +Channel::nick_find_mask(mask) + Find nick mask from nicklist, wildcards allowed. + +Channel::nicks() + Return a list of all nicks in channel. diff --git a/docs/Irssi/Chatnet.pod b/docs/Irssi/Chatnet.pod new file mode 100644 index 0000000..23fa134 --- /dev/null +++ b/docs/Irssi/Chatnet.pod @@ -0,0 +1,24 @@ +__END__ + +=head1 NAME + +Irssi::Chatnet + +=head1 FIELDS + +Chatnet->{} + type - "CHATNET" text + chat_type - String ID of chat protocol, for example "IRC" + + name - name of chat network + + nick - if not empty, nick preferred in this network + username - if not empty, username preferred in this network + realname - if not empty, realname preferred in this network + + own_host - address to use when connecting this network + autosendcmd - command to send after connecting to this network + + +=head1 METHODS + diff --git a/docs/Irssi/Client.pod b/docs/Irssi/Client.pod new file mode 100644 index 0000000..e07bed7 --- /dev/null +++ b/docs/Irssi/Client.pod @@ -0,0 +1,20 @@ +__END__ + +=head1 NAME + +Irssi::Client + +=head1 FIELDS +Client->{} + nick - nick of the client + host - host of the client + proxy_address - address of the proxy server + server - Irc::Server for which we proxy to this client + pass_sent - whether the client already send a PASS command + user_sent - whether the client already send a USER command + connected - whether the client is connected and ready + want_ctcp - whether the client wants to receive CTCPs + ircnet - network tag of the network we proxy + + +=head1 METHODS diff --git a/docs/Irssi/Command.pod b/docs/Irssi/Command.pod new file mode 100644 index 0000000..d777794 --- /dev/null +++ b/docs/Irssi/Command.pod @@ -0,0 +1,12 @@ +__END__ + +=head1 NAME + +=head1 FIELDS + + Command->{} + cmd - Command name + category - Category + +=head1 METHODS + diff --git a/docs/Irssi/Dcc.pod b/docs/Irssi/Dcc.pod new file mode 100644 index 0000000..546f112 --- /dev/null +++ b/docs/Irssi/Dcc.pod @@ -0,0 +1,65 @@ +__END__ + +=head1 NAME + +Irssi::Dcc + +=head1 FIELDS + +Dcc->{} + type - Type of the DCC: chat, send, get + orig_type - Original DCC type that was sent to us - same as type except + GET and SEND are swapped + created - Time stamp when the DCC record was created + + server - Server record where the DCC was initiated. + servertag - Tag of the server where the DCC was initiated. + mynick - Our nick to use in DCC chat. + nick - Other side's nick name. + + chat - Dcc chat record if the request came through DCC chat + target - Who the request was sent to - your nick, channel or empty + if you sent the request + arg - Given argument .. file name usually + + addr - Other side's IP address. + port - Port we're connecting in. + + starttime - Unix time stamp when the DCC transfer was started + transfd - Bytes transferred + +Dcc::Chat->{} + id - Unique identifier - usually same as nick + mirc_ctcp - Send CTCPs without the CTCP_MESSAGE prefix + connection_lost - Other side closed connection + +Dcc::Get->{} + (..contains all the same data as core Dcc object..) + size - File size + skipped - Bytes skipped from start (resuming file) + + get_type - What to do if file exists? 0=default, 1=rename, 2=overwrite, + 3=resume + file - The real file name which we use. + file_quoted - 1 if file name was received quoted ("file name") + +Dcc::Send->{} + (..contains all the same data as core Dcc object..) + size - File size + skipped - Bytes skipped from start (resuming file) + + file_quoted - 1 if file name was received quoted ("file name") + waitforend - File is sent, just wait for the replies from the other side + gotalldata - Got all acks from the other end + + +=head1 METHODS + +Dcc::destroy() + Destroy DCC connection. + +Dcc::chat_send(data) + Send `data' to dcc chat. + +Dcc::ctcp_message(target, notice, msg) + Send a CTCP message/notify to target. diff --git a/docs/Irssi/Ignore.pod b/docs/Irssi/Ignore.pod new file mode 100644 index 0000000..108c0ba --- /dev/null +++ b/docs/Irssi/Ignore.pod @@ -0,0 +1,22 @@ +__END__ + +=head1 NAME + +Irssi::Ignore + +=head1 FIELDS + +Ignore->{} + mask - Ignore mask + servertag - Ignore only in server + channels - Ignore only in channels (list of names) + pattern - Ignore text pattern + + level - Ignore level + + exception - This is an exception ignore + regexp - Regexp pattern matching + fullword - Pattern matches only full words + +=head1 METHODS + diff --git a/docs/Irssi/Log.pod b/docs/Irssi/Log.pod new file mode 100644 index 0000000..673a183 --- /dev/null +++ b/docs/Irssi/Log.pod @@ -0,0 +1,46 @@ +__END__ + +=head1 NAME + +Irssi::Log + +=head1 FIELDS + +Log->{} + fname - Log file name + real_fname - The actual opened log file (after %d.%m.Y etc. are expanded) + opened - Log file is open + level - Log only these levels + last - Timestamp when last message was written + autoopen - Automatically open log at startup + failed - Opening log failed last time + temp - Log isn't saved to config file + items - List of log items + + +=head1 METHODS + + +Log::update() + Add log to list of logs / save changes to config file. + + +Log::close() + Destroy log file. + +Log::start_logging() + Open log file and start logging. + +Log::stop_logging() + Close log file. + +Log::item_add(type, name, server) + Add log item to log. + +Log::item_destroy(item) + Remove log item from log. + + +Logitem +Log::item_find(type, item, server) + Find item from log. diff --git a/docs/Irssi/Logitem.pod b/docs/Irssi/Logitem.pod new file mode 100644 index 0000000..6db0c7b --- /dev/null +++ b/docs/Irssi/Logitem.pod @@ -0,0 +1,16 @@ +__END__ + +=head1 NAME + +Irssi::Logitem + +=head1 FIELDS + +Logitem->{} + type - 0=target, 1=window refnum + name - Name + servertag - Server tag + + +=head1 METHODS + diff --git a/docs/Irssi/Nick.pod b/docs/Irssi/Nick.pod new file mode 100644 index 0000000..b20d43a --- /dev/null +++ b/docs/Irssi/Nick.pod @@ -0,0 +1,24 @@ +__END__ + +=head1 NAME + +Irssi::Nick + +=head1 FIELDS + +Nick->{} + type - "NICK" text + chat_type - String ID of chat protocol, for example "IRC" + + nick - Plain nick + host - Host address + realname - Real name + hops - Hop count to the server the nick is using + + gone, serverop - User status, 1 or 0 + op, voice, halfop - Channel status, 1 or 0 + + last_check - timestamp when last checked gone/ircop status. + send_massjoin - Waiting to be sent in a "massjoin" signal, 1 or 0 + +=head1 METHODS diff --git a/docs/Irssi/Notifylist.pod b/docs/Irssi/Notifylist.pod new file mode 100644 index 0000000..5b2628a --- /dev/null +++ b/docs/Irssi/Notifylist.pod @@ -0,0 +1,21 @@ +__END__ + +=head1 NAME + +Irssi::Notifylist + +=head1 FIELDS + +Notifylist->{} + mask - Notify nick mask + away_check - Notify away status changes + idle_check_time - Notify when idle time is reset and idle was bigger + than this (seconds) + ircnets - List of ircnets (strings) the notify is checked + + +=head1 METHODS + +Notifylist::ircnets_match(ircnet) + Returns 1 if notify is checked in `ircnet'. + diff --git a/docs/Irssi/Process.pod b/docs/Irssi/Process.pod new file mode 100644 index 0000000..4b311a2 --- /dev/null +++ b/docs/Irssi/Process.pod @@ -0,0 +1,22 @@ +__END__ + +=head1 NAME + +Irssi::Query + +=head1 FIELDS + +Process->{} + id - ID for the process + name - Name for the process (if given) + args - The command that is being executed + + pid - PID for the executed command + target - send text with /msg <target> ... + target_win - print text to this window + + shell - start the program via /bin/sh + notice - send text with /notice, not /msg if target is set + silent - don't print "process exited with level xx" + +=head1 METHODS diff --git a/docs/Irssi/Query.pod b/docs/Irssi/Query.pod new file mode 100644 index 0000000..c823a4a --- /dev/null +++ b/docs/Irssi/Query.pod @@ -0,0 +1,28 @@ +__END__ + +=head1 NAME + +Irssi::Query + +=head1 FIELDS + +Query->{} + type - "QUERY" text + chat_type - String ID of chat protocol, for example "IRC" + + (..contains all the same data as Windowitem above..) + + address - Host address of the queries nick + server_tag - Server tag used for this nick (doesn't get erased if + server gets disconnected) + unwanted - 1 if the other side closed or some error occured (DCC chats) + + +=head1 METHODS + +Query::destroy() + Destroy the query. + +Query::query_change_server(server) + Change the active server of the query. + diff --git a/docs/Irssi/Rawlog.pod b/docs/Irssi/Rawlog.pod new file mode 100644 index 0000000..7f89c64 --- /dev/null +++ b/docs/Irssi/Rawlog.pod @@ -0,0 +1,40 @@ +__END__ + +=head1 NAME + +Irssi::Rawlog + +=head1 FIELDS + + +Rawlog->{} + logging - The rawlog is being written to file currently + nlines - Number of lines in rawlog + +=head1 METHODS + + +Rawlog::destroy() + Destroy the rawlog. + +Rawlog::get_lines() + Returns all lines in rawlog. + +Rawlog::open(filename) + Start logging new messages in rawlog to specified file. + +Rawlog::close() + Stop logging to file. + +Rawlog::save(filename) + Save the current rawlog history to specified file. + +Rawlog::input(str) + Send `str' to raw log as input text. + +Rawlog::output(str) + Send `str' to raw log as output text. + +Rawlog::redirect(str) + Send `str' to raw log as redirection text. + diff --git a/docs/Irssi/Reconnect.pod b/docs/Irssi/Reconnect.pod new file mode 100644 index 0000000..4085eec --- /dev/null +++ b/docs/Irssi/Reconnect.pod @@ -0,0 +1,20 @@ +__END__ + +=head1 NAME + +Irssi::Reconnect + +=head1 FIELDS + +Reconnect->{} + type - "RECONNECT" text + chat_type - String ID of chat protocol, for example "IRC" + + (..contains all the same data as Connect above..) + + tag - Unique numeric tag + next_connect - Unix time stamp when the next connection occurs + + +=head1 METHODS + diff --git a/docs/Irssi/Script.pod b/docs/Irssi/Script.pod new file mode 100644 index 0000000..9f8b07b --- /dev/null +++ b/docs/Irssi/Script.pod @@ -0,0 +1,10 @@ +__END__ + +=head1 NAME + +Irssi::Script + +=head1 FIELDS + +=head1 METHODS + diff --git a/docs/Irssi/Server.pod b/docs/Irssi/Server.pod new file mode 100644 index 0000000..0832d97 --- /dev/null +++ b/docs/Irssi/Server.pod @@ -0,0 +1,118 @@ +__END__ + +=head1 NAME + +Irssi::Server + +=head1 FIELDS + +Server->{} + + type - "SERVER" text + chat_type - String ID of chat protocol, for example "IRC" + + (..contains all the same data as Connect above..) + + connect_time - Time when connect() to server finished + real_connect_time - Time when server sent "connected" message + + tag - Unique server tag + nick - Current nick + + connected - Is connection finished? 1|0 + connection_lost - Did we lose the connection (1) or was + the connection just /DISCONNECTed (0) + + rawlog - Rawlog object for the server + + version - Server version + last_invite - Last channel we were invited to + server_operator - Are we server operator (IRC op) 1|0 + usermode_away - Are we marked as away? 1|0 + away_reason - Away reason message + banned - Were we banned from this server? 1|0 + lag - Current lag to server in milliseconds + +=head1 METHODS + +=head2 C<channels> + +- return list of channels in server + +=head2 C<queries> + +Return list of queries in server + +=head2 C<print $channel, $str, [$level]> + +=head2 C<command $string> + +Run the specified command on this server instance. + + + +=head2 C<Connect::connect> + +B<TODO: What is C<Connect::> package?> + +Connect to server. returns L<Irssi::Server> object. + +=head2 C<disconnect> + +Disconnect from server. + +=head2 C<server_find_tag $tag> + +Find server with tag. Returns L<Irssi::Server> + + +=head2 C<server_find_chatnet $chatnet> + +Find first server that is in `chatnet' +returns L<Irssi::Server> + +=head2 C<isnickflag $flag> + +Returns 1 if flag is a nick mode flag (C<@>, C<+> or C<%> in IRC) + +=head2 C<ischannel $data> + +Returns 1 if start of `data' seems to mean channel. + +=head2 C<get_nick_flags> + +Returns nick flag characters in order: op, voice, halfop (C<"@+%"> in IRC). + +=head2 C<send_message $target, $msg, $target_type> + +Sends a message to nick/channel. target_type 0 = channel, 1 = nick + +=head2 C<netsplit_find $nick, $address> + +Check if nick!address is on the other side of netsplit. Netsplit records +are automatically removed after 30 minutes (current default).. + +returns L<Irssi::Irc::Netsplit> + +=head2 C<netsplit_find_channel $nick, $address, $channel> + +Find nick record for nick!address in channel `channel'. +returns L<Irssi::Nick> + + +=head2 C<dcc_ctcp_message $target, $notice, $msg> + +=head2 C<channel_find $channel> + +Find channel from specified server. Returns L<Irssi::Channel> + +=head2 C<ignore_check $nick, $host, $channel, $text, $level> + +Return 1 if ignoring matched. + +=head2 C<nicks_get_same $nick> + +Return all L<nick|Irssi::Nick> objects in all channels in server. +List is in format: + + Channel, Nick, Channel, ... diff --git a/docs/Irssi/TextUI.pod b/docs/Irssi/TextUI.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI.pod diff --git a/docs/Irssi/TextUI/Line.pod b/docs/Irssi/TextUI/Line.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI/Line.pod diff --git a/docs/Irssi/TextUI/LineCache.pod b/docs/Irssi/TextUI/LineCache.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI/LineCache.pod diff --git a/docs/Irssi/TextUI/LineInfo.pod b/docs/Irssi/TextUI/LineInfo.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI/LineInfo.pod diff --git a/docs/Irssi/TextUI/MainWindow.pod b/docs/Irssi/TextUI/MainWindow.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI/MainWindow.pod diff --git a/docs/Irssi/TextUI/StatusbarItem.pod b/docs/Irssi/TextUI/StatusbarItem.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI/StatusbarItem.pod diff --git a/docs/Irssi/TextUI/TextBufferView.pod b/docs/Irssi/TextUI/TextBufferView.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI/TextBufferView.pod diff --git a/docs/Irssi/TextUI/Textbuffer.pod b/docs/Irssi/TextUI/Textbuffer.pod new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/Irssi/TextUI/Textbuffer.pod diff --git a/docs/Irssi/Theme.pod b/docs/Irssi/Theme.pod new file mode 100644 index 0000000..72ab9e1 --- /dev/null +++ b/docs/Irssi/Theme.pod @@ -0,0 +1,4 @@ +__END__ + +=head1 Deprecated + diff --git a/docs/Irssi/UI/Theme.pod b/docs/Irssi/UI/Theme.pod new file mode 100644 index 0000000..56e3a3f --- /dev/null +++ b/docs/Irssi/UI/Theme.pod @@ -0,0 +1,8 @@ +=head1 NAME + +Irssi::UI::Theme + +=head1 FIELDS + +=head1 METHODS + diff --git a/docs/Irssi/UI/Window.pod b/docs/Irssi/UI/Window.pod new file mode 100644 index 0000000..a00827e --- /dev/null +++ b/docs/Irssi/UI/Window.pod @@ -0,0 +1,116 @@ +__END__ + +=head1 NAME + +Irssi::UI::Window + +=head1 FIELDS + +UI::Window->{} + refnum - Reference number + name - Name + + width - Width + height - Height + + history_name - Name of named historylist for this window + + active - Active window item + active_server - Active server + + servertag - active_server must be either undef or have this same tag + (unless there's items in this window). This is used by + /WINDOW SERVER -sticky + level - Current window level + + sticky_refnum - 1 if reference number is sticky + + data_level - Current data level + hilight_color - Current activity hilight color + + last_timestamp - Last time timestamp was written in window + last_line - Last time text was written in window + + theme_name - Active theme in window, undef = default + +UI::TextDest->{} + window - Window where the text will be written + server - Target server + target - Target channel/query/etc name + level - Text level + + hilight_priority - Priority for the hilighted text + hilight_color - Color for the hilighted text + + +=head1 METHODS + +Window::command(cmd) +Window::print(str[, level]) + + +Window::items() + Return a list of items in window. + +Window +window_create(automatic) +Windowitem::window_create(automatic) + Create a new window. + +Window::destroy() + Destroy the window. + +Irssi::Window +Windowitem::window() + Returns parent window for window item. + +Window +window_find_name(name) + Find window with name. + +Window +window_find_refnum(refnum) + Find window with reference number. + +Window +window_find_level(level) +Server::window_find_level(level) + Find window with level. + +Window +window_find_closest(name, level) +Server::window_find_closest(name, level) + Find window that matches best to given arguments. `name' can be either + window name or name of one of the window items. + +Window +window_find_item(name) +Server::window_find_item(name) + Find window which contains window item with specified name/server. + + +Window::item_add(item, automatic) +Window::item_remove(item) +Window::item_destroy(item) + Add/remove/destroy window item + +Window::set_active() + Set window active. + +Window::change_server(server) +Window::set_refnum(refnum) +Window::set_name(name) +Window::set_history(name) +Window::set_level(level) + Change server/refnum/name/history/level in window. + +Window::item_prev() +Window::item_next() + Change to previous/next window item. + + +Window::get_active_name() + Return active item's name, or if none is active, window's name + +Window::item_find(server, name) + Find window item that matches best to given arguments. diff --git a/docs/Irssi/Window.pod b/docs/Irssi/Window.pod new file mode 100644 index 0000000..981a524 --- /dev/null +++ b/docs/Irssi/Window.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 DEPRECATED. diff --git a/docs/Irssi/Windowitem.pod b/docs/Irssi/Windowitem.pod new file mode 100644 index 0000000..7781a44 --- /dev/null +++ b/docs/Irssi/Windowitem.pod @@ -0,0 +1,55 @@ +__END__ + +=head1 NAME + +Irssi::Windowitem + +=head1 DESCRIPTION + + +The meaning of "window" should be pretty clear, but "window item" is something I +couldn't really figure out a better name for :) They're simply something that's +inside a window, a channel or a query usually. Windows can have multiple items +inside them. It's possible to create non-channel/query window items too, +currently the third possible window item is created by /EXEC -interactive. + +In scripts, I think you can quite safely assume that the window item is +query or channel if the script is intended to be run in one of them. +Stupid users won't probably have other window items, and smart users +know where to run the script, or at least later figure out why it +didn't work :) + +=head1 FIELDS + +Windowitem->{} + type - Type of the window item, for example "CHANNEL" or "QUERY" + chat_type - String ID of chat protocol, for example "IRC" + + server - Active server for item + name - Name of the item + + createtime - Time the window item was created + data_level - 0=no new data, 1=text, 2=msg, 3=highlighted text + hilight_color - Color of the last highlighted text + +=head1 METHODS + +Windowitem::print(str[, level]) + +Windowitem::command(cmd) + + + +Windowitem::set_active() + Change window item active in parent window. + + +Windowitem::change_server(server) + Change server in window item. + +Windowitem::is_active() + Returns 1 if window item is the active item in parent window. + +Dcc +Windowitem::get_dcc(item) + If `item' is a query of a =nick, return DCC chat record of nick. |