SHUTTLE.DOC

21.1 KB 43d3fb48638df58f…
          Are you tired of the curious caller?  That annoying caller 
          who logs on your BBS once, -forgets s/he called, or forgets 
          the password s/he picked, and bequeaths you a wasted user 
          record?

          Are you a SysOp who'd like to screen potential users, then
          determine if you should allow them an account on your BBS? 

          Are you looking for an extra edge against the 'Big Hack-
          Attack' that plagues so many SysOp's running "open" TAG 
          systems?

          Are you a SysOp who caters to the non-public domain LEECH
          and need a way to add more panache to your system (recent 
          upload bulletins etc.) that the general public can't see?


                    YES?  WELL, THEN READ ON, BECAUSE.......


 TTTTTTTT  AAAAAAA   GGGGGGG             SSSSSSSS  HH   HH   UU    UU  TTTTTTTT
    TT     AA   AA   GG   GG             SS    SS  HH   HH   UU    UU     TT
    TT     AA   AA   GG                  SS        HH   HH   UU    UU     TT 
    TT     AAAAAAA   GG  GGG             SSSSSSSS  HHHHHHH   UU    UU     TT
    TT     AA   AA   GG   GG                   SS  HH   HH   UU    UU     TT  
    TT     AA   AA   GG   GG             SS    SS  HH   HH   UU    UU     TT
    TT     AA   AA   GGGGGGG  =========  SSSSSSSS  HH   HH   UUUUUUUU     TT
                               V. 4.1  


                    *_THE_*  Shuttle Log-on door for T.A.G.
                         
                               has arrived.


Contents, by section order:

1] Authors Note.
2] Installation.                
3] Configuration.                                
4] Questionnaire file, -options.
5] Miscellaneous features.
6] Undocumented features.
7] Acknowledgments, -credit where credit is due.
8] Possible future enhancements.
9] Support.

Special note : R.T.F.D. (Read The Faruking Docs!!) 

Translation  : Read  = That, which you are doing now.
               Faruk = The handle I use on my BBS.
               Docs  = The ascii file accompanying a program that explains the  
               procedure for its setup and operation;  The one which so many
               SysOp's try to avoid reading.

                                   TAG_SHUT
                                 ------------
                       A Shuttle Log-On Door for TAG BBS'
                         Version 4.1, for T.A.G. 2.6d
                     

1] Authors note ... 


     I wrote this door to fill a gap for converted Telegard SysOp's (I was once
one of _them_ too!).  There are many SysOp's who have converted from Telegard
to TAG, -or wish to, and one of the features they'd miss was a "Shuttle" menu.
Personally, I found them to be quite annoying, but, since there was a need, I
decided to satisfy it, and:  You know what?  Since I've been running it, I've
come to appreciate not having my user records wasted by one time callers.

     Whether, I continue to work on this door, depends on the reception it gets
from you as the end user, and the personal support I receive.  The program is
provided as-is, without charge for those who choose to run it.  Please, _READ_
the enclosed TAG_SHUT.REG file for further details.


                                        Thank You,
                                        Faruk You.     


     You must follow a few simple steps to install, and configure TAG_SHUT to
     run on your system.  This is a simple and painless procedure, as follows.


2] Installation. 

     Using the DOS MD command, create a directory to run TAG_SHUT from.  
     Un-archive, or copy the files, SHUTTLE.EXE, SHUTTLE.OVR, and, optionally, 
     NEWUSER.APP to your new directory.  

          IMPORTANT NOTES:  If no NEWUSER.APP file is placed in your 
          TAG_SHUT directory, a message will be displayed to new users 
          stating your system is not accepting new user applications.

     A sample WELCOME.BAT file is included; you may use this for reference,
     and edit your existing WELCOME.BAT.  If you don't currently use a
     WELCOME.BAT file, please copy the sample to your main BBS directory, and
     edit it to suit your system, and paths.

     WELCOME.BAT should change to your TAG_SHUT directory and run
     SHUTTLE.EXE.

   HINT:  Copy WELCOME.MSG, and WELCOME.CLR from TAG's (A, D or GFILES) 
          directory to your SHUTTLE directory.  Replace the originals with 
          dummy files of the same name.  This will allow both TAG, and TAG_SHUT
          to run detect ansi rountines without errors:  TAG_SHUT will do the
          actual WELCOME file display.  Makes for a nice seamless interface.

          If TAG_SHUT finds, either MENU.CLR or MENU.MSG in the directory it is
          run from, those files will be displayed in place of the built in main
          shuttle menu.  

3] Configuration.

     Change to the directory you created for SHUTTLE.EXE, and run the command
     as follows:

     SHUTTLE CONFIG

     The following configuration menu will be displayed:

 ╔═[■]═════════════ Edit TAG_SHUT configuration - ESC to end ═════════════════╗
 ║ Main system password                  SYSTEM   (NOTE: See TAG_SHUT.REG)    ║
 ║ Days before system password change    28       (NOTE: See TAG_SHUT.REG)    ║
 ║ Length of generated system password   8        (NOTE: See TAG_SHUT.REG)    ║
 ║ Force local logons to use shuttle     Y        (NOTE: See TAG_SHUT.REG)    ║
 ║ Ansi detection enabled                Y        (NOTE: See TAG_SHUT.REG)    ║
 ║ Maximum time in door                  5                                    ║
 ║ Inactivity time out                   3                                    ║
 ║ Path to STATUS.DAT file               D:\COM\TAG                           ║
 ║ Who to send application letter to     SYSOP                                ║
 ║ Board Number for *.MSG directory      D:\COM\TAG\EMAIL                     ║
 ║ Subject line for user application     New User application                 ║
 ║ Password for reading reply to user    READ_IT                              ║
 ║  Command keys-                                                             ║
 ║ KEY1      Log on To system(requires PASSWORD)                              ║
 ║ KEY2      Get system password(must be a user)                              ║
 ║ KEY3      Apply for account on system                                      ║
 ║ KEY4      Chat with SysOp                                                  ║
 ║ KEY5      Read reply for access, from SysOp                                ║
 ║ KEY6      Good bye-log-off, beat it                                        ║
 ╚════════════════════════════════════════════════════════════════════════════╝

     You will note that some command descriptions below are preceded by an *
     symbol:  These commands are functional.  However, to unlock their full
     potential, you must register TAG_SHUT.  Please refer to the accompanying
     TAG_SHUT.REG file for further information. 

     Use your up and down arrow keys to scroll through the various fields. 
     Pressing enter while in a field will allow editing of that field.

     When you are finished editing, press your escape key; a file named
     TAG_SHUT.DAT will be created, and your changes will be saved to it. 


[Main system password]

*    {This command may not be manually changed in the evaluation version. 
     TAG_SHUT will automatically generate new passwords for you.}

     This is the password to move past TAG_SHUT, into the T.A.G. logon process.
     Only validated users, or users whom you have granted access through a
     reply to a new user application will know the system password.    
[Days before system password change]

*    {This command may only be set between 1 - 14 days, and cannot be disabled
     in the evaluation version.}

     If value is set to 0, this option is nullified.  Any value set above 0
     will be represent the number of days before TAG_SHUT will automatically
     update a new system password.  The password is chosen randomly.

[Length of generated system password]

*    {The length of this option is set to 8, and cannot be changed in the
     evaluation version.}     

     This value represents the number of characters the randomly generated 
     system password will contain.

[Force local logons to use shuttle]

*    {The value of this option is set to yes, and cannot be changed in the
     evaluation version.}    

     This option defines whether a local logon will cause TAG_SHUT to be
     called as a prelude to T.A.G.

[Ansi detection enabled]

*    {The value of this option is set to yes, and cannot be changed in the
     evaluation version.}    

     This option specifies whether TAG_SHUT will display to the user, that is
     has detected an Ansi driver loaded on their system.  

[Maximum time in door]

     This value represents the maximum time a user will be allowed to remain
     in the door before TAG_SHUT automatically resets.
 
[Inactivity time out]

     This value represents the time TAG_SHUT will wait for a keystroke before
     assuming no carrier is present, and automatically resetting.

[Path to STATUS.DAT file]

     This is where TAG_SHUT will locate your STATUS.DAT file.  This will be
     your main T.A.G., or BBS directory.

[Who to send user application to]

     This is the name of the person who will process, and answer the user
     applications.  If you will be answering the letters, set this to the user
     name contained in your account.  ie: SYSOP, SYSTEM OPERATOR, FARUK YOU.

[Board Number for *.MSG directory]

     This value must be set to a valid Fido Style (*.msg) message base.  

[Subject line for user application]

     This line decides the text that will form the subject line of the user
     application letter.  Set this to a subject that will allow easy
     recognition of your user application letters, such as the default does.
     
[Password for reading reply to user]

     This is the password a potential user will enter to read your reply to
     their user application letter.  To prevent un-authorized reading of  
     personal mail, only un-validated users will have access to this command.
 
     NOTE:  The sample read password has been hard coded into the sample
     questionnaire for your convenience, and reference.

     Since your reply to the user application will probably contain the system
     password for approved applications, you may also choose not to display a
     read password, and advise potential users of the read password by a voice
     call. 

[Command keys-]

     Listed in order, the command keys each perform a specific function as
     outlined in their defaults.  The command text may be changed as you
     prefer, but the actual commands are static.  
  
     The keys themselves, are 'hotwords, -not to be confused with, but not
     unlike 'hotkeys'.  They may be changed to read as you see fit, but they
     must all remain the same length for the 'hotword' feature to be in effect. 
     If the length of one description differs from the others, the command need
     be followed by a carriage return from the user.  

     The editing of command keys takes place in a windowed sub-menu.  A couple
     of options are added when you are editing command keys:  Once you scroll
     to, and enter on a command key to edit, you will use your TAB key to
     change fields.  When you are finished editing, press F10 to save your
     changes, or press your ESC to abort your changes.  You will then be
     returned to the main configuration menu.    

               Example:

               KEY1    Log on to system(requires password)
               
                         -may be changed to read-

               L       Log on system, -requires password.
     
               
               KEY2    Get system password(must be user)

               W       What is system password, -users only.     


     All keys, and descriptions may be redefined, but the commands will always
     remain the same.  In the case of our example, the KEY commands remained
     the same length, -at one character, and so the 'hotword' feature would
     remain enabled.
     

     KEY1 will allow a user who has the system password to pass through
     TAG_SHUT, and proceed with the T.A.G. logon process.

     KEY2 allows a registered user to obtain the current system password by
     entering their correct user name, and password.
     
     KEY3 allows new, un-validated users to fill out your user application, to
     apply for an account on your system.  As I pointed out previously, a
     NEWUSER.APP file _must_ be present in your TAG_SHUT directory for this
     command to operate. 

     KEY4 allows a user to request a chat with the SysOp.  Chat audio is
     enabled, and disabled by toggling the SCROLL LOCK key.

     KEY5 allows user to read your reply to their new user application letter.
     Remember that you must have supplied the required password for this
     command through the NEWUSER.APP file, or advised the user by voice of the
     password.  Only un-validated users may access this command.

     KEY6 allows a user to log off the shuttle.
     
4] Questionnaire file -options.
 
     A sample NEWUSER.APP has been provided for your convenience, and
     reference.

     If you would like to expand on the sample, you may refer to the example
     below.  Read your T.A.G. documentation for further information.

Example file:


#What's your real name ? @Q@
#What's your reason for wishing access to this bbs? >@Q@

cmd color 0 6 0
#Are you a sysop of a bbs? @O@
#Is your hair brown? @O@
cmd color 0 3 0
cmd cls
...     display a screen of system info   ...
.
.
This is the end of the displayed page, press any key to go on@P@
cmd color 0 4 0 
Thanks for your time. Please call back in a day or two to check
and see if you have a reply to your application.


     Valid commands for use in the newuser.app questionnaire file:

@Q@        - Specifies a MANDATORY question.  User must supply at least 1       
             character of input to answer and go on.

@O@        - Specifies an OPTIONAL question to ask of the user.  Just hitting   
             C/R will go on past the question and output a blank line to the    
             answer message.

@$@       - Specifies input of a phone number from the user (North American     
            format).

>         - Placed in front of either of the @Q@ or @O@ prompts will force a    
            line feed and carriage return before prompting for an answer to the 
            output line.

#         - Forces line to be included in the *.MSG created for SysOp.

@P@       - Force a pause at current line. Produces a [Paused] prompt.

cmd cls   - clears both local and remote screens when processed.

cmd color - changes colors. 
            Command syntax : cmd color x y z
                             x being background color
                             y being foreground color
                             z being blinking if 1 and no blink if 0

     Valid Background Colours :

            0  : black                  4  : red
            1  : blue                   5  : magenta
            2  : green                  6  : brown
            3  : cyan                   7  : light gray

Valid Foreground Colours :

   0  : black    4  : red           8  : dark gray     12  : light red
   1  : blue     5  : magenta       9  : light blue    13  : light magenta
   2  : green    6  : brown        10  : light green   14  : yellow
   3  : cyan     7  : light gray   11  : light cyan    15  : white



          See that blank line right up here ^^^^^^^^^^^^^ ?  

          A blank line is just that, A BLANK LINE, and is displayed 
          that way.  Text lines may also be added wherever you so choose.


5] Miscellaneous features.
 

          The F10 key will initiate a chat mode at ANY time.  Split screen
          mode or single line (you type first, user types next) will be
          chosen depending on whether or not the user has ansi.

          The F1 key when pressed in chat will drop the user back to the
          point at which they left off.

          The F9 key when pressed, hits the user with fake line noise.

          The F8 key when pressed, hits the user with fake line noise and
          then disconnects the call.
 
          The chat page is enabled/disabled via the scroll lock key.
          Scroll on / chat page bell on. Scroll off / chat page bell off.
     
          Questionnaire lines are limited and truncated to 78 characters.

   NOTE:  TAG_SHUT will display non-ansi screen writes on the far left of the
          screen, rather than the centred display of an ansi screen. 


6] Undocumented features.


     In keeping with the true tradition of TAG, bugs are non existent unless
they are proven to be FTSC compatible ANNOYING and/or OFFENSIVE.  Otherwise,
they are to be considered undocumented features, all of which I would very much
like to hear of so that I may include them in the docs. :-)

     Further to this portion of the documentation, all undocumented features
will see inclusion to the system/docs in approximately a WWeek, which for those
who may be as yet uninitiated, is roughly three weeks from the Tuesday after my
Mothers 92`nd birthday (anytime sooner is a bonus for you!).



7] Acknowledgements,  -Credit where credit is due.


     First of all, I must give credit to my girlfriend Brita, without who's 
patience and understanding this door would not exist.

     Thanks Sweetheart, and please continue to be as patient as you have.
     Next, my children, Teddy and Hillary. You guys have sacrificed a lot
of my time in order that I can develop this package.  I promise that come 
summer, -one of these summers, we'll see lots of the good times again.

     I love you two guys!

Also,


     A special thanks to,

                         
                                 THE

      /\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
     /\/\/\/                                                          \/\/\/\
    |   /\/    ______________        ______          ___________       \/\   |
    |  / /    /             /|      /     /|        /          /\       \ \  |
    | / /     TTTTTTTTTTTTTT/       AAAAAA /|       GGGGGGGGGGG\/|       \ \ |
    |/\/ /\         TT |           AA|___AA /|      GG |      GG/      /\ \/\|
    |-< <  >        TT |          AA/     AA /|     GG |   _____      <  > >-|
    |\/\ \/         TT |         AAAAAAAAAAAA |     GG |  /     /|     \/ /\/|
    | \ \           TT |         AA |      AA |     GG |__GGGGGG |       / / |
    |  \ \          TT |         AA |      AA |     GG/       GG |      / /  |
    |   \/\         TT/   <>     AA/       AA/  <>   GGGGGGGGG   | <> /\/    |
     \/\/\/\                                                          /\/\/\/
      \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/

                                     TEAM

     Thanks guys, (Vic, Randy and Paul especially), if it were not for you guys
and your generosity none of us would have this fine BBS package to run.


and,          

                                Rod Bowman
                                   and

             ┌──────────────────────────────────────────────┐
             │             MOTOR CITY SOFTWARE              │
             │   ┌──────────────────────────────────────┐   │
             │   │       JPDoor - Version 3.1 SE        │   │
             │   │            ┌──────────┐              │   │
             │   │            │\         │              │   │
             │   │            │ \        │              │   │
             │   │            │  \   P   │              │   │
             │   │            │   \  A   │              │   │
             │   │            │   │  S   │              │   │
             │   │            │   │  C   │              │   │
             │   │     5.5    │   │  A   │    6.0       │   │
             │   │            │  o│  L   │              │   │
             │   │            │   │      │              │   │
             │   │            \   │──────┘              │   │
             │   │             \  │                     │   │
             │   └──────────────\ │─────────────────────┘   │
             │      The Ultimate \│ Door Writing Unit.      │
             └────────────────────┴─────────────────────────┘

             Don't be fooled! It's a dandy of a door interface.


finally,     
     ... those who tested TAG_SHUT. 



8] Possible future enhancements.

     Complete rewrite of code to eliminate use of JPDoor and reduce memory
     usage dramatically.  

     Ability to write NEWUSER.APP response to HUDSON style message base.


                                   Enjoy the door!
                                   Drew Smith  (aka Faruk You)


9] Support. 

     I can be reached via, TAG_DOORS, and TAG, echoes, or refer to TAG_SHUT.REG
for my mailing address.