aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMitchell Horne <mhorne@FreeBSD.org>2023-06-16 16:38:03 +0000
committerMitchell Horne <mhorne@FreeBSD.org>2023-07-17 16:45:39 +0000
commit387ee93e0794d8812e276745de148292bedf8ccc (patch)
treeb4f505d70be2285e066be7ebf9d54351f3259c1d
parent9ebf3b43bb649fc079f4898ba8bc8c0b4503a078 (diff)
downloadsrc-387ee93e0794d8812e276745de148292bedf8ccc.tar.gz
src-387ee93e0794d8812e276745de148292bedf8ccc.zip
hwpmc(4): more detailed SYNOPSYS
Include some boilerplate similar to other section 4 man pages, describing how to load the module at boot-time or include it in the kernel. Reviewed by: jkoshy, emaste MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D40542 (cherry picked from commit 0a1a48148ccd561464d643c05597cec2ae9e88b8)
-rw-r--r--share/man/man4/hwpmc.418
1 files changed, 17 insertions, 1 deletions
diff --git a/share/man/man4/hwpmc.4 b/share/man/man4/hwpmc.4
index 08edb6a16faf..6bd5d571793a 100644
--- a/share/man/man4/hwpmc.4
+++ b/share/man/man4/hwpmc.4
@@ -35,11 +35,27 @@
.Nm hwpmc
.Nd "Hardware Performance Monitoring Counter support"
.Sh SYNOPSIS
+The following option must be present in the kernel configuration file:
+.Bd -ragged -offset indent
.Cd "options HWPMC_HOOKS"
-.Cd "device hwpmc"
+.Ed
.Pp
Additionally, for i386 systems:
+.Bd -ragged -offset indent
.Cd "device apic"
+.Ed
+.Pp
+To load the driver as a module at boot time, place the
+following line in
+.Xr rc.conf 5 :
+.Bd -literal -offset indent
+kld_list="${kld_list} hwpmc"
+.Ed
+.Pp
+Alternatively, to compile this driver into the kernel:
+.Bd -ragged -offset indent
+.Cd "device hwpmc"
+.Ed
.Sh DESCRIPTION
The
.Nm