freebsd-skq/sbin/kldload/kldload.8

.\"
.\" Copyright (c) 1997 Doug Rabson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd June 5, 2009
.Dt KLDLOAD 8
.Os
.Sh NAME
.Nm kldload
.Nd load a file into the kernel
.Sh SYNOPSIS
.Nm
.Op Fl qv
.Ar
.Sh DESCRIPTION
The
.Nm
utility loads
.Ar file Ns Pa .ko
into the kernel using the kernel linker.
Note that if multiple modules are specified then an attempt will
be made to load them all, even if some fail.
The
.Pa .ko
extension name is not mandatory when loading a given module
using
.Nm .
It does not hurt to specify it though.
.Pp
If a bare filename is requested it will only be loaded if it is found within
the module path as defined by the sysctl
.Va kern.module_path .
To load a module from the current directory it must be specified as a full or
relative path.
The
.Nm
utility will warn if a module is requested as a bare filename and is present
in the current directory.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl v
Be more verbose.
.It Fl q
Silence any extraneous warnings.
.El
.Sh NOTES
.Pp
The kernel security level settings may prevent a module from being
loaded or unloaded by giving
.Em "Operation not permitted" .
.Sh FILES
.Bl -tag -width /boot/kernel -compact
.It Pa /boot/kernel
directory containing loadable modules.
Modules must have an extension of
.Pa .ko .
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
To load by module name:
.Bd -literal -offset indent
\*[Gt] kldload foo
.Ed
.Pp
To load by file name within the module path:
.Bd -literal -offset indent
\*[Gt] kldload foo.ko
.Ed
.Pp
To load by relative path:
.Bd -literal -offset indent
\*[Gt] kldload ./foo.ko
.Ed
.Pp
To load by full path:
.Bd -literal -offset indent
\*[Gt] kldload /boot/kernel/foo.ko
.Ed
.Sh AUTOMATICALLY LOADING MODULES
Some modules (pf, ipfw, ipf, etc.) may be automatically loaded at boot
time when the corresponding
.Xr rc.conf 5
statement is used.
Modules may also be auto-loaded through their addition to
.Xr loader.conf 5 .
.Sh SEE ALSO
.Xr kldload 2 ,
.Xr loader.conf 5 ,
.Xr rc.conf 5 ,
.Xr security 7 ,
.Xr kldconfig 8 ,
.Xr kldstat 8 ,
.Xr kldunload 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 3.0 ,
replacing the
.Nm lkm
interface.
.Sh AUTHORS
.An Doug Rabson Aq dfr@FreeBSD.org
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.\"`
			`.\" Copyright (c) 1997 Doug Rabson`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.\"`
Bump document date. Pointed out by: trhodes 2009-06-05 03:06:24 +00:00			`.Dd June 5, 2009`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Dt KLDLOAD 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 11:04:34 +00:00			`.Os`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Sh NAME`
			`.Nm kldload`
			`.Nd load a file into the kernel`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
Make flags in usage() and SYNOPSYS more style(9)-ish. Suggested by: brian MFC after: 3 days 2010-08-30 07:29:27 +00:00			`.Op Fl qv`
Update documentation for kldload(8)'s ability to load multiple modules. Submitted by: Daniel O'Connor <doconnor@gsoft.com.au> 2002-10-09 06:46:54 +00:00			`.Ar`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Update documentation for kldload(8)'s ability to load multiple modules. Submitted by: Daniel O'Connor <doconnor@gsoft.com.au> 2002-10-09 06:46:54 +00:00			`utility loads`
			`.Ar file Ns Pa .ko`
Fill-in the manpages a little. 1998-11-12 11:10:26 +00:00			`into the kernel using the kernel linker.`
Update documentation for kldload(8)'s ability to load multiple modules. Submitted by: Daniel O'Connor <doconnor@gsoft.com.au> 2002-10-09 06:46:54 +00:00			`Note that if multiple modules are specified then an attempt will`
			`be made to load them all, even if some fail.`
Make it clear that the .ko extention of a module to be loaded is optional. PR: docs/85356 Submitted by: Julien Gabel <jpeg@thilelli.net> MFC after: 3 days 2005-08-27 22:25:51 +00:00			`The`
			`.Pa .ko`
			`extension name is not mandatory when loading a given module`
			`using`
			`.Nm .`
-mdoc sweep. 2005-11-18 10:36:29 +00:00			`It does not hurt to specify it though.`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Pp`
Perform some checking on the requested list of modules to warn people if they try to load modules by filename out of the current directory where the module in question may be further up the module path or not in the module path at all. Also add some text to the man page to help explain what's going on. Sponsored by: Redacted Consulting 2009-06-04 23:43:08 +00:00			`If a bare filename is requested it will only be loaded if it is found within`
			`the module path as defined by the sysctl`
			`.Va kern.module_path .`
			`To load a module from the current directory it must be specified as a full or`
			`relative path.`
			`The`
			`.Nm`
			`utility will warn if a module is requested as a bare filename and is present`
			`in the current directory.`
			`.Pp`
o Add -q flag to the synopsis. PR: docs/148535 Submitted by: Warren Block MFC after: 1 week 2010-07-13 04:11:25 +00:00			`The following options are available:`
Add -v in usage string. Add rcsid. 1998-01-05 07:07:44 +00:00			`.Bl -tag -width indent`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.It Fl v`
			`Be more verbose.`
Perform some checking on the requested list of modules to warn people if they try to load modules by filename out of the current directory where the module in question may be further up the module path or not in the module path at all. Also add some text to the man page to help explain what's going on. Sponsored by: Redacted Consulting 2009-06-04 23:43:08 +00:00			`.It Fl q`
			`Silence any extraneous warnings.`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.El`
Add a note about the implication of secure level setting against kldload, and cross reference security(7). 2009-06-23 23:56:56 +00:00			`.Sh NOTES`
			`.Pp`
			`The kernel security level settings may prevent a module from being`
			`loaded or unloaded by giving`
			`.Em "Operation not permitted" .`
Fill-in the manpages a little. 1998-11-12 11:10:26 +00:00			`.Sh FILES`
/modules -> /boot/kernel 2000-09-06 15:55:31 +00:00			`.Bl -tag -width /boot/kernel -compact`
			`.It Pa /boot/kernel`
mdoc(7) police: minor markup tweaks. 2001-07-10 09:37:53 +00:00			`directory containing loadable modules.`
			`Modules must have an extension of`
			`.Pa .ko .`
Prepare for mdoc(7)NG. 2000-12-18 15:16:24 +00:00			`.El`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: tidy up previous delta. 2002-01-09 15:22:30 +00:00			`.Ex -std`
Perform some checking on the requested list of modules to warn people if they try to load modules by filename out of the current directory where the module in question may be further up the module path or not in the module path at all. Also add some text to the man page to help explain what's going on. Sponsored by: Redacted Consulting 2009-06-04 23:43:08 +00:00			`.Sh EXAMPLES`
			`To load by module name:`
			`.Bd -literal -offset indent`
			`\*[Gt] kldload foo`
			`.Ed`
			`.Pp`
			`To load by file name within the module path:`
			`.Bd -literal -offset indent`
			`\*[Gt] kldload foo.ko`
			`.Ed`
			`.Pp`
			`To load by relative path:`
			`.Bd -literal -offset indent`
			`\*[Gt] kldload ./foo.ko`
			`.Ed`
			`.Pp`
			`To load by full path:`
			`.Bd -literal -offset indent`
			`\*[Gt] kldload /boot/kernel/foo.ko`
			`.Ed`
Add comments on where to look if you wish to auto-load modules at boot time. MFC after: 1 day 2001-12-16 05:14:17 +00:00			`.Sh AUTOMATICALLY LOADING MODULES`
Remove mention of "lomac" as it's been gone for a good while now (at least two years). 2006-10-13 23:59:59 +00:00			`Some modules (pf, ipfw, ipf, etc.) may be automatically loaded at boot`
Make it clear that the .ko extention of a module to be loaded is optional. PR: docs/85356 Submitted by: Julien Gabel <jpeg@thilelli.net> MFC after: 3 days 2005-08-27 22:25:51 +00:00			`time when the corresponding`
			`.Xr rc.conf 5`
			`statement is used.`
Add comments on where to look if you wish to auto-load modules at boot time. MFC after: 1 day 2001-12-16 05:14:17 +00:00			`Modules may also be auto-loaded through their addition to`
			`.Xr loader.conf 5 .`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Sh SEE ALSO`
Add cross-references to respective syscalls. 1999-09-03 16:40:24 +00:00			`.Xr kldload 2 ,`
Add comments on where to look if you wish to auto-load modules at boot time. MFC after: 1 day 2001-12-16 05:14:17 +00:00			`.Xr loader.conf 5 ,`
mdoc(7) police: tidy up previous delta. 2002-01-09 15:22:30 +00:00			`.Xr rc.conf 5 ,`
Add a note about the implication of secure level setting against kldload, and cross reference security(7). 2009-06-23 23:56:56 +00:00			`.Xr security 7 ,`
Add an xref to kldconfig(8). 2003-03-03 22:48:06 +00:00			`.Xr kldconfig 8 ,`
mdoc(7) police: tidy up previous delta. 2002-01-09 15:22:30 +00:00			`.Xr kldstat 8 ,`
			`.Xr kldunload 8`
a few code style changes: o start function names in column 1 o sort order of flags in getopt and switch o don't try to reference progname o unspam some changes introduced by a 2.2.1-R build box instead of a -current build box doc changes: o document when these commands first appeared o put email address in angle brakets o minor mdoc clean up 1997-10-21 09:59:26 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
The .Nm utility 2002-07-06 19:34:18 +00:00			`utility first appeared in`
Fill-in the manpages a little. 1998-11-12 11:10:26 +00:00			`.Fx 3.0 ,`
			`replacing the`
Mark up lkm with .Nm, since lkm is name of an api. Submitted by: ru 2007-02-13 17:06:15 +00:00			`.Nm lkm`
Fill-in the manpages a little. 1998-11-12 11:10:26 +00:00			`interface.`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-19 07:46:04 +00:00			`.Sh AUTHORS`
			`.An Doug Rabson Aq dfr@FreeBSD.org`