home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / KMAIL294.ZIP / KMAIL.DOC < prev    next >
Text File  |  1993-01-10  |  33KB  |  777 lines
  1.                        Kmail Version  2.94
  2.                          Copyright 1990
  3.                                by
  4.                            Ken Krueger
  5.  
  6.                          Twin  Peaks  BBS
  7.  
  8.                   (303)-651-0225 - Hayes Ultra 144
  9.  
  10. Specifications:
  11. ---------------
  12.  
  13.   Produces QWK compatible mail packets.
  14.   Supports up to 3000 conferences.
  15.   Reads CNAMES.@@@ to obtain conference information.
  16.   Reads TPA to obtain User information.
  17.   Updates USER file via USERS.SYS interface.
  18.   Resets "Mail Waiting" flags after a successful packet download.
  19.   Sets message 'has-been-read" flag after successful download.
  20.   Sets message-has-replies flag when appropriate.
  21.   Fully network compitable. Opens all files in share mode.
  22.   Locks message base during updating.
  23.   Message packets compatible with RNET.
  24.   Extended conference packets require RNET v1.07 or later.
  25.   Message packets tested with EZ-RDR v1.33 and SLMR v2.0.
  26.   Produces pre-scanned mail packets to save online time.
  27.   Limited file send services for Network hubs.
  28.   Sets the 'Have Mail Waiting' flags during message import.
  29.   BiModem protocol support including bi-directional mode.
  30.   HS/Link protocol support including bi-directional mode.
  31.   Supports FOSSIL interface.
  32.  
  33.  
  34. Evaluation
  35. ----------
  36.  
  37.   This evaluation  version of  Kmail is  provided so  that you  and your
  38. users may may decide  if this program meets  your needs.  Kmail  is 100%
  39. fully functional for the "sysop" in local mode.  The callers are limited
  40. to 10 messages per conference and to 50 total messages per packet.
  41.  
  42. In addition, you may call Twin Peaks and obtain a one time 60-day full
  43. function demo-key to help complete your evaluation. No fuss no muss,
  44. first time callers can obtain the demo-key.
  45.  
  46.  
  47. 60 Day Demo Key
  48. ---------------
  49.  
  50.   To obtain the 60 day demo key, just call Twin Peaks. Join conf #19
  51. open door 9 and follow the instructions.
  52.  
  53.   In order for the Demo-Key to work, the name you use to register on
  54. Twin Peaks MUST exactly match the name in record #1 of your USERS file.
  55.            ----
  56.  
  57. Requirements
  58. ------------
  59.  
  60.    Dos 3.1 or greater.
  61.    PCBoard 14.5 or 14.5a
  62.    DSZ     version 05/25/89 or later.
  63.    PKZIP   v1.10 or higher.
  64.    PK361   If you wish to support the ARC format.  (optional)
  65.    PUMA    If you wish to make it available.       (optional)
  66.    BiModem If you wish to support it.              (optional)
  67.    HS/Link If you wish to support it.              (optional)
  68.  
  69.  
  70. Communications Ports
  71. --------------------
  72.  
  73.     Channel        I/O Port        Interrupt
  74.       COM1           $3F8            4
  75.       COM2           $2F8            3
  76.       COM3           $3E8            4
  77.       COM4           $2E8            3
  78.       COM5           undefined
  79.       COM6           undefined
  80.       COM7           $2E8            5
  81.       COM8           $3E8            5
  82.  
  83.  
  84. Support for non-standard COM port configurations is provided by
  85. using DOS Set statements as shown below:
  86.  
  87.      SET COMBASE=nnnn   ;port base I/O address.
  88.      SET COMIRQ=n       ;port IRQ setting
  89.  
  90.            NOTE:  nnnn above is expressed as a decimal number!
  91.  
  92.  
  93. Installation for Single Node
  94. ----------------------------
  95.  
  96.       (Refer to NETWORK.DOC file for Multi-Node Installation)
  97.  
  98.    1. Create a KMAIL sub-directory to hold the Kmail distribution files.
  99.       Place all files in the archive into this directory.
  100.  
  101.    2. Create a work sub-directory such as C:\KWORK for Kmail to use.
  102.       ***CAUTION***  ***CAUTION***     All files are erased in this
  103.       directory during the mail packet creation process. DO NOT use an
  104.       existing directory that has good stuff in it!  Multi-node systems
  105.       must have a unique work area for each node.
  106.  
  107.    3. Customize the KMAIL.CFG file. Ample comments are in the sample.
  108.       This is where you really customize the overall operation.
  109.       Parms 1-4 are passed along to the mail readers for their use.
  110.       While not critical, you should keep to the general outline in
  111.       the sample and customize them for your system.
  112.  
  113.  ==>  PARM 5: This one is important! This parm specifies the name of
  114.       the QWK mail packet that Kmail will create. While the name can be
  115.       anything, it would be best to have a name that is associated
  116.       with your BBS system name. (Do not specify a .extension here).
  117.  
  118.       The rest of the parms are optional. Among them are options to
  119.       control the number of messages based on connect speed, and
  120.       protocol transfer options. The default values are in the sample.
  121.  
  122.       DSZ is used as the main protocol and is activated via a call
  123.       to a BAT file which you may define in the KMAIL.CFG file. This
  124.       allows you to totally customize the DSZ parms to suit your
  125.       system. I just let it default to the standard PCBxx.BAT files
  126.       that I have setup for PCBoard. Be sure to include the BAT files
  127.       location in your DOS path! Kmail passes parms %1-%5 to the
  128.       BAT files just the same as PCBoard.
  129.  
  130.  
  131.       When a caller requests ╔════════════════════════════════════════╗
  132.       an external protocol,  ║       External Protocol Parameters     ║
  133.       PCBoard passes several ╠═════════╦══════════════════════════════╣
  134.       parameters to the      ║Parameter║         n9scription          ║
  135.       protocol batch file.   ╠═════════╬══════════════════════════════╣
  136.       These parameters are   ║   %1    ║COM Port Number.              ║
  137.       listed to the right.   ╟─────────╫──────────────────────────────╢
  138.                              ║   %2    ║PC to Modem Speed (DTE rate)  ║
  139.                              ╟─────────╫──────────────────────────────╢
  140.                              ║   %3    ║Filename to transfer.         ║
  141.                              ╟─────────╫──────────────────────────────╢
  142.                            * ║   %4    ║Connect Speed shown by PCBoard║
  143.                              ╟─────────╫──────────────────────────────╢
  144.                              ║   %5    ║Carrier Speed.                ║
  145.                              ╟─────────╫──────────────────────────────╢
  146.                              ║   %6    ║Upload Dir Path for BiModem   ║
  147.                              ║         ║and HS/Link type protocols.   ║
  148.                              ╚═════════╩══════════════════════════════╝
  149.  
  150.       * The %4 field is not easily determined within Kmail, therefore
  151.         upon exit to the protocol BAT files, Kmail adjusts the %4
  152.         field to the same value as %5.
  153.  
  154.       I have found the following works well with my Hayes 9600 v.42.
  155.  
  156.         PCBSZ.BAT
  157.               dsz ha bo est 0 %5 pB4096 sz -m %3
  158.  
  159.         PCBRZ.BAT
  160.               dsz ha slow est 0 %5 pB4096 z pr1 rz -m -p %3
  161.  
  162.  
  163.    4. Customize the KMAIL.CNF if necessary. This is a 2 or 3 line file.
  164.       The 1st line defines the interface routine that Kmail should
  165.       use, and the 2nd line defines the location of a work directory.
  166.       The 3rd line is optional and is needed only if you plan to
  167.       pre-scan mail packets for your callers.
  168.  
  169.       Line #1 should specify either INTERRUPT or FOSSIL.
  170.  
  171.         INTERRUPT  - Use this for standard COMx communication.
  172.         FOSSIL     - Use this for connunication with FOSSIL drivers.
  173.  
  174.       Line #2 is the path\name of a scratch work directory. If the
  175.       sub-directory does not exist, it will be created. The name may
  176.       be anything. I use the name KWORK on my system.
  177.  
  178.       Line #3 is optional. If the pre-zip function (explained later) is
  179.       used, this line points to the holding sub-directory. It may be
  180.       any name, but I recommend something like KHOLD. Multi-node
  181.       systems MUST share the same KHOLD sub-directory in order for
  182.       pre-zip packets to be located from any node.
  183.  
  184.  
  185.         Sample KMAIL.CNF
  186.  
  187.         INTERRUPT       Line 1
  188.         C:\KWORK        Line 2  <-- Must be unique for each node!
  189.         D:\KHOLD        Line 3  <-- This is where pre-scanned mail
  190.                                     packets are stored. A common
  191.                                     directory shared by ALL nodes.
  192.  
  193.   ********************************************************************
  194.   **  Warning   **  Warning  **  Warning  **  Warning  **  Warning  **
  195.   ********************************************************************
  196.   *                                                                  *
  197.   *   ALL FILES ARE ERASED IN THE KWORK DIRECTORY DURING PROCESSING. *
  198.   *   MAKE SURE THE AREA YOU SPECIFY IS A SCRATCH AREA!              *
  199.   *                                                                  *
  200.   ********************************************************************
  201.   **  Warning   **  Warning  **  Warning  **  Warning  **  Warning  **
  202.   ********************************************************************
  203.  
  204.  
  205.    5. Create the BAT file to run the Kmail door. Kmail requires two
  206.       parameters when it is called. The 1st parameter specifies the
  207.       name of the CONFIG file. The 2nd parameter specifies the
  208.       the drive and path to your PCBoard main directory where the
  209.       PCBOARD.DAT file is located.
  210.  
  211.       Echo off
  212.       SET KMAIL=
  213.       CD\Kmail
  214.       KMAIL KMAIL.CNF C:\PCB
  215.       C:
  216.       CD\PCB
  217.       Board
  218.  
  219.  
  220.    6. Add an entry in your DOORS.LST files for Kmail. Indicate that
  221.       a USERS.SYS *SHOULD* be created and that a DOOR.SYS should not
  222.       be created when Kmail is executed.
  223.  
  224.    7. Using PCBSM, select "User Info File Maintenance" and create
  225.       a KMAIL Third Party Application entry with the following info.
  226.  
  227.       Version      :    30
  228.       Static Size  :    18
  229.       Dynamic Size :     1
  230.       Keyword      : KMAIL    <---- Watch this one! See notes below.
  231.  
  232.       NOTE: The keyword parameter above must match the name of the BAT
  233.             file that is used to open the Kmail door. So, if the name
  234.             of your BAT file is something else, change the keyword
  235.             parameter accordingly.
  236.  
  237.       NOTE: If you will be using the PreZip function, then the Keyword
  238.             *must* be KMAIL.     (PreZip is explained later).
  239.  
  240.    8. Kmail will use the DOS Environment variable "COMSPEC=" to locate
  241.       COMMAND.COM in order to execute the archive and communications
  242.       programs. The location of the archive and communication programs
  243.       must also be included in your DOS path.
  244.  
  245.    9. Network Qnet Status:
  246.  
  247.       If your system will be acting as a HUB for other systems, then
  248.       you will need to create a QNET.DAT file to control the Qnet status
  249.       of the downline systems. The QNET.DAT file is a plain ordinary
  250.       text file which contains the names of the downline sysops whom
  251.       you wish to grant Qnet status. One name per line starting in
  252.       column 1 and EXACTLY 1 space between the first and last name.
  253.       Mixed case is ok. The QNET.DAT file should be placed in the
  254.       Kmail sub-directory. Qnet status permits a user to upload mail
  255.       on behalf of another person. Without Qnet status, a user is limited
  256.       to uploading only their own personal mail.
  257.  
  258.       (* ----------------------------------------------------------- *)
  259.       (* The sequence of names should NEVER be changed and new names *)
  260.       (* must only be added to the end of the file. If you need to   *)
  261.       (* remove a person from the list, then just XXX their name out *)
  262.       (* leaving the XXX's as a placeholder.                         *)
  263.       (* ----------------------------------------------------------- *)
  264.  
  265.       NOTE: I apologize for the shoddyness of this procedure. I am
  266.             working on a PCBsm type utility to handle this function.
  267.             It is high on the priority list and expect to have something
  268.             around the middle of 1991.
  269.  
  270.       The letter 'Q' is displayed on the conference selection screen
  271.       beside each conference to indicate Qnet status.
  272.  
  273.       If you have one or more conferences that you do not want echoed
  274.       to downline systems, setting the conference echo-flag to NO will
  275.       disable Qnet status for that conference. Messages can still be
  276.       downloaded for offline reading via a RDR, but cannot be merged
  277.       into the system message base.
  278.  
  279.   10. PRE-ZIP'ed mail packets.
  280.  
  281.       This function allows you to scan and zip a mail packet for a
  282.       user so that it is ready for download when the user calls in.
  283.       This is an especially usefull function for LD callers.
  284.  
  285.       You will need to create a sub-directory to serve as a holding
  286.       area for the pre-zipped packets. The location of the holding
  287.       directory is specified in the Kmail.cnf file as shown in step
  288.       (5) above. Multi-node systems may share the same holding area.
  289.  
  290.       A PREZIP.DAT file must be created in the Kmail sub-directory
  291.       which lists each sysop's name and assigns a unique sequence
  292.       number to each name. The sequence numbers are used to match up
  293.       a pre-zip packet with the proper caller and are not associated
  294.       with any other function in Kmail. Pre-zip packets will be
  295.       stored in the KHOLD directory until downloaded by the caller.
  296.       The users "MSG Pointers" are also stored in the KHOLD directory
  297.       and are posted to the users record upon successful downloading
  298.       of the pre-zip packet.
  299.  
  300. Note: The following format must be *STRICTLY* adheared to. The
  301.       name begins in column #1 and must not exceed 25 characters.
  302.       A comma MUST separate the name and it's following sequence
  303.       number. All names must have a three digit sequence number
  304.       following the name, leading zeros REQUIRED!  Mixed case is
  305.       allowed in the name. No two users should have the same number!
  306.  
  307.    Sample: PREZIP.DAT
  308.  
  309.       George Washington,026
  310.       John Smith,015
  311.       Bob Jones,009
  312.  
  313.  
  314.       I would suggest a SET Kmail= in your door bat file to insure
  315.       that PREZIP is never active for an online caller.
  316.  
  317.       Prezip processing is activated via a Kmail=PREZIP DOS environment
  318.       variable. The following is suggested in your event.sys file.
  319.  
  320.       Basically, the process is to make a call to PCB145 to build a
  321.       USERS.SYS followed by a call to Kmail to create the packet.
  322.  
  323.       Important! The use of : and ; at the appropriate places in the
  324.                  PCB145 command line is critical!!!
  325.  
  326.          Ex:  PCB145 /USERSYS;JOHN;SMITH;PWRD:12345;TPA:KMAIL
  327.                                                         ^^^^^
  328.       Carefull, this parm must match the bat file name.   |
  329.       ____________________________________________________|
  330.  
  331.       EVENT.SYS
  332.       ...
  333.       ...
  334.       Set Kmail=PREZIP              <===== (note CAPS)
  335.       cd\pcb
  336.       PCB145 /USERSYS;JOHN;SMITH;PWRD:12345;TPA:KMAIL
  337.       cd\Kmail
  338.       Kmail KMAIL.CNF C:\PCB LOCAL
  339.       cd\pcb
  340.       PCB145 /USERSYS;JOE;DOAKS;PWRD:FOOBAR;TPA:KMAIL
  341.       cd\Kmail
  342.       Kmail KMAIL.CNF C:\PCB LOCAL
  343.       If Exist USERS.SYS Del USERS.SYS
  344.       Set Kmail=                 <===== Important!! I suggest you also
  345.       ...                               include this line in your Kmail
  346.       ...                               door BAT file(s).
  347.       event continues.....
  348.  
  349.  
  350.   11. The installation of Kmail is now complete and you are ready to
  351.       begin initial testing as soon as everything is backed up!!!
  352.  
  353.  
  354.   12. Insure that the locations of DSZ and PKZxxx programs are defined
  355.       in your DOS path. Kmail will be unable to locate them if they
  356.       are not in the Dos path!
  357.  
  358.  
  359.     **** NOTE WELL **** NOTE WELL **** NOTE WELL **** NOTE WELL ****
  360.     **** NOTE WELL **** NOTE WELL **** NOTE WELL **** NOTE WELL ****
  361.     **** NOTE WELL **** NOTE WELL **** NOTE WELL **** NOTE WELL ****
  362.  
  363.   Obviously a  mail door  must update  the USERS  file to  store message
  364. pointers.  Please make sure your USERS file is backed up before  running
  365. Kmail.  There has  been one report of  trashed message pointers.   I was
  366. unable to track down the cause of the problem and it has not re-occured.
  367.  
  368.   Do not fall  into the trap  of making an  automatic backup each  night
  369. during  your  event  if  you  are  simply overlaying the previous nights
  370. backup.  If  a problem did  occur and you  did not catch  it for several
  371. days, you wouldn't have a valid backup copy.  I suggest that you keep  a
  372. minimum of seven grandfather copies of  your USERS file and each one  of
  373. them should be unique.
  374.  
  375.  
  376. Conferences
  377. -----------
  378.  
  379.   Kmail obtains all conference  related information from the  CNAMES.@@@
  380. file including  such items  as MSG  base location,  required security to
  381. join, and bulletins path/location.
  382.  
  383.   If  a  user  does  not  have  the  required  security  level to join a
  384. conference,  the  conference  will  be  listed  as <closed> on the Kmail
  385. conference selection menu.
  386.  
  387.   If you need to  delete a conference for  any reason, just insure  that
  388. the conference  name is  blanked out  using PCBsetup  and Kmail will not
  389. attempt to  process it.   It  will show  up as  *Empty* on the selection
  390. menu. Remember to do a global delete of the registered and scan flags!
  391.  
  392.  
  393. Private (R/O) Messages
  394. ----------------------
  395.  
  396.   Kmail will validate the caller  security level and compare it  against
  397. the appropriate values specified in  PCBsetup to determine if access  to
  398. to private messages including comments to sysop are allowed.  Conference
  399. Sysop status  is also  checked.   As with  PCBoard, you  may give global
  400. access to private messages by assigning a high enough security, or on  a
  401. conference by conference basis by assigning conference-sysop status.
  402.  
  403.  
  404. Qnet_Private=No/Yes    (Default=No)
  405. -------------------
  406.  
  407.   If you wish to allow  Network-Sysop's the ability to download  private
  408. mail without having to alter security levels, you can do this be putting
  409. the parameter Qnet_Private=Yes in the Kmail.CFG file.  However, R/O msgs
  410. that do not have  the "Echo" flag set,  will not be sent.   In addition,
  411. the same rule  applies to the  conference "Echo-flag" status.   In other
  412. words, for a R/O message to qualify using the Qnet_Private= option, both
  413. the conference Echo flag  AND the individual msg  Echo flag must be  set
  414. on.  Comments to Sysop are not included with this option.
  415.  
  416.  
  417. Ignore_Echo=No/Yes     (Default=No)
  418. ------------------
  419.  
  420.   This option only has meaning if you will be operating as a network hub
  421. with downline nodes receiving mail from  you.  When you enable a  caller
  422. for network-status, that status  only applies to conferences  defined as
  423. "echo" conferences  in pcbsetup.   Besides  "main", you  may have one or
  424. more local conferences on  your system.  If  you wish to allow  downline
  425. nodes  to  echo  your  local  conferences  including main, then set this
  426. option to Yes.
  427.  
  428.  
  429. Mail_Waiting=Yes/No    (Default=Yes)
  430.  
  431.   Use this option to control  whether Kmail will set the  "Mail Waiting"
  432. indicator during message importing.   With this option  enabled, callers
  433. will be notified  of waiting mail  in the various  conferences when they
  434. logon.  This  option will slowdown  the upload process  depending on how
  435. large of a users file you have.  This option causes Kmail to update your
  436. USERS and USERS.INF files, KEEP GOOD BACKUP'S of these files!!!
  437.  
  438.  
  439. Zip_Opt=xxx      (Internal Default - Zip_Opt=-a)
  440. -----------
  441.  
  442.   If for some reason you  need/want Kmail to use unique  Zip parameters,
  443. you may specify them using this option.
  444.  
  445.  
  446. UnZip_Opt=xxx      (Internal Default - UnZip_Opt=-e)
  447. -------------
  448.  
  449.   If for some reason you need/want Kmail to use unique UnZip parameters,
  450. you may specify them using this option.
  451.  
  452.  
  453. Qwk_Dir=path       (Default=None)
  454. Rep_Dir=path       (Default=None)
  455. ------------
  456.  
  457.   If you plan to use Kmail in local mode to capture mail to use with  an
  458. offline RDR, use these parameters  to specify the locations where  Kmail
  459. should place the QWK packet and  where to retrieve the REP file.   These
  460. options are  only for  the convenience  of the  Sysop when  operating in
  461. local mode.   A  DOS copy  command is  issued to  copy the .QWK and .REP
  462. files to/from these directories.
  463.  
  464.  
  465. Scan_Upld_Only=Yes/No   (Default=Yes)
  466. ---------------------
  467.  
  468.   This  option  controls  whether  just  the  upload  directory  or  ALL
  469. directories are scanned when the caller  selects the new file scan.   If
  470. you keep new files in the upload directories for several days/weeks then
  471. setting this option to  YES would be the  best choice.  However,  if you
  472. move new files out of the upload area rather quickly or perhaps have the
  473. "make all uploads private" switch enabled in PCB, then you will need  to
  474. specify NO for this option to prevent callers from missing new files.
  475.  
  476.   The scanning of new  files is limited to  the conference in which  the
  477. door was opened.  Private upload directories are NEVER scanned.
  478.  
  479.  
  480. Tag=
  481. ----
  482.  
  483.   KMail will append a  tag line to messages uploaded via the KMail door.
  484. You may customize the tag information to refelect your bbs info by using
  485. a TAG= parm in the CFG file. Example: Tag=Home of Super BBS
  486.  
  487. The tag information may be up to 60 characters long.
  488.  
  489.  
  490. Disable_Tag=Yes/No      (Default=No)
  491. ------------------
  492.  
  493.   This option may be used to completely disable the adding of TAG lines
  494. to uploaded messages should the need arrise to do so. This option is
  495. ignored in non-registered versions.
  496.  
  497.  
  498. Force_Tag=Yes/No         (Default=No)
  499. ----------------
  500.  
  501.   The tag  information is  normally appended  only on  messages uploaded
  502. into an Echo conference.  Set this option to Yes if you wish to have tag
  503. lines appended to messages in non-echo conferences (including Main).
  504.  
  505.  
  506. Disable_Goodbye=Yes/No   (Default=No)
  507. ----------------------
  508.  
  509.   In the event that you have special processing requirements and  prefer
  510. that callers not logoff directly from KMail, this option is provided  to
  511. disable the (G) command.  When enabled, this option will cause KMail  to
  512. translate all forms of the (G) command into a Quit command.  Upon return
  513. to PCBoard a  PCBSTUFF.KBD file will  be created which  contains a (BYE)
  514. command to log the caller off.  Only systems that are configured to Drop
  515. to Dos after each caller would need this option enabled.
  516.  
  517.  
  518. Disable=nn               (Default=15)
  519. ----------
  520.  
  521.   Use this option  to disable KMail  downloads 'nn' minutes  before your
  522. scheduled system event.  This is used to prevent a user from starting  a
  523. large download and running past the event start time.  Values from  0-60
  524. are accepted here.
  525.  
  526.  
  527. HS/Link and BiModem
  528. -------------------
  529.  
  530.   HS/Link and BiModem are fully supported in bi-directional mode. Obtain
  531. the bulletin from Salt Air for details on installing BiModem. HS/Link is
  532. easily installed with the documentation that comes with it. The standard
  533. PCBxx batch files you setup for these protocols should work just fine
  534. with Kmail.
  535.  
  536.  
  537. KMail Help
  538. ----------
  539.  
  540.   Insure that the file "KMHELP" is placed in the \KMAIL directory.  This
  541. file provides the online help function while in the door.  The help file
  542. can be modified, if nessary, to suit unique environments, but I  suggest
  543. that you don't alter it too much.
  544.  
  545.  
  546. Multi-Lingual Text Files
  547. ------------------------
  548.  
  549.   There is  currently limited  support for  Multi-Lingual files although
  550. the  main  menu  is  not  currently  included.   The following files are
  551. supported.   Just customize  the files  as necessary  and add the proper
  552. language extension.  The files must reside in the KMail directory  along
  553. with the English versions.  Please note that the English versions do not
  554. have an extension.
  555.  
  556.      NEWUSER    (Displayed to first time users)
  557.      KMHELP     (The online help information)
  558.      PNTMSG     (Displayed when user uploads their .PNT
  559.                  file to reset their message pointers)
  560.  
  561.  
  562. SCRIPT0 File
  563. ------------
  564.  
  565.   KMail checks the location specified in PCBSetup for the SCRIPT0  file.
  566. If a SCRIPT0 file is found it  is sent in the mail packet.   The various
  567. rdr's will display the SCRIPT0 file at the end of the rdr session.
  568.  
  569.  
  570. NEWUSER File
  571. ------------
  572.  
  573.   Included in the archive is a  file called NEWUSER, which is a  replica
  574. of the opening display presented to a first time user.  If this new user
  575. screen is satisfactory, you need do nothing.  However, should you desire
  576. to create your own customized message, just edit the sample NEWUSER file
  577. and place it  in the Kmail  directory and Kmail  will display it  rather
  578. than the hard coded text within the program.
  579.  
  580.  
  581. KMAIL.KEY
  582. ---------
  583.  
  584.   This information applies to registered users of KMail that are running
  585. multi-node systems.   If  the BBS  name (as  specified in  PSCsetup) has
  586. different text for each  node, you will need  a KEY file for  each node.
  587. KMail will first check to see  if a KMAIL.KEY exists, and will  use that
  588. if one exists.  If a KMAIL.KEY is not found, then the node # is appended
  589. to the name  and another attempt  is made to  process the KEY  file.  In
  590. other words, Node 1 would look for KMAIL1.KEY and Node 2 would look  for
  591. KMAIL2.KEY and so on.  This approach  will allow you to have all of  the
  592. KEY files in a single directory if you choose to do so.  Of course,  you
  593. still could have a KMAIL.KEY in a unique directory for each node too.
  594.  
  595. NOTE: If at any time  it appears that  your KMAIL.KEY is not functioning
  596.       properly, enter the  character "&" at the  main Kmail  menu screen
  597.       and the  data from the  key will be  displayed  on the terminal to
  598.       assist in the diagnosis of the problem.
  599.  
  600.  
  601. SYSFILE.DAT
  602. -----------
  603.  
  604.   This data file is used to control the sending of data files to network
  605. sysops.  To activate this option, create a SYSFILE.DAT file in the KMail
  606. directory and specify the complete Drive:\Path\Name.ext of the files you
  607. wish to be automatically included within the QWK packet.  The file dates
  608. are checked and  only those with  dates more recent  than the last  file
  609. transmitted are sent.   You may  list up to  24 files, one  FileName per
  610. line starting in column one.  The files will be zipped into  SYSFILE.ZIP
  611. and included in the QWK packet as appropriate.
  612.  
  613.  
  614. Extended Services
  615. -----------------
  616.  
  617.   You can create up to 8 catagories of file services numbered (0-7) that
  618. a user  may subscribe  to.   Files within  the selected  service will be
  619. included in the QWK mail packet.  To implement this function you need to
  620. create a SERVICES.LST file in the KMail subdirectory.  The  SERVICES.LST
  621. file contains a description of each available service.  For each service
  622. create a matching  SERVICEx.DAT file where  x coorsponds to  the service
  623. number.  The SERVICEx.DAT file(s) contains the full drive:\path\name  of
  624. each file contained  in the service  catagory, samples are  shown below.
  625. The SERVICES.LST file is also used as the menu screen when the caller is
  626. selecting their desired services.
  627.  
  628.  
  629.      SERVICES.LST
  630.      ------------
  631.  
  632.      Network News         <== SERVICE0
  633.      BBS Help/Tips        <== SERVICE1
  634.      Conference Listing   <== SERVICE2
  635.  
  636.  
  637.      SERVICE0.DAT               SERVICE1.DAT
  638.      ------------               ------------
  639.      C:\FILES\NET.DOC           E:\SOMEDIR\BBS.HLP
  640.      C:\FILES\NETSTAT.TXT       D:\PCB\HELP\TIPS.TXT
  641.                                 G:\STUFF\MODEM.DOC
  642.  
  643.  
  644.   The above is intended  to show the amount  of flexibility you have  in
  645. creating the various  services.  You  probably will want  to be somewhat
  646. more organized than the example.
  647.  
  648.  
  649.  
  650. Getting Started
  651. ---------------
  652.  
  653.   Finally it's time to run Kmail.   Just login to the BBS in the  normal
  654. way and open  Kmail door.   As a first  time user, you  will be asked to
  655. answer some  configuration questions  as will  each user  when they  try
  656. Kmail the first time.  A  special feature in Kmail will detect  when the
  657. "sysop" is in local mode and  will issue a prompt asking where  to place
  658. the resulting QWK mail  packet.  You should  respond with the drive  and
  659. path, but WITHOUT the  trailing back-slash after the  name.  Use of  the
  660.  
  661. NOTE: Use of  the Loc_Dir option described above prevents having to type
  662.       this information each time you use the door.
  663.  
  664.        c:\temp     \      All of these are valid ways to specify the
  665.        d:\rdr       >--   location of where to place the QWK  packet
  666.        a:          /      when running in local mode.
  667.  
  668.   Later on when you are ready to upload any replies created with one  of
  669. the offline readers, Kmail will ask  where to obtain the REP file.   Use
  670. the same format as above to specify the location.
  671.  
  672.  
  673. Errors
  674. ------
  675.  
  676.   Any errors detected by kmail  including those from 3rd party  programs
  677. such as PKZip  and DSZ are  logged into a  file called $door.err  in the
  678. Kmail sub-directory.  In addition,  many of the errors are  also written
  679. to the  caller log  file.   Error information  is also  displayed to the
  680. callers.
  681.  
  682.  
  683. Notes and Misc Info
  684. -------------------
  685.  
  686.   Kmail  sends  a  bbsid.PNT  file  in  each  mail packet.  The PNT file
  687. contains the last-read message pointer for each conference that the user
  688. has selected.  In the event of a problem, a user may upload the PNT file
  689. to restore the message pointers.   Just extract the KMAIL.PNT  file from
  690. the QWK packet and upload it to Kmail using the 'P' menu option.
  691.  
  692.   The user may select/un-select  conferences and reset message  pointers
  693. by using the  appropriate options in  EZ-RDR.  Review  the documentation
  694. associated  with  EZ-RDR  for  additional  information.   When resetting
  695. message pointers, Kmail will accept an absolute message # or a  negative
  696. number such  as -25  which means  set the  message pointer  equal to  25
  697. messages from the end of the message base.
  698.  
  699.   Not yet documented on the menu screen is the ability to stack commands
  700. for the  download process.   The  command 'D  Y' will  download the mail
  701. packet and return you to the menu screen, while 'D G' will download  and
  702. log you off.  A 10 second timer is provided to allow you to change  your
  703. mind.  By using  stacked commands, the user  can avoid the question  "Do
  704. you wish to receive this packet?"
  705.  
  706.   Recent changes to PCBoard allow for passing command line parms to door
  707. programs. Kmail now takes advantage of this feature. Assuming  Kmail was
  708. installed as door #3, the following commands would be valid.
  709.  
  710.          Open 3 d       (open the door & start download scan)
  711.          Open 3 d y     (open the door, scan mail, yes to download)
  712.          Open 3 d g     (open the door, scan mail, download & goodbye)
  713.         Kmail d y       (open the door, scan mail, yes to download)
  714.         Kmail d y g     (open the door, scan mail, download, goodbye).
  715.  
  716.  
  717.   The following SET commands may be used to adjust the operation
  718.   of Kmail as appropriate.
  719.  
  720. SET PRODEBUG=ON
  721.      Enables total session logging to the file DEBUG.OUT.  Use this to
  722.      record door activity for later review.
  723.  
  724. SET OVCRT=ON
  725.      This environment enables a special CRT update mode that works best
  726.      with TaskView or OmniView systems.
  727.  
  728. SET CAPFILE=filename
  729.      This setting controls the name of the file generated by the ALT-F
  730.      (file out) and SET PRODEBUG=ON functions.  The default file name of
  731.      DEBUGxx.OUT is changed to the specified name.
  732.  
  733. SET COMSPEC=C:\COMMAND.COM
  734.     This environment variable specifies the location and name of your
  735.     current COMMAND.COM and is required if the location of COMMAND.COM
  736.     is not in the current DOS Path.
  737.  
  738. SET PATH=C:\DOS;C:\UTIL;C:\...
  739.      The PATH environment variable is used to locate many of the programs
  740.      called up by KMail.  Please insure  that your  archive utilities and
  741.      protocol driver programs are present in a directory listed in your
  742.      PATH environment.
  743.  
  744. In The Works
  745. ------------
  746.  
  747. Utility to handle Qnet status and view/change user options.
  748.  
  749.  
  750. Acknowledgements
  751. ----------------
  752.  
  753. Special thanks to Bill Walsh, whose system I crashed many times during
  754. early beta testing, and to Jeff Freeman whose eagle eye caught many
  755. potential problems, and to Ken Flower for testing >256 conferences.
  756. And thanks to the many others who played a part in the beta testing
  757. development of Kmail.
  758.  
  759.  
  760. Registration
  761. ------------
  762.  
  763.   Please see the file REGISTER.TXT for registration information.
  764.  
  765.   After receipt of your registration, you  will need to call my BBS  and
  766. obtain a customized KEY file, which will enable any and all features not
  767. available  in  the  evaluation  copy  of  Kmail.    Currently,  the only
  768. limitation is the number of messages allowed per mail packet.
  769.  
  770.   After obtaining your customized KMAIL.KEY file, just place it in  your
  771. KMAIL sub-directory to activate all features.
  772.  
  773.  
  774.                                  Ken Krueger
  775.                                  Twin Peak's BBS
  776.                     303-651-0225 - Hayes Ultra 9600 96 v.32 / v.42bis
  777.