home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / demos / program / excelbbs.lha / excelsiorbbs / TEXT / HELP.IPL < prev    next >
Encoding:
Text File  |  1993-01-10  |  7.0 KB  |  166 lines
  1. \f1\c1EXCELSIOR! \c7BBS  (Online User Help Manual)
  2.  
  3. \z4\c7TOPIC:\q1   IPL
  4.  
  5.      IPL (Intuitive Programming Language) allows you to "insert" certain
  6. sequences into text for the system to interpret.  EXCELSIOR will recognize a
  7. "\\" as the beginning of the Sequence Introducer.  The majority of the commands
  8. use an identifier, usually a single character, followed by an offset value. In
  9. the text below, the offset value is denoted by the letter x.  Replace this
  10. letter with the appropriate value located under DESCRIPTION.
  11.    Some commands are for users with SysOp access only.  Users without Sysop
  12. Access can only read "already created" commands, they will not be able to 
  13. create new ones.  These commands are denoted by the asterisk (*).
  14.    These commands are found as a standard on other systems, we have kept to
  15. this standard thus allowing for some compatibility between systems: 
  16.  
  17. IDENTIFIER         Description  
  18. =-=-=-=-=-         =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  19.    @x              Set IPL Variable Setting
  20.                           0  =  CANCEL ALL Settings
  21.                           1  =  Do not interpret commands (PRINT ALL CODES)
  22.                           2  =  Disable WORD-WRAP
  23.                           4  =  Disable MORE-PROMPT
  24.                           8  =  Disable SysOp-Only IPL Commands 
  25.  
  26.                    (NOTE: These variables will be reset as soon as the system
  27.                           reaches a command prompt)
  28.  
  29.    Ax              Disable message aborting
  30.  
  31.    Bx              Print x bells (DisplayBeep() on local console)
  32.  
  33.    Cx              Change the cursor color to:
  34.                           0  =  Black       4  =  Blue
  35.                           1  =  Red         5  =  Purple
  36.                           2  =  Green       6  =  Cyan  
  37.                           3  =  Yellow      7  =  White
  38.  
  39.    Dx              After a failed test operation, jump to label "x"
  40.  
  41.    Ex              After a successful test operation, jump to label "x"
  42.  
  43.    Fx              Screen Manipulation, move cursor to:
  44.                           0  =  Home position
  45.                           1  =  Home position and clear screen
  46.  
  47.    Gx              Wait for a single key to be entered, store it in IPL 
  48.                    Variable "x"
  49.  
  50.    Hn              Print x backspaces
  51.  
  52.    Ix              Input an entire line (limit 78 chars).  Store the line in
  53.                    IPL Variable "x"
  54.  
  55.    Jx              Jump to label "x".
  56.  
  57.    Kx              Toggle Kolorific mode (0 = Off / 1 = On).
  58.                    Will change text color each time a character is printed.
  59.  
  60.    Mx              Defines label "x".  This is used for tests(D,E) & jumps(J).
  61.                    NOTE:  Labels can only be located after the "GO TO" command
  62.  
  63.    Nx              Print x newlines
  64.  
  65.    Ox              Set BOLD Text (ANSI)
  66.  
  67.    Px              Change PrintMode to #x
  68.                           0  =  Standard
  69.                           1  =  Stack letters on top of one another
  70.                           2  =  Print Upward
  71.                           3  =  Print Downward
  72.                           4  =  Print Backward
  73.  
  74.    Qx              IPL Setting Mode:
  75.                           0  =  Re-send all current ANSI settings
  76.                           1  =  Cancel all settings and use default color
  77.  
  78.    Rx              Set Reverse Mode:
  79.                           0  =  Off
  80.                           1  =  On
  81.  
  82.    Sx              Pause between each character.  (x = 1/50 second)
  83.  
  84.    Tx<v>\           Test a variable for equality.  This command must be ended by
  85.                    an EOL (end of line) or another "\".  <v> = equals the
  86.                    test string.  Note it will test up to the length of <v>.
  87.  
  88.                         0-4  =  IPL Variable 0-4
  89.                           5  =  AccessGroup (use 00-32)
  90.                           6  =  SysOp Access (0=False / 1=True)
  91.                           7  =  Terminal Type  (0=Ascii / 1 = ANSI)
  92.                           8  =  Max Columns  (23-80)
  93.                           9  =  Expert Level (0=False / 1=True)
  94.  
  95.    Ux              Set underline mode
  96.                           0  =  Off
  97.                           1  =  On
  98.  
  99.    Vx              Display a system variable.  Insert response into text
  100.                           0  =  Current Date & Time
  101.                           1  =  User's Last Call (Date & Time)
  102.                           2  =  User's Alias
  103.                           3  =  User's Real Name
  104.                           4  =  User's Phone Number
  105.                           5  =  User's Password
  106.                           6  =  User's AccessGroup name
  107.                           7  =  Afternoon, morning, evening (where time is
  108.                                 appropriate)
  109.                           8  =  Total number of system's calls
  110.                           9  =  User's Street Address
  111.                           a  =  User's City & State
  112.                           b  =  User's ZipCode or Postal Code
  113.                           c  =  Time user has remaining for this call
  114.                           d  =  Total number of calls user has made
  115.                           e  =  Number of downloaded files
  116.                           f  =  Number of uploaded files
  117.                           g  =  Number of downloaded bytes
  118.                           h  =  Number of uploaded bytes
  119.                           i  =  Number of posts
  120.                           j  =  NOTHING.  Added for compatibility
  121.                           k  =  File credits available
  122.                           l  =  Byte credits available
  123.                           m  =  User's FIRST name
  124.                           n  =  User's LAST name
  125.                           o  =  Current sub-board number
  126.                           l  =  Current sub-board name
  127.  
  128.    Wx              Wait for x seconds to pass
  129.  
  130.    Yx              Display IPL Variable "x"
  131.  
  132.    Xx              Immediatedly exit message
  133.  
  134.    Zn              Change background color, use same colors as command "C"
  135.  
  136.    &0<cmd>\         Execute a "global command", where <cmd> = the command.
  137.  
  138.    ^x              Move cursor up x lines
  139.  
  140.    !x              Move cursor down x lines
  141.  
  142.    >x              Move cursor right x columns
  143.  
  144.    <x              Move cursor left x columns
  145.  
  146.    -x              Insert x characters at current position
  147.  
  148.    \\\\              Actually print a single slash "\\"
  149.  
  150.    ?x              Wait for a Yes/No.  Defaults when a return is pressed to:
  151.                           0  =  No (FALSE)
  152.                           1  =  Yes (TRUE)
  153.  
  154. *  *x<file>\\       Prints file "<file>".  X can equal any of the values for
  155.                    the '@' command.  SysOp only.
  156.  
  157. *  #x<file>\\       Spawn a door program.  Where <file> is the complete path
  158.                    and filename.  SysOp only.
  159.                           x  =  0   Shared access ARexx file.
  160.                           x  =  1   Exclusive access ARexx file.
  161.                           x  =  2   Shared access 'C' file.
  162.                           x  =  3   Exclusive acess 'C' file.
  163.  
  164. *  $0<file>\\       Executes an AmigaDOS command.  The command is <file>.
  165.                    SysOp only.
  166.