contrib/file/README

   1 ** README for file(1) Command **
   2 @(#) $Id: README,v 1.29 2003/02/27 20:47:46 christos Exp $
   3
   4 This is Release 3.x of Ian Darwin's (copyright but distributable)
   5 file(1) command. This version is the standard "file" command for Linux,
   6 *BSD, and other systems. (See "patchlevel.h" for the exact release number).
   7
   8 UNIX is a trademark of UNIX System Laboratories.
   9
  10 The prime contributor to Release 3.8 was Guy Harris, who put in megachanges
  11 including byte-order independence.
  12
  13 The prime contributor to Release 3.0 was Christos Zoulas, who put
  14 in hundreds of lines of source code changes, including his own
  15 ANSIfication of the code (I liked my own ANSIfication better, but
  16 his (__P()) is the "Berkeley standard" way of doing it, and I wanted UCB
  17 to include the code...), his HP-like "indirection" (a feature of
  18 the HP file command, I think), and his mods that finally got the
  19 uncompress (-z) mode finished and working.
  20
  21 This release has compiled in numerous environments; see PORTING
  22 for a list and problems.
  23
  24 This fine freeware file(1) follows the USG (System V) model of the file
  25 command, rather than the Research (V7) version or the V7-derived 4.[23]
  26 Berkeley one. That is, the file /etc/magic contains much of the ritual
  27 information that is the source of this program's power. My version
  28 knows a little more magic (including tar archives) than System V; the
  29 /etc/magic parsing seems to be compatible with the (poorly documented)
  30 System V /etc/magic format (with one exception; see the man page).
  31
  32 In addition, the /etc/magic file is built from a subdirectory
  33 for easier(?) maintenance.  I will act as a clearinghouse for
  34 magic numbers assigned to all sorts of data files that
  35 are in reasonable circulation. Send your magic numbers,
  36 in magic(4) format please, to the maintainer, Christos Zoulas.
  37
  38 LEGAL.NOTICE - read this first.
  39 README - read this second (you are currently reading this file).
  40 PORTING - read this only if the program won't compile.
  41 Makefile - read this next, adapt it as needed (particularly
  42         the location of the old existing file command and
  43         the man page layouts), type "make" to compile,
  44         "make try" to try it out against your old version.
  45         Expect some diffs, particularly since your original
  46         file(1) may not grok the embedded-space ("\ ") in
  47         the current magic file, or may even not use the
  48         magic file.
  49 apprentice.c - parses /etc/magic to learn magic
  50 ascmagic.c - third & last set of tests, based on hardwired assumptions.
  51 core - not included in distribution due to mailer limitations.
  52 debug.c - includes -c printout routine
  53 file.1 - man page for the command
  54 magic.4 - man page for the magic file, courtesy Guy Harris.
  55         Install as magic.4 on USG and magic.5 on V7 or Berkeley; cf Makefile.
  56 file.c - main program
  57 file.h - header file
  58 fsmagic.c - first set of tests the program runs, based on filesystem info
  59 is_tar.c, tar.h - knows about tarchives (courtesy John Gilmore).
  60 magdir - directory of /etc/magic pieces
  61         magdir/Makefile - ADJUST THIS FOR YOUR CONFIGURATION
  62 names.h - header file for ascmagic.c
  63 softmagic.c - 2nd set of tests, based on /etc/magic
  64 readelf.[ch] - Stand-alone elf parsing code.
  65 compress.c - on-the-fly decompression.
  66 print.c - print results, errors, warnings.
  67
  68 If your gzip sometimes fails to decompress things complaining about a short
  69 file, apply this patch [which is going to be in the next version of gzip]:
  70 *** -   Tue Oct 29 02:06:35 1996
  71 --- util.c      Sun Jul 21 21:51:38 1996
  72 *** 106,111 ****
  73 --- 108,114 ----
  74
  75       if (insize == 0) {
  76         if (eof_ok) return EOF;
  77 +       flush_window();
  78         read_error();
  79       }
  80       bytes_in += (ulg)insize;
  81
  82 E-mail: christos@astron.com
  83
  84 Phone: Do not even think of telephoning me about this program. Send cash first!
  85
  86 Parts of this software were developed at SoftQuad Inc., 56 Aberfoyle
  87 Cres, # 810, Toronto, Ontario CANADA M8X 2W4.  Phone: 416-239-4801 or
  88 800-387-2777. Email: mail@sq.com.  Call for information on SGML editing
  89 and browsing, Unix text processing, and customised products on Unix,
  90 DOS and Mac.
  91
  92 From: Kees Zeelenberg
  93
  94 An MS-Windows (Win32) port of File-3.41 is available from
  95 http://gnuwin32.sourceforge.net/
  96 File is an implementation of the Unix File(1) command.
  97 It knows the 'magic number' of several thousands of file types.