4544 sock2path(4) man page needs to be updated for configuration fragments
Reviewed by: Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
Reviewed by: Marcel Telka <marcel@telka.sk>

          --- 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    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    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    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 SOCONFIG 1M "Oct 29, 2008"
        6 +.TH SOCONFIG 1M "Apr 12, 2014"
   7    7  .SH NAME
   8    8  soconfig \- configure transport providers for use by sockets
   9    9  .SH SYNOPSIS
  10   10  .LP
  11   11  .nf
       12 +\fB/sbin/soconfig\fR \fB-d\fR \fIdir\fR
       13 +.fi
       14 +
       15 +.LP
       16 +.nf
  12   17  \fB/sbin/soconfig\fR \fB-f\fR \fIfile\fR
  13   18  .fi
  14   19  
  15   20  .LP
  16   21  .nf
  17      -\fB/sbin/soconfig\fR \fIfamily\fR \fItype\fR \fIprotocol\fR [\fIpath\fR]
       22 +\fB/sbin/soconfig\fR \fIfamily\fR \fItype\fR \fIprotocol\fR [\fImodule\fR | \fIpath\fR]
  18   23  .fi
  19   24  
  20   25  .SH DESCRIPTION
  21   26  .sp
  22   27  .LP
  23   28  The \fBsoconfig\fR utility configures the transport provider driver for use
  24   29  with sockets. It specifies how the family, type, and protocol parameters in the
  25   30  \fBsocket\fR(3SOCKET) call are mapped to the name of a transport provider such
  26   31  as \fB/dev/tcp\fR. This utility can be used to add an additional mapping or
  27   32  remove a previous mapping.
  28   33  .sp
  29   34  .LP
  30      -The \fBinit\fR(1M) utility uses \fBsoconfig\fR with the \fBsock2path\fR(4) file
  31      -during the booting sequence.
       35 +The \fBinit\fR(1M) utility uses \fBsoconfig\fR with the \fBsock2path.d\fR(4)
       36 +directory during the booting sequence.
  32   37  .SH OPTIONS
  33   38  .sp
  34   39  .LP
  35   40  The following options are supported:
  36   41  .sp
  37   42  .ne 2
  38   43  .na
       44 +\fB\fB-d\fR \fIdir\fR\fR
       45 +.ad
       46 +.RS 11n
       47 +Set up the \fBsoconfig\fR configuration for each driver
       48 +according  to  the  information stored in the
       49 +files in \fIdir\fR.
       50 +.RE
       51 +
       52 +.sp
       53 +.ne 2
       54 +.na
  39   55  \fB\fB-f\fR \fIfile\fR\fR
  40   56  .ad
  41   57  .RS 11n
  42   58  Set up the \fBsoconfig\fR configuration for each driver according to the
  43      -information stored in \fBfile\fR. A \fBsoconfig\fR file consists of lines of at
       59 +information stored in \fIfile\fR. A \fBsoconfig\fR file consists of lines of at
  44   60  least the first three fields listed below, separated by spaces:
  45   61  .sp
  46      -\fIfamily  type  protocol  path\fR
       62 +\fIfamily  type  protocol  [module | path]\fR
  47   63  .sp
  48   64  These fields are described in the \fBOPERANDS\fR section below.
  49   65  .sp
  50      -An example of \fBfile\fR can be found in the \fBEXAMPLES\fR section below.
       66 +An example of \fIfile\fR can be found in the \fBEXAMPLES\fR section below.
  51   67  .RE
  52   68  
  53   69  .SH OPERANDS
  54   70  .sp
  55   71  .LP
  56   72  The following operands are supported:
  57   73  .sp
  58   74  .ne 2
  59   75  .na
  60   76  \fB\fIfamily\fR\fR

  61   77  .ad
  62   78  .RS 17n
  63   79  The protocol family as listed in the \fB/usr/include/sys/socket.h\fR file,
  64   80  expressed as an integer.
  65   81  .RE
  66   82  
  67   83  .sp
  68   84  .ne 2
  69   85  .na
  70   86  \fB\fItype\fR\fR
  71   87  .ad
  72   88  .RS 17n
  73   89  The socket type as listed in the \fB/usr/include/sys/socket.h\fR file,
  74   90  expressed as an integer.
  75   91  .RE
  76   92  
  77   93  .sp
  78   94  .ne 2
  79   95  .na
  80   96  \fB\fIprotocol\fR\fR
  81   97  .ad
  82   98  .RS 17n
  83   99  The protocol number as specified in the family-specific \fBinclude\fR file,
  84  100  expressed as an integer. For example, for \fBAF_INET\fR this number is
  85  101  specified in \fB/usr/include/netinet/in.h\fR. An unspecified protocol number is
  86  102  denoted with the value zero.
  87  103  .RE
  88  104  
  89  105  .sp
  90  106  .ne 2
  91  107  .na
  92  108  \fB\fImodule\fR | \fIpath\fR\fR
  93  109  .ad
  94  110  .RS 17n
  95  111  The module name or path name of a device that corresponds to the transport
  96  112  provider, such as \fBtcp\fR or \fB/dev/tcp\fR. Modules must reside in
  97  113  \fBkernel/socketmod\fR. A device name must begin with \fB/dev\fR. If this
  98  114  parameter is specified, the configuration will be added for the specified
  99  115  family, type, and protocol. If this parameter is not specified, the
 100  116  configuration will be removed.
 101  117  .RE
 102  118  
 103  119  .SH EXAMPLES
 104  120  .LP
 105  121  \fBExample 1 \fRUsing \fBsoconfig\fR
 106  122  .sp
 107  123  .LP
 108  124  The following example sets up a module for family \fBAF_INET\fR and type
 109  125  \fBSOCK_STREAM\fR:
 110  126  
 111  127  .sp
 112  128  .in +2
 113  129  .nf
 114  130  example# \fBsoconfig 2 2 0 tcp\fR
 115  131  .fi
 116  132  .in -2
 117  133  .sp
 118  134  
 119  135  .sp
 120  136  .LP
 121  137  The following example sets up \fB/dev/tcp\fR for family \fBAF_INET\fR and type
 122  138  \fBSOCK_STREAM\fR:
 123  139  
 124  140  .sp
 125  141  .in +2
 126  142  .nf
 127  143  example# \fBsoconfig 2 2 0 /dev/tcp\fR
 128  144  .fi
 129  145  .in -2
 130  146  .sp
 131  147  
 132  148  .sp
 133  149  .LP
 134  150  The following is a sample file used with the \fB-f\fR option. Comment lines
 135  151  begin with a hash mark (\fB#\fR):
 136  152  
 137  153  .sp
 138  154  .in +2
 139  155  .nf
 140  156  #   Family  Type  Protocol   Module | Path
 141  157        2       2       0          tcp
 142  158        2       2       6          tcp
 143  159  
 144  160        2       1       0          udp
 145  161        2       1       17         udp
 146  162  
 147  163        1       2       0          /dev/ticotsord
 148  164        1       1       0          /dev/ticlts

 149  165  
 150  166        2       4       0          icmp
 151  167  .fi
 152  168  .in -2
 153  169  .sp
 154  170  
 155  171  .SH FILES
 156  172  .sp
 157  173  .ne 2
 158  174  .na
 159      -\fB\fB/etc/sock2path\fR\fR
      175 +\fB\fB/etc/sock2path.d\fR\fR
 160  176  .ad
 161  177  .RS 18n
 162      -File containing mappings from sockets to transport providers.
      178 +Directory containing files with mappings from
      179 +sockets  to transport providers.
 163  180  .RE
 164  181  
 165  182  .SH SEE ALSO
 166  183  .sp
 167  184  .LP
 168      -\fBinit\fR(1M), \fBsock2path\fR(4), \fBattributes\fR(5)
      185 +\fBinit\fR(1M), \fBsock2path.d\fR(4), \fBattributes\fR(5)
 169  186  .sp
 170  187  .LP
 171  188  \fINetwork Interface Guide\fR
    

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX