From bed4ff6e7bd3f1b6e336791286a9d6cf62bc121b Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Wed, 21 Sep 2011 18:39:12 +0100 Subject: updated readme with a bunch of todo items. --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/README.md b/README.md index f333829..445d4ac 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,63 @@ and will probably refuse to load without it. ## Reminders for myself +*Not for public consumption. This section contains text known to the State of +California to cause madness, rabies, or other reproductive harm.* + +### Todo Lists + +I should really put these into the issue tracker instead. That can be a +reminder. I'll go create an issue for it Right Now! + +#### Script ideas + +* override `/set` to provide list manipulation options, something like +`/set {-append, -remove} $param $value`. + +* Finish work on [[foreach-guard/]] + +* Finish (Well, start) something in [[colour_popup/]] to make an actual popup + +* Revisit some of the cracked-out ideas for colour/format overlays + +* Go back and clean up [[irssi_vim/]] like I promised to everyone ages and ages + ago. Also do the features thing. + +* Actually fix all the + [[issues|https://github.com/shabble/irssi-scripts/issues]] people have + dilligently reported. + +#### Other things + +* Go do something useful regarding the `IrssiX::` namespace and add some +useful general features. + + * Window and transient-split handling + + * Higher-level abstraction for key-interception + + * Overlays? + + * Format helper functions like the ones listed in the + [[Guide|https://github.com/shabble/irssi-docs/wiki/Guide]] + +* Refactor just about everything to use the above. + +* Do something productive again on the 256colour fork/patches + +* Ditto @leonerd's [[fixterms|http://www.leonerd.org.uk/hacks/fixterms/]] key +binding support + +* Try to get someone to look at my patches & bug reports. + +#### Documentation Wiki + +You know, [[that|https://github.com/shabble/irssi-docs/wiki]] one. + +* Fix the stupid ToC generator internal anchor names problem. + +* Add more examples, always more examples. + ### Deployment Process * Commit messages should be prefixed with something approximating the name of -- cgit v1.2.3 From 1e30e3a31f1afc9caa2f8ebb71a4cd7bdc8374b6 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Wed, 21 Sep 2011 18:44:15 +0100 Subject: fix all the links in the readme to use the right syntax. Meh. --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 445d4ac..6c94d63 100644 --- a/README.md +++ b/README.md @@ -125,17 +125,18 @@ reminder. I'll go create an issue for it Right Now! * override `/set` to provide list manipulation options, something like `/set {-append, -remove} $param $value`. -* Finish work on [[foreach-guard/]] +* Finish work on [`foreach-guard`](foreach-guard/) -* Finish (Well, start) something in [[colour_popup/]] to make an actual popup +* Finish (Well, start) something in [`colour_popup`](colour_popup/) + to make an actual popup * Revisit some of the cracked-out ideas for colour/format overlays -* Go back and clean up [[irssi_vim/]] like I promised to everyone ages and ages - ago. Also do the features thing. +* Go back and clean up [`irssi_vim`](irssi_vim/) like I promised to everyone + ages and ages ago. Also do the features thing. * Actually fix all the - [[issues|https://github.com/shabble/irssi-scripts/issues]] people have + [issues](https://github.com/shabble/irssi-scripts/issues) people have dilligently reported. #### Other things @@ -150,20 +151,20 @@ useful general features. * Overlays? * Format helper functions like the ones listed in the - [[Guide|https://github.com/shabble/irssi-docs/wiki/Guide]] + [Guide](https://github.com/shabble/irssi-docs/wiki/Guide). * Refactor just about everything to use the above. * Do something productive again on the 256colour fork/patches -* Ditto @leonerd's [[fixterms|http://www.leonerd.org.uk/hacks/fixterms/]] key +* Ditto @leonerd's [fixterms](http://www.leonerd.org.uk/hacks/fixterms/) key binding support * Try to get someone to look at my patches & bug reports. #### Documentation Wiki -You know, [[that|https://github.com/shabble/irssi-docs/wiki]] one. +You know, [that](https://github.com/shabble/irssi-docs/wiki) one. * Fix the stupid ToC generator internal anchor names problem. -- cgit v1.2.3 From 67836f7197b2a6bac6f4e38905f31fe4cfbb2ff3 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Wed, 21 Sep 2011 19:30:49 +0100 Subject: Return of the Son of README: finally fix the pesky links (maybe?) --- README.md | 207 +++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 109 insertions(+), 98 deletions(-) diff --git a/README.md b/README.md index 6c94d63..e99155f 100644 --- a/README.md +++ b/README.md @@ -11,92 +11,103 @@ each their own repository as might be sensible, they're all stuffed in here. The following is a brief list of the interesting scripts, and why you might want to use them. -* `auto_server/` -- provides a `/join+` command which allows you to join - channels on servers to which you're not currently connected, as long as you've - got everything set up correctly in your `/channels` and `/networks` config. +* [`auto_server/`](tree/master/auto_server/) -- provides a `/join+` command + which allows you to join channels on servers to which you're not currently + connected, as long as you've got everything set up correctly in your + `/channels` and `/networks` config. -* `history_search/` -- an improved version of coekie's original history_search, it - behaves a lot more like the standard Readline incremental +* [`history_search/`](tree/master/history_search/) -- an improved version of + [@coekie's](/coekie/irssi-scripts/blob/master/history_search.pl) original + history_search, it behaves a lot more like the standard Readline incremental search over your recent command history. -* `ido_mode/` -- A window switching mode best described as "The bastard lovechild - of emacs ido-mode and window_switcher.pl". It supports flexible matching of - channel names, filtering by active windows, servers, and more. See the script - comments for details. - -* `feature_tests/` has a bunch of different little scripts written to test certain - aspects of Irssi behaviour. None of them are likely to be particularly useful - unless you're looking for simple examples of various things on which to build. - Some of the ones which might actually be useful are: - - * `key_test.pl` - decodes and prints keyboard inputs from the `gui key pressed` - signal. Useful for checking what keycode a particular combo generates. - - * `template.pl` - A basic outline of a script to use as a starting point - for others. - - * `pipes.pl` A barebones template for a script which uses forking and pipes - to handle async tasks in the background without hanging Irssi. - -* `modules/` contains a few half-baked attempts at loadable modules for Irssi, - none of which do very much at the moment. They might be useful as templates - for your own modules, however. - -* `no_key_modes/` provides an additional expando `$M_nopass` which you can - add to your theme to provide channel modes, but without showing the channel - key. This is probably less useful since someone pointed me at `/set - chanmode_expando_strip` which has much the same effect. - -* `patches/` contains a few patches for the irssi source, probably out of date - by now, which do various things. The easiest way to figure out what is to read - them, unless I get bored and document them sometime. - -* `prompt_info/` was the original "How can I put dynamic status crap into my - prompt string" script. This has since been superceded by the far nicer - `uberprompt.pl` which also lives in that dir. Many of my other scripts - require uberprompt as a way to provide part of their user interface. - -* `sb_position/` gives you an additional status bar item which indicates - approximately how far you are scrolled in a given window buffer, in terms - of pages and percentage. It is configurable as the comments in the script - explain. - -* `scrolled_reminder/` is a script that tries to prevent one of the more - common accidental IRC screwups -- replying to a conversation that happened - hours ago because you didn't notice you were scrolled up in the history buffer. - If you try to send a message whilst scrolled, it'll warn you and check you - really want to first. +* [`ido_mode/`](tree/master/ido_mode/) -- A window switching mode best described + as "The bastard lovechild of emacs ido-mode and window_switcher.pl". It + supports flexible matching of channel names, filtering by active windows, + servers, and more. See the script comments for details. + +* [`feature_tests/`](tree/master/feature_tests/) has a bunch of different little + scripts written to test certain aspects of Irssi behaviour. None of them are + likely to be particularly useful unless you're looking for simple examples of + various things on which to build. Some of the ones which might actually be + useful are: + + * [`key_test.pl`](tree/master/feature_tests/key_test.pl) - decodes and prints + keyboard inputs from the `gui key pressed` signal. Useful for checking what + keycode a particular combo generates. + + * [`template.pl`](tree/master/feature_tests/template.pl) - A basic outline of a + script to use as a starting point for others. + + * [`pipes.pl`](tree/master/feature_tests/pipes.pl) A barebones template for a + script which uses forking and pipes to handle async tasks in the background + without hanging Irssi. + +* [`modules/`](tree/master/modules/) contains a few half-baked attempts at + loadable modules for Irssi, none of which do very much at the moment. They + might be useful as templates for your own modules, however. + +* [`no_key_modes/`](tree/master/no_key_modes/) provides an additional expando + `$M_nopass` which you can add to your theme to provide channel modes, but + without showing the channel key. This is probably less useful since someone + pointed me at `/set chanmode_expando_strip` which has much the same effect. + +* [`patches/`](tree/master/patches/) contains a few patches for the irssi + source, probably out of date by now, which do various things. The easiest way + to figure out what is to read them, unless I get bored and document them + sometime. + +* [`prompt_info/`](tree/master/prompt_info/) was the original "How can I put + dynamic status crap into my prompt string" script. This has since been + superceded by the far nicer `uberprompt.pl` which also lives in that dir. + Many of my other scripts require uberprompt as a way to provide part of their + user interface. + +* [`sb_position/`](tree/master/sb_position/) gives you an additional status bar + item which indicates approximately how far you are scrolled in a given window + buffer, in terms of pages and percentage. It is configurable as the comments + in the script explain. + +* [`scrolled_reminder/`](tree/master/scrolled_reminder/) is a script that tries + to prevent one of the more common accidental IRC screwups -- replying to a + conversation that happened hours ago because you didn't notice you were + scrolled up in the history buffer. If you try to send a message whilst + scrolled, it'll warn you and check you really want to first. -* `quit-notify/` is based on a script by vague@#irssi/Freenode. It is most - useful when you are ignoring joins/parts/quits from a channel, and hence - don't realise when the person you are responding to has left. If they have - (or if you prefix your message with a nonexistent nick), the script will - ask you to confirm that you want to send the message, much like - `scrolled_reminder`. - -* `undo/` contains 2 scripts, `undo.pl` and `kill-ring.pl`. See their header - for further documentation. - -* `testing/` is a Perl framework external to Irssi (ie: not a script) that will - ultimately allow you to write unit tests for your scripts, and run them in a - real irssi instance, and check that they behave correctly. Still undergoing - heavy development, and not really ready for public usage. - -* `throttled_autojoin/` doesn't work. It's meant to allow people with huuuuuuge - numbers of autojoin channels and servers to connect slowly, so as not to time - themselves out when reconnecting. Mostly dead. - -* `tinyurl_tabcomplete/` is a script which lets you hit tab following anything - that looks like a URL to replace it with a tinyurl'd version. Handy if you - regularly paste Google-maps links or other massive horrible links. - -* `url_hilight/` I can't remember what this one does. Suggestions welcome. - -* `vim_mode/` The most exciting (and by far the largest) script here. Gives - vim-addicted users a way to use most of their finger-memory in Irssi. Still - under active development, features and bug-requests welcome. Also supported - in #irssi_vim on Freenode. +* [`quit-notify/`](tree/master/quit-notify/) is based on a script by + vague@#irssi/Freenode. It is most useful when you are ignoring + joins/parts/quits from a channel, and hence don't realise when the person you + are responding to has left. If they have (or if you prefix your message with + a nonexistent nick), the script will ask you to confirm that you want to send + the message, much like `scrolled_reminder`. + +* [`undo/`](tree/master/undo/) contains 2 scripts, `undo.pl` and + `kill-ring.pl`. See their header for further documentation. + +* [`testing/`](tree/master/testing/) is a Perl framework external to Irssi (ie: + not a script) that will ultimately allow you to write unit tests for your + scripts, and run them in a real irssi instance, and check that they behave + correctly. Still undergoing heavy development, and not really ready for + public usage. + +* [`throttled_autojoin/`](tree/master/throttled_autojoin/) doesn't work. It's + meant to allow people with huuuuuuge numbers of autojoin channels and servers + to connect slowly, so as not to time themselves out when reconnecting. Mostly + dead. + +* [`tinyurl_tabcomplete/`](tree/master/tinyurl_tabcomplete/) is a script which + lets you hit tab following anything that looks like a URL to replace it with a + tinyurl'd version. Handy if you regularly paste Google-maps links or other + massive horrible links. + +* [`url_hilight/`](tree/master/url_hilight/) I can't remember what this one + does. Suggestions welcome. + +* [`vim_mode/`](tree/master/vim_mode/) The most exciting (and by far the + largest) script here. Gives vim-addicted users a way to use most of their + finger-memory in Irssi. Still under active development, features and + bug-requests welcome. Also supported in #irssi_vim on Freenode. ## Documentation @@ -106,13 +117,14 @@ it has been moved to ## Other Things -Many of my scripts require [uberprompt](https://github.com/shabble/irssi-scripts/blob/master/prompt_info/uberprompt.pl) as a -dependency. Those that do will say so in the comments at the top of the file, -and will probably refuse to load without it. +Many of my scripts require +[uberprompt](https://github.com/shabble/irssi-scripts/blob/master/prompt_info/uberprompt.pl) +as a dependency. Those that do will say so in the comments at the top of the +file, and will probably refuse to load without it. ## Reminders for myself -*Not for public consumption. This section contains text known to the State of +*Not for public consumption. This section contains text known to the State of California to cause madness, rabies, or other reproductive harm.* ### Todo Lists @@ -122,27 +134,26 @@ reminder. I'll go create an issue for it Right Now! #### Script ideas -* override `/set` to provide list manipulation options, something like -`/set {-append, -remove} $param $value`. +* override `/set` to provide list manipulation options, something like `/set +{-append, -remove} $param $value`. -* Finish work on [`foreach-guard`](foreach-guard/) +* Finish work on [`foreach-guard`](tree/master/foreach-guard/) -* Finish (Well, start) something in [`colour_popup`](colour_popup/) +* Finish (Well, start) something in [`colour_popup`](tree/master/colour_popup/) to make an actual popup * Revisit some of the cracked-out ideas for colour/format overlays -* Go back and clean up [`irssi_vim`](irssi_vim/) like I promised to everyone - ages and ages ago. Also do the features thing. +* Go back and clean up [`irssi_vim`](tree/master/irssi_vim/) like I promised to + everyone ages and ages ago. Also do the features thing. -* Actually fix all the - [issues](https://github.com/shabble/irssi-scripts/issues) people have - dilligently reported. +* Actually fix all the [issues](https://github.com/shabble/irssi-scripts/issues) + people have dilligently reported. #### Other things -* Go do something useful regarding the `IrssiX::` namespace and add some -useful general features. +* Go do something useful regarding the `IrssiX::` namespace and add some useful +general features. * Window and transient-split handling @@ -178,8 +189,8 @@ You know, [that](https://github.com/shabble/irssi-docs/wiki) one. * `./readme_generator.pl [` changes the %IRSSI{changed} timestamp - to the current time, which is something I always forget to do. +* `./changed_update.pl ` changes the %IRSSI{changed} timestamp to + the current time, which is something I always forget to do. * Think about bumping the internal version number if it's a big change. -- cgit v1.2.3 From caa477a5abf62ca9b50142d98511aa1b02b81a62 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 23 Sep 2011 04:12:30 +0100 Subject: Actually really truly fixed the urls this time. Honest. --- README.md | 62 ++++++++++++++++++++++++++++++++------------------------------ 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index e99155f..ac873a9 100644 --- a/README.md +++ b/README.md @@ -11,100 +11,101 @@ each their own repository as might be sensible, they're all stuffed in here. The following is a brief list of the interesting scripts, and why you might want to use them. -* [`auto_server/`](tree/master/auto_server/) -- provides a `/join+` command +* [`auto-server/`](tree/master/auto-server) -- provides a `/join+` command which allows you to join channels on servers to which you're not currently connected, as long as you've got everything set up correctly in your `/channels` and `/networks` config. -* [`history_search/`](tree/master/history_search/) -- an improved version of - [@coekie's](/coekie/irssi-scripts/blob/master/history_search.pl) original +* [`history-search/`](tree/master/history-search) -- an improved version of + [@coekie](/coekie/irssi-scripts/blob/master/history_search.pl)'s original history_search, it behaves a lot more like the standard Readline incremental search over your recent command history. -* [`ido_mode/`](tree/master/ido_mode/) -- A window switching mode best described +* [`ido-mode/`](tree/master/ido-mode) -- A window switching mode best described as "The bastard lovechild of emacs ido-mode and window_switcher.pl". It supports flexible matching of channel names, filtering by active windows, servers, and more. See the script comments for details. -* [`feature_tests/`](tree/master/feature_tests/) has a bunch of different little +* [`feature-tests/`](tree/master/feature-tests) has a bunch of different little scripts written to test certain aspects of Irssi behaviour. None of them are likely to be particularly useful unless you're looking for simple examples of various things on which to build. Some of the ones which might actually be useful are: - * [`key_test.pl`](tree/master/feature_tests/key_test.pl) - decodes and prints + * [`key_test.pl`](tree/master/feature-tests/key_test.pl) - decodes and prints keyboard inputs from the `gui key pressed` signal. Useful for checking what keycode a particular combo generates. - * [`template.pl`](tree/master/feature_tests/template.pl) - A basic outline of a + * [`template.pl`](tree/master/feature-tests/template.pl) - A basic outline of a script to use as a starting point for others. - * [`pipes.pl`](tree/master/feature_tests/pipes.pl) A barebones template for a + * [`pipes.pl`](tree/master/feature-tests/pipes.pl) A barebones template for a script which uses forking and pipes to handle async tasks in the background without hanging Irssi. -* [`modules/`](tree/master/modules/) contains a few half-baked attempts at +* [`modules/`](tree/master/modules) contains a few half-baked attempts at loadable modules for Irssi, none of which do very much at the moment. They might be useful as templates for your own modules, however. -* [`no_key_modes/`](tree/master/no_key_modes/) provides an additional expando +* [`no-key-modes/`](tree/master/no-key-modes) provides an additional expando `$M_nopass` which you can add to your theme to provide channel modes, but without showing the channel key. This is probably less useful since someone pointed me at `/set chanmode_expando_strip` which has much the same effect. -* [`patches/`](tree/master/patches/) contains a few patches for the irssi +* [`patches/`](tree/master/patches) contains a few patches for the irssi source, probably out of date by now, which do various things. The easiest way to figure out what is to read them, unless I get bored and document them sometime. -* [`prompt_info/`](tree/master/prompt_info/) was the original "How can I put +* [`prompt_info/`](tree/master/prompt_info) was the original "How can I put dynamic status crap into my prompt string" script. This has since been superceded by the far nicer `uberprompt.pl` which also lives in that dir. Many of my other scripts require uberprompt as a way to provide part of their user interface. -* [`sb_position/`](tree/master/sb_position/) gives you an additional status bar +* [`sb-position/`](tree/master/sb-position) gives you an additional status bar item which indicates approximately how far you are scrolled in a given window buffer, in terms of pages and percentage. It is configurable as the comments in the script explain. -* [`scrolled_reminder/`](tree/master/scrolled_reminder/) is a script that tries +* [`scrolled-reminder/`](tree/master/scrolled-reminder) is a script that tries to prevent one of the more common accidental IRC screwups -- replying to a conversation that happened hours ago because you didn't notice you were scrolled up in the history buffer. If you try to send a message whilst scrolled, it'll warn you and check you really want to first. -* [`quit-notify/`](tree/master/quit-notify/) is based on a script by +* [`quit-notify/`](tree/master/quit-notify) is based on a script by vague@#irssi/Freenode. It is most useful when you are ignoring joins/parts/quits from a channel, and hence don't realise when the person you are responding to has left. If they have (or if you prefix your message with a nonexistent nick), the script will ask you to confirm that you want to send the message, much like `scrolled_reminder`. -* [`undo/`](tree/master/undo/) contains 2 scripts, `undo.pl` and +* [`undo/`](tree/master/undo) contains 2 scripts, `undo.pl` and `kill-ring.pl`. See their header for further documentation. -* [`testing/`](tree/master/testing/) is a Perl framework external to Irssi (ie: +* [`testing/`](tree/master/testing) is a Perl framework external to Irssi (ie: not a script) that will ultimately allow you to write unit tests for your scripts, and run them in a real irssi instance, and check that they behave - correctly. Still undergoing heavy development, and not really ready for - public usage. + correctly. + + *Still undergoing heavy development, and not really ready for public usage.* -* [`throttled_autojoin/`](tree/master/throttled_autojoin/) doesn't work. It's +* [`throttled-autojoin/`](tree/master/throttled-autojoin) doesn't work. It's meant to allow people with huuuuuuge numbers of autojoin channels and servers to connect slowly, so as not to time themselves out when reconnecting. Mostly dead. -* [`tinyurl_tabcomplete/`](tree/master/tinyurl_tabcomplete/) is a script which +* [`tinyurl-tabcomplete/`](tree/master/tinyurl-tabcomplete) is a script which lets you hit tab following anything that looks like a URL to replace it with a tinyurl'd version. Handy if you regularly paste Google-maps links or other massive horrible links. -* [`url_hilight/`](tree/master/url_hilight/) I can't remember what this one - does. Suggestions welcome. +* [`url_hilight/`](tree/master/url_hilight) I can't remember what this one + does. Suggestions & ideas welcome. -* [`vim_mode/`](tree/master/vim_mode/) The most exciting (and by far the +* [`vim-mode/`](tree/master/vim-mode) The most exciting (and by far the largest) script here. Gives vim-addicted users a way to use most of their finger-memory in Irssi. Still under active development, features and bug-requests welcome. Also supported in #irssi_vim on Freenode. @@ -135,16 +136,17 @@ reminder. I'll go create an issue for it Right Now! #### Script ideas * override `/set` to provide list manipulation options, something like `/set -{-append, -remove} $param $value`. +{-append, -remove} $param $value`. Bit like a general purpose version of +[`hide.pl`](http://scripts.irssi.org/html/hide.pl.html) -* Finish work on [`foreach-guard`](tree/master/foreach-guard/) +* Finish work on [`foreach-guard`](tree/master/foreach-guard) -* Finish (Well, start) something in [`colour_popup`](tree/master/colour_popup/) +* Finish (Well, start) something in [`colour-popup`](tree/master/colour-popup) to make an actual popup * Revisit some of the cracked-out ideas for colour/format overlays -* Go back and clean up [`irssi_vim`](tree/master/irssi_vim/) like I promised to +* Go back and clean up [`irssi-vim`](tree/master/irssi-vim) like I promised to everyone ages and ages ago. Also do the features thing. * Actually fix all the [issues](https://github.com/shabble/irssi-scripts/issues) @@ -168,8 +170,8 @@ general features. * Do something productive again on the 256colour fork/patches -* Ditto @leonerd's [fixterms](http://www.leonerd.org.uk/hacks/fixterms/) key -binding support +* Ditto [@leonerd](/leonerd)'s +[fixterms](http://www.leonerd.org.uk/hacks/fixterms/) key binding support * Try to get someone to look at my patches & bug reports. -- cgit v1.2.3 From d338bbdff4ab176ff6be6a3a53d2eb7b8f79ec4b Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 23 Sep 2011 04:27:15 +0100 Subject: If these links don't work I'm going to move to the country and live in the woods. --- README.md | 167 ++++++++++++++++++++++++++++++++------------------------------ 1 file changed, 87 insertions(+), 80 deletions(-) diff --git a/README.md b/README.md index ac873a9..c98c385 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Shabble's Irssi Scripts -This repository contains a collection of scripts I have written or adapted from -others to improve my (and your!) irssi using experience. +This repository contains a collection of scripts and things I have written or +adapted from others to improve my (and maybe your!) Irssi using experience. ## What's In Here @@ -11,104 +11,111 @@ each their own repository as might be sensible, they're all stuffed in here. The following is a brief list of the interesting scripts, and why you might want to use them. -* [`auto-server/`](tree/master/auto-server) -- provides a `/join+` command - which allows you to join channels on servers to which you're not currently - connected, as long as you've got everything set up correctly in your +* [`auto-server/`](irssi-scripts/tree/master/auto-server) -- provides a `/join+` + command which allows you to join channels on servers to which you're not + currently connected, as long as you've got everything set up correctly in your `/channels` and `/networks` config. -* [`history-search/`](tree/master/history-search) -- an improved version of - [@coekie](/coekie/irssi-scripts/blob/master/history_search.pl)'s original - history_search, it behaves a lot more like the standard Readline incremental - search over your recent command history. +* [`history-search/`](irssi-scripts/tree/master/history-search) -- an improved + version of [@coekie](/coekie/irssi-scripts/blob/master/history_search.pl)'s + original history_search, it behaves a lot more like the standard Readline + incremental search over your recent command history. -* [`ido-mode/`](tree/master/ido-mode) -- A window switching mode best described - as "The bastard lovechild of emacs ido-mode and window_switcher.pl". It - supports flexible matching of channel names, filtering by active windows, +* [`ido-mode/`](irssi-scripts/tree/master/ido-mode) -- A window switching mode + best described as "The bastard lovechild of Emacs + [ido-mode](http://www.emacswiki.org/emacs/InteractivelyDoThings) and + [window_switcher.pl](http://scripts.irssi.org/html/window_switcher.pl.html)". + It supports flexible matching of channel names, filtering by active windows, servers, and more. See the script comments for details. -* [`feature-tests/`](tree/master/feature-tests) has a bunch of different little - scripts written to test certain aspects of Irssi behaviour. None of them are - likely to be particularly useful unless you're looking for simple examples of - various things on which to build. Some of the ones which might actually be - useful are: - - * [`key_test.pl`](tree/master/feature-tests/key_test.pl) - decodes and prints - keyboard inputs from the `gui key pressed` signal. Useful for checking what - keycode a particular combo generates. - - * [`template.pl`](tree/master/feature-tests/template.pl) - A basic outline of a - script to use as a starting point for others. - - * [`pipes.pl`](tree/master/feature-tests/pipes.pl) A barebones template for a - script which uses forking and pipes to handle async tasks in the background - without hanging Irssi. - -* [`modules/`](tree/master/modules) contains a few half-baked attempts at - loadable modules for Irssi, none of which do very much at the moment. They - might be useful as templates for your own modules, however. - -* [`no-key-modes/`](tree/master/no-key-modes) provides an additional expando - `$M_nopass` which you can add to your theme to provide channel modes, but - without showing the channel key. This is probably less useful since someone - pointed me at `/set chanmode_expando_strip` which has much the same effect. - -* [`patches/`](tree/master/patches) contains a few patches for the irssi - source, probably out of date by now, which do various things. The easiest way - to figure out what is to read them, unless I get bored and document them - sometime. - -* [`prompt_info/`](tree/master/prompt_info) was the original "How can I put - dynamic status crap into my prompt string" script. This has since been - superceded by the far nicer `uberprompt.pl` which also lives in that dir. +* [`feature-tests/`](irssi-scripts/tree/master/feature-tests) has a bunch of + different little scripts written to test certain aspects of Irssi behaviour. + None of them are likely to be particularly useful unless you're looking for + simple examples of various things on which to build. Some of the ones which + might actually be useful are: + + * [`key_test.pl`](irssi-scripts/tree/master/feature-tests/key_test.pl) - + decodes and prints keyboard inputs from the `gui key pressed` signal. Useful + for checking what keycode a particular combo generates. + + * [`template.pl`](irssi-scripts/tree/master/feature-tests/template.pl) - A + basic outline of a script to use as a starting point for others. + + * [`pipes.pl`](irssi-scripts/tree/master/feature-tests/pipes.pl) A barebones + template for a script which uses forking and pipes to handle async tasks in + the background without hanging Irssi. + +* [`modules/`](irssi-scripts/tree/master/modules) contains a few half-baked + attempts at loadable modules for Irssi, none of which do very much at the + moment. They might be useful as templates for your own modules, however. + +* [`no-key-modes/`](irssi-scripts/tree/master/no-key-modes) provides an + additional expando `$M_nopass` which you can add to your theme to provide + channel modes, but without showing the channel key. This is probably less + useful since someone pointed me at `/set chanmode_expando_strip` which has + much the same effect. + +* [`patches/`](irssi-scripts/tree/master/patches) contains a few patches for the + irssi source, probably out of date by now, which do various things. The + easiest way to figure out what is to read them, unless I get bored and + document them sometime. + +* [`prompt_info/`](irssi-scripts/tree/master/prompt_info) was the original "How + can I put dynamic status crap into my prompt string" script. This has since + been superceded by the far nicer `uberprompt.pl` which also lives in that dir. Many of my other scripts require uberprompt as a way to provide part of their user interface. -* [`sb-position/`](tree/master/sb-position) gives you an additional status bar - item which indicates approximately how far you are scrolled in a given window - buffer, in terms of pages and percentage. It is configurable as the comments - in the script explain. +* [`sb-position/`](irssi-scripts/tree/master/sb-position) gives you an + additional status bar item which indicates approximately how far you are + scrolled in a given window buffer, in terms of pages and percentage. It is + configurable as the comments in the script explain. -* [`scrolled-reminder/`](tree/master/scrolled-reminder) is a script that tries - to prevent one of the more common accidental IRC screwups -- replying to a - conversation that happened hours ago because you didn't notice you were - scrolled up in the history buffer. If you try to send a message whilst - scrolled, it'll warn you and check you really want to first. +* [`scrolled-reminder/`](irssi-scripts/tree/master/scrolled-reminder) is a + script that tries to prevent one of the more common accidental IRC screwups -- + replying to a conversation that happened hours ago because you didn't notice + you were scrolled up in the history buffer. If you try to send a message + whilst scrolled, it'll warn you and check you really want to first. -* [`quit-notify/`](tree/master/quit-notify) is based on a script by - vague@#irssi/Freenode. It is most useful when you are ignoring +* [`quit-notify/`](irssi-scripts/tree/master/quit-notify) is based on a script + by vague@#irssi/Freenode. It is most useful when you are ignoring joins/parts/quits from a channel, and hence don't realise when the person you are responding to has left. If they have (or if you prefix your message with a nonexistent nick), the script will ask you to confirm that you want to send the message, much like `scrolled_reminder`. -* [`undo/`](tree/master/undo) contains 2 scripts, `undo.pl` and +* [`undo/`](irssi-scripts/tree/master/undo) contains 2 scripts, `undo.pl` and `kill-ring.pl`. See their header for further documentation. + + *Still undergoing heavy development, and not really ready for public usage.* + -* [`testing/`](tree/master/testing) is a Perl framework external to Irssi (ie: - not a script) that will ultimately allow you to write unit tests for your - scripts, and run them in a real irssi instance, and check that they behave - correctly. +* [`testing/`](irssi-scripts/tree/master/testing) is a Perl framework external + to Irssi (ie: not a script) that will ultimately allow you to write unit tests + for your scripts, and run them in a real irssi instance, and check that they + behave correctly. *Still undergoing heavy development, and not really ready for public usage.* -* [`throttled-autojoin/`](tree/master/throttled-autojoin) doesn't work. It's - meant to allow people with huuuuuuge numbers of autojoin channels and servers - to connect slowly, so as not to time themselves out when reconnecting. Mostly - dead. +* [`throttled-autojoin/`](irssi-scripts/tree/master/throttled-autojoin) doesn't + work. It's meant to allow people with huuuuuuge numbers of autojoin channels + and servers to connect slowly, so as not to time themselves out when + reconnecting. Mostly dead. -* [`tinyurl-tabcomplete/`](tree/master/tinyurl-tabcomplete) is a script which - lets you hit tab following anything that looks like a URL to replace it with a - tinyurl'd version. Handy if you regularly paste Google-maps links or other - massive horrible links. +* [`tinyurl-tabcomplete/`](irssi-scripts/tree/master/tinyurl-tabcomplete) is a + script which lets you hit tab following anything that looks like a URL to + replace it with a tinyurl'd version. Handy if you regularly paste Google-maps + links or other massive horrible links. -* [`url_hilight/`](tree/master/url_hilight) I can't remember what this one - does. Suggestions & ideas welcome. +* [`url_hilight/`](irssi-scripts/tree/master/url_hilight) I can't remember what + this one does. Suggestions & ideas welcome. -* [`vim-mode/`](tree/master/vim-mode) The most exciting (and by far the - largest) script here. Gives vim-addicted users a way to use most of their - finger-memory in Irssi. Still under active development, features and - bug-requests welcome. Also supported in #irssi_vim on Freenode. +* [`vim-mode/`](irssi-scripts/tree/master/vim-mode) The most exciting (and by + far the largest) script here. Gives vim-addicted users a way to use most of + their finger-memory in Irssi. Still under active development, features and + bug-requests welcome. Also supported in + [#irssi_vim on Freenode](irc://irc.freenode.org/#irssi_vim). ## Documentation @@ -126,7 +133,7 @@ file, and will probably refuse to load without it. ## Reminders for myself *Not for public consumption. This section contains text known to the State of -California to cause madness, rabies, or other reproductive harm.* +California to cause madness, rabies, or reproductive harm.* ### Todo Lists @@ -139,14 +146,14 @@ reminder. I'll go create an issue for it Right Now! {-append, -remove} $param $value`. Bit like a general purpose version of [`hide.pl`](http://scripts.irssi.org/html/hide.pl.html) -* Finish work on [`foreach-guard`](tree/master/foreach-guard) +* Finish work on [`foreach-guard`](irssi-scripts/tree/master/foreach-guard) -* Finish (Well, start) something in [`colour-popup`](tree/master/colour-popup) +* Finish (Well, start) something in [`colour-popup`](irssi-scripts/tree/master/colour-popup) to make an actual popup * Revisit some of the cracked-out ideas for colour/format overlays -* Go back and clean up [`irssi-vim`](tree/master/irssi-vim) like I promised to +* Go back and clean up [`irssi-vim`](irssi-scripts/tree/master/irssi-vim) like I promised to everyone ages and ages ago. Also do the features thing. * Actually fix all the [issues](https://github.com/shabble/irssi-scripts/issues) -- cgit v1.2.3