contrib/file/magic.man

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