home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / oct93 / comm / 4d-bbsdemo.lha / 4D-BBSDemo / Docs / A2.ARexx_Cmds < prev    next >
Text File  |  1993-07-02  |  5KB  |  162 lines
  1. Appendix 2:
  2.  
  3.  
  4.               4D-BBS ARexx Command List for 4D-BBS V2.86
  5.  
  6.  
  7. All ARexx commands are run Async while the BBS is running. Extra caution
  8. should be taken when sending ARexx commands to the BBS, when the BBS is NOT
  9. in the ARexx door servor. Although problems should not arise from sending
  10. commands Async while not in the ARexx door servor, some commands can cause
  11. data to become garbled, or changed.
  12.  
  13. The default 4D-BBS ARexx port is "4D-BBS", but definable through the /a$
  14. command line parameter.
  15.  
  16. ($ are replaced by a string, # by a number)
  17.  
  18.  
  19. Command         Description
  20. -------------     ------------------------------------------------------------
  21.  
  22. message $       Send $ to both the main screen and the serial port. with \n
  23. transmit $
  24. print $
  25.  
  26. sendstring $    Send $ to both the main screen and the serial port. w/o \n
  27. send $ 
  28. msg $
  29.  
  30. sendmodem $     Send $ to just the serial, no main screen output.
  31.  
  32. screenout $     Send $ to main screen only
  33.  
  34. sendstatus $    Send $ to the status window, no serial/main output.
  35.  
  36. prompt $        Send $, read in a string from keyboard and serial.
  37. query $
  38.  
  39. hotkey $        Send $, Read in one character keyboard/serial.
  40. getchar $
  41. queryY          Will return Y on a return else keypress                      
  42. queryN          will return N on a return else keypress
  43.  
  44. quit            Immediatley Stop & shutdown survor mode.
  45.  
  46. hangup          Immediatley stop & hangup user
  47.  
  48. readfile $      Send $ file to both screen and serial.
  49. sendfile $      
  50.  
  51. readgra $       Send $ file, but append .ascii/.ansi depending on mode.
  52.  
  53. cls             Send a clear screen
  54.  
  55. exit            When in ARexx door servor mode, tells 4D-BBS door is
  56. shutdown        finished, and to continue.
  57. goodbye
  58.  
  59. getvar #        User/system information according to Starnet's standard.
  60. getuser #       User/system information according to Skyline's Standard.
  61. userinfo #      User information according to C-Net/TransAmiga Standard.
  62. systeminfo #    User information according to C-Net/TransAmiga Standard.
  63. getsvar #       
  64.  
  65. name            Returns users name logged on the BBS.
  66.  
  67. continue        prompts & waits for a key press.
  68.  
  69. checkabort      checks for input by user & returns the keypress or NULL
  70. checkforkey 
  71.  
  72. waitchar # #    [seconds] [microseconds] Will wait until the time
  73.                 past or a keypress. Returns the keypress or TIMED
  74.  
  75. emulation       Returns ASCII or ANSI
  76.  
  77. checkcarrier    Tells whether user dumped or not.
  78.  
  79. bufferflush     Clear the serial i/o buffer.
  80.  
  81. addtime #       Adds (or subtracts if negative) # from users on-line time.
  82.  
  83. resetmodem      Sends the init string defined in the system editor.
  84.  
  85. version         Current version of the BBS in "4D-BBS V#.##xx" format
  86. bbs
  87.  
  88. menu $          Execute a 4D-BBS Menu Command.
  89.  
  90. baud #          Change baudrate to #.
  91.  
  92. loaduser $      Load user $ into the curruser structure. 
  93.                 RC = 1 if successful.
  94.  
  95. saveuser $      Save user in curruser structure to $.
  96.                 RC = 1 if successful.
  97.  
  98. saydef #  Will print the string from the def_say.t file 
  99.  
  100. changescreen #  Manipulates the screens and windows of 4D-BBS.
  101.                 1-ScreenToFront         10-ActivateStatus
  102.                 2-ScreenToBack          11-StatusToFront
  103.                 3-MoveScreen            12-StatusToBack
  104.                                         13-MoveStatus
  105.                 4-ActivateMain          14-SetStatusTitle
  106.                 5-MainToFront           15-StatusIDCMPFlags
  107.                 6-MainToBack
  108.                 7-MoveMain              16-WBenchToFront
  109.                 8-SetMainTitle          17-WBenchToBack
  110.                 9-MainIDCMPFlags        18-Dragable Screen *
  111.                                         19-Interlace Screen *
  112.                                         20-HiRes Screen *
  113.                                         21-WBench Screen *
  114.                                         22-Custom Screen *
  115.                                         
  116. * Not implimented yet                                        
  117.  
  118. iconify         Iconify
  119.  
  120. logged          Will return REMOTE or LOCAL
  121.  
  122. logon #         Invokes a call to the logon function.
  123.                 0-Not Logged   1-Local  2-Remote   3-Terminal
  124.  
  125. boardsopen #    Open message board
  126.  
  127. transopen  #    Open file section
  128.  
  129. reloadboards    Reload config file for the Boards
  130.  
  131. reloadfiles     Reload config file for the Files
  132.  
  133. reloadsystem    Reload system defaults
  134.  
  135. reloadall       Reload all config files
  136.  
  137. readconfigs     Reload config files. Boards, Systems, and dirs.
  138.  
  139. waitscreen      Display the Wait Screen.
  140.  
  141. waitstats       Display the Wait Status Screen.
  142.  
  143. systemstatus    Return the system status
  144.  
  145. sysinit         Intialize the system Parameters.
  146.  
  147. checkparam $    Check for single character parameter. RESULT = parameter, 
  148.                        TRUE if Param, No string, and FALSE if no parameter.
  149.  
  150. sendstatus $    Write to the status window
  151.  
  152. messqueue  $    'queue' a message to a user
  153.  
  154. rexxcommand $   Will open a output window & send the command to ARexx
  155.  
  156. rexxscript  $   Will open a output window & run the script
  157.  
  158. spawn $         Will execute a ARexx script with out an output window
  159.  
  160.  
  161.    
  162.