home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine 1996 / ARCHIVE_96.iso / discs / shareware / share_36 / arc_ansi / ?ReadMe next >
Text File  |  1990-10-27  |  4KB  |  100 lines
  1. Small document with the ArcANSI module
  2. --------------------------------------
  3.                                                   
  4. Some facts:
  5. -----------
  6. ArcANSI is the Archimedes ANSI Escape Sequence emulator module.
  7. ANSI escape sequences are sequences of bytes that allow for easy colour
  8. and cursor control. All sequences start off with a 27 (ESC), hence the 
  9. term 'escape sequences'.
  10. The ANSI 6429 standard is mostly used by BBS's to give their users nice
  11. and colourful screens in a quick and widely supported way 
  12. People familiar with MS-DOS surely know about ANSI.SYS... ArcANSI is just
  13. the Archimedes equivalent of this ANSI.SYS driver! 
  14.  
  15.  
  16. The ANSI 6429 escape sequences:  
  17. -------------------------------
  18. Note that ESC must be treated as the single byte 27 
  19.  
  20. ESC[r;cH         | Put cursor at position r,c (ROW,COLUMN)
  21. ESC[r;cf         | E.g. ESC[10,16H                  
  22.  
  23. ESC[nA           | Move cursor up n lines (omitting n moves up 1 line)
  24.                  | E.g. ESC[4A
  25.  
  26. ESC[nB           | Move cursor down n lines (omitting n moves down 1 line)
  27.                  | E.g. ESC[10B
  28.  
  29. ESC[nC           | Move cursor right n columns (omitting n moves right 1 col)
  30.                  | E.g. ESC[C
  31.  
  32. ESC[nD           | Move cursor left n columns (omitting n moves left 1 col)
  33.                  | E.g. ESC[3D
  34.  
  35. ESC[s            | Store current cursor position
  36.                  | E.g. ESC[s
  37.  
  38. ESC[u            | Restore previously stored cursor position
  39.                  | E.g. ESC[u
  40.  
  41. ESC[2J           | Clear display and move cursor to home position
  42.                  | E.g. ESC[2J
  43.  
  44. ESC[K            | Clear current line from cursor position (inclusive)
  45.                  | E.g. ESC[K
  46.  
  47. ESC[c;...;cm     | Set foreground/background colours                
  48.                  | 0 = reset to default colours (white on black)
  49.                  | offset 0 = black
  50.                  | offset 1 = red
  51.                  | offset 2 = green
  52.                  | offset 3 = yellow
  53.                  | offset 4 = blue
  54.                  | offset 5 = magenta
  55.                  | offset 6 = cyan
  56.                  | offset 7 = white
  57.                  | To set foreground colour, add 30 to colour offset
  58.                  | To set background colour, add 40 to colour offset 
  59.                  | E.g. ESC[34;47m
  60.  
  61.  
  62. Using ArcANSI:
  63. --------------
  64. To load the ArcANSI module, double-click on its icon in a filer, or type
  65. '*RMLoad ArcANSI [ENTER]' at the CLI-prompt * .
  66. When loaded, the emulator will automatically activate itself, ie. any bytes
  67. subsequently sent to the VDU will pass through the ANSI emulator, which will
  68. take action when necessary.                                                 
  69.  
  70. The module also provides the new *ANSI keyword:
  71. Use  '*ANSI Off [ENTER]'  to turn the ANSI emulator off
  72.      '*ANSI On  [ENTER]'  to turn the ANSI emulator back on
  73.      '*ANSI     [ENTER]'  to display the ANSI emulation status
  74. Use  '*Help ANSI_Info [ENTER]'  for some cryptic info on the ArcANSI module.
  75.  
  76. The module also provides a new SWI, "ANSI_Control" (&C0100):
  77. Entry: R0 = 0, R1 = 0
  78.        Turn off the ANSI emulator
  79. Entry: R0 = 0, R1 = 1
  80.        Turn on the ANSI emulator
  81. Entry: R0 = 1, R1 = 0
  82.        Don't allow VDU codes to pass through the emulator
  83. Entry: R0 = 1, R1 = 1
  84.        Allow VDU codes to pass through the emulator
  85.  
  86.  
  87. Comments:
  88. ---------
  89. If you have any comments on the ArcANSI module or would like to get some more
  90. info on BASS, write to:
  91.  
  92.         Carl Declerck, Vrijgeweidestraat 24, 2800 Mechelen, Belgium
  93.                                     or
  94.        John Tytgat, Brusselbaan 445, 1600 St.-Pieters-Leeuw, Belgium
  95.  
  96.  
  97.                        Tune in, Turn on, Burn out...
  98.  
  99.                                                     Carl Declerck, BASS 1990
  100.