home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / bbs_opus / sm_27c.arj / SCANMAIL.DOC next >
Text File  |  1991-08-04  |  17KB  |  390 lines
  1.  
  2.                ╔══════════════════════════════════════════════════╗
  3.                ║▒▒▒▒▒▒ ScanMail v2.7c - SysOp Documentation ▒▒▒▒▒▒║
  4.                ╚══════════════════════════════════════════════════╝
  5.  
  6. ScanMail is just what it says. It is a mail scanning program for
  7. Opus Version 1.70.  It is nothing flash and contains no redundant
  8. install code, it just gets the job done.
  9.  
  10. This file contains details on the set-up and use of ScanMail. If you
  11. encounter any problems, you can contact the Author via NetMail at...
  12.  
  13.                            Mick Howland
  14.                            The Perth OMEN
  15.                            FidoNet 3:690/660
  16.  
  17. Or myself
  18.  
  19.                            Jonathan Cousins
  20.                            The Engineer's Pitstop
  21.                            FidoNet 3:690/652
  22.  
  23. If you do get any error messages, please tell us about them as well
  24. as the commands leading up-to the error.
  25.  
  26.  
  27.  ╔════════════════════════════╗
  28.  ║▒▒▒▒▒▒ 1. Legal Stuff ▒▒▒▒▒▒║
  29.  ╚════════════════════════════╝
  30.  
  31. ScanMail is and shall remain the property of Mick Howland of
  32. The Perth Omen. You are granted to use and distribute this
  33. archive as long as the all files within the archive remain
  34. intact and un-modified.
  35.  
  36. Many hours of work have been put into the writing of this program
  37. and it has been tested on several systems. I can not guarantee that
  38. ScanMail will work with all configurations, only that it works on
  39. the configurations it was tested on.
  40.  
  41. The author will not be held liable for any damage this program may
  42. do to your system. You are using it entirely at your own risk.
  43. Remember, if it breaks, you get to keep all the pieces!
  44.  
  45.  
  46.  ╔═══════════════════════════════════╗
  47.  ║▒▒▒▒▒▒ 2. Configuration File ▒▒▒▒▒▒║
  48.  ╚═══════════════════════════════════╝
  49.  
  50.  ╔═══════════════════════════════════════════════════════════════════╗
  51.  ║ Anyone converting from a version of ScanMail prior to 2.7 must    ║
  52.  ║ re-do the config files. This is due to the change in the parameter║
  53.  ║ names to reflect Opus 1.70 as being the official release version  ║
  54.  ║ instead of 1.20.                                                  ║
  55.  ╚═══════════════════════════════════════════════════════════════════╝
  56.  
  57. There are 11 parameters in the configuration file (SM.CFG).
  58. Most of them are self explanatory.
  59.  
  60.  
  61. 1)  Define the location and file name for the User file
  62.  
  63.     Opus170UserFile       C:\Opus\User.Dat
  64.  
  65.  
  66. 2)  Define the location and file name for the Message Area database
  67.  
  68.     Opus170AreaFile       C:\Opus\Sysmsg.Dat
  69.  
  70.  
  71. 3)  Define the location and file name for the Mail file created by
  72.     ScanMail. This file contains a complete list of the messages
  73.     for users on the BBS.
  74.  
  75.     MailWaitingFile       C:\Opus\Misc\MailWait.Dat
  76.  
  77.  
  78. 4)  Define the location and file name for the LastUser file
  79.  
  80.     Opus170Lastuser       C:\Opus\Status\Lastus01.Dat
  81.  
  82.  
  83. 5)  Define the location and file name for the file telling the user
  84.     about any waiting mail along with all area and message details.
  85.  
  86.     MailWaitingOutFile    C:\Opus\Misc\MailOut.Bbs
  87.  
  88.  
  89. 6)  Define the location and file name for the file to be displayed
  90.     after the mail waiting file is shown. This line can be commented
  91.     out if you wish.
  92.  
  93.     ChainToFile           C:\Opus\Misc\Bulletin.Bbs
  94.  
  95.  
  96. 7)  Define the location and file name for the file to be displayed
  97.     if there is no mail for the user. This option may be commented
  98.     out if you do not want to display anything special to the user.
  99.  
  100.     NoMailWaitingFile     C:\Opus\Misc\NoMail.Bbs
  101.  
  102. 8)  Define the location and file name for the flag file. This is for
  103.     multi-line systems to avoid two copies of smc trying to write to
  104.     the same file.
  105.  
  106.     FlagFiles             C:\Opus\Status\
  107.  
  108. 9)  Which area(s) to exclude from a compile/update phase. This is
  109.     especially useful if you have 2 logical areas pointing to the
  110.     same phisical area. E.g. Logoff messages and your replies.
  111.     If you do not want to exclude any areas and are using the INCLUDEAREAS
  112.     option the you may comment this out, however if you don't want
  113.     to use any of these include/exclude options, then leave this
  114.     line uncommented but with no area numbers.
  115.  
  116.     ExcludeAreas          0 9 4321 31932 28
  117.  
  118. 10) Which area(s) to use during a compile/update phase. This is
  119.     especially usefull if you have a lot of areas that you do
  120.     NOT want to be scanned but would take lines and lines (plus heaps
  121.     of typing) to enter. Oposite to the ExcludeAreas option.
  122.  
  123.     IncludeAreas         1 2 3 4 5 6 7 8 9 12 93
  124.  
  125. 11) Define the display colours.
  126.  
  127.                 ScanMail v2.7b.Opus 1.70
  128.           ┌─────┘        │
  129.           │ ┌────────────┘
  130.           │ │         ┌───────────────────────────────────────────────────────┐
  131.           │ │ Jonathan, you have mail waiting for you in the following area(s)│
  132.           │ │ │       │ │                ┌────────────────────┬────┬──────────┘
  133.           │ │ │       │ │      Area     6,  Netmail           │    │
  134.           │ │ │       │ └──┐     │ ┌────┘   │  Msg(s)       25,  34, 123
  135.           │ │ │       └┐   │     │ │   ┌────┘   │           │    │   │
  136.           │ │ └────┐   │   │   ┌─┘ │   │   ┌────┘           │    │   │
  137.           │ └──┐   │   │   │   │   │   │   │   ┌────────────┴────┴───┘
  138.           │    │   │   │   │   │   │   │   │   │
  139.  
  140.    Colour 12  11  12  14   2  13   9  79  10   7
  141.  
  142.    This is a list of the legal colour codes you can use for the
  143.    "Colour" statement. If you want to change background colours,
  144.    select the background colour you want (legal range is 0(Black)
  145.    to 7(Gray)) and multiply it by 16 and then add the foreground
  146.    colour (legal range is 0(Black) to 15(white)). If you want the
  147.    particular item to flash then simply add 128 to you colour.
  148.  
  149.    For example: Using the default Colour statement above, I have
  150.    the name of the area in white with a red background, this works
  151.    out like this...    15(white) + ( 4(red) * 16 ) = 79
  152.  
  153.        Black     =  0    Blue         =  1    Green     =  2
  154.        Cyan      =  3    Red          =  4    Magenta   =  5
  155.        Brown     =  6    Gray         =  7    DarkGray  =  8
  156.        LightBlue =  9    LightGreen   = 10    LightCyan = 11
  157.        LightRed  = 12    LightMagenta = 13    Yellow    = 14
  158.        White     = 15
  159.  
  160.  
  161. Note:
  162.  
  163. ScanMail will create a flag-file during the compilation or update
  164. stage. When SMC/SMD is executed, it will first check for the
  165. presence of this file before proceeding. This is a for multi-line
  166. systems to avoid two copies of smc trying to write to the same file
  167. which could cause some strange if not major problems.
  168.  
  169.  
  170.  ╔═════════════════════════════════════════════════════════╗
  171.  ║▒▒▒▒▒▒ 3. Compiling and Updating the Mail Database ▒▒▒▒▒▒║
  172.  ╚═════════════════════════════════════════════════════════╝
  173.  
  174. Before ScanMail can be used for the first time, it must compile a
  175. listing of mail waiting for the users.
  176.  
  177. This compilation should also be done after any re-numbering of the
  178. message base. An update should be performed after users log off
  179. and after the reciept of inbound mail.
  180.  
  181. The syntax for the compile/update program are as follows.
  182.  
  183.         SMC <-C>       <-U>      <-Afilename.ext>
  184.               Compile    Update    Alternative config file
  185.  
  186.  
  187.                                    *** Note ***
  188.  
  189.                                    No spaces are allowed between
  190.                                    the -a and the filename.
  191.  
  192. Typing SMC by itself will display the available parameters
  193.  
  194.  
  195.  ╔═════════════════════════╗
  196.  ║▒▒▒▒▒▒ 3.1 Compile ▒▒▒▒▒▒║
  197.  ╚═════════════════════════╝
  198.  
  199. The compile procedure will read in the area and user database
  200. files. It will then scan through all defined message areas and
  201. create its own database of users with mail waiting.
  202.  
  203. Priviledge levels are honoured so that users will not be shown
  204. mail waiting in areas that they can not access. It is up to you
  205. to ensure the users have access to areas that messages for them
  206. may be entered into.
  207.  
  208.  
  209.  ╔════════════════════════╗
  210.  ║▒▒▒▒▒▒ 3.2 Update ▒▒▒▒▒▒║
  211.  ╚════════════════════════╝
  212.  
  213. After a user has logged off, or extra mail is added (without
  214. renumbering the message base), you may update the ScanMail data.
  215. To do this, just use the -U parameter.
  216.  
  217. The update procedure will read in the lastuser file (as stipulated
  218. in the configuration), the old ScanMail data file, Opus user and
  219. sysmsg data files, then check with the high-water marks for all the
  220. message areas. Any new messages to users will be added to and any
  221. deleted mail will be removed from the ScanMail database.
  222.  
  223.  
  224.  ╔═════════════════════════╗
  225.  ║▒▒▒▒▒▒ 3.3 Display ▒▒▒▒▒▒║
  226.  ╚═════════════════════════╝
  227.  
  228. SMD has two command line options. Using SMD by itself will generate
  229. the MailWaiting file to show to the user who is currently online.
  230. Typing SMD with a users name will show any mail waiting for that
  231. user on your screen.
  232.  
  233. For example.
  234.  
  235.    SMD <enter> will generate a file for the user.
  236.  
  237.    SMD Mick Howland <enter> shows any mail waiting locally
  238.  
  239.    SMD Mick Howland -ac:\opus\sm.cfg <enter> same as above but tells
  240.                      ^                       SMD where to find an
  241.                      |                       alternative config file.
  242.                      |
  243.                      | Note - No space between the -a and the filename.
  244.  
  245.  
  246.  ╔══════════════════════════════════════╗
  247.  ║▒▒▒▒▒▒ 4. Sample Implementation ▒▒▒▒▒▒║
  248.  ╚══════════════════════════════════════╝
  249.  
  250. Now for the really useful bit. You now know how to compile the data
  251. and how to generate the display file. Next to give an example.
  252.  
  253. a) Copy the files into your OPUS directory.
  254.  
  255. b) Place the command "SMC -C" in your midnight event batch file
  256.    after the message renumbering.
  257.  
  258. c) Insert "SMC -U" in the batch files just after a user logs off
  259.    and after incoming mail processing.
  260.  
  261. d) Add some lines to display the message to the user.
  262.    For example, at the end of my Welcome.OEC file, I have the
  263.    following lines....
  264.  
  265.        [DOS]c:\opus\smd
  266.        [ENTER][CLS][CALLFILE]c:\opus\misc\mailout.bbs
  267.        [DISPLAY]c:\opus\misc\bulletin.bbs
  268.  
  269.    * Callfile compiles to ^OA - customised
  270.    * If you use OACOMP, add "CALLFILE ^OC" to your OACOMP.TOK file
  271.  
  272.    I have also added an option into the Message Menus...
  273.  
  274.        _SHOW      Twit      "Where are mine?" = c:\opus\mailout
  275.  
  276.    Important - If you use this function, any chain file that you
  277.                entered in the config file will also be shown.
  278.  
  279.  
  280.  ╔════════════════════════════════════╗
  281.  ║▒▒▒▒▒▒ 5. Future Enhancements ▒▒▒▒▒▒║
  282.  ╚════════════════════════════════════╝
  283.  
  284.   a) Make the message compile function KEY aware.   Any need for it?
  285.   b) Speed up compile and display phases.           Ummmmm???????? yeah, right.
  286.  
  287.  
  288.  ╔═════════════════════════════════╗
  289.  ║▒▒▒▒▒▒ 6. Revision History ▒▒▒▒▒▒║
  290.  ╚═════════════════════════════════╝
  291.  
  292. If a lot of this seems like gobbly-gook, don't worry, it's just a
  293. product of my warped logic, and it makes sense to me!
  294.  
  295.    SMC.EXE
  296.  
  297.    1.0  06/06/91 - Initial release to Jon (guinea pig). Only compiled database,
  298.                    limited usernames capability.
  299.    1.1  15/06/91 - Usernames now allocated dynamically on heap. Added command
  300.                    line functions and help if none. Added highwater recording
  301.                    for the update phase. Also added a pointer to the next
  302.                    record in the datafile.
  303.    1.2  18/06/91 - Changed database format, removed $ffff terminator word in
  304.                    output file. Not needed now because of record pointers.
  305.    1.3  19/06/91 - Started adding the update phase. What a prick of a job!
  306.    1.4  24/06/91 - Reverted back to highwater marks from v1.1.
  307.    2.4  25/06/91 - Version number changed to make it obvious that this is a
  308.                    complete rewrite from the version 1.x program release.
  309.         29/06/91 - Finally got the %$@#$*( sorts to work!
  310.         30/06/91 - First offical Opus 1.70 release.
  311.    2.5  01/07/91 - Added a new error handler routine. Now loggs errors to a
  312.                    disk file. It should now read the sysmsg file correctly as
  313.                    there were errors in the released Opus structures. This
  314.                    caused me a few headaches!
  315.    2.6  07/07/91 - Added a config option to specify where the flag files are
  316.                    to be created/found as we just went multiline and it soon
  317.                    became apparent that the original idea was full of bugs.
  318.                    The alternative config file option _NOW_ works, what a
  319.                    stupid mistake!
  320.    2.6a 13/07/91 - First official public release.
  321.    2.7  14/07/91 - Added an exclude area function. Thanks to Andrew Newbury
  322.                    (3:634/385@fidonet) for this suggestion.
  323.    2.7a 14/07/91 - Fixed command line parser, for good this time i hope.
  324.    2.7b 02/08/91 - Added a new config option that tells ScanMail to only look
  325.                    at areas wanted. Oposite to the ExcludeAreas option. Thanks
  326.                    to Dan Dimick (1:105/7@fidonet) for this suggestion.
  327.                    Should also fix problems encountered with screen bleed
  328.                    through under DesqView (I hope? It did here!).
  329.    2.7c 03/08/91 - Fixed a very small mite that i introduced while adding the
  330.                    includeareas option <red face>.
  331.  
  332.    SMD.EXE
  333.  
  334.    1.0  06/06/91 - Initial release to Jon (guinea pig).
  335.    1.1  15/06/91 - Now skips highwater mark header information.
  336.    1.2  18/06/91 - OEC colour codes now conform to Opus specs ^V^A^P Highbit
  337.                    set on colour value. Copy of the nomailwaiting file is now
  338.                    done with a blockread, as a text file readln() could bomb
  339.                    on a ^Z in the nomailwaiting file.
  340.    2.2  25/06/91 - Version number changed to make it obvious that this is a
  341.                    complete rewrite from the version 1.x program release.
  342.    2.3  ??/??/?? - Ummmm, obviously i can't count. Don't know how i missed 2.3?
  343.    2.4  30/06/91 - Official Opus 1.70 release. Did some change to this version
  344.                    but forgot to mention it here, maybe i should go to bed at
  345.                    a decent hour like normal people!
  346.    2.5  01/07/91 - Added a new error handler routine. Now loggs errors to a
  347.                    disk file. Added colour config code. It should now read the
  348.                    sysmsg file correctly as there were errors in the released
  349.                    Opus structures. This caused me a few headaches!
  350.    2.6  07/07/91 - Added a config option to specify where the flag files are
  351.                    to be created/found as we just went multiline and it soon
  352.                    became apparent that the original idea was full of bugs.
  353.                    The alternative config file option _NOW_ works, what a
  354.                    stupid mistake!
  355.    2.6a 13/07/91 - First official public release.
  356.    2.7  14/07/91 - Added local display option. Thanks to Andrew Newbury
  357.                    (3:634/385@fidonet) for this suggestion.
  358.    2.7a 16/07/91 - Fixed problem in that if SMC was running on one node and
  359.                    SMD was run on a different node, SMD would abort and Opus
  360.                    would show the user online, the mailwaiting file from the
  361.                    last logon. SMD now writes out the nomailwaiting file which
  362.                    should fix this. Fixed a small bug in the file copy routine.
  363.         19/07/91 - Small mod to command line parser. Should now ignore any
  364.                    spaces between -a and alternative config path/filename.
  365.    2.7b 02/08/91 - Found and fixed another problem with the command line
  366.                    parser. Who invented bloody command line options anyway!
  367.                    Should also fix screen bleed problems encountered while
  368.                    using DesqView (I hope? It did here!). Also enabled more
  369.                    prompts in the output display file as suggested by
  370.                    Dan Dimick (1:105/7@fidonet).
  371.  
  372.  
  373.  ╔════════════════════════╗
  374.  ║▒▒▒▒▒▒ 7. Credits ▒▒▒▒▒▒║
  375.  ╚════════════════════════╝
  376.  
  377. I would like to say thanks to the Opus LCDs for the many many hours
  378. of unpaid work they have put into Opus to make it the worlds best.
  379.  
  380. Many thanks to all who beta tested this very buggy program, especially
  381. Dan Dimick who really helped me along with his quick replies.
  382.  
  383. No thanks to Jonathan Cousins for giving me a lot of headaches
  384. because of his insistant nagging for me to write this <grin>.
  385.  
  386.  
  387. Programme by Mick Howland, Documentation by Jonathan Cousins & Mick Howland.
  388. Compiled 4th August 1991
  389.  
  390.