home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR3 / JSPICK21.ZIP / JSPICK.TXT < prev    next >
Text File  |  1993-09-28  |  9KB  |  254 lines
  1. JSPICK Utility Program Documentation
  2. (Ver 2.1, 09-24-93)
  3.  
  4. Author: Johnathan Mark Smith
  5.  
  6.  
  7. THE OLD DISCLAIMER
  8.  
  9.   This software and manual are sold "as is" and without warranties
  10.   as to performance or merchant ability or any other warranties
  11.   whether expressed or implied. Because of the various hardware and
  12.   software environments into which this program may be put, no
  13.   warranty of fitness for a particular purpose is offered.
  14.  
  15.   The user must assume the entire risk of using and evaluating this
  16.   program. Any liability of  Johnathan Mark Smith Technology will be
  17.   limited exclusively to product replacement or refund of purchase
  18.   price. If you find these terms unacceptable, do not use this
  19.   product.
  20.  
  21. Introduction
  22.  
  23.         As time goes by, more and more Mainframe Systems are being down
  24. sized to run on PC's. One of the biggest setbacks is matching data
  25. from one file to the next file. The JSPICK utility will simplify the
  26. task of checking to see if you have the same key on two files. JSPICK
  27. must be provided with two files to match and a control file. All these
  28. files must be ASCII files.
  29.  
  30.         JSPICK can be used to:
  31.         1. Create a file with all the records on file one which have
  32.            a matching key on file two.
  33.         2. Create a file with all the records on file one which do not
  34.            have a matching key on file two.
  35.         3. Create a file selecting records from one file by using a key
  36.            file as file two.
  37.  
  38.         The best part is that JSPICK can do all this without any of the
  39. files being sorted by the key used for matching. 
  40.  
  41.  
  42.     The JSPICK program must be provided with control information
  43. to govern its execution. This information is read from a control file. 
  44. The control file is a standard PC text file that can be created with
  45. any ASCII text editor.
  46.  
  47. To run JSPICK type at the prompt:    JSPICK [options] <control file name> 
  48.  
  49.  
  50.  
  51.                     THE CONTROL FILE:
  52.                     ----------------
  53.  
  54. The first line of the control file identifies the mode to run in.
  55.  
  56. The second line of the control file identifies the
  57. file(CALL THE MATCH ON FILE)  to match on,
  58. starting byte of the field to match on and the size of the field.
  59.  
  60. The third line of the control file identifies the file(CALL THE INPUT FILE)
  61. from which to pick off the matching and the non-matching records, and the
  62. starting byte of the key field.
  63.  
  64. The forth line of the control file identifies the file to put the
  65. matching records out to.
  66.  
  67. The fifth line of the control file identifies the file to put the
  68. non-matching records out to.
  69.  
  70. The following sample control file illustrates how control information 
  71. is provided to the JSPICK program.
  72.  
  73.  
  74. Contents of a sample #1 of JSPICK control file, JSPICK1.CTL:
  75.  
  76.         BOTH
  77.         C:\DATA\KEYS.TXT,4,10
  78.         C:\DATA\INPUT.TXT,6
  79.         C:\DATA\MATCH.DAT
  80.         C:\DATA\NONMATCH.DAT
  81.  
  82. The word "BOTH" tells the program to create both output files.
  83.  
  84. Line #2 tells the program that the file(THE MATCH ON FILE) with the keys is
  85. "C:\DATA\KEY.TXT" and the key starts in byte 4 for the length of 10 bytes.
  86.  
  87. Line #3 tells the program that the input file name is
  88. "C:\DATA\INPUT.TXT" and the key starts in byte 6 of the input file.
  89.  
  90. line #4 tells the program to put the matching records in the file
  91. "C:\DATA\MATCH.DAT"
  92.  
  93. line #5 tells the program to put the non-matching records in the file
  94. "C:\DATA\NONMATCH.DAT"
  95.  
  96.  
  97. Contents of a sample #2 of JSPICK control file, JSPICK2.CTL:
  98.  
  99.         MATCH
  100.         C:\DATA\KEYS.TXT,4,10
  101.         C:\DATA\INPUT.TXT,6
  102.         C:\DATA\MATCH.DAT
  103.  
  104.  The word "MATCH" tells the program to create only a file with
  105. the matching records in it.
  106.  
  107. Line #2 tells the program that the file(THE MATCH ON FILE) with the keys is
  108. "C:\DATA\KEY.TXT" and the key starts in byte 4 for the length of 10 bytes.
  109.  
  110. Line #3 tells the program that the input file name is
  111. "C:\DATA\INPUT.TXT" and the key starts in byte 6 of the input file.
  112.  
  113. line #4 tells the program to put the matching records in the file
  114. "C:\DATA\MATCH.DAT"
  115.  
  116.  
  117. Contents of a sample #3 of JSPICK control file, JSPICK3.CTL:
  118.  
  119.         NOMATCH
  120.         C:\DATA\KEYS.TXT,4,10
  121.         C:\DATA\INPUT.TXT,6
  122.                 C:\DATA\NONMATCH.DAT
  123.  
  124. The word "NOMATCH" tells the program to create only a file with
  125. the non-matching records in it.
  126.  
  127. Line #2 tells the program that the file (THE MATCH ON FILE) with the keys is
  128. "C:\DATA\KEY.TXT" and the key starts in byte 4 for the length of 10 bytes.
  129.  
  130. Line #3 tells the program that the input file name is
  131. "C:\DATA\INPUT.TXT" and the key starts in byte 6 of the input file.
  132.  
  133. line #4 tells the program to put the non-matching records in the file
  134. "C:\DATA\NONMATCH.DAT"
  135.  
  136.  
  137. NOTE:
  138.       If line #1 is not one of the following (BOTH, MATCH, NOMATCH)
  139.       the program will default to BOTH. A match file and a nomatch file
  140.       must be supplied.
  141.  
  142.  
  143.  
  144.  
  145.                                OPTIONS:
  146.                                -------
  147.  
  148.         At the prompt when you type JSPICK, there are two options
  149. available for the execution of that particular run.
  150.  
  151.         1) -iz     This option will tell the utility that the
  152.                    INPUT file is not CRLF and the record length
  153.                    is z long.
  154.  
  155.         2) -mz     This option will tell the utility that the
  156.                    MATCH ON file is not CRLF and the record length
  157.                    is z long.
  158.         
  159.         3) -s      This will surpress the graph that shows on
  160.                    the screen when JSPICK is executed and the
  161.                    counters will only be displayed at program
  162.                    termination. The advantage of using this opiton
  163.                    is that the program will run MUCH, MUCH FASTER.
  164.                    (Try it!)
  165.  
  166.         4) -C      This option will turn off case sensitivity.
  167.                    JSPICK will not care if the key is upper case,
  168.                    lower case, or a mix of both. For example:
  169.                    All these keys will match:   John
  170.                                                 JOHN
  171.                                                 john
  172.                                                 jOhN
  173.  
  174.  
  175.  
  176. Registration
  177.  
  178.   I will keep improving the program if I know enough people are
  179.   finding it useful.
  180.  
  181.   My registration policy is very flexible. The nominal fee are listed
  182.   in the file REGISTER.TXT. If you don't feel you will get your money
  183.   worth of use out of JSPICK, send whatever it is worth to you.
  184.   If you are impoverished and can't afford to pay anything,
  185.   enclose a stamped self-addressed envelope
  186.   and I will send you a registration.
  187.  
  188.   This is not freeware or public domain. Shareware is simply a means
  189.   of marketing commercial software. You are required to register if
  190.   you intend to use this program after a reasonable trial period.
  191.  
  192.   When registering, please tell me the version number you have 
  193.   and where you obtained your copy of JSPICK.
  194.  
  195.   Foreign checks and credit cards OK. See REGISTER.TXT for details.
  196.  
  197.   JSPICK should be registered for the maximum number of copies that
  198.   can be used simultaneously at your site. Site fees for commercial
  199.   users can be negotiated.
  200.  
  201.   If you register for the full fee, and enclose a Shipping and
  202.   Handling fee of $3 I will send you the latest versions of JSPICK and
  203.   Some Free Demo's.  if you decide to use it after a trial period. 
  204.   I will also send other File related shareware programs.
  205.  
  206.  
  207. Registered version features
  208.  
  209. * FREE UPGRADES AND NEWSLETTERS
  210.  
  211. * CUSTOM DEFAULT SETTINGS
  212.  
  213. * DISCOUNTS ON SHAREWARE
  214.  
  215.  
  216. Program Abort
  217.  
  218.     Hitting Control-C (or Control-Break) will terminate the program
  219.     immediately. 
  220.  
  221.  
  222. Distribution
  223.  
  224.     Permission is hereby given to copy and distribute this program
  225.     as long as no more than $5 is charged. It must be made clear to
  226.     the buyer that this is only a handling charge and not a
  227.     registration fee. You must include all files in their original
  228.     unmodified form when distributing this program. .
  229.  
  230.     Permission to distribute may be revoked by the Johnathan Mark Smith 
  231.     at any time for any reason.
  232.  
  233.     YOU MUST NOT DISTRIBUTE ANY COPY WHICH HAS BEEN BRANDED WITH
  234.     A REGISTRATION CODE. 
  235.  
  236. All trademarks used in this document are the property of their
  237. owners.
  238.  
  239.                          -Johnathan Mark Smith-
  240.  
  241.  
  242. Questions or suggestions regarding JSPICK should be directed to the
  243. author at the following address:
  244.  
  245.     Johnathan Mark Smith
  246.     2039 85 STREET
  247.     BROOKLYN, NY 11214
  248.  
  249.     Telephone: 718-373-3886
  250.  
  251.  
  252.  
  253.  
  254.