OS/2 Shareware BBS: 35 Internet/35-Internet.zip/dmi125.zip/Readme.DMI

Text File | 1996-09-26 | 14KB | 277 lines

                       -=≡=- DMI Version 1.2 -=≡=-
        for IRC clients supporting the RxScript REXX IRC Interface
      Copyright (C) 1996, Dusk To Dawn Computing. All Rights Reserved

1. Introduction:
~~~~~~~~~~~~~~~~
   Thanks for checking out DMI. It was written because I had been using
IceBerg (A good proram in itself), and decided that it just wasn't enough
for me. I didn't know REXX (I'm a dyed-in-the-wool Pascal programmer), so
I learned it. I'm still not that great...but I'm better than I was. :)

   DMI pretty much expands on the ideas brought forth by IceBerg. Some
IceBerg commands that I found useless are now gone (Encryption, etc). Some
commands, I either haven't decided to put back in, or haven't finished re-
working yet.

   Very little of the code in DMI still has any resemblance to the original
IceBerg. A bit at a time, nearly all of IceBerg has been replaced by my own
code (Take a look at the XDCC code and compare it to IceBerg's, you'll see
what I mean).

   The biggest feature for DMI, I suppose, is the new help system. For the
1.0 release, I had to move the help system into a separate REXX script,
simply because it was too big (~125 lines all by itself). There is a /HELP
hierarchy, with help pages on the miscellaneous commands, MODE commands,
message logger, OS/2 commands, shortcuts, XDCC commands, and DMI variables.

   Also new is the capability for making aliases for simple commands. In
fact, many of the shortcut commands (Those that could be done in one or
two lines of REXX) have become aliases to speed up normal script execution.

   XDCC has been supercharged! DMI has an almost complete XDCC
implementation, including the ability to change your offer list, display your
current offer list, manually send packs to users, et cetera. It also looks
quite a bit better (To me, anyway. :).

   Autologging now works (Among other things, autolog support was broken in
IceBerg 2.51) correctly, as well as redirection of OS/2 commands, which was
broken in an older version of GammaTech IRC.

   DMI is Donation-ware. If you like it, then I would always appreciate a
donation of a few bucks, a postcard, an e-mail message, or just a good
conversation on IRC. If you don't like it, that's okay too. :)

2. Disclaimer:
~~~~~~~~~~~~~~
   DMI is guaranteed only to take up disk space. While this script has
been thoroughly tested, I have no way of knowing what your setup is, and as
always; if it breaks, you have the pieces.

3. Installation:
~~~~~~~~~~~~~~~~
For GTirc and Internet Adventurer:
Unzip the files in the DMI installation archive into your IRC client's dir.
Load the client. In the options (In GTirc, this is Options -> Startup), you'll
find options for "Input Message Script" and "Output Cmd Script". In the Input
script field, place "DMI-Msg.Cmd". In the Output script field, place
"DMI-Cmd.Cmd". In the "Startup /CMD" field, place "/RUN DMIStart". Type
"/run DMIStart" to initialize, and voila! it's installed.

For IRC/2:
Make a \DMI subdirectory branching off your IRC/2 directory. Unzip the files
from the DMI installation archive into this directory. Run the IRC/2 Setup
program. On the REXX tab, add the full paths to the DMI-Cmd.Cmd and
DMI-Msg.Cmd files. Add /load DMI/DMIStart to your ircrc file, and to one of
the following:

1. Add:     'SET PATH=%PATH%;<Path to the DMI directory>'
   near the beginning of your irc.cmd file.

2. Add the path to your DMI directory somewhere in your PATH in CONFIG.SYS.

Edit the DMIStart file to customize it to your system, and start IRC/2. DMI
should start.

Note: If you don't want to go through all this, you can place the files in your
      base IRC/2 directory. Messier, but it'll work.

4.  Usage:
~~~~~~~~~~
   First thing I would suggest that you do once you have these
scripts loaded is to start GTirc, and run "/HELP".  Familiarize yourself
with what new commands are available.

AutoMode: By setting the AutoMode flag (Using /DMI AutoMode ON), you can
make DMI either give ChanOp status to, or Ban/Kick users meeting specific
User Masks. When a person on this list enters, DMI will (Depending on how
you have that usermask set) give them ops, or ban and kick them. The
AutoMode.Lst file is of this format:

   _B, O, or V - O=Op, B=Ban/Kick, V=Voice for moderated channels
  /       _ User Mask in the format *!*@*
 /       /                          __ Channel        __ Comments
/       /                          /                 /
O *!Deek@gra-mi*.netcom.com     #Deek           This is me
B *!*@*aol.com                  #AolSucks       <BANNED because you suck.>

The Comments field is not used yet for Ops (DMI may require passwords for
ops in the future, or it may be a toggle), but for Ban/Kick users, you may
use this field as a "Kick Message". When DMI kicks the user from the
channel, this text will be sent to the user to explain why it was done, or
perhaps just to taunt him/her. :)


XDCC: XDCC is short for "Extended DCC". It is a semi-standard used by
many different scripts. DMI includes almost complete support for XDCC,
including multi-file packs, extended descriptions, a forgiving pack
offer system, keeping track of how many kilobytes have been sent and
are currently being offered to other users.

The format of XDCC Offer lists is simple - it takes the format:

Pathname Description

A sample file, XDCCList is included in the archive. If a file does not
exist or has an incorrect pathname in your XDCC offer list, DMI will send
you an error message, telling you which line has a missing file in it.

Since version 1.1a, DMI also supports the usage of "XDCCList.DIZ" files.
DIZ files are for adding extended descriptions to your file offerings.
Simply make a text file of the format:

Pack1 Description line 1
Pack2 Description line 1
Pack2 Description line 2

By making multiple Pack# lines, you can have multiple lines in your
extended description. To make DMI use the file, name it the same thing
as your pack list, but with the .DIZ extension after it. This means
if you have a pack list file named "FileList.Lst", your extended list
will be named "FileList.Lst.DIZ". This is done so that when you change
your pack list using /XDCC LIST <File>, your extended description list
changes with it. If you have a better idea on how to handle it, I'd like
to hear it.

5. Future Plans:
~~~~~~~~~~~~~~~~
   There are still a few more things that I want to add to DMI:

   1. Adding/deleting packs from XDCC offer lists.

   2. Implement a cleaner way to do aliases; I don't like the current
      method very much.

   3. Add a DMI_Init file to move the initialization stuff into, making
      DMIStart exclusively for user mods.

   4. Add an IRC/2 script to set it up to better support DMI.

   5. Convert the DMI help into a set of text files to offer more
      flexibility in editing and user modification.

6. History:
~~~~~~~~~~~
   It wasn't until 6/13/96 that I decided to record a history, but I am
   going to try to record all major changes from now on. :) These are
   the ones I remember. <grin>

09/26/96 1.25  Fix /C (query) alias for IRC/2 and possibly others.
               Convert DMIHelp.Cmd into a set of help files, *.HLP
               Remove DMIHelp.Cmd from distribution archive.
09/25/96 1.24  Fix AutoMode - Parts of it weren't respecting the DataDir
                  variable.
               Fix /AUTO's Usage to say /AUTO, not /AUTOMODE. :)
               Add IRC/2 installation info to documentation.
09/25/96 1.23  Implement DataDir to change the default directory DMI
                  looks in for it's data files. Defaults to .\
               Fix AutoMode so it works with IRC/2 properly
09/23/96       Misc. minor fixes to aliases.
09/22/96       Start using the full standard for the IrcRexxSend()
                  function - was causing problems with the IRC/2 beta.
09/19/96 1.22  Fix kick protection - REXX was getting temperamental.
09/17/96 1.21  Add SHORTEN.EXE, a utility to shorten text files by
                  saving only the last N lines. It's a bound EXE, so
                  it works in DOS as well.
09/12/96       Rewrite the Cmd script. Many things should be much faster.
               Noticed something interesting...DMI is now just over 1500
                  lines of code! I think that's kind of impressive. :)
               Add /EDIT alias, which by default starts EPM, the best
                  damn editor on the planet. :)
               Got rid of the /NSL command, /HOST does just as good a job
                  and is much less verbose about it. :)
09/10/96       Add two new help menus, ALIAS and AUTO.
               Renamed /AUTOMODE to /AUTO. It's simpler that way. :)
09/05/96 1.20  Wall, WallOp, and CStat commands now default to the current
                  channel if you don't supply one on the command-line.
               New script: AutoMode.Cmd, to handle AutoMode file management.
               New script: Alias.Cmd, to handle alias file management.
               Add multimedia support to CTCP PAGE.
               Add /IDLE that WORKS! I'm very proud of myself. :)
09/03/96 1.1f  Clean up XDCC list processing. It will now properly handle
                  files 10 megs and over, instead of barfing at 9999K.
               Rewrite about 60 percent of the Inbound Message script. It
                  should be quite a bit faster, as well as cleaner, more
                  reliable, and in general really cool. :)
               Add CTCP PAGE support.
               Add "Paging" variable to script, and DMIStart. "Paging"
                  controls whether or not DMI responds via sound to the
                  CTCP PAGE command.
               Changed archive naming scheme to be nicer to people who like
                  knowing the version by the file date. :)
08/30/96 1.1e  Informed of a SERIOUS bug in GTirc. Before DMI 1.1d, other
                  users could kill GTirc with a special CTCP command. This
                  has been compensated for, and a warning is now sent when
                  this is attempted by another user.
               Add wildcard for channel names to AutoMode
               Add "Voice" to AutoMode
07/14/96 1.1d  Merge AutoOp and AutoBK into AutoMode - see above for usage.
               Add /WHOIS logic for prettying up some things.
               Add Time/Date to /AWAY send
               Fix /BK Alias (did the ban, it tried kicking the BKMsg. <G>)
07/11/96 1.1c  Add XDCC extended description ability. See above for usage.
               Got rid of the extension for DMIStart. Old users will
                  have to change their GTirc setup.
07/08/96 1.1b  Clean up XDCC pack listing.
               Fix potential problems with split finder logic
07/05/96 1.1a  Add error checking to XDCC - it now checks if a file exists
                  before checking the file's size - this gets rid of the
                  "REXX Error 40" errors when a file doesn't exist.
               Added multi-file XDCC offer pack (Wildcard) support.
07/04/96 1.10  Fix /FINDSPLIT - now it will add new servers like it's
                  *SUPPOSED* to. :) (Found old bug in source)
               Added /WALL, /WALLOP - Sends a NOTICE to all users/ops on
                  a channel. Beware, this can get you banned/k-lined if
                  you abuse it!
               Fixed /VOICE, /DEVOICE - were using mode +o/-o instead
                  of +v/-v. :)
               Cleaned up the help a little more. :)
07/03/96 1.0f  Re-add /DW after being pestered <grin> to do so.
               Add /WEB to script and help (Same as /WWW)
06/26/96 1.0e  Clean up help (Add internal variables to help, w/ warning)
06/13/96 1.0d  Fix /J alias (blush)
               Fix/clean up CSTAT
                  (Thanks to Stric for telling me it needed to be done)
               Fix Split Finder...it works now.
               Fix CSTAT, split commands.
                  (they now display on the screen that called them)
               Add /FTP, /LYNX, /TELNET, /WWW aliases.
               Add /FTP, /LYNX, /TELNET, /WWW to help. :)
06/12/96 1.0c  Add XDCC Total Sent and Total Offered.
               Fix several cosmetic problems
06/08/96 1.0b  Split the two scripts into 5 for speed purposes.
                  (DMI-Cmd.Cmd - Main Commands)
                  (DMI-Msg.Cmd - Main Message Handling)
                  (DMIHelp.Cmd - Help system)
                  (XDCC_In.Cmd - Inbound XDCC Handling)
                  (XDCC_Out.Cmd - Outbound XDCC Commands)
                 This should speed up execution by quite a bit.
06/02/96 1.0a  Turn many internal commands into aliases.
06/02/96 1.00  Add Alias support.

7. Credits:
~~~~~~~~~~~
   GammaTech
         - for adding REXX support to their IRC client.

   Stephen Berg (SSgt)
         - for giving me something to improve. :)

   Thomas Ögren (Stric)
         - for finding the /J bug

   Syndi Cagle (Syndi)
         - for telling me about the GTirc bug

   Andy Boss (Swammy)
         - for bitching about your 20 meg file. :)

8. Contacting me
~~~~~~~~~~~~~~~~
   I can be found on IRC usually on EFNet using the nickname "Deek". My
E-Mail address is [e-mail].

   If you have suggestions *please* E-Mail them to me, that way I can
keep an archive on what suggestions I've looked at/worked on/added in, and
I can also keep track of who suggested what.