libmagic.man 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. .\" $File: libmagic.man,v 1.18 2008/02/28 22:24:46 rrt Exp $
  2. .\"
  3. .\" Copyright (c) Christos Zoulas 2003.
  4. .\" All Rights Reserved.
  5. .\"
  6. .\" Redistribution and use in source and binary forms, with or without
  7. .\" modification, are permitted provided that the following conditions
  8. .\" are met:
  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.
  15. .\"
  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
  26. .\" SUCH DAMAGE.
  27. .\"
  28. .Dd November 15, 2006
  29. .Dt MAGIC 3
  30. .Os
  31. .Sh NAME
  32. .Nm magic_open ,
  33. .Nm magic_close ,
  34. .Nm magic_error ,
  35. .Nm magic_file ,
  36. .Nm magic_buffer ,
  37. .Nm magic_setflags ,
  38. .Nm magic_check ,
  39. .Nm magic_compile ,
  40. .Nm magic_load
  41. .Nd Magic number recognition library.
  42. .Sh LIBRARY
  43. .Lb libmagic
  44. .Sh SYNOPSIS
  45. .In magic.h
  46. .Ft magic_t
  47. .Fn magic_open "int flags"
  48. .Ft void
  49. .Fn magic_close "magic_t cookie"
  50. .Ft const char *
  51. .Fn magic_error "magic_t cookie"
  52. .Ft int
  53. .Fn magic_errno "magic_t cookie"
  54. .Ft const char *
  55. .Fn magic_file "magic_t cookie, const char *filename"
  56. .Ft const char *
  57. .Fn magic_buffer "magic_t cookie, const void *buffer, size_t length"
  58. .Ft int
  59. .Fn magic_setflags "magic_t cookie, int flags"
  60. .Ft int
  61. .Fn magic_check "magic_t cookie, const char *filename"
  62. .Ft int
  63. .Fn magic_compile "magic_t cookie, const char *filename"
  64. .Ft int
  65. .Fn magic_load "magic_t cookie, const char *filename"
  66. .Sh DESCRIPTION
  67. These functions
  68. operate on the magic database file
  69. which is described
  70. in
  71. .Xr magic __FSECTION__ .
  72. .Pp
  73. The function
  74. .Fn magic_open
  75. creates a magic cookie pointer and returns it. It returns NULL if
  76. there was an error allocating the magic cookie. The
  77. .Ar flags
  78. argument specifies how the other magic functions should behave:
  79. .Bl -tag -width MAGIC_COMPRESS
  80. .It Dv MAGIC_NONE
  81. No special handling.
  82. .It Dv MAGIC_DEBUG
  83. Print debugging messages to stderr.
  84. .It Dv MAGIC_SYMLINK
  85. If the file queried is a symlink, follow it.
  86. .It Dv MAGIC_COMPRESS
  87. If the file is compressed, unpack it and look at the contents.
  88. .It Dv MAGIC_DEVICES
  89. If the file is a block or character special device, then open the device
  90. and try to look in its contents.
  91. .It Dv MAGIC_MIME_TYPE
  92. Return a MIME type string, instead of a textual description.
  93. .It Dv MAGIC_MIME_ENCODING
  94. Return a MIME encoding, instead of a textual description.
  95. .It Dv MAGIC_CONTINUE
  96. Return all matches, not just the first.
  97. .It Dv MAGIC_CHECK
  98. Check the magic database for consistency and print warnings to stderr.
  99. .It Dv MAGIC_PRESERVE_ATIME
  100. On systems that support
  101. .Xr utime 2
  102. or
  103. .Xr utimes 2 ,
  104. attempt to preserve the access time of files analyzed.
  105. .It Dv MAGIC_RAW
  106. Don't translate unprintable characters to a \eooo octal representation.
  107. .It Dv MAGIC_ERROR
  108. Treat operating system errors while trying to open files and follow symlinks
  109. as real errors, instead of printing them in the magic buffer.
  110. .It Dv MAGIC_NO_CHECK_APPTYPE
  111. Check for
  112. .Dv EMX
  113. application type (only on EMX).
  114. .It Dv MAGIC_NO_CHECK_ASCII
  115. Check for various types of ascii files.
  116. .It Dv MAGIC_NO_CHECK_COMPRESS
  117. Don't look for, or inside compressed files.
  118. .It Dv MAGIC_NO_CHECK_ELF
  119. Don't print elf details.
  120. .It Dv MAGIC_NO_CHECK_FORTRAN
  121. Don't look for fortran sequences inside ascii files.
  122. .It Dv MAGIC_NO_CHECK_SOFT
  123. Don't consult magic files.
  124. .It Dv MAGIC_NO_CHECK_TAR
  125. Don't examine tar files.
  126. .It Dv MAGIC_NO_CHECK_TOKENS
  127. Don't look for known tokens inside ascii files.
  128. .It Dv MAGIC_NO_CHECK_TROFF
  129. Don't look for troff sequences inside ascii files.
  130. .El
  131. .Pp
  132. The
  133. .Fn magic_close
  134. function closes the
  135. .Xr magic __FSECTION__
  136. database and deallocates any resources used.
  137. .Pp
  138. The
  139. .Fn magic_error
  140. function returns a textual explanation of the last error, or NULL if there was
  141. no error.
  142. .Pp
  143. The
  144. .Fn magic_errno
  145. function returns the last operating system error number
  146. .Pq Xr errno 2
  147. that was encountered by a system call.
  148. .Pp
  149. The
  150. .Fn magic_file
  151. function returns a textual description of the contents of the
  152. .Ar filename
  153. argument, or NULL if an error occurred.
  154. If the
  155. .Ar filename
  156. is NULL, then stdin is used.
  157. .Pp
  158. The
  159. .Fn magic_buffer
  160. function returns a textual description of the contents of the
  161. .Ar buffer
  162. argument with
  163. .Ar length
  164. bytes size.
  165. .Pp
  166. The
  167. .Fn magic_setflags
  168. function sets the
  169. .Ar flags
  170. described above. Note that using both MIME flags together can also
  171. return extra information on the charset.
  172. .Pp
  173. The
  174. .Fn magic_check
  175. function can be used to check the validity of entries in the colon
  176. separated database files passed in as
  177. .Ar filename ,
  178. or NULL for the default database. It returns 0 on success and -1 on
  179. failure.
  180. .Pp
  181. The
  182. .Fn magic_compile
  183. function can be used to compile the the colon
  184. separated list of database files passed in as
  185. .Ar filename ,
  186. or NULL for the default database. It returns 0 on success and -1 on
  187. failure. The compiled files created are named from the
  188. .Xr basename 1
  189. of each file argument with
  190. .Dq .mgc
  191. appended to it.
  192. .Pp
  193. The
  194. .Fn magic_load
  195. function must be used to load the the colon
  196. separated list of database files passed in as
  197. .Ar filename ,
  198. or NULL for the default database file
  199. before any magic queries can performed.
  200. .Pp
  201. The default database file is named by the MAGIC environment variable. If
  202. that variable is not set, the default database file name is __MAGIC__.
  203. .Pp
  204. .Fn magic_load
  205. adds
  206. .Dq .mime
  207. and/or
  208. .Dq .mgc
  209. to the database filename as appropriate.
  210. .Sh RETURN VALUES
  211. The function
  212. .Fn magic_open
  213. returns a magic cookie on success and NULL on failure setting errno to
  214. an appropriate value. It will set errno to EINVAL if an unsupported
  215. value for flags was given.
  216. The
  217. .Fn magic_load ,
  218. .Fn magic_compile ,
  219. and
  220. .Fn magic_check
  221. functions return 0 on success and -1 on failure.
  222. The
  223. .Fn magic_file ,
  224. and
  225. .Fn magic_buffer
  226. functions return a string on success and NULL on failure. The
  227. .Fn magic_error
  228. function returns a textual description of the errors of the above
  229. functions, or NULL if there was no error.
  230. Finally,
  231. .Fn magic_setflags
  232. returns -1 on systems that don't support
  233. .Xr utime 2 ,
  234. or
  235. .Xr utimes 2
  236. when
  237. .Dv MAGIC_PRESERVE_ATIME
  238. is set.
  239. .Sh FILES
  240. .Bl -tag -width __MAGIC__.mime.mgc -compact
  241. .It Pa __MAGIC__.mime
  242. The non-compiled default magic mime database.
  243. .It Pa __MAGIC__.mime.mgc
  244. The compiled default magic mime database.
  245. .It Pa __MAGIC__
  246. The non-compiled default magic database.
  247. .It Pa __MAGIC__.mgc
  248. The compiled default magic database.
  249. .El
  250. .Sh SEE ALSO
  251. .Xr file __CSECTION__ ,
  252. .Xr magic __FSECTION__
  253. .Sh AUTHORS
  254. Måns Rullgård Initial libmagic implementation,
  255. and configuration.
  256. Christos Zoulas API cleanup, error code and allocation handling.