diff options
| author | Tom Feist <shabble@cowu.be> | 2010-08-23 00:22:09 +0000 |
|---|---|---|
| committer | Tom Feist <shabble@cowu.be> | 2010-08-23 00:22:09 +0000 |
| commit | 3d619726e5d6e0a769ad705c4a4298f6b28aa743 (patch) | |
| tree | 056e1136d99d0ea32c99f70ed026a47643c63c3b /docs/General/Guide.pod | |
| parent | moved some stuff into General, and started to modify buildpod.pl to render a ... (diff) | |
| download | irssi-scripts-3d619726e5d6e0a769ad705c4a4298f6b28aa743.tar.gz irssi-scripts-3d619726e5d6e0a769ad705c4a4298f6b28aa743.zip | |
lots of doc updates
Diffstat (limited to '')
| -rw-r--r-- | docs/General/Guide.pod | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/General/Guide.pod b/docs/General/Guide.pod index 3a9f43f..20f48af 100644 --- a/docs/General/Guide.pod +++ b/docs/General/Guide.pod @@ -6,6 +6,10 @@ Guide To Irssi Scripting. =head1 DESCRIPTION +This page presents a bunch of additional information about scripting for Irssi +that doesn't fit well anywhere else. It contains useful tips, common pitfalls, +and a bunch of other handy things. At least, I hope so. + =head1 LOADING AND UNLOADING SCRIPTS =head2 File Locations @@ -19,12 +23,33 @@ F<~/.irssi/scripts/>. If you require a script be run when Irssi starts, you can place the file (or better, create a symlink to it) into F<~/.irssi/scripts/autorun/>. +Alternatively, if you want more control over the order in which scripts are +autoloaded, you can place + + SCRIPT LOAD script1 + SCRIPT LOAD script2 + SCRIPT LOAD script3 + +into your F<~/.irssi/startup> file. + +I<This tip was provided by C<Rhonda> on Freenode/#irssi>. + =head2 Testing =for comment B<TODO: Forgotten what was going to go here> =head3 C</SCRIPT EXEC> +The C<SCRIPT EZEC> command allows you to test various simple ideas straight from +the Irssi interface. It can also be used to register signal handlers and +commands if run with the C<-permanent> option. + +B<NB: C<-permanent> only means that the script should not terminate +immediately. It is still not persistent between restarts of the Irssi client. +Truly permanent scripts should be placed in autorun scripts or added to +F<~/.irssi/startup>> + + B<TODO: Using it for testing stuff out> B<TODO: Also for very short scripts (with -permanent?)> |