home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_GAME / USURP005.ZIP / GAMEHELP.ZIP / TYPE_7.TXT < prev    next >
Text File  |  1994-02-08  |  14KB  |  303 lines

  1.                         Type 7 Parameters for Door Menus
  2.                         -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  3.  
  4.                           File supplied by Bill McPhail
  5.  
  6.                         North American/USA Registation Site
  7.                         -----------------------------------
  8.                       The BoardRoom BBS, Graham, Wa. 98338-1185
  9.                    FidoNet: Node 1 - 1:138/137 & Node 2 - 1:138/237
  10.              Data lines: Node 1 - (206) 847-1763 & Node 2 - (206) 846-0755
  11.  
  12. Ezycom Type 7 commands:
  13. -=-=-=-=-=-=-=-=-=-=-=-
  14.  
  15.           Example Data: *C /C GAME.BAT
  16.  
  17.                On executing a Type 7 Shell, Ezycom writes two files,
  18.           EXITINFO.<node> and DORINFOx.DEF.  The name for DORINFOx.DEF
  19.           is configurable and can be changed with the list of special
  20.           commands later.  The EXITINFO.<node> holds Ezycom specific
  21.           information, that it uses to run.  On returning to Ezycom
  22.           after the Type 7 Shell, Ezycom reads in the EXITINFO.<node>
  23.           file to process any information that might have been
  24.           changed.
  25.  
  26.            *F  User's First Name
  27.            *L  User's Last Name
  28.            *H  The Fossil Driver is left "Hot" during the Type 7
  29.                Shell. Generally this option is not used.
  30.            *M  Swap out Ezycom leaving it using only 9K of RAM.  This
  31.                enables larger programs to be executed in the Type 7
  32.                Shell although swapping can take a few seconds, if Disk
  33.                Swapping is used.
  34.            *P  Comport Number
  35.            *R  User Record Number
  36.            *G  ANSI On/Off On=1 Off=0
  37.            *V  ANSI/Avatar On/Off
  38.                3  ANSI & Avatar
  39.                2  Avatar
  40.                1  ANSI
  41.                0  ASCII
  42.            *A  Users Alias (Real Name if there is no alias)
  43.            *C  COMSPEC Environment variable (COMMAND.COM)
  44.            *S  User's Security Level
  45.            *N  Node : Format 1..250
  46.            *9  Node : Format FO1..250
  47.  
  48.                 This format could be used for renaming/copying
  49.           DORINFOx.DEF to a naming convention that some door programs
  50.           might prefer.
  51.  
  52.             *0  This switch is replaced by the current File Area      
  53.                 Template number.
  54.             *1  This switch is replaced by the current Message Area   
  55.           Template number.
  56.             *2  This is the upload path for the current file area     
  57.                 template.
  58.             &V  This is the same as *V, except that it places the
  59.                 *V information in the DORINFOx.DEF and DOOR.SYS       
  60.                 files.
  61.             &A  This is the same as *A, except that it places the
  62.                 Alias of the user in the DORINFOx.DEF and DOOR.SYS
  63.                 files instead of the user's real name.
  64.             &O  This is the same as *O, except that it places the
  65.                 Locked Baud rate in the DORINFOx.DEF and DOOR.SYS
  66.                 files instead of the effective baud rates.  That
  67.                 is, if the comport is locked.
  68.             *D1 This option creates the DORINxxx.DEF on executing
  69.                 the Type 7 Shell where xxx is the *9 Node Format.
  70.             *D2 This option creates the DORINFO1.DEF on executing
  71.                 the Type 7 Shell.
  72.             *D3 This option creates DOORx.DEF on executing the Type
  73.                 7 Shell where x is the *N Node Format
  74.             *D4 This option creates a doorway compatible DOOR.SYS
  75.                 file in executing the Type 7 Shell.
  76.             *!  This option stops the clock when the user is in the
  77.                 Type 7 Exit.  That is, the user does not loose
  78.                 anytime in the Shell.
  79.             *#  This option turns off the Want Chat Flag.
  80.             *B  This is the users effective Baud Rate.  If, the
  81.                 user is local then the baud rate is 0.
  82.             *O  This is the users actual Baud Rate between the
  83.                 computer and modem.  If the comport is NOT locked,    
  84.                 then it is the same value as the effective Baud
  85.                 Rate.
  86.  
  87.                These options can be used in the parameters field of
  88.           the Type 7 Exit.
  89.  
  90.           For Example: GAME.EXE *F *L *P
  91.  
  92.           This would translate to for instance,
  93.  
  94.           GAME.EXE Peter Davies 1.
  95.  
  96. RA Type 7 Commands:
  97. -=-=-=-=-=-=-=-=-=-
  98.  
  99.        Type          : 7
  100.        Name          : Run an external program in a shell
  101.        Optional Data : <Command Line> [Control Codes]
  102.  
  103.        This  command  will run an external program (a "door") in  a
  104.        shell while the user is on-line. Examples are on-line games,
  105.        mail-checking facilities and so on. (Refer also to type 15 -
  106.        Exit  to  DOS  for an alternative way  of  running  external
  107.        programs). The FULL name of the program must be specified if
  108.        it is an .EXE or .COM file.  To run one of these two  simply
  109.        put  the name of the program in the optional data field.  If
  110.        you  wish  to  call a batch file,  this  must  be  done  via
  111.        COMMAND.COM,  the memory-resident command-line processor. So
  112.        to  run  your TradeWars batch file,  the command line  could
  113.        read:
  114.  
  115.                    C:\COMMAND.COM /C \BBS\DOORS\TW2.BAT
  116.  
  117.        Many programs require extra information to be passed on  the
  118.        command line, so the following control codes may be used. In
  119.        each case, the code is replaced by it's value:
  120.  
  121.             *A : Write the user's handle (if any) in DORINFO.DEF   
  122.                  instead of the user's real name.
  123.  
  124.             *B : User's baud rate, or 0 if local.
  125.  
  126.             *C : Full path and name to COMMAND.COM.
  127.  
  128.             *D : Automatically generate the Doorway DOOR.SYS       
  129.                  parameter file.
  130.  
  131.             *F : User's first name.
  132.  
  133.             *G : ANSI graphics, 0=Off/1=On.
  134.  
  135.             *H : Normally  the  FOSSIL  is  de-initialised   before
  136.                  running an external program to avoid any possible 
  137.                  conflicts  between  the  FOSSIL and  the  program.
  138.                  Specifying this parameter leaves the FOSSIL  "hot"
  139.                  or active. 
  140.  
  141.             *L : User's last name.
  142.  
  143.             *M : Activate MemorySwap feature. RemoteAccess attempts
  144.                  to  swap itself and all the memory it occupies  to
  145.                  EMS  (if  installed) and  disk,  leaving  only  2k
  146.                  resident.    Great   for   running   memory-hungry
  147.                  programs,  but  it  takes a few seconds to do  the
  148.                  swap.  If  it  can't do the swap,  it will  try  a
  149.                  normal shell.  NOTE :  Some programs are notorious
  150.                  for  "fragmenting" memory,  and will not work with
  151.                  MemorySwap.  Programs compiled in QuickBASIC, such
  152.                  as TradeWars 1000 exhibit this problem.
  153.  
  154.             *N : Line number,  as specified  by the -N command line
  155.                  parameter.
  156.  
  157.          *Oxxx : Override the baudrate value passed on to the      
  158.                  called program with xxx.
  159.  
  160.             *P : Communications port being used (1-4).
  161.  
  162.             *R : User's record number in the user file.
  163.  
  164.        *S<filename.ext> :
  165.               Generates a  custom exitfile using a template file   
  166.               with the extension .RAT in the system directory      
  167.               which contains any valid textfile macros. See the    
  168.               "Textfile  Control Codes"  section  of  the          
  169.               reference chapter for a full  list of available      
  170.               text macros.
  171.  
  172.               The 'filename'  is the  base  filename  of  the  .RAT
  173.               template file.  RA will process the file  and  create
  174.               filename.ext where  the EXITINFO.BBS file is stored.
  175.  
  176.             *T : Time remaining for current call.
  177.  
  178.             *! : Freeze  the  system timer  for the duration of the
  179.                  shell.  Useful for running external utilities like
  180.                  full-screen chat programs etc.
  181.  
  182.             *# : Turn off the "Wants Chat" indicator on return from
  183.                  the   shell.  This  is  to  facilitate  the proper
  184.                  installation of external chat utilities.
  185.  
  186.             *0 : The full path to the currently selected file      
  187.                  template area.
  188.  
  189.             *1 : The number of the currently selected template     
  190.                  message area.
  191.  
  192.  
  193.        In  addition  to this command line information that  can  be
  194.        passed,  RemoteAccess also creates two data files before the
  195.        shell.  DORINFO1.DEF,  which is a RBBS-compatible file,  and
  196.        EXITINFO.BBS,  which  contains  an  extremely  comprehensive
  197.        amount of system and user information. The structure of this
  198.        file  can be found in the RemoteAccess structures  document,
  199.        RASTRUCT.  It should also be noted that ALL system files are
  200.        written  to  and closed off before the shell  is  activated,
  201.        then  reopened  and scanned upon  return.  This  means  that
  202.        programs  that  modify system files (eg.  USERS.BBS) can  be
  203.        safely run in a type 7 shell.
  204.  
  205.        RemoteAccess also supports Doorway's DOOR.SYS parameter file
  206.        directly; including  a *D on  the command  line enables  the
  207.        generation of this file.
  208.  
  209.        Note  that the external program must do it's own time  limit
  210.        and  carrier watchdogging,  in the event that the user  does
  211.        not exit from the program correctly.
  212.   
  213.  
  214. SuperBBS Type 7 Commands:
  215. -=-=-=-=-=-=-=-=-=-=-=-=-
  216.  
  217.       Type.........: 7
  218.         Description..: Shell to DOS and run program
  219.                        This option is used for starting other pro-
  220.                        grams, like doorgames and mailscanners, in
  221.                        SuperBBS. It shells to DOS and starts the pro-
  222.                        gram given in the optional data field. SuperBBS
  223.                        will return to the menu the exit started from.
  224.         Optional data: ProgramName <Parameters>
  225.                        This menu is one of the difficult menu options
  226.                        available, because of the large amount of para-
  227.                        meters. These are the parameters available:
  228.  
  229.                        *B   Caller's bps rate. This will be 0 if
  230.                             local, or 300 to 38400 if online.
  231.                        *C   Full path to your COMMAND.COM file as set
  232.                             in the environment variable COMSPEC. (Con-
  233.                             sult your DOS manual for more information
  234.                             about COMSPEC.) This parameter is needed
  235.                             if you want to start a batchfile from this
  236.                             type 7 menu command.
  237.                        *E   Read EXITINFO.BBS when returning to BBS.
  238.                             This can be handy if the program used with
  239.                             the type 7 exit, changes some of the
  240.                             user's data, like a timebank.
  241.                        *F   User's firstname.
  242.                        *G   Status of ANSI graphics. (0=Off, 1=On)
  243.                        *H   Leave the Fossil driver (X00 or
  244.                             compatible) hot when exiting from
  245.                             SuperBBS. Some programs require this.
  246.                             (Most don't.)
  247.                        *I   Path of current language file.
  248.                        *J   User's screenlength
  249.                        *L   User's lastname.
  250.                        *N   Gives current node number.
  251.                        *P   Gives current COM port number.
  252.                        *R   User's recordnumber in the user database.
  253.                        *S   Swap SuperBBS to EMS or disk. If you run a
  254.                             program which needs more memory than the
  255.                             normal amount available, specify the *S
  256.                             option, so SuperBBS will swap itself to
  257.                             EMS or, if EMS is not available, to disk.
  258.                        *T   Time left this call.
  259.                        *U   Path to current template file area. (See
  260.                             menu templating.)
  261.  
  262.                        *X   Template filename. SuperBBS now can pro-
  263.                             duce any kind of (ASCII style) exit file,
  264.                             supporting doors not made for SuperBBS.
  265.                             Create a template file with the extension
  266.                             .SBE and set it up as the door might need
  267.                             it. You have all control codes available.
  268.                             When you use the *X option in a type 7
  269.                             exit, SuperBBS will replace the template
  270.                             given in the optional data field, like
  271.                             *XFilename.SBE, to create the exitfile
  272.                             Filename.EXT. Example:
  273.  
  274.                             Exit template file: (TEST.SBE)
  275.  
  276.                                  ^FA
  277.                                  ^FB
  278.                                  ^KO
  279.                                  ^KV
  280.  
  281.                             Would give you an exitfile looking like
  282.                             this: (TEST.EXT)
  283.  
  284.                                  Aki Antman
  285.                                  Helsinki, Finland
  286.                                  45
  287.                                  290
  288.  
  289.                             Being the full username, city, remaining
  290.                             time online and time of next event.
  291.  
  292.                        Mostly you just use the *C and *S parameters.
  293.                        With multi-node operations, you will need the
  294.                        *N and *P options. Normally the documentation
  295.                        from the program you wish to run will supply
  296.                        the needed information.
  297.  
  298.          The above information was taken right from the BBS Software Docs.
  299.  
  300.          If you are running BBS software other than above, check with
  301.          your BBS Docs, to obtain you Type 7 Data Line parameters.
  302.  
  303.