1.\" $NetBSD: modstat.8,v 1.28 2020/02/23 00:14:31 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 February 22, 2020 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 Aaek 44.Op Fl n Ar name | 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 k 67Display the kernel address of the module's text segment (disabled by default). 68.It Fl n Ar name 69Display the status of only the module with this name. 70Please note that 71.Fl n 72is optional. 73.El 74.Pp 75In addition to listing the currently loaded modules' name, 76the information reported by 77.Nm 78includes: 79.Bl -tag -width Loadaddr 80.It Li CLASS 81Module class, such as 82"vfs", "driver", "exec", "misc" or "secmodel". 83.It Li SOURCE 84Where the module was loaded from. 85.Qq Dv builtin 86indicates that the module was built into the running kernel. 87.Qq Dv boot 88indicates that the module was loaded during system bootstrap. 89.Qq Dv filesys 90indicates that the module was loaded from the file system. 91.It Li SIZE 92Size of the module's text section, in bytes. 93.It Li FLAG 94The module flags: 95.Bl -tag -width a -offset indent -compact 96.It Dv a 97Module is auto-loaded. 98.It Dv f 99Requires the 100.Xr modload 8 101flag 102.Fl f 103(force) to be loaded. 104.El 105.It Li REFS 106Number of references held on the module. 107Disabled builtin modules will show a count of \-1 here. 108.It Li ADDRESS 109The kernel address at which the module's text segment is loaded. 110Builtin modules will show 0 here. 111This field is only displayed if the 112.Fl k 113option is specified. 114.It Li REQUIRES 115Additional modules that must be present. 116.El 117.Sh EXIT STATUS 118The 119.Nm 120utility exits with a status of 0 on success 121and with a nonzero status if an error occurs. 122.Sh SEE ALSO 123.Xr module 7 , 124.Xr sysctl 7 , 125.Xr modload 8 , 126.Xr modunload 8 127.Sh HISTORY 128A 129.Nm 130utility appeared in 131.Nx 0.9 . 132The 133.Nm 134command was designed to be similar in functionality 135to the corresponding command in 136.Tn "SunOS 4.1.3" . 137.Nm 138was switched to the module framework for 139.Nx 5.0 . 140.Sh AUTHORS 141.An -nosplit 142The original 143.Nx 144implementation was written by 145.An Terrence R. Lambert Aq Mt terry@cs.weber.edu . 146The switch to the module framework was by 147.An Andrew Doran Aq Mt ad@NetBSD.org . 148