home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / wp / xword222.zip / XWORD.DOC < prev    next >
Text File  |  1986-03-30  |  11KB  |  235 lines
  1.                 X W O R D    D O C U M E N T A T I O N
  2.  
  3.  
  4.  
  5.  
  6.                             By Ronald Gans
  7.  
  8.                        350 West 55th Street #2-E
  9.  
  10.                        New York, New York  10019
  11.  
  12.  
  13.         (See the end of this file for registration information)
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                              INTRODUCTION                        Page 1
  20.  
  21.                What You Should Have and What Is Required
  22.  
  23. There should be two files ARC'd together: XWORD.EXE and XWORD.DOC.  The
  24. ARC'd file will be called XWORDnnn.ARC; the 'nnn' refers to the revision
  25. number of XWORD.EXE.  The only file that is essential to XWORD's
  26. operation is XWORD.EXE.  XWORD should work OK on any IBM PC (IBM PC-XT,
  27. IBM PC-AT, or close compatible, such as the COMPAQ or AT&T 6300).
  28. XWORD.EXE requires about 80K bytes of memory and will only work with DOS
  29. 2.xx or above.  XWORD.EXE senses whether the monitor is monochrome or
  30. color, but in either case writes directly to the screen in the normal
  31. video mode.  This file, XWORD.DOC, should clarify difficult points of
  32. XWORD's operation.  See the end of this file for more information about
  33. registration and copyright.
  34.  
  35. XWORD is a general file format transformer; that is, it converts files from
  36. one format to another.  Selections are made from two menus, "FORMAT
  37. CONVERTERS" and "LOGICAL OPTIONS." Since XWORD is not tricky to use, this
  38. file deals with general operation procedures, some problems, and what XWORD
  39. does not do.
  40.  
  41. I have made some arbitrary decisions regarding what XWORD does to files.
  42. Sometimes it is not possible, or not possible without great difficulty, to
  43. preserve print options between different word processing formats. In some of
  44. these cases, I have elected to eliminate them and let the user re-input them
  45. anew. For those word processors which require a line length embedded in the
  46. files, I have chosen one arbitrarily, based on my own experience.
  47.  
  48. XWORD appends a 1AH to the ends of files under certain options. Those
  49. options that convert files to ASCII format all append a 1AH to the file.
  50. This is not required for MS/PC-DOS, but it necessary in CP/M, to which ASCII
  51. files can be ported.
  52.  
  53.  
  54.                  WILDCARDS, DRIVES, and SUBDIRECTORIES
  55.  
  56. XWORD supports wildcards (* and ?) in the source file name. When wildcards
  57. are used, XWORD will overwrite the source file (a warning to that effect
  58. appears). YOU STRONGLY ADVISED TO MAKE ALL CONVERSIONS ON COPIES OF FILES
  59. ONLY, NEVER ON THE ORIGINALS. XWORD also fully supports drives and
  60. subdirectories in both the source and target file names.
  61.  
  62.                                                                   Page 2
  63.  
  64.                                MENU ONE
  65.  
  66.                             REDUCING SPACES
  67.  
  68. Use only with ASCII or WordStar-compatible files. DO NOT USE WITH MULTIMATE
  69. FILES OR WITH WORDSTAR 2000 FILES. You will have to reboot if you try to
  70. load a file processed with the P option into Multimate or WordStar 2000.
  71.  
  72.  
  73.                  WORDSTAR, WORDSTAR 2000, AND SIDEKICK
  74.  
  75. No special precautions need be taken regarding these files. Both WordStar
  76. and WordStar 2000 will allow any kind of file name. There is still a problem
  77. with tab handling (by XWORD), but the rest of the options of the two should
  78. be OK. XWORD will support WordStar 2000's JUSTIFY.FRM, RAGGED.FRM, MEMO.FRM,
  79. and NORMAL.FRM. It will not support the NOFORM.FRM. This format is
  80. identical to ASCII. Thus, if converting a file produced with WordStar 2000
  81. and NOFORM.FRM, select ASCII as the source file format.
  82.  
  83. Sidekick is compatible with WordStar, BUT, the tabs of files written in
  84. WordStar's non-document mode show up as capital "I"s in Sidekick.  XWORD
  85. expands expands these tabs so they will appear properly.
  86.  
  87. If your file in WordStar2000 looks funny when XWORD is through with it, place
  88. the cursor at the beginning of the paragraph and press any letter (you will
  89. have to erase the letter you input). This will cause WordStar2000 to
  90. reformat the paragraph.
  91.  
  92.  
  93.                                MULTIMATE
  94.  
  95. XWORD supports conversion into and out of MultiMate. When converting from
  96. WordStar, be careful of indents. Make sure that indents begin after a hard
  97. return or ^PM (equivalent to 0DH). MultiMate requires all document files
  98. have the extension .DOC; XWORD appends this extension to MultiMate-target
  99. files.  You will notice that the converted Multimate file will often have
  100. more indents than it should. This is due to the algorithm I used; a future
  101. version of XWORD will solve this problem. I have used XWORD to convert files
  102. longer than 42K to MultiMate with no problems. Converting into MultiMate with
  103. wildcards is the only instance in which wildcard use does not result in the
  104. original files being overwritten, unless they, too, have a .DOC extension.
  105. When converting OUT of MultiMate, it is strongly advised that you
  106. repaginate your document. Multi
  107.  
  108.  
  109.  
  110.  
  111.                                                                   Page 3
  112.  
  113.                             XYWRITE II PLUS
  114.  
  115. No special precautions need be taken here, as XyWrite II is very friendly.
  116. (XWORD has been tested on Version 1.00.)
  117.  
  118.  
  119.                               WORDPERFECT
  120.  
  121. No special precautions are needed regarding conversion to or from
  122. WordPerfect.
  123.  
  124.  
  125.                                MENU TWO
  126.  
  127. The options on this menu are for bit and byte manipulation.  Some of them can
  128. be used for a quick and dirty type of cryptography.  Three of the options
  129. require the user to input a value in hexadecimal format (digits 0-9 and
  130. letters A-F, which represent our common notion of 10, 11, 12, to 15); they
  131. are: AND, OR, XOR.  Another one, NOT, requires no other input from the user
  132. than the source and target file names.  ROL and ROR require the user supply a
  133. number between 1 and 7, inclusive.
  134.  
  135. The action of NOT, ROL and ROR are fully reversable.  That is, if NOT
  136. FileA produces FileB, and NOT FileB produces FileC, then FileC is
  137. identical to FileA.  ROR (ROtate through Right) and ROL (ROtate through
  138. Left) circulate the eight bits that compose each byte.  ROR 1 time
  139. shifts the bits in each bit right once; the rightmost bit is moved to
  140. the leftmost position (this information is merely for the elucidation of
  141. the user; the user does not have to understand the action of these
  142. options in order to use them).  ROL 1 acts in the same way, but to the
  143. left.  ROR 2 is the same as ROR 1 and then ROR 1 again.  If FileA is
  144. processed with ROR 3, say, producing FileB, and FileB is processed using
  145. ROL 3, producing FileC, then FileC is identical to FileA.  You can use a
  146. sequence of these options to scramble a file pretty well (but remember
  147. to record your sequence and go through it in reverse to unscramble it).
  148. That is, if your sequence was:
  149.  
  150.                      ROR 4, NOT, ROL 3, NOT, ROL 2
  151.  
  152.                     then to undo this, you must go:
  153.  
  154.                      ROR 2, NOT, ROR 3, NOT, ROL 4
  155.  
  156.  
  157.                                                                   Page 4
  158.                                 REPLACE
  159.  
  160. The last option on this menu, Replace, is different from the others.
  161. Replace allows the user to replace any text (ASCII) or hexadecimal
  162. string (a string is a sequence of bytes) by any other text or
  163. hexadecimal string.  The two strings do not have to both be ASCII or
  164. hex.  Additionally, the user can elect to save these strings and reuse
  165. them (especially useful if they were complicated to figure out).  The
  166. user will be prompted for a source file and then a target file; then,
  167. whether the string is to be entered in ASCII, hex, or from a previously
  168. saved file.  If the user enters a string in ASCII or hex, XWORD will ask
  169. if the user wants to save the string.  This sequence is repeated for the
  170. replacement (new) string.  Each string can be 30 bytes (characters)
  171. long.  When entering hex, note that each hex digit must be composed of
  172. two numerals (including letters).  Thus, the string more commonly
  173. written as 0DH,0AH,27H,64H,0FFH, would be enterd as 0D0A2764FF.
  174.  
  175. Remember that if you Replace a commonly occurring byte in a file with a long
  176. string, then your target file could become up to 30 times as large as the
  177. original file.
  178.  
  179. If you make an error during hex entry, hit the backspace key, and you will be
  180. reset to the beginning of hex entry.  Generally in XWORD, hitting the space
  181. bar, return, or end key lets you escape from one level of the program to
  182. another, and, except when files are actually being converted, control-C
  183. always works.
  184.  
  185.  
  186.                   DISCLAIMERS, OWNERSHIP, COPYRIGHTS
  187.  
  188. XWORD is the property of Ronald Gans; XWORD is unpublished and copyrighted.
  189. XWORD may not be sold for profit by anyone.  If you purchased XWORD for more
  190. than the price of a disk, shipping, and handling, you got taken and should
  191. notify me of that fact, along with the name of the person or corporation from
  192. whom you purchased XWORD.  XWORDnnn.ARC, XWORD.EXE, XWORD.DOC, and
  193. XWRDINVC.EXE may be freely copied and distributed, but may not be altered in
  194. any way by anyone.  If you wish an alternate version of XWORD, please let me
  195. know.  Please direct all correspondence to:
  196.  
  197.                               RONALD GANS
  198.                          350 WEST 55TH STREET
  199.                        NEW YORK, NEW YORK 10019
  200.            CompuServe No. 74216,264 Telephone (212) 957-8361
  201.  
  202.                                                                   Page 5
  203.  
  204. You may make unlimited copies of XWORD.EXE for distribution without charge or
  205. rental, to anyone, ONLY IF XWORD.DOC and XWRDINVC.EXE are included. I urge
  206. you to copy the ARC'd file, XWORDnnn.ARC, so that others may share the
  207. documentation and also have a chance to register their copies.
  208.  
  209.                              REGISTRATION
  210.  
  211. Included with the files XWORD.EXE and XWORD.DOC should be the file
  212. XWRDINVC.EXE.  Running this program and answering the two questions will
  213. result in an invoice printed out on your printer (assuming a printer is
  214. attached).  If you wish to register your copy of XWORD, please fill out and
  215. mail the invoice form back to me at the above address along with $15.00
  216. (N.Y.S. residents please add 8 1/4% sales tax for $16.24).  If you register,
  217. you are entitled to free upgrades for one year (there have been many
  218. revisions of XWORD since it was first released to the public and I am
  219. continually working on it).  Additionally, if you wish to continue receiving
  220. upgrades after one year, an additional year will cost only $8.00.  Planned
  221. enhancements for XWORD include, of course, more word processing formats
  222. (VolksWriter and  Navy DIF, among others) along with a greatly enhanced
  223. replace function allowing for "intelligent" replacement.
  224.  
  225.  
  226. WordStar and WordStar 2000 are registerd trademarks of MicroPro International
  227. Corporation.  MultiMate is a registered trademark of MultiMate International.
  228. XyWrite II Plus is a registered trademark of XyQuest Inc. Sidekick is a
  229. registered trademark of Borland International. WordPerfect is a registered
  230. trademark of Satellite Software. IBM PC, IBM PC-XT, IBM PC-AT are registered
  231. trademarks of International Business Machines, Inc. AT&T 6300 is a registered
  232. trademark of American Telephone & Telegraph Company. COMPAQ is a registered
  233. trademark of COMPAQ Computer Corporation.
  234.  
  235.