10067 Miscellaneous man page typos
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Andy Fiddaman <andy@omniosce.org>
Reviewed by: Volker A. Brandt <vab@bb-c.de>

   1 '\" te
   2 .\" Copyright (c) 2003, 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 SERVICE_PROVIDER.CONF 4 "Jun 18, 2004"
   7 .SH NAME
   8 service_provider.conf \- service provider configuration file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBservice_provider.conf\fR
  13 .fi
  14 
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBservice_provider.conf\fR contains information about the device type that the
  19 service provider supports. This information includes the pathname of the
  20 service provider library, the library version and other library characteristics
  21 that are required by the system administrative command, \fBdatadm\fR(1M).
  22 \fBdatadm\fR(1M) puts this information in the DAT static register file,
  23 \fBdat.conf\fR(4).
  24 .sp
  25 .LP
  26 The \fBdatadm\fR program enumerates each device entry into a list of interface
  27 adapters, that is, interfaces to external network that are available to uDAPL
  28 consumers. This new list of interface adapters is appended to other service
  29 providers' information in the DAT static registry, \fBdat.conf\fR. You can do
  30 this is you invoke the \fBdatadm\fR program with the \fB-a\fR option and the
  31 pathname of the \fBservice_provider.conf\fR file.
  32 .sp
  33 .LP
  34 Each entry in the service_provider.conf is a single line of 7 fields.
  35 .sp
  36 .LP
  37 The following shows the order of the fields in a \fBservice_provider.conf\fR
  38 entry:
  39 .sp
  40 .in +2
  41 .nf
  42 "\fIdriver_name\fR" "\fIAPI_version\fR" "\fIthreadsafe_library\fR | \e
  43       \fInonthreadsafe_librar\fRy"\e
  44 "\fIdefault_version\fR | \fInondefault_version\fR" \e
  45      "\fIservice_provider_library_pathname\fR"\e
  46 "\fIservice_provider_version\fR" "\fIservice_provider_instance_data\fR"\e
  47 .fi
  48 .in -2
  49 
  50 .sp
  51 .LP
  52 The fields are defined as follows:
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIdriver_name\fR\fR
  57 .ad
  58 .sp .6
  59 .RS 4n
  60 Specifies a driver name in the format of \fBdriver_name\fR=\fIvalue pair\fR,
  61 for example, \fBdriver_name=tavor\fR.
  62 .RE
  63 
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fIAPI_version\fR\fR
  68 .ad
  69 .sp .6
  70 .RS 4n
  71 Specifies the API version of the service provide library: For example,
  72 \fB"u"major.minor\fR is \fBu1.2\fR.
  73 .RE
  74 
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fIthreadsafe_library\fR | \fInonthreadsafe_librar\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 Specifies a threadsafe or non-threadsafe library.
  83 .RE
  84 
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fIdefault_version\fR | \fInondefault_version\fR\fR
  89 .ad
  90 .sp .6
  91 .RS 4n
  92 Specifies a default or non-default version of library. A service provider can
  93 offer several versions of the library. If so, one version is designated as
  94 \fBdefault\fR with the rest as \fBnondefault\fR.
  95 .RE
  96 
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fIservice_provider_library_pathname\fR\fR
 101 .ad
 102 .sp .6
 103 .RS 4n
 104 Specifies the pathname of the library image.
 105 .RE
 106 
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fIservice_provider_version\fR\fR
 111 .ad
 112 .sp .6
 113 .RS 4n
 114 Specifies the version of the service provider. By convention, specify the
 115 company stock symbol as the service provider, followed by major and minor
 116 version numbers, for example, \fBSUNW1.0\fR.
 117 .RE
 118 
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fIservice_provider_instance_data\fR\fR
 123 .ad
 124 .sp .6
 125 .RS 4n
 126 Specifies the service provider instance data.
 127 .RE
 128 
 129 .SH EXAMPLES
 130 .LP
 131 \fBExample 1 \fRUsing a Logical Device Name
 132 .sp
 133 .LP
 134 The following example \fBservice_provider.conf\fR entry uses a logical device
 135 name:
 136 
 137 .sp
 138 .in +2
 139 .nf
 140 #
 141 # Sample service_provider.conf entry showing an uDAPL 1.2 service
 142 # provider, udapl_tavor.so.1 supporting a device with a driver named
 143 # tavor
 144 driver_name=tavor u1.2 nonthreadsafe default udapl_tavor.so.1 \e
 145     SUNW.1.0 ""
 146 .fi
 147 .in -2
 148 
 149 .LP
 150 \fBExample 2 \fRUsing a Physical Device Name
 151 .sp
 152 .LP
 153 The following example \fBservice_provider.conf\fR uses a physical device name:
 154 
 155 .sp
 156 .in +2
 157 .nf
 158 #
 159 # Sample service_provider.conf entry showing an uDAPL 1.2
 160 # service provider, udapl_tavor.so.1 supporting a device named
 161 # pci15b3,5a44 that can be located under /devices
 162 #
 163 pci15b3,5a44 u1.2 nonthreadsafe default \e
 164     /usr/lib/tavor/udapl_tavor.so.1 SUNWudaplt1.0 ""
 165 .fi
 166 .in -2
 167 
 168 .SH ATTRIBUTES
 169 .sp
 170 .LP
 171 See \fBattributes\fR(5) for descriptions of the following attributes:
 172 .sp
 173 
 174 .sp
 175 .TS
 176 box;
 177 c | c
 178 l | l .
 179 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 180 Stability       Evolving
 181 .TE
 182 
 183 .SH SEE ALSO
 184 .sp
 185 .LP
 186 \fBdatadm\fR(1M), \fBdat.conf\fR(4), \fBattributes\fR(5)
--- EOF ---