usr/src/man/man1m/modload.1m

   1 '\" te
   2 .\" Copyright (c) 1993, 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 MODLOAD 1M "Dec 1, 1993"
   7 .SH NAME
   8 modload \- load a kernel module
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBmodload\fR [\fB-p\fR] [\fB-e\fR \fIexec_file\fR] \fIfilename\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBmodload\fR command loads the loadable module  \fIfilename\fR into the
  19 running system.
  20 .sp
  21 .LP
  22 \fIfilename\fR is an object file produced by \fBld \fR\fB-r\fR. If
  23 \fIfilename\fR is an absolute pathname then the file specified by that absolute
  24 path is loaded. If  \fIfilename\fR does not begin with a slash (\fB/\fR), then
  25 the path to load  \fIfilename\fR is relative to the current directory unless
  26 the  \fB-p\fR option is specified.
  27 .sp
  28 .LP
  29 The kernel's \fBmodpath\fR variable can be set using the \fB/etc/system\fR
  30 file. The default value of the kernel's \fBmodpath\fR variable is set to the
  31 path where the operating system was loaded.  Typically this is \fB/kernel
  32 /usr/kernel\fR.
  33 .sp
  34 .LP
  35 For example, the following command looks for \fB\&./drv/foo\fR:
  36 .sp
  37 .in +2
  38 .nf
  39 example# \fBmodload drv/foo\fR
  40 .fi
  41 .in -2
  42 .sp
  43
  44 .sp
  45 .LP
  46 The following command looks for \fB/kernel/drv/foo\fR and then
  47 \fB/usr/kernel/drv/foo\fR:
  48 .sp
  49 .in +2
  50 .nf
  51 example# \fBmodload -p drv/foo\fR
  52 .fi
  53 .in -2
  54 .sp
  55
  56 .SH OPTIONS
  57 .sp
  58 .LP
  59 The following options are supported:
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fB-e\fR\fI exec_file\fR\fR
  64 .ad
  65 .RS 16n
  66 Specify the name of a shell script or  executable image file that is executed
  67 after the module is successfully loaded.  The first argument passed is the
  68 module ID (in decimal). The other argument is module specific. The module
  69 specific information is: the block and character major numbers for drivers, the
  70 system call number for system calls, or, for  other module types, the index
  71 into the appropriate kernel table. See  \fBmodinfo\fR(1M)
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-p\fR\fR
  78 .ad
  79 .RS 16n
  80 Use the kernel's internal modpath variable as the search path for the module.
  81 .RE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBld\fR(1), \fBadd_drv\fR(1M), \fBkernel\fR(1M), \fBmodinfo\fR(1M),
  87 \fBmodunload\fR(1M), \fBsystem\fR(4), \fBattributes\fR(5), \fBmodldrv\fR(9S),
  88 \fBmodlinkage\fR(9S), \fBmodlstrmod\fR(9S), \fBmodule_info\fR(9S)
  89 .sp
  90 .LP
  91 \fI\fR
  92 .SH NOTES
  93 .sp
  94 .LP
  95 Use \fBadd_drv\fR(1M) to add device drivers, not \fBmodload\fR. See \fI\fR for
  96 procedures on adding device drivers.