summaryrefslogtreecommitdiffstats
path: root/contrib/file/magic.man
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/file/magic.man')
-rw-r--r--contrib/file/magic.man78
1 files changed, 47 insertions, 31 deletions
diff --git a/contrib/file/magic.man b/contrib/file/magic.man
index b07f584..0d957bc 100644
--- a/contrib/file/magic.man
+++ b/contrib/file/magic.man
@@ -6,7 +6,8 @@ magic \- file command's magic number file
This manual page documents the format of the magic file as
used by the
.BR file (__CSECTION__)
-command, version __VERSION__. The
+command, version __VERSION__.
+The
.BR file
command identifies the type of a file using,
among other tests,
@@ -21,13 +22,15 @@ and additional information to extract from the file.
Each line of the file specifies a test to be performed.
A test compares the data starting at a particular offset
in the file with a 1-byte, 2-byte, or 4-byte numeric value or
-a string. If the test succeeds, a message is printed.
+a string.
+If the test succeeds, a message is printed.
The line consists of the following fields:
.IP offset \w'message'u+2n
A number specifying the offset, in bytes, into the file of the data
which is to be tested.
.IP type
-The type of the data to be tested. The possible values are:
+The type of the data to be tested.
+The possible values are:
.RS
.IP byte \w'message'u+2n
A one-byte value.
@@ -36,11 +39,14 @@ A two-byte value (on most systems) in this machine's native byte order.
.IP long
A four-byte value (on most systems) in this machine's native byte order.
.IP string
-A string of bytes. The string type specification can be optionally followed
-by /[Bbc]*. The ``B'' flag compacts whitespace in the target, which must
-contain at least one whitespace character. If the magic has "n" consecutive
-blanks, the target needs at least "n" consecutive blanks to match. The ``b''
-flag treats every blank in the target as an optional blank. Finally the ``c''
+A string of bytes.
+The string type specification can be optionally followed by /[Bbc]*.
+The ``B'' flag compacts whitespace in the target, which must
+contain at least one whitespace character.
+If the magic has "n" consecutive
+blanks, the target needs at least "n" consecutive blanks to match.
+The ``b'' flag treats every blank in the target as an optional blank.
+Finally the ``c''
flag, specifies case insensitive matching: lowercase characters in the magic
match both lower and upper case characters in the targer, whereas upper case
characters in the magic, only much uppercase characters in the target.
@@ -73,12 +79,13 @@ The numeric types may optionally be followed by
.B \*[Am]
and a numeric value,
to specify that the value is to be AND'ed with the
-numeric value before any comparisons are done. Prepending a
+numeric value before any comparisons are done.
+Prepending a
.B u
to the type indicates that ordered comparisons should be unsigned.
.IP test
-The value to be compared with the value from the file. If the type is
-numeric, this value
+The value to be compared with the value from the file.
+If the type is numeric, this value
is specified in C form; if it is a string, it is specified as a C string
with the usual escapes permitted (e.g. \en for new-line).
.IP
@@ -100,8 +107,8 @@ that are set in the specified value,
to specify that the value from the file must have clear any of the bits
that are set in the specified value, or
.BR x ,
-to specify that any value will match. If the character is omitted,
-it is assumed to be
+to specify that any value will match.
+If the character is omitted, it is assumed to be
.BR = .
.IP
Numeric values are specified in C form; e.g.
@@ -123,21 +130,24 @@ and
.BR \*[Am] )
can be applied to strings.
The length used for matching is that of the string argument
-in the magic file. This means that a line can match any string, and
+in the magic file.
+This means that a line can match any string, and
then presumably print that string, by doing
.B \*[Gt]\e0
(because all strings are greater than the null string).
.IP message
-The message to be printed if the comparison succeeds. If the string
-contains a
+The message to be printed if the comparison succeeds.
+If the string contains a
.BR printf (3)
format specification, the value from the file (with any specified masking
performed) is printed using the message as the format string.
.PP
Some file formats contain additional information which is to be printed
-along with the file type. A line which begins with the character
+along with the file type.
+A line which begins with the character
.B \*[Gt]
-indicates additional tests and messages to be printed. The number of
+indicates additional tests and messages to be printed.
+The number of
.B \*[Gt]
on the line indicates the level of the test; a line with no
.B \*[Gt]
@@ -151,8 +161,8 @@ If the test on a line at level
.I n
succeeds, the tests specified in all the subsequent lines at level
.IB n \(pl1
-are performed, and the messages printed if the tests succeed. The next
-line at level
+are performed, and the messages printed if the tests succeed.
+The next line at level
.I n
terminates this.
If the first character following the last
@@ -161,27 +171,33 @@ is a
.B (
then the string after the parenthesis is interpreted as an indirect offset.
That means that the number after the parenthesis is used as an offset in
-the file. The value at that offset is read, and is used again as an offset
-in the file. Indirect offsets are of the form:
+the file.
+The value at that offset is read, and is used again as an offset
+in the file.
+Indirect offsets are of the form:
.BI (( x [.[bslBSL]][+-][ y ]).
The value of
.I x
-is used as an offset in the file. A byte, short or long is read at that offset
-depending on the
+is used as an offset in the file.
+A byte, short or long is read at that offset depending on the
.B [bslBSL]
-type specifier. The capitalized types interpret the number as a big endian
+type specifier.
+The capitalized types interpret the number as a big endian
value, whereas the small letter versions interpret the number as a little
-endian value. To that number the value of
+endian value.
+To that number the value of
.I y
-is added and the result is used as an offset in the file. The default type
-if one is not specified is long.
+is added and the result is used as an offset in the file.
+The default type if one is not specified is long.
.PP
Sometimes you do not know the exact offset as this depends on the length of
-preceding fields. You can specify an offset relative to the end of the
+preceding fields.
+You can specify an offset relative to the end of the
last uplevel field (of course this may only be done for sublevel tests, i.e.
test beginning with
.B \*[Gt]
-). Such a relative offset is specified using
+).
+Such a relative offset is specified using
.B \*[Am]
as a prefix to the offset.
.SH BUGS
@@ -219,4 +235,4 @@ indirect offsets.
.\" the changes I posted to the S5R2 version.
.\"
.\" Modified for Ian Darwin's version of the file command.
-.\" @(#)$Id: magic.man,v 1.20 2003/02/08 18:33:53 christos Exp $
+.\" @(#)$Id: magic.man,v 1.21 2003/02/27 20:47:46 christos Exp $
OpenPOWER on IntegriCloud