usr.bin/file/magic.5

   1 .\"
   2 .\" @(#)$FreeBSD$
   3 .\"
   4 .\" install as magic.4 on USG, magic.5 on V7 or Berkeley systems.
   5 .\"
   6 .Dd September 3, 1994
   7 .Dt MAGIC 5
   8 .Os "Public Domain"
   9 .Sh NAME
  10 .Nm magic
  11 .Nd file command's magic number file
  12 .Sh DESCRIPTION
  13 This manual page documents the format of the magic file as
  14 used by the
  15 .Xr file 1
  16 command, version 3.22. The
  17 .Nm file
  18 command identifies the type of a file using,
  19 among other tests,
  20 a test for whether the file begins with a certain
  21 .Em "magic number" .
  22 The file
  23 .Pa /usr/share/misc/magic
  24 specifies what magic numbers are to be tested for,
  25 what message to print if a particular magic number is found,
  26 and additional information to extract from the file.
  27 .Pp
  28 Each line of the file specifies a test to be performed.
  29 A test compares the data starting at a particular offset
  30 in the file with a 1-byte, 2-byte, or 4-byte numeric value or
  31 a string.  If the test succeeds, a message is printed.
  32 The line consists of the following fields:
  33 .Bl -tag -width indent
  34 .It offset
  35 A number specifying the offset, in bytes, into the file of the data
  36 which is to be tested.
  37 .It type
  38 The type of the data to be tested.  The possible values are:
  39 .Bl -tag -width indent
  40 .It byte
  41 A one-byte value.
  42 .It short
  43 A two-byte value (on most systems) in this machine's native byte order.
  44 .It long
  45 A four-byte value (on most systems) in this machine's native byte order.
  46 .It string
  47 A string of bytes.
  48 .It date
  49 A four-byte value interpreted as a unix date.
  50 .It beshort
  51 A two-byte value (on most systems) in big-endian byte order.
  52 .It belong
  53 A four-byte value (on most systems) in big-endian byte order.
  54 .It bedate
  55 A four-byte value (on most systems) in big-endian byte order,
  56 interpreted as a unix date.
  57 .It leshort
  58 A two-byte value (on most systems) in little-endian byte order.
  59 .It lelong
  60 A four-byte value (on most systems) in little-endian byte order.
  61 .It ledate
  62 A four-byte value (on most systems) in little-endian byte order,
  63 interpreted as a unix date.
  64 .El
  65 .El
  66 .Pp
  67 The numeric types may optionally be followed by
  68 .Em &
  69 and a numeric value,
  70 to specify that the value is to be AND'ed with the
  71 numeric value before any comparisons are done.  Prepending a
  72 .Em u
  73 to the type indicates that ordered comparisons should be unsigned.
  74 .Bl -tag -width indent
  75 .It test
  76 The value to be compared with the value from the file.  If the type is
  77 numeric, this value
  78 is specified in C form; if it is a string, it is specified as a C string
  79 with the usual escapes permitted (e.g. \en for new-line).
  80 .It ""
  81 Numeric values
  82 may be preceded by a character indicating the operation to be performed.
  83 It may be
  84 .Em = ,
  85 to specify that the value from the file must equal the specified value,
  86 .Em < ,
  87 to specify that the value from the file must be less than the specified
  88 value,
  89 .Em > ,
  90 to specify that the value from the file must be greater than the specified
  91 value,
  92 .Em & ,
  93 to specify that the value from the file must have set all of the bits
  94 that are set in the specified value,
  95 .Em ^ ,
  96 to specify that the value from the file must have clear any of the bits
  97 that are set in the specified value, or
  98 .Em x ,
  99 to specify that any value will match.
 100 If the character is omitted,
 101 it is assumed to be
 102 .Em = .
 103 .It ""
 104 Numeric values are specified in C form; e.g.
 105 .Em 13
 106 is decimal,
 107 .Em 013
 108 is octal, and
 109 .Em 0x13
 110 is hexadecimal.
 111 .It ""
 112 For string values, the byte string from the
 113 file must match the specified byte string.
 114 The operators
 115 .Em = ,
 116 .Em <
 117 and
 118 .Em >
 119 (but not
 120 .Em & )
 121 can be applied to strings.
 122 The length used for matching is that of the string argument
 123 in the magic file.  This means that a line can match any string, and
 124 then presumably print that string, by doing
 125 .Em >\e0
 126 (because all strings are greater than the null string).
 127 .It message
 128 The message to be printed if the comparison succeeds.  If the string
 129 contains a
 130 .Xr printf 3
 131 format specification, the value from the file (with any specified masking
 132 performed) is printed using the message as the format string.
 133 .El
 134 .Pp
 135 Some file formats contain additional information which is to be printed
 136 along with the file type.  A line which begins with the character
 137 .Em >
 138 indicates additional tests and messages to be printed.  The number of
 139 .Em >
 140 on the line indicates the level of the test; a line with no
 141 .Em >
 142 at the beginning is considered to be at level 0.
 143 Each line at level
 144 .Em n+1
 145 is under the control of the line at level
 146 .Em n
 147 most closely preceding it in the magic file.
 148 If the test on a line at level
 149 .Em n
 150 succeeds, the tests specified in all the subsequent lines at level
 151 .Em n+1
 152 are performed, and the messages printed if the tests succeed.  The next
 153 line at level
 154 .Em n
 155 terminates this.
 156 If the first character following the last
 157 .Em >
 158 is a
 159 .Em (
 160 then the string after the parenthesis is interpreted as an indirect offset.
 161 That means that the number after the parenthesis is used as an offset in
 162 the file.
 163 The value at that offset is read, and is used again as an offset
 164 in the file.
 165 Indirect offsets are of the form:
 166 .Em (x[.[bsl]][+-][y]) .
 167 The value of
 168 .Em x
 169 is used as an offset in the file.
 170 A byte, short or long is read at that offset
 171 depending on the
 172 .Em [bsl]
 173 type specifier.
 174 To that number the value of
 175 .Em y
 176 is added and the result is used as an offset in the file.
 177 The default type
 178 if one is not specified is long.
 179 .Pp
 180 Sometimes you do not know the exact offset as this depends on the length of
 181 preceding fields.
 182 You can specify an offset relative to the end of the
 183 last uplevel field (of course this may only be done for sublevel tests, i.e.
 184 test beginning with
 185 .Em > Ns ).
 186 Such a relative offset is specified using
 187 .Em &
 188 as a prefix to the offset.
 189 .Sh BUGS
 190 The formats
 191 .Em long ,
 192 .Em belong ,
 193 .Em lelong ,
 194 .Em short ,
 195 .Em beshort ,
 196 .Em leshort ,
 197 .Em date ,
 198 .Em bedate ,
 199 and
 200 .Em ledate
 201 are system-dependent; perhaps they should be specified as a number
 202 of bytes (2B, 4B, etc),
 203 since the files being recognized typically come from
 204 a system on which the lengths are invariant.
 205 .Pp
 206 There is (currently) no support for specified-endian data to be used in
 207 indirect offsets.
 208 .Sh SEE ALSO
 209 .Xr file 1
 210 .\"
 211 .\" From: guy@sun.uucp (Guy Harris)
 212 .\" Newsgroups: net.bugs.usg
 213 .\" Subject: /etc/magic's format isn't well documented
 214 .\" Message-ID: <2752@sun.uucp>
 215 .\" Date: 3 Sep 85 08:19:07 GMT
 216 .\" Organization: Sun Microsystems, Inc.
 217 .\" Lines: 136
 218 .\"
 219 .\" Here's a manual page for the format accepted by the "file" made by adding
 220 .\" the changes I posted to the S5R2 version.
 221 .\"
 222 .\" Modified for Ian Darwin's version of the file command.