5b22438467374d85d72d50a8eef0ea4c064c01c5
[dragonfly.git] / contrib / file / doc / file.man
1 .\" $File: file.man,v 1.96 2011/07/12 11:23:38 rrt Exp $
2 .Dd April 20, 2011
3 .Dt FILE __CSECTION__
4 .Os
5 .Sh NAME
6 .Nm file
7 .Nd determine file type
8 .Sh SYNOPSIS
9 .Nm
10 .Bk -words
11 .Op Fl bchiklLNnprsvz0
12 .Op Fl Fl apple
13 .Op Fl Fl mime-encoding
14 .Op Fl Fl mime-type
15 .Op Fl e Ar testname
16 .Op Fl F Ar separator
17 .Op Fl f Ar namefile
18 .Op Fl m Ar magicfiles
19 .Ar
20 .Ek
21 .Nm
22 .Fl C
23 .Op Fl m Ar magicfiles
24 .Nm
25 .Op Fl Fl help
26 .Sh DESCRIPTION
27 This manual page documents version __VERSION__ of the
28 .Nm
29 command.
30 .Pp
31 .Nm
32 tests each argument in an attempt to classify it.
33 There are three sets of tests, performed in this order:
34 filesystem tests, magic tests, and language tests.
35 The
36 .Em first
37 test that succeeds causes the file type to be printed.
38 .Pp
39 The type printed will usually contain one of the words
40 .Em text
41 (the file contains only
42 printing characters and a few common control
43 characters and is probably safe to read on an
44 .Dv ASCII
45 terminal),
46 .Em executable
47 (the file contains the result of compiling a program
48 in a form understandable to some
49 .Tn UNIX
50 kernel or another),
51 or
52 .Em data
53 meaning anything else (data is usually
54 .Dq binary
55 or non-printable).
56 Exceptions are well-known file formats (core files, tar archives)
57 that are known to contain binary data.
58 When modifying magic files or the program itself, make sure to
59 .Em "preserve these keywords" .
60 Users depend on knowing that all the readable files in a directory
61 have the word
62 .Dq text
63 printed.
64 Don't do as Berkeley did and change
65 .Dq shell commands text
66 to
67 .Dq shell script .
68 .Pp
69 The filesystem tests are based on examining the return from a
70 .Xr stat 2
71 system call.
72 The program checks to see if the file is empty,
73 or if it's some sort of special file.
74 Any known file types appropriate to the system you are running on
75 (sockets, symbolic links, or named pipes (FIFOs) on those systems that
76 implement them)
77 are intuited if they are defined in the system header file
78 .In sys/stat.h .
79 .Pp
80 The magic tests are used to check for files with data in
81 particular fixed formats.
82 The canonical example of this is a binary executable (compiled program)
83 .Dv a.out
84 file, whose format is defined in
85 .In elf.h ,
86 .In a.out.h
87 and possibly
88 .In exec.h
89 in the standard include directory.
90 These files have a
91 .Dq "magic number"
92 stored in a particular place
93 near the beginning of the file that tells the
94 .Tn UNIX
95 operating system
96 that the file is a binary executable, and which of several types thereof.
97 The concept of a
98 .Dq "magic"
99 has been applied by extension to data files.
100 Any file with some invariant identifier at a small fixed
101 offset into the file can usually be described in this way.
102 The information identifying these files is read from the compiled
103 magic file
104 .Pa __MAGIC__.mgc ,
105 or the files in the directory
106 .Pa __MAGIC__
107 if the compiled file does not exist.
108 In addition, if
109 .Pa $HOME/.magic.mgc
110 or
111 .Pa $HOME/.magic
112 exists, it will be used in preference to the system magic files.
113 .Pp
114 If a file does not match any of the entries in the magic file,
115 it is examined to see if it seems to be a text file.
116 ASCII, ISO-8859-x, non-ISO 8-bit extended-ASCII character sets
117 (such as those used on Macintosh and IBM PC systems),
118 UTF-8-encoded Unicode, UTF-16-encoded Unicode, and EBCDIC
119 character sets can be distinguished by the different
120 ranges and sequences of bytes that constitute printable text
121 in each set.
122 If a file passes any of these tests, its character set is reported.
123 ASCII, ISO-8859-x, UTF-8, and extended-ASCII files are identified
124 as
125 .Dq text
126 because they will be mostly readable on nearly any terminal;
127 UTF-16 and EBCDIC are only
128 .Dq character data
129 because, while
130 they contain text, it is text that will require translation
131 before it can be read.
132 In addition,
133 .Nm
134 will attempt to determine other characteristics of text-type files.
135 If the lines of a file are terminated by CR, CRLF, or NEL, instead
136 of the Unix-standard LF, this will be reported.
137 Files that contain embedded escape sequences or overstriking
138 will also be identified.
139 .Pp
140 Once
141 .Nm
142 has determined the character set used in a text-type file,
143 it will
144 attempt to determine in what language the file is written.
145 The language tests look for particular strings (cf.
146 .In names.h )
147 that can appear anywhere in the first few blocks of a file.
148 For example, the keyword
149 .Em .br
150 indicates that the file is most likely a
151 .Xr troff 1
152 input file, just as the keyword
153 .Em struct
154 indicates a C program.
155 These tests are less reliable than the previous
156 two groups, so they are performed last.
157 The language test routines also test for some miscellany
158 (such as
159 .Xr tar 1
160 archives).
161 .Pp
162 Any file that cannot be identified as having been written
163 in any of the character sets listed above is simply said to be
164 .Dq data .
165 .Sh OPTIONS
166 .Bl -tag -width indent
167 .It Fl b , Fl Fl brief
168 Do not prepend filenames to output lines (brief mode).
169 .It Fl C , Fl Fl compile
170 Write a
171 .Pa magic.mgc
172 output file that contains a pre-parsed version of the magic file or directory.
173 .It Fl c , Fl Fl checking-printout
174 Cause a checking printout of the parsed form of the magic file.
175 This is usually used in conjunction with the
176 .Fl m
177 flag to debug a new magic file before installing it.
178 .It Fl e , Fl Fl exclude Ar testname
179 Exclude the test named in
180 .Ar testname
181 from the list of tests made to determine the file type.
182 Valid test names are:
183 .Bl -tag -width compress
184 .It apptype
185 .Dv EMX
186 application type (only on EMX).
187 .It ascii
188 Various types of text files (this test will try to guess the text
189 encoding, irrespective of the setting of the
190 .Sq encoding
191 option).
192 .It encoding
193 Different text encodings for soft magic tests.
194 .It tokens
195 Looks for known tokens inside text files.
196 .It cdf
197 Prints details of Compound Document Files.
198 .It compress
199 Checks for, and looks inside, compressed files.
200 .It elf
201 Prints ELF file details.
202 .It soft
203 Consults magic files.
204 .It tar
205 Examines tar files.
206 .El
207 .It Fl F , Fl Fl separator Ar separator
208 Use the specified string as the separator between the filename and the
209 file result returned.
210 Defaults to
211 .Sq \&: .
212 .It Fl f , Fl Fl files-from Ar namefile
213 Read the names of the files to be examined from
214 .Ar namefile
215 (one per line)
216 before the argument list.
217 Either
218 .Ar namefile
219 or at least one filename argument must be present;
220 to test the standard input, use
221 .Sq -
222 as a filename argument.
223 .It Fl h , Fl Fl no-dereference
224 option causes symlinks not to be followed
225 (on systems that support symbolic links).
226 This is the default if the environment variable
227 .Dv POSIXLY_CORRECT
228 is not defined.
229 .It Fl i , Fl Fl mime
230 Causes the file command to output mime type strings rather than the more
231 traditional human readable ones.
232 Thus it may say
233 .Sq text/plain; charset=us-ascii
234 rather than
235 .Dq ASCII text .
236 .It Fl Fl mime-type , Fl Fl mime-encoding
237 Like
238 .Fl i ,
239 but print only the specified element(s).
240 .It Fl k , Fl Fl keep-going
241 Don't stop at the first match, keep going.
242 Subsequent matches will be
243 have the string
244 .Sq "\[rs]012\- "
245 prepended.
246 (If you want a newline, see the
247 .Fl r
248 option.)
249 .It Fl l , Fl Fl list
250 Print information about the strength of each magic pattern.
251 .It Fl L , Fl Fl dereference
252 option causes symlinks to be followed, as the like-named option in
253 .Xr ls 1
254 (on systems that support symbolic links).
255 This is the default if the environment variable
256 .Ev POSIXLY_CORRECT
257 is defined.
258 .It Fl l
259 Shows sorted patterns list in the order which is used for the matching.
260 .It Fl m , Fl Fl magic-file Ar magicfiles
261 Specify an alternate list of files and directories containing magic.
262 This can be a single item, or a colon-separated list.
263 If a compiled magic file is found alongside a file or directory,
264 it will be used instead.
265 .It Fl N , Fl Fl no-pad
266 Don't pad filenames so that they align in the output.
267 .It Fl n , Fl Fl no-buffer
268 Force stdout to be flushed after checking each file.
269 This is only useful if checking a list of files.
270 It is intended to be used by programs that want filetype output from a pipe.
271 .It Fl p , Fl Fl preserve-date
272 On systems that support
273 .Xr utime 3
274 or
275 .Xr utimes 2 ,
276 attempt to preserve the access time of files analyzed, to pretend that
277 .Nm
278 never read them.
279 .It Fl r , Fl Fl raw
280 Don't translate unprintable characters to \eooo.
281 Normally
282 .Nm
283 translates unprintable characters to their octal representation.
284 .It Fl s , Fl Fl special-files
285 Normally,
286 .Nm
287 only attempts to read and determine the type of argument files which
288 .Xr stat 2
289 reports are ordinary files.
290 This prevents problems, because reading special files may have peculiar
291 consequences.
292 Specifying the
293 .Fl s
294 option causes
295 .Nm
296 to also read argument files which are block or character special files.
297 This is useful for determining the filesystem types of the data in raw
298 disk partitions, which are block special files.
299 This option also causes
300 .Nm
301 to disregard the file size as reported by
302 .Xr stat 2
303 since on some systems it reports a zero size for raw disk partitions.
304 .It Fl v , Fl Fl version
305 Print the version of the program and exit.
306 .It Fl z , Fl Fl uncompress
307 Try to look inside compressed files.
308 .It Fl 0 , Fl Fl print0
309 Output a null character
310 .Sq \e0
311 after the end of the filename.
312 Nice to
313 .Xr cut 1
314 the output.
315 This does not affect the separator which is still printed.
316 .It Fl -help
317 Print a help message and exit.
318 .El
319 .Sh FILES
320 .Bl -tag -width __MAGIC__.mgc -compact
321 .It Pa __MAGIC__.mgc
322 Default compiled list of magic.
323 .It Pa __MAGIC__
324 Directory containing default magic files.
325 .El
326 .Sh ENVIRONMENT
327 The environment variable
328 .Ev MAGIC
329 can be used to set the default magic file name.
330 If that variable is set, then
331 .Nm
332 will not attempt to open
333 .Pa $HOME/.magic .
334 .Nm
335 adds
336 .Dq Pa .mgc
337 to the value of this variable as appropriate.
338 However,
339 .Pa file
340 has to exist in order for
341 .Pa file.mime
342 to be considered.
343 The environment variable
344 .Ev POSIXLY_CORRECT
345 controls (on systems that support symbolic links), whether
346 .Nm
347 will attempt to follow symlinks or not.
348 If set, then
349 .Nm
350 follows symlink, otherwise it does not.
351 This is also controlled by the
352 .Fl L
353 and
354 .Fl h
355 options.
356 .Sh SEE ALSO
357 .Xr magic __FSECTION__ ,
358 .Xr hexdump 1 ,
359 .Xr od 1 ,
360 .Xr strings 1 ,
361 .Sh STANDARDS CONFORMANCE
362 This program is believed to exceed the System V Interface Definition
363 of FILE(CMD), as near as one can determine from the vague language
364 contained therein.
365 Its behavior is mostly compatible with the System V program of the same name.
366 This version knows more magic, however, so it will produce
367 different (albeit more accurate) output in many cases.
368 .\" URL: http://www.opengroup.org/onlinepubs/009695399/utilities/file.html
369 .Pp
370 The one significant difference
371 between this version and System V
372 is that this version treats any white space
373 as a delimiter, so that spaces in pattern strings must be escaped.
374 For example,
375 .Bd -literal -offset indent
376 \*[Gt]10        string  language impress\       (imPRESS data)
377 .Ed
378 .Pp
379 in an existing magic file would have to be changed to
380 .Bd -literal -offset indent
381 \*[Gt]10        string  language\e impress      (imPRESS data)
382 .Ed
383 .Pp
384 In addition, in this version, if a pattern string contains a backslash,
385 it must be escaped.
386 For example
387 .Bd -literal -offset indent
388 0       string          \ebegindata     Andrew Toolkit document
389 .Ed
390 .Pp
391 in an existing magic file would have to be changed to
392 .Bd -literal -offset indent
393 0       string          \e\ebegindata   Andrew Toolkit document
394 .Ed
395 .Pp
396 SunOS releases 3.2 and later from Sun Microsystems include a
397 .Nm
398 command derived from the System V one, but with some extensions.
399 This version differs from Sun's only in minor ways.
400 It includes the extension of the
401 .Sq \*[Am]
402 operator, used as,
403 for example,
404 .Bd -literal -offset indent
405 \*[Gt]16        long\*[Am]0x7fffffff    \*[Gt]0         not stripped
406 .Ed
407 .Sh MAGIC DIRECTORY
408 The magic file entries have been collected from various sources,
409 mainly USENET, and contributed by various authors.
410 Christos Zoulas (address below) will collect additional
411 or corrected magic file entries.
412 A consolidation of magic file entries
413 will be distributed periodically.
414 .Pp
415 The order of entries in the magic file is significant.
416 Depending on what system you are using, the order that
417 they are put together may be incorrect.
418 If your old
419 .Nm
420 command uses a magic file,
421 keep the old magic file around for comparison purposes
422 (rename it to
423 .Pa __MAGIC__.orig ) .
424 .Sh EXAMPLES
425 .Bd -literal -offset indent
426 $ file file.c file /dev/{wd0a,hda}
427 file.c:   C program text
428 file:     ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV),
429           dynamically linked (uses shared libs), stripped
430 /dev/wd0a: block special (0/0)
431 /dev/hda: block special (3/0)
432
433 $ file -s /dev/wd0{b,d}
434 /dev/wd0b: data
435 /dev/wd0d: x86 boot sector
436
437 $ file -s /dev/hda{,1,2,3,4,5,6,7,8,9,10}
438 /dev/hda:   x86 boot sector
439 /dev/hda1:  Linux/i386 ext2 filesystem
440 /dev/hda2:  x86 boot sector
441 /dev/hda3:  x86 boot sector, extended partition table
442 /dev/hda4:  Linux/i386 ext2 filesystem
443 /dev/hda5:  Linux/i386 swap file
444 /dev/hda6:  Linux/i386 swap file
445 /dev/hda7:  Linux/i386 swap file
446 /dev/hda8:  Linux/i386 swap file
447 /dev/hda9:  empty
448 /dev/hda10: empty
449
450 $ file -i file.c file /dev/{wd0a,hda}
451 file.c:      text/x-c
452 file:        application/x-executable
453 /dev/hda:    application/x-not-regular-file
454 /dev/wd0a:   application/x-not-regular-file
455
456 .Ed
457 .Sh HISTORY
458 There has been a
459 .Nm
460 command in every
461 .Dv UNIX since at least Research Version 4
462 (man page dated November, 1973).
463 The System V version introduced one significant major change:
464 the external list of magic types.
465 This slowed the program down slightly but made it a lot more flexible.
466 .Pp
467 This program, based on the System V version,
468 was written by Ian Darwin
469 .Aq ian@darwinsys.com
470 without looking at anybody else's source code.
471 .Pp
472 John Gilmore revised the code extensively, making it better than
473 the first version.
474 Geoff Collyer found several inadequacies
475 and provided some magic file entries.
476 Contributions by the
477 .Sq \*[Am]
478 operator by Rob McMahon, 
479 .Aq cudcv@warwick.ac.uk ,
480 1989.
481 .Pp
482 Guy Harris, 
483 .Aq guy@netapp.com ,
484 made many changes from 1993 to the present.
485 1989.
486 .Pp
487 Primary development and maintenance from 1990 to the present by
488 Christos Zoulas
489 .Aq christos@astron.com .
490 .Pp
491 Altered by Chris Lowth
492 .Aq chris@lowth.com ,
493 2000: handle the
494 .Fl i
495 option to output mime type strings, using an alternative
496 magic file and internal logic.
497 .Pp
498 Altered by Eric Fischer
499 .Aq enf@pobox.com ,
500 July, 2000,
501 to identify character codes and attempt to identify the languages
502 of non-ASCII files.
503 .Pp
504 Altered by Reuben Thomas
505 .Aq rrt@sc3d.org ,
506 2007-2011, to improve MIME support, merge MIME and non-MIME magic,
507 support directories as well as files of magic, apply many bug fixes,
508 update and fix a lot of magic, improve the build system, improve the
509 documentation, and rewrite the Python bindings in pure Python.
510 .Pp
511 The list of contributors to the
512 .Sq magic
513 directory (magic files)
514 is too long to include here.
515 You know who you are; thank you.
516 Many contributors are listed in the source files.
517 .Sh LEGAL NOTICE
518 Copyright (c) Ian F. Darwin, Toronto, Canada, 1986-1999.
519 Covered by the standard Berkeley Software Distribution copyright; see the file
520 COPYING in the source distribution.
521 .Pp
522 The files
523 .Pa tar.h
524 and
525 .Pa is_tar.c
526 were written by John Gilmore from his public-domain
527 .Xr tar 1
528 program, and are not covered by the above license.
529 .Sh RETURN CODE
530 .Nm
531 returns 0 on success, and non-zero on error.
532 .Sh BUGS
533 .Pp
534 Please report bugs and send patches to the bug tracker at
535 .Pa http://bugs.gw.com/
536 or the mailing list at
537 .Aq file@mx.gw.com .
538 .Sh TODO
539 .Pp
540 Fix output so that tests for MIME and APPLE flags are not needed all
541 over the place, and actual output is only done in one place. This
542 needs a design. Suggestion: push possible outputs on to a list, then
543 pick the last-pushed (most specific, one hopes) value at the end, or
544 use a default if the list is empty. This should not slow down evaluation.
545 .Pp
546 Continue to squash all magic bugs. See Debian BTS for a good source.
547 .Pp
548 Store arbitrarily long strings, for example for %s patterns, so that
549 they can be printed out. Fixes Debian bug #271672. Would require more
550 complex store/load code in apprentice.
551 .Pp
552 Add syntax for relative offsets after current level (Debian bug #466037).
553 .Pp
554 Make file -ki work, i.e. give multiple MIME types.
555 .Pp
556 Add a zip library so we can peek inside Office2007 documents to
557 figure out what they are.
558 .Pp
559 Add an option to print URLs for the sources of the file descriptions.
560 .Sh AVAILABILITY
561 You can obtain the original author's latest version by anonymous FTP
562 on
563 .Pa ftp.astron.com
564 in the directory
565 .Pa /pub/file/file-X.YZ.tar.gz .