1.\" $NetBSD: modload.8,v 1.47 2017/07/18 19:50:54 wiz 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 July 18, 2017 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 60parameter into the running system. 61.Pp 62Modules are loaded from the default system module areas unless the 63.Ar module 64parameter contains a path separator character 65.Pq Sq / . 66.Pp 67The options to 68.Nm 69are as follows: 70.Bl -tag -width xbxvarxbooleanx 71.It Fl b Ar var=boolean 72Pass the module a boolean property with the name 73.Ar var . 74.Ar boolean 75may be either 76.Dv true 77or 78.Dv false . 79.It Fl d Ar var 80When used in conjunction with 81.Fl m , 82delete 83.Ar var 84from the 85.Ar plist 86specified. 87.It Fl f 88When a module is loaded, the kernel checks if the module is compatible 89with the running kernel and will refuse to load modules that are 90potentially incompatible. 91This option disables compatibility checks. 92.Em Note : 93an incompatible module can cause system instability, including data 94loss or corruption. 95.Pp 96This option is also required for re-enabling a builtin module that 97was disabled using 98.Xr modunload 8 . 99.It Fl i Ar var=integer 100Pass the module an integer property with the name 101.Ar var 102and integral value 103.Ar integer . 104.It Fl m Ar plist 105When used in conjunction with 106.Fl p , 107merge new options with an existing property list contained in 108.Ar plist . 109.It Fl P 110This option tells the kernel not to load an associated property list. 111.It Fl p 112Output a property list suitable for loading along with a module. 113When using this option, you do not need to specify a module. 114Use 115.Fl m 116and 117.Fl d 118to read and modify an existing property list. 119.It Fl s Ar var=string 120Pass the module a string property with the name 121.Ar var 122and string value 123.Ar string . 124.El 125.Sh DIAGNOSTICS 126The 127.Nm 128utility exits with a status of 0 on success 129and with a nonzero status if an error occurs. 130.Sh SEE ALSO 131.Xr modctl 2 , 132.Xr modules.conf 5 , 133.Xr module 7 , 134.Xr modstat 8 , 135.Xr modunload 8 136.Sh HISTORY 137A 138.Nm 139utility appeared in 140.Nx 0.9 . 141The 142.Nm 143command was designed to be similar in functionality 144to the corresponding command in 145.Tn "SunOS 4.1.3" . 146.Nm 147was switched to the module framework for 148.Nx 5.0 . 149.Sh AUTHORS 150.An -nosplit 151The original 152.Nx 153implementation was written by 154.An Terrence R. Lambert Aq Mt terry@cs.weber.edu . 155The switch to the module framework was by 156.An Andrew Doran Aq Mt ad@NetBSD.org . 157