NetBSD/sbin/modunload/modunload.8

.\" $NetBSD: modunload.8,v 1.23 2016/09/12 06:55:10 wiz Exp $
.\"
.\" Copyright (c) 1993 Christopher G. Demetriou
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"          This product includes software developed for the
.\"          NetBSD Project.  See http://www.NetBSD.org/ for
.\"          information about NetBSD.
.\" 4. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
.\"
.Dd September 12, 2016
.Dt MODUNLOAD 8
.Os
.Sh NAME
.Nm modunload
.Nd unload a kernel module
.Sh SYNOPSIS
.Nm
.Ar name
\&...
.Sh DESCRIPTION
The
.Nm
utility unloads a loadable kernel module from a running system.
.Pp
.Ar name
is name of the module to be unloaded, as shown by
.Xr modstat 8 .
.Pp
Builtin modules will not be unloaded from memory, but they will be
disabled.
They can be re-enabled using
.Xr modload 8 .
.Sh DIAGNOSTICS
The
.Nm
utility exits with a status of 0 on success
and with a nonzero status if an error occurs.
.Sh SEE ALSO
.Xr modctl 2 ,
.Xr module 7 ,
.Xr modload 8 ,
.Xr modstat 8
.Sh HISTORY
A
.Nm
utility appeared in
.Nx 5.0 .
The
.Nm
command was designed to be similar in functionality
to the corresponding command in
.Tn "SunOS 4.1.3" .
.Sh AUTHORS
.An Andrew Doran Aq Mt ad@NetBSD.org .
Use standard section header. 2016-09-12 09:55:10 +03:00			`.\" $NetBSD: modunload.8,v 1.23 2016/09/12 06:55:10 wiz Exp $`
convert to new RCS Id conventions; reduce my headache 1995-03-18 17:54:19 +03:00			`.\"`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.\" Copyright (c) 1993 Christopher G. Demetriou`
			`.\" All rights reserved.`
Whitespace nits 2001-11-16 13:25:42 +03:00			`.\"`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.\" 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.`
sweep of my licenses (userland files w/o only my copyright) for consistency. (no functional changes) 2000-06-14 21:24:02 +04:00			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed for the`
'NetBSD.org' and some mdoc fixes. 2003-02-14 19:21:47 +03:00			`.\" NetBSD Project. See http://www.NetBSD.org/ for`
sweep of my licenses (userland files w/o only my copyright) for consistency. (no functional changes) 2000-06-14 21:24:02 +04:00			`.\" information about NetBSD.`
			`.\" 4. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission.`
Whitespace nits 2001-11-16 13:25:42 +03:00			`.\"`
add LKM man pages 1993-06-08 07:07:11 +04:00			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.`
Whitespace nits 2001-11-16 13:25:42 +03:00			`.\"`
sweep of my licenses (userland files w/o only my copyright) for consistency. (no functional changes) 2000-06-14 21:24:02 +04:00			`.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.\"`
Document author and the version modunload appeared. Bump date. 2016-09-12 03:19:29 +03:00			`.Dd September 12, 2016`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.Dt MODUNLOAD 8`
Drop arguments of .Os. 2001-06-05 15:22:41 +04:00			`.Os`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.Sh NAME`
			`.Nm modunload`
			`.Nd unload a kernel module`
			`.Sh SYNOPSIS`
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.Nm`
Remove LKMs and switch to the module framework, pass 1. Proposed on tech-kern@. 2008-11-12 15:35:50 +03:00			`.Ar name`
Allow for passing more than one module at a time: $ sudo modunload auvitek xc5000 wintv_eeprom 2010-12-07 02:42:48 +03:00			`\&...`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`utility unloads a loadable kernel module from a running system.`
Remove LKMs and switch to the module framework, pass 1. Proposed on tech-kern@. 2008-11-12 15:35:50 +03:00			`.Pp`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.Ar name`
Remove LKMs and switch to the module framework, pass 1. Proposed on tech-kern@. 2008-11-12 15:35:50 +03:00			`is name of the module to be unloaded, as shown by`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.Xr modstat 8 .`
note module changes 2010-03-05 21:51:22 +03:00			`.Pp`
			`Builtin modules will not be unloaded from memory, but they will be`
			`disabled.`
			`They can be re-enabled using`
			`.Xr modload 8 .`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.Sh DIAGNOSTICS`
			`The`
			`.Nm`
			`utility exits with a status of 0 on success`
			`and with a nonzero status if an error occurs.`
			`.Sh SEE ALSO`
Add cross-refs from modload(8) amd modunload(8) to modctl(2) 2015-11-29 02:53:48 +03:00			`.Xr modctl 2 ,`
Fix xref; module(4) -> module(7). 2010-12-14 19:23:59 +03:00			`.Xr module 7 ,`
merge in changes from 1.1 release branch 1995-11-28 08:25:28 +03:00			`.Xr modload 8 ,`
add LKM man pages 1993-06-08 07:07:11 +04:00			`.Xr modstat 8`
			`.Sh HISTORY`
Document author and the version modunload appeared. Bump date. 2016-09-12 03:19:29 +03:00			`A`
			`.Nm`
			`utility appeared in`
			`.Nx 5.0 .`
add LKM man pages 1993-06-08 07:07:11 +04:00			`The`
			`.Nm`
			`command was designed to be similar in functionality`
			`to the corresponding command in`
			`.Tn "SunOS 4.1.3" .`
Use standard section header. 2016-09-12 09:55:10 +03:00			`.Sh AUTHORS`
Document author and the version modunload appeared. Bump date. 2016-09-12 03:19:29 +03:00			`.An Andrew Doran Aq Mt ad@NetBSD.org .`