blob: 2f71e1c35db55ecefd49511eea03aa0b8c8690ff (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
__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</SCRIPT LOAD I<filename>>. A default Irssi
configuration also provides the C</RUN> alias as an alternative to C</SCRIPT
LOAD>.
=head2 Unloading
A script can be unloaded via the C</SCRIPT UNLOAD I<name>> command. The name is
typically the script filename without the F<.pl> extension, so F<nickcolor.pl>
becomes C</SCRIPT UNLOAD nickcolor>.
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 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<Data::Dumper> is an extremely good way to inspect Irssi internals if you're
looking for an undocumented feature.
The C<DUMP> alias by L<Wouter
Coekaerts|http://wouter.coekaerts.be/site/irssi/aliases> provides an easy way to
check object fields.
Dump perl object (e.g. C</dump Irssi::active_win>):
/alias DUMP script exec use Data::Dumper\; print Data::Dumper->new([\\$0-])->Dump
=head2 Making Script Look Native
=head3 Provide Help
=head3 Use Tab Completion
=head3 Use Settings for Customisation
=head1 OTHER RESOURCES
=over
=item L<http://irssi.org/documentation/perl>
=item L<http://irssi.org/documentation/signals>
=item L<http://irssi.org/documentation/special_vars>
=item L<http://irssi.org/documentation/formats>
=item L<http://irssi.org/documentation/settings>
=item L<http://juerd.nl/site.plp/irssiscripttut>
=item L<http://irchelp.org/irchelp/rfc/rfc.html>
=item L<http://wouter.coekaerts.be/site/irssi/irssi>
=back
|
