From 8d4fe58ee09b7f5d00ee0c1a6e122a1bcff7ca4e Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Sat, 8 Jan 2011 20:00:20 +0000 Subject: moved docs/ to https://github.com/shabble/irssi-docs --- docs/Irssi/Channel.pod | 86 ------------------ docs/Irssi/Chatnet.pod | 26 ------ docs/Irssi/Command.pod | 12 --- docs/Irssi/Ignore.pod | 27 ------ docs/Irssi/Irc.pod | 51 ----------- docs/Irssi/Irc/Ban.pod | 15 ---- docs/Irssi/Irc/Channel.pod | 16 ---- docs/Irssi/Irc/Client.pod | 21 ----- docs/Irssi/Irc/Dcc.pod | 79 ---------------- docs/Irssi/Irc/Notifylist.pod | 23 ----- docs/Irssi/Irc/Server.pod | 26 ------ docs/Irssi/Log.pod | 55 ------------ docs/Irssi/Logitem.pod | 16 ---- docs/Irssi/Nick.pod | 25 ------ docs/Irssi/Query.pod | 30 ------- docs/Irssi/Rawlog.pod | 48 ---------- docs/Irssi/Reconnect.pod | 20 ----- docs/Irssi/Script.pod | 10 --- docs/Irssi/Server.pod | 149 ------------------------------ docs/Irssi/TextUI.pod | 12 --- docs/Irssi/TextUI/Line.pod | 16 ---- docs/Irssi/TextUI/LineCache.pod | 3 - docs/Irssi/TextUI/LineInfo.pod | 3 - docs/Irssi/TextUI/MainWindow.pod | 3 - docs/Irssi/TextUI/StatusbarItem.pod | 29 ------ docs/Irssi/TextUI/TextBufferView.pod | 26 ------ docs/Irssi/TextUI/Textbuffer.pod | 3 - docs/Irssi/UI.pod | 13 --- docs/Irssi/UI/Process.pod | 25 ------ docs/Irssi/UI/Server.pod | 13 --- docs/Irssi/UI/TextDest.pod | 11 --- docs/Irssi/UI/Theme.pod | 169 ----------------------------------- docs/Irssi/UI/Window.pod | 167 ---------------------------------- docs/Irssi/Windowitem.pod | 78 ---------------- 34 files changed, 1306 deletions(-) delete mode 100644 docs/Irssi/Channel.pod delete mode 100644 docs/Irssi/Chatnet.pod delete mode 100644 docs/Irssi/Command.pod delete mode 100644 docs/Irssi/Ignore.pod delete mode 100644 docs/Irssi/Irc.pod delete mode 100644 docs/Irssi/Irc/Ban.pod delete mode 100644 docs/Irssi/Irc/Channel.pod delete mode 100644 docs/Irssi/Irc/Client.pod delete mode 100644 docs/Irssi/Irc/Dcc.pod delete mode 100644 docs/Irssi/Irc/Notifylist.pod delete mode 100644 docs/Irssi/Irc/Server.pod delete mode 100644 docs/Irssi/Log.pod delete mode 100644 docs/Irssi/Logitem.pod delete mode 100644 docs/Irssi/Nick.pod delete mode 100644 docs/Irssi/Query.pod delete mode 100644 docs/Irssi/Rawlog.pod delete mode 100644 docs/Irssi/Reconnect.pod delete mode 100644 docs/Irssi/Script.pod delete mode 100644 docs/Irssi/Server.pod delete mode 100644 docs/Irssi/TextUI.pod delete mode 100644 docs/Irssi/TextUI/Line.pod delete mode 100644 docs/Irssi/TextUI/LineCache.pod delete mode 100644 docs/Irssi/TextUI/LineInfo.pod delete mode 100644 docs/Irssi/TextUI/MainWindow.pod delete mode 100644 docs/Irssi/TextUI/StatusbarItem.pod delete mode 100644 docs/Irssi/TextUI/TextBufferView.pod delete mode 100644 docs/Irssi/TextUI/Textbuffer.pod delete mode 100644 docs/Irssi/UI.pod delete mode 100644 docs/Irssi/UI/Process.pod delete mode 100644 docs/Irssi/UI/Server.pod delete mode 100644 docs/Irssi/UI/TextDest.pod delete mode 100644 docs/Irssi/UI/Theme.pod delete mode 100644 docs/Irssi/UI/Window.pod delete mode 100644 docs/Irssi/Windowitem.pod (limited to 'docs/Irssi') diff --git a/docs/Irssi/Channel.pod b/docs/Irssi/Channel.pod deleted file mode 100644 index baeff6c..0000000 --- a/docs/Irssi/Channel.pod +++ /dev/null @@ -1,86 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Channel - -=head1 FIELDS - -C{}> - - 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 - - - -=head2 C - -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 channel. - -=head2 C - -Return a list of bans in channel. - -=head2 C - -Get ban mask for `nick'. - -=head2 C - -Add a new ban to channel. - -=head2 C - -Remove a ban from channel. - - -=head2 C - -Add nick to nicklist. Returns a L. - -=head2 C - -Remove nick from nicklist. - -=head2 C - -Find nick from nicklist. Returns L. - -=head2 C - -Find nick mask from nicklist, wildcards allowed. Returns L. - -=head2 C - -Return a list of all nicks in channel. diff --git a/docs/Irssi/Chatnet.pod b/docs/Irssi/Chatnet.pod deleted file mode 100644 index 991dd2b..0000000 --- a/docs/Irssi/Chatnet.pod +++ /dev/null @@ -1,26 +0,0 @@ -__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 - -I diff --git a/docs/Irssi/Command.pod b/docs/Irssi/Command.pod deleted file mode 100644 index d777794..0000000 --- a/docs/Irssi/Command.pod +++ /dev/null @@ -1,12 +0,0 @@ -__END__ - -=head1 NAME - -=head1 FIELDS - - Command->{} - cmd - Command name - category - Category - -=head1 METHODS - diff --git a/docs/Irssi/Ignore.pod b/docs/Irssi/Ignore.pod deleted file mode 100644 index 47f5225..0000000 --- a/docs/Irssi/Ignore.pod +++ /dev/null @@ -1,27 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Ignore - -=head1 FIELDS - -C{}> - - 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 - -=head2 C - -=head2 C - diff --git a/docs/Irssi/Irc.pod b/docs/Irssi/Irc.pod deleted file mode 100644 index e654f59..0000000 --- a/docs/Irssi/Irc.pod +++ /dev/null @@ -1,51 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Irc - -=head1 DESCRIPTION - -=head1 CLASSES - -=head1 EXPORTS - -=head1 METHODS - -=head2 TODO - - Irssi::Irc::dcc_chat_find_id - Irssi::Irc::dcc_chat_send - Irssi::Irc::dcc_ctcp_message - Irssi::Irc::dcc_find_request - Irssi::Irc::dcc_find_request_latest - Irssi::Irc::dcc_get_download_path - Irssi::Irc::dcc_register_type - Irssi::Irc::dcc_str2type - Irssi::Irc::dcc_type2str - Irssi::Irc::dcc_unregister_type - Irssi::Irc::dccs - Irssi::Irc::deinit - Irssi::Irc::get_mask - Irssi::Irc::init - Irssi::Irc::modes_join - Irssi::Irc::notifies - Irssi::Irc::notifylist_add - Irssi::Irc::notifylist_find - Irssi::Irc::notifylist_ison - Irssi::Irc::notifylist_remove - -=head2 Accessors - -=head3 C - -returns a list of all L - -=head1 COPYRIGHT - -All the content of this site is copyright E 2000-2010 L. - -Formatting to POD and linking by Tom Feist - L - diff --git a/docs/Irssi/Irc/Ban.pod b/docs/Irssi/Irc/Ban.pod deleted file mode 100644 index 7026ca1..0000000 --- a/docs/Irssi/Irc/Ban.pod +++ /dev/null @@ -1,15 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Irc::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/Irc/Channel.pod b/docs/Irssi/Irc/Channel.pod deleted file mode 100644 index 02488d1..0000000 --- a/docs/Irssi/Irc/Channel.pod +++ /dev/null @@ -1,16 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Irc::Channel - -=head1 FIELDS - -=head1 METHODS - - Irssi::Irc::Channel::ban_get_mask - Irssi::Irc::Channel::banlist_add - Irssi::Irc::Channel::banlist_remove - Irssi::Irc::Channel::bans - Irssi::Irc::Channel::nick_insert - diff --git a/docs/Irssi/Irc/Client.pod b/docs/Irssi/Irc/Client.pod deleted file mode 100644 index e0a27f4..0000000 --- a/docs/Irssi/Irc/Client.pod +++ /dev/null @@ -1,21 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Irc::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/Irc/Dcc.pod b/docs/Irssi/Irc/Dcc.pod deleted file mode 100644 index e3b5b99..0000000 --- a/docs/Irssi/Irc/Dcc.pod +++ /dev/null @@ -1,79 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Irc::Dcc - -=head1 FIELDS - -=head2 C{}> - - 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 - -=head2 C{}> - - id - Unique identifier - usually same as nick - mirc_ctcp - Send CTCPs without the CTCP_MESSAGE prefix - connection_lost - Other side closed connection - -=head2 C{}> - - (..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") - -=head2 C{}> - - (..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 - -=head2 C - -Destroy DCC connection. - -=head2 C - -Send `data' to dcc chat. - -=head2 C - -Send a CTCP message/notify to target. - -=head2 C - -=head2 C - -=head2 C - diff --git a/docs/Irssi/Irc/Notifylist.pod b/docs/Irssi/Irc/Notifylist.pod deleted file mode 100644 index fd933ef..0000000 --- a/docs/Irssi/Irc/Notifylist.pod +++ /dev/null @@ -1,23 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Irc::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 - -=head2 C - -Returns 1 if notify is checked in `ircnet'. - diff --git a/docs/Irssi/Irc/Server.pod b/docs/Irssi/Irc/Server.pod deleted file mode 100644 index 520bf8d..0000000 --- a/docs/Irssi/Irc/Server.pod +++ /dev/null @@ -1,26 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Irc::Server - -=head1 FIELDS - -=head1 METHODS - - Irssi::Irc::Server::ctcp_send_reply - Irssi::Irc::Server::get_channels - Irssi::Irc::Server::isupport - Irssi::Irc::Server::netsplit_find - Irssi::Irc::Server::netsplit_find_channel - Irssi::Irc::Server::notifylist_ison_server - Irssi::Irc::Server::query_create - Irssi::Irc::Server::redirect_event - Irssi::Irc::Server::redirect_get_signal - Irssi::Irc::Server::redirect_peek_signal - Irssi::Irc::Server::redirect_register - Irssi::Irc::Server::send_raw - Irssi::Irc::Server::send_raw_first - Irssi::Irc::Server::send_raw_now - Irssi::Irc::Server::send_raw_split - diff --git a/docs/Irssi/Log.pod b/docs/Irssi/Log.pod deleted file mode 100644 index c319654..0000000 --- a/docs/Irssi/Log.pod +++ /dev/null @@ -1,55 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Log - -=head1 FIELDS - -C{}> - - 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 - -=head2 C - -Add log to list of logs / save changes to config file. - -=head2 C - -Destroy log file. - -=head2 C - -Open log file and start logging. - -=head2 C - -Close log file. - -=head2 C - -Add log item to log. - -=head2 C - -Remove log item from log. - -=head2 C - -Find item from log. Returns L - -=head2 C - -I - diff --git a/docs/Irssi/Logitem.pod b/docs/Irssi/Logitem.pod deleted file mode 100644 index f30d4b8..0000000 --- a/docs/Irssi/Logitem.pod +++ /dev/null @@ -1,16 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Logitem - -=head1 FIELDS - -C{}> - - 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 deleted file mode 100644 index 3e85256..0000000 --- a/docs/Irssi/Nick.pod +++ /dev/null @@ -1,25 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Nick - -=head1 FIELDS - -C{}> - - 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/Query.pod b/docs/Irssi/Query.pod deleted file mode 100644 index cb7e0d8..0000000 --- a/docs/Irssi/Query.pod +++ /dev/null @@ -1,30 +0,0 @@ -__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 - -=head2 C - -Destroy the query. - -=head2 C - -Change the active server of the query. - diff --git a/docs/Irssi/Rawlog.pod b/docs/Irssi/Rawlog.pod deleted file mode 100644 index a5428bf..0000000 --- a/docs/Irssi/Rawlog.pod +++ /dev/null @@ -1,48 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Rawlog - -=head1 FIELDS - - -C{}> - - logging - The rawlog is being written to file currently - nlines - Number of lines in rawlog - -=head1 METHODS - -=head2 C - -Destroy the rawlog. - -=head2 C - -Returns all lines in rawlog. - -=head2 C - -Start logging new messages in rawlog to specified file. - -=head2 C - -Stop logging to file. - -=head2 C - -Save the current rawlog history to specified file. - -=head2 C - -Send `str' to raw log as input text. - -=head2 C - -Send `str' to raw log as output text. - -=head2 C - -Send `str' to raw log as redirection text. - diff --git a/docs/Irssi/Reconnect.pod b/docs/Irssi/Reconnect.pod deleted file mode 100644 index 4085eec..0000000 --- a/docs/Irssi/Reconnect.pod +++ /dev/null @@ -1,20 +0,0 @@ -__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 deleted file mode 100644 index 9f8b07b..0000000 --- a/docs/Irssi/Script.pod +++ /dev/null @@ -1,10 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Script - -=head1 FIELDS - -=head1 METHODS - diff --git a/docs/Irssi/Server.pod b/docs/Irssi/Server.pod deleted file mode 100644 index e8ca3c1..0000000 --- a/docs/Irssi/Server.pod +++ /dev/null @@ -1,149 +0,0 @@ -__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 - -- return list of channels in server - -=head2 C - -Return list of queries in server - -=head2 C - -=head2 C - -Run the specified command on this server instance. - - - -=head2 C - -B package?> - -Connect to server. returns L object. - -=head2 C - -Disconnect from server. - -=head2 C - -Find server with tag. Returns L - - -=head2 C - -Find first server that is in `chatnet' -returns L - -=head2 C - -Returns 1 if flag is a nick mode flag (C<@>, C<+> or C<%> in IRC) - -=head2 C - -Returns 1 if start of `data' seems to mean channel. - -=head2 C - -Returns nick flag characters in order: op, voice, halfop (C<"@+%"> in IRC). - -=head2 C - -Sends a message to nick/channel. target_type 0 = channel, 1 = nick - -=head2 C - -Check if nick!address is on the other side of netsplit. Netsplit records -are automatically removed after 30 minutes (current default).. - -returns L - -=head2 C - -Find nick record for nick!address in channel `channel'. -returns L - - -=head2 C - -=head2 C - -Find channel from specified server. Returns L - -=head2 C - -Return 1 if ignoring matched. - -=head2 C - -Return all L objects in all channels in server. -List is in format: - - Channel, Nick, Channel, ... - - -=head1 FULL LIST OF FUNCS - - Irssi::Server::channel_find - Irssi::Server::channels - Irssi::Server::channels_join - Irssi::Server::command - Irssi::Server::disconnect - Irssi::Server::format_create_dest - Irssi::Server::get_nick_flags - Irssi::Server::ignore_check - Irssi::Server::ischannel - Irssi::Server::isnickflag - Irssi::Server::mask_match - Irssi::Server::mask_match_address - Irssi::Server::masks_match - Irssi::Server::nicks_get_same - Irssi::Server::parse_special - Irssi::Server::print - Irssi::Server::printformat - Irssi::Server::queries - Irssi::Server::query_find - Irssi::Server::ref - Irssi::Server::send_message - Irssi::Server::unref - Irssi::Server::window_find_closest - Irssi::Server::window_find_item - Irssi::Server::window_find_level - Irssi::Server::window_item_find - diff --git a/docs/Irssi/TextUI.pod b/docs/Irssi/TextUI.pod deleted file mode 100644 index 7993274..0000000 --- a/docs/Irssi/TextUI.pod +++ /dev/null @@ -1,12 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::TextUI - -=head1 FIELDS - -=head1 METHODS - - Irssi::TextUI::deinit - Irssi::TextUI::init diff --git a/docs/Irssi/TextUI/Line.pod b/docs/Irssi/TextUI/Line.pod deleted file mode 100644 index 4c29dca..0000000 --- a/docs/Irssi/TextUI/Line.pod +++ /dev/null @@ -1,16 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::TextUI::Line - -=head1 FIELDS - -=head1 METHODS - -=head2 C - -=head2 C - -=head2 C - diff --git a/docs/Irssi/TextUI/LineCache.pod b/docs/Irssi/TextUI/LineCache.pod deleted file mode 100644 index 08bdae1..0000000 --- a/docs/Irssi/TextUI/LineCache.pod +++ /dev/null @@ -1,3 +0,0 @@ -__END__ - -=head1 Empty diff --git a/docs/Irssi/TextUI/LineInfo.pod b/docs/Irssi/TextUI/LineInfo.pod deleted file mode 100644 index 08bdae1..0000000 --- a/docs/Irssi/TextUI/LineInfo.pod +++ /dev/null @@ -1,3 +0,0 @@ -__END__ - -=head1 Empty diff --git a/docs/Irssi/TextUI/MainWindow.pod b/docs/Irssi/TextUI/MainWindow.pod deleted file mode 100644 index 08bdae1..0000000 --- a/docs/Irssi/TextUI/MainWindow.pod +++ /dev/null @@ -1,3 +0,0 @@ -__END__ - -=head1 Empty diff --git a/docs/Irssi/TextUI/StatusbarItem.pod b/docs/Irssi/TextUI/StatusbarItem.pod deleted file mode 100644 index b62890c..0000000 --- a/docs/Irssi/TextUI/StatusbarItem.pod +++ /dev/null @@ -1,29 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::TextUI::StatusbarItem - -=head1 DESCRIPTION - -=head1 FIELDS - -=head1 METHODS - -=head2 C - -=over - -=item C<$item> - -=item C<$get_size_only> - -=item C<$str> - -=item C<$data> - -=item C<$escape_vars> - defaults to C - -=back - - diff --git a/docs/Irssi/TextUI/TextBufferView.pod b/docs/Irssi/TextUI/TextBufferView.pod deleted file mode 100644 index f42d362..0000000 --- a/docs/Irssi/TextUI/TextBufferView.pod +++ /dev/null @@ -1,26 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::TextUI::TextBufferView - -=head1 FIELDS - -=head1 METHODS - - Irssi::TextUI::TextBufferView::clear - Irssi::TextUI::TextBufferView::get_bookmark - Irssi::TextUI::TextBufferView::get_line_cache - Irssi::TextUI::TextBufferView::get_lines - Irssi::TextUI::TextBufferView::redraw - Irssi::TextUI::TextBufferView::remove_all_lines - Irssi::TextUI::TextBufferView::remove_line - Irssi::TextUI::TextBufferView::scroll - Irssi::TextUI::TextBufferView::scroll_line - Irssi::TextUI::TextBufferView::set_bookmark - Irssi::TextUI::TextBufferView::set_bookmark_bottom - Irssi::TextUI::TextBufferView::set_default_indent - Irssi::TextUI::TextBufferView::set_scroll - -I - diff --git a/docs/Irssi/TextUI/Textbuffer.pod b/docs/Irssi/TextUI/Textbuffer.pod deleted file mode 100644 index 08bdae1..0000000 --- a/docs/Irssi/TextUI/Textbuffer.pod +++ /dev/null @@ -1,3 +0,0 @@ -__END__ - -=head1 Empty diff --git a/docs/Irssi/UI.pod b/docs/Irssi/UI.pod deleted file mode 100644 index aac1c6e..0000000 --- a/docs/Irssi/UI.pod +++ /dev/null @@ -1,13 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::UI - -=head1 FIELDS - -=head1 METHODS - - Irssi::UI::deinit - Irssi::UI::init - Irssi::UI::processes diff --git a/docs/Irssi/UI/Process.pod b/docs/Irssi/UI/Process.pod deleted file mode 100644 index 23d9100..0000000 --- a/docs/Irssi/UI/Process.pod +++ /dev/null @@ -1,25 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::UI::Process - -=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_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 - -I diff --git a/docs/Irssi/UI/Server.pod b/docs/Irssi/UI/Server.pod deleted file mode 100644 index 7bc7080..0000000 --- a/docs/Irssi/UI/Server.pod +++ /dev/null @@ -1,13 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::UI::Server - -=head1 FIELDS - -=head1 METHODS - - Irssi::UI::Server::gui_printtext_after - Irssi::UI::Server::term_refresh_freeze - Irssi::UI::Server::term_refresh_thaw diff --git a/docs/Irssi/UI/TextDest.pod b/docs/Irssi/UI/TextDest.pod deleted file mode 100644 index 24b9d04..0000000 --- a/docs/Irssi/UI/TextDest.pod +++ /dev/null @@ -1,11 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::UI::TextDest - -=head1 FIELDS - -=head1 METHODS - - Irssi::UI::TextDest::print diff --git a/docs/Irssi/UI/Theme.pod b/docs/Irssi/UI/Theme.pod deleted file mode 100644 index 344b5ae..0000000 --- a/docs/Irssi/UI/Theme.pod +++ /dev/null @@ -1,169 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::UI::Theme - -=head1 FIELDS - -=head1 METHODS - -=head2 C - -C<$flags> is an optional bitmask of any of the following flags: - -=over - -=item C - -Any replacements specified in the theme are not applied to this expansion. - -=item C - -B - -=item C - -If the format contains variables and no values are specified, an empty string is -returned instead of a partially filled template. - -=back - -B - -Example: - - my $formatted_str = Irssi::current_theme()->format_expand('{hilight Hello}'); - -B. Weird> - -=head2 C - -Returns the unexpanded format template for the format name supplied in C<$tag>. - -Valid values for C<$module> are: - -=over - -=item C - -=item C - -=item C - -=item C - -=item C - -=item C - -=back - -Example: - - my $pubmsg_format = Irssi::current_theme()->get_format('fe-common/core', 'pubmsg'); - -=head1 THEME DETAILS - -=head2 Loading and Testing - -You can change themes by issuing a C> command from Irssi. -Reloading is slightly harder, since Irssi will only reload and process a new theme -if the C variable I. - -You can force a reload of the theme (and everything else) with C. This -reloads the configuration file too, so if you did any changes remember to C -first. - -B overwrites the theme file with old data so keep -backups C<:)>> - -Better alternatives are the following aliases: - - /ALIAS THEMERELOAD SCRIPT EXEC Irssi::themes_reload(); - -or - - /ALIAS THEMERELOAD SET theme default; EVAL SET theme $theme - -The former is preferred if you have scripting support, whereas the latter will -work without scripting (Perl) support loaded, but requires that you are editing -a custom theme, rather than modifying F. - -=head2 TEMPLATES - -The actual mechanism used by Irssi to print text into the client involves a -certain amount of indirection, which allows themes to reformat messages in -various ways before they are displayed. - -The overall structure of these templates is based around 3 basic ideas: - -=over - -=item Nested Templates - -=item Colour Codes - -=item Variable Expansion - -=item Special Variables - -=back - -The real text formats that irssi uses are the ones you can find with -/FORMAT command. Back in the old days all the colors and texts were mixed -up in those formats, and it was really hard to change the colors since you -might have had to change them in tens of different places. So, then came -this templating system. - -Now the Cs don't have any colors in them, and they also have very -little other styling. Most of the stuff you need to change is in this -theme file. If you can't change something here, you can always go back -to change the /FORMATs directly, they're also saved in the F<*.theme> files. - -So, the templates. They're those C<{blahblah}> parts you see all over the -/FORMATs and here. Their usage is simply C<{name parameter1 parameter2}>. - -When irssi sees this kind of text, it goes to find C from the abstracts -block below and sets C into C<$0> and C into C<$1> (you -can have more parameters of course). Templates can have sub-templates. Here's a -small example: - - /FORMAT format hello {colorify {underline world}} - - abstracts = { colorify = "%G$0-%n"; underline = "%U$0-%U"; } - -When irssi expands the templates in C<"format">, the final string would be: - - hello %G%Uworld%U%n - -ie. underlined bright green "world" text. and why C<$0->, why not C<$0>? C<$0> -would only mean the first parameter, C<$0-> means all the parameters. With -C<{underline hello world}> you'd really want to underline both of the words, not -just the hello (and world would actually be removed entirely). - -See also L for -details on the variable to argument mapping. - -=head2 COLOURS - -You can find definitions for the colour format codes in L. - -There's one difference here though. C<%n> format. Normally it means the default -color of the terminal (white mostly), but here it means the "reset color back to -the one it was in higher template". For example if there was C, and C, irssi would print yellow C<"foo"> (as set -with C<%Y>) but C<"bar"> would be green, which was set at the beginning before -the C<{foo}> template. If there wasn't the C<%g> at start, the normal behaviour -of C<%n> would occur. If you I want to use the terminal's default color, -use C<%N>. - -=head1 AUTHOR - -Based on the original content found as comments in the F file. -Copyright E 2000-2010 L. - -Formatting and additional content by Tom Feist - L - diff --git a/docs/Irssi/UI/Window.pod b/docs/Irssi/UI/Window.pod deleted file mode 100644 index 2dd6389..0000000 --- a/docs/Irssi/UI/Window.pod +++ /dev/null @@ -1,167 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::UI::Window - -=head1 FIELDS - -C{}> - - 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 - -C{}> - - 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 - -=head2 C - -=head2 C - -=head2 C - -Return a list of items in window. - - -=head2 C - -=head2 C - -Destroy the window. - -Irssi::Window -Windowitem::window() - Returns parent window for window item. - -=head2 C - -Find window with name.L - -=head2 C - -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. - - -=head2 C - -Add specified windowitem - -=head2 C - -remove specified windowitem - -=head2 C - -destroy specified windowitem - -=head2 C - -Set window active. - -=head2 C - -=head2 C - -=head2 C - -=head2 C - -=head2 C - -Change server/refnum/name/history/level in window. - -=head2 C - -=head2 C - -Change to previous/next window item. - - -=head2 C - -Return active item's name, or if none is active, window's name - -=head2 C - -Find window item that matches best to given arguments. - -=head1 Full list of functions - - Irssi::UI::Window::activity - Irssi::UI::Window::change_server - Irssi::UI::Window::command - Irssi::UI::Window::destroy - Irssi::UI::Window::format_get_text - Irssi::UI::Window::get_active_name - Irssi::UI::Window::get_history_lines - Irssi::UI::Window::gui_printtext_after - Irssi::UI::Window::item_add - Irssi::UI::Window::item_destroy - Irssi::UI::Window::item_find - Irssi::UI::Window::item_next - Irssi::UI::Window::item_prev - Irssi::UI::Window::item_remove - Irssi::UI::Window::items - Irssi::UI::Window::last_line_insert - Irssi::UI::Window::print - Irssi::UI::Window::print_after - Irssi::UI::Window::printformat - Irssi::UI::Window::set_active - Irssi::UI::Window::set_history - Irssi::UI::Window::set_level - Irssi::UI::Window::set_name - Irssi::UI::Window::set_refnum - Irssi::UI::Window::view - diff --git a/docs/Irssi/Windowitem.pod b/docs/Irssi/Windowitem.pod deleted file mode 100644 index 896600b..0000000 --- a/docs/Irssi/Windowitem.pod +++ /dev/null @@ -1,78 +0,0 @@ -__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 - -=head2 C - -=head2 C - -=head2 C - -Change window item active in parent window. - - -=head2 C - -Change server in window item. - -=head2 C - -Returns 1 if window item is the active item in parent window. - - -=head2 C - -If `item' is a query of a =nick, return DCC chat record of nick. -returns L object. - -Windowitem::window_create(automatic) - Create a new window. - -=head1 full func list - - - Irssi::Windowitem::activity - Irssi::Windowitem::change_server - Irssi::Windowitem::command - Irssi::Windowitem::get_dcc - Irssi::Windowitem::is_active - Irssi::Windowitem::parse_special - Irssi::Windowitem::print - Irssi::Windowitem::printformat - Irssi::Windowitem::set_active - Irssi::Windowitem::window - Irssi::Windowitem::window_create - -- cgit v1.2.3