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

   1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBFCOE 3LIB "Apr 1, 2009"
   7 .SH NAME
   8 libfcoe \- FCoE Port Mangament library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... lfcoe [ \fIlibrary\fR... ]
  13 #include <libfcoe.h>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 Functions in this library provide management of the FCoE (Fibre Channel over
  20 Ethernet) ports in the system, allowing clients to create, delete and list
  21 information of FCoE ports.
  22 .SH INTERFACES
  23 .sp
  24 .LP
  25 The shared object \fBlibfcoe.so.1\fR provides the public interfaces defined
  26 below. See \fBIntro\fR(3) for additional information on shared object
  27 interfaces.
  28 .sp
  29
  30 .sp
  31 .TS
  32 l l
  33 l l .
  34 \fBFCOE_CreatePort\fR   \fBFCOE_DeletePort\fR
  35 \fBFCOE_GetPortList\fR
  36 .TE
  37
  38 .SH FILES
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fB/lib/libfcoe.so.1\fR\fR
  43 .ad
  44 .RS 24n
  45 shared object
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB/lib/64/libfcoe.so.1\fR\fR
  52 .ad
  53 .RS 24n
  54 64-bit shared object
  55 .RE
  56
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5) for descriptions of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 Interface Stability     Committed
  70 _
  71 MT-Level        Safe
  72 .TE
  73
  74 .SH SEE ALSO
  75 .sp
  76 .LP
  77 \fBIntro\fR(3), \fBFCOE_CreatePort\fR(3FCOE), \fBFCOE_DeletePort\fR(3FCOE),
  78 \fBFCOE_GetPortList\fR(3FCOE), \fBattributes\fR(5)