@database InfoID
@master Work:MebbsNet/FD1/Doors/InfoID/InfoID.guide
@$VER: 1.00
@author "By Jason Gouger"
@(c) "© Copyright 1995  All rights reserved"

@node "Main" "InfoID  By, Jason Gouger"
               ***********************************************
               *                                             *
               *            InfoID Version 1.00              *
               *                                             *
               *       Written By, Jason Gouger[M3012]       *
               *    © Copyright 1995  All rights reserved    *
               ***********************************************


                         @{"       Disclaimer       " link "Disclaimer" 0}
                         @{"      Introduction      " link "Introduction" 0}
                         @{"        Features        " link "Features" 0}
                         @{"      Installation      " link "Installation" 0}
                         @{"          Usage         " link "Usage" 0}
                         @{"  Elysium Door Scripts  " link "Shell Games" 0}
                         @{"Comments and Bug Reports" link "Comments" 0}
                         @{"    Other Doors By Me   " link "Other Doors" 0}
                         @{"         History        " link "History" 0}


 *************************************************************************
 ***   ==> PLEASE REPORT *ALL* bugs found in the InfoID program! <==   ***
 *************************************************************************
@endnode

@node "Disclaimer" "Disclaimer"
 Disclaimer
 ~~~~~~~~~~

In the paragraphs below 'author' refers to Jason Gouger and 'program' refers to
InfoID (c) Copyright 1995, by Jason Gouger, All Rights Reserved.

This program may only be reproduced and used in accordance with the
requirements and limitations set forth below.  This program may be used by
licensees of MEBBSNet Professional BBS software in combination with their
lawful use of licensed copies of MEBBSNet Professional BBS software.  This
software may be redistributed on a non profit basis by any official MEBBSNet
CSR support site.  Any other distribution sites MUST the express written
permission to do so by the author.  Redistribution of this program for profit
requires the express, written permission of the author.  Furthermore, all
advertising materials mentioning the features, or use, of this software must
acknowledge the author and software.   This archive MUST be distributed in an
UNALTERED form.

The Author makes no warranties or representations, either express, or implied,
with respect to the information set forth herein, which the information is
being supplied on an "AS IS" basis, subject to change without notice. The
ENTIRE risk as to the use of this program is assumed by the user. IN NO EVENT
WILL THE AUTHOR OF THIS PROGRAM BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES RESULTING FROM ANY CLAIM ARISING OUT OF THE
INFORMATION PRESENTED HEREIN, EVEN IF IT HAS BEEN ADVISED OF THE POSSIBILITIES
OF SUCH DAMAGES.  SOME STATES DO NOT ALLOW THE LIMITATION OF IM PLIED
WARRANTIES OR DAMAGES, SO THE ABOVE LIMITATIONS MAY NOT APPLY.

'MEBBSNet Profession BBS' is a registered trademark of MEBBS Engineering and
Software.
@endnode

@node "Introduction" "Introduction"
 Introduction
 ~~~~~~~~~~~~

      InfoID is a small utility to generate local variables containing most of
the information on a particular user.  The variable names are 100%
configurable, and a line number or username may be specified to  generate the
user information.  This utility may be used to initialize CLI doors with a
user's personal preferences, or scripts that process user information.
@endnode

@node "Features" "Features"
 Features
 ~~~~~~~~

    - 100% configurable variable names
    - ability to specify a 'new' space character
    - easy access to user information
    - ability to specify a line number or username for data retrieval
@endnode

@node "Installation" "Installation"
 Installation
 ~~~~~~~~~~~~

Simply copy InfoID to your MEBBSNet:c/ directory or where desired.

Example:

 1> Copy InfoID MEBBSNet:c


NOTE: This utility will requires a minimum of AmigaOS 2.0
@endnode

@node "Usage" "Usage"
 Usage 
 ~~~~~

InfoID is ONLY usable from a shell enviornment.  There are MANY options, which
are described below.

 Options:

  NAME/K,LINE/K/N,USERNAME/K,HANDLE/K,PASSWORD/K,TELEPHONE/K,ADDRESS/K,CITY/K,
  STATE/K,ZIP/K,BUPLOAD/K,BDOWNLOAD/K,FREEBYTES/K,ACCESSLEVEL/K,TOTALCALLS/K,
  CALLSTODAY/K,MINSREMAIN/K,COMPTYPE/K,COLUMNS/K,FUPLOAD/K,FDOWNLOAD/K,
  DOORPOINTS/K,MSGLIMIT/K,NETCREDITS/K,GFXTYPE/K,FRATIO/K,CALLSPERDAY/K,
  MINSPERDAY/K,MINSPERCALL/K,BRATIO/K,MSGENTERED/K,EDITOR/K,HOTKEYS/K,
  PROTOCOL/K,CONVSPCS/K,QUIET/S

  NOTE: Either the NAME/K or LINE/K argument MUST be specified for the 
        command to function.

  NAME/K ........ Keyword which specifies the UserName or Handle on which
                  the information is to be retrieved. 

  LINE/K ........ Keyword which specifies the Line Number from which the
                  user information is to be retrieved.

  USERNAME/K .... Keyword which specifies the Variable Name in which the
                  UserName is to be stored.

  HANDLE/K ...... Keyword which specifies the Variable Name in which the
                  Handle is to be stored.

  PASSWORD/K .... Keyword which specifies the Variable Name in which the
                  Password is to be stored.

  TELEPHONE/K ... Keyword which specifies the Variable Name in which the
                  Telephone Number is to be stored.

  ADDRESS/K ..... Keyword which specifies the Variable Name in which the
                  Address is to be stored.

  CITY/K ........ Keyword which specifies the Variable Name in which the
                  City is to be stored.

  STATE/K ....... Keyword which specifies the Variable Name in which the
                  State is to be stored.

  ZIP/K ......... Keyword which specifies the Variable Name in which the
                  Zip Code is to be stored.

  BUPLOAD/K ..... Keyword which specifies the Variable Name in which the
                  Total Bytes Uploaded is to be stored.

  BDOWNLOAD/K ... Keyword which specifies the Variable Name in which the
                  Total Bytes Downloaded is to be stored.

  FREEBYTES/K ... Keyword which specifies the Variable Name in which the
                  Total Free Bytes is to be stored.

  ACCESSLEVEL/K . Keyword which specifies the Variable Name in which the
                  Access Level is to be stored.

  TOTALCALLS/K .. Keyword which specifies the Variable Name in which the
                  Total Calls to the System is to be stored.

  CALLSTODAY/K .. Keyword which specifies the Variable Name in which the
                  Total Calls Today is to be stored.

  MINSREMAIN/K .. Keyword which specifies the Variable Name in which the
                  Total Minutes Remaining is to be stored.

  COMPTYPE/K .... Keyword which specifies the Variable Name in which the
                  Computer Type is to be stored.

  COLUMNS/K ..... Keyword which specifies the Variable Name in which the
                  Total Columns is to be stored.

  FUPLOAD/K ..... Keyword which specifies the Variable Name in which the
                  Total Files Uploaded is to be stored.

  FDOWNLOAD/K ... Keyword which specifies the Variable Name in which the
                  Total Files Downloaded is to be stored.

  DOORPOINTS/K .. Keyword which specifies the Variable Name in which the
                  Total Door Points is to be stored.

  MSGLIMIT/K .... Keyword which specifies the Variable Name in which the
                  Total Messages Allowed Per Call is to be stored.

  NETCREDITS/K .. Keyword which specifies the Variable Name in which the
                  Total Network Credits Remaining is to be stored.

  GFXTYPE/K ..... Keyword which specifies the Variable Name in which the
                  Graphics Type is to be stored.

  FRATIO/K ...... Keyword which specifies the Variable Name in which the
                  File Ratio is to be stored.

  CALLSPERDAY/K . Keyword which specifies the Variable Name in which the
                  Total Calls Per Day is to be stored.

  MINSPERDAY/K .. Keyword which specifies the Variable Name in which the
                  Total Minutes Allowed Per Day is to be stored.

  MINSPERCALL/K . Keyword which specifies the Variable Name in which the
                  Total Minutes Allowed Per Call is to be stored.

  BRATIO/K ...... Keyword which specifies the Variable Name in which the
                  Byte Ratio is to be stored.

  MSGENTERED/K .. Keyword which specifies the Variable Name in which the
                  Total Messages Entered is to be stored.

  EDITOR/K ...... Keyword which specifies the Variable Name in which the
                  Editor Type is to be stored.

  HOTKEYS/K ..... Keyword which specifies the Variable Name in which the
                  HotKey Mode is to be stored.

  PROTOCOL/K .... Keyword which specifies the Variable Name in which the
                  Protocol Type is to be stored.

  CONVSPCS/K .... Keyword which specifies a character to substitute in 
                  the user information instead of a [SPACE].

  QUIET/A ....... Switch which suppresses the copyright information from
                  being displayed.


 Example:

  1> InfoID NAME "Jason Gouger" HANDLE User GFXTYPE GfxMode QUIET

  This example would retrieve the User Information on 'Jason Gouger' and 
  store the Handle in the 'User' local variable and the Graphics Type in 
  the local variable 'GfxMode'.

***NOTE: The information is retrieved from *DISK*, therefore it will not
         reflect any changes made in the user information while the user
         has been OnLine.  Which means that the Total Minutes Remaining 
         will indicate the Minutes Remaining when the User Logged On and
         *NOT* the current number of minutes remaining.
@endnode

@node "Shell Games" "Example Shell Game Scripts"
 Example Elysium DosDriver SetUp:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 Script To Be Called By MEBBSNet as the DOOR:
 *******************************************

 >>>Start>>>>>>>>>>>>>>>DosDrivers:ShellDoor.SCP>>>>>>>>>>>>>>>>>>>>>>>

 .KEY LineNumber

 InfoID LINE <LineNumber> GFXTYPE Gfx HANDLE User QUIET

 DosDrivers:ShellDoor <LineNumber>  ; Start 'Normal' Elysium Door File

 <<<End<<<<<<<Make SURE that the 'S' protection bit is *SET*<<<<<<<<<<<


 Script called by the Elysium DosDriver:  
 **************************************

 >>>Start>>>>>>>>>>>>>>>DosDrivers:ShellDoor.SCH>>>>>>>>>>>>>>>>>>>>>>>

 FailAt 200

 CD DOORS:ShellDoorDir

 if $Gfx EQ 0
    ShellDoorPrg UserName=$User ANSI=MONO
 Else
    ShellDoorPrg USERNAME=$User ANSI=COLOR 
 EndIf

 Lab Begin
    EndCli 
 Skip Begin BACK

 <<<End<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

Notice the FailAt line is the FIRST line in the script, this ensures that the
script will continue even if any of the commands contained within the script
fail.  Also, notice the 'EndCli' loop, which ensures that the EndCli command is
executed.
@endnode

@node "Comments" "Comments and Suggestions"
 Comments and Bug Reports:
 ~~~~~~~~~~~~~~~~~~~~~~~~

  Call my BBS:

    The Amiga Enterprise    717-223-8269   300-28800 Bps   24 Hours

  Or send mail to:

                gouger@psu.edu     - Internet Address *
                gouger@cse.psu.edu - Internet Address *
                Jason Gouger       - Fidonet 1:268/114
                Jason Gouger       - Proper Mebbs Echo

    * Internet addresses are the fastest method of communication

    Updates can be Freq'ed from 1:268/114.0 with the magical name 'InfoID' 
    and a password of 'UPDATE'.
@endnode

@node "Other Doors" "Other Doors by Jason Gouger"
 Other Doors by Me:
 ~~~~~~~~~~~~~~~~~

                              MQwkID [V1.00]
                              --------------

   MQwkID is an external door for the MEBBSNet Profession BBS software that
creates standard QWKMail packets.  MQwkID has many features including
autopacket naming, multiple message area downloads, hidden mode operation, and
much more.  MQwkID also serves as a reply packet tosser directly through the
door or from the command line.


                              UserID [V2.01]
                              --------------

     UserID keeps track of the past number of callers that YOU define. Also the
output is 100% configurable.  There are many text sequences (~u_) which display
a callers actions while on-line.  They include messages posted, download, and
upload information.  Every field can be configured to a specific length and can
be left or right justified.  UserID will create an environmental variable
called User_X (X being the line number) which will hold the on-line user's
name. This environmental variable can be used for shell games and other
applications where the username is not readily available, see the included
examples.  The environmental variable is also used by the TimeOn door. The
TimeOn door displays the total on-line time.


                              CDRomID [V1.02]
                              ---------------

Allows users to search CD-Rom Index file(s) for a string, and of course it has
the ability to the allow direct downloading of files from the CD-Rom.  It also
includes the ability to make file(s) FREE for download, or have them charged
against the users account.  It now has Multiple CD-Rom support, and a temporary
download directory option has been added.


                              LineID [V1.00]
                              --------------

     LineID displays a configurable number of user's online.  The output is
100% configurable.  This configurability is accomplished through several text
sequences.  If LineID is used in conjunction with UserID a SIGNIFICANT increase
in speed will be noticed.  I recommend installing this wonderful last caller
door.


                              PathID [V1.00]
                              --------------

   PathID is a small utility to ensure all of the file, message, and system
directories have been created.  If a missing directory is encountered PathID
will prompt to create the missing directory if desired. This is an excellent
utility for first time setups, and when creating new file or message areas.
@endnode

@node "History" "History"
@next "Main"
 History:
 ~~~~~~~

===> 1.00 ===> 

First Public Release.
@endnode

