Print this page
4770 soconfig(1M) needs an option to print the in-kernel socket configuration table
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1m/soconfig.1m
+++ new/usr/src/man/man1m/soconfig.1m
1 1 '\" te
2 2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
3 +.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
3 4 .\" 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 5 .\" 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 6 .\" 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 SOCONFIG 1M "Apr 12, 2014"
7 +.TH SOCONFIG 1M "May 21, 2015"
7 8 .SH NAME
8 9 soconfig \- configure transport providers for use by sockets
9 10 .SH SYNOPSIS
10 11 .LP
11 12 .nf
12 13 \fB/sbin/soconfig\fR \fB-d\fR \fIdir\fR
13 14 .fi
14 15
15 16 .LP
16 17 .nf
17 18 \fB/sbin/soconfig\fR \fB-f\fR \fIfile\fR
18 19 .fi
19 20
20 21 .LP
21 22 .nf
22 23 \fB/sbin/soconfig\fR \fIfamily\fR \fItype\fR \fIprotocol\fR [\fImodule\fR | \fIpath\fR]
23 24 .fi
24 25
26 +.LP
27 +.nf
28 +\fB/sbin/soconfig\fR \fB-l\fR
29 +.fi
30 +
25 31 .SH DESCRIPTION
26 32 .sp
27 33 .LP
28 34 The \fBsoconfig\fR utility configures the transport provider driver for use
29 35 with sockets. It specifies how the family, type, and protocol parameters in the
30 36 \fBsocket\fR(3SOCKET) call are mapped to the name of a transport provider such
31 37 as \fB/dev/tcp\fR. This utility can be used to add an additional mapping or
32 38 remove a previous mapping.
33 39 .sp
34 40 .LP
35 41 The \fBinit\fR(1M) utility uses \fBsoconfig\fR with the \fBsock2path.d\fR(4)
36 42 directory during the booting sequence.
37 43 .SH OPTIONS
38 44 .sp
39 45 .LP
40 46 The following options are supported:
41 47 .sp
42 48 .ne 2
43 49 .na
44 50 \fB\fB-d\fR \fIdir\fR\fR
45 51 .ad
46 52 .RS 11n
47 53 Set up the \fBsoconfig\fR configuration for each driver
48 54 according to the information stored in the
49 55 files in \fIdir\fR.
50 56 .RE
51 57
52 58 .sp
53 59 .ne 2
54 60 .na
55 61 \fB\fB-f\fR \fIfile\fR\fR
56 62 .ad
57 63 .RS 11n
58 64 Set up the \fBsoconfig\fR configuration for each driver according to the
↓ open down ↓ |
24 lines elided |
↑ open up ↑ |
59 65 information stored in \fIfile\fR. A \fBsoconfig\fR file consists of lines of at
60 66 least the first three fields listed below, separated by spaces:
61 67 .sp
62 68 \fIfamily type protocol [module | path]\fR
63 69 .sp
64 70 These fields are described in the \fBOPERANDS\fR section below.
65 71 .sp
66 72 An example of \fIfile\fR can be found in the \fBEXAMPLES\fR section below.
67 73 .RE
68 74
75 +.sp
76 +.ne 2
77 +.na
78 +\fB\fB-l\fR
79 +.ad
80 +.RS 11n
81 +Print the in-kernel socket configuration table.
82 +.RE
83 +
69 84 .SH OPERANDS
70 85 .sp
71 86 .LP
72 87 The following operands are supported:
73 88 .sp
74 89 .ne 2
75 90 .na
76 91 \fB\fIfamily\fR\fR
77 92 .ad
78 93 .RS 17n
79 94 The protocol family as listed in the \fB/usr/include/sys/socket.h\fR file,
80 95 expressed as an integer.
81 96 .RE
82 97
83 98 .sp
84 99 .ne 2
85 100 .na
86 101 \fB\fItype\fR\fR
87 102 .ad
88 103 .RS 17n
89 104 The socket type as listed in the \fB/usr/include/sys/socket.h\fR file,
90 105 expressed as an integer.
91 106 .RE
92 107
93 108 .sp
94 109 .ne 2
95 110 .na
96 111 \fB\fIprotocol\fR\fR
97 112 .ad
98 113 .RS 17n
99 114 The protocol number as specified in the family-specific \fBinclude\fR file,
100 115 expressed as an integer. For example, for \fBAF_INET\fR this number is
101 116 specified in \fB/usr/include/netinet/in.h\fR. An unspecified protocol number is
102 117 denoted with the value zero.
103 118 .RE
104 119
105 120 .sp
106 121 .ne 2
107 122 .na
108 123 \fB\fImodule\fR | \fIpath\fR\fR
109 124 .ad
110 125 .RS 17n
111 126 The module name or path name of a device that corresponds to the transport
112 127 provider, such as \fBtcp\fR or \fB/dev/tcp\fR. Modules must reside in
113 128 \fBkernel/socketmod\fR. A device name must begin with \fB/dev\fR. If this
114 129 parameter is specified, the configuration will be added for the specified
115 130 family, type, and protocol. If this parameter is not specified, the
116 131 configuration will be removed.
117 132 .RE
118 133
119 134 .SH EXAMPLES
120 135 .LP
121 136 \fBExample 1 \fRUsing \fBsoconfig\fR
122 137 .sp
123 138 .LP
124 139 The following example sets up a module for family \fBAF_INET\fR and type
125 140 \fBSOCK_STREAM\fR:
126 141
127 142 .sp
128 143 .in +2
129 144 .nf
130 145 example# \fBsoconfig 2 2 0 tcp\fR
131 146 .fi
132 147 .in -2
133 148 .sp
134 149
135 150 .sp
136 151 .LP
137 152 The following example sets up \fB/dev/tcp\fR for family \fBAF_INET\fR and type
138 153 \fBSOCK_STREAM\fR:
139 154
140 155 .sp
141 156 .in +2
142 157 .nf
143 158 example# \fBsoconfig 2 2 0 /dev/tcp\fR
144 159 .fi
145 160 .in -2
146 161 .sp
147 162
148 163 .sp
149 164 .LP
150 165 The following is a sample file used with the \fB-f\fR option. Comment lines
151 166 begin with a hash mark (\fB#\fR):
152 167
153 168 .sp
154 169 .in +2
155 170 .nf
156 171 # Family Type Protocol Module | Path
157 172 2 2 0 tcp
158 173 2 2 6 tcp
159 174
160 175 2 1 0 udp
161 176 2 1 17 udp
162 177
163 178 1 2 0 /dev/ticotsord
164 179 1 1 0 /dev/ticlts
165 180
166 181 2 4 0 icmp
167 182 .fi
168 183 .in -2
169 184 .sp
170 185
171 186 .SH FILES
172 187 .sp
173 188 .ne 2
174 189 .na
175 190 \fB\fB/etc/sock2path.d\fR\fR
176 191 .ad
177 192 .RS 18n
178 193 Directory containing files with mappings from
179 194 sockets to transport providers.
180 195 .RE
181 196
182 197 .SH SEE ALSO
183 198 .sp
184 199 .LP
185 200 \fBinit\fR(1M), \fBsock2path.d\fR(4), \fBattributes\fR(5)
186 201 .sp
187 202 .LP
188 203 \fINetwork Interface Guide\fR
↓ open down ↓ |
110 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX