From ced8aef9e7966a75b43c1d54b7fa06377bad8dff Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 16 Jul 2010 20:13:02 +0100 Subject: renamed everything to .pod since they are not actually perl modules --- docs/Guide.pm | 158 --- docs/Guide.pod | 158 +++ docs/Irssi.pm | 563 -------- docs/Irssi.pod | 563 ++++++++ docs/Irssi/Ban.pm | 15 - docs/Irssi/Channel.pm | 79 -- docs/Irssi/Chatnet.pm | 24 - docs/Irssi/Client.pm | 20 - docs/Irssi/Command.pm | 12 - docs/Irssi/Dcc.pm | 65 - docs/Irssi/Ignore.pm | 22 - docs/Irssi/Log.pm | 46 - docs/Irssi/Logitem.pm | 16 - docs/Irssi/Nick.pm | 24 - docs/Irssi/Notifylist.pm | 21 - docs/Irssi/Process.pm | 22 - docs/Irssi/Query.pm | 28 - docs/Irssi/Rawlog.pm | 40 - docs/Irssi/Reconnect.pm | 20 - docs/Irssi/Script.pm | 10 - docs/Irssi/Server.pm | 149 --- docs/Irssi/TextUI.pm | 0 docs/Irssi/TextUI/Line.pm | 0 docs/Irssi/TextUI/LineCache.pm | 0 docs/Irssi/TextUI/LineInfo.pm | 0 docs/Irssi/TextUI/MainWindow.pm | 0 docs/Irssi/TextUI/StatusbarItem.pm | 0 docs/Irssi/TextUI/TextBufferView.pm | 0 docs/Irssi/TextUI/Textbuffer.pm | 0 docs/Irssi/Theme.pm | 4 - docs/Irssi/UI/Theme.pm | 8 - docs/Irssi/UI/Window.pm | 116 -- docs/Irssi/Window.pm | 3 - docs/Irssi/Windowitem.pm | 55 - docs/Signals.pm | 2405 ----------------------------------- 35 files changed, 721 insertions(+), 3925 deletions(-) delete mode 100644 docs/Guide.pm create mode 100644 docs/Guide.pod delete mode 100644 docs/Irssi.pm create mode 100644 docs/Irssi.pod delete mode 100644 docs/Irssi/Ban.pm delete mode 100644 docs/Irssi/Channel.pm delete mode 100644 docs/Irssi/Chatnet.pm delete mode 100644 docs/Irssi/Client.pm delete mode 100644 docs/Irssi/Command.pm delete mode 100644 docs/Irssi/Dcc.pm delete mode 100644 docs/Irssi/Ignore.pm delete mode 100644 docs/Irssi/Log.pm delete mode 100644 docs/Irssi/Logitem.pm delete mode 100644 docs/Irssi/Nick.pm delete mode 100644 docs/Irssi/Notifylist.pm delete mode 100644 docs/Irssi/Process.pm delete mode 100644 docs/Irssi/Query.pm delete mode 100644 docs/Irssi/Rawlog.pm delete mode 100644 docs/Irssi/Reconnect.pm delete mode 100644 docs/Irssi/Script.pm delete mode 100644 docs/Irssi/Server.pm delete mode 100644 docs/Irssi/TextUI.pm delete mode 100644 docs/Irssi/TextUI/Line.pm delete mode 100644 docs/Irssi/TextUI/LineCache.pm delete mode 100644 docs/Irssi/TextUI/LineInfo.pm delete mode 100644 docs/Irssi/TextUI/MainWindow.pm delete mode 100644 docs/Irssi/TextUI/StatusbarItem.pm delete mode 100644 docs/Irssi/TextUI/TextBufferView.pm delete mode 100644 docs/Irssi/TextUI/Textbuffer.pm delete mode 100644 docs/Irssi/Theme.pm delete mode 100644 docs/Irssi/UI/Theme.pm delete mode 100644 docs/Irssi/UI/Window.pm delete mode 100644 docs/Irssi/Window.pm delete mode 100644 docs/Irssi/Windowitem.pm delete mode 100644 docs/Signals.pm (limited to 'docs') diff --git a/docs/Guide.pm b/docs/Guide.pm deleted file mode 100644 index 4f78fc0..0000000 --- a/docs/Guide.pm +++ /dev/null @@ -1,158 +0,0 @@ -__END__ - -=head1 NAME - -Guide To Irssi Scripting. - -=head1 DESCRIPTION - -=head1 LOADING AND UNLOADING SCRIPTS - -=head2 File Locations - -=head2 Testing - -=head2 Loading - -Scripts are loaded via C>. A default Irssi -configuration also provides the C alias as an alternative to C. - - -=head2 Unloading - -A script can be unloaded via the C> command. The name is -typically the script filename without the F<.pl> extension, so F -becomes C. - -As part of the unloading process, if the script contains a - - sub UNLOAD { - ... - } - -function, it will be run just before the script is unloaded and all variables -destroyed. This can be used to clean up any temporary files, shut down any -network connections or processes, and restore any Irssi modifications made. - -=head1 ANATOMY OF A SCRIPT - -In this section, we develop a very simplistic script and look at the -necessary code. - -=head2 Preamble - -=head1 COMMONLY SCRIPTED TASKS - -=head2 Modifying an input line before sending - -=head2 Responding to a public message - -=head2 Responding to a private message - -=head1 USEFUL THINGS - -=head2 Sharing Code Between Scripts - -There are 2 main ways for scripts to communicate, either via emitting and -handling Irssi signals, or by calling functions from one another directly. - -=head3 Using Signals - -=head3 Using Functions - -=head2 If In Doubt, Dump! - -C is an extremely good way to inspect Irssi internals if you're -looking for an undocumented feature. - -The C alias by L provides an easy way to -check object fields. - -Dump perl object (e.g. C): - - /alias DUMP script exec use Data::Dumper\; print Data::Dumper->new([\\$0-])->Dump - -=head2 Making Scripts Act Native - -An important part of creating a good script is to make it behave as though it -were a part of Irssi. Adhering to some of the standard conventions can make this -easier. - -=head3 Provide Help - -Scripts commonly store information about how to use them in comments at the top -of their file. Whilst better than no documentation at all, a preferable approach -is to allow that help to be accessed from within Irssi itself, using the C -command. - -B - - -=head3 Use Tab Completion - -One of the great features of Irssi is the ability to complete commands, -subcommands and even certain arguments. - -=head3 Use Settings for Customisation - -B - -B - -B - -=head3 Use Subcommands to Group Script Functionality - -A common theme in Irssi scripts is to define commands with a prefix, such as -C, C, etc. This helps to avoid accidentally clobbering -native commands and those defined by other scripts, but is a problem better solved -with I. - -Subcommands allow you to bind commands such as C and C. -Completions are automatically handled for both the primary command, and any -subcommands contained within it. - -The following example demonstrates how to use subcommands from within a script: - - Irssi::command_bind("foo bar", \&subcmd_bar); - Irssi::command_bind("foo", \&subcmd_handler); - - sub subcmd_handler { - my ($data, $server, $item) = @_; - $data =~ s/\s+$//g; - Irssi::command_runsub('foo', $data, $server, $item); - } - - sub subcmd_bar { - my ($args) = @_; - print "subcommand called with: $args"; - } - -=head1 OTHER RESOURCES - -The documentation assembled here and elsewhere on this site has been drawn from -many different places, and a lot of valuable information is available from the -following sites. - - -=over - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=back diff --git a/docs/Guide.pod b/docs/Guide.pod new file mode 100644 index 0000000..4f78fc0 --- /dev/null +++ b/docs/Guide.pod @@ -0,0 +1,158 @@ +__END__ + +=head1 NAME + +Guide To Irssi Scripting. + +=head1 DESCRIPTION + +=head1 LOADING AND UNLOADING SCRIPTS + +=head2 File Locations + +=head2 Testing + +=head2 Loading + +Scripts are loaded via C>. A default Irssi +configuration also provides the C alias as an alternative to C. + + +=head2 Unloading + +A script can be unloaded via the C> command. The name is +typically the script filename without the F<.pl> extension, so F +becomes C. + +As part of the unloading process, if the script contains a + + sub UNLOAD { + ... + } + +function, it will be run just before the script is unloaded and all variables +destroyed. This can be used to clean up any temporary files, shut down any +network connections or processes, and restore any Irssi modifications made. + +=head1 ANATOMY OF A SCRIPT + +In this section, we develop a very simplistic script and look at the +necessary code. + +=head2 Preamble + +=head1 COMMONLY SCRIPTED TASKS + +=head2 Modifying an input line before sending + +=head2 Responding to a public message + +=head2 Responding to a private message + +=head1 USEFUL THINGS + +=head2 Sharing Code Between Scripts + +There are 2 main ways for scripts to communicate, either via emitting and +handling Irssi signals, or by calling functions from one another directly. + +=head3 Using Signals + +=head3 Using Functions + +=head2 If In Doubt, Dump! + +C is an extremely good way to inspect Irssi internals if you're +looking for an undocumented feature. + +The C alias by L provides an easy way to +check object fields. + +Dump perl object (e.g. C): + + /alias DUMP script exec use Data::Dumper\; print Data::Dumper->new([\\$0-])->Dump + +=head2 Making Scripts Act Native + +An important part of creating a good script is to make it behave as though it +were a part of Irssi. Adhering to some of the standard conventions can make this +easier. + +=head3 Provide Help + +Scripts commonly store information about how to use them in comments at the top +of their file. Whilst better than no documentation at all, a preferable approach +is to allow that help to be accessed from within Irssi itself, using the C +command. + +B + + +=head3 Use Tab Completion + +One of the great features of Irssi is the ability to complete commands, +subcommands and even certain arguments. + +=head3 Use Settings for Customisation + +B + +B + +B + +=head3 Use Subcommands to Group Script Functionality + +A common theme in Irssi scripts is to define commands with a prefix, such as +C, C, etc. This helps to avoid accidentally clobbering +native commands and those defined by other scripts, but is a problem better solved +with I. + +Subcommands allow you to bind commands such as C and C. +Completions are automatically handled for both the primary command, and any +subcommands contained within it. + +The following example demonstrates how to use subcommands from within a script: + + Irssi::command_bind("foo bar", \&subcmd_bar); + Irssi::command_bind("foo", \&subcmd_handler); + + sub subcmd_handler { + my ($data, $server, $item) = @_; + $data =~ s/\s+$//g; + Irssi::command_runsub('foo', $data, $server, $item); + } + + sub subcmd_bar { + my ($args) = @_; + print "subcommand called with: $args"; + } + +=head1 OTHER RESOURCES + +The documentation assembled here and elsewhere on this site has been drawn from +many different places, and a lot of valuable information is available from the +following sites. + + +=over + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=back diff --git a/docs/Irssi.pm b/docs/Irssi.pm deleted file mode 100644 index 11837d4..0000000 --- a/docs/Irssi.pm +++ /dev/null @@ -1,563 +0,0 @@ -__END__ - -=head1 NAME - -Irssi.pm - -=head1 DESCRIPTION - -L is a console based fullscreen IRC client. It is -written in the C programming language, and can be modified through both -I -- dynamically loadable compiled libraries -- and I, written -in L. - -Modules are not covered in this documentation, other than to note that Perl -scripting support itself may be compiled as a module rather than built directly -into Irssi. The C command can be used from within Irssi to check if Perl -support is available. If not, refer to the F file for how to recompile -irssi. - -The C package is the basis of Perl scripting in Irssi. It does not export any -functions, and requires that all function-calls be fully qualified with the -C> prefix. - -=head1 CLASSES - -This documentation has been split into a number of pages, each documenting a -particular class or pseudo-class. The following list contains all of these -additional pages. - -=over 4 - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=item L - -=back - - -=head1 EXPORTS - -Nothing by default, but passing a list of function names when Cing the module -will import them into the current namespace. - -For example: - - use Irssi qw/signal_emit signal_add .../; - -=head1 METHODS - -=head2 Accessors - -=head3 active_win - -C - -returns the currently active L - -=head3 active_server - -C - -returns the currently active L in active window. - -=head3 windows - -returns a list of all L. - -=head3 servers - -returns a list of all L. - -=head3 reconnects - -returns a list of all L. - -=head3 channels - -returns a list of all L. - -=head3 queries - -returns a list of all L. - -=head3 commands - -returns a list of all L. - -=head3 logs - -returns a list of all L. - -=head3 ignores - -returns a list of all L. - -=head3 dccs - -returns a list of all L - -=head2 Signals - -See also L - -Irssi is pretty much based on sending and handling different signals. -Like when you receive a message from server, say: - -C<:nick!user@there.org PRIVMSG you :blahblah> - -Irssi will first send a signal: - -C<"server incoming", SERVER_REC, "nick!user@there PRIVMSG ..."> - -You probably don't want to use this signal. Default handler for this -signal interprets the header and sends a signal: - -C<"server event", Irssi::Server, "PRIVMSG ...", "nick", "user@there.org"> - -You probably don't want to use this either, since this signal's default -handler parses the event string and sends a signal: - -C<"event privmsg", Irssi::Server, "you :blahblah", "nick", "user@there.org"> - -You can at any point grab the signal, do whatever you want to do with -it and optionally stop it from going any further by calling -L - -For example: - - sub event_privmsg { - # $data = "nick/#channel :text" - my ($server, $data, $nick, $address) = @_; - my ($target, $text) = split(/ :/, $data, 2); - - Irssi::signal_stop() if ($text =~ /free.*porn/ || $nick =~ /idiot/); - } - - Irssi::signal_add("event privmsg", "event_privmsg"); - -This will hide all public or private messages that match the regexp -C<"free.*porn"> or the sender's nick contain the word "idiot". Yes, you -could use /IGNORE instead for both of these C<:)> - -You can also use L if you wish to let the -Irssi's internal functions be run before yours. - -A list of signals that irssi sends can be found in the L documentation. - - - - -=head3 Handling Signals - -=head4 C - -Bind C<$sig_name> to function C<$func>. The C<$func> argument may be either -a string containing the name of a function to call, or a coderef. - -For example: - - Irssi::signal_add("default command", sub { ... }); - - Irssi::signal_add("default command", "my_function"); - - Irssi::signal_add("default command", \&my_function); - -In all cases, the specified function will be passed arguments in C<@_> as specified -in L. - -=head4 C - -Bind C<$sig_name> to function C<$func>. Call C<$func> as soon as possible when -the signal is raised. - -=head4 C - -Bind C<$sig_name> to function C<$func>. Call C<$func> as late as possible (after -all other signal handlers). - -=head4 C - -Unbind C<$sig_name> from function C<$func>. -B coderef? What happens?> - - -=head3 Controlling Signal Propagation - -=head4 C - -Send a signal of type C<$sig_name>. Up to 6 parameters can be passed in C<@params>. - -=head4 C - -Propagate a currently emitted signal, but with different parameters. This only -needs to be called if you wish to change them, otherwise all subsequent handlers -will be invoked as normal. - -B - -=head4 C - -Stop the signal that's currently being emitted, no other handlers after this one will -be called. - -=head4 C - -Stop the signal with name C<$sig_name> that is currently being emitted. - -=head3 Registering New Signals - -=head4 C - -Register parameter types for one or more signals. C<$hashref> must map one or -more signal names to references to arrays containing 0 to 6 type names. Some -recognized type names include int for integers, intptr for references to -integers and string for strings. For all standard signals see -F in the source code (this is generated by -F). - -For example: - - my $signal_config_hash = { "new signal" => [ qw/string string integer/ ] }; - Irssi::signal_register($signal_config_hash); - -Any signals that were already registered are unaffected. - -B Once registered, a signal cannot be unregistered without -restarting Irssi. B, including modifying the type signature. - -Registration is required to get any parameters to signals written in -Perl and to emit and continue signals from Perl. - -B - - - - -=head2 Commands - -See also L - -=head3 Registering Commands - -=head4 C - -Bind a command string C<$cmd> to call function C<$func>. C<$func> can be -either a string or coderef. C<$category> is an optional string specifying -the category to display the command in when C is used. - -=head4 C - -Run subcommands for `cmd'. First word in `data' is parsed as -subcommand. `server' is L record for current -L `item'. - -Call command_runsub in handler function for `cmd' and bind -with command_bind("`cmd' `subcmd'", subcmdfunc[, category]); - -B - -=head4 C - -Unbind command C<$cmd> from function C<$func>. - -=head3 Invoking Commands - -=head4 C - -Run the command specified in C<$string> in the currently active context. - -B vs concatenating into the command string?> - -See also L - -=head3 Parsing Command Arguments - -=head4 C - -Set options for command C<$cmd> to C<$data>. C<$data> is a string of -space separated words which specify the options. Each word can be -optionally prefixed with one of the following character: - -=over 16 - -=item C<->: optional argument - -=item C<@>: optional numeric argument - -=item C<+>: required argument - -=back - -For example: - - my $argument_format = "+something -other -another @number"; - Irssi::command_set_options('mycmd', $argument_format); - -Thus, the command may be run as C. - -=head4 C - -Parse out options as specified by L for command C<$cmd>. A string containing the input received by the -command handler should be passed in as C<$data>. - -The return value is either C if an error occurred, or a list containing -two items. The first is a hashref mapping the option names to their -values. Optional arguments which were not present in the input will not be -included in the hash. - -The second item in the return list is a string containing the remainder of the input -after the arguments have been parsed out. - -For example: - - sub my_cmd_handler { - my ($command_args) = @_; - my @options_list = Irssi::command_parse_options "my_cmd", $command_args; - if (@options_list) { - my $options = $options_list->[0]; - my $arg_remainder = $options_list->[1]; - - if (exists $options->{other} && $options->{something} eq 'hello') { - - ... - - } - } - } - -=head2 Settings - - -=head3 Creating New Settings - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head4 C - - -=head3 Retrieving Settings - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head3 Modifying Settings - -Set value for setting. - -B signal afterwards.> - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -=head4 C - -Remove a setting. - - -=head2 IO and Process Management - -timeout_add(msecs, func, data) - Call `func' every `msecs' milliseconds (1000 = 1 second) with - parameter `data'. Returns tag which can be used to stop the timeout. - -timeout_add_once(msecs, func, data); - Call `func' once after `msecs' milliseconds (1000 = 1 second) - with parameter `data'. Returns tag which can be used to stop the timeout. - -timeout_remove(tag) - Remove timeout with tag. - -input_add(source, condition, func, data) - Call `func' with parameter `data' when specified IO happens. - `source' is the file handle that is being listened. `condition' can - be INPUT_READ, INPUT_WRITE or both. Returns tag which can be used to - remove the listener. - -input_remove(tag) - Remove listener with tag. - -pidwait_add(pid) - Adds `pid' to the list of processes to wait for. The pid must identify - a child process of the irssi process. When the process terminates, a - "pidwait" signal will be sent with the pid and the status from - waitpid(). This is useful to avoid zombies if your script forks. - -pidwait_remove(pid) - Removes `pid' from the list of processes to wait for. Terminated - processes are removed automatically, so it is usually not necessary - to call this function. - - - -=head2 Message Levels - -level2bits(level) - Level string -> number - -bits2level(bits) - Level number -> string - -combine_level(level, str) - Combine level number to level string ("+level -level"). - Return new level number. - - -=head2 Themes - -See also L - -You can have user configurable texts in scripts that work just like -irssi's internal texts that can be changed in themes. - -First you'll have to register the formats: - - -Irssi::theme_register([ - 'format_name', '{hilight my perl format!}', - 'format2', 'testing.. nick = $0, channel = $1' -]); - -Printing happens with one of the functions: - -printformat(level, format, ...) -Window::printformat(level, format, ...) -Server::printformat(target, level, format, ...) -Windowitem::printformat(level, format, ...) - -For example: - - $channel->printformat(MSGLEVEL_CRAP, 'format2', - 'nick', $channel->{name}); - - -=head2 DCC - -See also L - -Dcc -dcc_find_item(type, nick, arg) - Find DCC connection. - -Dcc -dcc_find_by_port(nick, port) - Find DCC connection by port. - - -=head2 Channels - -Channel -channel_find(channel) - Find channel from any server. - -=head2 Ignores - - -ignore_add_rec(ignore) - Add ignore record. - -ignore_update_rec(ignore) - Update ignore record in configuration - -ignore_check(nick, host, channel, text, level) - -=head2 Logging - - -Log -log_create_rec(fname, level) - Create log file. - - -Log -log_find(fname) - Find log with file name. - -=head2 Raw Logging - -Rawlog rawlog_create() - Create a new rawlog. - -rawlog_set_size(lines) - Set the default rawlog size for new rawlogs. - -=head2 Chat-Nets - -chatnet_find(name) - Find chat network with name. - -=head2 Status Bars - -B - -=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.pod b/docs/Irssi.pod new file mode 100644 index 0000000..11837d4 --- /dev/null +++ b/docs/Irssi.pod @@ -0,0 +1,563 @@ +__END__ + +=head1 NAME + +Irssi.pm + +=head1 DESCRIPTION + +L is a console based fullscreen IRC client. It is +written in the C programming language, and can be modified through both +I -- dynamically loadable compiled libraries -- and I, written +in L. + +Modules are not covered in this documentation, other than to note that Perl +scripting support itself may be compiled as a module rather than built directly +into Irssi. The C command can be used from within Irssi to check if Perl +support is available. If not, refer to the F file for how to recompile +irssi. + +The C package is the basis of Perl scripting in Irssi. It does not export any +functions, and requires that all function-calls be fully qualified with the +C> prefix. + +=head1 CLASSES + +This documentation has been split into a number of pages, each documenting a +particular class or pseudo-class. The following list contains all of these +additional pages. + +=over 4 + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=item L + +=back + + +=head1 EXPORTS + +Nothing by default, but passing a list of function names when Cing the module +will import them into the current namespace. + +For example: + + use Irssi qw/signal_emit signal_add .../; + +=head1 METHODS + +=head2 Accessors + +=head3 active_win + +C + +returns the currently active L + +=head3 active_server + +C + +returns the currently active L in active window. + +=head3 windows + +returns a list of all L. + +=head3 servers + +returns a list of all L. + +=head3 reconnects + +returns a list of all L. + +=head3 channels + +returns a list of all L. + +=head3 queries + +returns a list of all L. + +=head3 commands + +returns a list of all L. + +=head3 logs + +returns a list of all L. + +=head3 ignores + +returns a list of all L. + +=head3 dccs + +returns a list of all L + +=head2 Signals + +See also L + +Irssi is pretty much based on sending and handling different signals. +Like when you receive a message from server, say: + +C<:nick!user@there.org PRIVMSG you :blahblah> + +Irssi will first send a signal: + +C<"server incoming", SERVER_REC, "nick!user@there PRIVMSG ..."> + +You probably don't want to use this signal. Default handler for this +signal interprets the header and sends a signal: + +C<"server event", Irssi::Server, "PRIVMSG ...", "nick", "user@there.org"> + +You probably don't want to use this either, since this signal's default +handler parses the event string and sends a signal: + +C<"event privmsg", Irssi::Server, "you :blahblah", "nick", "user@there.org"> + +You can at any point grab the signal, do whatever you want to do with +it and optionally stop it from going any further by calling +L + +For example: + + sub event_privmsg { + # $data = "nick/#channel :text" + my ($server, $data, $nick, $address) = @_; + my ($target, $text) = split(/ :/, $data, 2); + + Irssi::signal_stop() if ($text =~ /free.*porn/ || $nick =~ /idiot/); + } + + Irssi::signal_add("event privmsg", "event_privmsg"); + +This will hide all public or private messages that match the regexp +C<"free.*porn"> or the sender's nick contain the word "idiot". Yes, you +could use /IGNORE instead for both of these C<:)> + +You can also use L if you wish to let the +Irssi's internal functions be run before yours. + +A list of signals that irssi sends can be found in the L documentation. + + + + +=head3 Handling Signals + +=head4 C + +Bind C<$sig_name> to function C<$func>. The C<$func> argument may be either +a string containing the name of a function to call, or a coderef. + +For example: + + Irssi::signal_add("default command", sub { ... }); + + Irssi::signal_add("default command", "my_function"); + + Irssi::signal_add("default command", \&my_function); + +In all cases, the specified function will be passed arguments in C<@_> as specified +in L. + +=head4 C + +Bind C<$sig_name> to function C<$func>. Call C<$func> as soon as possible when +the signal is raised. + +=head4 C + +Bind C<$sig_name> to function C<$func>. Call C<$func> as late as possible (after +all other signal handlers). + +=head4 C + +Unbind C<$sig_name> from function C<$func>. +B coderef? What happens?> + + +=head3 Controlling Signal Propagation + +=head4 C + +Send a signal of type C<$sig_name>. Up to 6 parameters can be passed in C<@params>. + +=head4 C + +Propagate a currently emitted signal, but with different parameters. This only +needs to be called if you wish to change them, otherwise all subsequent handlers +will be invoked as normal. + +B + +=head4 C + +Stop the signal that's currently being emitted, no other handlers after this one will +be called. + +=head4 C + +Stop the signal with name C<$sig_name> that is currently being emitted. + +=head3 Registering New Signals + +=head4 C + +Register parameter types for one or more signals. C<$hashref> must map one or +more signal names to references to arrays containing 0 to 6 type names. Some +recognized type names include int for integers, intptr for references to +integers and string for strings. For all standard signals see +F in the source code (this is generated by +F). + +For example: + + my $signal_config_hash = { "new signal" => [ qw/string string integer/ ] }; + Irssi::signal_register($signal_config_hash); + +Any signals that were already registered are unaffected. + +B Once registered, a signal cannot be unregistered without +restarting Irssi. B, including modifying the type signature. + +Registration is required to get any parameters to signals written in +Perl and to emit and continue signals from Perl. + +B + + + + +=head2 Commands + +See also L + +=head3 Registering Commands + +=head4 C + +Bind a command string C<$cmd> to call function C<$func>. C<$func> can be +either a string or coderef. C<$category> is an optional string specifying +the category to display the command in when C is used. + +=head4 C + +Run subcommands for `cmd'. First word in `data' is parsed as +subcommand. `server' is L record for current +L `item'. + +Call command_runsub in handler function for `cmd' and bind +with command_bind("`cmd' `subcmd'", subcmdfunc[, category]); + +B + +=head4 C + +Unbind command C<$cmd> from function C<$func>. + +=head3 Invoking Commands + +=head4 C + +Run the command specified in C<$string> in the currently active context. + +B vs concatenating into the command string?> + +See also L + +=head3 Parsing Command Arguments + +=head4 C + +Set options for command C<$cmd> to C<$data>. C<$data> is a string of +space separated words which specify the options. Each word can be +optionally prefixed with one of the following character: + +=over 16 + +=item C<->: optional argument + +=item C<@>: optional numeric argument + +=item C<+>: required argument + +=back + +For example: + + my $argument_format = "+something -other -another @number"; + Irssi::command_set_options('mycmd', $argument_format); + +Thus, the command may be run as C. + +=head4 C + +Parse out options as specified by L for command C<$cmd>. A string containing the input received by the +command handler should be passed in as C<$data>. + +The return value is either C if an error occurred, or a list containing +two items. The first is a hashref mapping the option names to their +values. Optional arguments which were not present in the input will not be +included in the hash. + +The second item in the return list is a string containing the remainder of the input +after the arguments have been parsed out. + +For example: + + sub my_cmd_handler { + my ($command_args) = @_; + my @options_list = Irssi::command_parse_options "my_cmd", $command_args; + if (@options_list) { + my $options = $options_list->[0]; + my $arg_remainder = $options_list->[1]; + + if (exists $options->{other} && $options->{something} eq 'hello') { + + ... + + } + } + } + +=head2 Settings + + +=head3 Creating New Settings + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head4 C + + +=head3 Retrieving Settings + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head3 Modifying Settings + +Set value for setting. + +B signal afterwards.> + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +=head4 C + +Remove a setting. + + +=head2 IO and Process Management + +timeout_add(msecs, func, data) + Call `func' every `msecs' milliseconds (1000 = 1 second) with + parameter `data'. Returns tag which can be used to stop the timeout. + +timeout_add_once(msecs, func, data); + Call `func' once after `msecs' milliseconds (1000 = 1 second) + with parameter `data'. Returns tag which can be used to stop the timeout. + +timeout_remove(tag) + Remove timeout with tag. + +input_add(source, condition, func, data) + Call `func' with parameter `data' when specified IO happens. + `source' is the file handle that is being listened. `condition' can + be INPUT_READ, INPUT_WRITE or both. Returns tag which can be used to + remove the listener. + +input_remove(tag) + Remove listener with tag. + +pidwait_add(pid) + Adds `pid' to the list of processes to wait for. The pid must identify + a child process of the irssi process. When the process terminates, a + "pidwait" signal will be sent with the pid and the status from + waitpid(). This is useful to avoid zombies if your script forks. + +pidwait_remove(pid) + Removes `pid' from the list of processes to wait for. Terminated + processes are removed automatically, so it is usually not necessary + to call this function. + + + +=head2 Message Levels + +level2bits(level) + Level string -> number + +bits2level(bits) + Level number -> string + +combine_level(level, str) + Combine level number to level string ("+level -level"). + Return new level number. + + +=head2 Themes + +See also L + +You can have user configurable texts in scripts that work just like +irssi's internal texts that can be changed in themes. + +First you'll have to register the formats: + + +Irssi::theme_register([ + 'format_name', '{hilight my perl format!}', + 'format2', 'testing.. nick = $0, channel = $1' +]); + +Printing happens with one of the functions: + +printformat(level, format, ...) +Window::printformat(level, format, ...) +Server::printformat(target, level, format, ...) +Windowitem::printformat(level, format, ...) + +For example: + + $channel->printformat(MSGLEVEL_CRAP, 'format2', + 'nick', $channel->{name}); + + +=head2 DCC + +See also L + +Dcc +dcc_find_item(type, nick, arg) + Find DCC connection. + +Dcc +dcc_find_by_port(nick, port) + Find DCC connection by port. + + +=head2 Channels + +Channel +channel_find(channel) + Find channel from any server. + +=head2 Ignores + + +ignore_add_rec(ignore) + Add ignore record. + +ignore_update_rec(ignore) + Update ignore record in configuration + +ignore_check(nick, host, channel, text, level) + +=head2 Logging + + +Log +log_create_rec(fname, level) + Create log file. + + +Log +log_find(fname) + Find log with file name. + +=head2 Raw Logging + +Rawlog rawlog_create() + Create a new rawlog. + +rawlog_set_size(lines) + Set the default rawlog size for new rawlogs. + +=head2 Chat-Nets + +chatnet_find(name) + Find chat network with name. + +=head2 Status Bars + +B + +=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/Ban.pm b/docs/Irssi/Ban.pm deleted file mode 100644 index ba8381f..0000000 --- a/docs/Irssi/Ban.pm +++ /dev/null @@ -1,15 +0,0 @@ -__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 deleted file mode 100644 index bb6789d..0000000 --- a/docs/Irssi/Channel.pm +++ /dev/null @@ -1,79 +0,0 @@ -__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.pm b/docs/Irssi/Chatnet.pm deleted file mode 100644 index 23fa134..0000000 --- a/docs/Irssi/Chatnet.pm +++ /dev/null @@ -1,24 +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 - diff --git a/docs/Irssi/Client.pm b/docs/Irssi/Client.pm deleted file mode 100644 index e07bed7..0000000 --- a/docs/Irssi/Client.pm +++ /dev/null @@ -1,20 +0,0 @@ -__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.pm b/docs/Irssi/Command.pm deleted file mode 100644 index d777794..0000000 --- a/docs/Irssi/Command.pm +++ /dev/null @@ -1,12 +0,0 @@ -__END__ - -=head1 NAME - -=head1 FIELDS - - Command->{} - cmd - Command name - category - Category - -=head1 METHODS - diff --git a/docs/Irssi/Dcc.pm b/docs/Irssi/Dcc.pm deleted file mode 100644 index 546f112..0000000 --- a/docs/Irssi/Dcc.pm +++ /dev/null @@ -1,65 +0,0 @@ -__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 deleted file mode 100644 index 108c0ba..0000000 --- a/docs/Irssi/Ignore.pm +++ /dev/null @@ -1,22 +0,0 @@ -__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 deleted file mode 100644 index 673a183..0000000 --- a/docs/Irssi/Log.pm +++ /dev/null @@ -1,46 +0,0 @@ -__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.pm b/docs/Irssi/Logitem.pm deleted file mode 100644 index 6db0c7b..0000000 --- a/docs/Irssi/Logitem.pm +++ /dev/null @@ -1,16 +0,0 @@ -__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.pm b/docs/Irssi/Nick.pm deleted file mode 100644 index b20d43a..0000000 --- a/docs/Irssi/Nick.pm +++ /dev/null @@ -1,24 +0,0 @@ -__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.pm b/docs/Irssi/Notifylist.pm deleted file mode 100644 index 5b2628a..0000000 --- a/docs/Irssi/Notifylist.pm +++ /dev/null @@ -1,21 +0,0 @@ -__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 deleted file mode 100644 index 4b311a2..0000000 --- a/docs/Irssi/Process.pm +++ /dev/null @@ -1,22 +0,0 @@ -__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_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 deleted file mode 100644 index c823a4a..0000000 --- a/docs/Irssi/Query.pm +++ /dev/null @@ -1,28 +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 - -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 deleted file mode 100644 index 7f89c64..0000000 --- a/docs/Irssi/Rawlog.pm +++ /dev/null @@ -1,40 +0,0 @@ -__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.pm b/docs/Irssi/Reconnect.pm deleted file mode 100644 index 4085eec..0000000 --- a/docs/Irssi/Reconnect.pm +++ /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.pm b/docs/Irssi/Script.pm deleted file mode 100644 index 9f8b07b..0000000 --- a/docs/Irssi/Script.pm +++ /dev/null @@ -1,10 +0,0 @@ -__END__ - -=head1 NAME - -Irssi::Script - -=head1 FIELDS - -=head1 METHODS - diff --git a/docs/Irssi/Server.pm b/docs/Irssi/Server.pm deleted file mode 100644 index dfb8500..0000000 --- a/docs/Irssi/Server.pm +++ /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 - -Server::channels() - return list of channels in server -Server::queries() - return list of queries in server -Server::print(channel, str[, level]) - -=head2 C - -Run the specified command on this server instance. - - -Server -Connect::connect() - Connect to server. - -Server::disconnect() - Disconnect from server. - -Server -server_find_tag(tag) - Find server with tag - -Server -server_find_chatnet(chatnet) - Find first server that is in `chatnet' - -Server::isnickflag(flag) - Returns 1 if flag is a nick mode flag (@, + or % in IRC) - -Server::ischannel(data) - Returns 1 if start of `data' seems to mean channel. - -Server::get_nick_flags() - Returns nick flag characters in order: op, voice, halfop ("@+%" in IRC). - -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/TextUI.pm b/docs/Irssi/TextUI.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/TextUI/Line.pm b/docs/Irssi/TextUI/Line.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/TextUI/LineCache.pm b/docs/Irssi/TextUI/LineCache.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/TextUI/LineInfo.pm b/docs/Irssi/TextUI/LineInfo.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/TextUI/MainWindow.pm b/docs/Irssi/TextUI/MainWindow.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/TextUI/StatusbarItem.pm b/docs/Irssi/TextUI/StatusbarItem.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/TextUI/TextBufferView.pm b/docs/Irssi/TextUI/TextBufferView.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/TextUI/Textbuffer.pm b/docs/Irssi/TextUI/Textbuffer.pm deleted file mode 100644 index e69de29..0000000 diff --git a/docs/Irssi/Theme.pm b/docs/Irssi/Theme.pm deleted file mode 100644 index 72ab9e1..0000000 --- a/docs/Irssi/Theme.pm +++ /dev/null @@ -1,4 +0,0 @@ -__END__ - -=head1 Deprecated - diff --git a/docs/Irssi/UI/Theme.pm b/docs/Irssi/UI/Theme.pm deleted file mode 100644 index 56e3a3f..0000000 --- a/docs/Irssi/UI/Theme.pm +++ /dev/null @@ -1,8 +0,0 @@ -=head1 NAME - -Irssi::UI::Theme - -=head1 FIELDS - -=head1 METHODS - diff --git a/docs/Irssi/UI/Window.pm b/docs/Irssi/UI/Window.pm deleted file mode 100644 index a00827e..0000000 --- a/docs/Irssi/UI/Window.pm +++ /dev/null @@ -1,116 +0,0 @@ -__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.pm b/docs/Irssi/Window.pm deleted file mode 100644 index 981a524..0000000 --- a/docs/Irssi/Window.pm +++ /dev/null @@ -1,3 +0,0 @@ -__END__ - -=head1 DEPRECATED. diff --git a/docs/Irssi/Windowitem.pm b/docs/Irssi/Windowitem.pm deleted file mode 100644 index 7781a44..0000000 --- a/docs/Irssi/Windowitem.pm +++ /dev/null @@ -1,55 +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 - -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. diff --git a/docs/Signals.pm b/docs/Signals.pm deleted file mode 100644 index 570214c..0000000 --- a/docs/Signals.pm +++ /dev/null @@ -1,2405 +0,0 @@ -__END__ - -=head1 NAME - -Irssi Signal Documentation - -=head1 DESCRIPTION - -Perl POD documentation based on the doc/signals.txt documentation supplied with -Irssi. - -=head1 USING SIGNALS - -See L - -=begin irssi_signal_types - -START OF SIGNAL TYPES - -=over - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - - - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - - -=item C C - -=item C C - -=item C C - - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - -=item C C - - - -=item C C - -=back - -END OF SIGNAL TYPES - -=end irssi_signal_types - -=head1 SIGNAL DEFINITIONS - -The following signals are categorised as in the original documentation, but -have been revised to note Perl variable types and class names. - -Arguments are passed to signal handlers in the usual way, via C<@_>. - -=for irssi_signal_defs START OF SIGNAL DEFINITIONS - -=head2 Core - -=over 4 - -=item C<"gui exit"> - -=over - -=item I - -=back - -=item C<"gui dialog"> - -=over - -=item string C<$type> - -=item string C<$text> - -=back - -=item C<"send command"> - -=over - -=item C, - -=item L C<$server>, - -=item L C<$window_item> - -=back - -This is sent when a command is entered via the GUI, or by scripts via L. - -=back - -=head3 F: - -B - -=over 4 - -=item C<"chat protocol created"> - -=over - -=item CHAT_PROTOCOL_REC C<$protocol> - -=back - -=item C<"chat protocol updated"> - -=over - -=item CHAT_PROTOCOL_REC C<$protocol> - -=back - -=item C<"chat protocol destroyed"> - -=over - -=item CHAT_PROTOCOL_REC C<$protocol> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"channel created"> - -=over - -=item L C<$channel> - -=item int C<$automatic> - -=back - -=item C<"channel destroyed"> - -=over - -=item L C<$channel> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"chatnet created"> - -=over - -=item CHATNET_REC C<$chatnet> - -=back - -=item C<"chatnet destroyed"> - -=over - -=item CHATNET_REC C<$chatnet> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"commandlist new"> - -=over - -=item L C<$cmd> - -=back - -=item C<"commandlist remove"> - -=over - -=item L C<$cmd> - -=back - -=item C<"error command"> - -=over - -=item int C<$err> - -=item string C<$cmd> - -=back - -=item C<"send command"> - -=over - -=item string C<$args> - -=item L C<$server> - -=item L C<$witem> - -=back - -=item C<"send text"> - -=over - -=item string C<$line> - -=item L C<$server> - -=item L C<$witem> - -=back - -=item C<"command "> - -=over - -=item string C<$args> - -=item L C<$server> - -=item L C<$witem> - -=back - -B - -=item C<"default command"> - -=over - -=item string C<$args> - -=item L C<$server> - -=item L C<$witem> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"ignore created"> - -=over - -=item L C<$ignore> - -=back - -=item C<"ignore destroyed"> - -=over - -=item L C<$ignore> - -=back - -=item C<"ignore changed"> - -=over - -=item L C<$ignore> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"log new"> - -=over - -=item L C<$log> - -=back - -=item C<"log remove"> - -=over - -=item L C<$log> - -=back - -=item C<"log create failed"> - -=over - -=item L C<$log> - -=back - -=item C<"log locked"> - -=over - -=item L C<$log> - -=back - -=item C<"log started"> - -=over - -=item L C<$log> - -=back - -=item C<"log stopped"> - -=over - -=item L C<$log> - -=back - -=item C<"log rotated"> - -=over - -=item L C<$log> - -=back - -=item C<"log written"> - -=over - -=item L C<$log> - -=item string C<$line> - -=back - -=back - -=head3 F: - -B - -=over 4 - -=item C<"module loaded"> - -=over - -=item MODULE_REC C<$module> - -=item MODULE_FILE_REC C<$module_file> - -=back - -=item C<"module unloaded"> - -=over - -=item MODULE_REC C<$module> - -=item MODULE_FILE_REC C<$module_file> - -=back - -=item C<"module error"> - -=over - -=item int C<$error> - -=item string C<$text> - -=item string C<$root_module> - -=item string C<$sub_module> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"nicklist new"> - -=over - -=item L C<$channel> - -=item L C<$nick> - -=back - -=item C<"nicklist remove"> - -=over - -=item L C<$channel> - -=item L C<$nick> - -=back - -=item C<"nicklist changed"> - -=over - -=item L C<$channel> - -=item L C<$nick> - -=item string C<$old_nick> - -=back - -=item C<"nicklist host changed"> - -=over - -=item L C<$channel> - -=item L C<$nick> - -=back - -=item C<"nicklist gone changed"> - -=over - -=item L C<$channel> - -=item L C<$nick> - -=back - -=item C<"nicklist serverop changed"> - -=over - -=item L C<$channel> - -=item L C<$nick> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"pidwait"> - -=over - -=item int C<$pid> - -=item int C<$status> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"query created"> - -=over - -=item L C<$query> - -=item int C<$automatic> - -=back - -=item C<"query destroyed"> - -=over - -=item L C<$query> - -=back - -=item C<"query nick changed"> - -=over - -=item L C<$query> - -=item string C<$original_nick> - -=back - -=item C<"window item name changed"> - -=over - -=item L C<$witem> - -=back - -=item C<"query address changed"> - -=over - -=item L C<$query> - -=back - -=item C<"query server changed"> - -=over - -=item L C<$query> - -=item L C<$server> - -=back - -=back - - -=head3 F: - -=over 4 - -=item C<"rawlog"> - -=over - -=item L C<$raw_log> - -=item string C<$data> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"server looking"> - -=over - -=item L C<$server> - -=back - -=item C<"server connected"> - -=over - -=item L C<$server> - -=back - - -=item C<"server connecting"> - -=over - -=item L C<$server> - -=item ulongptr C<$ip> - -=back - -=item C<"server connect failed"> - -=over - -=item L C<$server> - -=back - -=item C<"server disconnected"> - -=over - -=item L C<$server> - -=back - -=item C<"server quit"> - -=over - -=item L C<$server> - -=item string C<$message> - -=back - -=item C<"server sendmsg"> - -=over - -=item L C<$server> - -=item string C<$target> - -=item string C<$message> - -=item int C<$target_type> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"setup changed"> - -=over - -=item I - -=back - -=item C<"setup reread"> - -=over - -=item string C<$fname> - -=back - -=item C<"setup saved"> - -=over - -=item string C<$fname> - -=item int C<$autosaved> - -=back - -=back - -=head2 IRC Core - -=head3 F: - -=over 4 - -=item C<"ban type changed"> - -=over - -=item string C<$bantype> - -=back - -=back - -=head3 F, F: - -B - -=over 4 - -=item C<"channel joined"> - -=over - -=item L C<$channel> - -=back - -=item C<"channel wholist"> - -=over - -=item L C<$channel> - -=back - -=item C<"channel sync"> - -=over - -=item L C<$channel> - -=back - -=item C<"channel topic changed"> - -=over - -=item L C<$channel> - -=back - -=back - -=head3 F: - -=over - -=item C<"ctcp msg"> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$nick> - -=item string C<$addr> - -=item string C<$target> - -=back - -=item C<"ctcp msg "> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$nick> - -=item string C<$addr> - -=item string C<$target> - -=back - -=item C<"default ctcp msg"> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$nick> - -=item string C<$addr> - -=item string C<$target> - -=back - -=item C<"ctcp reply"> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$nick> - -=item string C<$addr> - -=item string C<$target> - -=back - -=item C<"ctcp reply "> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$nick> - -=item string C<$addr> - -=item string C<$target> - -=back - -=item C<"default ctcp reply"> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$nick> - -=item string C<$addr> - -=item string C<$target> - -=back - -=item C<"ctcp action"> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$nick> - -=item string C<$addr> - -=item string C<$target> - -=back - -=back - -=head3 F: - -=over - -=item C<"awaylog show"> - -=over - -=item L C<$log> - -=item int C<$away_msgs> - -=item int C<$filepos> - -=back - -=back - -=head3 F: - -=over - -=item C<"server nick changed"> - -=over - -=item L C<$server> - -=back - -=back - -=head3 F: - -=over - -=item C<"event connected"> - -=over - -=item L C<$server> - -=back - -=back - -=head3 F: - -=over - -=item C<"server event"> - -=over - -=item L C<$server> - -=item string C<$data> - -=item string C<$sender_nick> - -=item string C<$sender_addr> - -=back - -=item C<"event "> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$sender_nick> - -=item string C<$sender_addr> - -=back - -=item C<"default event"> - -=over - -=item L C<$server> - -=item string C<$data> - -=item string C<$sender_nick> - -=item string C<$sender_addr> - -=back - -=item C<"whois default event"> - -=over - -=item L C<$server> - -=item string C<$data> - -=item string C<$sender_nick> - -=item string C<$sender_addr> - -=back - -=item C<"server incoming"> - -=over - -=item L C<$server> - -=item string C<$data> - -=back - -=item C<"redir "> - -=over - -=item L C<$server> - -=item string C<$args> - -=item string C<$sender_nick> - -=item string C<$sender_addr> - -=back - -=back - -=head3 F: - -=over - -=item C<"server lag"> - -=over - -=item L C<$server> - -=back - -=item C<"server lag disconnect"> - -=over - -=item L C<$server> - -=back - -=back - -=head3 F: - -=over - -=item C<"massjoin"> - -=over - -=item L C<$channel> - -=item List of L C<@nicks> - -B - -=back - -=back - -=head3 F: - -=over - -=item C<"ban new"> - -=over - -=item L C<$channel> - -=item L C<$ban> - -=back - -=item C<"ban remove"> - -=over - -=item L C<$channel> - -=item L C<$ban> - -=item string C<$set_by> - -=back - -=back - -=head3 F: - -=over - -=item C<"channel mode changed"> - -=over - -=item L C<$channel> - -=item string C<$set_by> - -=back - -=item C<"nick mode changed"> - -=over - -=item L C<$channel> - -=item L C<$nick> - -=item string C<$set_by> - -=item string C<$mode> - -=item string C<$type> - -=back - -=item C<"user mode changed"> - -=over - -=item L C<$server> - -=item string C<$old_mode> - -=back - -=item C<"away mode changed"> - -=over - -=item L C<$server> - -=back - -=back - -=head3 F: - -=over - -=item C<"netsplit server new"> - -=over - -=item L C<$server> - -=item L C<$netsplit_server> - -=back - -=item C<"netsplit server remove"> - -=over - -=item L C<$server> - -=item L C<$netsplit_server> - -=back - -=item C<"netsplit new"> - -=over - -=item L C<$netsplit> - -=back - -=item C<"netsplit remove"> - -=over - -=item L C<$netsplit> - -=back - -=back - -=head2 IRC Modules - - -=head3 F: - -=over - -=item C<"dcc ctcp "> - -=over - -=item string C<$args> - -=item L C<$dcc> - -=back - -=item C<"default dcc ctcp"> - -=over - -=item string C<$args> - -=item L C<$dcc> - -=back - -=item C<"dcc unknown ctcp"> - -=over - -=item string C<$args> - -=item string C<$sender> - -=item string C<$send_addr> - -=back - -=item C<"dcc reply "> - -=over - -=item string C<$args> - -=item L C<$dcc> - -=back - -=item C<"default dcc reply"> - -=over - -=item string C<$args> - -=item L C<$dcc> - -=back - -=item C<"dcc unknown reply"> - -=over - -=item string C<$args> - -=item string C<$sender> - -=item string C<$send_addr> - -=back - -=item C<"dcc chat message"> - -=over - -=item L C<$dcc> - -=item string C<$msg> - -=back - -=item C<"dcc created"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc destroyed"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc connected"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc rejecting"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc closed"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc request"> - -=over - -=item L C<$dcc> - -=item string C<$send_addr> - -=back - -=item C<"dcc request send"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc chat message"> - -=over - -=item L C<$dcc> - -=item string C<$msg> - -=back - -=item C<"dcc transfer update"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc get receive"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc error connect"> - -=over - -=item L C<$dcc> - -=back - -=item C<"dcc error file create"> - -=over - -=item L C<$dcc> - -=item string C<$filename> - -=back - -=item C<"dcc error file open"> - -=over - -=item string C<$nick> - -=item string C<$filename> - -=item int C<$errno> - -=back - -=item C<"dcc error get not found"> - -=over - -=item string C<$nick> - -=back - -=item C<"dcc error send exists"> - -=over - -=item string C<$nick> - -=item string C<$filename> - -=back - -=item C<"dcc error unknown type"> - -=over - -=item string C<$type> - -=back - -=item C<"dcc error close not found"> - -=over - -=item string C<$type> - -=item string C<$nick> - -=item string C<$filename> - -=back - -=back - -=head3 F: - -=over - -=item C<"autoignore new"> - -=over - -=item L C<$server> - -=item L C<$autoignore> - -=back - -=item C<"autoignore remove"> - -=over - -=item L C<$server> - -=item L C<$autoignore> - -=back - -=back - -=head3 F: - -=over - -=item C<"flood"> - -=over - -=item L C<$server> - -=item string C<$nick> - -=item string C<$host> - -=item int C<$level> - -=item string C<$target> - -=back - -=back - -=head3 F: - -=over - -=item C<"notifylist new"> - -=over - -=item L C<$notify_list> - -=back - -=item C<"notifylist remove"> - -=over - -=item L C<$notify_list> - -=back - -=item C<"notifylist joined"> - -=over - -=item L C<$server> - -=item string C<$nick> - -=item string C<$user> - -=item string C<$host> - -=item string C<$real_name> - -=item string C<$away_message> - -=back - -=item C<"notifylist away changed"> - -=over - -=item L C<$server> - -=item string C<$nick> - -=item string C<$user> - -=item string C<$host> - -=item string C<$real_name> - -=item string C<$away_message> - -=back - -=item C<"notifylist left"> - -=over - -=item L C<$server> - -=item string C<$nick> - -=item string C<$user> - -=item string C<$host> - -=item string C<$real_name> - -=item string C<$away_message> - -=back - -=back - -=head3 F: - -=over - -=item C<"proxy client connected"> - -=over - -=item L C<$client> - -=back - -=item C<"proxy client disconnected"> - -=over - -=item L C<$client> - -=back - -=item C<"proxy client command"> - -=over - -=item L C<$client> - -=item string C<$args> - -=item string C<$data> - -=back - -=item C<"proxy client dump"> - -=over - -=item L C<$client> - -=item string C<$data> - -=back - -=back - -=head2 Display (FE) Common - -B - -=over - -=item C<"gui print text"> - -=over - -=item L C<$window> - -=item int C<$fg> - -=item int C<$bg> - -=item int C<$flags> - -=item string C<$text> - -=item L C<$text_dest> - -=back - -=back - -(Can be used to determine when all "gui print text"s are sent (not required)) - "gui print text finished", WINDOW_REC - -B - -=head3 F: - -=over - -=item C<"complete word"> - -, GList * of char*, WINDOW_REC, char *word, char *linestart, int *want_space - -=back - -=head3 F: - -=over - -=item C<"irssi init read settings"> - -=over - -=item I - -=back - -=back - -=head3 F: - -=over - -=item C<"exec new"> - -=over - -=item L C<$process> - -=back - -=item C<"exec remove"> - -=over - -=item L C<$process> - -=item int C<$status> - -=back - -=item C<"exec input"> - -=over - -=item L C<$process> - -=item string C<$text> - -=back - -=back - -=head3 F: - -=over - -=item C<"message public"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$target> - -=back - -=item C<"message private"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$nick> - -=item string C<$address> - -=back - -=item C<"message own_public"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$target> - -=back - -=item C<"message own_private"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$target> - -=item string C<$original_target> - -=back - -=item C<"message join"> - -=over - -=item L C<$server> - -=item string C<$channel> - -=item string C<$nick> - -=item string C<$address> - -=back - -=item C<"message part"> - -=over - -=item L C<$server> - -=item string C<$channel> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$reason> - -=back - -=item C<"message quit"> - -=over - -=item L C<$server> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$reason> - -=back - -=item C<"message kick"> - -=over - -=item L C<$server> - -=item string C<$channel> - -=item string C<$nick> - -=item string C<$kicker> - -=item string C<$address> - -=item string C<$reason> - -=back - -=item C<"message nick"> - -=over - -=item L C<$server> - -=item string C<$new_nick> - -=item string C<$old_nick> - -=item string C<$address> - -=back - -=item C<"message own_nick"> - -=over - -=item L C<$server> - -=item string C<$new_nick> - -=item string C<$old_nick> - -=item string C<$address> - -=back - -=item C<"message invite"> - -=over - -=item L C<$server> - -=item string C<$channel> - -=item string C<$nick> - -=item string C<$address> - -=back - -=item C<"message topic"> - -=over - -=item L C<$server> - -=item string C<$channel> - -=item string C<$topic> - -=item string C<$nick> - -=item string C<$address> - -=back - -=back - -=head3 F: - -=over - -=item C<"keyinfo created"> - -=over - -=item L C<$key_info> - -=back - -=item C<"keyinfo destroyed"> - -=over - -=item L C<$key_info> - -=back - -=back - -=head3 F: - -=over - -=item C<"print text"> - -=over - -=item L C<$text_dest> - -=item string C<$text> - -=item string C<$stripped_text> - -=back - -=back - -=head3 F: - -=over - -=item C<"theme created"> - -=over - -=item L C<$theme> - -=back - -=item C<"theme destroyed"> - -=over - -=item L C<$theme> - -=back - -=back - -=head3 F: - -=over - -=item C<"window hilight"> - -=over - -=item L C<$window> - -=back - -=item C<"window dehilight"> - -=over - -=item L C<$window> - -=back - -=item C<"window activity"> - -=over - -=item L C<$window> - -=item int C<$old_level> - -=back - -=item C<"window item hilight"> - -=over - -=item L C<$window_item> - -=back - -=item C<"window item activity"> - -=over - -=item L C<$window_item> - -=item int C<$old_level> - -=back - -=back - -=head3 F: - -=over - -=item C<"window item new"> - -=over - -=item L C<$window> - -=item L C<$window_item> - -=back - -=item C<"window item remove"> - -=over - -=item L C<$window> - -=item L C<$window_item> - -=back - -=item C<"window item moved"> - -B - -=over - -=item L C<$window_from> - -=item L C<$window_item> - -=item L C<$window_to> - -=back - -=item C<"window item changed"> - -=over - -=item L C<$window> - -=item L C<$window_item> - -=back - -=item C<"window item server changed"> - -=over - -=item L C<$window> - -=item L C<$window_item> - -=back - -=back - -=head3 F: - -=over - -=item C<"window created"> - -=over - -=item L C<$window> - -=back - -=item C<"window destroyed"> - -=over - -=item L C<$window> - -=back - -=item C<"window changed"> - -=over - -=item L C<$window> - -=item L C<$old_window> - -=back - -=item C<"window changed automatic"> - -=over - -=item L C<$window> - -=back - -=item C<"window server changed"> - -=over - -=item L C<$window> - -=item L C<$server> - -=back - -=item C<"window refnum changed"> - -=over - -=item L C<$window> - -=item int C<$old_refnum> - -=back - -=item C<"window name changed"> - -=over - -=item L C<$window> - -=back - -=item C<"window history changed"> - -=over - -=item L C<$window> - -=item string C<$old_name> - -=back - -=item C<"window level changed"> - -=over - -=item L C<$window> - -=back - -=back - -=head2 Display (FE) IRC - -=head3 F: - -=over - -=item C<"default event numeric"> - -=over - -=item L C<$server> - -=item string C<$data> - -=item string C<$nick> - -=item string C<$address> - -=back - -=back - -=head3 F: - -=over - -=item C<"message irc op_public"> - -=over - -=item L - -=item string C<$msg> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$target> - -=back - -=item C<"message irc own_wall"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$target> - -=back - -=item C<"message irc own_action"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$target> - -=back - -=item C<"message irc action"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$target> - -=back - -=item C<"message irc own_notice"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$target> - -=back - -=item C<"message irc notice"> - -=over - -=item L C<$server> - -=item string C<$msg> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$target> - -=back - -=item C<"message irc own_ctcp"> - -=over - -=item L C<$server> - -=item string C<$cmd> - -=item string C<$data> - -=item string C<$target> - -=back - -=item C<"message irc ctcp"> - -=over - -=item L C<$server> - -=item string C<$cmd> - -=item string C<$data> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$target> - -=back - -=back - -=head3 F: - -=over - -=item C<"message irc mode"> - -=over - -=item L C<$server> - -=item string C<$channel> - -=item string C<$nick> - -=item string C<$address> - -=item string C<$mode> - -=back - -=back - -=head3 F: - -=over - -=item C<"message dcc own"> - -=over - -=item L C<$dcc> - -=item string C<$msg> - -=back - -=item C<"message dcc own_action"> - -=over - -=item L C<$dcc> - -=item string C<$msg> - -=back - -=item C<"message dcc own_ctcp"> - -=over - -=item L C<$dcc> - -=item string C<$cmd> - -=item string C<$data> - -=back - -=item C<"message dcc"> - -=over - -=item L C<$dcc> - -=item string C<$msg> - -=back - -=item C<"message dcc action"> - -=over - -=item L C<$dcc> - -=item string C<$msg> - -=back - -=item C<"message dcc ctcp"> - -=over - -=item L C<$dcc> - -=item string C<$cmd> - -=item string C<$data> - -=back - -=back - -=head2 Display (FE) Text - -=head3 F: - -=over 4 - -=item C<"gui key pressed"> - -=over - -=item int C<$key> - -=back - -=back - -=head3 F: - -=over 4 - -=item C<"beep"> - -=over - -=item I - -=back - -=back - -=head2 Perl Scripting - -=over 4 - -=item C<"script error"> - -=over - -=item L C<$script> - -=item string C<$error_msg> - -=back - -=back - -=for irssi_signal_defs END OF SIGNAL DEFINITIONS - -=head1 SIGNAL AUTO-GENERATION - -This file is used to auto-generate the signal definitions used by Irssi, and hence -must be edited in order to add new signals. - -=head2 Format - - -- cgit v1.2.3