diff options
Diffstat (limited to 'docs/Irssi')
| -rw-r--r-- | docs/Irssi/Ban.pm | 15 | ||||
| -rw-r--r-- | docs/Irssi/Channel.pm | 36 | ||||
| -rw-r--r-- | docs/Irssi/Chatnet.pm | 24 | ||||
| -rw-r--r-- | docs/Irssi/Client.pm | 20 | ||||
| -rw-r--r-- | docs/Irssi/Dcc.pm | 65 | ||||
| -rw-r--r-- | docs/Irssi/Ignore.pm | 22 | ||||
| -rw-r--r-- | docs/Irssi/Log.pm | 36 | ||||
| -rw-r--r-- | docs/Irssi/Logitem.pm | 6 | ||||
| -rw-r--r-- | docs/Irssi/Notifylist.pm | 21 | ||||
| -rw-r--r-- | docs/Irssi/Process.pm | 22 | ||||
| -rw-r--r-- | docs/Irssi/Query.pm | 7 | ||||
| -rw-r--r-- | docs/Irssi/Rawlog.pm | 40 | ||||
| -rw-r--r-- | docs/Irssi/Server.pm | 82 | ||||
| -rw-r--r-- | docs/Irssi/Theme.pm | 11 | ||||
| -rw-r--r-- | docs/Irssi/Window.pm | 8 | ||||
| -rw-r--r-- | docs/Irssi/Windowitem.pm | 14 | 
16 files changed, 421 insertions, 8 deletions
| diff --git a/docs/Irssi/Ban.pm b/docs/Irssi/Ban.pm new file mode 100644 index 0000000..ba8381f --- /dev/null +++ b/docs/Irssi/Ban.pm @@ -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.pm b/docs/Irssi/Channel.pm index 10e82f1..bb6789d 100644 --- a/docs/Irssi/Channel.pm +++ b/docs/Irssi/Channel.pm @@ -46,10 +46,34 @@ Server::channels_join(channels, automatic)  Channel::destroy()    Destroy channel. -Channel -channel_find(channel) -  Find channel from any server. -Channel -Server::channel_find(channel) -  Find channel from specified server. +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.pm b/docs/Irssi/Chatnet.pm new file mode 100644 index 0000000..23fa134 --- /dev/null +++ b/docs/Irssi/Chatnet.pm @@ -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.pm b/docs/Irssi/Client.pm new file mode 100644 index 0000000..e07bed7 --- /dev/null +++ b/docs/Irssi/Client.pm @@ -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/Dcc.pm b/docs/Irssi/Dcc.pm new file mode 100644 index 0000000..546f112 --- /dev/null +++ b/docs/Irssi/Dcc.pm @@ -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.pm b/docs/Irssi/Ignore.pm new file mode 100644 index 0000000..108c0ba --- /dev/null +++ b/docs/Irssi/Ignore.pm @@ -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.pm b/docs/Irssi/Log.pm index 6787f85..673a183 100644 --- a/docs/Irssi/Log.pm +++ b/docs/Irssi/Log.pm @@ -6,5 +6,41 @@ 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.pm b/docs/Irssi/Logitem.pm index 21ec401..6db0c7b 100644 --- a/docs/Irssi/Logitem.pm +++ b/docs/Irssi/Logitem.pm @@ -6,5 +6,11 @@ Irssi::Logitem  =head1 FIELDS +Logitem->{} +  type - 0=target, 1=window refnum +  name - Name +  servertag - Server tag + +  =head1 METHODS diff --git a/docs/Irssi/Notifylist.pm b/docs/Irssi/Notifylist.pm new file mode 100644 index 0000000..5b2628a --- /dev/null +++ b/docs/Irssi/Notifylist.pm @@ -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.pm b/docs/Irssi/Process.pm new file mode 100644 index 0000000..4b311a2 --- /dev/null +++ b/docs/Irssi/Process.pm @@ -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.pm b/docs/Irssi/Query.pm index 953c179..c823a4a 100644 --- a/docs/Irssi/Query.pm +++ b/docs/Irssi/Query.pm @@ -19,3 +19,10 @@ Query->{}  =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.pm b/docs/Irssi/Rawlog.pm new file mode 100644 index 0000000..7f89c64 --- /dev/null +++ b/docs/Irssi/Rawlog.pm @@ -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/Server.pm b/docs/Irssi/Server.pm index bb93d20..dfb8500 100644 --- a/docs/Irssi/Server.pm +++ b/docs/Irssi/Server.pm @@ -37,7 +37,10 @@ Server->{}  Server::channels() - return list of channels in server  Server::queries() - return list of queries in server  Server::print(channel, str[, level]) -Server::command(cmd) + +=head2 C<command $string> + +Run the specified command on this server instance.  Server @@ -67,3 +70,80 @@ Server::get_nick_flags()  Server::send_message(target, msg, target_type)    Sends a message to nick/channel. target_type 0 = channel, 1 = nick + + +Netsplit +Server::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).. + +Nick +Server::netsplit_find_channel(nick, address, channel) +  Find nick record for nick!address in channel `channel'. + + +Server::dcc_ctcp_message(target, notice, msg) + +Channel +Server::channel_find(channel) +  Find channel from specified server. + +Server::ignore_check(nick, host, channel, text, level) +  Return 1 if ignoring matched. + + + + +Server::nicks_get_same(nick) +  Return all nick objects in all channels in server. List is in format: +  Channel, Nick, Channel, ... + +blah + +blah  + +blah + + + +blah + +blah  + +blah + + +blah + +blah  + +blah + + +blah + +blah  + +blah + + +blah + +blah  + +blah + + +blah + +blah  + +blah + + +blah + +blah  + +blah + diff --git a/docs/Irssi/Theme.pm b/docs/Irssi/Theme.pm new file mode 100644 index 0000000..f9efc85 --- /dev/null +++ b/docs/Irssi/Theme.pm @@ -0,0 +1,11 @@ +__END__ + +=head1 NAME + +Irssi::Theme + +=head1 FIELDS + + +=head1 METHODS + diff --git a/docs/Irssi/Window.pm b/docs/Irssi/Window.pm index 77b880c..540fae2 100644 --- a/docs/Irssi/Window.pm +++ b/docs/Irssi/Window.pm @@ -94,7 +94,6 @@ Window::item_remove(item)  Window::item_destroy(item)    Add/remove/destroy window item -  Window::set_active()    Set window active. @@ -108,3 +107,10 @@ Window::set_level(level)  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/Windowitem.pm b/docs/Irssi/Windowitem.pm index 78919cc..7781a44 100644 --- a/docs/Irssi/Windowitem.pm +++ b/docs/Irssi/Windowitem.pm @@ -39,3 +39,17 @@ 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. | 
