BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / ktrace / kdump / kdump.1

diff --git a/usr/src/usr.bin/ktrace/kdump/kdump.1 b/usr/src/usr.bin/ktrace/kdump/kdump.1
index a18c017..8189082 100644 (file)
--- a/usr/src/usr.bin/ktrace/kdump/kdump.1
+++ b/usr/src/usr.bin/ktrace/kdump/kdump.1
@@ -1,92 +1,100 @@
 .\" Copyright (c) 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1990 The Regents of the University of California.
 .\" 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.

 .\"
 .\"

-.\"     @(#)kdump.1    1.3 (Berkeley) 7/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.

 .\"
 .\"

-.Dd July 24, 1990
+.\"    @(#)kdump.1     5.4 (Berkeley) 7/26/91
+.\"
+.Dd July 26, 1991

 .Dt KDUMP 1
 .Dt KDUMP 1

+.Os

 .Sh NAME
 .Nm kdump
 .Nd display kernel trace data
 .Sh SYNOPSIS
 .Nm kdump
 .Sh NAME
 .Nm kdump
 .Nd display kernel trace data
 .Sh SYNOPSIS
 .Nm kdump

-.Op Fl dnlTR
-.Op Fl f Ar trfile
-.Op Fl t Ar trstr
+.Op Fl dnlRT
+.Op Fl f Ar file
+.Op Fl m Ar maxdata
+.Op Fl t Op cnis

 .Sh DESCRIPTION
 .Nm Kdump
 .Sh DESCRIPTION
 .Nm Kdump

-displays kernel trace files produced with
+displays the kernel trace files produced with

 .Xr ktrace 1
 .Xr ktrace 1

-in a human readable format.
-Without the
-.Fl f
-flag,
-.Nm kdump
-reads the file
-.Sq Pa ktrace.out
-in the current
-directory.
+in human readable format.
+By default, the file
+.Pa ktrace.out
+in the current directory is displayed.

 .Pp
 .Pp

-Options:
-.Tw Fl
-.Tp Fl d
+The options are as follows:
+.Bl -tag -width Fl
+.It Fl d

 Display all numbers in decimal.
 Display all numbers in decimal.

-.Tp Fl n
-Suppress ad hoc translations.  Normally
+.It Fl f Ar file 
+Display the specified file instead of
+.Pa ktrace.out .
+.It Fl l
+Loop reading the trace file, once the end-of-file is reached, waiting for
+more data.
+.It Fl m Ar maxdata 
+Display at most
+.Ar maxdata
+bytes when decoding
+.Tn I/O .
+.It Fl n
+Suppress ad hoc translations.
+Normally

 .Nm kdump
 .Nm kdump

-tries to decode many
-system calls into a more human readable format.  For example, ioctl
-values are replaced with the macro name and errno values are replaced
-with the
-.Li sys_errlist
-string.  Suppressing this feature yields a more consistent
-output format and is easily amenable to further processing.
-.Tp Fl l
-Loop reading end-of-file.
-.Tp Fl T
-Display absolute timestamps for each entry (seconds since epoch).
-.Tp Fl R
+tries to decode many system calls into a more human readable format.
+For example,
+.Xr ioctl 2
+values are replaced with the macro name and
+.Va errno
+values are replaced with the
+.Xr strerror 3
+string.
+Suppressing this feature yields a more consistent output format and is
+easily amenable to further processing.
+.It Fl R

 Display relative timestamps (time since previous entry).
 Display relative timestamps (time since previous entry).

-.Tc Fl t
-.Ws
-.Ar trstr
-.Cx
-See
-.Fl t
-in
-.Xr ktrace 1 .
-.Tc Fl f
-.Ws
-.Ar trfile
-.Cx
-See
+.It Fl T
+Display absolute timestamps for each entry (seconds since epoch).
+.It Fl t Ar cnis 
+See the

 .Fl t
 .Fl t

-in
+option of

 .Xr ktrace 1 .
 .Xr ktrace 1 .

-.Tc Fl m
-.Ws
-.Ar maxdata
-.Cx
-Display at most
-.Ar maxdata
-bytes when decoding i/o.
-.Tp
+.El

 .Sh SEE ALSO
 .Xr ktrace 1
 .Sh SEE ALSO
 .Xr ktrace 1

-\- enable kernel process tracing.

 .Sh HISTORY
 .Sh HISTORY

-4.4 BSD.
+The
+.Nm kdump
+command is
+.Ud .