usr/src/man/man3lib/libfstyp.3lib

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBFSTYP 3LIB "Jun 20, 2006"
   7 .SH NAME
   8 libfstyp \- file system type identification library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lfstyp\fR \fB -lnvpair \fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include \fB<libnvpair.h>\fR
  14 #include \fB<libfstyp.h>\fR
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBlibfstyp\fR library exports a set of functions to identify the file
  21 system type of an unmounted file system using heuristic modules.
  22 .sp
  23 .LP
  24 Internally, the library is comprised of interfaces exported by file
  25 system-specific modules. See \fBfstyp_mod_init\fR(3FSTYP).
  26 .SH INTERFACES
  27 .sp
  28 .LP
  29 The shared object \fBlibfstyp.so.1\fR provides the public interfaces defined
  30 below. See \fBIntro\fR(3) for additional information on shared object
  31 interfaces.
  32 .sp
  33
  34 .sp
  35 .TS
  36 l l
  37 l l .
  38 \fBfstyp_fini\fR        \fBfstyp_get_attr\fR
  39 \fBfstyp_ident\fR       \fBfstyp_init\fR
  40 \fBfstyp_mod_dump\fR    \fBfstyp_mod_fini\fR
  41 \fBfstyp_mod_get_attr\fR        \fBfstyp_mod_ident\fR
  42 \fBfstyp_mod_init\fR    \fBfstyp_strerror\fR
  43 .TE
  44
  45 .SH FILES
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fB/lib/libfstyp.so.1\fR\fR
  50 .ad
  51 .RS 22n
  52 shared object
  53 .RE
  54
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Evolving
  69 _
  70 MT-Level        MT-Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBIntro\fR(3), \fBfstyp_mod_init\fR(3FSTYP), \fBlibnvpair\fR(3LIB),
  77 \fBattributes\fR(5)