home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 6 / FreshFish_September1994.bin / bbs / util / mayflower.lha / MayFlower / TrimLines / TrimLines.doc < prev    next >
Encoding:
Text File  |  1994-06-10  |  7.8 KB  |  172 lines
  1.          --- ---
  2.          (o) (o)           TrimLines 5.0 (19940312)
  3.             ^
  4.          \_____/            by  Stephen D Childers
  5.  
  6. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7.            ***  WARNING !!!  ***         ***  WARNING !!!  ***
  8.  
  9.    This program can damage [ouch] important files if not used properly.
  10.    Do not use this program on original files unless you know exactly
  11.    what you are doing.
  12.  
  13.    This is the warning that should have been given with previous
  14.    releases of this program.
  15.  
  16. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  17. Program Description:
  18.  
  19.    1) This program will take a text file and remove the space characters
  20.       from the end of each text line within that file.
  21.  
  22.    2) It will print a total count of spaces removed.
  23.  
  24.    3) It can only be run from CLI. Can be made resident.
  25.  
  26.    4) Program (when run from CLI) will interact with the 'c:Why' command
  27.       after program failures; this command may provide a more detailed
  28.       explanation of why the program failed.
  29.  
  30.       The 'Why' command should be used immediately after a program
  31.       failure to extract the last program's result code, because
  32.       that result code is changed upon the execution of the next CLI
  33.       command.
  34.  
  35.    5) Certain error reports will contain the name of the arg, file,
  36.       device, (etc) that is associated with failure when it occurs.
  37.  
  38. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  39. Reason for program's existence:
  40.  
  41.    Let us suppose that the following line appears in one of our library
  42.    text files (minus the quotes).
  43.  
  44.    "This ends the first paragraph.                                 "
  45.  
  46.    And let us suppose that the LF (LineFeed) or CR (Carriage Return) for
  47.    this line begins right after the end quote. As you can see; there is
  48.    a lot of blank space being stored in this text file line before the
  49.    CR or LF is reached.
  50.  
  51.    And let us suppose there are over a 1000 lines similar to this last
  52.    line which have blank spaces extending the length of the line before
  53.    the CR or LF is reached.
  54.  
  55.    It now becomes apparent that the size in bytes of a text file in this
  56.    condition could be very large, thousands of bytes larger than normal.
  57.    Larger than what is necessary for a normal text file being stored on a
  58.    library diskette. I suppose that there are times when certain text
  59.    files may need to be left in this condition, but there are times when
  60.    text files do not need to be stored in this condition.
  61.  
  62.    NOTE:  I first discovered the existence of excessive spaces one day
  63.    while I was using Ed to browse around some message text files that
  64.    were captured from certain computer bulletin board systems. This is
  65.    what motivated me to write this program.
  66.  
  67. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68. CLI Usage:
  69.  
  70.    Usage 1 > TrimLines [!] [[-options] input output]
  71.  
  72.       ! = show author info
  73.  
  74.       options: q = Quiet; do not print messages
  75.                o = Overwrite input, output arg not needed
  76.  
  77.       input  = file to be trimmed
  78.       output = where to put trimmed file
  79.  
  80. CLI Usage notes:
  81.  
  82.    1) The options arg can appear any where within the command line
  83.       template, thereby allowing this program to be used with various
  84.       "S:SPAT" like script files, thus allowing the use of wild
  85.       characters.
  86.                   ie > Execute SPAT TrimLines  *.txt -o
  87.                   or > Execute SPAT TrimLines #?.txt -o
  88.  
  89.    2) Input arg must be a file and can not be a device or directory,
  90.       and output arg can designate a device and/or directory as the
  91.       destination for trimmed data. If output arg is not a file then
  92.       input file name will be taken and used for the output file name.
  93.  
  94.          ie > TrimLines manyspaces.txt df0:
  95.          or > TrimLines yeowspaces.txt df0:stuff/
  96.  
  97.    3) If the output arg is not given (and option -o is not selected) then
  98.       the input arg (file name) will be used in creating the output file
  99.       name, and that name will have the extension ".TLS" appended to it.
  100.       Output will be put in same directory as input file.
  101.  
  102.    4) If the output arg is a device or directory name then a copy of
  103.       the trimmed input file is sent to the given directory.
  104.  
  105.    5) Option -o does not require the output arg, and output arg will be
  106.       ignored if option -o is specified.
  107.  
  108.    6) Option -o requires loading all of the input file into memory, and
  109.       if there is not enough memory the program will inform you to try
  110.       again without -o option.
  111.  
  112.    7) Option -o will not overwrite input file unless the spaces removed
  113.       is greater than zero.
  114.  
  115. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  116. Version History:
  117.  
  118.    The following information briefly describes changes or improvements
  119.    made to each version, and they will be described in descending order;
  120.    meaning latest version information begins first:
  121.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  122.    Version 5.0 (19940312) -
  123.    1) Changed version numbering format. Program can now be used with the
  124.       "Version" command. Date within parenthesis is shown in a somewhat
  125.       international format as (yyyymmdd).
  126.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  127.    Version 19930803 -
  128.    1) Optimized and refined source code thereby making program smaller.
  129.    2) Added "***  WARNING !!!  ***" paragraph to document file.
  130.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  131.    Version 19920105 -
  132.    1) Removed a CLI parsing problem.
  133.    2) Can be made resident.
  134.    3) Added option -o.
  135.    4) The options arg can now appear any where within the command
  136.       line template.
  137.    5) Input arg must be a file, and output arg can now designate a path.
  138.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  139.    Version 19910917 -
  140.    1) The usage template has changed.
  141.    2) Improved error reports.
  142.    3) Program (when run from CLI) will now interact with the 'c:Why'
  143.       command after program failures.
  144.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  145.    Version 19910631 - The first version.
  146. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  147.    _   _   _   _   _   _   _   _   __   _   _   _   _   _   _   _   _
  148.   (_) (_) (_) (_) (_) (_) (_) (_) (__) (_) (_) (_) (_) (_) (_) (_) (_)
  149.   //\_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/  \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/\\
  150.  //                                                                  \\
  151.  \\     28  And even as they did not like to retain God in their     //
  152.  //  knowledge, God gave them over to a reprobate mind, to do        \\
  153.  \\  those things which are not convenient;                          //
  154.  //     29  Being filled with all unrighteousness, fornication,      \\
  155.  \\  wickedness, covetousness, maliciousness; full of envy, murder,  //
  156.  //  debate, deceit, malignity; whisperers,                          \\
  157.  \\     30  Backbiters, haters of God, despiteful, proud, boasters,  //
  158.   X  inventors of evil things, disobedient to parents,               X
  159.  //     31  Without understanding, covenantbreakers, without         \\
  160.  \\  natural affection, implacable, unmerciful:                      //
  161.  //     32  Who knowing the judgment of God, that they which         \\
  162.  \\  commit such things are worthy of death, not only do the same,   //
  163.  //  but have pleasure in them that do them.                         \\
  164.  \\                                                                  //
  165.  //                 The King James Holy Bible - Romans 1:28-32       \\
  166.  \\  _   _   _   _   _   _   _   _    _   _   _   _   _   _   _   _  //
  167.   \\/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \__/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \//
  168.   (_) (_) (_) (_) (_) (_) (_) (_) (__) (_) (_) (_) (_) (_) (_) (_) (_)
  169.  
  170. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  171.                            End Of Document
  172.