share/man/man8/modunload.8

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc.
   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 MODUNLOAD 8 "Nov 19, 2001"
   7 .SH NAME
   8 modunload \- unload a module
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBmodunload\fR \fB-i\fR \fImodule_id\fR [\fB-e\fR \fIexec_file\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBmodunload\fR unloads a loadable module from the running system. The
  19 \fImodule_id\fR is the \fBID\fR of the module as shown by \fBmodinfo\fR(8). If
  20 \fBID\fR is \fB0\fR, all modules that were autoloaded which are unloadable, are
  21 unloaded. Modules loaded by \fBmodload\fR(8) are not affected.
  22 .SH OPTIONS
  23 .sp
  24 .LP
  25 The following options are supported:
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fB-e\fR \fIexec_file\fR\fR
  30 .ad
  31 .RS 16n
  32 Specify the name of a shell script or executable image file to be executed
  33 before the module is unloaded. The first argument passed is the module id (in
  34 decimal). There are two additional arguments that are module specific. For
  35 loadable drivers, the second argument is the driver major number. For loadable
  36 system calls, the second argument is the system call number. For loadable exec
  37 classes, the second argument is the index into the \fBexecsw\fR table. For
  38 loadable filesystems, the second argument is the index into the \fBvfssw\fR
  39 table. For loadable streams modules, the second argument is the index into the
  40 \fBfmodsw\fR table. For loadable scheduling classes, the second argument is the
  41 index into the class array. Minus one is passed for an argument that does not
  42 apply.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB-i\fR \fImodule_id\fR\fR
  49 .ad
  50 .RS 16n
  51 Specify the module to be unloaded.
  52 .RE
  53
  54 .SH SEE ALSO
  55 .sp
  56 .LP
  57 \fBmodinfo\fR(8), \fBmodload\fR(8), \fBupdate_drv\fR(8), \fBattributes\fR(5)
  58 .SH NOTES
  59 .sp
  60 .LP
  61 The \fBmodunload\fR command is often used on driver modules to force the system
  62 to reread the associated driver configuration file. While this works in the
  63 current Solaris release, it is not the supported way to reread the
  64 configuration file and is not guaranteed to work in future releases. The
  65 supported way for rereading driver configuration file is through the
  66 \fBupdate_drv\fR(8) command.