home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / progm / sxu.zip / SXU.HLP < prev   
Text File  |  1987-08-28  |  14KB  |  350 lines
  1. */001
  2. *H
  3.                                HELP!
  4. *L
  5.  
  6. (SXU) or Select Xtrac Utility was written to offer the capability of extracting
  7. selected sections of data files. SXU accepts as input any standard ASCII
  8. sequential file, composed of character or numerical data. The input file to
  9. SXU cannot contain imbedded control characters, except for normal print
  10. control characters like line feed, carriage return, form feed and so on. Input
  11. characters such as Cntl/C will produce unpredicable results.
  12.  
  13. SXU supports a full HELP facility which is callable from any program prompt.
  14. An SXU session can be ended from any prompt by entry of the word 'END',
  15. which can be entered in either upper or lower case characters or a combination
  16. of both.
  17.  
  18. SXU reads the input data file specified and creates an output extract
  19. file with the same name as the input file, except with a default file extention
  20. of (.SXU).
  21. *P
  22. *H
  23.                              HELP!
  24. *L
  25.  
  26. File name specifications must be specified complete enough to allow the file
  27. to be located by SXU. Operating systems which support multiple directories
  28. are fully supported by SXU. File names plus directory information can be up
  29. to 40 characters in length.
  30.  
  31. To use the file append option, care must be used in the naming of files. If
  32. you are appending to an existing extract file produced by SXU, that file
  33. will have a default file extension of (.SXU) unless you have renamed it.
  34. SXU by default assigns output extract files the name of the input file plus an
  35. (.SXU) extension.
  36.  
  37. Assume the following example:
  38.  
  39. First run of SXU, input file name was SHEET1.DTA, SXU produces an extract
  40. file named SHEET1.SXU.
  41.  
  42. You further wish to extract from another file SHEET2.DTA and append the extract
  43. to the existing extract file SHEET1.SXU. **The Files must be renamed.
  44. *P
  45. *H
  46.                              HELP!
  47. *L
  48.  
  49. To perform the append operation in this example, SHEET2.DTA is renamed to
  50. SHEETS.DTA and SHEET1.SXU is renamed to SHEETS.SXU.
  51.  
  52. This in effect fools SXU into appending to an existing file. Remember that
  53. SXU outputs a file with the same name as the input file, except for the
  54. addition of a default extention of (.SXU).
  55.  
  56. SHEETS.DTA, under normal conditions SXU will create an output file with a
  57. name of SHEETS.SXU. With the append option invoked by the addition of the
  58. '<' character following the input file name, SXU will try to open and
  59. append to an existing file with the name SHEETS.SXU.
  60.  
  61. If the append option character '<' is not placed at the end of the input
  62. file name at entry, SXU will create a new file named SHEETS.SXU which will
  63. only contain the data from the current run. Data existing from the first
  64. extract in file SHEET1.SXU will still be present, but will not have any
  65. data appended to it.
  66. *E
  67. */500
  68. *H
  69.                              HELP!
  70. *L
  71.  
  72. SXU writes a Form Feed character, ASCII(12), to the extract file after
  73. each (Stop Mark) record. This is a default, procedure, although the user
  74. has the option of changing this character or suppressing it.
  75.  
  76. Pressing (RETURN) at this prompt will accept the Form Feed default. Entry
  77. of 'N' or 'n' will allow you to enter a different control character.
  78.  
  79. *E
  80. */550
  81. *H
  82.                              HELP!
  83. *L
  84.  
  85. If (RETURN) is pressed at this point, no character will be added by SXU
  86. after each (Stop Mark) record that is written to the extract file.
  87.  
  88. If you desire to use a different character than the default (FF), ASCII(12),
  89. then enter the ASCII number code for the character desired. Check with any
  90. ASCII Code Table to obtain the correct ASCII number in decimal form for the
  91. code desired. Only one character code can be entered. The character code must
  92. be a decimal number within the range of 1 thru 254.
  93. *E
  94. */800
  95. *H
  96.                              HELP!
  97. *L
  98.  
  99. Certain input files may contain recurring records, an example might be page
  100. header lines at page breaks. If recurring records are present in the input
  101. file and it is desired to exclude them from the extract, SXU/PC provides
  102. for the entry of from 1 thru 10 exclusion specifications. These record
  103. specifications can be from 1 thru 20 characters in length and are entered
  104. similar to Start and Stop mark specifications.
  105.  
  106. Example Entry Screen Format:
  107.  
  108.          LIST RECORDS TO BE EXCLUDED:
  109.              1...5....0....5....20
  110.           1)!Annual Report
  111.           2)!Page
  112.           3)!*
  113.  
  114. The above example will exclude any records which begin with the words
  115. 'Annual Report' and 'Page'. Entry is terminated by entry of the '*' symbol
  116. to the entry prompt.
  117. *P
  118. *H
  119.                              HELP!
  120. *L
  121.  
  122. Leading spaces must be entered if present in the line to be keyed on. Use
  123. of the entry form (@Spaces) is not allowed, actual spaces must be entered
  124. in the input prompt as the line appears in the input file.
  125.  
  126.  
  127. *E
  128. */900
  129. *H
  130.                              HELP!
  131. *L
  132.  
  133. SXU will not begin extract of data from the input file, until a valid Start
  134. Mark is located. A valid Start Mark can be any combination of text or numer-
  135. ical characters up to a maximun of 80. The Start Mark must appear within the
  136. first 80 characters of the data record. SXU begins its start mark search at
  137. character position (1) of each data record and reads thru the 80th. character.
  138.  
  139. Example Data Record:
  140.                             1         2
  141.        Column      12345678901234567890
  142.                    Now is the time......
  143.  
  144. In the above example if the phrase (Now is the), is used for the start mark,
  145. SXU will not begin recovery of data from the input file until it finds an
  146. exact matching phrase. It must be noted that the start mark phrase and the
  147. actual phrase must match character for character. Upper/lower case char-
  148. acters must be the same, SXU does consider upper and lower case characters to
  149. be different.
  150. *P
  151. *H
  152.                              HELP!
  153. *L
  154.  
  155. Be sure when entering a start or end mark to consider the leading spaces
  156. which may be present before the actual text. SXU considers spaces as valid
  157. characters, therefore if the mark is preceeded by 3 spaces in the actual
  158. record, the mark must be entered with the three spaces preceeding it, or
  159. use the [@spaces] option.
  160.  
  161. Entry of preceeding spaces are best handled by the [@spaces], enter the
  162. @ symbol followed by the number of preceeding spaces before the start
  163. mark. SXU will automatically insert the correct number of spaces during its
  164. mark search.
  165. *P
  166. *H
  167.                             HELP!
  168. *L
  169. SXU allows for entry of 32 separate start and stop markers at one time.
  170. This allows for multiple extracts to be made from the same file, without
  171. having to enter each start and stop mark in separate program runs.
  172.  
  173. During entry of start and stop markers, the lower right corner displays
  174. the number of the marker being entered. To end the entry of markers the
  175. letters 'fin' or 'FIN' must be entered in response to the start mark
  176. prompt. If you enter the full 32 markers, SXU will accept the 32nd. mark
  177. and automatically stop further entry.
  178.  
  179. Start and Stop marks can not be imbedded. Each matching start and stop
  180. mark pair must be found and processed before the next mark/end mark pair
  181. is processed.
  182.  
  183. Start and Stop Marks do not have to be entered in all cases. If the input file
  184. is to be extracted using one set of start and stop columns and the entire file
  185. is to be extracted, start and stop marks can be replaced with special commands
  186. to override them.
  187.  
  188. These commands are [*B] for the start mark and [*E] for the end mark.
  189.  
  190. *P
  191. *H
  192.                             HELP!
  193. *L
  194. Remember that to use these override commands the entire file is to be extract-
  195. ed using a single request with start and stop columns specified.
  196.  
  197. Example:
  198.  
  199.          *B:20
  200.          *E:30
  201.  
  202. Entry of the above to the start and stop request will produce an extract file
  203. which will be pulled from the 20th. thru 30th. columns. The entire file will
  204. be scanned from start to end. If a scanned record contains less than 30
  205. columns, data from the 20th. thru the last column will be returned.
  206.  
  207. *P
  208. *H
  209.                             HELP!
  210. *L
  211.  
  212. SXU allows recovery of selected portions of selected records. If for example
  213. it is desired to recover a column of numerical data from a file and the
  214. desired data starts in column 10 and ends in column 15, SXU allows entry
  215. of start and end column numbers.
  216.  
  217. To enter a start column number follow entry of the start mark with a ':'
  218. and the colunm number.
  219.  
  220. Example:      Start Mark ==>    Line25:10
  221.  
  222. The start mark is 'Line25' and the data will be recovered starting in
  223. column ':10'. SXU will read all input records from this column until
  224. the end mark is reached for this example. The example is not complete,
  225. whereas data is recovered starting in column '10' but it was desired to
  226. stop at column '15'. In the above example the entire record is recoverd
  227. from column '10' to the record end.
  228.  
  229. This problem is solved by entering a stop column number with the end
  230. mark entry, using the same format as above.
  231. *P
  232. *H
  233.                             HELP!
  234. *L
  235.  
  236. Example:     End Mark ==>  Line50:15
  237.  
  238. The end mark is specified along with an end column number. The start
  239. /end mark pair, (Line25:10,Line50:15) will do the following.
  240.  
  241. Data records will be recovered from the file beginning with (Line25) and
  242. data starting in column 10. Data will be read from each input record from
  243. column 10 thru column 15 until (Line50) is processed.
  244.  
  245. If it is desired to read all data from a record beginning at some column
  246. other than (1) but read all data to the end of each record, don't enter
  247. a stop column, enter only the stop mark.
  248.  
  249. Start and stop column numbers can be different for each start and stop mark
  250. set. This allows for unlimited variation in extracts, but the end column
  251. must be greater than the start column or an error will result.
  252.  
  253. Start and stop mark pairs are processed in the order in which they were
  254. entered and sets can not be embedded within sets. Each set must start and
  255. end before the next set begins.
  256. *P
  257. *H
  258.                             HELP!
  259. *L
  260.  
  261. SXU allows the user to store Start/Stop specifications in a special file
  262. called a Parameter File (ParmFile). The format of this file is similar to
  263. what the user is required to enter to the Start/Stop parameter input
  264. requests. A ParmFile is created by the user with any system supported editor
  265. which can create a standard ASCII sequential ouput file. The file must contain
  266. only Start/Stop mark information.
  267.  
  268. The ParmFile is a list of Start/Stop mark information beginning with the first
  269. start mark followed by a RETURN followed by the stop mark followed by the next
  270. start mark or the 'fin' or 'FIN' termination string.
  271.  
  272. Example ParmFile:
  273.                            1         2
  274.   Column Position 12345678901234567890
  275.                   --------------------
  276.                   @4 December:12
  277.                   @8 TOTAL
  278.                   FIN
  279. *P
  280. *H
  281.                             HELP!
  282. *L
  283.  
  284. In the example ParmFile the start mark entry of (@4 December:12) is entered
  285. just as it would be by the manual method. Followed in the next line is the
  286. matching stop mark (@8 TOTAL). Every start mark must be followed by a stop
  287. mark or unpredicable results will occur.
  288.  
  289. The ParmFile is ment to replace long multiple extract specifications having
  290. to be entered by the user each time an extract is to be produced. As many
  291. different ParmFiles can exist as user disk space will allow. It is up to
  292. the user to assign file names and extensions to conform to his or her own
  293. conventions.
  294.  
  295. To request that a ParmFile be input at this point, enter the word (file) or
  296. (FILE) and press RETURN. You will be prompted to enter the file name and
  297. location.
  298.  
  299.            Enter ParmFile (drive:\name.ext) => {name}
  300.  
  301. Entry of the word (end) or (END) will terminate SXU at this point.
  302.  
  303. *E
  304. */940
  305. *H
  306.                              HELP!
  307. *L
  308.  
  309. SXU will not stop recovery of data from a specified file, until it finds
  310. a stop mark. A stop mark can be any combination of text or numerical
  311. characters up to a maximun of 80. The stop mark must appear within the first
  312. 80 characters of the data record for which it is specified. SXU begins its
  313. stop mark search with character 1 of each data record and reads thru the
  314. 80th. character.
  315.  
  316. Example Data Record:
  317.                             1         2
  318.       Column       12345678901234567890
  319.                    Now is the time.....
  320.  
  321. In the above example if the phrase (Now is the), is used for the stop mark,
  322. SXU will stop recovery of data from the input file when it finds the matching
  323. phrase. It must be noted that the stop mark phrase and the actual phrase
  324. must match character for character. Upper/lower case characters must be the
  325. same as SXU does consider upper and lower case characters to be different.
  326.  
  327. SXU does recover and print the stop mark record, recover ends with the
  328. stop mark record.
  329. *P
  330. *H
  331.                              HELP!
  332. *L
  333.  
  334. Be sure when entering a start or end mark to consider the leading spaces
  335. which may be present before the actual text. SXU considers spaces as valid
  336. characters, therefore if the mark is preceeded by 3 spaces in the actual
  337. record, the mark must be entered with the three spaces preceeding it.
  338.  
  339. SXU allows for entry of 32 separate start and stop markers at one time.
  340. This allows for multiple extracts to be made from the same file, without
  341. having to enter each start and stop mark in separate program runs.
  342.  
  343. During entry of start and stop markers, the lower right corner displays
  344. the number of the marker being entered. To end the entry of markers the
  345. letters 'fin' or 'FIN' must be entered in response to the start mark
  346. prompt. If you enter the full 32 markers, SXU will accept the 32nd. mark
  347. and automatically stop further input requests.
  348.  
  349. To END the session at this point enter the word 'end' or 'END'.
  350. *E