home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / GREETZ44.ZIP / GREETZ.DOC < prev    next >
Text File  |  1995-01-13  |  14KB  |  316 lines
  1.  
  2.  
  3.                            GREETZ v4.04
  4.                                 by
  5.                   Brian Bosworth & David Hollis
  6.                      Double Miracle Software
  7.  
  8.   Introduction:
  9.  
  10.     GREETZ is an informative login utility for WWIV BBS Systems.  It gives
  11.   users a little information, and the ability to leave on-liner messages to
  12.   the next callers.  Also, there is the ability for the SysOp to leave
  13.   news to the users.  The news is only shown to the user once.  Greetz also
  14.   supports Multiline operation.
  15.  
  16.   Files:                                       Usage:
  17.  
  18.   GREETZ4.EXE    Executable file               <path>GREETZ4.EXE
  19.  
  20.   DMS.INI*       Configuration INI file        <none>
  21.  
  22.   GRTZNEWS.<ext> SysOp News file               <ext> is a distinguishing
  23.                                                extension for each news
  24.                                                file.
  25.  
  26.   FILE_ID.DIZ    A Description for BBS use     <none>
  27.  
  28.   *NOTE - Changed from GREETZ.INI.  All DMS programs will use DMS.INI
  29.   to consolidate the information and make some information shareable.
  30.  
  31.   Installation:
  32.     Unzip the archive (GREETZ44.ZIP) to your main WWIV directory.
  33.     It can also be installed in it's own subdirectory if you like to
  34.     keep programs out of the BBS directory.  The directory for Greetz
  35.     should contain Greetz and all it's data files.  Be certain that the
  36.     full path to CHAIN.TXT is passed (%1 on the command line will pass the
  37.     full path) or Greetz may not work properly.  If you do opt to use
  38.     Greetz from a seperate directory, you may wish to use a batch file.
  39.     Here is a sample called LOGON.BAT (in main WWIV dir):
  40.  
  41.          @echo off
  42.          CD\WWIV\GREETZ
  43.          GREETZ4.EXE %1
  44.          CD\WWIV
  45.  
  46.     Add the following line to your login event batch file, or
  47.     the login event field in INIT (under Option 6):
  48.  
  49.     <full path>GREETZ4.EXE %1
  50.  
  51.     i.e, a typical system that has installed it in their main WWIV dir can
  52.     use:
  53.  
  54.     GREETZ4.EXE
  55.  
  56.     and that's it!  Greetz does the rest.
  57.  
  58.     NOTE: For multiline operation, the CHAIN.TXT parameter must be passed.
  59.     No parameters forces Greetz to assume the file is CHAIN.TXT, not
  60.     CHAIN.<node>.
  61.  
  62.     NOTE: If upgrading from a previous version of Greetz, you can rename
  63.     the GREETZ.INI file to DMS.INI.  Also, if you desire to keep the messages,
  64.     you will need to change the lines in the INI from MSGx to Message.
  65.       (i.e., INI has a line such as:
  66.              Msg1=This is message one
  67.                  should now become
  68.              Message=This is message one
  69.       )
  70.  
  71.     If it were installed in a GREETZ sub-directory, it may look something
  72.     like this:
  73.  
  74.     LOGON.BAT %1
  75.  
  76.     Also, you can run Greetz as an on-liner (if you want users to be
  77.     able to re-peruse the messages or whatever).  Setup is simple,
  78.     just call GREETZ4.EXE %1.  The BBS should definitly intercept
  79.     DOS calls, shrinking is not neccessary.  I would definitly recommend
  80.     that 300 not allowed be a definite YES!
  81.  
  82.   INI Fields:
  83.  
  84.     There are a few fields in the DMS.INI file that may or may not be of
  85.     interest:
  86.  
  87.     [Greetz]
  88.     LastCaller - Stores the last caller information (should not be changed)
  89.  
  90.     SysOpQuote - Allows a "quote" to be displayed for the SysOp.
  91.                  It is displayed under the "Your SysOp" line.
  92.                  (Default: nothing)
  93.  
  94.     SaveSysOp  - TRUE or FALSE.  If TRUE, SysOp logins will go into
  95.                  Last Caller field.  If FALSE, the previous
  96.                  non-SysOp caller will be retained. (Default: False)
  97.  
  98.     MessageSystem - TRUE or FALSE.  If TRUE, Message system is
  99.                  enabled.  If FALSE, Message system is completly
  100.                  removed.  (Default: True)
  101.  
  102.     MinSLAddMsg- Minimum SL to add a message. (Default: 0)
  103.  
  104.     ForceNews  - If TRUE, users will be shown ALL SysOp News files
  105.                  on every logon.  If FALSE, only files changed since
  106.                  the users last call will be shown.
  107.     Msg2SysOpLog - if TRUE, Greetz will make a note in the SysOp log
  108.                    when a user writes a new message (who wrote what, etc.).
  109.                    Defaults to TRUE.
  110.  
  111.     [Greetz Messages]
  112.     Message<x>   - This is where the messages are stored.  If you find
  113.                  an offensive message, you can just remove it from the file.
  114.  
  115.     Date & Time Seperators:
  116.       You can also change how Greetz will display the Date & Time.
  117.       They are maintained in a section [International].  Below is
  118.       an example, of which should explain everything.
  119.  
  120.          [International]
  121.          TimeSep=:            ;Time seperator  (9:12:43)
  122.          DateSep=/            ;Date seperator  (9/12/42)
  123.  
  124.          ;Time24 - Military Time.  Can be TRUE or FALSE
  125.          Time24=False
  126.  
  127.          ;DateFormat - 0=USA (mdy), 1=Europe (dmy), 2=Japan (ymd)
  128.          DateFormat=0
  129.  
  130.  
  131.   SysOp News:
  132.     Use an ASCII text editor (DOS' EDIT.COM, WWIVEdit, or the like)
  133.     to create a file GRTZNEWS.<ext> in your GREETZ directory.  The timestamp
  134.     of this file will be compared to the users last login date.  If their
  135.     last login was prior to the creation (or edit) of the news, it will
  136.     be displayed to them.  Do not bother to embed color codes in the file,
  137.     they will be removed.  You can have as many files as the 3 digit
  138.     extension will allow (I think that you should not have any troubles
  139.     in that regard).  If the user happens to be the SysOp, the file
  140.     name of the current news file is displayed on the box as well for
  141.     reference purposes.
  142.  
  143.   Registration:
  144.  
  145.      Greetz is NOT Public Domain (PD).  It is Shareware.  You are
  146.   permitted to use the software for a period of 30 days, after which
  147.   you must either register the software, or discontinue it's use.
  148.   Registration costs $10.00 (US funds only) and entitles you to
  149.   ALL subsequent releases of Greetz.  To register, please send a
  150.   check addressed to David Hollis to:
  151.  
  152.                       David Hollis
  153.                       c/o Double Miracle Software
  154.                       425 Fairtree Dr.
  155.                       Severna Park, MD
  156.                           21146
  157.                       ATTN: Registration
  158.  
  159.   Disclaimer:
  160.  
  161.      Double Miracle Software claims no responsibility for any damages
  162.   related to the use of this software.  The software has been tested
  163.   on more than one system and deemed safe for use.  There is very
  164.   little likelyhood of any damage actually happening as the only files
  165.   that GREETZ even looks at are CHAIN.TXT and DMS.INI.
  166.  
  167.   If you have any questions you can contact Double Miracle Software at:
  168.  
  169.      The Whammy Bar BBS         410-647-9592
  170.          1@8344 WWIVNet
  171.      dhollis@clark.net
  172.  
  173.  
  174. Greetz is Copyright (c) 1994 Double Miracle Software.
  175. WWIV is Copyright (c) 1988-1994 Wayne Bell
  176.  
  177.  
  178. Revision History
  179. ----------------
  180. Greetz 4.04 - Ok, the stupid "Math coprocessor required" message should
  181. (Released:    be totally obliterated.  Thanks (and sorry) to those that
  182.   1/13/94     found and mentioned this annoyance.
  183. Friday 13th!)
  184.               Fixed some date/time minor details.  Some routines did not
  185.               use International routines so if date/time seperators were
  186.               modified, some values would not reflect it.
  187.  
  188.               Added support for multiple SysOp Quotes (currently a maximum
  189.               is set at 4).  Simply define a couple SysOpQuotes in the
  190.               DMS.INI (Greetz section) and it will select a random one
  191.               to display.  Future plans are to allow for as many quotes
  192.               as you want to put in the file.
  193.  
  194.               Yet again, more conversion into pure ASM.
  195.  
  196.           **  Known bugs to be fixed and upcoming features **
  197.  
  198.               Dropped carriers while in Greetz often (always?) leave
  199.               the system in endless loop of "Exiting ..." at a prompt.
  200.  
  201.               Small INI problem with LastCaller field (sometimes keeps
  202.               a couple, but the correct last caller is always brought
  203.               up, small detail).
  204.  
  205.               "On-line" SysOp News editor and possibly a configuration
  206.               utility (instead of being required to manually edit the INI).
  207.               Still trying to determine best method to call up the News
  208.               editor (don't want to force a menu selection on people).
  209.               Suggestions are welcome.  Currently looking at command
  210.               line param, not the best, but the least obtrusive.
  211.  
  212. Greetz 4.03 - Completly reconstructed the INI routines to allow for more
  213. (Released:    flexibility with programming.  By revamping the routines,
  214.  12/09/94)    the addition of other features has been simplified.
  215.  
  216.               Message writers now saved in INI file for reference.
  217.               The author of a message will be listed on the same
  218.               line of the INI as the message written.
  219.                 (Message=<author>:<message>)
  220.               Also, deleting messages has been simplified due to INI
  221.               revamping.  Simply delete the line of the message
  222.               to be removed.
  223.  
  224.               Added support for multiple news files.  News files should
  225.               now be called GRTZNEWS.<ext> where <ext> can be whatever
  226.               you like (.001, .002, whatever).
  227.  
  228.               Added ability to force users to read news on every call.
  229.               (ForceNews in .INI file)
  230.  
  231.               Fixed ratio bug for users with extremly high ratios (little
  232.               downloads compared to uploads).  Now the ratio will not be
  233.               higher than 99.999.
  234.  
  235.               Renamed GREETZ.INI to DMS.INI so all DMS programs can share
  236.               one file.  Makes things a little cleaner and removes redundant
  237.               data (if international settings are used especially).
  238.  
  239.               Word Wrapping for SysOp News.  Now you don't need to worry
  240.               about how many characters per line when writing the news
  241.               file.  Greetz will automatically wrap it for you!
  242.  
  243.               Fixed cosmetic problem of erasing right edge of message box
  244.               when adding a new message and previous scrolled.  This only
  245.               occured when the message box was "full" and had to scroll
  246.               up to allow for a new message.  (Had constants been used
  247.               properly, this bug never would have turned up....)
  248.  
  249.               If no message was entered (user just hits carriage return),
  250.               doesn't ask to add, nor add the message.  Really a convienince
  251.               thing in case the user accidentally hit yes to enter a message
  252.               and really didn't want to.
  253.  
  254.               With the ratio bug fixed, mistakenly set the ratio to 0.00 when
  255.               the ratio should be 99.999.  Minor detail.
  256.  
  257.               Optimized in many areas.  Many routines put into direct
  258.               Assembly to speed up displays.  Removed some redundance with
  259.               routines being defined in a couple of places.
  260.  
  261. Greetz 4.02 - Hopefully the last of the bug fixes!
  262. (Released:    Fixed that math-coprocesser required bug (set that flag wrong!)
  263.  11/18/94)    Took care of the run-time error at the ratio
  264.                (very stupid error!)
  265.               Should be very stable now (but do let me know!)
  266.  
  267. Greetz 4.01 - Bug fix with new features
  268. (Released:    Fixed color bug (users having different colors setup
  269.  11/05/94)    would have Greetz displayed in their colors.  Could
  270.               get ugly at times).  Greetz now sends the ANSI, not
  271.               WWIV.
  272.               Fixed some bugs with messages overlapping (only a
  273.               cosmetic/display bug)
  274.               Added SysOp News (which was in v1 -> 3.0 and removed
  275.               due to time contraints in 4.0) (file: GREETZ.NWS)
  276.               Fixed some potential INI problems and removed
  277.               error messages that could mess up screen (informative,
  278.               but not neccessary messages).
  279.               Fixed to run without any INI at all (messages would
  280.               be saved and create the INI)
  281.               Added flags to completely disable the message section
  282.               if so desired.
  283.               Added flag to save or not save SysOp logins in LastCaller
  284.               field.
  285.               SysOp News is only displayed to a user if they have a
  286.               last on date prior to the time stamp on the NWS file.
  287.               Not perfect, but makes so a user doesn't have to skip
  288.               it every subsequent logon (and potentially miss later
  289.               updates).
  290.               Fixed minor detail with a user adding a message, then
  291.               saying No to the "Are you Sure?" prompt.  It didn't
  292.               erase it so it gave the impression that it did
  293.               (though it was not saved).
  294.               Added a "Node: " line if Greetz detects that WWIV is running
  295.               in Multi-instance mode.  Will read appropriate CHAIN file
  296.               in such a case as well.
  297.  
  298. Greetz 4.0  - Complete Rewrite
  299. (Released:    Totally new screen layout/color scheme
  300.  10/31/94)    Introduced INI configuration file
  301.               Made a bit more robust and stable.
  302.               Allowed SysOp quote
  303.               Many routines written in ASM even (wow!)
  304.               Made configuration programs unnecessary (GREETC.EXE)
  305.               All config data and messages saved in INI file.
  306.  
  307. Greetz 3.0  - All differences, enhancements lost in time...
  308.        .      (circa April/May '94 or so).
  309.        .
  310.        .
  311. Greetz 2.0
  312.        .
  313.        .
  314.        .
  315. Greetz 1.0  - Original version by Double Click. (circa Jan '94 or so).
  316.