home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / citadel / k2ne603c.zip / CITGUIDE.ZIP / PARAMS.TXT < prev   
Text File  |  1991-11-24  |  8KB  |  156 lines
  1. /*
  2.  * PARAMS.TXT
  3.  *
  4.  *     Date:  24 November 1991
  5.  * Audience:  Citadel:K2NE Sysops and wannabes
  6.  *  Purpose:  A description of each of the command-line paramaters
  7.  *            usable with CTDL.EXE as distributed by K2NE Software
  8.  *            in connection with the Citadel:K2NE Bulletin Board
  9.  *            software.  Citadel:K2NE is a PUBLIC DOMAIN release.
  10.  */
  11.  
  12. Parameter     Effect
  13. --------------------
  14. asdoor
  15.               Tells Citadel that it is being run "as a Door" from
  16.               another program.  Behavior is, at best, unpredictable.
  17.  
  18. bink
  19.               Tells Citadel that it has been called from a "front-end"
  20.               such as BinkleyTerm.  When this parameter is used, the
  21.               modem initialization routines are completely bypassed,
  22.               and when the caller logs out, control is passed back to
  23.               the supervisory batchfile with an exit-level of 0.  It is
  24.               up to you to construct your batchfile(s) to properly handle
  25.               this.
  26.  
  27. lock
  28.               Using this parameter will cause Citadel to ask for "Username"
  29.               instead of bringing the caller to the "BaseRoom>" prompt
  30.               when carrier is detected.  When this parameter is used,
  31.               the caller is prompted for name, then password, and if
  32.               the process fails, the caller is asked if he wants to apply
  33.               for an account.  After the number of attempts at logging
  34.               in specified by the #LOGTRY parameter (in CTDLCNFG.SYS) are
  35.               exceeded, Citadel will hang-up on the caller.
  36.  
  37. private
  38.               Same as "lock" however the caller is not given the option
  39.               of applying for a new account.  This is for systems where
  40.               tight security is desired.  Accounts must be "pre-created"
  41.               by the sysop at the console.
  42.  
  43. netonly
  44.               Brings up Citadel to ONLY accept an incoming call if it
  45.               is a networking call.  Sends a "We are in networking" type
  46.               of message to "human" callers.
  47.  
  48. noluck=n
  49.              The number specified by n is the numeric code that your
  50.               modem returns when you call out and get a BUSY signal.
  51.               Most "Hayes-type" modems return a 7 in that case.  This is
  52.               used during networking.
  53.  
  54. doormin=n
  55.               The number specified by n is the number of minutes that your
  56.               callers are permitted to spend in any given "door" program.
  57.               This is NOT a "session limit" for doors.  Note, if this
  58.               parameter is missing DOORS WILL NOT WORK.  Also, minimum
  59.               value is 10.
  60.  
  61. rings=n
  62.               The value of n is the number of rings before Citadel will
  63.               tell your modem to answer the line.  If this parameter is
  64.               not used, then your modem MUST be capable of ring-counting
  65.               and auto-answering on its own.  If you use this parameter,
  66.               then you should tell your modem to ignore rings by using
  67.               the appropriate modem command (ATS0=0 for Hayes) in the
  68.               #modemSetup command (CTDLCNFG.SYS).
  69.  
  70. dead=x,y
  71.               This controls the AnytimeNet dial-out timeframes. The
  72.               value of x determines how long Citadel will wait between
  73.               calls before attempting an AnytimeNet session.  The value
  74.               of y determines the length of the session.  Both values
  75.               are in minutes.
  76.  
  77. color=x,y
  78.               This sets up the colors for the text and screen at Console
  79.               when #ANSICONSOLE is set to 0 in CTDLCNFG.SYS.  Note that
  80.               this option MAY not be available beginning with release
  81.               version 6.02 or newer.
  82.  
  83. coltb=a,b,c,d,e
  84.               Param "coltb=a,b,c,d" added to control ANSI color assignment.
  85.               The assignment levels are (roughly) as follows:
  86.                 a: message texts, system announcements and major (non-room)
  87.                    prompts particularly for nonexpert users, one of the
  88.                    introductory (optional logtext.00#) files
  89.                 b: the console standby screen (FKEYS.BLB), mail> notification
  90.                    at login, display of rooms with new messages, expanded
  91.                    descriptions in file directories, message headers, most
  92.                    of the help files, room prompts for mail> and aide>,
  93.                    known hidden rooms.
  94.                 c: HELPOPT.HLP when called by ".h?", terse file directory
  95.                    listings, all room prompts except for mail> and aide>,
  96.                    list of known directory rooms (.kd), nodes on the net (.m),
  97.                    known public rooms, rooms with no new messages.
  98.                 d: Known zapped/forgotten rooms.
  99.                 e: Color of FKEYS.BLB (if present)
  100.               Experiment here to find something that looks good on your
  101.               monitor.  Usage is as follows:
  102.  
  103.               The letters (a, b, c, and d) should be replaced with SINGLE DIGIT
  104.               numbers in accordance with the following color-code assignment:
  105.                        0=BLACK     1=RED        2=GREEN    3=BROWN
  106.                        4=BLUE      5=MAGENTA    6=CYAN     7=WHITE
  107.               These are the ONLY permissable values for this parameter.
  108.               A typical example use of the parameter might be "coltb=2,1,4,5,2",
  109.               which is, incidentally, the DEFAULT setting if you leave this
  110.               parameter out.  This parameter controls the colors you, as well
  111.               as the modem user, will see (provided you use the #ANSICONSOLE
  112.               value of 1 (in CTDLCNFG.SYS) to activate ANSI color for your console
  113.               and provided, obviously, that the caller has set his ANSI flag ON
  114.               using the ".ECG" command in his user configuration).
  115.  
  116. altlink=name
  117.               String used as "name" will be placed into the NameField of a
  118.               message integrated from an alternate network.  See notes
  119.               that accompany CITAGATE for more details.  This should NEVER
  120.               be used as a parameter in your normal operation, but ONLY
  121.               in conjunction with the CITAGATE utility.
  122.  
  123. noringer
  124.               Turns off the computer speaker sound-effect when the modem
  125.               line rings.
  126.  
  127. nonoise
  128.               Turns off the "exploding windows" sound effects.
  129.  
  130. +noinit
  131.               Brings up Citadel normally but WITHOUT modem initialization.
  132.               Assumes a user is already online.  This is usually used
  133.               after a user returns from a "door."
  134.  
  135. +doors
  136.               Same as "+noinit" BUT forces Citadel to a special exitlevel
  137.               (ERRORLEVEL 8) so that you can use an external program to
  138.               reboot your machine.  This was used with earlier versions
  139.               of Citadel (pre-FOSSIL) that had a problem hanging up the
  140.               phone properly after some doors were used.  You should not
  141.               have to use this with V6.01 or newer, but it is available
  142.               "just in case."
  143.  
  144. +recover
  145.               Using this parameter will cause Citadel to generate a message
  146.               into the Aide> room stating that the system crashed and that
  147.               the date/time of the message was the date/time of the crash.
  148.               See the sample RUNBBS.BAT file that comes with the full release
  149.               filesets for an example of how to use this.
  150.  
  151. CAUTION:  You should use ONLY the BARE MINIMUM number of parameters to support
  152.           your use of the BBS.  Remember that DOS places a limit on the
  153.           length of a command-line, and also that strange things happen
  154.           with more than nine parameters.  You can use more than nine, but
  155.           you first had best be an expert in the use of the BATCH "shift"
  156.           command.