share/man/man8/autopush.8

   1 '\" te
   2 .\"  Copyright 1989 AT&T Copyright (c) 2008 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 AUTOPUSH 8 "Feb 15, 2008"
   7 .SH NAME
   8 autopush \- configures lists of automatically pushed STREAMS modules
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBautopush\fR \fB-f\fR \fIfilename\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBautopush\fR \fB-g\fR \fB-M\fR \fImajor\fR \fB-m\fR \fIminor\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBautopush\fR \fB-r\fR \fB-M\fR \fImajor\fR \fB-m\fR \fIminor\fR
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBautopush\fR command configures the list of modules to be automatically
  29 pushed onto the stream when a device is opened. It can also be used to remove a
  30 previous setting or get information on a setting.
  31 .SH OPTIONS
  32 .sp
  33 .LP
  34 The following options are supported:
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB-f\fR \fIfilename\fR\fR
  39 .ad
  40 .sp .6
  41 .RS 4n
  42 Sets up the \fBautopush\fR configuration for each driver according to the
  43 information stored in \fIfilename\fR. An \fBautopush\fR file consists of lines
  44 of four or more fields, separated by spaces as shown below:
  45 .sp
  46 .in +2
  47 .nf
  48 \fImajor minor last-minor module1 module2 \|.\|.\|. module8\fR
  49 .fi
  50 .in -2
  51 .sp
  52
  53 The first field is a string that specifies the \fImajor\fR device name, as
  54 listed in the \fB/kernel/drv\fR directory. The next two fields are integers
  55 that specify the \fIminor\fR device number and \fIlast-minor\fR device number.
  56 The fields following represent the names of modules. If \fIminor\fR is
  57 \fB\(mi1\fR, then all minor devices of a major driver specified by \fImajor\fR
  58 are configured, and the value for \fIlast-minor\fR is ignored. If
  59 \fIlast-minor\fR is \fB0\fR, then only a single minor device is configured. To
  60 configure a range of minor devices for a particular major, \fIminor\fR must be
  61 less than \fIlast-minor\fR.
  62 .sp
  63 The remaining fields list the names of modules to be automatically pushed onto
  64 the stream when opened, along with the position of an optional anchor. The
  65 maximum number of modules that can be pushed is eight. The modules are pushed
  66 in the order they are specified. The optional special character sequence
  67 \fB[anchor]\fR indicates that a STREAMS anchor should be placed on the stream
  68 at the module previously specified in the list; it is an error to specify more
  69 than one anchor or to have an anchor first in the list.
  70 .sp
  71 A nonzero exit status indicates that one or more of the lines in the specified
  72 file failed to complete successfully.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-g\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 Gets the current configuration setting of a particular \fImajor\fR and
  83 \fIminor\fR device number specified with the \fB-M\fR and \fB-m\fR options
  84 respectively and displays the autopush modules associated with it. It will also
  85 return the starting minor device number if the request corresponds to a setting
  86 of a range (as described with the \fB-f\fR option).
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-m\fR \fIminor\fR\fR
  93 .ad
  94 .sp .6
  95 .RS 4n
  96 Specifies the minor device number.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB-M\fR \fImajor\fR\fR
 103 .ad
 104 .sp .6
 105 .RS 4n
 106 Specifies the major device number.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fB-r\fR\fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 Removes the previous configuration setting of the particular \fImajor\fR and
 117 \fIminor\fR device number specified with the \fB-M\fR and \fB-m\fR options
 118 respectively. If the values of \fImajor\fR and \fIminor\fR correspond to a
 119 previously established setting of a range of minor devices, where \fIminor\fR
 120 matches the first minor device number in the range, the configuration would be
 121 removed for the entire range.
 122 .RE
 123
 124 .SH EXIT STATUS
 125 .sp
 126 .LP
 127 The following exit values are returned:
 128 .sp
 129 .ne 2
 130 .na
 131 \fB0\fR
 132 .ad
 133 .sp .6
 134 .RS 4n
 135 Successful completion.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fBnon-zero\fR
 142 .ad
 143 .sp .6
 144 .RS 4n
 145 An error occurred.
 146 .RE
 147
 148 .SH EXAMPLES
 149 .LP
 150 \fBExample 1 \fRUsing the \fBautopush\fR command.
 151 .sp
 152 .LP
 153 The following example gets the current configuration settings for the
 154 \fImajor\fR and \fIminor\fR device numbers as indicated and displays the
 155 \fBautopush\fR modules associated with them for the character-special device
 156 \fB/dev/term/a:\fR
 157
 158 .sp
 159 .in +2
 160 .nf
 161 example# autopush \fB-g\fR \fB-M\fR 29 \fB-m\fR 0
 162 Major     Minor     Lastminor     Modules
 163   29        0         1           ldterm  ttcompat
 164 .fi
 165 .in -2
 166 .sp
 167
 168 .SH FILES
 169 .sp
 170 .LP
 171 \fB/etc/iu.ap\fR
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBdladm\fR(8), \fBttymon\fR(8), \fBattributes\fR(5), \fBldterm\fR(7M),
 176 \fBsad\fR(7D), \fBstreamio\fR(7I), \fBttcompat\fR(7M)
 177 .sp
 178 .LP
 179 \fI\fR
 180 .SH NOTES
 181 .sp
 182 .LP
 183 The use of the \fBautopush\fR command is obsolete for networking data-links.
 184 The preferred method of configuring a list of automatically pushed STREAMS
 185 modules on a given networking data-link interface is the \fBdladm\fR(8)
 186 \fBautopush\fR link property.
 187 .sp
 188 .LP
 189 Because network devices are self-cloning, the \fBautopush\fR command is
 190 inadequate for networking devices. The granularity of the \fBautopush\fR
 191 command's configuration is driver-wide, and not per-interface as one might
 192 expect. Another reason not to use \fBautopush\fR is that administrators are
 193 more familiar with the names of their network interfaces than with device major
 194 and minor numbers. The \fBdladm\fR(8) command allows the configuration using
 195 data-link interface names.