xref: /netbsd-src/sbin/modload/modload.8 (revision c2f76ff004a2cb67efe5b12d97bd3ef7fe89e18d)
1.\" $NetBSD: modload.8,v 1.40 2010/12/14 16:23:59 jruoho Exp $
2.\"
3.\" Copyright (c) 1993 Christopher G. Demetriou
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"          This product includes software developed for the
17.\"          NetBSD Project.  See http://www.NetBSD.org/ for
18.\"          information about NetBSD.
19.\" 4. The name of the author may not be used to endorse or promote products
20.\"    derived from this software without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
34.\"
35.Dd December 14, 2010
36.Dt MODLOAD 8
37.Os
38.Sh NAME
39.Nm modload
40.Nd load a kernel module
41.Sh SYNOPSIS
42.Nm
43.Op Fl fP
44.Op Fl b Ar var=boolean
45.Op Fl i Ar var=integer
46.Op Fl s Ar var=string
47.Ar module
48.Nm
49.Fl p
50.Op Fl b Ar var=boolean
51.Op Fl d Ar var
52.Op Fl i Ar var=integer
53.Op Fl m Ar plist
54.Op Fl s Ar var=string
55.Sh DESCRIPTION
56The
57.Nm
58utility loads a kernel module specified by the
59.Ar module
60paramamter into the running system.
61.Pp
62The current working directory is first searched for the module object file.
63If not found there, the default system module areas are searched.
64.Pp
65The options to
66.Nm
67are as follows:
68.Bl -tag -width xbxvarxbooleanx
69.It Fl b Ar var=boolean
70Pass the module a boolean property with the name
71.Ar var .
72.Ar boolean
73may be either
74.Dv true
75or
76.Dv false .
77.It Fl d Ar var
78When used in conjuction with
79.Fl m ,
80delete
81.Ar var
82from the
83.Ar plist
84specified.
85.It Fl f
86When a module is loaded, the kernel checks if the module is compatible
87with the running kernel and will refuse to load modules that are
88potentially incompatible.
89This option disables compatibility checks.
90.Em Note :
91an incompatible module can cause system instability, including data
92loss or corruption.
93.Pp
94This option is also required for re-enabling a builtin module that
95was disabled using
96.Xr modunload 8 .
97.It Fl i Ar var=integer
98Pass the module an integer property with the name
99.Ar var
100and integral value
101.Ar integer .
102.It Fl m Ar plist
103When used in conjuction with
104.Fl p ,
105merge new options with an existing property list contained in
106.Ar plist .
107.It Fl P
108This option tells the kernel not to load an associated property list.
109.It Fl p
110Output a property list suitable for loading along with a module.
111When using this option, you do not need to specify a module.
112Use
113.Fl m
114and
115.Fl d
116to read and modify an existing property list.
117.It Fl s Ar var=string
118Pass the module a string property with the name
119.Ar var
120and string value
121.Ar string .
122.El
123.Sh DIAGNOSTICS
124The
125.Nm
126utility exits with a status of 0 on success
127and with a nonzero status if an error occurs.
128.Sh SEE ALSO
129.Xr module 7 ,
130.Xr modstat 8 ,
131.Xr modunload 8
132.Sh HISTORY
133The
134.Nm
135command was designed to be similar in functionality
136to the corresponding command in
137.Tn "SunOS 4.1.3" .
138