Aspeller Documentation

Current Version: 0.3.1

Contents:
1.	How to Install
2.	How to run
3.	Various Commands
4.	Changing Options
5.	Troubleshooting
6.	Changelog
	
1. HOW TO INSTALL
First of all, if you haven't already, download the script from http://www.nathancoad.com/aspeller.tar.gz
Decompress the archive by running the following command:
		tar -zxf aspeller.tar.gz -C ~/.irssi/scripts
This will extract the script and place it in your scripts folder within irssi. Thats all thats involved when installing a script in irssi.  Pretty simple, hey.

2. HOW TO RUN
BIG WARNING!!!
Most scripts can be shut down by the script unload command within irssi. Using this method with aspeller will result in defunct aspell processes! Instead, _always_ unload the script by running the
		/aspell_shutdown
command.
Running the script is also pretty simple.  Within irssi, type the following:
		/run aspeller
Thats it!

3. VARIOUS COMMANDS
We've already met one very important command - the /aspell_shutdown command.  There are several others.  The next most useful command is 
		/suggest <word>
This command takes one argument, the word you wish to check the spelling of (Note: angle brackets are not necessary). This will respond with a number of suggestions, or tell you that you spelled the word correctly.
Both the remaining commands are used to interface with aspell. The first of these is
		/aspell_add <word>
As the name suggests, use this command to add the word to your personal aspell dictionary (more on the personal dictionary in secion 4). 
The final command is recommended for advanced users only. That is, people who know how to use aspell's pipe interface. The
		/aspell <command>
command will pass anything specified by <command> directly to aspell. Use this with caution. If you don't know what you're doing, you can cause irssi to hang waiting for a reply from aspell. (See section 5 for more details). Details of possible commands can be found at the aspell website. A brief summary can be found in the comments at the beginning of the script.

4. CHANGING OPTIONS

More to come later.  For now, have a look at the comments in the script.

5. TROUBLESHOOTING

Irssi seems to have frozen.  What can i do?
	For some reason or other, irssi is busy waiting for a response from aspell that isnt forthcoming.  You need to identify the process number of aspell, and kill that process. This will return irssi to normal. You can then reload aspeller.
	
More to come later

6. CHANGELOG

0.2.0
	- Changed things totally.  Now uses a statusbar to highlight spelling errors
0.2.2
	- Fixed parsing for * at beginning of input string
0.2.3
	- Fixed some escaping problems with input and output text
	- Currently leading special characters and the presence of $ and % screw thigns up
0.2.4
	- Special leading characters should be fixed
0.2.5
	- Improved removal of special leading characters
0.3.0
	- Altered the statusbar so its prefixed with the channel name rather than Aspell
	- Added a hack so the statusbar displays the end of the text if you've typed more than the screen's width
0.3.1
	- Fixed a flaw that made the statusbar redraw constantly