2 .\" Copyright (c) Christos Zoulas 2003.
3 .\" All Rights Reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice immediately at the beginning of the file, without modification,
10 .\" this list of conditions, and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\" derived from this software without specific prior written permission.
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 .Nd Magic number recognition library.
48 .Fn magic_open "int flags"
50 .Fn magic_close "magic_t cookie"
52 .Fn magic_error "magic_t cookie"
54 .Fn magic_errno "magic_t cookie"
56 .Fn magic_file "magic_t cookie, const char *filename"
58 .Fn magic_buffer "magic_t cookie, const void *buffer, size_t length"
60 .Fn magic_setflags "magic_t cookie, int flags"
62 .Fn magic_check "magic_t cookie, const char *filename"
64 .Fn magic_compile "magic_t cookie, const char *filename"
66 .Fn magic_load "magic_t cookie, const char *filename"
69 operate on the magic database file
72 .Xr magic __FSECTION__ .
76 creates a magic cookie pointer and returns it. It returns NULL if
77 there was an error allocating the magic cookie. The
79 argument specifies how the other magic functions should behave:
80 .Bl -tag -width MAGIC_COMPRESS
84 Print debugging messages to stderr.
86 If the file queried is a symlink, follow it.
88 If the file is compressed, unpack it and look at the contents.
90 If the file is a block or character special device, then open the device
91 and try to look in its contents.
93 Return a mime string, instead of a textual description.
95 Return all matches, not just the first.
97 Check the magic database for consistency and print warnings to stderr.
98 .It Dv MAGIC_PRESERVE_ATIME
99 On systems that support
103 attempt to preserve the access time of files analyzed.
105 Don't translate unprintable characters to a \eooo octal representation.
107 Treat operating system errors while trying to open files and follow symlinks
108 as real errors, instead of printing them in the magic buffer.
114 .Xr magic __FSECTION__
115 database and deallocates any resources used.
119 function returns a textual explanation of the last error, or NULL if there was
124 function returns the last operating system error number (
126 that was encountered by a system call.
130 function returns a textual description of the contents of the
132 argument, or NULL if an error occurred.
135 is NULL, then stdin is used.
139 function returns a textual description of the contents of the
153 function can be used to check the validity of entries in the colon
154 separated database files passed in as
156 or NULL for the default database. It returns 0 on success and -1 on
161 function can be used to compile the the colon
162 separated list of database files passed in as
164 or NULL for the default database. It returns 0 on success and -1 on
165 failure. The compiled files created are named from the
167 of each file argument with ".mgc" appended to it.
171 function must be used to load the the colon
172 separated list of database files passed in as
174 or NULL for the default database file
175 before any magic queries can performed.
177 The default database file is named by the MAGIC environment variable. If
178 that variable is not set, the default database file name is __MAGIC__.
181 adds ".mime" and/or ".mgc" to the database filename as appropriate.
185 returns a magic cookie on success and NULL on failure setting errno to
186 an appropriate value. It will set errno to EINVAL if an unsupported
187 value for flags was given.
193 functions return 0 on success and -1 on failure.
198 functions return a string on success and NULL on failure. The
200 function returns a textual description of the errors of the above
201 functions, or NULL if there was no error.
204 returns -1 on systems that don't support
209 .Dv MAGIC_PRESERVE_ATIME
212 .Bl -tag -width __MAGIC__.mime.mgc -compact
213 .It Pa __MAGIC__.mime
214 The non-compiled default magic mime database.
215 .It Pa __MAGIC__.mime.mgc
216 The compiled default magic mime database.
218 The non-compiled default magic database.
220 The compiled default magic database.
223 .Xr file __CSECTION__ ,
224 .Xr magic __FSECTION__
226 Måns Rullgård Initial libmagic implementation,
228 Christos Zoulas API cleanup, error code and allocation handling.