xref: /netbsd-src/sbin/modstat/modstat.8 (revision a5847cc334d9a7029f6352b847e9e8d71a0f9e0c)
1.\" $NetBSD: modstat.8,v 1.9 2011/08/02 16:46:45 mbalmer 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 August 2, 2011
36.Dt MODSTAT 8
37.Os
38.Sh NAME
39.Nm modstat
40.Nd display status of loaded kernel modules
41.Sh SYNOPSIS
42.Nm
43.Op Fl n
44.Op Ar name
45.Sh DESCRIPTION
46The
47.Nm
48utility displays the status of any kernel modules present in the kernel.
49.Pp
50The options are as follows:
51.Bl -tag -width indent
52.It Fl n Ar name
53Display the status of only the module with this name.
54Please note that
55.Fl n
56is optional.
57.El
58.Pp
59In addition to listing the currently loaded modules' name,
60the information reported by
61.Nm
62includes:
63.Pp
64.Bl -tag -width Loadaddr
65.It Li CLASS
66Module class, such as
67"vfs", "driver", "exec", "misc" or "secmodel".
68.It Li SOURCE
69Where the module was loaded from.
70.Qq Dv builtin
71indicates that the module was built into the running kernel.
72.Qq Dv boot
73indicates that the module was loaded during system bootstrap.
74.Qq Dv filesys
75indicates that the module was loaded from the file system.
76.It Li SIZE
77Size of the module in bytes.
78.It Li REFS
79Number of references held on the module.
80Disabled builtin modules will show a count of \-1 here.
81.It Li REQUIRES
82Additional modules that must be present.
83.El
84.Sh EXIT STATUS
85The
86.Nm
87utility exits with a status of 0 on success
88and with a nonzero status if an error occurs.
89.Sh SEE ALSO
90.Xr module 7 ,
91.Xr modload 8 ,
92.Xr modunload 8
93.Sh HISTORY
94The
95.Nm
96command was designed to be similar in functionality
97to the corresponding command in
98.Tn "SunOS 4.1.3" .
99