Annotation of src/usr.bin/pctr/pctr.1, Revision 1.6
1.6 ! aaron 1: .\" $OpenBSD: pctr.1,v 1.5 2000/03/23 21:10:17 aaron Exp $
1.1 downsj 2: .\"
3: .\" Copyright (c) 1998, Jason Downs. All rights reserved.
4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
13: .\"
14: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
15: .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16: .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17: .\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
18: .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19: .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20: .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21: .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24: .\" SUCH DAMAGE.
25: .\"
26: .Dd August 30, 1998
27: .Dt PCTR 1
28: .Os
29: .Sh NAME
30: .Nm pctr
1.2 aaron 31: .Nd display CPU performance counters
1.1 downsj 32: .Sh SYNOPSIS
1.3 aaron 33: .Nm pctr
1.1 downsj 34: .Op Fl l Ar 5 | 6
35: .Sh DESCRIPTION
36: The
37: .Nm
38: program is a sample implementation of how to access the
39: .Xr pctr 4
40: pseudo device available on many i386 compatible machines.
41: .Pp
42: By default, the
43: .Nm
44: command displays the current values of the TSC and any vendor specific
45: counter registers.
1.4 aaron 46: .Pp
47: The options are as follows:
1.6 ! aaron 48: .Bl -tag -width Ds
1.1 downsj 49: .It Fl l Ar 5 | 6
1.5 aaron 50: List all possible vendor specific counters.
51: The argument specifies which
1.1 downsj 52: .Dq family
53: to display; it defaults to the
54: .Dq family
55: designation of the current processor.
56: .El
1.4 aaron 57: .Pp
1.1 downsj 58: The
59: .Nm
1.2 aaron 60: program exits with a value of 0 on success or 1 on failure.
1.1 downsj 61: .Sh SEE ALSO
62: .Xr pctr 4
63: .Sh HISTORY
64: The
65: .Nm
66: program appeared in
67: .Ox 2.0 .
1.4 aaron 68: .Sh BUGS
69: The
70: .Nm
71: program is still orientated towards Intel brand microprocessors.