home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / comm / bbs / 4d-bbsdemo / docs / text / 03.getting_started < prev    next >
Text File  |  1993-12-28  |  20KB  |  522 lines
  1. Chapter 3:  Getting Started
  2.  
  3.  
  4.  
  5.  
  6. 3.1 Command Line Parameters (CLP)
  7.  
  8.     4D-BBS uses command line parameters (CLP) to allow you to customize
  9. its behavior to suit your needs right from startup!  CLPs are arguments
  10. used in normal DOS commands.
  11.  
  12.     4D-BBS also uses a configuration file that imitates the CLPs, however
  13. a CLP will always override the setting of the configuration file.
  14.  
  15.     All parameters are preceeded with a "/" or "-" and should be spaced
  16. apart BETWEEN THE PARAMETERS.  NO spaces should be between the "/" or "-"
  17. and the actual command itself.  CLPs CAN NOT be stacked by using a single
  18. "/" or "-" with multiple commands.
  19.  
  20.     A "#" following a CLP should be replaced by a numerical value, and a
  21. "$" should be replaced by a character string.  The "!" following a CLP
  22. indicates the CLP is a switch.  A blank or a "0" following the CLP is
  23. considered off, while a "1" is considered on.
  24.  
  25.     In the event a space is needed for a parameter, enclose JUST that
  26. parameter including the "/" or "-" within quotation marks.  The commands
  27. ARE case sensitive.
  28.  
  29. 3.1.1 CLP Descriptions
  30.  
  31.     CLP DESCRIPTION
  32.  
  33.     A!  Enter ARexx Port Server Mode, Wait for Commands
  34.  
  35. Brings the BBS up in WAIT mode and does NOT monitor the serial port.  This
  36. mode is used mainly as an ARexx server.  (Refer to Chapter 10.)
  37.  
  38. Example:  4D-BBS -A
  39.  
  40.     a$ ARexx Port Name
  41.  
  42. Allows you to change the base ARexx port name created when 4D-BBS is
  43. started up.  All ARexx doors and scripts should address this name if you
  44. want 4D-BBS to recognize the commands.  (Refer to Chapter 10.)
  45.  
  46. Example:  4D-BBS -aARexxName
  47.  
  48.     B# True Baud Rate of "/o" Call
  49.  
  50. Lets 4D-BBS know the true baud rate if different than the serial baud rate.
  51. Used for login and transfer time calculations.  This command only has an
  52. affect when used with the "b" CLP.
  53.  
  54. Example:  4D-BBS -o1 -b19200 -B2400 Range:  300-115,200
  55.  
  56.     b# Lock the Serial Baud Rate
  57.  
  58. Allows 4D-BBS and your modem to send information at a fixed serial rate.
  59. This is only needed for modems which have data compression capabilities.
  60. (Refer to Chapter 12.)
  61.  
  62. Without "/o" CLP:  Lock Serial Port at rate With "/o" CLP:  Serial Baud
  63. rate for call
  64.  
  65. Example:  4D-BBS -b38400 Range:  300-115,200
  66.  
  67.     C# Number of Last Callers Saved
  68.  
  69. Allows you to set the number of callers saved to the file "BBS:lastcall.t".
  70. If you have low memory try to keep this number as low as possible.
  71.  
  72. Example:  4D-BBS -C10 Range:  1-30
  73.  
  74.     c# Number of Bitplanes to Use (Colors = 2^#)
  75.  
  76. If you have low memory, run multiple lines, or are running on an
  77. unaccelerated Amiga, use "1" or "2" here not only to save memory, but to
  78. speed up the BBS.  This setting has NO affect on the user's color, as they
  79. will see the full set of colors.
  80.  
  81. Example:  4D-BBS -c2 Range:  1-4 (2-16 colors)
  82.  
  83.     D$ Filename of Directories Data File
  84.  
  85. A data file containing a list of alternative paths for 4D-BBS to use.  The
  86. order of the paths or assigns is as follows:
  87.  
  88. BBS Path or Assign FILE Path or Assign MENU Path or Assign TEXT Path or
  89. Assign USERS Path or Assign BOARDS Path or Assign DOORS Path or Assign
  90.  
  91. Example:  4D-BBS -DBBS:AltPaths.Dat
  92.  
  93.     d# Hang-up Behavior of BBS
  94.  
  95.         0:  Don't do anything to hang-up (used in a spawn mode)
  96.         1:  Drop DTR to hang up modem
  97.         2:  Use "+++,,,ATH" to hang-up modem
  98.  
  99.         Example:  4D-BBS -d1
  100.  
  101.     f$ Font to Use with 4D-BBS
  102.  
  103. You can use just about any font you wish with 4D-BBS.  It will look in your
  104. "FONTS:" directory and append the ".font" on the end if it is not already
  105. there.  If the requested font is already open in RAM, it will use it.  If
  106. not, it will open your diskfont and use it.
  107.  
  108. Example:  4D-BBS -fGraphics.font
  109.  
  110.     G$ Configuration File to Use
  111.  
  112. Instead of using the default "S:4D.Config" file, you can specify an
  113. optional file for 4D-BBS to get its configuration settings from.  The FULL
  114. path must be given.
  115.  
  116. Example:  4D-BBS -GS:4D2.config
  117.  
  118.     h!  Reset to System High Baud After Every Caller
  119.  
  120. This is mostly used in conjunction with the other serial and baud related
  121. CLPs.  When the BBS is running in continuous answer modem, it will reset
  122. BACK to the system high baud after each call when this parameter is given.
  123. Normally it will stay at the last caller's baud rate, until another call at
  124. a different baud rate comes in.
  125.  
  126. Example:  4D-BBS -h1
  127.  
  128.     H!  Hide Screen and Don't Make Active when Starting
  129.  
  130. Tells 4D-BBS to open its custom screen in the back, and NOT make it the
  131. active screen.  Normally used with "/o1" when being spawned by another
  132. program.
  133.  
  134. Example:  4D-BBS -H1
  135.  
  136.     I!  Open 4D-BBS in Iconified Mode Instead of Full Screen
  137.  
  138. This is a very handy memory saving option.  The user receives a slightly
  139. faster response time as local screens and windows are not updated.  A small
  140. title bar will appear to give you system status reports including on-line
  141. users name and their activity.  You can un-iconify 4D-BBS by quickly
  142. clicking the left then right mouse buttons while pointing in the small
  143. window.  The close gadget will completely shutdown the BBS, so be careful
  144. when using it.
  145.  
  146. Example:  4D-BBS -I
  147.  
  148.     K!  Turn Keyboard Input Off when 4D-BBS is Started
  149.  
  150. Allows you to switch off normal keyboard input, the AMIGA key commands, and
  151. function keys.  Your mouse or an ARexx script is the only way to turn
  152. keyboard input back on.
  153.  
  154. NOTE:  If you use the CLP of "-M" to switch your pull down menus OFF to
  155. save memory and do not have an ARexx script to turn your keyboard back ON
  156. 4D-BBS will not recognize keystrokes.  Use the option in "Defs" pull down
  157. menu to toggle this option.
  158.  
  159. Example:  4D-BBS -K1
  160.  
  161.     L# Number of Screen Lines to Use
  162.  
  163. Sets the number of displayable lines to the SysOp.  If your screen/window
  164. is not large enough 4D-BBS will increase the size.  A number greater than
  165. 32 will cause an interlaced screen to be opened.
  166.  
  167. Example:  4D-BBS -L50 Range:  20-60
  168.  
  169.     M!  Disable Pull-Down Menus
  170.  
  171. Saves memory by disabling the pull-down menus.  You cannot use the
  172. pull-down menus or the AMIGA keys if you set this CLP.  The function keys
  173. will NOT be disabled.
  174.  
  175. Example:  4D-BBS -M1
  176.  
  177.     m$ Replacement File for BBS:Modem.dat
  178.  
  179. In the event that you are running multiple modems, allows you to use a
  180. different modem data file without editing the same file for each change of
  181. modem.  Can also be used in a multi-line situation, when different modems
  182. are being used.  Will only be in effect is auto-detect is enabled in the
  183. configuration editor.
  184.  
  185. Example:  4D-BBS -mBBS:ModemUSR.dat
  186.  
  187.     N$ Forced User Name if Using "/o"
  188.  
  189. The string following N will be used as the user name, and the user will not
  190. be prompted for one.  The CLP "-P" is normally associated with this
  191. command.  If BOTH "-N" and "-P" are given with the "/o1" or "/os" CLP, and
  192. the name or password is incorrect, 4D-BBS will quit returning an error
  193. code.  If just "-N" and "/o1" or "/os" is given the user will be prompted
  194. for a password.  If the password is given incorrectly three times, 4D-BBS
  195. will quit returning an error.
  196.  
  197. In the event the BBS is spawned from another program (i.e.  the BBS is not
  198. responsible for responding to the phone line) a script can be written to
  199. automatically log you into the BBS using the "/os", "-N" and "-P"
  200. parameters.  This will function as pressing F10 for the SysOp local logon
  201. from the BBS wait screen.
  202.  
  203. If the user name contains a space in it, surround just this CLP with double
  204. quotation marks.
  205.  
  206. Example:  4D-BBS -os "-NJohn Doe" "-Pjane"
  207.  
  208.     o!  Logon Once Remote, Without a Waiting Screen
  209.     os Logon Once Local, Without a Waiting Screen (can also be -o2)
  210.  
  211. This is mainly used by a network front end program to call up 4D-BBS when a
  212. carrier is present.  4D-BBS will send the opening logon screen, and act as
  213. if it had responded to the phone.  Once the call is complete, the BBS will
  214. shut down, and return control to the calling program.
  215.  
  216. For a remote spawn, the calling program will need to pass the "-b" CLP to
  217. tell 4D-BBS what serial rate to use.  The "-B" CLP should also be passed to
  218. tell 4D-BBS what the true carrier rate is.
  219.  
  220. For a local spawn ("/os") 4D-BBS will not actually open the serial port.
  221. The serial I/O will not checked during the session, but everything else
  222. will function as a normal call.  (Refer to Chapter 14 for more information
  223. on Networking.)
  224.  
  225. Example:  4D-BBS -o1 -b19200 -B14400
  226.  
  227.     P$ Forced User Pa