xref: /netbsd-src/sbin/modunload/modunload.8 (revision fad4c9f71477ae11cea2ee75ec82151ac770a534)
1.\" $NetBSD: modunload.8,v 1.15 2003/09/06 20:12:41 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 September 6, 2003
36.Dt MODUNLOAD 8
37.Os
38.Sh NAME
39.Nm modunload
40.Nd unload a kernel module
41.Sh SYNOPSIS
42.Nm
43.Op Fl i Ar id
44.Op Fl n Ar name
45.Nm
46.Op Ar id Ns \&| Ns Ar name
47.Sh DESCRIPTION
48The
49.Nm
50utility unloads a loadable kernel module from a running system.
51The
52.Ar id
53or
54.Ar name
55is the ID or name of the module as shown by
56.Xr modstat 8 .
57.Pp
58One of the following options may be specified:
59.Bl -tag -width indent
60.It Fl i Ar id
61Unload the module with the ID
62.Ar id .
63.It Fl n Ar name
64Unload the module with the name
65.Ar name .
66.El
67.Pp
68If the option is not specified, the provided argument
69is used as module ID if it's numeric.
70If the argument is not numeric, it's used as module name.
71.Sh DIAGNOSTICS
72The
73.Nm
74utility exits with a status of 0 on success
75and with a nonzero status if an error occurs.
76.Sh SEE ALSO
77.Xr lkm 4 ,
78.Xr modload 8 ,
79.Xr modstat 8
80.Sh HISTORY
81The
82.Nm
83command was designed to be similar in functionality
84to the corresponding command in
85.Tn "SunOS 4.1.3" .
86.Sh AUTHORS
87.Bl -tag
88.An Terrence R. Lambert
89.Aq terry@cs.weber.edu .
90.El
91