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