home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / toolkit.zip / TOOLKIT.DOC < prev    next >
Text File  |  1986-05-27  |  16KB  |  529 lines
  1.          
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                             ==========================
  15.                             =        TOOLKIT         =
  16.                             =    MS-DOS UTILITIES    =
  17.                             =        - by -          =
  18.                             =   Steven E. Margison   =
  19.                             ==========================
  20.  
  21.  
  22.                     Programs and Documentation Copyright 1986
  23.                    by Steven E. Margison -- All Rights Reserved
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.                    TOOLKIT Programs  Issue A          Page 1
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.          
  68.  
  69.  
  70.  
  71.  
  72.                              TOOLKIT MS-DOS UTILITIES
  73.  
  74.  
  75.          I. INTRODUCTION
  76.                  Almost anyone who writes software eventually winds up by
  77.          writing a whole bunch of  short  utilities  for  various  tasks.
  78.          Normally,  I  issue  each  program  as  a  stand-alone ShareWare
  79.          program.  However, I have several programs which  I  just  can't
  80.          justify issueing  as  separate  products.  Therefore, my TOOLKIT
  81.          will become the repository for all these little bits and pieces.
  82.          The programs contained in this package may not all  be  to  your
  83.          use,  but it is hoped that at least one or two will be useful to
  84.          almost any PC user.  This package will be updated very often  to
  85.          include  new  goodies,  and  an  update policy will be described
  86.          later in this document.
  87.  
  88.  
  89.  
  90.  
  91.          II. OVERVIEW OF PROGRAMS
  92.                  Here is a short list and  description  of  the  programs
  93.          currently in the TOOLKIT:
  94.  
  95.               * INPATH
  96.               A utility to locate an EXECUTABLE program in your PATH
  97.               variable.   Will  report  the  location of the program
  98.               which would be executed if you used the filename as  a
  99.               DOS command.  Identical to the UNIX program "whereis".
  100.  
  101.               * TC
  102.               This  is  a  Text Compare program, which works only on
  103.               ASCII text files.    It  reports  differences  between
  104.               files  in  a  very  friendly manner, unlike some other
  105.               DIFF-type programs.      Most   useful   for    subtle
  106.               differences, such as changed words or spellings.
  107.  
  108.               * WC
  109.               This  is  a  Word  Counting  program which will report
  110.               words, characters, lines, and a checksum on the  file.
  111.               For non-text files, only the checksum is reported.
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                    TOOLKIT Programs  Issue A          Page 2
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.          
  134.  
  135.  
  136.          III. PROGRAMS IN DETAIL
  137.  
  138.                                       INPATH
  139.  
  140.                  Typing INPATH at the DOS prompt will display the version
  141.          number and a short usage message.  To use, type:
  142.  
  143.                inpath <filename>
  144.  
  145.          where filename is the basename portion of the executable file to
  146.          find.  Note that an  extension  can  be  specified,  but  it  is
  147.          ignored.   INPATH  will  first  look for the file in the current
  148.          directory, and then look in the PATH environment variable (if it
  149.          is present) in the order specified.  For each directory,  INPATH
  150.          first tries to locate a .COM file, then a .EXE file, then a .BAT
  151.          file,  since  that is the order in which DOS searches for files.
  152.          On the first  match,  INPATH  reports  the  directory  and  full
  153.          filename of the program and then exits.  If none are found, that
  154.          fact is reported.
  155.  
  156.  
  157.                                         TC
  158.  
  159.                  Typing  TC  at  the  DOS prompt will display the verison
  160.          number and a short usage message.  To use, type:
  161.  
  162.                tc file1 file2
  163.  
  164.          where file1 and file2 are the two files  to  compare.    If  the
  165.          files are  identical,  no  more message will appear.  Otherwise,
  166.          the program will report any lines which are different  with  the
  167.          filename, line  number,  and  a printout of the actual line.  If
  168.          one file ends before the other, the program reports  which  file
  169.          terminated first.
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.                    TOOLKIT Programs  Issue A          Page 3
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.          
  200.  
  201.  
  202.                                         WC
  203.  
  204.                  Typing WC at the DOS prompt  will  display  the  version
  205.          number and a short usage message.  To use, type:
  206.  
  207.                 wc filename [-wcls]
  208.  
  209.          where filename  is  the  name  of the file to act upon.  With no
  210.          options, the program will report words, characters, lines, and a
  211.          checksum, which is a simple binary  addition  of  all  character
  212.          values.   No,  it ain't a CRC, but it is a quick check to see if
  213.          it the same as another file under the same name.    The  options
  214.          [wcls] tell the program to report ONLY the items specified:
  215.  
  216.               -w     report only words
  217.               -l     report only lines
  218.               -c     report only characters
  219.               -s     report only checksum
  220.  
  221.          Note that giving all options is the same as giving no options.
  222.  
  223.          Since words, lines, and characters are meaningless in a non-text
  224.          file,  the  program examines the filename extension to determine
  225.          if the file is a binary or text file.    This  isn't  a  perfect
  226.          method, but  it  is good enough.  If the file extension is .COM,
  227.          .EXE, .OBJ, .REL, .PFS, .LIB, or .BIN, then only the checksum is
  228.          reported, overriding all other options.  The current version  of
  229.          the  program  does  not  support  wildcards in the filename, but
  230.          drives and directories are supported.
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.                    TOOLKIT Programs  Issue A          Page 4
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.          
  266.  
  267.  
  268.          IV. SHAREWARE AND COMMERCIAL LICENSING
  269.                  By  now,  the ShareWare concept should be familiar to PC
  270.          users.   In  a  nutshell,  ShareWare   is   "try-before-you-buy"
  271.          software, reasonably  priced  and  user-supported.   This simply
  272.          means that you can get ShareWare software for free  from  anyone
  273.          who has  a  copy,  or often from bulletin board systems.  If you
  274.          use and like the program, then the author requests a donation to
  275.          support further software development.  By registering and making
  276.          a donation, you will often  also  receive  notice  of  available
  277.          upgrades or  supplemental  programs.    Of course, payment under
  278.          ShareWare is voluntary, but if the program  is  useful  and  the
  279.          price  is  right, why not pay the dues and provide the incentive
  280.          and reward necessary to continue development of new  and  better
  281.          software?
  282.                  TOOLKIT programs  are  ShareWare  programs.  If you like
  283.          and use them, a donation of $5.00 to the author will  place  you
  284.          on  a  mailing  list  for  any  future upgrade notices, and will
  285.          register you as a user of these programs.  You will also receive
  286.          a diskette (DSDD 5.25" DOS 2.0+) with the  latest  versions  and
  287.          documentation,  plus  other  documentation relative to ShareWare
  288.          programs by Steven Margison.  A registration form is provided at
  289.          the end of this manual.  For  a  donation  of  $8.00,  you  will
  290.          receive the  next  TOOLKIT  upgrade  automatically.  If you have
  291.          suggestions for the improvement of these programs,  please  send
  292.          them to  the  author.    If  they are incorporated into a future
  293.          version of the program you will receive a  free  disk  with  the
  294.          newer version.   Even if your suggestions are not used, they are
  295.          appreciated and will be given due consideration.    It  is  only
  296.          through  user  feedback  that  future  programs and upgrades can
  297.          answer the needs of the PC community.
  298.                  TOOLKIT may be used in  a  commercial  environment  only
  299.          upon  payment of a site licensing fee to the author, although it
  300.          may be tried for free under  the  ShareWare  concept.    A  site
  301.          license  for  any  number  of  computers at the same location is
  302.          $15.00, or $20.00 for one automatic upgrade.
  303.                  TOOLKIT may be freely exchanged or given away.  However,
  304.          it may not be included or "bundled" with any software  which  is
  305.          sold  or is a commercial product, nor may any charge be made for
  306.          copying or transferring the files.  PC Users groups may  request
  307.          from the author an exemption to this restriction.
  308.                  TOOLKIT and its documentation may not be transferred nor
  309.          exchanged in  any  modified  form.  If you really want to "hack"
  310.          the program or the documentation, by all means do so; but  don't
  311.          give the  hacked  version to anyone else.  This author cannot be
  312.          expected to help others use this program if it is not  the  same
  313.          as it  was  when  distributed.    Under no circumstances may the
  314.          copyright notices be altered or removed from the program or this
  315.          documentation.
  316.                  TOOLKIT programs were written in the C  language.    The
  317.          source  code  is available from the author, but it is NOT in the
  318.          public domain.  Source code on a  DSDD  5.25"  diskette  may  be
  319.          obtained for  personal  use  upon  payment of a $20.00 fee.  The
  320.  
  321.  
  322.                    TOOLKIT Programs  Issue A          Page 5
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.          
  332.  
  333.  
  334.          source code  may  NOT  be  exchanged.    The  source code may be
  335.          purchased for commercial use by special request to  the  author,
  336.          and  the  payment  of $40.00 if not for resale, or $80.00 if for
  337.          resale.
  338.  
  339.  
  340.  
  341.  
  342.          V. WARRANTY
  343.                  Oh,  this  shouldn't  be  necessary  among  friends  and
  344.          gentlemen,  but  it's  really  the lawyers who run the world and
  345.          they say we gotta do this:
  346.  
  347.  
  348.               ** TOOLKIT programs are hereby placed  in  the  Public
  349.               Domain,   subject  to  the  limitations  specified  in
  350.               section IV of this manual.
  351.               ** TOOLKIT programs and  documentation  are  copyright
  352.               1986 by Steven E. Margison.
  353.               **  These  programs and documentation are provided "as
  354.               is" without warranty of any kind, either expressed  or
  355.               implied,  including  but  not  limited  to the implied
  356.               warranties  of  merchantability  and  fitness  for   a
  357.               particular purpose.
  358.               **  The user of these programs and documentation agree
  359.               to hold  the  author  and/or  distributor(s)  of  this
  360.               program  and  documentation harmless for any direct or
  361.               consequential damages resulting  from  its  use.    In
  362.               other words, "you're on your own!"
  363.               **  If  these  programs were received by the user on a
  364.               diskette directly from the author (S.E. Margison) then
  365.               the diskette will be warranted to be free from defects
  366.               for a period of 30 days from date of purchase.    Sole
  367.               liability  of  the  author  shall  be  to replace such
  368.               defective diskette with a like diskette upon return of
  369.               the defective  diskette.  "Defective  diskette"  shall
  370.               mean  a  diskette  which is physically or magnetically
  371.               damaged in such a way as to make  the  contained  data
  372.               inaccessible to a properly functioning computer of the
  373.               type intended for the media.
  374.               **  IBM  is  a  registered  trademark of International
  375.               Business Machines Corporation.
  376.               ** MS-DOS is a trademark of MicroSoft Corporation.
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.                    TOOLKIT Programs  Issue A          Page 6
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.          
  398.  
  399.  
  400.          VI. And Now A Word From The Author...
  401.                  Well,  if  you got this far, you must be at least mildly
  402.          interested in what I have to say; for that I thank you.  I  hope
  403.          that  you will use TOOLKIT programs and find them indispensable.
  404.          Besides money, user satisfaction is all that a  REAL  programmer
  405.          wants out  of  life.    Even if you do not decide to donate, I'd
  406.          like  to  hear  your  comments   on   the   program   and   this
  407.          documentation.
  408.                  Got  an  idea  for a program which you would like to see
  409.          written?  Let me know -- I pay commissions on ideas which I  use
  410.          for new ShareWare programs!
  411.                  A business-sized SASE will bring you a list of currently
  412.          available programs from me.
  413.  
  414.                             --- Steven E. Margison ---
  415.                           --- CompuServe 74435,1042 ---
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.                    TOOLKIT Programs  Issue A          Page 7
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.          
  464.  
  465.  
  466.          
  467.          =======================================================================
  468.                       SOFTWARE REGISTRATION FORM AND ORDER
  469.          =======================================================================
  470.          A separate form must be filled out for each product ordered or
  471.          registered.  This form may be photocopied, printed out, or
  472.          edited to include all information and re-printed.
  473.          
  474.          PRODUCT: --------- TOOLKIT PROGRAMS Issue A ---------------------
  475.          
  476.          Check all that apply:                                    Amount:
  477.          
  478.          [ ]  Standard non-commercial registration   $5.00        $______
  479.          [ ]  as above, with 1 free update           $8.00        $______
  480.          [ ]  Commercial site license                $15.00       $______
  481.          [ ]  as above, with 1 free update           $20.00       $______
  482.          [ ]  Non-commercial Source Code license     $20.00       $______
  483.          [ ]  Commercial Source Code license         $40.00       $______
  484.               * for non-resale use only.  Attach explanation
  485.                 of need for source code and intended purpose.
  486.          [ ]  Commercial Source Code license         $80.00       $______
  487.               * for resale use.  Attach explanation of intended
  488.                 use in your product of source code or modified
  489.                 program code.
  490.          
  491.                                           TOTAL ENCLOSED:         $______
  492.          
  493.          Payment is by check[ ] or money order[ ] (Sorry - no COD or charges)
  494.          
  495.          NAME _______________________________________________________
  496.          
  497.          COMPANY ____________________________________________________
  498.          
  499.          ADDRESS ____________________________________________________
  500.          
  501.          CITY _______________________________________________________
  502.          
  503.          STATE___________________________ ZIP _______________________
  504.          
  505.          =======================================================================
  506.          Send completed form and payment to:
  507.                              Steven E. Margison
  508.                               124 Sixth Street
  509.                           Downers Grove, IL, 60515
  510.          =======================================================================
  511.                        - do not write below this line -
  512.          
  513.          recd________________________   sent_______________________       
  514.          
  515.          version #__________  serial #________________  
  516.  
  517.  
  518.  
  519.  
  520.                    TOOLKIT Programs  Issue A          Page 8
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.