Sat Mar 10 10:36:26 2018 UTC ()
Document the new A-is-for-Alias flag value


(pgoyette)
diff -r1.22 -r1.22.12.1 src/sbin/modstat/modstat.8
cvs diff -r1.22 -r1.22.12.1 src/sbin/modstat/modstat.8 (switch to unified diff)

--- src/sbin/modstat/modstat.8 2016/09/12 06:54:00 1.22
+++ src/sbin/modstat/modstat.8 2018/03/10 10:36:26 1.22.12.1
@@ -1,148 +1,153 @@ @@ -1,148 +1,153 @@
1.\" $NetBSD: modstat.8,v 1.22 2016/09/12 06:54:00 wiz Exp $ 1.\" $NetBSD: modstat.8,v 1.22.12.1 2018/03/10 10:36:26 pgoyette Exp $
2.\" 2.\"
3.\" Copyright (c) 1993 Christopher G. Demetriou 3.\" Copyright (c) 1993 Christopher G. Demetriou
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" Redistribution and use in source and binary forms, with or without 6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions 7.\" modification, are permitted provided that the following conditions
8.\" are met: 8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright 9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer. 10.\" notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\" notice, this list of conditions and the following disclaimer in the 12.\" notice, this list of conditions and the following disclaimer in the
13.\" documentation and/or other materials provided with the distribution. 13.\" documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software 14.\" 3. All advertising materials mentioning features or use of this software
15.\" must display the following acknowledgement: 15.\" must display the following acknowledgement:
16.\" This product includes software developed for the 16.\" This product includes software developed for the
17.\" NetBSD Project. See http://www.NetBSD.org/ for 17.\" NetBSD Project. See http://www.NetBSD.org/ for
18.\" information about NetBSD. 18.\" information about NetBSD.
19.\" 4. The name of the author may not be used to endorse or promote products 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. 20.\" derived from this software without specific prior written permission.
21.\" 21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 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 23.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 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 28.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 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 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. 31.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32.\" 32.\"
33.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>> 33.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
34.\" 34.\"
35.Dd September 12, 2016 35.Dd September 12, 2016
36.Dt MODSTAT 8 36.Dt MODSTAT 8
37.Os 37.Os
38.Sh NAME 38.Sh NAME
39.Nm modstat 39.Nm modstat
40.Nd display status of loaded kernel modules 40.Nd display status of loaded kernel modules
41.Sh SYNOPSIS 41.Sh SYNOPSIS
42.Nm 42.Nm
43.Op Fl Aaen 43.Op Fl Aaen
44.Op Ar name 44.Op Ar name
45.Sh DESCRIPTION 45.Sh DESCRIPTION
46The 46The
47.Nm 47.Nm
48utility displays the status of any kernel modules present in the kernel. 48utility displays the status of any kernel modules present in the kernel.
49.Pp 49.Pp
50The options are as follows: 50The options are as follows:
51.Bl -tag -width indent 51.Bl -tag -width indent
52.It Fl A 52.It Fl A
53Tells you whether or not modules can be autoloaded at the moment. 53Tells you whether or not modules can be autoloaded at the moment.
54This option 54This option
55.Em does 55.Em does
56take into consideration the sysctl 56take into consideration the sysctl
57.Li kern.module.autoload . 57.Li kern.module.autoload .
58.It Fl a 58.It Fl a
59Tells you whether or not modules can be autoloaded at the moment. 59Tells you whether or not modules can be autoloaded at the moment.
60This option 60This option
61.Em does not 61.Em does not
62take into consideration the sysctl 62take into consideration the sysctl
63.Li kern.module.autoload . 63.Li kern.module.autoload .
64.It Fl e 64.It Fl e
65Tells you whether or not you may load a module at the moment. 65Tells you whether or not you may load a module at the moment.
66.It Fl k 66.It Fl k
67Display the module's kernel address (disabled by default). 67Display the module's kernel address (disabled by default).
68.It Fl n Ar name 68.It Fl n Ar name
69Display the status of only the module with this name. 69Display the status of only the module with this name.
70Please note that 70Please note that
71.Fl n 71.Fl n
72is optional. 72is optional.
73.El 73.El
74.Pp 74.Pp
75In addition to listing the currently loaded modules' name, 75In addition to listing the currently loaded modules' name,
76the information reported by 76the information reported by
77.Nm 77.Nm
78includes: 78includes:
79.Pp 79.Pp
80.Bl -tag -width Loadaddr 80.Bl -tag -width Loadaddr
81.It Li CLASS 81.It Li CLASS
82Module class, such as 82Module class, such as
83"vfs", "driver", "exec", "misc" or "secmodel". 83"vfs", "driver", "exec", "misc" or "secmodel".
84.It Li SOURCE 84.It Li SOURCE
85Where the module was loaded from. 85Where the module was loaded from.
86.Qq Dv builtin 86.Qq Dv builtin
87indicates that the module was built into the running kernel. 87indicates that the module was built into the running kernel.
88.Qq Dv boot 88.Qq Dv boot
89indicates that the module was loaded during system bootstrap. 89indicates that the module was loaded during system bootstrap.
90.Qq Dv filesys 90.Qq Dv filesys
91indicates that the module was loaded from the file system. 91indicates that the module was loaded from the file system.
92.It Li SIZE 92.It Li SIZE
93Size of the module in bytes. 93Size of the module in bytes.
94.It Li FLAG 94.It Li FLAG
95The module flags: 95The module flags:
96.Bl -tag -width a -offset indent -compact 96.Bl -tag -width a -offset indent -compact
97.It Dv a 97.It Dv a
98Module is auto-loaded. 98Module is auto-loaded.
99.It Dv f 99.It Dv f
100Required the 100Requires the
101.Xr modload 8 101.Xr modload 8
102flag 102flag
103.Fl f 103.Fl f
104(force) to be loaded. 104(force) to be loaded.
 105.It Dv A
 106Module is an alias for another module.
 107The REQUIRES column contains the
 108.Dq real
 109alias name.
105.El 110.El
106.It Li REFS 111.It Li REFS
107Number of references held on the module. 112Number of references held on the module.
108Disabled builtin modules will show a count of \-1 here. 113Disabled builtin modules will show a count of \-1 here.
109.It Li ADDRESS 114.It Li ADDRESS
110The kernel address at which the module is loaded. 115The kernel address at which the module is loaded.
111Builtin modules will show 0 here. 116Builtin modules will show 0 here.
112This field is only displayed if the 117This field is only displayed if the
113.Fl k 118.Fl k
114option is specified. 119option is specified.
115.It Li REQUIRES 120.It Li REQUIRES
116Additional modules that must be present. 121Additional modules that must be present.
117.El 122.El
118.Sh EXIT STATUS 123.Sh EXIT STATUS
119The 124The
120.Nm 125.Nm
121utility exits with a status of 0 on success 126utility exits with a status of 0 on success
122and with a nonzero status if an error occurs. 127and with a nonzero status if an error occurs.
123.Sh SEE ALSO 128.Sh SEE ALSO
124.Xr module 7 , 129.Xr module 7 ,
125.Xr sysctl 7 , 130.Xr sysctl 7 ,
126.Xr modload 8 , 131.Xr modload 8 ,
127.Xr modunload 8 132.Xr modunload 8
128.Sh HISTORY 133.Sh HISTORY
129A 134A
130.Nm 135.Nm
131utility appeared in 136utility appeared in
132.Nx 0.9 . 137.Nx 0.9 .
133The 138The
134.Nm 139.Nm
135command was designed to be similar in functionality 140command was designed to be similar in functionality
136to the corresponding command in 141to the corresponding command in
137.Tn "SunOS 4.1.3" . 142.Tn "SunOS 4.1.3" .
138.Nm 143.Nm
139was switched to the module framework for 144was switched to the module framework for
140.Nx 5.0 . 145.Nx 5.0 .
141.Sh AUTHORS 146.Sh AUTHORS
142.An -nosplit 147.An -nosplit
143The original 148The original
144.Nx 149.Nx
145implementation was written by 150implementation was written by
146.An Terrence R. Lambert Aq Mt terry@cs.weber.edu . 151.An Terrence R. Lambert Aq Mt terry@cs.weber.edu .
147The switch to the module framework was by 152The switch to the module framework was by
148.An Andrew Doran Aq Mt ad@NetBSD.org . 153.An Andrew Doran Aq Mt ad@NetBSD.org .