usr.bin/file/magic.5

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