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.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
19 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 .Nd Magic number recognition library.
46 .Fn magic_open "int flags"
48 .Fn magic_close "magic_t cookie"
50 .Fn magic_error "magic_t cookie"
52 .Fn magic_errno "magic_t cookie"
54 .Fn magic_file "magic_t cookie, const char *filename"
56 .Fn magic_buffer "magic_t cookie, const void *buffer, size_t length"
58 .Fn magic_setflags "magic_t cookie, int flags"
60 .Fn magic_check "magic_t cookie, const char *filename"
62 .Fn magic_compile "magic_t cookie, const char *filename"
64 .Fn magic_load "magic_t cookie, const char *filename"
67 operate on the magic database file
70 .Xr magic __FSECTION__ .
74 creates a magic cookie pointer and returns it. It returns NULL if
75 there was an error allocating the magic cookie. The
77 argument specifies how the other magic functions should behave:
78 .Bl -tag -width MAGIC_COMPRESS
82 Print debugging messages to stderr.
84 If the file queried is a symlink, follow it.
86 If the file is compressed, unpack it and look at the contents.
88 If the file is a block or character special device, then open the device
89 and try to look in its contents.
90 .It Dv MAGIC_MIME_TYPE
91 Return a MIME type string, instead of a textual description.
92 .It Dv MAGIC_MIME_ENCODING
93 Return a MIME encoding, 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.
109 .It Dv MAGIC_NO_CHECK_APPTYPE
112 application type (only on EMX).
113 .It Dv MAGIC_NO_CHECK_ASCII
114 Check for various types of ascii files.
115 .It Dv MAGIC_NO_CHECK_COMPRESS
116 Don't look for, or inside compressed files.
117 .It Dv MAGIC_NO_CHECK_ELF
118 Don't print elf details.
119 .It Dv MAGIC_NO_CHECK_FORTRAN
120 Don't look for fortran sequences inside ascii files.
121 .It Dv MAGIC_NO_CHECK_SOFT
122 Don't consult magic files.
123 .It Dv MAGIC_NO_CHECK_TAR
124 Don't examine tar files.
125 .It Dv MAGIC_NO_CHECK_TOKENS
126 Don't look for known tokens inside ascii files.
127 .It Dv MAGIC_NO_CHECK_TROFF
128 Don't look for troff sequences inside ascii files.
134 .Xr magic __FSECTION__
135 database and deallocates any resources used.
139 function returns a textual explanation of the last error, or NULL if there was
144 function returns the last operating system error number
146 that was encountered by a system call.
150 function returns a textual description of the contents of the
152 argument, or NULL if an error occurred.
155 is NULL, then stdin is used.
159 function returns a textual description of the contents of the
169 described above. Note that using both MIME flags together can also
170 return extra information on the charset.
174 function can be used to check the validity of entries in the colon
175 separated database files passed in as
177 or NULL for the default database. It returns 0 on success and -1 on
182 function can be used to compile the the colon
183 separated list of database files passed in as
185 or NULL for the default database. It returns 0 on success and -1 on
186 failure. The compiled files created are named from the
188 of each file argument with ".mgc" appended to it.
192 function must be used to load the the colon
193 separated list of database files passed in as
195 or NULL for the default database file
196 before any magic queries can performed.
198 The default database file is named by the MAGIC environment variable. If
199 that variable is not set, the default database file name is __MAGIC__.
202 adds ".mime" and/or ".mgc" to the database filename as appropriate.
206 returns a magic cookie on success and NULL on failure setting errno to
207 an appropriate value. It will set errno to EINVAL if an unsupported
208 value for flags was given.
214 functions return 0 on success and -1 on failure.
219 functions return a string on success and NULL on failure. The
221 function returns a textual description of the errors of the above
222 functions, or NULL if there was no error.
225 returns -1 on systems that don't support
230 .Dv MAGIC_PRESERVE_ATIME
233 .Bl -tag -width __MAGIC__.mime.mgc -compact
234 .It Pa __MAGIC__.mime
235 The non-compiled default magic mime database.
236 .It Pa __MAGIC__.mime.mgc
237 The compiled default magic mime database.
239 The non-compiled default magic database.
241 The compiled default magic database.
244 .Xr file __CSECTION__ ,
245 .Xr magic __FSECTION__
247 Måns Rullgård Initial libmagic implementation,
249 Christos Zoulas API cleanup, error code and allocation handling.