From 9e8571059d562c097cf36ec45a4d56c9629de158 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Sat, 8 Jan 2011 20:07:23 +0000 Subject: updated readme for scripts repo --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index e69de29..84bccb5 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,17 @@ +# 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. + +## Documentation + +If you are here looking for my Irssi scripting documentation, please note that +it has been moved to +[https://github.com/shabble/irssi-docs/wiki](https://github.com/shabble/irssi-docs/wiki) + +## Other Things + +Many of my scripts require [uberprompt](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. + -- cgit v1.2.3 From 63b7e2f94b1467eae9fa3b2407ec208c130d1750 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Sat, 8 Jan 2011 20:19:36 +0000 Subject: fixed broken uberprompt link in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 84bccb5..69c645e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ it has been moved to ## Other Things -Many of my scripts require [uberprompt](prompt_info/uberprompt.pl) as a +Many of my scripts require [uberprompt](irssi-scripts/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. -- cgit v1.2.3 From bc1a1fa8cb8cfa747c62f60eba2bacd10f238598 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Sat, 8 Jan 2011 20:23:15 +0000 Subject: make the blasted link absolute to stop GH screwing with me. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 69c645e..3562c91 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ it has been moved to ## Other Things -Many of my scripts require [uberprompt](irssi-scripts/prompt_info/uberprompt.pl) as a +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. -- cgit v1.2.3 From 72f79234cb7baea6dc440c0e6d01ec10b5cea55f Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 4 Mar 2011 01:59:41 +0000 Subject: readme: updated to give a brief description of the various bits of the repo. --- README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3562c91..f465f1a 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,87 @@ This repository contains a collection of scripts I have written or adapted from others to improve my (and your!) irssi using experience. +## What's In Here + +I never thought I'd end up writing so many scripts, so rather than give them +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. + + +* `history_search/` -- an improved version of coekie's 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. + The exception is 'key_test.pl', which is good for figuring out what keycodes + Irssi sees when you give it input. + + pipes.pl might also be interesting as 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. + +* `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. + ## Documentation If you are here looking for my Irssi scripting documentation, please note that -- cgit v1.2.3 From 46f30c983488c1fb212476c2a9eff70a2faa54f1 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 1 Apr 2011 09:21:17 +0100 Subject: updated readme with brief synopsis of notifyquit. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index f465f1a..34c291d 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,13 @@ to use them. 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`. * `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 -- cgit v1.2.3 From f224f8fe2f7979fb18ea3a31a4c04012bac0ec43 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Mon, 18 Apr 2011 01:42:34 +0100 Subject: updated root README to mention some of the newer stuff. --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 34c291d..51c7dcf 100644 --- a/README.md +++ b/README.md @@ -28,12 +28,16 @@ to use them. * `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. - The exception is 'key_test.pl', which is good for figuring out what keycodes - Irssi sees when you give it input. - - pipes.pl might also be interesting as a barebones template for a script which - uses forking and pipes to handle async tasks in the background without hanging - Irssi. + 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 @@ -71,6 +75,9 @@ to use them. 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 -- cgit v1.2.3 From 6250e6d9e4bf9e80bb69791be2b8fe6ae02508e8 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Thu, 5 May 2011 05:22:42 +0100 Subject: brought in changes in readme and deployment stuff from branch where it shouldn't have been --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 51c7dcf..f333829 100644 --- a/README.md +++ b/README.md @@ -110,3 +110,21 @@ Many of my scripts require [uberprompt](https://github.com/shabble/irssi-scripts 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 + +### Deployment Process + +* Commit messages should be prefixed with something approximating the name of + the script or directory to make it obvious what thing is being worked on. + +* `./readme_generator.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. + +* Commit! + + -- cgit v1.2.3