Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / kernbb / kernbb.8
1 .\" Copyright (c) 1983, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $FreeBSD: src/usr.sbin/kernbb/kernbb.8,v 1.9.2.5 2001/08/16 15:56:01 ru Exp $
33 .\"
34 .Dd May 22, 1995
35 .Dt KERNBB 8
36 .Os
37 .Sh NAME
38 .Nm kernbb
39 .Nd generate a dump of the kernels basic-block profile buffers
40 .Sh SYNOPSIS
41 .Nm
42 .Sh DESCRIPTION
43 .Nm Kernbb
44 is a tool used to dump the basic-block profiling buffers of the running
45 kernel.
46 .Pp
47 At least one source file in the running kernel must have been compiled
48 with the
49 .Fl a
50 option.
51 .Pp
52 The output format is
53 .Tn ASCII ,
54 consisting of one line per record with the
55 following fields: filename, linenumber, procedure, address, count
56 of executions, length of the basic-block in bytes and the product of
57 the previous two fields.
58 .Sh FILES
59 .Bl -tag -width /dev/kmemx -compact
60 .It Pa /kernel
61 the default system
62 .It Pa /dev/kmem
63 the default memory
64 .El
65 .Sh SEE ALSO
66 .Xr cc 1
67 .Sh AUTHORS
68 The
69 .Nm
70 command was written by
71 .An Poul-Henning Kamp ,
72 along with the kernel-support.