home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d581 / stripansi.lha / StripANSI / StripANSI.docs < prev    next >
Text File  |  1992-01-04  |  5KB  |  105 lines
  1.        ***************************************************************
  2.        *                   StripANSI Docs v1.0                       *
  3.        *                                                             *
  4.        *     Program and Documentation Written by Syd L. Bolton      *
  5.        *                                                             *
  6.        *         ©1991 Legendary Design Technologies Inc.            *
  7.        ***************************************************************
  8.  
  9. Introduction
  10. ~~~~~~~~~~~~
  11.     There are many times when capturing buffers from terminal
  12. programs that you may find the pretty (but sometimes annoying) use of
  13. ANSI codes to be undesireable.  In one case, I wanted to keep my own
  14. list of downloadable files from a certain BBS, but I wanted to weed
  15. out the menus, and other messages.  When loading my captured file into
  16. my text editor, I was appalled to see the screen cluttered with ANSI
  17. codes everywhere.  Search & replace just won't do here, since there are
  18. so many variations.  So, a program needed to be written to remove these
  19. codes for me.  Here is that program.
  20.  
  21. The Three Flavours of StripANSI
  22. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23.  
  24.     StripANSI actually comes in three (3) different versions, each
  25. of which has a particular use for you, depending upon your system.
  26. They are:
  27.  
  28. CLI VERSION
  29. -----------
  30.     This is the smallest version of the program, intended to be used
  31. by people who don't like WIMP interfaces, but prefer command line ones.
  32. The usage of the program is simply:
  33.  
  34. StripANSI inputname outputname [REPORT]
  35.  
  36.     Of course, the 'inputname' is the name of the ANSI-ridden file,
  37. 'outputname' is the name of the destination filename for the NEW, stripped
  38. file, and the optional 'REPORT' will generate a report about the number
  39. of ANSI entries, and their appropriate percentages.
  40.  
  41. WORKBENCH VERSION
  42. -----------------
  43.     This version of StripANSI has a full Intuition interface that allows
  44. more control over the conversion.  You have the ability to selectively turn
  45. on and off certain types of conversions.  The default is that ALL ANSI codes
  46. listed on the screen are to be stripped.  If you DON'T want one (or more) of
  47. these codes stripped, click on its gadget to highlight it.  There is also the
  48. ability to selectively generate a report, and all file handling is done
  49. through a file requester which makes the entire program 'point and click'.
  50.  
  51. ARP VERSION
  52. -----------
  53.     This version is the same as the Workbench version but is smaller
  54. because it uses the ARP library for the file requester.  You will want
  55. to use this version if you have (or intend to start using) the ARP
  56. library on your system.
  57.     NOTE: WITH THIS RELEASE, THE ARP VERSION IS NOT FINISHED!  I
  58. REALLY NEED TO GET A HOLD OF SOME REAL ARP DOCUMENTATION!
  59.  
  60. How It Works
  61. ~~~~~~~~~~~~
  62.     StripANSI is a very simple program.  A table of code names, and
  63. their equivalent 'ending' indicators was created.  When a CSI (Code
  64. Sequence Introducer) character is encountered in the input file, the
  65. program then searches the table to find a match for the 'ending'
  66. indicators.  When one is found, normal 'read in, write out' procedures
  67. continue, until another CSI is encountered.  By simply not writing the
  68. characters found between (and including) the CSI and ending character,
  69. we eliminate all ANSI codes in a file.
  70.     Currently, StripANSI will also eliminate any BACKSPACE (ASCII:8)
  71. characters, which often appear in terminal buffers when a mistake is
  72. made on the keyboard.  It will also eliminate FORM FEEDs (ASCII:12) which
  73. is often used to clear the screen.
  74.  
  75. True ANSI?
  76. ~~~~~~~~~~
  77.     Since I do not actually have a valid ANSI table of codes
  78. (if someone can tell me where I can get a complete table, I would be
  79. most appreciative), I have only filtered the codes that the Amiga
  80. understands, as defined by the latest RKM, 'Libraries & Devices'.
  81. StripANSI will also remove any Amiga-specific (non-ANSI) codes, and
  82. these are preceeded by a '»' character to indicate they are NON-ANSI.
  83.  
  84. Conclusions
  85. ~~~~~~~~~~~
  86.     Please test this program with files you have to make sure
  87. it works as it should, trying the report option as well.  Please
  88. realize the '%' indicators is not actually 100% accurate: this is
  89. because I did not want to introduce floating-point numbers (as this
  90. would increase program size unnecessarily) so the % will probably
  91. only add up to 99%, but this is okay, and not really a bug.
  92.  
  93.     Any problems, questions, or concerns should be directed to
  94. me either via E-MAIL, mail, fax, or voice.  THANKS FOR YOUR TIME!
  95.  
  96.     Syd Bolton
  97.     President
  98.     Legendary Design Technologies Inc.
  99.     25 Frontenac Avenue
  100.     Brantford, Ontario
  101.     N3R 3B7
  102.     (519)-753-6120 voice/answering machine
  103.     (519)-754-4059 fax
  104.     (519)-754-1120 Probe BBS: Sysop: A.Antoszewski 24hrs, 2400, 8n1
  105.