home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR8 / RAP12.ZIP / RAP.DOC < prev    next >
Text File  |  1993-08-17  |  9KB  |  191 lines
  1.                              Rap version 1.2
  2.  
  3.                              August 16, 1993
  4.  
  5.                  Copyright (C) 1992, 1993 by Thomas M. Roddy
  6.                             All Rights Reserved.
  7.  
  8.  
  9. Introduction:
  10.  
  11. Rap is a "word wrap" utility program which is used to reformat a text file
  12. into specified line lengths without splitting up words across lines. If a
  13. word will not fit at the end of a line, then the entire word will start
  14. the next line. This differs from programs which reformat text files to a
  15. given line length regardless of the word boundaries.
  16.  
  17. The shareware version of Rap is restricted in one way. To encourage
  18. registration, it will only process the first 60000 or so characters of a file.
  19. This should be adequate to test the usefulness of the program. Please
  20. register if you find Rap useful. You will be mailed the latest version of
  21. the program without the shareware notice and with the restriction removed.
  22.  
  23. New in version 1.2 is a /M option which will use "margin mode" to also
  24. wrap paragraphs that have an indented starting position.
  25.  
  26.  
  27. License and distribution information:
  28.  
  29. Rap is shareware. It is not public domain or free software. An order form
  30. is enclosed in the file named ORDER.FRM.  After trying it out for 14 days, if
  31. you like it and want to continue using it, please register by sending the
  32. registration fee (located in ORDER.FRM) with your name and address along with
  33. any comments or questions to the address listed.
  34.  
  35. You may NOT alter the code nor may you sell this program or any of its
  36. associated data files for any price.  You may charge a reasonable copy
  37. fee of not more than US$10 when distributing it to others as long as you
  38. clearly stipulate that Rap must be registered with its author if it is
  39. used beyond the trial period. Every copy of the ZIP distribution file
  40. must contain all of the files listed below.
  41.  
  42. You may (and are encouraged to) distribute the shareware version of Rap
  43. to others. Under no circumstances may you distribute a registered version
  44. of Rap to others.
  45.  
  46.  
  47. Disclaimer:
  48.  
  49. The author makes no claims or guarantees about the use of Rap and will
  50. not be responsible for any loss of data or profits due its use or misuse.
  51.  
  52.  
  53. Compatibility:
  54.  
  55. Rap should work with all standard ASCII files. It has not been tested with
  56. files containing control characters commonly found in documents in specific
  57. word processing formats such as Word Perfect or Microsoft Word. Most
  58. word processors allow you to convert documents to ASCII format. You should
  59. do this before using Rap on the documents.
  60.  
  61. Rap should work with UNIX generated files which may have line feeds
  62. without the accompanying carriage returns generally found in MS-DOS
  63. generated files. It should also work with Macintosh generated files.
  64. The output file generated by Rap will, however, have a carriage return
  65. and line feed at the end of each line.
  66.  
  67.  
  68. Files in distribution:
  69.  
  70.  RAP.EXE    -   Rap executable program
  71.  RAP.DOC    -   This file - Documentation for Rap
  72.  ORDER.FRM  -   Printable order form for registering Rap
  73.  
  74.  
  75. Product description:
  76.  
  77. Rap will "word wrap" lines of text to fit into the line width specified
  78. on the command line. If a full word cannot fit on the end of one line,
  79. the entire word is wrapped to the next line. Rap will not hypenate words
  80. that are not already hypenated, but will unhyphenate words that are hyphen-
  81. ated at the end of a line (as in the above line) since the hyphenation is
  82. meaningless (actually confusing and incorrect) if it appears in the middle
  83. of a line after being reformatted by Rap.
  84.  
  85. If a line width is not specified, then Rap will default to the largest line
  86. width it supports which is 2147483647 characters per line. This effectively
  87. removes all line breaks within a paragraph. Acceptable values are from 10 to
  88. 2147483647 and can be specified using the /W option.
  89.  
  90. Rap also allows you to specify the size of the two internal buffers which
  91. are used in processing the file. The default sizes for the two buffers are
  92. 2048 bytes each. You can modify this value by using the /B option. Acceptable
  93. values are from 128 to 30208 bytes. If performance is critical, you could
  94. optimize the processing time by setting these buffer sizes, but in my testing
  95. 2048 bytes seems to be the most efficient value.
  96.  
  97. Specifying the output file name is optional.  If no output file name is given,
  98. the output file name will default to the input file name with the extension
  99. .RAP appended to it.  For example, the input file TEXTFILE would default to
  100. the output file TEXTFILE.RAP while TEXTFILE.TXT would also default to
  101. TEXTFILE.RAP.  Rap will error if the input file has the same name as the
  102. output file.
  103.  
  104. Many word processing programs reformat paragraphs themselves depending
  105. on how many characters can fit on a line. This is frequently dependent
  106. upon font size, margins, etc. By removing the "line breaks", these programs
  107. can process the file better because they don't have to worry about "line
  108. breaks" which are already in the file. Rap is therefore very useful when
  109. converting documents between different word processors. In some cases, you
  110. may want to put in line breaks after 80 characters, while other times you
  111. may want to strip out all the line breaks within a paragraph and let the
  112. word processor do the reformatting.
  113.  
  114. Most word processor programs save their files in a proprietary format with
  115. control characters. If the text file is not in ASCII format, you must convert
  116. it to ASCII. Most word processors allow you to do this.
  117.  
  118. Reformatting documents using word wrap programs often have undesirable side
  119. effects so this type of text processing is dependent upon the text files you
  120. want to print.
  121.  
  122. Usage:  Rap infile [-Wm] [-Bn] [-M] [outfile]
  123.  
  124.    where m is the desired line width:
  125.          minimum=10, maximum=2147483647, default=2147483647
  126.    where n is the desired buffer size
  127.          minimum=128, maximum=30208, default=2048
  128.    where M implements margin mode.
  129.  
  130. Examples:
  131.  
  132.     RAP TEXTFILE.TXT /W76
  133.           Reformats TEXTFILE.TXT into 76 characters per line and writes
  134.           it to TEXTFILE.RAP
  135.  
  136.     RAP TEXTFILE.TXT
  137.           Reformats TEXTFILE.TXT into 2147483647 characters per line and
  138.           writes it to TEXTFILE.RAP. This effectively removes all line breaks
  139.           within paragraphs. Useful for importing the document to word
  140.           processors which do not like line breaks.
  141.  
  142.     RAP TEXTFILE.TXT /W50
  143.           Reformats TEXTFILE.TXT into 50 characters per line and writes
  144.           it to TEXTFILE.RAP. This is useful for printing the output file
  145.           in three columns (using ColPrint) on a printer that supports 160
  146.           characters per line (20 cpi) mode.
  147.  
  148.     RAP TEXTFILE.TXT /W50 /B8096 TEXT2.TXT
  149.           Reformats TEXTFILE.TXT into 50 characters per line and writes
  150.           it to TEXT2.TXT. The two internal buffers are each 8 KB in
  151.           size.
  152.  
  153.     RAP TEXTFILE.TXT /W50 /B8096 /M TEXT2.TXT
  154.           Reformats TEXTFILE.TXT into 50 characters per line and writes
  155.           it to TEXT2.TXT. The two internal buffers are each 8 KB in
  156.           size. If an entire paragraph is indented, then it will also be
  157.           "word wrapped" while maintaining the indentation.
  158.  
  159. RAP.EXE should be placed in a directory which is in your search PATH so that
  160. you can run the program from within other directories.
  161.  
  162.  
  163. Miscellaneous information:
  164.  
  165. Warning: you are not legally allowed to modify many copyrighted software
  166. manuals. This program should be used on your own personal files or with the
  167. permission of the document's author.
  168.  
  169. If you are looking for a printing program to print your files into newspaper
  170. style columns, take a look at another shareware program by this author called
  171. ColPrint. ColPrint is compatible with many dot matrix, DeskJet, and laser
  172. printers. If you can't find it on your local BBS, download it from CompuServe.
  173. If you do not have access to CompuServe, send $5 to the address below and I'll
  174. mail you a Shareware copy to evaluate or send $9.95 + $1 (shipping/handling)
  175. for a registered unrestricted version.
  176.  
  177. The official distribution site for Rap is the Programmers Corner BBS in
  178. Columbia, Maryland (410) 995-6874. You can be sure of having the latest
  179. version of Rap if you download it from there. CompuServe will have it soon
  180. after the Programmers Corner. I can also be reached on the Programmers Corner
  181. BBS for technical support by sending a message to Tom Roddy.
  182.  
  183. The author can also be contacted by US mail or CompuServe:
  184.  
  185.  Thomas M. Roddy              CompuServe ID:  73730,3304
  186.  7158 Harp String
  187.  Columbia, MD  21045
  188.  
  189.  
  190. Trademarks are the property of their respective owners.
  191.