Readme for regexcheck V1.0

Use this little tool to check your regular expressions in your 
users.ini file. I wrote this program because a lot of people
have problems setting up AdminMod with regexes.

Usage
~~~~~

regexcheck [-h] [nickname | -f namefile] [regex | -u inifile]

You provide regexcheck with the nickname you want to use and
the regex that you have setup. You can enter the nickname at
the command line or have it read from a file. Examples follow
below. You can check a single regular expression if you put
it on the command line. Use this to check if you got the regex
right. With the -u switch you can provide the program with the
path to your users.ini file. It will then tell you which line in
the users.ini file matches your nickname. I use the routines from
the AdminMod source code so that the checking is the same that
AdminMod performs.


Examples
~~~~~~~~

The normal usage would be to enter nichname and regex on the 
command line:

> ./regexcheck '[MP]Shadow' '\[MP]Shadow'
[MP]Shadow is matched by pattern \[MP]Shadow. Success.

Put both nickname and regex in single qoutes "'" to prevent
the shell from interpreting any special characters as contol
characters. If you use the csh/tcsh you have to be careful if
you want to use an exclamation mark '!' because the tcsh
interprets it as the history command. It is not escaped by single
quotes and has to be escaped explicitly:

> ./regexcheck  '[-EJ\!-]M@ster' '\[-EJ\!-]M[a@]ster'
[-EJ!-]M@ster is matched by pattern \[-EJ!-]M[a@]ster. Success.


To avoid these traps you can put the nickname into a file. The
file will contain only one line with the nickname to check:

> cat nf
[-EJ!-] Mambojambo
> ./regexcheck -f nf '\[-EJ\!-] Mambo'
[-EJ!-] Mambojambo is matched by pattern \[-EJ!-] Mambo. Success.


To see if the correct entry in yout users.ini file is used:

> cat users.ini
\[SC]:tagpass:16384
\[SC] \+mother\+:somepass:65535

> ./regexcheck  '[SC] +mother+' -u users.ini
Name [SC] +mother+ is matched by \[SC] \+mother\+ in users.ini. Success.

> ./regexcheck -f fn -u users.ini
Name [-EH!-] Mambojambo is NOT matched by any line in users.ini. Failure.


Drawbacks
~~~~~~~~~

Again, this program is for Linux only. I don't do Windows Progamming.
Sorry.
