home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / prog / c / stripit.lha / StripIt / StripIt.doc < prev    next >
Text File  |  1992-10-13  |  9KB  |  294 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                  DOCUMENTATION
  12.  
  13.  
  14.                       StripIt  VERSION  1.3 FREEWARE VERSION
  15.  
  16.  
  17.                              written 1992 by H.P.G.
  18.  
  19.  
  20.  
  21. INDEX:
  22.  
  23.             INDEX
  24.             General Description
  25.             Features
  26.             Using StripIt
  27.             System Requirements
  28.             Legal Stuff
  29.             Installation
  30.             Cli-Syntax
  31.             Configuration File
  32.             Technical
  33.             Last
  34.             Address
  35.             List of files
  36.  
  37. General Description
  38.  
  39.     StripIt is a programmers tool.
  40.     StripIt simply strips all  kinds  of  comments  from  Source  Codes.
  41.     StripIt can handle all kinds of programming languages.
  42.     StripIt needs OS 2.xx to run. It is not able to run under
  43.     Kickstart 1.2 and 1.3.
  44.  
  45. Features
  46.  
  47.     StripIt  [SI]  is  configurable  for  all   kinds   of   programming
  48.     languages through its configuration file.
  49.  
  50.     SI is relatively fast und easy to use.
  51.     ( Not like stripc of Manx etc.).
  52.  
  53.     SI can be stopped at each time simply by ^C. No loosing data.
  54.  
  55.     You can specify multiples Source Codes at  once.  In  this  case  SI
  56.     first strips then and then copies it to the Destination.
  57.  
  58.     StripIt is a OS 2.xx only Tool, that means it is much  shorter  than
  59.     tools which supports OS 1.3 and 2.xx.
  60.  
  61.  
  62. Using StripIt
  63.  
  64.     You need StripIt if you want to strip all  comments  e.g.  from  the
  65.     Include-Files. This results in a much more shorter  compiling  time.
  66.  
  67.     Or you want to strip comments from old sources. Then you could strip
  68.     the comments manually, which could be work for a live,  or  you  can
  69.     alternatively  use  StripIt  which  takes  only   a   few   seconds.
  70.  
  71. System Requirements
  72.  
  73.     You need at least OS 2.xx Version  37.  Version  36  may  have  some
  74.     problems because some functions which SI uses, was in  this  version
  75.     not fully implemented.
  76.  
  77.  
  78. Legal Stuff:
  79.  
  80.  
  81.         This  program  and  all files come with it, also the docfiles,
  82.         are released as FREEWARE.
  83.  
  84.         this means:
  85.  
  86.             everybody may use StripIt,
  87.  
  88.             everybody may copy StripIt, if:
  89.  
  90.                 1. You copy all included files, see list at the end of the
  91.                    doc file.
  92.                 2. No changes are made,  this  means  the  program and all
  93.                    included files must stay in the original form.
  94.                    Exception: you  may  archieve  it; but in this case you
  95.                               must also archieve the whole package.
  96.                 3. If  you  recompile  it, you have to include a notice to
  97.                    the original author. If you also want to (re)distribute
  98.                    in any new form you have to send me a copy.
  99.                 4. You may not sell StripIt.
  100.                    Execption: you`re  allowed  to  take  a  small copy fee
  101.                               which should not extend 5US$.
  102.                 5. If you want to include StripIt
  103.                    or one of the  included files as a part of a commercial
  104.                    package,  you  must  have  written  permission  of  the
  105.                    author (address see below).
  106.  
  107.  
  108.         I take no warranty or garanty for the function of this program.
  109.         The whole risk of using StripIt stays only by the user.
  110.  
  111.  
  112.  
  113. Installation
  114.  
  115.     The best is to copy StripIt to the directory where you have put your
  116.     compiler, linker, etc.
  117.  
  118.     In each case it should be located in the AmigaDOS searchpath.
  119.  
  120.  
  121. Cli-Syntax
  122.  
  123.     StripIt can only be called via CLI. It has the following options:
  124.  
  125.  
  126. SYNTAX: Stripit [SRC/M/A][TO/A][Cfg/K][C/S]
  127.  
  128. with
  129.  
  130.         SRC/M/A         SRC is the name of your Source  Codes(s),  which
  131.                         should  be   stripped   from   their   comments.
  132.                         You can specify multiples Sources but  you  must
  133.                         at least specify one.
  134.                         Therefor you must take care  bot  to  forget  to
  135.                         specify  also  a  destination.  Else  the   last
  136.                         Source-File is taken as  destination  und  would
  137.                         be overwritten. BE CAREFUL
  138.  
  139.  
  140.         TO/A            TO is the name  of  the  destenation.  You  must
  141.                         specify TO. If you specify multiple Source-Files,
  142.                         the comments from all files will be deleted  and
  143.                         append  to  TO.  Much  equal  the  Join-command.
  144.                         You cannot specify the same file for SRC and TO.
  145.                         In this case  the  file  could  be  overwritten.
  146.  
  147.         CFG/K           If you type CFG  following  by  the  name  of  a
  148.                         configuration file  StripIt  use  this  file  as
  149.                         configuration. About syntax  of  this  file  see
  150.                         below. This  file  contains  all  comment  chars
  151.                         which should be deleted from SRC(s).
  152.  
  153.         C/S             Is c is given StriPIt uses an intern configuration
  154.                         which knows all C-comments like
  155.                         /* , */ , // . The `//` are supported for  ANSI-
  156.                         compatibility. All chars after a // are  handled
  157.                         as comment until an `EndOfLine' appears.
  158.  
  159.  
  160. Configuration File
  161.  
  162.     StripIt knows two different kinds of comments.
  163.  
  164. 1.  The first is a comment that startet with  a  string  and  ends  with
  165.     another different string. All between this two strings are  comment.
  166.  
  167.     e.g.:
  168.  
  169.                   /* : Is a start of a C-comment
  170.                   */ : Is the end of a C-comment
  171.  
  172.                   /* And this too */ This not
  173.  
  174.     equal exists in other programming languages too
  175.  
  176. TAKE CARE: StripIt doesn`t support comments in comments
  177.  
  178.          e.g.
  179.                  '/* Hello /* Comment 2 */    */'
  180.  
  181.        will get an error, because StripIt only waits for the end of the
  182.        comment. You will get something like:
  183.  
  184.                  '                            */'
  185.  
  186.  
  187. 2.  The scond kind of comment starts  with  a  string  and  ends  by  an
  188.     EndOfLine.
  189.  
  190.     e.g.
  191.  
  192.                    ;   : All behind this char is a comment
  193.                    *   : This could be a comment in Assembler
  194.                    ;   : there are comments in AmigaDOS-scripts too
  195.                    REM : Also in BASIC are comments allowed
  196.  
  197. I didn`t want to handle all kinds of comments of all kinds of languages.
  198. So I take the advantage of a full user-configurable config file.
  199.  
  200. So you can still use StripIt with new languages.
  201.  
  202. To differ the two kinds of comments the config file has the following
  203. syntax:
  204.  
  205. .sta ##
  206. .end ##
  207. .lin ##
  208.  
  209. Instead of ## you must specify the comment keys
  210.  
  211. .sta means: The string behind .sta represents the  start  of  a  comment
  212.  
  213. .end means: The string behind .end  represents  the  end  of  a  comment
  214.  
  215. that means: .sta ## must always be followed by  an  .end  ##  statement,
  216.             else you can lose datas.
  217.  
  218. .lin means: The string behind .lin  represents  a  ToEndOfLine  comment.
  219.             If StripIt finds this statement in a source code  all  chars
  220.             until EndOfLine wil be deleted.
  221.  
  222. You can use upto 10 (!) different comment statements.
  223.  
  224. This should be enough for all kinds of sources.
  225.  
  226. I have a few (most simply) example config files included in the examples
  227. directory. There are examples  for  Batch-,Csh-,Dme-,ASM-  etc  comments
  228. included.
  229.  
  230.  
  231. Technical
  232.  
  233.                StripIt  uses  a  lot  of  new  OS  2.xx  features,   for
  234.                commandline parsing and outputs etc.
  235.                Besides StripIt has get rather  big.  This  is  a  result
  236.                at the on hand of the complexibility ( full  configurable
  237.                interal C-comments-support etc.)
  238.                on the other hand of secuity functions (  Break  Handling
  239.                etc.). So StripIt can be stopped at any  time  simply  by
  240.                typing a ^C. Before SI ends it first  closes  all  opened
  241.                files and gives back all allocated resources.
  242.                The more comment statements are used the more  time  will
  243.                be used to strip the comments. If using all 10 statements
  244.                and very large source files it can take a  lot  of  time.
  245.                In this case you should run StripIT as a  backgound  task
  246.                and sets its priority to something like -1.
  247.  
  248.  
  249. Last
  250.  
  251.                I hope StripIt will be used by a lot of people.
  252.                If you find some bugs please let me know.
  253.                Also seriously critic and/or ideas are wellcomed.
  254.  
  255.                Send all messages to the address below
  256.  
  257.  
  258. Adresse
  259.  
  260.  
  261.                 Hans-Peter Guenther
  262.                 Gruener Weg 5
  263.                 3501 Fuldatal 2
  264.                 Germany
  265.  
  266. List of files
  267.  
  268. (If you miss any of the following files your release is incomplete)
  269.  
  270. StripIt           : the binary
  271. StripIt.info
  272. StripIt.doc       : english manual
  273. StripIt.doc.info
  274. StripIt.dok       : german manual
  275. StripIt.dok.info
  276. CfgFiles          : directory with some example configurations
  277.     csh.cfg       : for csh
  278.     dme.cfg       : for dme
  279.     asm.cfg       : for assembler
  280.     dos.cfg       : for batch files
  281. CfgFiles.info
  282. ExampleSrc        : directory with some example source files
  283.     ex.c          : in C
  284.     ex.s          : in assembler
  285.     ex.sh         : in csh script language
  286.     ex.dme        : in dme script language
  287.     ex.bat        : in dos script language
  288. ExampleSrc.info
  289.  
  290.  
  291.  
  292. -------- END
  293.  
  294.