Return to kgmon.8 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / usr.sbin / kgmon

Annotation of 43BSDReno/usr.sbin/kgmon/kgmon.8, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"    @(#)kgmon.8     6.3 (Berkeley) 6/24/90
                     19: .\"
                     20: .TH KGMON 8 "June 24, 1990"
                     21: .UC 5
                     22: .SH NAME
                     23: kgmon \- generate a dump of the operating system's profile buffers
                     24: .SH SYNOPSIS
                     25: .B kgmon
                     26: [
                     27: .B \-b
                     28: ] [
                     29: .B \-h
                     30: ] [
                     31: .B \-r
                     32: ] [
                     33: .B \-p
                     34: ] [ system ] [ memory ]
                     35: .SH DESCRIPTION
                     36: .I Kgmon
                     37: is a tool used when profiling the operating system.
                     38: When no arguments are supplied,
                     39: .I kgmon 
                     40: indicates the state of operating system profiling as running,
                     41: off, or not configured.
                     42: (see
                     43: .IR config (8))
                     44: If the
                     45: .B \-p
                     46: flag is specified,
                     47: .I kgmon
                     48: extracts profile data from the operating system and produces a
                     49: .I gmon.out
                     50: file suitable for later analysis by
                     51: .IR gprof (1).
                     52: .PP
                     53: The following options may be specified:
                     54: .TP
                     55: .B \-b
                     56: Resume the collection of profile data.
                     57: .TP
                     58: .B \-h
                     59: Stop the collection of profile data.
                     60: .TP
                     61: .B \-p
                     62: Dump the contents of the profile buffers into a
                     63: .I gmon.out
                     64: file.
                     65: .TP
                     66: .B \-r
                     67: Reset all the profile buffers. 
                     68: If the
                     69: .B \-p
                     70: flag is also specified, the
                     71: .I gmon.out
                     72: file is generated before the buffers are reset.
                     73: .PP
                     74: If neither 
                     75: .B \-b
                     76: nor
                     77: .B \-h
                     78: is specified, the state of profiling collection remains unchanged.
                     79: For example, if the
                     80: .B \-p
                     81: flag is specified and profile data is being collected,
                     82: profiling will be momentarily suspended,
                     83: the operating system profile buffers will be dumped,
                     84: and profiling will be immediately resumed.
                     85: .SH FILES
                     86: /vmunix \- the default system
                     87: .br
                     88: /dev/kmem \- the default memory
                     89: .SH "SEE ALSO"
                     90: gprof(1),
                     91: config(8)
                     92: .SH DIAGNOSTICS
                     93: Users with only read permission on /dev/kmem cannot change the state
                     94: of profiling collection. 
                     95: They can get a 
                     96: .I gmon.out
                     97: file with the warning that the data may be
                     98: inconsistent if profiling is in progress.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.