home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tlint1_0.zip / tlint1_0 / doc / README < prev   
Text File  |  1996-02-05  |  9KB  |  255 lines
  1. README for Thinkage LINT
  2.  
  3. Contents:
  4. ---------
  5. *About TLINT
  6. *Installation
  7. *Distribution, copyright
  8. *Registration
  9. *Bug Reports
  10. *Contact information
  11.  
  12. 1. About TLINT
  13.  
  14. Thinkage LINT examines source code written in the C programming
  15. language and reports on questionable or non-portable constructs.
  16. Because of our extensive experience in porting software to non-standard
  17. computing platforms, our version of LINT catches more potential
  18. problems and provides more comprehensible diagnostic messages than many
  19. other LINT packages.
  20.  
  21. This package runs on SunOS, Linux, Windows NT, DOS and OS/2 platforms.
  22.  
  23. 2. Installation
  24.  
  25. See end of this section for system-specific instructions.
  26.  
  27. To unpack LINT 1.0, run one of the following commands depending on
  28. which archive you have:
  29.  
  30. For tlint-1.0.tar.Z (compressed tar file on SunOS):
  31.     zcat tlint-1.0.tar.Z | tar xvf -
  32.  
  33. For tlint-1.0.tar.gz (Gnu-zipped tar file on SunOS and Linux):
  34.     zcat tlint-1.0.tar.gz | tar xvf -
  35.  
  36. For tlint1_0.zip (zipped file on DOS, OS/2, and Windows NT):
  37.     unzip tlint1_0.zip
  38.  
  39. This operation unpacks everything into a directory called 'tlint1.0'
  40. on SunOS and Linux, and 'tlint1_0' on OS/2, DOS and NT.  To install
  41. LINT, change to this directory and run the 'setup' program.
  42.  
  43. The setup program will ask you where to put the various LINT-related
  44. files.  It will also create an installation file that tells LINT
  45. where to find the files it needs.  If you don't use the default
  46. filename for the installation file, you must set the LINT_INST
  47. environment variable to be the name of the installation file.
  48. Alternately, you can use LINT's INSTallation= command-line option.
  49.  
  50. After setup finishes, you can look at the setup.log file to see what
  51. it did.
  52.  
  53. Finally, you should copy the 'tlint' executable file to a directory
  54. that is in your search path.
  55.  
  56. 2.1 OS/2-Specific Instructions:
  57.  
  58. OS/2 users can get unzip from
  59. <ftp://ftp.cdrom.com/pub/os2/archiver/unz512x2.exe>.  Create a new
  60. directory and run unz512x2.exe from within it.  This will create a
  61. number of files including README and unzip.exe.  See the README for
  62. further information.  Using PKZIP for OS/2 is not recommended.
  63.  
  64. 2.2 SunOS-Specific Instructions:
  65.  
  66. SunOS users will need gzip.  You can fetch the README from 
  67. ftp://prep.ai.mit.edu/pub/gnu/README-about-.gz-files.  Gzip source 
  68. can be found at ftp://prep.ai.mit.edu/pub/gnu/gzip-1.2.4.tar.
  69.  
  70. 2.3 DOS-Specific Instructions:
  71.  
  72. DOS users require the DOS4GW.EXE 32-bit extender which is included in
  73. the distribution under the DOS4GW directory.  This must be installed
  74. before installing LINT.  See the file DOS4GW.DOC for installation and
  75. configuration instructions.  Normally, you only need to copy
  76. DOS4GW.EXE to a directory that is in your search path, but the
  77. documentation explains settings that you may need if you have unusual
  78. hardware or if you do not like the defaults.
  79.  
  80. Since DOS restricts command-line lengths to 128 characters, you may
  81. encounter a problem if you use many CPP options (such as Include= or
  82. Define=).  If you get a message like "Argument list too big", or you
  83. are experiencing other problems, you can put your CPP options in a
  84. configuration file.  The syntax of configuration file statements are
  85. described in the help document.
  86.  
  87. 2.4 Removal:
  88.  
  89. Change to a directory that was NOT created during the installation
  90. procedure (such as your home directory or the root directory).
  91. Run the 'uninst' program using the full name of the command.
  92. You will be prompted for a log file name.  This file will be used
  93. to log errors and list all files and directories that are removed.
  94. By default this information will be printed to your display.
  95. After uninst finishes, you can look at the log file to see what
  96. uninst did.
  97.  
  98. If uninst cannot find the installation file, it will ask you
  99. where it is.  It will then remove all the files that the setup
  100. program installed.  If you have installed LINT more than once on
  101. the same system you must be careful to uninstall the correct one.
  102. The safest way to do this is to use the INSTallation= option:
  103.  
  104.    /usr/local/lib/tlint-1.0/uninst INST=/usr/local/lib/tlint-1.0/instinfo
  105.  
  106. or on OS/2, DOS or Windows NT:
  107.  
  108.    C:\thinkage\tlint1_0\uninst INST=C:\thinkage\tlint1_0\instinfo
  109.  
  110. Those examples reflect the default values for the INSTallation=
  111. option.  You would not need to use the INSTallation option in those
  112. cases unless the LINT_INST variable was set.  If LINT was installed on
  113. OS/2, DOS or NT in D:\tlint-1.0 then you might use
  114.  
  115.    D:\tlint-1.0\uninst INST=D:\tlint-1.0\instinfo
  116.  
  117. Uninstallation is slightly different on OS/2.  The OS/2 version of
  118. uninst will usually report that it was unable to delete some of its
  119. files (such as uninst.exe).  This occurs because OS/2 will not allow
  120. files to be deleted if they are in use.  Usually uninst can delete
  121. these files after the uninst program is finished.  You should check
  122. that these files were deleted.  You do not need to reboot after
  123. running uninst.
  124.  
  125. 2.5 Documentation:
  126.  
  127. Documentation is provided in both text and postscript versions.  You
  128. can find the postscript versions of the full manual and the LINT
  129. command-syntax help in the following files:
  130.  
  131. SunOS and Linux:
  132.     tlint-1.0-manual.ps
  133.     tlint-1.0-help.ps
  134.  
  135. DOS, OS/2 and Windows NT:
  136.     lnt10man.ps
  137.     lnt10hlp.ps
  138.  
  139. 3. Distribution, copyright
  140.  
  141. For purposes of this section, the term "User" is defined as anyone
  142. trying out the Program and/or a registered licensee of the Program.
  143.  
  144. This software is protected by both Canadian Copyright Law and
  145. International Treaty provisions.  Therefore you must treat this
  146. software just like a book with the following single exception.
  147. Thinkage Ltd. authorizes you to make archival copies of the software
  148. for the sole purpose of backing up your software and protecting your
  149. investment from loss.
  150.  
  151. By saying, "just like a book", Thinkage means, for example, that this
  152. software may be used by any number of people and may be freely moved
  153. from one location to another so long as there is no possibility of it
  154. being used at one location while it is being used at another.  In the
  155. same way that two different people in two different places cannot read
  156. the same book at the same time, neither may the software be used by two
  157. different people in two different places at the same time, without
  158. violating Thinkage's copyright.
  159.  
  160. Thinkage warrants that it has title to the Programs free of any lien,
  161. charge, encumbrance or claim.  Title to the programs and any materials
  162. associated therewith shall at all times remain in Thinkage.
  163.  
  164. Thinkage makes no representation with respect to the adequacy of these
  165. Programs for any particular purpose, or with respect to their adequacy
  166. to produce any particular result.
  167.  
  168. The User agrees to absolve Thinkage of any responsibility for losses,
  169. costs, damages, or expenses of every nature or kind due to use of the
  170. Programs.
  171.  
  172. If the User finds the programs unsatisfactory in any way, the User's
  173. sole recourse is to request a refund of moneys already paid to
  174. Thinkage.  In this case, Thinkage will return this amount to the User
  175. in a timely manner.  When the money has been returned, the User will
  176. destroy all of its copies of the programs and any products derived from
  177. the programs, and will cease to use the programs in any way.
  178.  
  179. 4. Registration
  180.  
  181. Registration form for Thinkage Ltd. shareware
  182.  
  183. Name:
  184.  
  185. Company Name (if applicable):
  186.  
  187. Address:
  188.  
  189. City:
  190.  
  191. Province/State:
  192.  
  193. Country:
  194.  
  195. Postal Code/Zip Code:
  196.  
  197. Phone:
  198.  
  199. Fax:
  200.  
  201. Email:
  202.  
  203. Software Registering:
  204.  
  205.     __ Thinkage LINT, Version 1.0 @ $50US per copy
  206.     
  207.     Total:    $    
  208.     (Payment methods accepted:  cheque or money order
  209.     made payable to:  Thinkage Ltd.)
  210.  
  211. (All applicable taxes included in price.)
  212.  
  213. Would you like us to notify you of upgrades to your software?:
  214.  
  215. Would you like us to notify you of new products from Thinkage?:
  216.  
  217. The following section is optional.  We have included it to speed up
  218. bug fixes and to get an idea of what systems people are using our software
  219. on.
  220.  
  221. System Hardware:
  222.  
  223.  
  224. Operating System:
  225.  
  226.  
  227.  
  228.  
  229. Mail your registration to 
  230. Shareware
  231. Thinkage Ltd.
  232. 85 McIntyre Drive
  233. Kitchener, Ontario
  234. Canada  N2R 1H6
  235.  
  236. Fax: 519-895-1864
  237.  
  238. Email: shareware@thinkage.on.ca
  239.  
  240. 5. Bug Reports
  241.  
  242. Please contact us with a description of any bugs you find, with as much
  243. detail as possible regarding the system and circumstances of the error.
  244.  
  245. 6. Contact Information
  246. Email: shareware@thinkage.on.ca
  247. Phone:  519-895-1860
  248. Fax: 519-895-1864
  249. Mail:
  250. Thinkage Ltd.
  251. 85 McIntyre Drive
  252. Kitchener, Ontario
  253. Canada  N2R 1H6
  254.  
  255.