home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / comm / bbs / 4d-bbsdemo / docs / text / a2.arexx_commands < prev    next >
Text File  |  1993-12-28  |  5KB  |  216 lines
  1. Appendix 2:
  2.  
  3.  
  4.  
  5.               4D-BBS ARexx Command List
  6.  
  7.  
  8. All ARexx commands are run asyncronously while the BBS is running.  Most
  9. commands, but not all, return something.
  10.  
  11. The default 4D-BBS ARexx port is "4D-BBS0", but definable through the /a$
  12. command line parameter.
  13.  
  14. ($ is a string, # is an integer number)
  15.  
  16.  
  17. Command        Description
  18. -------------    ------------------------------------------------------------
  19.  
  20. message $        Send $ to both the main screen and the serial port followed
  21. transmit $    by a line feed/carriage return.
  22. print $
  23.  
  24. sendstring $    Send $ to both the main screen and the serial port.
  25. send $
  26. msg $
  27.  
  28. sendmodem $    Send $ to just the serial, no main screen output.
  29.  
  30. screenout $    Send $ to main screen only
  31.  
  32. sendstatus $    Send $ to the status window, no serial/main output.
  33.  
  34. prompt $        Send $, read in a string from keyboard and serial.
  35. query $
  36.  
  37. hotkey $        Send $, Read in one character keyboard/serial.
  38. getchar $
  39.  
  40. query Y        Will return Y on a return else keypress
  41. query N        will return N on a return else keypress
  42.  
  43. hangup        Immediatley stop & hangup user
  44.  
  45. readfile $    Send $ file to both screen and serial.
  46. sendfile $
  47.  
  48. readgra $        Send $ file, but append .ascii/.ansi depending on mode.
  49.  
  50. cls            Send a clear screen
  51.  
  52. exit            When in ARexx door server mode, tells 4D-BBS door is
  53. shutdown        finished, and to continue.
  54. goodbye
  55. quit
  56.  
  57. getvar #        User/system information:
  58.  
  59.                 1:    Name
  60.                 2:    ""
  61.                 3:    ""
  62.                 4:    City (City, State/Country)
  63.                 5:    State ("")
  64.                 6:    ""
  65.                 7:    Telephone
  66.                 8:    Ansi/Ascii Modem (0=Ascii, >0 = Ansi)
  67.                 9:    ""
  68.                 10:    ""
  69.                 14:    BBS:        Directory
  70.                 15:    Doors:    Directory
  71.                 16:    TEXT:    Directory
  72.  
  73.  
  74. getuser #        User/system information: 
  75.  
  76.                 1:    Name
  77.                 2:    Password
  78.                 3:    High Password ("")
  79.                 4:    City (C, S/C)
  80.                 5:    State ("")
  81.                 6:    Street ("")
  82.                 7:    "Extra"
  83.                 8:    "Extra"
  84.                 9:    "Extra"
  85.                 10:    Phone
  86.                 11:    Last Call (long int)
  87.                 12:    Sysop Comments ("")
  88.                 13:    Main Menu Number (Text: Dir)
  89.                 14:    Reserved ("")
  90.                 15:    Flags (0)
  91.                 16:    Access Level ("1")
  92.  
  93.                 19:  Clear Screen Code?    (Not Implemented)
  94.  
  95.  
  96. userinfo #    User information:
  97.  
  98.                 a:    Name
  99.                 b:    Location (c, s/c)
  100.                 c:    Password
  101.                 p:    Calls
  102.                 w:    Real Name
  103.                 x:    ansi ("ON" or "OFF")
  104.                 v:    Rows    
  105.                 m:    Time Left
  106.                 n:    Time per call
  107.                 
  108.                    0:    Set User access to new
  109.                    1:    Set User access to member
  110.                    2:    Set User access to sysop
  111.                    3:    Set User access to no access
  112.             
  113.                 9:    Validate use to member access
  114.  
  115.  
  116. systeminfo #    User/system information:
  117.  
  118.                 a:    Name
  119.                 i:    Data ("YYMMDD")
  120.                 j:    Time ("HHMMSS")
  121.                 m:    Time Left
  122.                 n:    Time Limit
  123.  
  124.  
  125. getsvar #     Get user information
  126.  
  127.                 1:    Name
  128.                 2:    Password
  129.                 3:    ""
  130.                 4:    Location (c, s/c)
  131.                 7:    Doors: Directory
  132.                 8:    BBS:   Directory
  133.                 9:    Date ("YYMMDD")
  134.  
  135.  
  136. name            Returns users name logged on the BBS.
  137.  
  138. continue        prompts & waits for a key press.
  139.  
  140. checkabort    checks for input by user & returns the keypress or NULL
  141. checkforkey
  142.  
  143. waitchar # #    [seconds] [microseconds] Will wait the specified time for a
  144.             keypress. Returns the keypress or TIMED
  145.  
  146. emulation        Returns ASCII or ANSI
  147.  
  148. checkcarrier    Returns the status of the modem's Carrier Detect signal.
  149.  
  150. bufferflush    Clear the serial i/o buffer.
  151.  
  152. addtime #        Add (or subtract if negative) # from user's on-line time.
  153.  
  154. resetmodem    Send BBS init string to modem.
  155.  
  156. version        Current version of the BBS in "4D-BBS V#.##xx" format.
  157. bbs
  158.  
  159. menu $        Execute a 4D-BBS Menu Command.
  160.  
  161. baud #        Change baudrate to #.
  162.  
  163. loaduser $    Load user $ into the curruser structure. 
  164.             RC = 1 if successful.
  165.  
  166. saveuser $    Save user in curruser structure to $.
  167.             RC = 1 if successful.
  168.  
  169. saydef #        Will print line # from the def_say.t file 
  170.  
  171. changescreen #  Manipulates the screens and windows of 4D-BBS.
  172.                 1-4D-BBS To Front       16-Workbench to Front
  173.                 2-4D-BBS To Back        16-Workbench to Back
  174.  
  175. logged        Will return REMOTE or LOCAL, or NOTLOGGED
  176.  
  177. logon #        Invokes a call to the logon function.
  178.             1-Local  2-Remote
  179.  
  180. boardsopen #    Open message board #
  181.  
  182. transopen #    Open file section #
  183.  
  184. reloadboards $    Reload config file for the Boards
  185.  
  186. reloadfiles $    Reload config file for the Files
  187.  
  188. reloadsystem    Reload system defaults
  189.  
  190. reloadall        Reload all config files
  191.  
  192. readconfigs    Reload config files. Boards, Systems, and dirs.
  193.  
  194. waitscreen    Display the Wait Screen.
  195.  
  196. waitstats        Display the Status Window.
  197.  
  198. systemstatus    Return the system status
  199.  
  200. sysinit        Intialize the system Parameters.
  201.  
  202. checkparam $    Check for single character parameter. RESULT = parameter, 
  203.                        TRUE if Param, No string, and FALSE if no parameter.
  204.  
  205. sendstatus $    Write to the status window
  206.  
  207. messqueue  $    'queue' a message to a user
  208.  
  209. rexxcommand $    Will open a output window & send the command to ARexx
  210.  
  211. rexxscript $    Will open a output window & run the script
  212.  
  213. spawn $        Will execute a ARexx script with out an output window
  214.  
  215.  
  216.