freebsd-nq/sbin/kldunload/kldunload.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 February 27, 2006
.Dt KLDUNLOAD 8
.Os
.Sh NAME
.Nm kldunload
.Nd unload a file from the kernel
.Sh SYNOPSIS
.Nm
.Op Fl fv
.Fl i Ar id ...
.Nm
.Op Fl fv
.Op Fl n
.Ar name ...
.Sh DESCRIPTION
The
.Nm
utility unloads a file which was previously loaded with
.Xr kldload 8 .
.Pp
The following options are available:
.Bl -tag -width ".Fl n Ar name"
.It Fl f
Force the unload.
This ignores error returns to
.Dv MOD_QUIESCE
from the module and implies
that the module should be unloaded even if it is currently in use.
The users are left to cope as best they can.
.It Fl v
Be more verbose.
.It Fl i Ar id
Unload the file with this ID.
.It Fl n Ar name
Unload the file with this name.
.It Ar name
Unload the file with this name.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr kldunload 2 ,
.Xr kldload 8 ,
.Xr kldstat 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 a date in .Dd field. Last change brought some new functionality. Spotted by: brueffer Approved by: cognet (mentor) MFC after: 1 week 2006-02-27 22:48:58 +00:00			`.Dd February 27, 2006`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Dt KLDUNLOAD 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 kldunload`
			`.Nd unload a file from the kernel`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
Scheduled mdoc(7) sweep. 2005-01-10 16:17:34 +00:00			`.Op Fl fv`
Extend kldunload(8) functionality and fix minor problems: o multiple modules can be unloaded at once (specified either by id or be module name) o exit with EX_USAGE after usage() is called. o remove unused variables, since we keep command line flags as bitmask, in 'opt'. o 'kldload -n ...' does nothing. Add comment to this options. Additionally: o Update manual page to conform new functionality. o Increace WARNS to 6. Because we can. Approved by: cognet (mentor) MFC after: 1 week 2006-02-27 22:20:57 +00:00			`.Fl i Ar id ...`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
Scheduled mdoc(7) sweep. 2005-01-10 16:17:34 +00:00			`.Op Fl fv`
Show that the -n option is optional Suggested by: Bruce Evans <bde@zeta.org.au> Reviewed by: dfr 1999-09-06 08:30:25 +00:00			`.Op Fl n`
Extend kldunload(8) functionality and fix minor problems: o multiple modules can be unloaded at once (specified either by id or be module name) o exit with EX_USAGE after usage() is called. o remove unused variables, since we keep command line flags as bitmask, in 'opt'. o 'kldload -n ...' does nothing. Add comment to this options. Additionally: o Update manual page to conform new functionality. o Increace WARNS to 6. Because we can. Approved by: cognet (mentor) MFC after: 1 week 2006-02-27 22:20:57 +00:00			`.Ar name ...`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`utility unloads a file which was previously loaded with`
			`.Xr kldload 8 .`
			`.Pp`
Sync. usage string and synopsis. Add rcsid. 1998-01-05 07:10:42 +00:00			`The following options are available:`
Scheduled mdoc(7) sweep. 2005-01-10 16:17:34 +00:00			`.Bl -tag -width ".Fl n Ar name"`
Give kldunload a -f(orce) argument. Add a MOD_QUIESCE event for modules. This should return error (EBUSY) of the module is in use. MOD_UNLOAD should now only fail if it is impossible (as opposed to inconvenient) to unload the module. Valid reasons are memory references into the module which cannot be tracked down and eliminated. When kldunloading, we abandon if MOD_UNLOAD fails, and if -force is not given, MOD_QUIESCE failing will also prevent the unload. For backwards compatibility, we treat EOPNOTSUPP from MOD_QUIESCE as success. Document that modules should return EOPNOTSUPP for unknown events. 2004-07-13 19:36:59 +00:00			`.It Fl f`
			`Force the unload.`
- Correctly spell MOD_QUIESCE - use .Dv for it MFC after: 3 days 2005-02-09 22:06:16 +00:00			`This ignores error returns to`
			`.Dv MOD_QUIESCE`
			`from the module and implies`
Give kldunload a -f(orce) argument. Add a MOD_QUIESCE event for modules. This should return error (EBUSY) of the module is in use. MOD_UNLOAD should now only fail if it is impossible (as opposed to inconvenient) to unload the module. Valid reasons are memory references into the module which cannot be tracked down and eliminated. When kldunloading, we abandon if MOD_UNLOAD fails, and if -force is not given, MOD_QUIESCE failing will also prevent the unload. For backwards compatibility, we treat EOPNOTSUPP from MOD_QUIESCE as success. Document that modules should return EOPNOTSUPP for unknown events. 2004-07-13 19:36:59 +00:00			`that the module should be unloaded even if it is currently in use.`
			`The users are left to cope as best they can.`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.It Fl v`
			`Be more verbose.`
			`.It Fl i Ar id`
			`Unload the file with this ID.`
			`.It Fl n Ar name`
			`Unload the file with this name.`
Show that the -n option is optional Suggested by: Bruce Evans <bde@zeta.org.au> Reviewed by: dfr 1999-09-06 08:30:25 +00:00			`.It Ar name`
			`Unload the file with this name.`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.El`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
			`.Ex -std`
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 kldunload 2 ,`
Add utilities for the kernel linker. 1997-05-07 18:19:54 +00:00			`.Xr kldload 8 ,`
			`.Xr kldstat 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`