file

NAME

file - determine file type

SYNOPSIS

file [-c ] [-z ] [-f namefile]
	 [-m magicfile] file ...

DESCRIPTION

The file(1) utility tests each argument in an attempt to classify it. There are three sets of tests, performed in this order: file system tests, magic number tests, and language tests. The first test that succeeds causes the file type to be printed.

The type printed will usually contain one of the keywords text, executable, or data. Text means the file contains only ASCII characters and is probably safe to read on an ASCII terminal. Executable indicates the file contains the result of compiling a program for either a Microsoft operating system or for some other vendor's operating system. Data indicates anything else; data is usually 'binary' or nonprintable. Exceptions are familiar file formats (core files, tar archives) that are known to contain binary data. When modifying the file /usr/share/magic or the program itself, preserve the keywords text, executable, and data. People depend on knowing that all the readable files in a directory have the word "text" printed. Do not do as Berkeley did and change "shell commands text" to "shell script".

OPTIONS

-c
Check the format of the magic file; output displays the parsed form of the file. This is usually used in conjunction with -m to debug a new magic file before installing it.
-f namefile
Specifies that the names of the files to be examined are to be read (one per line) from namefile before the argument list. Either namefile or at least one file-name argument must be present; to test the standard input, use "-" as a file-name argument.
-m file
Look in file for magic numbers, instead of /usr/share/magic.
-z
Try to look inside compressed files.

The file-system tests are based on examining the return from a stat(2) system call. The program checks to determine whether the file is either empty or some sort of special file. Any known file types appropriate to the system on which you are running (sockets, symbolic links, or named pipes (FIFOs) on those systems that implement them) are intuited if they are defined in the system header file <sys/stat.h>.

The magic-number tests are used to check for files with data in particular fixed formats. The canonical example of this is a binary executable (compiled program) a.out file, whose format is defined in <a.out.h> and possibly <exec.h> in the standard include directory. These files have a 'magic number' stored in a particular place near the beginning of the file that tells the operating system that the file is a binary executable, and which of several types of binary executables it is. The concept of 'magic number' has been applied by extension to data files. Any file with some invariant identifier at a small fixed offset into the file can usually be described in this way. The information in these files is read from the magic file magic.

If an argument appears to be an ASCII file, file(1) attempts to guess its language. The language tests look for particular strings (cf <names.h>) that can appear anywhere in the first few blocks of a file. For example, the keyword .br indicates that the file is most likely a troff input file, just as the keyword struct indicates a C program. These tests are less reliable than the previous two groups, so they are performed last. The language test routines also test for some miscellany (such as tar(1) archives) and determine whether an unknown file should be labeled as 'ascii text' or 'data'.

FILES

The file(1) command uses the following files:

/usr/share/magic
Default list of magic numbers.

STANDARDS CONFORMANCE

This program is believed to exceed the System V Interface Definition of file(1), as near as one can determine from the vague language contained therein. Its behavior is mostly compatible with the System V program of the same name. This version knows more magic, however, so it will produce behavior (albeit more accurate) output in many cases.

The one significant difference between this version and System V is that this version treats any white space as a delimiter, so spaces in pattern strings must be escaped. or example,

>10	string	language impress\   (imPRESS data)
in an existing magic file would have to be changed to
>10	string	language\ impress   (imPRESS data)
In addition, in this version, if a pattern string contains a backslash, it must be escaped. For example
0	string		 \begindata	 Andrew Toolkit document
in an existing magic file must be changed to
0	string		 \\begindata	Andrew Toolkit document

SunOS releases 3.2 and later from Sun Microsystems include a file(1) command derived from the System V one, but with some extensions. My version differs from Sun's only in minor ways. It includes the extension of the '&' operator, used as, for example:

>16	long&0x7fffffff >0		not stripped

MAGIC DIRECTORY

The magic file entries have been collected from various sources, primarily USENET, and contributed by various authors. Christos Zoulas (address below) will collect additional or corrected magic file entries. A consolidation of magic file entries will be distributed periodically.

The order of entries in the magic file is significant. Depending on which system you are using, the order that they are put together may be incorrect. If your old file(1) command uses a magic file, keep the old magic file for comparison purposes (rename it to magic.orig).

HISTORY

There has been a file(1) command since at least Research Version 6 (man page dated January, 1975). The System V version introduced one significant major change: the external list of magic number types. This slowed the program down slightly, but made it much more flexible.

This program, based on the System V version, was written by Ian Darwin without looking at anybody else's source code.

John Gilmore revised the code extensively, making it better than the first version. Geoff Collyer found several inadequacies and provided some magic file entries. The program has undergone continued evolution since.

AUTHOR

Written by Ian F. Darwin, UUCP address {utzoo | ihnp4}!darwin!ian, Internet address ian@sq.com, postal address: P.O. Box 603, Station F, Toronto, Ontario, CANADA M4Y 2L8.

Altered by Rob McMahon, cudcv@warwick.ac.uk, 1989, to extend the '&' operator from simple 'x&y != 0' to 'x&y op z'.

Altered by Guy Harris, guy@auspex.com, 1993, to:

Changes by Ian Darwin and various authors including Christos Zoulas (christos@ee.cornell.edu), 1990-1992.

LEGAL NOTICE

Copyright (c) Ian F. Darwin, Toronto, Canada, 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993.

This software is not subject to and may not be made subject to any license of the American Telephone and Telegraph Company, Sun Microsystems Inc., Digital Equipment Inc., Lotus Development Inc., the Regents of the University of California, The X Consortium or MIT, or The Free Software Foundation.

This software is not subject to any export provision of the United States Department of Commerce, and may be exported to any country/region or planet.

Permission is granted to anyone to use this software for any purpose on any computer system, and to alter it and redistribute it freely, subject to the following restrictions:

  1. The author is not responsible for the consequences of use of this software, no matter how awful, even if they arise from flaws in it.
  2. The origin of this software must not be misrepresented, either by explicit claim or by omission. Since few users ever read sources, credits must appear in the documentation.
  3. Altered versions must be plainly marked as such, and must not be misrepresented as being the original software. Since few users ever read sources, credits must appear in the documentation.
  4. This notice may not be removed or altered.

A few support files (getopt, strtok) distributed with this package are by Henry Spencer and are subject to the same terms as above.

A few simple support files (strtol, strchr) distributed with this package are in the public domain; they are so marked.

The files <tar.h> and is_tar.c were written by John Gilmore from his public-domain tar(1) program, and are not covered by the above restrictions.

BUGS

The file(1) utility uses several algorithms that favor speed over accuracy, thus it can be misled about the contents of ASCII files.

The support for files ASCII (primarily for programming languages) is simplistic, inefficient and requires recompilation to update.

There should be an "else" clause to follow a series of continuation lines.

The magic file and keywords should have regular expression support. Their use of ASCII TAB as a field delimiter is ugly and makes it hard to edit the files, but is entrenched.

The program does not deal with FORTRAN. It should be able to figure FORTRAN by seeing some keywords which appear indented at the start of line. Regular expression support would make this easy.

The list of keywords in ascmagic probably belongs in the magic file. This could be done by using a keyword like '*' for the offset value.

Another optimization would be to sort the magic file so that we can just run down all the tests for the first byte, first word, first long, etc, once we have fetched it. Complain about conflicts in the magic file entries. Make a rule that the magic entries sort based on file offset rather than position within the magic file?

The program should provide a way to give an estimate of how good a guess is. We end up removing guesses (such as "From " as first 5 chars of file) because they are not as good as other guesses (such as "Newsgroups:" versus "Return-Path:"). Still, if the others don't pan out, it should be possible to use the first guess.

This program is slower than some vendors' file commands.

This manual page, and particularly this section, is too long.

AVAILABILITY

You can obtain the original author's latest version by anonymous FTP on tesla.ee.cornell.edu in the directory /pub/file-X.YY.tar.gz.

SEE ALSO

od(1)

magic(5)