1 .\" $File: libmagic.man,v 1.26 2011/12/19 17:49:31 christos Exp $
3 .\" Copyright (c) Christos Zoulas 2003.
4 .\" All Rights Reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice immediately at the beginning of the file, without modification,
11 .\" this list of conditions, and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nm magic_descriptor ,
41 .Nd Magic number recognition library
47 .Fn magic_open "int flags"
49 .Fn magic_close "magic_t cookie"
51 .Fn magic_error "magic_t cookie"
53 .Fn magic_errno "magic_t cookie"
55 .Fn magic_descriptor "magic_t cookie" "int fd"
57 .Fn magic_file "magic_t cookie" "const char *filename"
59 .Fn magic_buffer "magic_t cookie" "const void *buffer" "size_t length"
61 .Fn magic_setflags "magic_t cookie" "int flags"
63 .Fn magic_check "magic_t cookie" "const char *filename"
65 .Fn magic_compile "magic_t cookie" "const char *filename"
67 .Fn magic_list "magic_t cookie" "const char *filename"
69 .Fn magic_load "magic_t cookie" "const char *filename"
72 operate on the magic database file
75 .Xr magic __FSECTION__ .
79 creates a magic cookie pointer and returns it.
82 if there was an error allocating the magic cookie.
85 argument specifies how the other magic functions should behave:
86 .Bl -tag -width MAGIC_COMPRESS
90 Print debugging messages to stderr.
92 If the file queried is a symlink, follow it.
94 If the file is compressed, unpack it and look at the contents.
96 If the file is a block or character special device, then open the device
97 and try to look in its contents.
98 .It Dv MAGIC_MIME_TYPE
99 Return a MIME type string, instead of a textual description.
100 .It Dv MAGIC_MIME_ENCODING
101 Return a MIME encoding, instead of a textual description.
103 A shorthand for MAGIC_MIME_TYPE | MAGIC_MIME_ENCODING.
104 .It Dv MAGIC_CONTINUE
105 Return all matches, not just the first.
107 Check the magic database for consistency and print warnings to stderr.
108 .It Dv MAGIC_PRESERVE_ATIME
109 On systems that support
113 attempt to preserve the access time of files analysed.
115 Don't translate unprintable characters to a \eooo octal representation.
117 Treat operating system errors while trying to open files and follow symlinks
118 as real errors, instead of printing them in the magic buffer.
120 Return the Apple creator and type.
121 .It Dv MAGIC_NO_CHECK_APPTYPE
124 application type (only on EMX).
125 .It Dv MAGIC_NO_CHECK_CDF
126 Don't get extra information on MS Composite Document Files.
127 .It Dv MAGIC_NO_CHECK_COMPRESS
128 Don't look inside compressed files.
129 .It Dv MAGIC_NO_CHECK_ELF
130 Don't print ELF details.
131 .It Dv MAGIC_NO_CHECK_ENCODING
132 Don't check text encodings.
133 .It Dv MAGIC_NO_CHECK_SOFT
134 Don't consult magic files.
135 .It Dv MAGIC_NO_CHECK_TAR
136 Don't examine tar files.
137 .It Dv MAGIC_NO_CHECK_TEXT
138 Don't check for various types of text files.
139 .It Dv MAGIC_NO_CHECK_TOKENS
140 Don't look for known tokens inside ascii files.
146 .Xr magic __FSECTION__
147 database and deallocates any resources used.
151 function returns a textual explanation of the last error, or
153 if there was no error.
157 function returns the last operating system error number
159 that was encountered by a system call.
163 function returns a textual description of the contents of the
167 if an error occurred.
176 function returns a textual description of the contents of the
180 if an error occurred.
184 function returns a textual description of the contents of the
195 Note that using both MIME flags together can also
196 return extra information on the charset.
200 function can be used to check the validity of entries in the colon
201 separated database files passed in as
205 for the default database.
206 It returns 0 on success and \-1 on failure.
210 function can be used to compile the the colon
211 separated list of database files passed in as
215 for the default database.
216 It returns 0 on success and \-1 on failure.
217 The compiled files created are named from the
219 of each file argument with
225 function dumps all magic entries in a human readable format,
226 dumping first the entries that are matched against binary files and then the
227 ones that match text files.
228 It takes and optional
230 argument which is a colon separated list of database files, or
232 for the default database.
236 function must be used to load the the colon
237 separated list of database files passed in as
241 for the default database file before any magic queries can performed.
243 The default database file is named by the MAGIC environment variable.
244 If that variable is not set, the default database file name is __MAGIC__.
248 to the database filename as appropriate.
252 returns a magic cookie on success and
254 on failure setting errno to an appropriate value.
257 if an unsupported value for flags was given.
264 functions return 0 on success and \-1 on failure.
270 functions return a string on success and
275 function returns a textual description of the errors of the above
278 if there was no error.
281 returns \-1 on systems that don't support
286 .Dv MAGIC_PRESERVE_ATIME
289 .Bl -tag -width __MAGIC__.mgc -compact
291 The non-compiled default magic database.
293 The compiled default magic database.
296 .Xr file __CSECTION__ ,
297 .Xr magic __FSECTION__
299 .An M\(oans Rullg\(oard
300 Initial libmagic implementation, and configuration.
302 API cleanup, error code and allocation handling.