                    Documentation for MultiSearch Text Door
                         Written by Robert V. Chambers
                               Copyright (c) 1996


WHAT IS MULTISEARCH TEXT DOOR?
MultiSearch Text Door is a BBS door program that will let you, the sysop, make
text  files  available  to  your users  for  on-line  viewing,  searching, and
downloading.  Sounds  dull, right? Well, there's  a  catch. This door makes it
possible  to not only view a file but to also search for text within the file.
And not just within one file, either. With MultiSearch Text Door you can elect
to  search across any files that are  available and display the results a page
at  a  time,  or only display the  lines  that  meet the search criteria. Just
select  the  files of interest, enter text to  search for, and let it go. It's
the   perfect   utility  door  for  scanning   your  log  files,  making  game
documentation  or  faq sheets available, etc.  MultiSearch  Text Door makes it
extremely  easy  to access the information you  and  your users want and need.
With DSZ your user can download any file that he/she has clearance to view.

The  door  provides  ANSI graphics file capability  so  that you can make your
favorite  ANSIs  available to your users,  thus extending the functionality of
the  door.  Though  the primary function  is  text reading and searching, this
feature was added at the encouragement of the beta testers.

While  most  doors  are aimed at either the  user  or the sysop, this one will
benefit both.

SYSTEM REQUIREMENTS:
386 or better processor
220K memory (probably less, just being conservative).

WHAT ARE SOME OF THE FEATURES?
*  Search multiple files for information.
*  Display ANSI graphics files.
*  Up to 225 files can be made available. (Registered only)
*  Download files of interest. (Requires DSZ)
*  Up to 20 document categories.
*  Optional activity log.
*  On-line help.
*  Simple Boolean search patterns.
*  Page numbering.
*  Displays file size and date.
*  File-specific security clearance.
*  Custom color configuration of file and category menus.
*  Comes complete with menu editor for adding or removing documents.
*  Has a sysop chat mode.
*  Fossil aware.
*  Supports   standard   drop  files   such   as  DOOR.SYS  (PCBoard/GAP),
   DORINFO1.DEF, EXITINFO.BBS, CHAIN.TXT, etc.
*  Supports multiple nodes.
*  Includes an editor to make menu maintenance a snap.
*  These are the basics, but there's lots more!

LIMITATIONS ON UNREGISTERED VERSION:
The  unregistered version will only support 10 documents in the menu. You must
register  the  program  to  eliminate this  restriction.  See  the  section on
registration below.

WHERE ARE THE INSTRUCTIONS ON USAGE?
All  instructions on how to use the door once it has been installed are in the
on-line  help file. If you can't wait, and  want to read it now, the help file
is  called "multsrch.hlp". Be careful that  you don't inadvertently change the
wording  in  the file, since this is the  one  that will be displayed when the
user  enters on-line help! Of course, you are free to edit it if you wish, and
may even like to add some additional information.

HOW DO I INSTALL IT:
This is simple, but you must follow these instructions. I am assuming that you
are already familiar with the steps required to install a door on your BBS. If
not,  I  would  suggest  that you read  your  manual  first. This doc will not
attempt to guide you through that.

Step  1) Unzip all files into a single directory of your choice.

Step  2)  Create a batch file that your BBS  will use to start the door. I use
        PCBoard, and my file looks something like this:

        @echo off
        cd\pcb\search
        multsrch.exe c:\pcb\node1\door.sys /L
        IF "%INPCB"=="Y" EXIT
        %PCBDRIVE%
        %PCBDIR%
        board

        You  may call the file whatever you like, subject to restrictions that
        may  be  enforced by your BBS  software. Mine is simply called SEARCH,
        with no .BAT extension. Again, consult your manual.

        A  little explanation of the startup batch  file is in order here. The
        first  line  simply  changes  to  the  directory  where  all  of  your
        MultiSearch  Text Door program files are found. (Remember you put them
        there  in  Step 1.) The second line  is  the name of the door program,
        MULTSRCH.EXE,  followed by the complete path to your drop file and the
        (optional)  log  file  switch.  Notice  that  the  drop  file  name is
        specified.  If  you  are using PCBoard,  you  may also use the PCBoard
        environment variables for the path to the drop file. Like this:

                        multsrch.exe %PCBDRIVE%%PCBDIR%\door.sys

        If you wish the program to log its activities, add "/L" after the path
        to  the  drop  file like this:

                        multsrch.exe %PCBDRIVE%%PCBDIR%\door.sys /L

        The program will create MULTSRCH.LOG which will contain information on
        door usage.  See the section below on "LOGGING ACTIVITY".

        Finally,   use   whatever  door   exiting   statements  your  software
        recommends. Your startup file will undoubtedly look different, but you
        get the general idea.


Step  3)
        Set  up  the category menu. If you  want to set up categories for your
        documents  (and you should!) you must  first create MAIN.CFG using any
        ASCII  text editor. Refer to  SAMPLE1.CFG for complete instructions on
        the  contents of this file. This file is very simple and contains only
        the  number of categories you wish to use and the description of each.

        If you do not want to use categories, but would rather have all of the
        files  listed  in a single menu, you  can  skip this step. The program
        will  provide your users with an option to list all files, so there is
        really  no  reason not to set up  categories.  Also, you will not have
        access  to  the door statistics or  file  properties display since the
        menu option for these functions is available only through the category
        menu.

        Note that the category configuration file MUST be called MAIN.CFG, and
        MUST  reside in the program file  directory. The first category listed
        will  be  category  1, the second category  2,  and  so forth. You may
        define  a  maximum  of  20  categories  in  either  the  registered or
        unregistered version.

Step  4)
        Next  run  MULTEDIT.EXE to build the  document list menu. This program
        will build the menu configuration file, MULTSRCH.CFG and add a default
        entry.  Edit  this  entry with the  proper  information for your first
        document. MULTEDIT.EXE is a very simple program that will let you add,
        modify,   and  delete  document   entries,  change  your  registration
        information,  etc.  You should use this  program each time you wish to
        make modifications to your document menu. See MULTEDIT.DOC information
        on this program.

        Alternatively  you  can  use  any  text  editor  to edit MULTSRCH.CFG.
        Complete instructions for editing are included in SAMPLE2.CFG. Be sure
        to  follow  these  carefully. Note that  no  lines  can be skipped and
        comments  are not allowed. An explanation of  each line in the file is
        included in SAMPLE2.CFG.  I don't recommend this because it's too easy
        to make a mistake.

        If you have ANSI graphics files you would like to make available, they
        must contain the ".ANS" file extension. Non-graphics users will not be
        able to display these files.

        NOTE:  Using  categories is optional.  However, the program presents a
        much   more  organized  environment  for  the  user  with  categorized
        documents.  Without  the  category menu the  user  will see all of the
        files  listed  together  in a single menu.  If  you  choose not to use
        categories  then  MAIN.CFG is not  necessary.  All new entries created
        with  MULTEDIT.EXE  will  default  to category  1  if  MAIN.CFG is not
        detected.  If you decide later to use categories, and create MAIN.CFG,
        then   you  will  need  to  change  the  category  for  each  document
        appropriately.  Otherwise all documents will appear in category 1, the
        default.

Step  5)
        Enable  or disable the download function by editing MULTSRCH.CFG. This
        is  easy  to  do  using  MULTEDIT.EXE.  You  will  be  able to disable
        downloads  or select DSZ, GSZ, or FDSZ external protocol packages. See
        "ADDING DOWNLOAD CAPABILITY" below.

Step  6)
        Setup  your BBS software and configure  any door menus, etc. that give
        the user access.

Step  7)
        You're finished! That wasn't so bad after all.

PS-> Don't forget to advertise that you now have a new door on your system!


PROGRAM  REMOVAL:
Simply  delete  the  files in the  directory  where  MultiSearch Text Door was
installed,  make appropriate changes in your BBS software, and delete any text
files that you no longer need on your system.


ADDING DOWNLOAD CAPABILITY:
To  provide your user with the ability  to download text files either DSZ, GSZ
or  FDSZ from Omen Technologies must be  in the path. These shareware programs
contain  all  the  external  drivers  that  are  needed  for  common  transfer
protocols,  including Zmodem. If you elect not to use the download feature, or
do  not have one of these programs,  then simply configure the door to disable
downloads using MULTEDIT.EXE or by manually editing MULTSRCH.CFG. Instructions
on how to manually enable/disable downloads are included in SAMPLE2.CFG.

DSZ.EXE  is  a  little faster than  DSZ.COM,  but requires more memory. Either
should  work  with the door, although  DSZ.EXE has been tested more thoroughly
than  DSZ.COM.  GSZ.EXE has a nice  graphics display of the download progress;
FDSZ.EXE is a fossil-aware version of DSZ and solved at least one problem with
a  multinode  board  running a multiport  Arnet  card. Experiment to see which
works best for you.

The  door is set up to use a default set of parameters that should work if you
are  using one or two nodes with  standard comm port (1 and 2) configurations.
If  your  setup  is  not standard, or  if  you  are having trouble getting the
download  feature  to work see DSZ.DOC for  info  on how to configure the door
using custom comm port parameters.


CUSTOMIZATION:
- TITLE SCREEN
If  you want a new title screen (maybe  for multiple instances of the door for
different  purposes)  you can do it. Create  a  new screen using your favorite
ANSI  editor,  and call it TITLE.ANS. Leave  enough room at the bottom for the
additional   registration  text.  Also,  be  sure  to  create  TITLE.ASC,  the
non-graphics  version of the title screen. It's *CRITICAL* that you name these
files correctly.

- LOGGING ACTIVITY
The program will provide extensive logging of activity within the door if the
logging switch is included in the startup command line.  For example:

                     multsrch.exe c:\pcb\node1\door.sys /L

will  cause  the  program  to record entry  and  exit  times, files viewed and
downloaded, search requests, etc. in a file called MULTSRCH.LOG. This file can
become  lengthy  if  the  door is used  regularly.  A  suggestion is to enable
logging  when  the door is initially installed  to monitor its use or when you
add  something  special that you want your  users to view or download. After a
period  of time you may wish to  disable logging or trim the file occasionally
(there  are  programs  that will do this  in  an  event). Please note that the
switch (/L) is case specific and there must be a space between it and the path
to the drop file.

- INACTIVITY TIMEOUT AND MAXIMUM DOOR TIME
You  may specify the maximum time allowed in the door and the keyboard timeout
limit  by  editing DOOR.CFG. Instructions are in  this file and should be self
explanatory.

- FILE  AND CATEGORY LISTING  COLORS:
If  you don't like the standard yellow  text in the file and category listings
you can change it! You can mix and match colors, add flashing text, change the
background  color, etc. You can even  have different color combinations within
the same file name. See the SAMPLE2.CFG for details on how to do this.


TROUBLE  SHOOTING:
The program has been successfully tested with PCBoard running under DOS 5.0 on
up,  Windows  3.1, Windows 95, Dos  with  Desqview, with Maximus running under
OS/2,  and  with  Wildcat.  It has also  been  tested  in  a Lantastic network
environment. Both single and multi-node configurations have also been tested.

In  the  event you have trouble maybe some  of  these tips will help you. This
list  is  not  very  long yet, but  will  be  added  to as information becomes
available.

1)  The  door  will not open at all.  It  looks like it tries, but immediately
shuts down and returns to the BBS.

-  This is almost certainly a sign that the startup file is not specifying the
correct  path  and/or file name of the  drop file. It's also possible that you
have  not  set the board up correctly and  the expected drop file is not being
created.  The  startup batch file must include  the full path and file name of
the  drop file as an argument to  the executable, MULTSRCH.EXE. See the sample
startup file above.

2)  You  are using DOOR.SYS and the  door  keeps logging you out when entering
locally.

- If you are not using the long GAP version (51 lines) of DOOR.SYS then either
go  to  the long version or try  DORINFO1.DEF. The DORINFO style drop file has
been successfully tested on Maximus.

3) The file listing is not working as expected.

-  Make sure that the configuration file  is named MULTSRCH.CFG and that it is
properly  filled  out. Remember not to put  any spaces or comments between the
configuration  lines.  Also be sure you  specify the EXACT number of documents
you  have  configured  for display on Line  3  of  the configuration file. The
program  uses this number to know when to quit reading the configuration file.
It  is  critical  that this number be  accurate!  Don't  forget to change this
number   when  adding  or  deleting  an   entry.  MULTEDIT.EXE  will  do  this
automatically if you use it to maintain your menu.

4)  The file will not display properly, even though it's obvious that the door
is reading it.

-  If  you  are  having  problems with  a  particular  file,  there  is a good
possibility  that  the file contains some control  codes that will cause it to
misbehave.  The door will recognize the form feed character and ignore it, but
watch  out  for  other ASCII codes from  0-31.  Also, the door works best with
files  containing  lines no longer than  78 characters in length. Longer lines
will work, but you may see wrap around on some lines.

5) The file names are doing weird things when trying to use colors.

-  First  of all read the  instructions  in SAMPLE2.CFG carefully. Chances are
that  you  are using the wrong delimiter  to specify the color. Your file name
may  also  be too long. You are  limited  to 80 characters including the color
information.

6) Problems with downloading from multinode boards.

-  You will probably have an unusual  or modified comm port addressing scheme.
Please  read  DSZ.DOC  (included) for information on  how  to  set up the port
addressing for each port used by your system. Also read the documentation that
came with DSZ. It is an excellent source of information.

7) The documents are suddenly appearing under the wrong categories.

-  You have probably changed the order of the categories in MAIN.CFG. The file
menu uses the line number of the category description to know where to display
the  entry.  If the position of the  category description has changed you will
have  to  change  the  document  category in  each  file  to  match.  A little
forethought when creating categories is a good idea!

8)  The graphics don't behave exactly right (on the user's end) with the board
running under Windows 95.

-  If  you  experience problems with this  try  running the window either full
screen  or  in  the  foreground. This seems  to  solve  the problem if you are
running  the  X00 fossil driver, but is  not feasible if running more than one
node. Try switching to the BNU fossil driver. This driver seems to work better
with  Win95,  and  cleared up the graphics  problem  for  me (I was previously
running X00).

THE LEGAL STUFF:
Users  of  MultiSearch  Text  Door must  accept  this  disclaimer of warranty:
"MultiSearch Text Door is supplied as is. The author disclaims all warranties,
expressed  or  implied,  including,  without  limitation,  the  warranties  of
merchantability  and  of  fitness  for  any  purpose.  The  author  assumes no
liability  for damages, direct or consequential, which may result from the use
of MultiSearch Text Door."

By  registering  you do NOT own this  software.  You have simply licensed it's
use.  You may use it on as many BBS  nodes as you wish, as long as these nodes
comprise  a single bulletin board system. You  may create as many instances of
the program as you wish, as long as they all reside on a single bulletin board
system.

You  are  encouraged  to pass a copy  of  MultiSearch  Text Door along to your
friends  for evaluation. Please encourage them  to register their copy if they
find  that  they  can use it. You  may  NOT pass along your registration code,
however. This should go without saying.

REGISTRATION :
This  is  not  freeware; it is shareware.  If  you  are not familiar with this
concept it means that you are allowed to try the software free of charge for a
period  of time not to exceed 30 days. At the end of this time you must either
register it or remove it from your system.

Although  I wrote this door primarily as  a learning exercise, I feel that the
time  invested  in writing and testing  the  program was significant enough to
justify  a registration fee. The cost is $20 U.S., and payment may be made via
check drawn on a United States bank. No credit cards are accepted. I will take
your cash, but you send it at your own risk.

To  register  fill  out REGISTER.FRM (included)  and  send it, along with your
check  or money order, to the address on  the form. I will respond to you with
your  registration  either  through U.S.  Postal  Service, Fidonet Netmail, or
Internet E-Mail. The choice is yours; just be sure to specify which you prefer
on the form.

When  you receive your registration code either manually edit MULTSRCH.CFG and
change  the  first  two lines to your  registered  name and code number or run
MULTEDIT.EXE and use option #1 to input the information.

The  unregistered version will only support 10 files in the menu. Registration
will  remove  this  limitation and allow as  many  as 225 documents to be made
available. Registration will also entitle you to free lifetime upgrades.

There  will  be no automatic notification of  upgrades. You can always get the
latest  version  from my BBS, Tequilla  Sunrise,  at (504)-756-0383. Just type
MULTSRCH  at  the main menu prompt. There  is  no charge (except LD charges if
applicable) for the file or to become a member of the BBS.


TECHNICAL SUPPORT:
Technical support will be provided to both registered and non-registered users
to  the  best  of my ability.

You may reach me via the following:

Fidonet -              Robert Chambers@1:3800/49
Internet EMail -       chambers@premier.net
Tequilla Sunrise BBS - (504)-756-0383


MANY THANKS!:
I  would  like  to thank Fred Leger,  Dennis  Wallette, and Henry Lin of Cajun
Clickers  BBS, David Taylor of The Phantom BBS, and Lajuana Bloomenstiel of My
Hiding  Box!  BBS,  all  from Baton  Rouge,  Louisiana,  for helping with beta
testing  and bug fixing as well as  thoughts and suggestions for improving the
program.  These  folks  are  the real heroes  here,  and  they run some of the
slickest boards around.

They  fearlessly took a chance with unproven software, and it paid off in what
I hope is a program that you will use and enjoy.

Also  thanks  to Brian Pirie who wrote  OpenDoors, the C function library that
handles  the  communications.  This  is  a heck  of  a  package,  and I highly
recommend it. Great job, Brian.

Thanks to all you guys!  I owe you one!

