home *** CD-ROM | disk | FTP | other *** search
/ Frostbyte's 1980s DOS Shareware Collection / floppyshareware.zip / floppyshareware / GLEN / WHATTXT.ZIP / WHATDOC.TXT < prev   
Text File  |  2012-10-23  |  25KB  |  438 lines

  1.  
  2.                         WHAT?format 2.9
  3.                         ---------------
  4.  
  5.                         A file format recognition utility for
  6.                         IBM PCs and compatibles
  7.                         
  8.                         
  9.     INTRODUCTION TO     WHAT?format started life as a simple utility whose
  10.     WHAT?format         purpose was to distinguish between text files
  11.                         created by WordStar and WordPerfect. It was
  12.                         originally written for people working in a
  13.                         typesetting house which received a lot of raw text
  14.                         on floppy disks -- all too often without any
  15.                         information regarding the system that had created
  16.                         the files. As time has gone on, the program's
  17.                         abilities have been extended so that the present
  18.                         version can distinguish between the native formats
  19.                         of 27 of the most common word processors. In many
  20.                         cases it will also distinguish between files
  21.                         created by different versions of the same program
  22.                         (e.g. WordPerfect 4.2, 5.0, 5.1, etc.).
  23.                         
  24.                         In addition to native file formats, version 2.9
  25.                         also supports a number of text interchange formats
  26.                         (e.g. Document Content Architecture and Rich Text
  27.                         Format), various text-only formats (ASCII, DOS,
  28.                         EBCDIC, etc.), and a few print-formatted/page
  29.                         description formats (PostScript, PCL, etc.).
  30.                         Although it is primarily concerned with text files,
  31.                         WHAT will also recognise an assortment of other
  32.                         common data formats stemming from database,
  33.                         spreadsheet, graphics and other applications. A
  34.                         complete list of supported formats is given at the
  35.                         end of this document. Others features include the
  36.                         ability to create a pure hex dump and character set
  37.                         map. These are described in detail below.
  38.                         
  39.     USAGE               To use WHAT in its basic mode as a format
  40.                         recognition utility, simply type WHAT at the DOS
  41.                         prompt, followed by the name of the file to be
  42.                         analysed. The file name may include optional drive
  43.                         and path specifications, as well as standard DOS
  44.                         wildcards:
  45.                         
  46.                            C:\>WHAT myfile.doc
  47.                            (analyse myfile.doc in current directory)
  48.                            C:\>WHAT a:*.*
  49.                            (analyse all files on disk in drive A:)
  50.                         
  51.                         WHAT takes each file matching the file
  52.                         specification and writes its name and size on the
  53.                         screen, analyses it and reports the result.
  54.                         Unrecognized files are reported as being of UNKNOWN
  55.                         FORMAT. The file name and size are written to DOS'
  56.                         CON device; the result is written to the standard
  57.                         output device (normally the console), making it
  58.                         possible to redirect the result using the usual DOS
  59.                         redirection techniques.
  60.  
  61.     ───────────────────────────────────────────────────────────────────────
  62.     WHAT?format 2.9                                                       1
  63.     
  64.     OPTIONS             NOTE: All options can be used in either upper or
  65.                         lower case, and may be preceded by either a slash
  66.                         or a hyphen. Those used in conjunction with file
  67.                         names may appear either before or after the file
  68.                         specification.
  69.                         
  70.                         
  71.     Character set       Usage: WHAT <filespec> /c [ >filename ]
  72.                         
  73.                         Creates an on-screen map of all characters
  74.                         appearing in the first file that matches
  75.                         <filespec>. The user is then given the option of
  76.                         writing more detailed information (including the
  77.                         offset and context of the first occurrence of each
  78.                         character) to the standard output. If redirection
  79.                         has been specified on the command line, the result
  80.                         will be a text file suitable for viewing with Vern
  81.                         Buerg's LIST. The character set option is
  82.                         particularly useful with plain text files that do
  83.                         not use one of the standard character sets. Note
  84.                         that /C uses the underline attribute in order to
  85.                         create a 16x16 character set matrix on the screen.
  86.                         This gives better results on monochrome than on
  87.                         colour monitors.
  88.                         
  89.                         
  90.     Errorlevel          USAGE: WHAT /e [ >filename ]
  91.                         
  92.                         Upon completion of a file analysis WHAT sets the
  93.                         DOS errorlevel to a value corresponding to the
  94.                         result arrived at. This switch generates a list of
  95.                         which errorlevels correspond to which formats. The
  96.                         output can be redirected to a disk file and
  97.                         modified to create a batch file for automating file
  98.                         handling procedures.
  99.                         
  100.                         
  101.     Hex dump            USAGE: WHAT <filespec> /h [ >filename ]
  102.                         
  103.                         Creates a hex dump of the first file that matches
  104.                         <filespec>. The output contains only hex values --
  105.                         no file offsets or character equivalents. The main
  106.                         purpose of this switch is to simplify the analysis
  107.                         of long and complicated formatting instructions
  108.                         contained within a text file. (The resulting file
  109.                         is easy to edit since it only contains hex
  110.                         values.) If you merely want to view the contents of
  111.                         a file in hex format, you will be better off using
  112.                         a file browsing utility like LIST, PC-Tools or
  113.                         Norton Utilities, that also displays file offsets
  114.                         and character equivalents.
  115.                         
  116.                         
  117.     List formats        USAGE: WHAT /l
  118.                         
  119.                         Presents an on-screen list of all file formats
  120.                         supported by the current version of WHAT.
  121.  
  122.  
  123.     ───────────────────────────────────────────────────────────────────────
  124.     WHAT?format 2.9                                                       2
  125.     
  126.     COMMENTARY          WHAT is not foolproof, nor is it meant to be. It
  127.                         belongs to the venerable family of Q&D-utilities,
  128.                         and its basic philosophy is to be right as often as
  129.                         possible but without spending all day about it. It
  130.                         is not as Quick as it could be, and it is no doubt
  131.                         a good deal Dirtier than it would have been if I'd
  132.                         been a real programmer. That said, it has been
  133.                         tested fairly thoroughly on a number of systems and
  134.                         performs as described in this documentation. No
  135.                         problems have been reported that would consitute a
  136.                         threat to your computer or data, but as always, no
  137.                         responsibility is taken for damage resulting from
  138.                         incorrect or careless use of the program.
  139.                         
  140.                         WHAT works by scanning the beginning of a file and
  141.                         looking for specific formatting features that can
  142.                         identify its format. The precise features looked
  143.                         for vary. Some applications -- especially newer ones
  144.                         -- create files with headers containing an ID-tag, a
  145.                         kind of "thumbprint" consisting of a special
  146.                         sequence of bytes that the application itself uses
  147.                         to determine whether or not the file is in its
  148.                         native format. For example, all files created by
  149.                         WordPerfect 5.0 or later begin with the byte
  150.                         sequence FF 57 50 43 (-1,"WPC"). These kind of
  151.                         files are an easy match, and WHAT will handle them
  152.                         quickly and flawlessly.
  153.                         
  154.                         Other programs present greater problems, especially
  155.                         those with a native format closely akin to pure
  156.                         ASCII. PC-Write, for example, produces ASCII files
  157.                         if the document doesn't contain guide line font
  158.                         commands or text with attributes such as bold,
  159.                         underline etc. Such a file will be reported as
  160.                         being ASCII by WHAT.
  161.                         
  162.                         If on the other hand, the PC-Write document
  163.                         contains a few words that are underlined, the file
  164.                         will resemble an ASCII file interspersed with the
  165.                         odd 17h -- a "non-ASCII" character. This will
  166.                         probably be enough for WHAT to reach a verdict of
  167.                         PC-Write, but it is not difficult to imagine that
  168.                         the file could have been produced by another
  169.                         program and that the 17h means something quite
  170.                         different. In such borderline cases a programming
  171.                         decision has been made based upon the assumed
  172.                         popularity of particular applications. (If you
  173.                         disagree with the decision, don't hesitate to let
  174.                         me know!) When WHAT makes a mistake, it is often in
  175.                         this kind of situation.
  176.                         
  177.                         Another example will further illustrate the
  178.                         problems involved in differentiating between word
  179.                         processing systems that use similar formats. I
  180.                         recently downloaded an ARChive file containing a
  181.                         number of text files from a bulletin board system.
  182.                         These files looked like ASCII when I viewed them
  183.                         with LIST, but WHAT said they were WordPerfect 4.x.
  184.  
  185.     ───────────────────────────────────────────────────────────────────────
  186.     WHAT?format 2.9                                                       3
  187.     
  188.                         In actual fact they turned out to be UNIX-type
  189.                         ASCII files with line endings marked by a single LF
  190.                         instead of the CR/LF pair used under DOS. (The
  191.                         archive file seems to have been put together on an
  192.                         Amiga.) LF (0Ah) is the code used by WordPerfect to
  193.                         represent a hard return (hence WHAT's diagnosis),
  194.                         so the files could equally well have been prepared
  195.                         using WordPerfect (except that they also had hard
  196.                         returns where there should have been soft returns).
  197.                         
  198.                         The question here is whether the result reached by
  199.                         WHAT was acceptable. My answer -- based mainly upon
  200.                         pragmatic considerations -- is yes: Wherever the
  201.                         file might have come from, it is now on a PC
  202.                         (otherwise I wouldn't be using WHAT!), and if it is
  203.                         to be edited on a PC, the best program to use is
  204.                         WordPerfect. Most ASCII editors would complain
  205.                         bitterly about the missing CR at the end of each
  206.                         line; but WordPerfect is over the moon, and it will
  207.                         even allow me to regenerate most of the soft
  208.                         returns (by reading in the file, saving it as DOS
  209.                         text, and reading it in again using the option of
  210.                         converting hard returns in the hyphenation zone to
  211.                         soft returns). So in this case, WordPerfect is the
  212.                         best answer -- even though strictly speaking it is
  213.                         the wrong one.
  214.                         
  215.     Dirty tricks        If there is one thing that really slows WHAT down
  216.                         it is a lot of files in unsupported formats. A
  217.                         couple of dirty tricks are used to minimise this
  218.                         problem. Firstly, WHAT never reads more than the
  219.                         first 5 Kb of a file, reasoning that if it hasn't
  220.                         made up its mind by then, it probably never will.
  221.                         This could in theory lead to problems. For
  222.                         example, a PC-Write document consisting of 2-3
  223.                         pages of straight ASCII followed by a few pages of
  224.                         heavily formatted text will be judged to be ASCII
  225.                         -- but you'll be in trouble if you try to import it
  226.                         to, say, WordPerfect as "DOS Text". Such situations
  227.                         occur so rarely in practice, however, that the
  228.                         speed advantages of just looking at the beginning
  229.                         of a document outweigh the potential disadvantages.
  230.                         
  231.                         Secondly, WHAT doesn't bother to try to ascertain
  232.                         whether an .EXE-file really is executable: The
  233.                         present version quite simply ignores files with the
  234.                         extensions .EXE and .COM (except when the only
  235.                         files that match the file specification have one of
  236.                         these extensions, in which case WHAT will attempt
  237.                         to analyse the last one -- hopefully
  238.                         unsuccessfully).
  239.                         
  240.     ASCII files and     The criterion for differentiating between what WHAT
  241.     DOS files           calls "ASCII text files" and "DOS text files" is
  242.                         whether or not characters from the Extended ASCII
  243.                         set appear in the file, and most specifically
  244.                         whether the file contains 7-bit or 8-bit
  245.                         Norwegian/Danish characters -- [ \ ] { | } in ASCII
  246.  
  247.     ───────────────────────────────────────────────────────────────────────
  248.     WHAT?format 2.9                                                       4
  249.     
  250.                         files and Æ ¥ Å æ ¢ å in DOS files. This is an
  251.                         important distinction in certain European countries
  252.                         where accented characters may be represented by
  253.                         national versions of the (7-bit) ISO 646 character
  254.                         set, so English-speaking users will just have to
  255.                         live with it! In neither format does WHAT expect to
  256.                         encounter any control characters other than TAB
  257.                         (09h), CR (0Dh), LF (0Ah), FF (0Ch) or a single
  258.                         Control-Z end-of-file marker (1Ah).
  259.                         
  260.     FEEDBACK            The biggest problem with a program like WHAT is
  261.                         keeping it up to date. New word processing programs
  262.                         are appearing all the time, and most of them use
  263.                         their own native format. Occasionally the format is
  264.                         described in the documentation that follows the
  265.                         application, but usually that is not the case. Some
  266.                         software publishers are willing to make the
  267.                         details of the format available to developers,
  268.                         others (like Microsoft and IBM) keep them a closely
  269.                         guarded secret.
  270.                         
  271.                         Upgrades of existing programs also present
  272.                         problems. As new formatting features are added to
  273.                         the application, the native format changes in order
  274.                         to accommodate them. Sometimes these changes amount
  275.                         to no more than the addition of new codes to the
  276.                         old format (as when WordPerfect was upgraded from
  277.                         4.1 to 4.2). More major revisions, on the other
  278.                         hand, can lead to a complete revamping of the
  279.                         native format (as was the case with WordPerfect
  280.                         5.0). WHAT has been designed as far as possible to
  281.                         be able to handle new versions of formats that are
  282.                         already supported, but no guarantees are made. (I
  283.                         am fairly certain that WHAT will recognise
  284.                         documents created by version 6.5 of WordPerfect,
  285.                         but what happens with 9.0 documents is anybody's
  286.                         guess!)
  287.                         
  288.                         Keeping abreast of all these changes and additions
  289.                         is no easy matter (I have yet to find a company
  290.                         that runs a mailing list for people interested in
  291.                         this kind of information!). What that means is that
  292.                         WHAT can only be improved and kept up to date with
  293.                         the assistance of its users. So if you find that
  294.                         WHAT makes a mistake when analysing a supported
  295.                         format, experience trouble with the latest version
  296.                         of a particular program, or can provide
  297.                         information on file formats not currently supported
  298.                         by WHAT, please do not hesitate to get in touch.
  299.                         The more example files and technical information
  300.                         you can provide for a particular format the better.
  301.                         Your efforts will be rewarded with an
  302.                         acknowledgement in the next version of WHATDOC and
  303.                         a typeset copy of this one. (The "wish list" for
  304.                         the next version of WHAT includes support for Amí;
  305.                         Excel; PCX, IMG, CGM and GEM graphics; the latest
  306.                         versions of DisplayWrite and Lotus 1-2-3; and many
  307.                         more.)
  308.  
  309.     ───────────────────────────────────────────────────────────────────────
  310.     WHAT?format 2.9                                                       5
  311.     
  312.     THANKS TO...        Dag Hasvold, Aron Gurski, Tor Nordahl, Gisle
  313.                         Hannemyr, Truls Meland and Chris Wolf for helpful
  314.                         suggestions.
  315.                         
  316.                         Send comments, files and format documentation to:
  317.  
  318.                         Steve Pepper, Pilestredet 97, N-0358 Oslo 3, Norway
  319.                         
  320.                         or log on to:
  321.  
  322.                         Computertext BBS (2400 8-N-1) +47-2-420825.
  323.                         
  324.                         One final thing: Don't bother suggesting that the
  325.                         next version of WHAT ought to be able to recognise
  326.                         non-DOS disk formats unless you are prepared to
  327.                         tell me how to implement such a feature. I know it
  328.                         would be enormously useful, but I am a typographer
  329.                         -- not a programmer!
  330.  
  331.  
  332.     SUPPORTED           Here is a complete list of all formats supported by
  333.     FORMATS             version 2.9 of WHAT. Those formats for which a
  334.                         version number or other additional information is
  335.                         given are marked by an asterisk. Please support
  336.                         WHAT by helping to make this list more
  337.                         comprehensive!
  338.                         
  339.     Word                Ability WP*
  340.     processors          Acto WP*
  341.                         ASCII text file     (09, 0A, 0C, 0D, 1A, 20..7E)
  342.                         ASCII even parity
  343.                         Cicero
  344.                         DisplayWrite*
  345.                         DOS text file       (as ASCII, plus 80..FE)
  346.                         DSI Tekst
  347.                         EBCDIC file
  348.                         Enable WPF*
  349.                         Framework
  350.                         Manuscript*
  351.                         MASS-11
  352.                         Microsoft Word
  353.                         MicroWord
  354.                         Multimate
  355.                         Notis WP*
  356.                         OfficeWriter
  357.                         Ordbehandling
  358.                         Palantir*
  359.                         PC-Write
  360.                         Samna Word*         1.0 and 2.0
  361.                         Sprint
  362.                         Super WP
  363.                         Symphony*           1.0 and 1.1
  364.                         Ventura Publisher
  365.                         Volkswriter
  366.                         WordPerfect*        4.x and higher
  367.                         WordStar*           4.0 and higher
  368.                         WordStar 2000*
  369.                         XyWrite
  370.  
  371.     ───────────────────────────────────────────────────────────────────────
  372.     WHAT?format 2.9                                                       6
  373.     
  374.     Formatted text      Adobe PostScript    (at least min. conforming)
  375.                         DCA/RFT             (Revisable Form Text)
  376.                         DEC DX
  377.                         HP LaserJet (PCL)
  378.                         IBM DCF-GML         (Generalised Markup Language)
  379.                         Rich Text Format
  380.                         
  381.                         
  382.     Data bases          Ability DBF*
  383.                         DataPerfect*
  384.                         dBASE*
  385.                         Enable DBF*
  386.                         Reflex*
  387.                         
  388.                         
  389.     Spreadsheets        Ability s'sheet*
  390.                         DIF spreadsheet
  391.                         Enable s'sheet*
  392.                         Lotus 1-2-3*
  393.                         PlanPerfect*
  394.                         SuperCalc
  395.                         SYLK spreadsheet
  396.                         
  397.                         
  398.     Graphics            Ability graphics*
  399.                         GIF*                resolution and no. of colours
  400.                         IFF*                resolution for ILBM files
  401.                         TIFF*               version + processor type
  402.                         WPG*                version + bitmap/drawing
  403.                         
  404.                         
  405.     Various             Ability comms*
  406.                         ARC archive
  407.                         LZH archive
  408.                         MacBinary*          TYPE resource
  409.                         StuffIt! archive
  410.                         ZIP archive*
  411.  
  412.  
  413.     COPYRIGHT           WHAT?format is copyright Boots & Pepper 1989-90.
  414.                         It may be freely used and distributed to others
  415.                         provided no changes are made in the files WHAT.EXE
  416.                         and WHATDOC.
  417.                    
  418.                    
  419.                         Steve Pepper
  420.                    
  421.                         2 June 1990
  422.     
  423.  
  424.  
  425.     
  426.  
  427.     
  428.  
  429.     
  430.  
  431.     
  432.  
  433.     ───────────────────────────────────────────────────────────────────────
  434.     WHAT?format 2.9                                                       7
  435.     
  436.  
  437.  
  438.