BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.sbin / kgmon / kgmon.8

diff --git a/usr/src/usr.sbin/kgmon/kgmon.8 b/usr/src/usr.sbin/kgmon/kgmon.8
index 80ce790..0378cd5 100644 (file)
--- a/usr/src/usr.sbin/kgmon/kgmon.8
+++ b/usr/src/usr.sbin/kgmon/kgmon.8
@@ -1,98 +1,122 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)kgmon.8     6.3 (Berkeley) 6/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH KGMON 8 "June 24, 1990"
-.UC 5
-.SH NAME
-kgmon \- generate a dump of the operating system's profile buffers
-.SH SYNOPSIS
-.B kgmon
-[
-.B \-b
-] [
-.B \-h
-] [
-.B \-r
-] [
-.B \-p
-] [ system ] [ memory ]
-.SH DESCRIPTION
-.I Kgmon
+.\"     @(#)kgmon.8    6.5 (Berkeley) 6/6/91
+.\"
+.Dd June 6, 1991
+.Dt KGMON 8
+.Os BSD 4.2
+.Sh NAME
+.Nm kgmon
+.Nd generate a dump of the operating system's profile buffers
+.Sh SYNOPSIS
+.Nm kgmon
+.Op Fl bhpr
+.Op Fl M core
+.Op Fl N system
+.Sh DESCRIPTION
+.Nm Kgmon

 is a tool used when profiling the operating system.
 When no arguments are supplied,
 is a tool used when profiling the operating system.
 When no arguments are supplied,

-.I kgmon 
+.Nm kgmon

 indicates the state of operating system profiling as running,
 off, or not configured.
 (see
 indicates the state of operating system profiling as running,
 off, or not configured.
 (see

-.IR config (8))
+.Xr config 8 )

 If the
 If the

-.B \-p
+.Fl p

 flag is specified,
 flag is specified,

-.I kgmon
+.Nm kgmon

 extracts profile data from the operating system and produces a
 extracts profile data from the operating system and produces a

-.I gmon.out
+.Pa gmon.out

 file suitable for later analysis by
 file suitable for later analysis by

-.IR gprof (1).
-.PP
-The following options may be specified:
-.TP
-.B \-b
+.Xr gprof 1 .
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl b

 Resume the collection of profile data.
 Resume the collection of profile data.

-.TP
-.B \-h
+.It Fl h

 Stop the collection of profile data.
 Stop the collection of profile data.

-.TP
-.B \-p
+.It Fl p

 Dump the contents of the profile buffers into a
 Dump the contents of the profile buffers into a

-.I gmon.out
+.Pa gmon.out

 file.
 file.

-.TP
-.B \-r
+.It Fl r

 Reset all the profile buffers. 
 If the
 Reset all the profile buffers. 
 If the

-.B \-p
+.Fl p

 flag is also specified, the
 flag is also specified, the

-.I gmon.out
+.Pa gmon.out

 file is generated before the buffers are reset.
 file is generated before the buffers are reset.

-.PP
+.It Fl M
+Extract values associated with the name list from the specified core
+instead of the default ``/dev/kmem''.
+.It Fl N
+Extract the name list from the specified system instead of the
+default ``/vmunix''.
+.El
+.Pp

 If neither 
 If neither 

-.B \-b
+.Fl b

 nor
 nor

-.B \-h
+.Fl h

 is specified, the state of profiling collection remains unchanged.
 For example, if the
 is specified, the state of profiling collection remains unchanged.
 For example, if the

-.B \-p
+.Fl p

 flag is specified and profile data is being collected,
 profiling will be momentarily suspended,
 the operating system profile buffers will be dumped,
 and profiling will be immediately resumed.
 flag is specified and profile data is being collected,
 profiling will be momentarily suspended,
 the operating system profile buffers will be dumped,
 and profiling will be immediately resumed.

-.SH FILES
-/vmunix \- the default system
-.br
-/dev/kmem \- the default memory
-.SH "SEE ALSO"
-gprof(1),
-config(8)
-.SH DIAGNOSTICS
-Users with only read permission on /dev/kmem cannot change the state
+.Sh FILES
+.Bl -tag -width /dev/kmemx -compact
+.It Pa /vmunix
+the default system
+.It Pa /dev/kmem
+the default memory
+.El
+.Sh SEE ALSO
+.Xr gprof 1 ,
+.Xr config 8
+.Sh DIAGNOSTICS
+Users with only read permission on
+.Pa /dev/kmem
+cannot change the state

 of profiling collection. 
 They can get a 
 of profiling collection. 
 They can get a 

-.I gmon.out
+.Pa gmon.out

 file with the warning that the data may be
 inconsistent if profiling is in progress.
 file with the warning that the data may be
 inconsistent if profiling is in progress.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.2 .