From: Christos Zoulas <christos@zoulas.com>
Date: Tue, 1 Jun 2010 12:31:31 +0000 (+0000)
Subject: add a description for file_descriptor
X-Git-Tag: FILE5_05~91
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=24785fd520908040f258bf6095820ba171164446;p=file

add a description for file_descriptor
---

diff --git a/doc/libmagic.man b/doc/libmagic.man
index a9e59215..9af2c0bc 100644
--- a/doc/libmagic.man
+++ b/doc/libmagic.man
@@ -1,4 +1,4 @@
-.\" $File: libmagic.man,v 1.21 2009/11/24 21:16:14 christos Exp $
+.\" $File: libmagic.man,v 1.22 2010/06/01 12:31:31 christos Exp $
 .\"
 .\" Copyright (c) Christos Zoulas 2003.
 .\" All Rights Reserved.
@@ -25,14 +25,14 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd November 24, 2009
+.Dd July 1, 2010
 .Dt LIBMAGIC 3
 .Os
 .Sh NAME
 .Nm magic_open ,
 .Nm magic_close ,
 .Nm magic_error ,
-.Nm magic_file ,
+.Nm magic_descriptor ,
 .Nm magic_buffer ,
 .Nm magic_setflags ,
 .Nm magic_check ,
@@ -52,6 +52,8 @@
 .Ft int
 .Fn magic_errno "magic_t cookie"
 .Ft const char *
+.Fn magic_descriptor "magic_t cookie, "int fd"
+.Ft const char *
 .Fn magic_file "magic_t cookie, const char *filename"
 .Ft const char *
 .Fn magic_buffer "magic_t cookie, const void *buffer, size_t length"
@@ -156,6 +158,12 @@ If the
 is NULL, then stdin is used.
 .Pp
 The
+.Fn magic_descriptor
+function returns a textual description of the contents of the
+.Ar fd
+argument, or NULL if an error occurred.
+.Pp
+The
 .Fn magic_buffer
 function returns a textual description of the contents of the
 .Ar buffer