[src/trunk]: src/usr.bin/pmc Add a DIAGNOSTIC section to clarify potential pr...

[gmcgarry <gmcgarry%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/91da28013e2f
branches:  trunk
changeset: 532406:91da28013e2f
user:      gmcgarry <gmcgarry%NetBSD.org@localhost>
date:      Thu Jun 06 21:32:37 2002 +0000

description:
Add a DIAGNOSTIC section to clarify potential problems.

diffstat:

 usr.bin/pmc/pmc.1 |  38 +++++++++++++++++++++++++-------------
 1 files changed, 25 insertions(+), 13 deletions(-)

diffs (81 lines):

diff -r ae3e8df7224f -r 91da28013e2f usr.bin/pmc/pmc.1
--- a/usr.bin/pmc/pmc.1 Thu Jun 06 21:28:49 2002 +0000
+++ b/usr.bin/pmc/pmc.1 Thu Jun 06 21:32:37 2002 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: pmc.1,v 1.3 2002/02/07 03:15:11 ross Exp $
+.\"    $NetBSD: pmc.1,v 1.4 2002/06/06 21:32:37 gmcgarry Exp $
 .\"
 .\" Copyright (c) 2000 Zembu Labs, Inc.
 .\" All rights reserved.
@@ -36,7 +36,7 @@
 .Os
 .Sh NAME
 .Nm pmc
-.Nd performance counter interface for command execution
+.Nd performance-monitoring counter interface for command execution
 .Sh SYNOPSIS
 .Nm ""
 .Fl h
@@ -52,15 +52,16 @@
 .Oc
 .Sh DESCRIPTION
 .Nm
-is a means of using a processor's performance counter facility to
-measure various aspects of a program's execution.  It is meant to
-be used in a fashion similar to
+is a means of using a processor's performance-monitoring counter (PMC)
+facility to measure various aspects of a program's execution.  It is
+meant to be used in a fashion similar to
 .Xr time 1 .
 .Pp
 The arguments are as follows:
 .Bl -tag -width indent
 .It Fl h
-Display a list of performance counter events available on the system.
+Display a list of performance counter events available on
+the system.
 .It Fl C
 Cancel any performance counters that are currently running.
 .It Fl c Ar event
@@ -68,8 +69,21 @@
 .Ar event
 while running the command.
 .El
+.Sh DIAGNOSTICS
+.Bl -diag
+.It PMC support is not compiled into the kernel
+Performance-monitoring counter support has not been compiled into the
+kernel.  It may be included using the
+.Em PERFCTRS
+option.  See
+.Xr options 4
+for details.
+.It only 686 counters are supported 
+Currently, only supports 686-class performance-monitoring
+counters are supported.
 .Sh SEE ALSO
-.Xr time 1
+.Xr time 1 ,
+.Xr options 4
 .Sh HISTORY
 The
 .Nm
@@ -79,14 +93,12 @@
 The
 .Nm
 command was written by
-.An Frank van der Linden
-.Aq fvdl%wasabisystems.com@localhost .
+.An Frank van der Linden Aq fvdl%wasabisystems.com@localhost .
 The kernel support for reading performance counters on the i386
 architecture was written by
-.An Jason R. Thorpe
-.Aq thorpej%zembu.com@localhost .
+.An Jason R. Thorpe Aq thorpej%zembu.com@localhost .
 .Sh BUGS
 The
 .Nm
-command currently only supports 686-class performance counters on
-the i386 architecture.
+command currently only supports 686-class performance-monitoring
+counters on the i386 architecture.