
       .----------.___
     / |        |||\  ~~~--_               ____
  __|-------------| |~~~~~~~~----______--~~    ~~-_
 | _|-_           |_|                  =============
 |_|   ~~---------'__\_____------~~~~~~--.______.-~
  |__|~~ ~-__/   ~-_~-_
     ~--__   ~-__/  ~-_~-_   Home of the 1st Klingon Trivia Game!
          ~--__  ~-__/ ~-_~-_
               ~--__ ~-___/  ~-_   (C) 1993 Klingon SoftWare Labs
                    ~--__       ~-_
                        [__________]=====[[

                     USRobotics Courier 14.4 HST/PC
                        215-426-5596 24hrs Daily
                          FidoNet - 1:273/935


                                   ͻ
                                  ۺKLINCHEF
                                  ͼ
                                  

                       Version 1.05  by  Robert Ferguson
   Released  November 08, 1993  by: Klingon SoftWare Labs  Philadelphia, PA.

KLINCHEF is designed to be run as a live DOOR program on WildCat! 3.x and 2.x
systems. It allows your users to search through any recipe files you provide.
For each file, they can get a [L]ist of the recipes by name, or they may
[S]earch through the file, looking for a particular recipe by [N]ame,
[K]eyword, [M]atching ingredient, etc.

Sample recipe files are included, Thanks to Sue Franks "The Agonizer Magazine"
(Volume 4, No. 1 Spring, 1993).


                              ͻ
                             ۺSETTING UP A DOOR
                             ͼ
                             

It's important to note that KLINCHEF will check the CURRENT directory (where
your DOOR program is started) for either DOOR.SYS or CALLINFO.BBS.

klinchef also needs ENVIRONMENT VARIABLES:  These are used by WildCat! 3.x
These variables MUST be present, regardless of what WildCat! version you are
running (I have them in my AUTOEXEC.BAT and run WildCat! v2.55s).


                                 SET WCPORTID=2
                                 SET WCIRQID=3


If you have a Non-Standard port address, you'll need to provide an additional
environment variable with the DECIMAL port address:

      SET COMBASE=1016 (substitute your correct decimal port address here)

That will override the default address of the port number specified in
WCPORTID. WCIRQID will still need to be set to the correct interrupt value.
klinchef supports IRQs in the range 2-15.

If you're running the WildCat! IM version, I strongly recommend Scott Brynen's
DIGIFOSSIL, a shareware fossil driver available on Mustang SoftWare BBS.

A sample batch file for WildCat! v3.x should look something like this:

REM this is a sample batch file for KLINCHEF with WildCat! 3.x
REM this assumes you SHELL to your doors.  If you TERMINATE, you
REM need to add a change-directory back to your startup directory
REM and then run your startup batch file.
ECHO OFF
COPY C:\WC30\WCWORK\NODE%WCNODEID%\DOOR.SYS C:\WC30\DOORS\DOOR.SYS
CD C:\WC30\DOORS
KLINCHEF
EXIT

A sample batch file for WildCat! v2.x should look something like this:

REM this is a sample batch file for KLINCHEF with WildCat! 2.x
ECHO OFF
CD \DOORS
COPY C:\CAT\NODE1\CALLINFO.BBS C:\DOORS\CALLINFO.BBS
KLINCHEF
CD \CAT\NODE1
NODE1.BAT

Note that KLINCHEF monitors time online and Carrier Detect, and will close
and exit gracefully back to the node if the caller drops offline while in
the door.


                           ͻ
                          ۺPREPARING A RECIPE FILE
                          ͼ
                          

klinchef will operate with up to 18 separate recipe files ... see the
configuration file for an example of how to set up multiple files.

The format of the recipe file is quite simple, but very specific.  You may
need to edit any existing recipe files to conform to this format before they
can be used with klinchef:

The first several lines of the file are the "HEADER" and may include any
descriptive information you like, such as the date the file was compiled,
the name of the chef who authored the recipes, etc.  We suggest that you
keep the header SHORT, as it will be seen at the beginning of each search.

Before the first recipe, and between each recipe after that, place a "divider-
bar" of equal signs, beginning in column 1 and at least 10 columns wide.  The
recipe name is next, in all UPPER CASE, on the first line after the divider
bar.  After that, the format of the recipe and ingredient list is free form
and may be mixed upper and lower case as desired.

Distributed with this ZIP file is a sample recipe file which shows the required
format in detail.


                             ͻ
                            ۺPREPARING KLINCHEF
                            ͼ
                            

It's necessary to create a configuration file for KLINCHEF, named KLINCHEF.CFG,
which must reside in the directory where you'll start KLINCHEF. Here is a
sample configuration file:

                  BBSNAME=Klingon SoftWare Labs
                  CTSCHECK=YES
                  FOSSIL=NO
                  LISTPATH=C:\WC30\doors

                  KLINNAME=Klingon/Vulcan Appetizers
                  KLINFILE=KLINZHAI.1
                  KLINHEADERS=3

                  KLINNAME=Klingon/Vulcan/Romulan Ale Formulas
                  KLINFILE=KLINZHAI.2
                  KLINHEADERS=3

                  KLINNAME=Lively Klin-Foods from Chok
                  KLINFILE=KLINZHAI.3
                  KLINHEADERS=3

                  KLINNAME=Intergalactic Sweet Treats
                  KLINFILE=KLINZHAI.4
                  KLINHEADERS=3

You may edit this file as desired, following these guidelines:

        BBSNAME= The name of your BBS as you want it to appear in
                 the program's displays.

        CTSCHECK= Indicate YES or NO ... do you want the program to
                  check for Clear to Send?  Default is YES if this
                  line isn't found.

        FOSSIL=   Indicate YES or NO ... do you want the program to
                  redirect all COM calls using the INT 14h FOSSIL
                  convention.  If you're NOT running a FOSSIL driver,
                  set this to NO.

        LISTPATH= The complete Path to your recipe text files.

Next, you'll need to set up configuration information for each recipe file
you want to support in klinchef.  NOTE: You'll need to place ALL of the
files in the directory defined in LISTPATH.

A maximum of 18 Recipe files may be included...any beyond that will be ignored.

For each Recipe file, create a block of entries with these three lines:

        KLINNAME= The name of the file as you want it displayed on the
                  menu screen.

        KLINFILE= The name of the Recipe file file itself.  Reasonable
                  wildcards are acceptable, such as "PASTRY??.LST" The
                  program's search routine will display the first
                  matching file, so be sure to delete old ones when you
                  create a new file.

        KLINHEADERS= Indicates how many lines from the very top of the
                     text file you want to display.  This might include
                     the name of the list, the compilation date, and
                     perhaps the name of the chef who created the
                     recipes. I suggest you keep this to a fairly small
                     number because this info will be displayed each
                     time a search is initiated on a particular file.

It's important to note that the block of options for each list must be filled
out completely, or klinchef may produce unpredictable results!  Also, be sure
to keep them in the order shown above.  Do NOT omit any lines or klinchef
will reject the configuration file.
