home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / LAKOTA.ZIP / LAKOTA.DOC < prev    next >
Text File  |  1993-09-04  |  19KB  |  440 lines
  1.  
  2.                                LAKOTA
  3.                         SPITFIRE MAIL SYSTEM
  4.                             Version 1.1f
  5.                   Copyright (C) by Mike Woltz, 1993
  6.                         Buffalo Creek Software
  7.  
  8.  
  9.     INTRODUCTION
  10.     ------------
  11.  
  12.        LAKOTA is a companion utility designed to work with the SPITFIRE
  13.     Bulletin Board System.  SPITFIRE Version 3.3 or greater offers an
  14.     option from the Message Menu called LAKOTA (QWK Mail System).  When 
  15.     a caller selects this option, SPITFIRE shells to LAKOTA.COM.  LAKOTA
  16.     allows the caller to extract messages for download and to upload
  17.     reply packets, inserting the caller's messages into the SPITFIRE
  18.     message base.  LAKOTA is written in Assembler which contributes to 
  19.     its speed and compact file size.
  20.     
  21.  
  22.     USAGE
  23.     -----
  24.  
  25.        LAKOTA.COM must reside in the SPITFIRE home directory.  LAKOTA
  26.     uses Phil Katz's PKZIP, PKUNZIP and Chuck Forsberg's DSZ.  These
  27.     files must reside in a directory that is located in your path statement
  28.     or in your SPITFIRE home directory.  For more information on defining
  29.     file paths refer to your DOS documentation.  Versions of PKZIP newer
  30.     than version 1.10 require a tremendous amount more memory than did
  31.     PKZIP version 1.10.  In the event you discover that there is not
  32.     enough memory available to utilize a version of PKZIP newer than version
  33.     1.10 then simply place a copy of PKZIP.EXE (v1.10) in your SPITFIRE
  34.     HOME directory.  LAKOTA will then use the copy of PKZIP in the SPITFIRE
  35.     HOME directory before looking through your PATH to find it.
  36.  
  37.        Upon selecting <L>.... LAKOTA (QWK Mail System) option from the 
  38.     Message Menu of SPITFIRE, SPITFIRE shells to LAKOTA and the following 
  39.     menu is displayed:
  40.     
  41.     ╔═════[ WELCOME TO SPITFIRE'S MAIL SYSTEM]════╗
  42.     ║            LAKOTA Version 1.1f              ║
  43.     ║           Buffalo Creek Software            ║
  44.     ║      Copyright (C) by Mike Woltz, 1993      ║
  45.     ║     Utilizing QWK Message Packet Format     ║
  46.     ╚═════════════════════════════════════════════╝
  47.     <D>............. Download Messages (QWK Format)
  48.     <U>............... Upload Messages (QWK Format)
  49.     <S>............. Set Last Read Message Pointers
  50.     <Q>....................................... Quit
  51.     
  52.     LAKOTA MAIN MENU - [D U S Q]?
  53.     
  54.  
  55.     CONFIGURATION
  56.     -------------
  57.     
  58.        When LAKOTA is first installed on your BBS, it must be configured
  59.     for your system.  To configure LAKOTA, log on to the BBS locally and
  60.     select <L>...LAKOTA (QWK Mail System) from the Message Menu.  LAKOTA 
  61.     will provide a series of prompts.  The information you enter in
  62.     response to these prompts is used to create the configuration file.
  63.     
  64.        The configuration prompts Lakota will present include:
  65.        
  66.     Enter the name of your BBS:
  67.        Simply respond by entering the name of your BBS.
  68.  
  69.     Enter your city & state/province:
  70.        Respond with the city and state/province where your BBS is located.
  71.        
  72.     Enter your BBS phone number:
  73.        Key in the phone number to your BBS, including area code.
  74.  
  75.     Enter the name of the Sysop of your BBS:
  76.        Normally you will want to respond by entering your name, followed
  77.        by a comma and then the word Sysop.  (See example below.)
  78.  
  79.     Enter QWK BBS identification name:
  80.        Respond with the name which will be used to identify your BBS.  This 
  81.        is a single word of up to eight characters and is used to identify
  82.        your BBS in QWK mail exchanges.
  83.  
  84.        A sample configuration for Buffalo Creek's BBS would look like this:
  85.  
  86.     Enter the name of your BBS: Buffalo Creek's BBS
  87.     Enter your city & state/province: West Des Moines, Iowa
  88.     Enter your BBS phone number: 515-225-8496
  89.     Enter the name of the Sysop of your BBS: Mike Woltz, Sysop
  90.     Enter QWK BBS identification name: BUFFALO
  91.  
  92.  
  93.     UNDOCUMENTED SPITFIRE FEATURE
  94.     -----------------------------
  95.  
  96.        SPITFIRE supports an undocumented feature related to LAKOTA. 
  97.     Immediately before SPITFIRE shells to LAKOTA, a display named
  98.     LAKOTA.BBS/CLR will be displayed if SPITFIRE finds such file in
  99.     your DISPLAY directory.  The purpose of this display file is to
  100.     provide your callers with information regarding LAKOTA which you
  101.     may feel is important.  You will find both LAKOTA.BBS and LAKOTA.CLR
  102.     included in this package.  In the event you wish to use these
  103.     display files, you will simply have to copy them into your DISPLAY
  104.     directory.
  105.  
  106.  
  107.     DOWNLOADING MESSAGES
  108.     --------------------
  109.     
  110.        When a caller elects to download messages using the LAKOTA (QWK
  111.     Mail System) option, a check is made to determine if the available disk
  112.     space is sufficient.  (The disk space available on the BBS must be equal
  113.     to or greater than that which the Sysop has configured using SPITFIRE's
  114.     (ALT+Z) Upload Disk Space Requirement.)  In the event the amount of 
  115.     available disk space is inadequate, LAKOTA displays the message:
  116.     
  117.      "Sorry but there is not enough disk space!"
  118.     
  119.     Otherwise the following menu is displayed:
  120.     
  121.     >>>> Download Message Menu <<<<
  122.     <N>................New Messages
  123.     <T>......................To You
  124.     <Q>........................Quit        
  125.  
  126.     DOWNLOAD MENU - [N T Q]?
  127.  
  128.        "New Messages" are messages newer than the message pointed to by
  129.     the last read message pointer for each Message Conference.
  130.    
  131.       "To You" are messages specifically addressed to the caller.
  132.   
  133.        "Quit" will return the caller to LAKOTA's Main Menu.
  134.        
  135.        Once the caller has selected the option of New Messages or To You,
  136.     a second menu is presented.  The Message Conference Menu allows the 
  137.     caller to further define which messages will be extracted by selecting
  138.     which conferences are to be included in the download packet.
  139.     
  140.     >>>> Message Conference Menu <<<<
  141.     <A>...............All Conferences
  142.     <B>...........Select A Conference
  143.     <C>.......Your Queued Conferences
  144.     <Q>..........................Quit
  145.  
  146.     CONFERENCE MENU - [A S Y Q]?
  147.  
  148.     All Conferences -  Will extract messages from all available message 
  149.     conferences (those to which the caller has security to access) according
  150.     to the previously selected criteria (New Messages/To You).
  151.     
  152.     Select A Conference - Will prompt the caller to enter the number
  153.     of the message conference from which messages will be extracted
  154.     according to the previously selected criteria (New Messages/To You).
  155.     
  156.     Your Queued Conferences - Will extract messages according to the
  157.     previously selected criteria (New Messages/To You) from all message
  158.     conferences in the caller's queue.
  159.  
  160.     Quit - Returns the caller to LAKOTA's Main Menu.
  161.     
  162.        If the caller has Sysop Security, LAKOTA will then prompt the
  163.     caller with:
  164.  
  165.     "Update last read message pointers? [y/N] ".  
  166.     
  167.     In the event the caller selects "No", LAKOTA will not mark the caller's 
  168.     messages as received and will not update the caller's last read message
  169.     pointers.  When the caller selects "Yes", then the messages are marked
  170.     as received and the last read message pointers are updated just as if
  171.     the caller did not have Sysop Security.
  172.  
  173.        During the message extraction process, LAKOTA will display
  174.     the following messages for each conference processed:
  175.     
  176.     You last read message number #<X> of <X>
  177.              (where the first <X> represents the last message number
  178.              read in this Message Conference and the second <X>
  179.              represents the total number of messages available in
  180.              the Message Conference being processed.)
  181.              
  182.     Processing Message Conference #<X> <Message Conference Description>
  183.             (where <X> represents the number of the Message Conference
  184.              and <Message Conference  Description> is the configured
  185.              description of the Message Conference being processed).
  186.     
  187.        As the messages are processed, a sliding graph is used to
  188.     illustrate the progress of the message extraction process.  The
  189.     graph is divided into increments of 20 percent; showing 0, 20, 40
  190.     60, 80, and 100 percent completion of the message extraction.
  191.        
  192.        Once the message(s) have been extracted from the SPITFIRE message
  193.     base, the extracted messages will be archived in ZIP format and the
  194.     following message will display to the caller:
  195.  
  196.     Creating (zipping) <BBS QWK Identification>.QWK ... please stand by!
  197.             (the BBS QWK Identification will correspond to the BBS QWK
  198.              Identification defined during LAKOTA's configuration.)
  199.        
  200.        If the caller has logged on locally, the <BBS QWK Identification>.QWK 
  201.     packet will be created in the SPITFIRE home directory.   If this file
  202.     (<BBS QWK Identification>.QWK) already exists, it will be overwritten 
  203.     when the new mail packet is created.
  204.         
  205.        If the caller has called the BBS from a remote location (via modem) 
  206.     the filename is displayed along with the total number of bytes the
  207.     file contains.  For example:
  208.     
  209.     <BBS QWK Identification>.QWK :  117,341 Bytes
  210.  
  211.        Next, the File Transfer Protocol Menu is displayed to the remote
  212.     caller:
  213.     
  214.     File Transfer Protocols
  215.     <X>..............Xmodem
  216.     <Y>..............Ymodem
  217.     <Z>..............Zmodem
  218.     <Q>................Quit
  219.     PROTOCOL MENU - [X Y Z Q]:
  220.     
  221.        The caller may then select the download protocol of their choice 
  222.     from XModem, YModem or ZModem.  The caller may also opt to Quit and 
  223.     return to LAKOTA's Main Menu.  Once a protocol is selected, the caller
  224.     should initiate the download process from within their communications
  225.     program to begin the file transfer.
  226.  
  227.        LAKOTA includes display files in the created QWK packet.  These
  228.     display files are WELCOME1.CLR and GOODBYE.CLR from your DISPLAY
  229.     directory (when found).  LAKOTA also includes a display named
  230.     NEWSFILE.CLR when this file is found in the SPITFIRE HOME directory.
  231.     This file can be used to provide the caller with whatever information
  232.     you believe is important, however, the purpose of this file is to explain
  233.     the <QWK BBS identification name>.LMR (last message read pointer file)
  234.     which LAKOTA creates and includes in the QWK packet.
  235.  
  236.        LAKOTA creates and includes a <QWK BBS identification name>.LMR file
  237.     in the QWK packet.  This file contains a record of the 'last message
  238.     read pointers' for the messages conferences which are included in the
  239.     downloaded QWK packet.  In the event this file is placed in a .REP file
  240.     and then uploaded to LAKOTA, the caller's last message read pointers
  241.     will be  reset using the information contained in the .LMR file.
  242.  
  243.     
  244.     UPLOADING MESSAGES
  245.     ------------------
  246.    
  247.       When logged on locally and a caller selects to Upload Messages in 
  248.     QWK Format, the following prompt is displayed provided the required
  249.     amount of upload disk space exists per the amount configured by the
  250.     Sysop in SPITFIRE (ALT+Z).  In the event there is inadequate disk space,
  251.     then LAKOTA displays the message "Sorry but there is not enough disk
  252.     space!" otherwise the following prompt is displayed::
  253.    
  254.     File must be in .ZIP format!
  255.     Enter name of the file to import:
  256.    
  257.        The first character you enter should be the drive letter where the 
  258.     file to be uploaded is located.  LAKOTA will automatically insert the 
  259.     semi-colon and the backslash after this letter  is entered.   (In other
  260.     words, if you input the letter C, LAKOTA will then place the :\ after 
  261.     this character to make it "C:\".)  Next enter the path and file name 
  262.     of the file you will import.  LAKOTA will import messages from this 
  263.     file directly into SPITFIRE's message base.
  264.  
  265.        If a caller logs on to the BBS from a remote location (via modem) 
  266.     and selects LAKOTA's option to Upload Messages, the caller is presented
  267.     a menu of File Transfer Protocols:
  268.     
  269.     File Transfer Protocols
  270.     <X>..............XModem
  271.     <Y>..............YModem
  272.     <Z>..............ZModem
  273.     <Q>................Quit
  274.     PROTOCOL MENU - [X Y Z Q]:
  275.     
  276.     from which a protocol will be selected to perform the file transfer
  277.     of the message mail packet or the caller may quit and be returned
  278.     to LAKOTA's Main Menu.  Once a protocol is selected, the caller
  279.     should initiate the upload process from within their communications
  280.     program.
  281.  
  282.        LAKOTA adds the number of messages uploaded to the caller's record
  283.     in SPITFIRE.  In other words, if the caller had entered 197 messages 
  284.     and then uploaded 7 messages, SPITFIRE would then credit the caller 
  285.     with 204 messages entered.  LAKOTA also adds the number of messages 
  286.     uploaded to SPITFIRE's total number of messages entered for the day.
  287.     
  288.  
  289.     SET LAST MESSAGE READ POINTERS
  290.     ------------------------------
  291.  
  292.        Selecting this option from Lakota's Main Menu allows the caller
  293.     to update their last message read pointers.  The Message Conference
  294.     menu is displayed to allow the caller to specify which conference(s)
  295.     should be included when setting the last message read pointers.
  296.  
  297.     >>>> Message Conference Menu <<<<
  298.     <A>...............All Conferences
  299.     <B>...........Select A Conference
  300.     <C>.......Your Queued Conferences
  301.     <Q>..........................Quit
  302.  
  303.     CONFERENCE MENU - [A S Y Q]?
  304.  
  305.     All Conferences - will display the following prompt for each
  306.     Message Conference available to the caller:
  307.     
  308.     Message Conference #<X> 
  309.              (where <X> is the number corresponding the Message 
  310.              Conference number)
  311.     You last read msg #<X> of <X>
  312.              (where the first <X> represents the last message number
  313.              read in this Message Conference and where the second <X>
  314.              represents the total number of messages available in
  315.              this Message Conference.)
  316.     Enter message number:
  317.     
  318.     The number entered here will reset the caller's last message read 
  319.     pointer to the corresponding message number in this conference.
  320.     Pressing enter, without entering a number, allows the caller to
  321.     continue without updating the last message read pointer for this
  322.     conference.
  323.  
  324.     This process will continue until the caller has been prompted to set
  325.     their last read message pointer for each conference available to them
  326.     on the BBS.  
  327.     
  328.     Select A Conference - allows the caller to select a specific conference
  329.     in which to set the last message read pointer.  LAKOTA will prompt the
  330.     caller with:
  331.     
  332.     Change last message read for which conference?
  333.     
  334.     After the caller enters the number of the conference, the following
  335.     prompt is displayed:
  336.  
  337.     You last read msg #<X> of <X>
  338.              (where the first <X> represents the last message number
  339.              read in this Message Conference and where the second <X>
  340.              represents the total number of messages available in
  341.              this Message Conference.)
  342.     Enter message number:
  343.     
  344.     The number entered here will reset the caller's last message read 
  345.     pointer to the corresponding message number for this conference.
  346.     Pressing enter, without entering a number, allows the caller to
  347.     continue without updating the last message read pointer for this
  348.     conference.
  349.  
  350.     Your Queued Conferences - will display the following prompt for each
  351.     Message Conference in the caller's message queue:
  352.     
  353.     Message Conference #<X> 
  354.              (where <X> is the number corresponding the the Message 
  355.              Conference number)
  356.     You last read msg #<X> of <X>
  357.              (where the first <X> represents the last message number
  358.              read in this Message Conference and where the second <X>
  359.              represents the total number of messages available in
  360.              this Message Conference.)
  361.     Enter message number:
  362.     
  363.     The number entered here will reset the caller's last message read 
  364.     pointer to the corresponding message number in this conference.
  365.     Pressing enter, without entering a number, allows the caller to
  366.     continue without updating the last message read pointer for this
  367.     conference.
  368.  
  369.     This process will continue until the caller has been prompted to set
  370.     their last read message pointer for each conference within their
  371.     message queue.
  372.  
  373.     Quit - Returns the caller to LAKOTA's Main Menu.
  374.  
  375.  
  376.     DISTRIBUTION PACKAGE
  377.     --------------------
  378.       
  379.       When decompressed, the distribution package, LAKOTA.ZIP, should
  380.     contain the following files:
  381.     
  382.        FILE_ID.DIZ     - Text file containing short program description
  383.        LAKOTA.BBS      - ASCII display file
  384.        LAKOTA.CLR      - ANSI display file
  385.        LAKOTA.COM      - Executable message packer file
  386.        LAKOTA.DOC      - This documentation file
  387.        NEWSFILE.CLR    - Optional display file
  388.        
  389.       You are free to distribute the LAKOTA program as long as it remains
  390.     unmodified and no fee is charged.  Sysops are free to post this and 
  391.     subsequent versions of LAKOTA on public Bulletin Board Systems as
  392.     long as no fee is charged to obtain the file.
  393.  
  394.     
  395.     SPECIAL THANKS
  396.     --------------
  397.         
  398.         Mike Woltz and Buffalo Creek Software would like to extend a
  399.     special thank you to Mike Hudson, Steve Newman and Tom Lehner for
  400.     their participation in the beta-testing of LAKOTA during its
  401.     development stages.  There are quite a number of people who
  402.     participated in the development of LAKOTA but these fellows
  403.     went above and beyond the call of duty. Thanks!
  404.  
  405.         Further, special thanks goes to the native Americans for
  406.     the word LAKOTA.  
  407.     
  408.         
  409.     REGISTRATION
  410.     ------------
  411.  
  412.        LAKOTA is distributed under the shareware concept.  You may use
  413.     the files included within LAKOTA.ZIP for a trial period of thirty
  414.     days.  If you continue to use these programs beyond the thirty day
  415.     trial period a $1.00 registration fee is required.  Registration 
  416.     should be sent to:
  417.  
  418.                          Buffalo Creek Software
  419.                          ATTN: Mike Woltz
  420.                          913 39th Street
  421.                          West Des Moines, Iowa   50265
  422.  
  423.  
  424.     DISCLAIMER
  425.     ----------
  426.         
  427.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  428.     held responsible for any damage incurred while operating LAKOTA.
  429.     All responsibility lies with the user of the software.
  430.  
  431.        The documentation for LAKOTA is contributed by Jacque
  432.     Shipley and The Mother Board BBS.  The shareware version of
  433.     SPITFIRE and other SPITFIRE utilities are available for download
  434.     from:
  435.  
  436.          Buffalo Creek's BBS              The Mother Board BBS
  437.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  438.            (515) 225-8496                    (515) 986-3464
  439.     38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  440.