home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / PRESCAN.ZIP / PRESCAN.DOC < prev    next >
Text File  |  1992-11-25  |  16KB  |  474 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                             PreScan (tm)
  8.                           Version 2.05.00b
  9.  
  10.  
  11.  
  12.  
  13.                             
  14.                    Copyright (c) 1992, Jeff Hasz
  15.                         All Rights Reserved
  16.  
  17.  
  18.  
  19.  
  20.  Page i                                                              PreScan
  21.  
  22.                               Forward
  23.                               
  24.         I'll try to be brief here, in my forward, but I would like
  25.         to thank a few people for helping make PreScan a reality.
  26.         
  27.         First, I'd like to thank my wife for putting up with me 
  28.         working into the wee smalls, and my daughter, Sara, who
  29.         corageously puts up with my rantings.  They are both a
  30.         fountain of inspiration to me.
  31.         
  32.         Secondly, I'd like to thank Laughlin (you know who you
  33.         are) for the patience to test this thing and await the 
  34.         next beta release while I was implementing and debugging
  35.         the excellent suggestions you gave me for improving 
  36.         PreScan.  (Next thing I work on L is better doc 
  37.         formatting, OK?)
  38.         
  39.         And finally, to my former employer, who, in a surprise
  40.         decision, gave me the time to get those creative juices 
  41.         flowing again, without which, I would never have even 
  42.         conceived of PreScan let alone had time or energy to create
  43.         it. 
  44.         
  45.         There, I think that's short enough...
  46.         
  47.         Enjoy,
  48.         
  49.  
  50.         Jeff  -  November 1992
  51.         
  52.  
  53.  Page 1                                                              PreScan
  54.  
  55.  
  56.         Hello, first a word of advice, if you are viewing this with your
  57.         text based word processor, you will have to set your tabs to 
  58.         four.  This document was save with actual tabs in it. if you 
  59.         wish them to be spaces you will have to edit it and place four
  60.         spaces for every tab. 
  61.  
  62.         First off, these are the files you should have received in the
  63.         PRESCAN.ZIP:
  64.         
  65.             PRESCAN.EXE                The PreScan executable.
  66.             
  67.             PRESCAN.CFG                A sample configuration file.
  68.             
  69.             PRESCAN.BAT                A sample prescan.bat file.
  70.             
  71.             PRESCAN.DOC                This documentation file.
  72.             
  73.  
  74.         Additional Files you will receive upon registering your copy
  75.         of PreScan:
  76.         
  77.             DAYERR.EXE                A program to generate a errorlevel
  78.                                     based on the current day.
  79.             
  80.         
  81.         I will quote myself:
  82.  
  83.         "However, if enough repondants request that PreScan be made
  84.         available as a stand alone door program, I will incorporate
  85.         all of the required code to make it a stand alone door program."
  86.         
  87.         Well it's here!  PreScan V 2.0.0!  Now New! Improved! (oops,
  88.         sorry, I'm getting carried away).
  89.         
  90.         But it is here...Prescan, version 2.  Now a stand-alone door
  91.         program.
  92.         
  93.         Please feel free to support this shareware development effort 
  94.         through the registration proceedure and through your comments.
  95.         
  96.         
  97. Page 2                                                               PreScan
  98.  
  99.         Contents:
  100.         
  101.             Packing manifest................................ 1
  102.             Table of Contents............................... 2
  103.             Terms and Conditions............................ 3
  104.             Restrictions.................................... 3
  105.             Introduction.................................... 4
  106.             Installation.................................... 4
  107.             Configuration................................... 5
  108.             Configuring the PRESCAN.BAT file................ 6
  109.             Why Should I Register?.......................... 7
  110.             Registration Form............................... 8
  111.             Appendix A...................................... 9
  112.             Appendix B......................................10
  113.             
  114.  
  115.  
  116. Page 3                                                               PreScan
  117.  
  118.     Terms and Conditions:
  119.     
  120.         PreScan is a shareware package.  To those of you who don't 
  121.         know or have a vague idea what this means, read on.  
  122.         Otherwise, skip to the next section.  Shareware is software 
  123.         you may "share" with your friends and colleagues.  You may 
  124.         use PreScan as much as you wish for up to 45 days with 
  125.         absolutely no obligation to buy it.  But shareware isn't 
  126.         free. You must pay for PreScan if you decide to use it past 
  127.         45 days.  The initial charge for PreScan is $10, which will 
  128.         not include printed documentation and disks initially.  
  129.         However, registering PreScan will include free upgrades to 
  130.         the software for up to 1 year.  Some time at a later date 
  131.         printed documentation may be available, depending on demand.
  132.  
  133.         The copy of PreScan you have is not crippled, and hopefully 
  134.         it isn't "annoyware."   
  135.  
  136.     Restrictions:
  137.  
  138.         You have obtained a copy of a shareware package, which means 
  139.         you may let your friends and colleagues have a copy if you 
  140.         wish, as long as you abide by the following restrictions:
  141.  
  142.             1.  You do not charge for the transfer of PreScan or any 
  143.                 of its components.
  144.  
  145.             2.  You supply the exact files and packaging for the 
  146.                 shareware version of PreScan that you obtained 
  147.                 electronically or by other means.
  148.  
  149.             3.  You DO NOT share the licensing information provided 
  150.                 once you register PreScan.
  151.  
  152.         The author, Jeff Hasz, makes no claim as to the viability or
  153.         usefulness of the product to suit particular needs.  Use the 
  154.         product initially for no charge, and when the test drive is 
  155.         over, decide if you like it and register it if you do.
  156.  
  157.         PreScan is copyrighted property developed by Jeff Hasz.
  158.  
  159.  
  160.  
  161.  
  162. Page 4                                                               PreScan
  163.  
  164.         Introduction:
  165.         
  166.             PreScan was conceived as a timesaving program for the 
  167.             Ship to Shore On-Line Information Service to allow some
  168.             user maintenance.
  169.             
  170.             It allows the on-line user to select to have his mail
  171.             packets prepared for him prior to his logging onto your 
  172.             system.
  173.             
  174.             This is done by calling the mail door through the
  175.             PRESCAN.BAT file and allowing it to create individual
  176.             mail packet files for each listed user.
  177.             
  178.             It was originally created to run under the WildCat! 
  179.             BBS system with the Tomcat! mail door.  It has not been
  180.             fully tested with any other mail door yet.  (read, "Any 
  181.             volunteers out there?")
  182.             
  183.             It has the capability to support almost any mail door
  184.             that supports prescanned packets.
  185.             
  186.             Finally, PreScan REQUIRES the use of a fossil driver to 
  187.             work, it has been tested with X00.
  188.             
  189.         Installation:
  190.         
  191.             PreScan should be installed in the same directory that
  192.             your BBS software is.  This is not mandatory, but it 
  193.             helps keep things straight.
  194.             
  195.             The PRESCAN.CFG file _must_ be installed in the same
  196.             directory as PRESCAN.EXE.  PreScan looks for the 
  197.             configuration file in the same place that it exists.
  198.             
  199.             The configuration file contains information needed 
  200.             by PreScan to determine where the CALLINFO.BBS file 
  201.             and the PRESCAN.BAT file are located as well as the 
  202.             actual name of the CALLINFO file (Some BBS's create a
  203.             file called PCBOARD.BBS or DORINFO.DEF).
  204.             
  205.             It also contains information about what line(s) the 
  206.             user name is located as well as where to find the baud
  207.             rate and the COM port.
  208.             
  209.             Also in this file is the name of the mail door you are 
  210.             using and the format that it is called with.
  211.             
  212.  
  213.  
  214. Page 5                                                               PreScan
  215.  
  216.         Configuration:
  217.         
  218.             Ok, so now you have the files all unpacked, so now it's 
  219.             time to set up the configuration of PreScan.
  220.             
  221.             Below is a sample PRESCAN.CFG file.  A discussion of
  222.             each line will follow.
  223.         
  224.             d:\wc30\callinfo.bbs
  225.             d:\wc30\
  226.             1, 1, 29, 31
  227.             tomcat %s /prescan
  228.             tomcat
  229.             d:\wc30\
  230.             
  231.             Ok, clear as mud, right?
  232.             
  233.             The first line is the line that contains the path and 
  234.             file name of the "callinfo" file.  For WC! this *will*
  235.             be CALLINFO.BBS (boy those guys as MSI think of 
  236.             everything!).  This could be PCBOARD.DEF or something
  237.             else that some BBS author dreams up.
  238.             
  239.             The second line indicates where the PRESCAN.BAT file 
  240.             is located.
  241.             
  242.             The third line contain the line number in the "callinfo"
  243.             file that has the users first name and second name 
  244.             respectively.
  245.             
  246.             Also in the third line are the line numbers for the COM
  247.             port and the modem speed (baud rate).
  248.             
  249.             The fourth line is the format line for how your mail
  250.             door is called for creating prescan packets.
  251.             
  252.             The fifth line is the name of your mail door (this 
  253.             should be the same as the first word of the line 
  254.             preceeding it in the file i.e. the fourth line).
  255.             
  256.             The final line MUST exist, even if it's blank.  If this
  257.             line is left blank then no logging will occur.  To 
  258.             institute logging of the additions to your PRESCAN.BAT
  259.             file, put the path to where you want the log file to
  260.             be placed here.
  261.             
  262.             Once you have this file created and setup properly
  263.             you can test the door with your PRESCAN.BAT file to
  264.             determine if it is setup correctly.
  265.  
  266.  
  267.  
  268. Page 6                                                               PreScan
  269.             
  270.             However, this supposes that you have created a minimal 
  271.             PRESCAN.BAT file already.  And you do know how to do 
  272.             that, don't you?  Oh that's right.  I haven't explained
  273.             that part yet...Ok, I'll get on with it.
  274.             
  275.  
  276.         Configuring the PRESCAN.BAT file:
  277.  
  278.             The correct format for the PRESCAN.BAT file is as
  279.             follows:
  280.             
  281.             @echo off
  282.             c:
  283.             cd \wc30
  284.             dayerr nnn        /*  This line exists only for registered versions  */
  285.                             /*  nnn = the number to start your error level at  */
  286.                              /*  in this example nnn would equal 10               */
  287.  
  288.             if errorlevel == 16 goto SATURDAY
  289.             if errorlevel == 15 goto FRIDAY
  290.             if errorlevel == 14 goto THURSDAY
  291.             if errorlevel == 13 goto WEDNESDAY
  292.             if errorlevel == 12 goto TUESDAY
  293.             if errorlevel == 11 goto MONDAY
  294.             if errorlevel == 10 goto SUNDAY   
  295.             :SUNDAY
  296.             goto DAILY
  297.             :MONDAY
  298.             goto DAILY
  299.             :TUESDAY
  300.             goto DAILY
  301.             :WEDNESDAY
  302.             goto DAILY
  303.             :THURSDAY
  304.             goto DAILY
  305.             :FRIDAY
  306.             goto DAILY
  307.             :SATURDAY
  308.             :DAILY
  309.             tomcat sysop /download
  310.             tomcat JOHN SMITH /prescan
  311.             d:
  312.             cd \fd
  313.             
  314.             You *must* begin with at least one call to your mail
  315.             door already in place (see appendix A).
  316.             
  317.             The labeled points are required only for the registered
  318.             version...<hint, hint>...If you don't run the registered
  319.             version, then you can leave them out.  But if you
  320.             decide to register your PreScan (and I hope you will), 
  321.             you will need to put them back in.
  322.             
  323.             If you have the registered version of PreScan, the 
  324.             labels are required and they are required to be in the
  325.             order shown (you can use the sample PRESCAN.BAT file
  326.             supplied as a beginning).
  327.             
  328.             I trust that the rest of this file will be self
  329.             explanatory.
  330.             
  331.             
  332.  
  333.  
  334. Page 7                                                               PreScan
  335.  
  336.         Registration:
  337.         
  338.             Please register PreScan if you find it helpful in 
  339.             your BBS maintanance.  It will help promote further
  340.             enhancements and other new, useful doors that I might
  341.             develop.  It also might inspire me to add features to
  342.             Prescan or create other good, easy-to-run programs for
  343.             us sysop types.
  344.             
  345.             Remember that if you don't register it, I absoulutely
  346.             will *NOT* tolerate any mail, phone calls, etc. that
  347.             are whiney, nasty, or complaining from you. Constructive 
  348.             suggestions are always welcome.
  349.             
  350.             However, if you do register I will welcome any thoughts
  351.             about improving PreScan.
  352.             
  353.             Registration is truly a bargain at $21.00 US and brings
  354.             with it many benefits.  Some of which are notification of
  355.             free upgrades (downloadable from my system), a typeset,
  356.             printed manual, and the *now* available, multi-day
  357.             option (See appendix A and thanks Laughlin).  
  358.             None-the-less, it is still a bargain.  And I will 
  359.             appreciate it.
  360.             
  361.  
  362.  
  363. Page 8                                                               PreScan
  364.  
  365.     Registration Form:
  366.     
  367.     Name:____________________________________________________________
  368.     
  369.     Address:_________________________________________________________
  370.     
  371.     City:______________________________ State:______ Zip:____________
  372.     
  373.     Version of PreScan you have:_________________
  374.     
  375.  
  376.     Mail to:
  377.     
  378.     Jeff Hasz
  379.     5000 Carriage Way Drive
  380.     Suite 109
  381.     Rolling Meadows, IL  60008
  382.     
  383.     Thank you,
  384.     
  385.     Jeff Hasz.
  386.  
  387.  
  388. Page 9                                                               PreScan
  389.  
  390.  
  391.                              Appendix A
  392.  
  393.         This appendix is to describe some of the additional features
  394.         that you will receive with a registered copy of PreScan.
  395.         
  396.         The biggie feature that will be available to you will be the
  397.         ability of users to select a single day, combination of days 
  398.         or every day of the week to have the prescan packet made up
  399.         for them.  This also requires another file, which you will 
  400.         receive from me when I receive your registration.
  401.         
  402.         To illustrate:
  403.         
  404.         A user calls once a week and would like to get the mail for
  405.         the echos/conferences he reads for the whole week.  He simply
  406.         selects the day to perform the prescan on every week and 
  407.         PreScan will create his .QWK file on that day, to be ready
  408.         for when he calls.
  409.         
  410.         Other minor advantages are a typeset, printed manual and
  411.         notification of new versions (and other software that I 
  412.         might develop).
  413.         
  414.         Another benefit of registration is that you may be given 
  415.         the option of becoming a Beta test site for upgrades/new
  416.         software and you will get to see/have the new stuff first!
  417.         This is hightened by one of the rewards of Beta testing
  418.         which is a registered copy of the tested software, free, or
  419.         if you are already a registered user and are testing an up-
  420.         grade, a selection from our catalog (when we develop other
  421.         packages! ;-))
  422.         
  423.         Also, you will now you are supporting the development of 
  424.         new and timesaving software for your use at a reasonable 
  425.         cost.  (I'll appreciate it, too!)
  426.         
  427.         Thanks for your support of the shareware concept.
  428.         
  429.         Jeff Hasz
  430.         1:115/670  (fido)
  431.         
  432.  
  433.  
  434. Page 9                                                               PreScan
  435.  
  436.  
  437.                              Appendix B
  438.         
  439.     Features Summary:
  440.     
  441.         There are a number of features in this release of PreScan
  442.         that are not completely intuitive.  These include the
  443.         capability of running it locally and, in the registered
  444.         version, the ability to scan by indivdual days, as well as
  445.         daily.
  446.         
  447.         To run PreScan locally, from the command line type:
  448.         
  449.                 PRESCAN B0 <ENTER>
  450.                 
  451.         This will run PreScan in a stand alone mode locally.
  452.         
  453.         
  454.         To implement the individual scans (including daily), the 
  455.         PRESCAN.BAT file must be created in the same manner as the 
  456.         example given previously.  This will ensure that all the 
  457.         days are accounted for, and that after each individual days
  458.         worth of users packets have been created it will create 
  459.         those whose packets are "daily" packets.
  460.         
  461.         After the PRESCAN.BAT file has been created in this manner,
  462.         an event must be created that will exits with a specific
  463.         errorlevel.  This can be done in Front Door, Wildcat,
  464.         and many of the other mailers and BBS packages around.
  465.         
  466.         Call the PRESCAN.BAT file by calling it    from CAT.BAT (or 
  467.         other batch file) in the following manner:
  468.         
  469.         PRESCAN.BAT
  470.         
  471.         The PRESCAN.BAT file, if created correctly, will handle the 
  472.         rest.
  473.         
  474.