svn commit: r365266 - head/sbin/kldstat

[Fernando Apesteguía]

Author: fernape (ports committer)
Date: Wed Sep  2 18:15:57 2020
New Revision: 365266
URL: https://svnweb.freebsd.org/changeset/base/365266

Log:
  kldstat(8): Add EXAMPLES to the man page
  
  Add EXAMPLES for all the flags
  
  Approved by:	manpages (bcr@)
  Differential Revision: https://reviews.freebsd.org/D26283

Modified:
  head/sbin/kldstat/kldstat.8

Modified: head/sbin/kldstat/kldstat.8
==============================================================================
--- head/sbin/kldstat/kldstat.8	Wed Sep  2 18:12:47 2020	(r365265)
+++ head/sbin/kldstat/kldstat.8	Wed Sep  2 18:15:57 2020	(r365266)
@@ -63,12 +63,84 @@ 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.
+Only check if file 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 EXAMPLES
+Show files dynamically linked into the kernel.
+Note the kernel itself is shown in the list.
+.Em Refs
+shows the number of modules referenced by each file:
+.Bd -literal -offset indent
+$ kldstat
+Id Refs Address                Size Name
+ 1   38 0xffffffff80200000  2448f20 kernel
+ 2    3 0xffffffff82649000    b7bd8 linux.ko
+ 3    5 0xffffffff82701000     9698 linux_common.ko
+ 4    1 0xffffffff82b11000     1eae linsysfs.ko
+ 5    1 0xffffffff82b13000    f2af8 nvidia-modeset.ko
+ 6    1 0xffffffff82c06000  122b020 nvidia.ko
+ 7    1 0xffffffff83e32000     2668 intpm.ko
+ 8    1 0xffffffff83e35000      b50 smbus.ko
+ 9    1 0xffffffff83e36000     18a0 uhid.ko
+10    1 0xffffffff83e38000     2928 ums.ko
+11    1 0xffffffff83e3b000     1aa0 wmt.ko
+12    1 0xffffffff83e3d000     cd70 snd_uaudio.ko
+.Ed
+.Pp
+Show the verbose status of the
+.Em linux
+file and show the size in a human readable fashion:
+.Bd -literal -offset indent
+$ kldstat -h -v -n linux
+Id Refs Address             Size Name
+ 2    3 0xffffffff82649000  735K linux.ko (/boot/kernel/linux.ko)
+        Contains modules:
+                 Id Name
+                  2 linuxelf
+.Ed
+.Pp
+Same as above using the
+.Em id
+of the file:
+.Bd -literal -offset indent
+$ kldstat -h -i 2 -v
+Id Refs Address             Size Name
+ 2    3 0xffffffff82649000  735K linux.ko (/boot/kernel/linux.ko)
+        Contains modules:
+                 Id Name
+                  2 linuxelf
+.Ed
+.Pp
+Show the status of the
+.Em linuxelf
+module obtained from the example above:
+.Bd -literal -offset indent
+$ kldstat -v -m linuxelf
+Id  Refs Name
+  2    1 linuxelf
+.Ed
+.Pp
+Show the module specific data for the
+.Em g_raid
+module:
+.Bd -literal -offset indent
+$ kldstat -d -m g_raid
+Id  Refs Name data..(int, uint, ulong)
+366    1 g_raid (0, 0, 0x0)
+.Ed
+.Pp
+Check if the module
+.Em fakefile
+is linked.
+Returns 0 if it is, 1 otherwise:
+.Bd -literal -offset indent
+$ kldstat -q -n fakefile || echo file not linked
+file not linked
+.Ed
 .Sh SEE ALSO
 .Xr kldstat 2 ,
 .Xr kldload 8 ,