home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Unix / hack / class-dump.1.3.1.README < prev    next >
Encoding:
Text File  |  1994-05-19  |  3.4 KB  |  108 lines

  1. This is the README for class-dump, a useful adjunct to otool and
  2. AppInspector.  This command-line utility can display the classes,
  3. instance variables, methods, and protocols an executable or
  4. shared library presents to the Objective C runtime system.  The
  5. output resembles the syntax used in header files.  More detailed
  6. information can be found on the manual page.
  7.  
  8.  
  9. Notes for version 1.3.1:
  10.  
  11. If you are running 3.2 (Lightning5S or Thunder5S):
  12.  
  13.   Copy NS3.2/class-dump to an appropriate place, such as
  14.   /usr/local/bin, or ~/Unix/bin.  This version is identical to
  15.   version 3.1, except for a minor fix to correct a byte ordering
  16.   problem.  This is the first release to be compiled "fat" for
  17.   both m68k and i486.
  18.  
  19.  
  20. Notes for version 1.3:
  21.  
  22. This is primarily a bug fix release.  The major change is that
  23. pointers to arrays are now decoded correctly (oops!).  It also
  24. properly handles zero-sized bitfields and empty structs, and
  25. some changes necessitated by newer versions of gcc.
  26.  
  27. There's some stronger sanity checking on protocols, and an
  28. (unfinished) attempt to deal with a NeXT-gcc bug that causes
  29. @encode(long long) to return nothing!  (This is probably the
  30. reason why BugNeXT.app gives it indigestion.)
  31.  
  32. The only really "new" feature is that if you tell class-dump to
  33. examine foo.app it will interpret that as foo.app/foo (since app
  34. wrappers are now the rule rather than the exception--it's a
  35. useful shortcut).
  36.  
  37.  
  38. If you are running the 2.x Release:
  39.  
  40.   Copy NS2.1/class-dump to an appropriate place, such as
  41.   /usr/local/bin, or ~/Unix/bin.  While this version will run on
  42.   a 3.x system, it will only handle 2.x files.
  43.  
  44.  
  45. If you are running the 3.0 or 3.1 (Lightning4H) Release:
  46.  
  47.   Copy NS3.0/class-dump to an appropriate place, such as
  48.   /usr/local/bin, or ~/Unix/bin.  This version is a superset of
  49.   the NS2.1 executable.  It understands 3.x's protocols, expanded
  50.   method types, and strong typing.  (It will also read 2.x
  51.   executables, so there is no need to keep the NS2.1 version
  52.   around if you can run this.)
  53.  
  54.  
  55. If you are running NS/FIP:
  56.  
  57.   Sorry, this release of class-dump only supports the m68k
  58.   architecture.
  59.  
  60.  
  61. What to do with the manual page:
  62.  
  63.   You can copy man/class-dump.l to /usr/man/manl and the right
  64.   thing should happen.  You can also use
  65.  
  66.     nroff -man man/class-dump.l
  67.         to produce the ASCII version
  68.  
  69.     ptroff -t -man man/class-dump.l >man/class-dump.ps
  70.         to product the PostScript version
  71.         (suitable for Preview)
  72.  
  73.  
  74. Licensing:
  75.  
  76.   class-dump is a copyrighted work, distributed free of charge
  77.   for personal, educational, and noncommercial use.  It may not
  78.   be sold for profit, nor incorporated in products sold for
  79.   profit without the express permission of the author.  However,
  80.   recognized NeXT User Groups may include it on diskettes, tapes,
  81.   CD-ROMs, or other media priced above time-and-materials costs
  82.   for fundraising purposes.  This software may be placed on
  83.   Internet archive sites or other public software archives
  84.   provided that no "download" or other "enhanced services"
  85.   charges are assessed for access.
  86.  
  87.   Only a nonexclusive license to use is granted; all other rights
  88.   are retained by the copyright holder.
  89.  
  90.   Please do not redistribute modified versions of this package.
  91.  
  92.  
  93. Source code availablility:
  94.  
  95.   Source code is not currently available.
  96.  
  97.  
  98. Author's address:
  99.  
  100.     Eric P. Scott
  101.     Department of Computer Science
  102.     San Francisco State University
  103.     1600 Holloway Avenue
  104.     San Francisco, CA  94132
  105.     USA
  106.  
  107.     <eps@cs.sfsu.edu> (NeXT Mail discouraged)
  108.