xref: /netbsd-src/sbin/modstat/modstat.8 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\" $NetBSD: modstat.8,v 1.15 2013/10/24 13:00:21 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 October 24, 2013
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 Aaen
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 A
53Tells you whether or not modules can be autoloaded at the moment.
54This option
55.Em does
56take into consideration the sysctl
57.Li kern.module.autoload .
58.It Fl a
59Tells you whether or not modules can be autoloaded at the moment.
60This option
61.Em does not
62take into consideration the sysctl
63.Li kern.module.autoload .
64.It Fl e
65Tells you whether or not you may load a module at the moment.
66.It Fl n Ar name
67Display the status of only the module with this name.
68Please note that
69.Fl n
70is optional.
71.El
72.Pp
73In addition to listing the currently loaded modules' name,
74the information reported by
75.Nm
76includes:
77.Pp
78.Bl -tag -width Loadaddr
79.It Li CLASS
80Module class, such as
81"vfs", "driver", "exec", "misc" or "secmodel".
82.It Li SOURCE
83Where the module was loaded from.
84.Qq Dv builtin
85indicates that the module was built into the running kernel.
86.Qq Dv boot
87indicates that the module was loaded during system bootstrap.
88.Qq Dv filesys
89indicates that the module was loaded from the file system.
90.It Li SIZE
91Size of the module in bytes.
92.It Li REFS
93Number of references held on the module.
94Disabled builtin modules will show a count of \-1 here.
95.It Li ADDRESS
96The kernel address at which the module is loaded.
97Builtin modules will show 0 here.
98.It Li REQUIRES
99Additional modules that must be present.
100.El
101.Sh EXIT STATUS
102The
103.Nm
104utility exits with a status of 0 on success
105and with a nonzero status if an error occurs.
106.Sh SEE ALSO
107.Xr module 7 ,
108.Xr sysctl 7 ,
109.Xr modload 8 ,
110.Xr modunload 8
111.Sh HISTORY
112The
113.Nm
114command was designed to be similar in functionality
115to the corresponding command in
116.Tn "SunOS 4.1.3" .
117