opnsense-src/sbin/kldstat/kldstat.8

.\"
.\" Copyright (c) 1997 Doug Rabson
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
.\"
.\" $FreeBSD$
.\"
.Dd January 19, 2016
.Dt KLDSTAT 8
.Os
.Sh NAME
.Nm kldstat
.Nd display status of dynamic kernel linker
.Sh SYNOPSIS
.Nm
.Op Fl h
.Op Fl q
.Op Fl v
.Op Fl d
.Op Fl i Ar id
.Op Fl n Ar filename
.Nm
.Op Fl q
.Op Fl d
.Op Fl m Ar modname
.Sh DESCRIPTION
The
.Nm
utility displays the status of any files dynamically linked into the
kernel.
.Pp
The following options are available:
.Bl -tag -width indentXX
.It Fl h
Display the size field in a human-readable form, using unit suffixes
instead of hex values.
.It Fl v
Be more verbose.
.It Fl d
Show the module specific data (as int, unsigned int and unsigned long)
.It Fl i Ar id
Display the status of only the file with this ID.
.It Fl n Ar filename
Display the status of only the file with this filename.
.It Fl q
Only check if module is loaded or compiled into the kernel.
.It Fl m Ar modname
Display the status of only the module with this modname.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr kldstat 2 ,
.Xr kldload 8 ,
.Xr kldunload 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 3.0 ,
replacing the
.Nm lkm
interface.
.Sh AUTHORS
.An Doug Rabson Aq Mt dfr@FreeBSD.org
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.\"`
			`.\" Copyright (c) 1997 Doug Rabson`
			`.\" 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.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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$ -> $FreeBSD$ 1999-08-27 20:22:10 -04:00			`.\" $FreeBSD$`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.\"`
Add "kldstat -h"; showing module sizes in hex is rather weird. Reviewed by: emaste@ (earlier version) MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D4969 2016-01-23 07:10:16 -05:00			`.Dd January 19, 2016`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.Dt KLDSTAT 8`
			`.Os`
			`.Sh NAME`
			`.Nm kldstat`
			`.Nd display status of dynamic kernel linker`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 11:52:27 -05:00			`.Nm`
Add "kldstat -h"; showing module sizes in hex is rather weird. Reviewed by: emaste@ (earlier version) MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D4969 2016-01-23 07:10:16 -05:00			`.Op Fl h`
Add quiet support for kldstat -n PR: bin/180014 Submitted by: Olivier Cochard-Labbé <olivier@cochard.me> MFC after: 1 week 2014-01-22 12:15:17 -05:00			`.Op Fl q`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.Op Fl v`
Add the ability to print out ht emodule specific information in likely formats. Among other things this gives us the ability to find outthe syscall number of a dynamically loaded syscall that has a dynamicly allocated vector number. MFC after: 1 week Sponsored by: Panzura inc. 2016-03-18 10:49:11 -04:00			`.Op Fl d`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.Op Fl i Ar id`
Add -m option (find module using modfind() and stat it). 2005-05-04 08:46:43 -04:00			`.Op Fl n Ar filename`
			`.Nm`
Add '-q' option, which (when used with '-m' option) just tells if the given module is loaded or compiled into the kernel. This is useful mostly in startup scripts, when module should be loaded only if it wasn't compiled into the kernel nor already loaded, eg.: kldstat -q -m g_eli \|\| kldload geom_eli.ko \|\| err 1 'geom_eli module failed to load.' 2005-09-23 19:52:26 -04:00			`.Op Fl q`
Add the ability to print out ht emodule specific information in likely formats. Among other things this gives us the ability to find outthe syscall number of a dynamically loaded syscall that has a dynamicly allocated vector number. MFC after: 1 week Sponsored by: Panzura inc. 2016-03-18 10:49:11 -04:00			`.Op Fl d`
Add -m option (find module using modfind() and stat it). 2005-05-04 08:46:43 -04:00			`.Op Fl m Ar modname`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Backout rev 1.8. This really does not give us the version number of the kld's. Pointed out by: bp 2000-07-01 03:57:28 -04:00			`utility displays the status of any files dynamically linked into the`
			`kernel.`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.Pp`
Sync. usage string and synopsis. Add rcsid. 1998-01-05 02:10:42 -05:00			`The following options are available:`
Fill-in the manpages a little. 1998-11-12 06:10:26 -05:00			`.Bl -tag -width indentXX`
Add "kldstat -h"; showing module sizes in hex is rather weird. Reviewed by: emaste@ (earlier version) MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D4969 2016-01-23 07:10:16 -05:00			`.It Fl h`
			`Display the size field in a human-readable form, using unit suffixes`
			`instead of hex values.`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.It Fl v`
Backout rev 1.8. This really does not give us the version number of the kld's. Pointed out by: bp 2000-07-01 03:57:28 -04:00			`Be more verbose.`
Add the ability to print out ht emodule specific information in likely formats. Among other things this gives us the ability to find outthe syscall number of a dynamically loaded syscall that has a dynamicly allocated vector number. MFC after: 1 week Sponsored by: Panzura inc. 2016-03-18 10:49:11 -04:00			`.It Fl d`
			`Show the module specific data (as int, unsigned int and unsigned long)`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.It Fl i Ar id`
			`Display the status of only the file with this ID.`
Add -m option (find module using modfind() and stat it). 2005-05-04 08:46:43 -04:00			`.It Fl n Ar filename`
			`Display the status of only the file with this filename.`
Add '-q' option, which (when used with '-m' option) just tells if the given module is loaded or compiled into the kernel. This is useful mostly in startup scripts, when module should be loaded only if it wasn't compiled into the kernel nor already loaded, eg.: kldstat -q -m g_eli \|\| kldload geom_eli.ko \|\| err 1 'geom_eli module failed to load.' 2005-09-23 19:52:26 -04:00			`.It Fl q`
			`Only check if module is loaded or compiled into the kernel.`
Add -m option (find module using modfind() and stat it). 2005-05-04 08:46:43 -04:00			`.It Fl m Ar modname`
			`Display the status of only the module with this modname.`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.El`
Added the EXIT STATUS section where appropriate. 2005-01-17 02:44:44 -05:00			`.Sh EXIT STATUS`
			`.Ex -std`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.Sh SEE ALSO`
Add cross-references to respective syscalls. 1999-09-03 12:40:24 -04:00			`.Xr kldstat 2 ,`
Add utilities for the kernel linker. 1997-05-07 14:19:54 -04:00			`.Xr kldload 8 ,`
			`.Xr kldunload 8`
a few code style changes: o start function names in column 1 o sort order of flags in getopt and switch o don't try to reference progname o unspam some changes introduced by a 2.2.1-R build box instead of a -current build box doc changes: o document when these commands first appeared o put email address in angle brakets o minor mdoc clean up 1997-10-21 05:59:26 -04:00			`.Sh HISTORY`
			`The`
			`.Nm`
The .Nm utility 2002-07-06 15:34:18 -04:00			`utility first appeared in`
Fill-in the manpages a little. 1998-11-12 06:10:26 -05:00			`.Fx 3.0 ,`
			`replacing the`
Mark up lkm with .Nm, since lkm is name of an api. Submitted by: ru 2007-02-13 12:06:15 -05:00			`.Nm lkm`
Fill-in the manpages a little. 1998-11-12 06:10:26 -05:00			`interface.`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-19 02:46:04 -05:00			`.Sh AUTHORS`
use .Mt to mark up email addresses consistently (part1) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> 2014-06-20 05:40:43 -04:00			`.An Doug Rabson Aq Mt dfr@FreeBSD.org`