| 1 |
.\" $File: file.man,v 1.153 2025/07/23 18:52:08 christos Exp $ |
| 2 |
.Dd June 17, 2025 |
| 3 |
.Dt FILE 1 |
| 4 |
.Os |
| 5 |
.Sh NAME |
| 6 |
.Nm file |
| 7 |
.Nd determine file type |
| 8 |
.Sh SYNOPSIS |
| 9 |
.Nm |
| 10 |
.Bk -words |
| 11 |
.Op Fl bcdEhiklLNnprsSvzZ0 |
| 12 |
.Op Fl Fl apple |
| 13 |
.Op Fl Fl exclude-quiet |
| 14 |
.Op Fl Fl extension |
| 15 |
.Op Fl Fl mime-encoding |
| 16 |
.Op Fl Fl mime-type |
| 17 |
.Op Fl e Ar testname |
| 18 |
.Op Fl F Ar separator |
| 19 |
.Op Fl f Ar namefile |
| 20 |
.Op Fl m Ar magicfiles |
| 21 |
.Op Fl P Ar name=value |
| 22 |
.Ar |
| 23 |
.Ek |
| 24 |
.Nm |
| 25 |
.Fl C |
| 26 |
.Op Fl m Ar magicfiles |
| 27 |
.Nm |
| 28 |
.Op Fl Fl help |
| 29 |
.Sh DESCRIPTION |
| 30 |
This manual page documents version 5.47 of the |
| 31 |
.Nm |
| 32 |
command. |
| 33 |
.Pp |
| 34 |
.Nm |
| 35 |
tests each argument in an attempt to classify it. |
| 36 |
There are three sets of tests, performed in this order: |
| 37 |
filesystem tests, magic tests, and language tests. |
| 38 |
The |
| 39 |
.Em first |
| 40 |
test that succeeds causes the file type to be printed. |
| 41 |
.Pp |
| 42 |
The type printed will usually contain one of the words |
| 43 |
.Em text |
| 44 |
(the file contains only |
| 45 |
printing characters and a few common control |
| 46 |
characters and is probably safe to read on an |
| 47 |
.Dv ASCII |
| 48 |
terminal), |
| 49 |
.Em executable |
| 50 |
(the file contains the result of compiling a program |
| 51 |
in a form understandable to some |
| 52 |
.Tn UNIX |
| 53 |
kernel or another), |
| 54 |
or |
| 55 |
.Em data |
| 56 |
meaning anything else (data is usually |
| 57 |
.Dq binary |
| 58 |
or non-printable). |
| 59 |
Exceptions are well-known file formats (core files, tar archives) |
| 60 |
that are known to contain binary data. |
| 61 |
When modifying magic files or the program itself, make sure to |
| 62 |
.Em "preserve these keywords" . |
| 63 |
Users depend on knowing that all the readable files in a directory |
| 64 |
have the word |
| 65 |
.Dq text |
| 66 |
printed. |
| 67 |
Don't do as Berkeley did and change |
| 68 |
.Dq shell commands text |
| 69 |
to |
| 70 |
.Dq shell script . |
| 71 |
.Pp |
| 72 |
The filesystem tests are based on examining the return from a |
| 73 |
.Xr stat 2 |
| 74 |
system call. |
| 75 |
The program checks to see if the file is empty, |
| 76 |
or if it's some sort of special file. |
| 77 |
Any known file types appropriate to the system you are running on |
| 78 |
(sockets, symbolic links, or named pipes (FIFOs) on those systems that |
| 79 |
implement them) |
| 80 |
are intuited if they are defined in the system header file |
| 81 |
.In sys/stat.h . |
| 82 |
.Pp |
| 83 |
The magic tests are used to check for files with data in |
| 84 |
particular fixed formats. |
| 85 |
The canonical example of this is a binary executable (compiled program) |
| 86 |
.Dv a.out |
| 87 |
file, whose format is defined in |
| 88 |
.In elf.h , |
| 89 |
.In a.out.h |
| 90 |
and possibly |
| 91 |
.In exec.h |
| 92 |
in the standard include directory. |
| 93 |
These files have a |
| 94 |
.Dq magic number |
| 95 |
stored in a particular place |
| 96 |
near the beginning of the file that tells the |
| 97 |
.Tn UNIX |
| 98 |
operating system |
| 99 |
that the file is a binary executable, and which of several types thereof. |
| 100 |
The concept of a |
| 101 |
.Dq magic number |
| 102 |
has been applied by extension to data files. |
| 103 |
Any file with some invariant identifier at a small fixed |
| 104 |
offset into the file can usually be described in this way. |
| 105 |
The information identifying these files is read from /etc/magic |
| 106 |
and the compiled |
| 107 |
magic file |
| 108 |
.Pa /usr/share/misc/magic.mgc , |
| 109 |
or the files in the directory |
| 110 |
.Pa /usr/share/misc/magic |
| 111 |
if the compiled file does not exist. |
| 112 |
In addition, if |
| 113 |
.Pa $HOME/.magic.mgc |
| 114 |
or |
| 115 |
.Pa $HOME/.magic |
| 116 |
exists, it will be used in preference to the system magic files. |
| 117 |
.Pp |
| 118 |
If a file does not match any of the entries in the magic file, |
| 119 |
it is examined to see if it seems to be a text file. |
| 120 |
ASCII, ISO-8859-x, non-ISO 8-bit extended-ASCII character sets |
| 121 |
(such as those used on Macintosh and IBM PC systems), |
| 122 |
UTF-8-encoded Unicode, UTF-16-encoded Unicode, and EBCDIC |
| 123 |
character sets can be distinguished by the different |
| 124 |
ranges and sequences of bytes that constitute printable text |
| 125 |
in each set. |
| 126 |
If a file passes any of these tests, its character set is reported. |
| 127 |
ASCII, ISO-8859-x, UTF-8, and extended-ASCII files are identified |
| 128 |
as |
| 129 |
.Dq text |
| 130 |
because they will be mostly readable on nearly any terminal; |
| 131 |
UTF-16 and EBCDIC are only |
| 132 |
.Dq character data |
| 133 |
because, while |
| 134 |
they contain text, it is text that will require translation |
| 135 |
before it can be read. |
| 136 |
In addition, |
| 137 |
.Nm |
| 138 |
will attempt to determine other characteristics of text-type files. |
| 139 |
If the lines of a file are terminated by CR, CRLF, or NEL, instead |
| 140 |
of the Unix-standard LF, this will be reported. |
| 141 |
Files that contain embedded escape sequences or overstriking |
| 142 |
will also be identified. |
| 143 |
.Pp |
| 144 |
Once |
| 145 |
.Nm |
| 146 |
has determined the character set used in a text-type file, |
| 147 |
it will |
| 148 |
attempt to determine in what language the file is written. |
| 149 |
The language tests look for particular strings (cf. |
| 150 |
.In names.h ) |
| 151 |
that can appear anywhere in the first few blocks of a file. |
| 152 |
For example, the keyword |
| 153 |
.Em .br |
| 154 |
indicates that the file is most likely a |
| 155 |
.Xr troff 1 |
| 156 |
input file, just as the keyword |
| 157 |
.Em struct |
| 158 |
indicates a C program. |
| 159 |
These tests are less reliable than the previous |
| 160 |
two groups, so they are performed last. |
| 161 |
The language test routines also test for some miscellany |
| 162 |
(such as |
| 163 |
.Xr tar 1 |
| 164 |
archives, JSON files). |
| 165 |
.Pp |
| 166 |
Any file that cannot be identified as having been written |
| 167 |
in any of the character sets listed above is simply said to be |
| 168 |
.Dq data . |
| 169 |
.Sh OPTIONS |
| 170 |
.Bl -tag -width indent |
| 171 |
.It Fl Fl apple |
| 172 |
Causes the |
| 173 |
.Nm |
| 174 |
command to output the file type and creator code as |
| 175 |
used by older MacOS versions. |
| 176 |
The code consists of eight letters, |
| 177 |
the first four describing the file type, the latter four the creator. |
| 178 |
This option works properly only for file formats that have the |
| 179 |
apple-style output defined. |
| 180 |
.It Fl b , Fl Fl brief |
| 181 |
Do not prepend filenames to output lines (brief mode). |
| 182 |
.It Fl C , Fl Fl compile |
| 183 |
Write a |
| 184 |
.Pa magic.mgc |
| 185 |
output file that contains a pre-parsed version of the magic file or directory. |
| 186 |
.It Fl c , Fl Fl checking-printout |
| 187 |
Cause a checking printout of the parsed form of the magic file. |
| 188 |
This is usually used in conjunction with the |
| 189 |
.Fl m |
| 190 |
option to debug a new magic file before installing it. |
| 191 |
.It Fl d |
| 192 |
Prints internal debugging information to stderr. |
| 193 |
.It Fl E |
| 194 |
On filesystem errors (file not found etc), instead of handling the error |
| 195 |
as regular output as POSIX mandates and keep going, issue an error message |
| 196 |
and exit. |
| 197 |
.It Fl e , Fl Fl exclude Ar testname |
| 198 |
Exclude the test named in |
| 199 |
.Ar testname |
| 200 |
from the list of tests made to determine the file type. |
| 201 |
Valid test names are: |
| 202 |
.Bl -tag -width compress |
| 203 |
.It apptype |
| 204 |
.Dv EMX |
| 205 |
application type (only on EMX). |
| 206 |
.It ascii |
| 207 |
Various types of text files (this test will try to guess the text |
| 208 |
encoding, irrespective of the setting of the |
| 209 |
.Sq encoding |
| 210 |
option). |
| 211 |
.It encoding |
| 212 |
Different text encodings for soft magic tests. |
| 213 |
.It tokens |
| 214 |
Ignored for backwards compatibility. |
| 215 |
.It cdf |
| 216 |
Prints details of Compound Document Files. |
| 217 |
.It compress |
| 218 |
Checks for, and looks inside, compressed files. |
| 219 |
.It csv |
| 220 |
Checks Comma Separated Value files. |
| 221 |
.It elf |
| 222 |
Prints ELF file details, provided soft magic tests are enabled and the |
| 223 |
elf magic is found. |
| 224 |
.It json |
| 225 |
Examines JSON (RFC-7159) files by parsing them for compliance. |
| 226 |
.It soft |
| 227 |
Consults magic files. |
| 228 |
.It simh |
| 229 |
Examines SIMH tape files. |
| 230 |
.It tar |
| 231 |
Examines tar files by verifying the checksum of the 512 byte tar header. |
| 232 |
Excluding this test can provide more detailed content description by using |
| 233 |
the soft magic method. |
| 234 |
.It text |
| 235 |
A synonym for |
| 236 |
.Sq ascii . |
| 237 |
.El |
| 238 |
.It Fl Fl exclude-quiet |
| 239 |
Like |
| 240 |
.Fl Fl exclude |
| 241 |
but ignore tests that |
| 242 |
.Nm |
| 243 |
does not know about. |
| 244 |
This is intended for compatibility with older versions of |
| 245 |
.Nm . |
| 246 |
.It Fl Fl extension |
| 247 |
Print a slash-separated list of valid extensions for the file type found. |
| 248 |
.It Fl F , Fl Fl separator Ar separator |
| 249 |
Use the specified string as the separator between the filename and the |
| 250 |
file result returned. |
| 251 |
Defaults to |
| 252 |
.Sq \&: . |
| 253 |
.It Fl f , Fl Fl files-from Ar namefile |
| 254 |
Read the names of the files to be examined from |
| 255 |
.Ar namefile |
| 256 |
(one per line) |
| 257 |
before the argument list. |
| 258 |
Either |
| 259 |
.Ar namefile |
| 260 |
or at least one filename argument must be present; |
| 261 |
to test the standard input, use |
| 262 |
.Sq - |
| 263 |
as a filename argument. |
| 264 |
Please note that |
| 265 |
.Ar namefile |
| 266 |
is unwrapped and the enclosed filenames are processed when this option is |
| 267 |
encountered and before any further options processing is done. |
| 268 |
This allows one to process multiple lists of files with different command line |
| 269 |
arguments on the same |
| 270 |
.Nm |
| 271 |
invocation. |
| 272 |
Thus if you want to set the delimiter, you need to do it before you specify |
| 273 |
the list of files, like: |
| 274 |
.Dq Fl F Ar @ Fl f Ar namefile , |
| 275 |
instead of: |
| 276 |
.Dq Fl f Ar namefile Fl F Ar @ . |
| 277 |
.It Fl h , Fl Fl no-dereference |
| 278 |
This option causes symlinks not to be followed |
| 279 |
(on systems that support symbolic links). |
| 280 |
This is the default if the environment variable |
| 281 |
.Dv POSIXLY_CORRECT |
| 282 |
is not defined. |
| 283 |
.It Fl i , Fl Fl mime |
| 284 |
Causes the |
| 285 |
.Nm |
| 286 |
command to output mime type strings rather than the more |
| 287 |
traditional human readable ones. |
| 288 |
Thus it may say |
| 289 |
.Sq text/plain; charset=us-ascii |
| 290 |
rather than |
| 291 |
.Dq ASCII text . |
| 292 |
.It Fl Fl mime-type , Fl Fl mime-encoding |
| 293 |
Like |
| 294 |
.Fl i , |
| 295 |
but print only the specified element(s). |
| 296 |
.It Fl k , Fl Fl keep-going |
| 297 |
Don't stop at the first match, keep going. |
| 298 |
Subsequent matches will be |
| 299 |
have the string |
| 300 |
.Sq "\[rs]012\- " |
| 301 |
prepended. |
| 302 |
(If you want a newline, see the |
| 303 |
.Fl r |
| 304 |
option.) |
| 305 |
The magic pattern with the highest strength (see the |
| 306 |
.Fl l |
| 307 |
option) comes first. |
| 308 |
.It Fl l , Fl Fl list |
| 309 |
Shows a list of patterns and their strength sorted descending by |
| 310 |
.Xr magic 5 |
| 311 |
strength |
| 312 |
which is used for the matching (see also the |
| 313 |
.Fl k |
| 314 |
option). |
| 315 |
.It Fl L , Fl Fl dereference |
| 316 |
This option causes symlinks to be followed, as the like-named option in |
| 317 |
.Xr ls 1 |
| 318 |
(on systems that support symbolic links). |
| 319 |
This is the default if the environment variable |
| 320 |
.Ev POSIXLY_CORRECT |
| 321 |
is defined. |
| 322 |
.It Fl m , Fl Fl magic-file Ar magicfiles |
| 323 |
Specify an alternate list of files and directories containing magic. |
| 324 |
This can be a single item, or a colon-separated list. |
| 325 |
If a compiled magic file is found alongside a file or directory, |
| 326 |
it will be used instead. |
| 327 |
.It Fl N , Fl Fl no-pad |
| 328 |
Don't pad filenames so that they align in the output. |
| 329 |
.It Fl n , Fl Fl no-buffer |
| 330 |
Force stdout to be flushed after checking each file. |
| 331 |
This is only useful if checking a list of files. |
| 332 |
It is intended to be used by programs that want filetype output from a pipe. |
| 333 |
.It Fl p , Fl Fl preserve-date |
| 334 |
On systems that support |
| 335 |
.Xr utime 3 |
| 336 |
or |
| 337 |
.Xr utimes 2 , |
| 338 |
attempt to preserve the access time of files analyzed, to pretend that |
| 339 |
.Nm |
| 340 |
never read them. |
| 341 |
.It Fl P , Fl Fl parameter Ar name=value |
| 342 |
Set various parameter limits. |
| 343 |
.Bl -column "elf_phnum" "Default" "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" |
| 344 |
.It Sy "Name" Ta Sy "Default" Ta Sy "Explanation" |
| 345 |
.It Li bytes Ta 1M Ta max number of bytes to read from file |
| 346 |
.It Li elf_notes Ta 256 Ta max ELF notes processed |
| 347 |
.It Li elf_phnum Ta 2K Ta max ELF program sections processed |
| 348 |
.It Li elf_shnum Ta 32K Ta max ELF sections processed |
| 349 |
.It Li elf_shsize Ta 128MB Ta max ELF section size processed |
| 350 |
.It Li encoding Ta 65K Ta max number of bytes to determine encoding |
| 351 |
.It Li indir Ta 50 Ta recursion limit for indirect magic |
| 352 |
.It Li name Ta 150 Ta use count limit for name/use magic |
| 353 |
.It Li regex Ta 8K Ta length limit for regex searches |
| 354 |
.El |
| 355 |
.It Fl r , Fl Fl raw |
| 356 |
Don't translate unprintable characters to \eooo. |
| 357 |
Normally |
| 358 |
.Nm |
| 359 |
translates unprintable characters to their octal representation. |
| 360 |
.It Fl s , Fl Fl special-files |
| 361 |
Normally, |
| 362 |
.Nm |
| 363 |
only attempts to read and determine the type of argument files which |
| 364 |
.Xr stat 2 |
| 365 |
reports are ordinary files. |
| 366 |
This prevents problems, because reading special files may have peculiar |
| 367 |
consequences. |
| 368 |
Specifying the |
| 369 |
.Fl s |
| 370 |
option causes |
| 371 |
.Nm |
| 372 |
to also read argument files which are block or character special files. |
| 373 |
This is useful for determining the filesystem types of the data in raw |
| 374 |
disk partitions, which are block special files. |
| 375 |
This option also causes |
| 376 |
.Nm |
| 377 |
to disregard the file size as reported by |
| 378 |
.Xr stat 2 |
| 379 |
since on some systems it reports a zero size for raw disk partitions. |
| 380 |
.It Fl S , Fl Fl no-sandbox |
| 381 |
On systems where libseccomp |
| 382 |
.Pa ( https://github.com/seccomp/libseccomp ) |
| 383 |
is available, the |
| 384 |
.Fl S |
| 385 |
option disables sandboxing which is enabled by default. |
| 386 |
This option is needed for |
| 387 |
.Nm |
| 388 |
to execute external decompressing programs, |
| 389 |
i.e. when the |
| 390 |
.Fl z |
| 391 |
option is specified and the built-in decompressors are not available. |
| 392 |
On systems where sandboxing is not available, this option has no effect. |
| 393 |
.Pp |
| 394 |
.Em Note: |
| 395 |
This Debian version of |
| 396 |
.Nm |
| 397 |
was built without seccomp support, so this option has no effect. |
| 398 |
.It Fl v , Fl Fl version |
| 399 |
Print the version of the program and exit. |
| 400 |
.It Fl z , Fl Fl uncompress |
| 401 |
Try to look inside compressed files. |
| 402 |
.It Fl Z , Fl Fl uncompress-noreport |
| 403 |
Try to look inside compressed files, but report information about the contents |
| 404 |
only not the compression. |
| 405 |
.It Fl 0 , Fl Fl print0 |
| 406 |
Output a null character |
| 407 |
.Sq \e0 |
| 408 |
after the end of the filename. |
| 409 |
Nice to |
| 410 |
.Xr cut 1 |
| 411 |
the output. |
| 412 |
This does not affect the separator, which is still printed. |
| 413 |
.Pp |
| 414 |
If this option is repeated more than once, then |
| 415 |
.Nm |
| 416 |
prints just the filename followed by a NUL followed by the description |
| 417 |
(or ERROR: text) followed by a second NUL for each entry. |
| 418 |
.It Fl -help |
| 419 |
Print a help message and exit. |
| 420 |
.El |
| 421 |
.Sh ENVIRONMENT |
| 422 |
The environment variable |
| 423 |
.Ev MAGIC |
| 424 |
can be used to set the default magic file name. |
| 425 |
If that variable is set, then |
| 426 |
.Nm |
| 427 |
will not attempt to open |
| 428 |
.Pa $HOME/.magic . |
| 429 |
.Nm |
| 430 |
adds |
| 431 |
.Dq Pa .mgc |
| 432 |
to the value of this variable as appropriate. |
| 433 |
The environment variable |
| 434 |
.Ev POSIXLY_CORRECT |
| 435 |
controls (on systems that support symbolic links), whether |
| 436 |
.Nm |
| 437 |
will attempt to follow symlinks or not. |
| 438 |
If set, then |
| 439 |
.Nm |
| 440 |
follows symlink, otherwise it does not. |
| 441 |
This is also controlled by the |
| 442 |
.Fl L |
| 443 |
and |
| 444 |
.Fl h |
| 445 |
options. |
| 446 |
.Sh FILES |
| 447 |
.Bl -tag -width /usr/share/misc/magic.mgc -compact |
| 448 |
.It Pa /usr/share/misc/magic.mgc |
| 449 |
Default compiled list of magic. |
| 450 |
.It Pa /usr/share/misc/magic |
| 451 |
Directory containing default magic files. |
| 452 |
.El |
| 453 |
.Sh EXIT STATUS |
| 454 |
.Nm |
| 455 |
will exit with |
| 456 |
.Dv 0 |
| 457 |
if the operation was successful or |
| 458 |
.Dv >0 |
| 459 |
if an error was encountered. |
| 460 |
The following errors cause diagnostic messages, but don't affect the program |
| 461 |
exit code (as POSIX requires), unless |
| 462 |
.Fl E |
| 463 |
is specified: |
| 464 |
.Bl -bullet -compact -offset indent |
| 465 |
.It |
| 466 |
A file cannot be found |
| 467 |
.It |
| 468 |
There is no permission to read a file |
| 469 |
.It |
| 470 |
The file type cannot be determined |
| 471 |
.El |
| 472 |
.Sh EXAMPLES |
| 473 |
.Bd -literal -offset indent |
| 474 |
$ file file.c file /dev/{wd0a,hda} |
| 475 |
file.c: C program text |
| 476 |
file: ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV), |
| 477 |
dynamically linked (uses shared libs), stripped |
| 478 |
/dev/wd0a: block special (0/0) |
| 479 |
/dev/hda: block special (3/0) |
| 480 |
|
| 481 |
$ file -s /dev/wd0{b,d} |
| 482 |
/dev/wd0b: data |
| 483 |
/dev/wd0d: x86 boot sector |
| 484 |
|
| 485 |
$ file -s /dev/hda{,1,2,3,4,5,6,7,8,9,10} |
| 486 |
/dev/hda: x86 boot sector |
| 487 |
/dev/hda1: Linux/i386 ext2 filesystem |
| 488 |
/dev/hda2: x86 boot sector |
| 489 |
/dev/hda3: x86 boot sector, extended partition table |
| 490 |
/dev/hda4: Linux/i386 ext2 filesystem |
| 491 |
/dev/hda5: Linux/i386 swap file |
| 492 |
/dev/hda6: Linux/i386 swap file |
| 493 |
/dev/hda7: Linux/i386 swap file |
| 494 |
/dev/hda8: Linux/i386 swap file |
| 495 |
/dev/hda9: empty |
| 496 |
/dev/hda10: empty |
| 497 |
|
| 498 |
$ file -i file.c file /dev/{wd0a,hda} |
| 499 |
file.c: text/x-c |
| 500 |
file: application/x-executable |
| 501 |
/dev/hda: application/x-not-regular-file |
| 502 |
/dev/wd0a: application/x-not-regular-file |
| 503 |
|
| 504 |
.Ed |
| 505 |
.Sh SEE ALSO |
| 506 |
.Xr hexdump 1 , |
| 507 |
.Xr od 1 , |
| 508 |
.Xr strings 1 , |
| 509 |
.Xr magic 5 |
| 510 |
.Sh STANDARDS CONFORMANCE |
| 511 |
This program is believed to exceed the System V Interface Definition |
| 512 |
of FILE(CMD), as near as one can determine from the vague language |
| 513 |
contained therein. |
| 514 |
Its behavior is mostly compatible with the System V program of the same name. |
| 515 |
This version knows more magic, however, so it will produce |
| 516 |
different (albeit more accurate) output in many cases. |
| 517 |
.\" URL: http://www.opengroup.org/onlinepubs/009695399/utilities/file.html |
| 518 |
.Pp |
| 519 |
The one significant difference |
| 520 |
between this version and System V |
| 521 |
is that this version treats any white space |
| 522 |
as a delimiter, so that spaces in pattern strings must be escaped. |
| 523 |
For example, |
| 524 |
.Bd -literal -offset indent |
| 525 |
\*[Gt]10 string language impress\ (imPRESS data) |
| 526 |
.Ed |
| 527 |
.Pp |
| 528 |
in an existing magic file would have to be changed to |
| 529 |
.Bd -literal -offset indent |
| 530 |
\*[Gt]10 string language\e impress (imPRESS data) |
| 531 |
.Ed |
| 532 |
.Pp |
| 533 |
In addition, in this version, if a pattern string contains a backslash, |
| 534 |
it must be escaped. |
| 535 |
For example |
| 536 |
.Bd -literal -offset indent |
| 537 |
0 string \ebegindata Andrew Toolkit document |
| 538 |
.Ed |
| 539 |
.Pp |
| 540 |
in an existing magic file would have to be changed to |
| 541 |
.Bd -literal -offset indent |
| 542 |
0 string \e\ebegindata Andrew Toolkit document |
| 543 |
.Ed |
| 544 |
.Pp |
| 545 |
SunOS releases 3.2 and later from Sun Microsystems include a |
| 546 |
.Nm |
| 547 |
command derived from the System V one, but with some extensions. |
| 548 |
This version differs from Sun's only in minor ways. |
| 549 |
It includes the extension of the |
| 550 |
.Sq \*[Am] |
| 551 |
operator, used as, |
| 552 |
for example, |
| 553 |
.Bd -literal -offset indent |
| 554 |
\*[Gt]16 long\*[Am]0x7fffffff \*[Gt]0 not stripped |
| 555 |
.Ed |
| 556 |
.Sh SECURITY |
| 557 |
On systems where libseccomp |
| 558 |
.Pa ( https://github.com/seccomp/libseccomp ) |
| 559 |
is available, |
| 560 |
.Nm |
| 561 |
is enforces limiting system calls to only the ones necessary for the |
| 562 |
operation of the program. |
| 563 |
This enforcement does not provide any security benefit when |
| 564 |
.Nm |
| 565 |
is asked to decompress input files running external programs with |
| 566 |
the |
| 567 |
.Fl z |
| 568 |
option. |
| 569 |
To enable execution of external decompressors, one needs to disable |
| 570 |
sandboxing using the |
| 571 |
.Fl S |
| 572 |
option. |
| 573 |
.Sh MAGIC DIRECTORY |
| 574 |
The magic file entries have been collected from various sources, |
| 575 |
mainly USENET, and contributed by various authors. |
| 576 |
Christos Zoulas (address below) will collect additional |
| 577 |
or corrected magic file entries. |
| 578 |
A consolidation of magic file entries |
| 579 |
will be distributed periodically. |
| 580 |
.Pp |
| 581 |
The order of entries in the magic file is significant. |
| 582 |
Depending on what system you are using, the order that |
| 583 |
they are put together may be incorrect. |
| 584 |
.Sh HISTORY |
| 585 |
There has been a |
| 586 |
.Nm |
| 587 |
command in every |
| 588 |
.Dv UNIX since at least Research Version 4 |
| 589 |
(man page dated November, 1973). |
| 590 |
The System V version introduced one significant major change: |
| 591 |
the external list of magic types. |
| 592 |
This slowed the program down slightly but made it a lot more flexible. |
| 593 |
.Pp |
| 594 |
This program, based on the System V version, |
| 595 |
was written by Ian Darwin |
| 596 |
.Aq [email protected] |
| 597 |
without looking at anybody else's source code. |
| 598 |
.Pp |
| 599 |
John Gilmore revised the code extensively, making it better than |
| 600 |
the first version. |
| 601 |
Geoff Collyer found several inadequacies |
| 602 |
and provided some magic file entries. |
| 603 |
Contributions of the |
| 604 |
.Sq \*[Am] |
| 605 |
operator by Rob McMahon, |
| 606 |
.Aq [email protected] , |
| 607 |
1989. |
| 608 |
.Pp |
| 609 |
Guy Harris, |
| 610 |
.Aq [email protected] , |
| 611 |
made many changes from 1993 to the present. |
| 612 |
.Pp |
| 613 |
Primary development and maintenance from 1990 to the present by |
| 614 |
Christos Zoulas |
| 615 |
.Aq [email protected] . |
| 616 |
.Pp |
| 617 |
Altered by Chris Lowth |
| 618 |
.Aq [email protected] , |
| 619 |
2000: handle the |
| 620 |
.Fl i |
| 621 |
option to output mime type strings, using an alternative |
| 622 |
magic file and internal logic. |
| 623 |
.Pp |
| 624 |
Altered by Eric Fischer |
| 625 |
.Aq [email protected] , |
| 626 |
July, 2000, |
| 627 |
to identify character codes and attempt to identify the languages |
| 628 |
of non-ASCII files. |
| 629 |
.Pp |
| 630 |
Altered by Reuben Thomas |
| 631 |
.Aq [email protected] , |
| 632 |
2007-2011, to improve MIME support, merge MIME and non-MIME magic, |
| 633 |
support directories as well as files of magic, apply many bug fixes, |
| 634 |
update and fix a lot of magic, improve the build system, improve the |
| 635 |
documentation, and rewrite the Python bindings in pure Python. |
| 636 |
.Pp |
| 637 |
The list of contributors to the |
| 638 |
.Sq magic |
| 639 |
directory (magic files) |
| 640 |
is too long to include here. |
| 641 |
You know who you are; thank you. |
| 642 |
Many contributors are listed in the source files. |
| 643 |
.Sh LEGAL NOTICE |
| 644 |
Copyright (c) Ian F. Darwin, Toronto, Canada, 1986-1999. |
| 645 |
Covered by the standard Berkeley Software Distribution copyright; see the file |
| 646 |
COPYING in the source distribution. |
| 647 |
.Pp |
| 648 |
The files |
| 649 |
.Pa tar.h |
| 650 |
and |
| 651 |
.Pa is_tar.c |
| 652 |
were written by John Gilmore from his public-domain |
| 653 |
.Xr tar 1 |
| 654 |
program, and are not covered by the above license. |
| 655 |
.Sh BUGS |
| 656 |
Please report bugs and send patches to the bug tracker at |
| 657 |
.Pa https://bugs.astron.com/ |
| 658 |
or the mailing list at |
| 659 |
.Aq [email protected] |
| 660 |
(visit |
| 661 |
.Pa https://mailman.astron.com/mailman/listinfo/file |
| 662 |
first to subscribe). |
| 663 |
.Sh TODO |
| 664 |
Fix output so that tests for MIME and APPLE flags are not needed all |
| 665 |
over the place, and actual output is only done in one place. |
| 666 |
This needs a design. |
| 667 |
Suggestion: push possible outputs on to a list, then pick the |
| 668 |
last-pushed (most specific, one hopes) value at the end, or |
| 669 |
use a default if the list is empty. |
| 670 |
This should not slow down evaluation. |
| 671 |
.Pp |
| 672 |
The handling of |
| 673 |
.Dv MAGIC_CONTINUE |
| 674 |
and printing \e012- between entries is clumsy and complicated; refactor |
| 675 |
and centralize. |
| 676 |
.Pp |
| 677 |
Some of the encoding logic is hard-coded in encoding.c and can be moved |
| 678 |
to the magic files if we had a !:charset annotation. |
| 679 |
.Pp |
| 680 |
Continue to squash all magic bugs. |
| 681 |
See Debian BTS for a good source. |
| 682 |
.Pp |
| 683 |
Store arbitrarily long strings, for example for %s patterns, so that |
| 684 |
they can be printed out. |
| 685 |
Fixes Debian bug #271672. |
| 686 |
This can be done by allocating strings in a string pool, storing the |
| 687 |
string pool at the end of the magic file and converting all the string |
| 688 |
pointers to relative offsets from the string pool. |
| 689 |
.Pp |
| 690 |
Add syntax for relative offsets after current level (Debian bug #466037). |
| 691 |
.Pp |
| 692 |
Make file -ki work, i.e. give multiple MIME types. |
| 693 |
.Pp |
| 694 |
Add a zip library so we can peek inside Office2007 documents to |
| 695 |
print more details about their contents. |
| 696 |
.Pp |
| 697 |
Add an option to print URLs for the sources of the file descriptions. |
| 698 |
.Pp |
| 699 |
Combine script searches and add a way to map executable names to MIME |
| 700 |
types (e.g. have a magic value for !:mime which causes the resulting |
| 701 |
string to be looked up in a table). |
| 702 |
This would avoid adding the same magic repeatedly for each new |
| 703 |
hash-bang interpreter. |
| 704 |
.Pp |
| 705 |
When a file descriptor is available, we can skip and adjust the buffer |
| 706 |
instead of the hacky buffer management we do now. |
| 707 |
.Pp |
| 708 |
Fix |
| 709 |
.Dq name |
| 710 |
and |
| 711 |
.Dq use |
| 712 |
to check for consistency at compile time (duplicate |
| 713 |
.Dq name , |
| 714 |
.Dq use |
| 715 |
pointing to undefined |
| 716 |
.Dq name |
| 717 |
). |
| 718 |
Make |
| 719 |
.Dq name |
| 720 |
/ |
| 721 |
.Dq use |
| 722 |
more efficient by keeping a sorted list of names. |
| 723 |
Special-case ^ to flip endianness in the parser so that it does not |
| 724 |
have to be escaped, and document it. |
| 725 |
.Pp |
| 726 |
If the offsets specified internally in the file exceed the buffer size |
| 727 |
( |
| 728 |
.Dv HOWMANY |
| 729 |
variable in file.h), then we don't seek to that offset, but we give up. |
| 730 |
It would be better if buffer managements was done when the file descriptor |
| 731 |
is available so we can seek around the file. |
| 732 |
One must be careful though because this has performance and thus security |
| 733 |
considerations, because one can slow down things by repeatedly seeking. |
| 734 |
.Pp |
| 735 |
There is support now for keeping separate buffers and having offsets from |
| 736 |
the end of the file, but the internal buffer management still needs an |
| 737 |
overhaul. |
| 738 |
.Sh AVAILABILITY |
| 739 |
You can obtain the original author's latest version by anonymous FTP |
| 740 |
on |
| 741 |
.Pa ftp.astron.com |
| 742 |
in the directory |
| 743 |
.Pa /pub/file/file-X.YZ.tar.gz . |