home *** CD-ROM | disk | FTP | other *** search
/ Merciful 1 / Merciful - Disc 1.iso / software / c / c-net_pro / c-netprov3.03a.dms / in.adf / cnet / systext / systext.LHA / help / MCI < prev    next >
Encoding:
Text File  |  1994-01-04  |  10.3 KB  |  224 lines

  1. The Message Command Interpreter (MCI) is one of C-Net's more powerful features. It allows users to insert "command sequences" directly into messages to be interpreted by the system when the message is later read. These commands include changing colors, moving the cursor, and many other useful utilities.
  2.  
  3. In CNet/3, MCI commands begin with CONTROL-Q.  When you press CONTROL-Q in the editor, CNet will print the character {.  Immediately following this, you must place the desired MCI command character, then the appropriate arguments, ending the command with the character }. For example, {c1} will change the text output color to Red.
  4.  
  5. In order to maintain some visual continuity with older versions of CNet, you may optionally use the CONTROL-Y key to display a special character \. Following the \ character, you MUST place a command letter and an argument character.  For example, instead of {c1}, ^c1 can be used to change the text output color to Red.
  6.  
  7. NOTE:  Remember that the { and \ characters in MCI commands are produced using the special keys CONTROL-Q and CONTROL-Y, NOT the actual \ and { keys on the keyboard!
  8.  
  9. Access to MCI commands is divided into three categories: SYSOP ONLY, LEVEL 1, and LEVEL 2.  Commands which are level 2 or SYSOP ONLY are marked with a (+) in the following descriptions.  If you do NOT have access to a particular command, the command will be entered into the message exactly as you have written it, and will not be "interpreted" by the system.
  10.  
  11. Following are the MCI commands:
  12.  
  13.   {@n}      Set MCI environment variables
  14.             n= 0  reset MCI environment settings (except n=8)
  15.             n= 1  disable further MCI interpretation (all codes PRINTED)
  16.             n= 2  disable word wrap-around
  17.             n= 4  disable the More? pause temporarily
  18.             n= 8  disable sysop-only MCI commands (cannot be reset)
  19.             n=32  ENABLE SkyPix pseudo-ANSI commands
  20.             n=64  DISABLE Text Translation (use when sending system-
  21.                   specific text files, like C64/128 screens).
  22.                   Screen output, MCI, and ALL formatting is suppressed.
  23.  
  24.             To set multiple items, add their values ( for 1,2,4, use 7 ).
  25.             All codes are reset at the end of the current file or message.
  26.  
  27.   {:n}      Set the automatic indentation of text
  28.             n= 0  disable indentation altogether
  29.             n= 1  return to default indentation (sysop defined)
  30.             n= 2  set indentation to occur at the current cursor position
  31.  
  32.   {.n}      TAB to column n on the CURRENT LINE.  Useful for lining up
  33.             output which contains invisible MCI.
  34.  
  35. + {An}      Disable message abortion using the SpaceBar or the / key
  36.  
  37.   {Bn}      Print n Bells (beeps)
  38.  
  39.   {Cn}      Change the cursor color to #n.
  40.             0=black    1=red     2=green      3=yellow    4=blue
  41.             5=purple   6=cyan    7=white
  42.  
  43.             Color codes 8,9,a,b,c,d,e, & f are INTENSE versions of the first
  44.             8 ... visible on 16 color terminals only.
  45.  
  46.   {F0}      Move cursor to home position
  47.   {F1}      Move cursor to home position and clear screen
  48.  
  49. + {Gn}      Wait for a key press.  The key will be placed into MCI string
  50.             variable n (70+n).
  51.  
  52.   {Hn}      Print n backspaces
  53.  
  54. + {In m}    Input a line.  The result will ALWAYS be placed into variable 70.
  55.             n=input options ... (may be summed)
  56.             n=     1   all caps
  57.             n=     2   FILENAME ... don't allow =:;"/*
  58.             n=     8   chop leading spaces
  59.             n=    16   force 1st letter of each word uppercase
  60.             n=    32   force all others letters lower case
  61.             n=    64   numeric input only
  62.             n=   128   print input box (.)
  63.             n=   256   allow MCI control-A/C
  64.             n=   512   HANDLES ... don't allow ^_`{|}~@
  65.             n= 16384   Don't allow spaces
  66.             n= 32768   Don't allow cursor movement
  67.  
  68.             m=length of input (default is 40).
  69.  
  70.   {JA n}    Jump to label #n unconditionally
  71.   {JE n}    Jump to label #n if last TEST was EQUAL.
  72.   {JG n}    Jump to label #n if GREATER THAN.
  73.   {JL n}    Jump to label #n if LESS THAN.
  74.   {JN n}    Jump to label #n if NOT EQUAL.
  75.  
  76.             By specifying a label which does not EXIST, it is possible to
  77.             effectively EXIT the message.
  78.  
  79.   {n}       An MCI command which consists only of a NUMBER is a LABEL.
  80.             LABELS are used to "mark a spot" in a message. LABELS are used
  81.             with the MCI "Jump" commands above.
  82.  
  83.             It is legal to jump "backward" to the 20 most recent labels.
  84.             The reverse branching will only be effective when the message
  85.             is READ FROM DISK, and will not occur when reading the message
  86.             in an editor.
  87.  
  88.             By placing the special character + after the label number (like
  89.             {JA 2+}, it is possible to force CNet to only branch forward.
  90.             This is useful in situations where you re-use the same label
  91.             number.
  92.  
  93.   {Kn}      Kolorific mode on/off.  When enabled, the text color will be
  94.             changed automatically as each character is printed.
  95.  
  96. + {Ln m}    Load the variable specified by 'n' with contents of 'm'.
  97.             n and m may be any legal GETUSER specifications.  m may also
  98.             be a "literal" by placing the special character # before text
  99.             or numbers.
  100.  
  101.             {L60 61}    Copy contents of register 1 into 0
  102.             {L21 #100}  Set user's game points to 100
  103.  
  104.             Use EXTREME caution with this command.  Memory can easily be
  105.             corrupted to the point of system failure if used indiscriminately.
  106.  
  107. + {Mn x..}  Perform MATH functions on the variable specified by n.
  108.             This MCI command can be used to add, subtract, multiply, divide,
  109.             and mod (find remainder).  Arguments may be variables, literals,
  110.             or one of the special characters +, -, /, *, or %.
  111.  
  112.             Arguments must be entered in RPN, Reverse Polish Notation. That
  113.             is, specify the operands, and THEN the operators.
  114.  
  115.             {M60 #1 +}       Add 1 to MCI register 0
  116.             {M60 24 #3 / +}  Add a third of the current CPS rate to reg 0
  117.  
  118.             Calculate your gas mileage without leave the editor!
  119.  
  120.   {Nn}      Print n NewLines
  121.  
  122.   {On}      Set FLASHing text (Commodore C/G) or BOLD text (ANSI)
  123.  
  124.   {Pn}      Set Print Direction
  125.             n=0 normal printing
  126.             n=1 print each character, backspace, then the character again
  127.             n=2 print upward
  128.             n=3 print downward
  129.             n=4 print backwards
  130.  
  131.   {Q0}      Re-send all current ANSI settings
  132.   {Q1}      Cancel all active MCI modes (colors/printmodes, etc).
  133.   {Q2}      Remember current ANSI settings
  134.   {Q3}      Recall last remembered ANSI settings
  135.  
  136.   {Rn}      Set REVERSE video on/off
  137.  
  138. + {Sn}      Set the number of 1/50 seconds to pause between characters
  139.  
  140. + {Tn m}    Test a variable or literal against another.  Results may be
  141.             interpreted using the {J} commands.
  142.  
  143.             n and m may be any legal GETUSER specification, as detailed
  144.             under the {V} command.
  145.  
  146.             In addition, you may specify "literal" text or numbers by
  147.             using the special character #.
  148.  
  149.             {T60 61}  Compare the MCI numeric register 0 with register 1.
  150.             {T60 #1}  Compare the MCI numeric register 0 to the number '1'
  151.             {T70 #Y}  Compare the MCI string register 0 with "Y"
  152.  
  153.             When comparing strings, variables are compared case-insensitive.
  154.             Also, the special character ' may be used IN PLACE of # to
  155.             determine whether one variable appears within (instr()) another,
  156.             instead of strict equality.
  157.  
  158.   {Un}      Set underline mode on/off
  159.  
  160. + {Vn s}    Display a system variable
  161.             n may be any valid GETUSER specification.  The special numbers
  162.             60-69 correspond to the MCI numeric registers.  The special
  163.             numbers 70-74 correspond to the MCI string registers.  See the
  164.             CNet manual for a complete list.
  165.  
  166.             If the optional argument 's' is specified, it must be of the
  167.             form %n.ms ... a 'C' style format command.
  168.  
  169.             alternately, 's' may be the special character 'c' followed
  170.             by a field width.  The variable will be displayed CENTERED
  171.             within a field of spaces of the specified width.
  172.  
  173. + {Wn}      Wait for n seconds to pass
  174.  
  175. + {XM n}    Replace MCI character register 0 (70) beginning with its nth
  176.             character. Similar to BASIC MID$()
  177. + {XL n}    Replace MCI character register 0 with its leftmost n characters.
  178.             Similar to BASIC LEFT$()
  179. + {XR n}    Replace MCI character register 0 with its rightmost n characters.
  180.             Similar to BASIC RIGHT$()
  181. + {XP}      Replace MCI character registers 0 and 1 with the PARSED version
  182.             of MCI character register 0.  Text is parsed at the first space.
  183. + {XS}      Store the SIZE (strlen()) of MCI character register 0 into
  184.             MCI numeric register 0 (60).
  185.  
  186.   {Zn}      ANSI users, change Background color to n (same as C colors)
  187.  
  188.   {^n}      Move cursor up n lines
  189.  
  190.   {!n}      Move cursor down n lines
  191.  
  192.   {>n}      Move cursor to the right n spaces
  193.  
  194.   {<n}      Move cursor to the left n spaces
  195.  
  196.   {-n}      Insert n characters at cursor point
  197.  
  198. + {*n f}    Display file with path/name given by f.
  199.             'n' will be OR'ed with the current MCI environment (see '@').
  200.  
  201. + {#n f}    Run a program file with path/name given by f.
  202.             n=0 for a AREXX   program, n=1 for AREXX   w/exclusive access
  203.             n=2 for a CNet C  program, n=3 for C       w/exclusive access.
  204.             n=4 for a DOS     program, n=5 for DOS     w/exclusive access.
  205.             n=6 for a Paragon program, n=7 for Paragon w/exclusive access.
  206.  
  207. + {$ f}     Send AmigaDOS command specified by f.
  208.  
  209. + {+ s}     Write string specified by 's' to the call log.
  210.  
  211. + {& s}     Perform BBS command specified by 's' ... must a 'system'
  212.             command like Time, Who, Chat, etc.
  213.  
  214. + {% d}     Set the user's time remaining to 0 (hang-up) if the current
  215.             date is less than the date specified by 'd' in the format
  216.             dd-mm-yy.
  217.  
  218. + {?n}      Wait for a Yes or No response (used in BBSTEXT for prompt lines)
  219.             n=0 for No, n=1 for Yes.  The response is ALSO placed in MCI
  220.             string register 0 (variable 70) as "1" or "0".
  221.  
  222. + {=n}      Manually set the response for a prompt line in BBSTEXT
  223.             n=0 for No, n=1 for Yes.
  224.