home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / disks / disk417.lzh / WhatIs / WhatIs.doc < prev    next >
Text File  |  1990-12-16  |  18KB  |  491 lines
  1. ==============================================================================
  2.  
  3.         WhatIs This File ?              V2.0
  4.         © J.Tyberghein                  Sun Sep 23 20:20:27 1990
  5.  
  6. ==============================================================================
  7.  
  8.  
  9.  
  10. Preface
  11. -------
  12.   This utility gives you all useful information it can obtain from a file.
  13.   WHATIS recognizes IFF files, object files and executables (hunks),
  14.   Aztec object files, crunched data files (with the PowerPacker), archives
  15.   like ZOO, ARC and ArcFiles (my own archiver), UUEncoded files, .info files,
  16.   Lattice PGTB files, Warp files (disk warper), WordPerfect files and macros,
  17.   MaxiPlan files, font header files, crunched command files (with the
  18.   PowerPacker and some other crunchers), LHarc files, PowerWindows files,
  19.   ReSource files, sonix samples and the Preferences file
  20.   (system-configuration).
  21.   In addition it will print all information for this file.
  22.   If you specify a device or directory instead of a file, you get more
  23.   system information.
  24.   If WHATIS doesn't recognize your file, it will check if the file could
  25.   be ASCII.
  26.  
  27.   This program (WHATIS V2.0) is shareware, but I prefer utilities above
  28.   money. If you want to send money, send me a contribution of $10 US
  29.   ($15 if you want to get a new update (when one is available)).
  30.   Please send money by international money order, EuroCheck (in Belgian
  31.   Francs (BF) !) or cash, because it's very difficult for me to cash in
  32.   other checks.
  33.   If you want an update please state your current version.
  34.   If you want to use this program for commercial purposes please write
  35.   for permission !
  36.  
  37.   If you have any suggestions or remarks you can write to (Bug reports are
  38.   welcome too)
  39.  
  40.                             Jorrit  Tyberghein
  41.                              Hepmansbossen 31
  42.                            2450 Meerhout BELGIUM
  43.  
  44.   WHATIS is not perfect. There are still many files it doesn't recognize.
  45.   I would appreciate it if you'd send me all files which are not supported
  46.   yet and are common. If you have a description of these files please
  47.   send this also. So I don't have to dig in the files myself.
  48.   I don't know the full format for Zoo, Arc and LHarc. If someone out there
  49.   could send this information to me I can implement a 'list-file' feature
  50.   in WHATIS.
  51.   If someone has the information for ALL hunks available in 2.0, this
  52.   description would also be greatly appreciated.
  53.  
  54.  
  55. WARNING
  56. -------
  57.   If you want to use this utility you must have AmigaDOS 2.0 (or later :-).
  58.   WHATIS is reentrable so you can use it with ARes, Resident, ...
  59.   There are still some unsupported hunks in object files. These occure in
  60.   some new Lattice object files. As soon as I have information about these
  61.   new hunks, these shortcomings will be removed.
  62.  
  63.  
  64. Changes
  65. -------
  66.   New in 1.2:
  67.     Support for ATAK,RLSE,VHDR,SHDR,CAMG,CRNG and FONS chunks (for IFF files)
  68.     ASCII and DIAG options
  69.     Lattice hunk support is better (but not best)
  70.   New in 1.2a:
  71.     Support for ANHD and CCRT chunks (IFF)
  72.     Show preferences information
  73.     More information in hunks (BSS and chip)
  74.     More information in INS1 chunk (IFF)
  75.     Protection bits now show in right order
  76.     New IDENT option
  77.     Speed optimization
  78.   New in 1.3:
  79.     New WHATIS option (is default)
  80.     WHATIS recognizes font headers
  81.     WordPerfect files and macros
  82.     Sonix samples
  83.     PowerWindows files
  84.     MaxiPlan files
  85.     LHarc files
  86.     ReSource files
  87.     Crunched executables (PowerPacker,...)
  88.   New in 2.0:
  89.     Arp dependancy removed.
  90.     Made conform with AmigaDOS 2.0 commandline standard.
  91.     Hunks are a very little bit better (only a VERY little bit)
  92.     New flag in FileInfoBlock (FastFileSystem) supported.
  93.     It's now possible to start WHATIS from workbench.
  94.     Made completely resident.
  95.     New PAGE option.
  96.  
  97.  
  98. Supported files and features for the current version
  99. ----------------------------------------------------
  100.   Lattice ProGram TraceBack format (display all available information)
  101.   Warp file format (diplay file version number)
  102.   UUEncoded files (display name and size)
  103.   Zoo (simply state version)
  104.   Arc (no further information)
  105.   ArcFiles version 1.2 (QuickHelp Archiver) (list files in archive)
  106.   LHarc (no further information)
  107.   Sonix sound files (no IFF)
  108.   PowerWindow files (no further information)
  109.   WordPerfect files and macros (no further information)
  110.   MaxiPlan files (no further information)
  111.   ReSource files (no further information)
  112.   Crunched command files (version and hunks)
  113.     PowerPacker 1.0 to 3.0 (including overlays and encrypted files)
  114.     TNM cruncher 1.1
  115.     Relokit 1.0
  116.     HQC 2.0
  117.     MasterCrunch 3.0
  118.     DragPack 1.0b
  119.     TurboSqueeze 5.1
  120.     Titanics 1.1
  121.     Titanics 1.2
  122.   .info files (display gadget structure, DiskObject type and coordinates)
  123.   Aztec object files (no further information)
  124.   Aztec library files (list all functions in library)
  125.   Preferences file (display the complete contents of the file)
  126.   Hunks (Object files and executables) (list all hunks and display
  127.     information for each hunk)
  128.   IFF
  129.     Supported IFF formats:
  130.       ILBM  Interleaved BitMap
  131.       FTXT  Formatted text
  132.       PICS  QuickDraw picture
  133.       SMUS  Simple Musical Score
  134.       ANIM  Cel Animation Form
  135.       8SVX  8-bit Sampled Voice
  136.       ACBM  Amiga Contiguous BitMap
  137.       AIFF  Apple Audio Samples
  138.       ANBM  Animated BitMap Form
  139.       BANK  MIDI system-exclusive data dump
  140.       HEAD  Idea processor Form
  141.       MIDI  MIDI Form
  142.       PGTB  ProGram TraceBack diagnostic dump image (not really IFF)
  143.       SYTH  SoundQuest Master Librarian format for MIDI
  144.       WORD  Word processing form used by ProWrite
  145.       PDEF  Deluxe Print page definition
  146.       RGB4  4 bit RGB pixel information
  147.       SHAK  Used by Shakespeare (private)
  148.       VDEO  Used by Deluxe Video
  149.       SAMP  Sound Sample Form
  150.       TDDD  Used by Turbo Silver (ray tracing)
  151.       SC3D  Used by Sculpt-3D
  152.       TEXT  Plain unformatted ASCII text
  153.       FNTR  Raster font
  154.       FNTV  Vector font
  155.       GSCR  General-use musical score
  156.       USCR  Uhuru Sound Software musical score
  157.       UVOX  Uhuru Sound Software Macintosh voice
  158.       other IFF formats will simply appear on the screen without further
  159.       information (except for the listing of the chunks in the IFF file)
  160.     Supported IFF chunks:
  161.       LIST
  162.       CAT
  163.       CMAP  (ILBM) ColorMap
  164.       CRNG  (ILBM) ColorRange cycling chunk (used by DeluxePaint)
  165.       CCRT  (ILBM) Cycling chunk (use by Graphicraft)
  166.       GRAB  (ILBM) For sprites or brushes
  167.       CAMG  (ILBM) ViewModes for Amiga computers
  168.       BMHD  (ILBM) BitMapHeader
  169.       DEST  (ILBM) Destination chunk
  170.       ANHD  (ANIM) Animation Header
  171.       FONS  (FTXT) FontSpecifier
  172.       VHDR  (8SVX) Voice8Header
  173.       ATAK  (8SVX) Used to modulate sound
  174.       RLSE  (8SVX) Used to modulate sound
  175.       SHDR  (SMUS) SScoreHeader
  176.       INS1  (SMUS) Musical instrument
  177.       NAME  (SMUS) Name of the score
  178.       (c)   (SMUS) Copyright message
  179.       AUTH  (SMUS) Author of score
  180.       ANNO  (SMUS) Text annotations of score
  181.       other chunks will simply appear on the screen without further
  182.       information
  183.  
  184.  
  185. Cli Usage
  186. ---------
  187.  
  188.   +----------------------------------------------------------------------+
  189.   | Commandline template:                                                |
  190.   |   File/a,S=SHORT/s,M=MEDIUM/s,F=FULL/s,D=DIAG/s,I=IDENT/s,A=ASCII/n, |
  191.   |   W=WHATIS/s,P=PAGE/n:                                               |
  192.   |----------------------------------------------------------------------|
  193.   | Usage:                                                               |
  194.   |   WhatIs <File> [WHATIS | SHORT | MEDIUM | FULL | DIAG | IDENT |     |
  195.   |                 ASCII <len>] [PAGE <pglen>]                          |
  196.   +----------------------------------------------------------------------+
  197.  
  198.     File   : You want info about a File, a device or a directory.
  199.              You can only use the SHORT, MEDIUM or FULL option for a
  200.              device or a directory.
  201.     WHATIS : Simply say what the file is (no further information) (default)
  202.     SHORT  : Standard file info
  203.     MEDIUM : SHORT and identification info
  204.     FULL   : MEDIUM and diagnostic info
  205.     DIAG   : Show only diagnostic info
  206.              Diagnostic usage is divided into resource usage and
  207.              byte count usage. Resource usage shows the libraries, devices,
  208.              resources and fonts the program uses. This feature is only
  209.              meaningfull if the file is an executable, an object file or
  210.              a source file. There is no resource usage if identification is
  211.              enabled and the file is not an executable or object file.
  212.              Byte count usage shows the number of ascii characters (carriage
  213.              return, tab and form feed included), the number of non ascii
  214.              characters (between 127 and 255), the number of control codes
  215.              (between 0 and 31) and the number of lines.
  216.     IDENT  : Show only identification info
  217.              If you enable this option, WHATIS will try to recognize your
  218.              file. If it succeeds WHATIS will give you as much information
  219.              as possible. Otherwise WHATIS will tell you how likely it is
  220.              that this file is ascii.
  221.              If <File> is a device you will get some more information about
  222.              this device.
  223.     ASCII  : Dump ascii in file
  224.     Len    : Minimum linelength for ASCII dump
  225.     PAGE   : If this option is given, WHATIS will give a prompt after each
  226.              block of <pglen> lines.
  227.  
  228.  
  229. Workbench Usage
  230. ---------------
  231.  
  232.   Click on the WhatIs icon (or the other equivalent WhatIs... icons (see
  233.   below)) and, while holding shift, double click on the icon you want to
  234.   examine. A console window will appear with the information you asked for.
  235.   Press enter or click on the close gadget if you are ready. (Note that you
  236.   can change the dimensions of this output window if you do not like the
  237.   default (see below)).
  238.  
  239.   Because there is no commandline in the workbench you must supply the
  240.   arguments for WHATIS in the tooltypes. You do this by selecting the WHATIS
  241.   icon and choosing 'Information' in the workbench 'Icons' menu. See your
  242.   manual for more details.
  243.   This is not very handy when you often use other options. Therefore I
  244.   suggest the following:
  245.     Open a shell if you had not already done this.
  246.     Go to the subdirectory where you have put WHATIS.
  247.     Let say that you want to make a WHATIS that gives you all information
  248.     from a file (The FULL option), The normal WHATIS with no tooltypes
  249.     gives only one line information.
  250.     Type
  251.       'makelink WhatIsFull WhatIs'.
  252.     This command makes a new directory entry (WhatIsFull) that points to
  253.     the same file as 'WhatIs'. The following command would have been
  254.     correct too:
  255.       'copy WhatIs WhatIsFull'
  256.     but in this case you loose disk space.
  257.     Then you type
  258.       'copy WhatIs.info WhatIsFull.info'
  259.     You must copy the info files because these are going to be different
  260.     (Two linked files are always equal because they are in fact one and
  261.     the same).
  262.     Go to the workbench and add the 'ACTION=FULL' tooltype to WhatIsFull.
  263.     You have now two different programs, but you only use disk space for
  264.     one :-)
  265.     You can of course repeat this procedure as many times as you like.
  266.  
  267.   The following tooltypes are supported:
  268.     ACTION=<action>
  269.         <action> is one of FULL,SHORT,MEDIUM,WHATIS,ASCII,IDENT or DIAG.
  270.         See the cli usage for a description.
  271.         WHATIS is the default.
  272.     LEN=<length>
  273.         <length> is the minimum line length for the ASCII dump. This tooltype is
  274.         ignored if the ASCII action is not given.
  275.         6 is the default line length.
  276.     PAGE=<page length>
  277.         If this tooltype is given, WHATIS will give a prompt after each
  278.         block of <page length> lines.
  279.     WINDOW=<window specification>
  280.         This tooltype describes the output window for WHATIS.
  281.         When you omit this tooltype the output window is:
  282.             con:0/0/640/200/WhatIs window/close
  283.         The first four integers after 'con:' are the window dimensions
  284.         (left, top, width, height). The following string is the window
  285.         title. After the window title come the options (new to AmigaDOS
  286.         2.0). Here are some of these options:
  287.             close : The output window has a close gadget.
  288.             nodrag : You can't drag the output window.
  289.             nosize : You can't size the output window.
  290.             nodepth : The window does not have a depth gadget.
  291.         For example:
  292.           con:0/0/640/512/my window/close/nodrag/nosize
  293.         is a valid output window.
  294.  
  295.  
  296. Examples
  297. --------
  298.  
  299.   'WhatIs KingTut m' for cli          (KingTut is a graphic image)
  300.     or
  301.   WhatIs with tooltype ACTION=MEDIUM in workbench
  302.  
  303.     you will get the following output (or something equivalent):
  304.  
  305.     |  FileInfoBlock:
  306.     |     File         : KingTut
  307.     |     DirEntryType : -3
  308.     |     Protect      : rwed
  309.     |     Size         : 25728       NumBlocks : 51
  310.     |     Last changed : 15-Oct-89 10:54:52 (Sunday)
  311.     |     Comment      :
  312.     |
  313.     |  IFF file
  314.     |    FORM  ILBM   (25720 data bytes)
  315.     |      Interleaved BitMap
  316.     |      BMHD
  317.     |        width   :   320     height  :   200
  318.     |        x       :     0     y       :     0
  319.     |        nPlanes :     5     Masking :     0
  320.     |        xAspect :    10     yAspect :    11
  321.     |        PageWid :   320     PageHei :   200
  322.     |        Compression       : 1
  323.     |        transparent color : 0
  324.     |      CMAP  (96 bytes)
  325.     |      DPPS
  326.     |      CRNG
  327.     |        Rate :     0     Flags : RNG_ACTIVE
  328.     |        Low  :    20     High  :    31
  329.     |      CRNG
  330.     |        Rate :  2730     Flags : RNG_ACTIVE
  331.     |        Low  :     3     High  :     7
  332.     |      CRNG
  333.     |        Rate :  2730     Flags : RNG_ACTIVE
  334.     |        Low  :     0     High  :     0
  335.     |      CRNG
  336.     |        Rate :  2730     Flags : RNG_ACTIVE
  337.     |        Low  :     0     High  :     0
  338.     |      BODY
  339.  
  340.   'WhatIs file.c s' for cli
  341.     or
  342.   WhatIs with tooltype ACTION=SHORT in workbench
  343.  
  344.     you get only the basic information
  345.  
  346.     |  FileInfoBlock:
  347.     |     File         : file.c
  348.     |     DirEntryType : -3
  349.     |     Protect      : rwed
  350.     |     Size         : 146       NumBlocks : 1
  351.     |     Last changed : 17-Dec-89 20:37:04 (Sunday)
  352.     |     Comment      : This is an example file
  353.  
  354.   'WhatIs ram: medium' for cli
  355.     or
  356.   WhatIs with tooltype ACTION=MEDIUM in workbench
  357.  
  358.     |  FileInfoBlock:
  359.     |     Directory    : RAM DISK
  360.     |     DirEntryType : 2
  361.     |     Protect      : rwed
  362.     |     Size         : 0       NumBlocks : 1
  363.     |     Last changed : 18-Dec-89 17:29:22 (Monday)
  364.     |     Comment      :
  365.     |
  366.     |  InfoData:
  367.     |     UnitNumber    : -1
  368.     |     NumSoftErrors : 0
  369.     |     NumBlocks     : 3       NumBlocksUsed : 3
  370.     |     BytesPerBlock : 488
  371.     |     Disk is validated
  372.     |     Dos disk
  373.     |     Disk in use
  374.     |
  375.     |  DeviceList:
  376.     |     Volume
  377.     |     Creation date : 01-Jan-78 00:00:61 (Sunday)
  378.     |     DiskType      : 444F5300
  379.  
  380.   'WhatIs c:WhatIs f' for cli
  381.     or
  382.   WhatIs with tooltype ACTION=FULL in workbench
  383.  
  384.     Give full information
  385.  
  386.     |  FileInfoBlock:
  387.     |     File         : WhatIs
  388.     |     DirEntryType : -3
  389.     |     Protect      : rwed
  390.     |     Size         : 14940       NumBlocks : 30
  391.     |     Last changed : 17-Dec-89 17:07:02 (Sunday)
  392.     |     Comment      : © J.Tyberghein
  393.     |
  394.     |  Executable file
  395.     |     Hunk   0 : header
  396.     |                   Resident libraries:
  397.     |                   Table size : 2
  398.     |                   First Hunk : 0
  399.     |                   Last Hunk  : 1
  400.     |                code    (14568 bytes)
  401.     |                reloc32 (1 entries)
  402.     |                end
  403.     |     Hunk   1 : data    (160 bytes)  (0 bss)
  404.     |                reloc32 (2 entries)
  405.     |                end
  406.     |
  407.     |  Diagnostic research...
  408.     |     Resource usage:
  409.     |        arp.library
  410.     |        dos.library
  411.     |     Byte count:
  412.     |        8705 normal characters (58 %)
  413.     |        2691 non ascii characters (18 %)
  414.     |        3455 control codes ( <32 ) (23 %)
  415.     |        164 lines
  416.  
  417.   'WhatIs disk.info ident' for cli
  418.     or
  419.   (no equivalent in workbench because you can't select an info file)
  420.  
  421.     |  .info file  version 1
  422.     |     icon gadget:
  423.     |        LeftEdge 406, TopEdge 23
  424.     |        Width 141, Height 74
  425.     |        Flags GADGHIMAGE, Activation RELVERIFY GADGIMMEDIATE
  426.     |        GadgetType BOOLGADGET
  427.     |     DiskObject type WBDISK
  428.     |     Current X 406   Current Y 23
  429.  
  430.   'WhatIs II.smus m' for cli
  431.     or
  432.   WhatIs with tooltype ACTION=MEDIUM in workbench
  433.  
  434.     |  FileInfoBlock:
  435.     |     File         : II.smus
  436.     |     DirEntryType : -3
  437.     |     Protect      : rwed
  438.     |     Size         : 1456       NumBlocks : 3
  439.     |     Last changed : 03-Nov-89 15:05:22 (Friday)
  440.     |     Comment      :
  441.     |
  442.     |  IFF file
  443.     |    FORM  SMUS   (1448 data bytes)
  444.     |      Simple Musical Score
  445.     |      SHDR
  446.     |        Tempo  : 16047
  447.     |        Volume :   127     ctTrack :   4
  448.     |      NAME  Sphere
  449.     |      SNX1
  450.     |      INS1  (  0) NAME sphere
  451.     |      INS1  (  1) NAME human
  452.     |      INS1  (  2) NAME SynthiI
  453.     |      INS1  (  3) NAME explosion
  454.     |      INS1  (  4) NAME no
  455.     |      INS1  (  5) NAME EffectII
  456.     |      INS1  (  6) NAME synthiII
  457.     |      INS1  (  7) NAME BassdrumI
  458.     |      INS1  (  8) NAME SphereI
  459.     |      TRAK
  460.     |      TRAK
  461.     |      TRAK
  462.     |      TRAK
  463.  
  464.   'Whatis c:avail a 8' for cli
  465.     or
  466.   WhatIs with tooltypes ACTION=ASCII and LEN=8 in workbench
  467.  
  468.       Show all ascii lines with length greater than 8 and the offsets
  469.       in the file.
  470.  
  471.     |  Ascii listing:
  472.     |  00000064: PONudos.library
  473.     |  00000074: you need arp.library
  474.     |  000001E6: NuUsage: Avail [CHIP|FAST] [TOTAL] [FLUSH]
  475.     |  00000211: CHIP/s,FAST/s,TOTAL/s,FLUSH/s
  476.     |  0000022F: Avail: %s
  477.     |  0000023A: Type  Available    In-Use   Maximum   Largest
  478.     |  00000268: %s %9ld %9ld %9ld %9ld
  479.  
  480.   'Whatis :graphics/dpaintIII' for cli
  481.     or
  482.   WhatIs with no ACTION tooltype in workbench
  483.  
  484.     |  Crunched executable with PowerPacker 3.0 (overlays)
  485.  
  486. ==============================================================================
  487.  
  488.                          End of WHATIS 2.0 document
  489.  
  490. ==============================================================================
  491.