Edit

IABSD.fr/src/usr.bin/kdump/kdump.1

Branch :

  • Show log

    Commit

  • Author : schwarze
    Date : 2019-05-15 15:36:59
    Hash : dfdede6c
    Message : improve wrong markup and poor wording regarding the -t argument that was spotted by deraadt@; OK deraadt@ jmc@

  • usr.bin/kdump/kdump.1
  • .\"	$OpenBSD: kdump.1,v 1.34 2019/05/15 15:36:59 schwarze Exp $
    .\"
    .\" Copyright (c) 1990, 1993
    .\"	The Regents of the University of California.  All rights reserved.
    .\"
    .\" 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. 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 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.
    .\"
    .\"	from: @(#)kdump.1	8.1 (Berkeley) 6/6/93
    .\"
    .Dd $Mdocdate: May 15 2019 $
    .Dt KDUMP 1
    .Os
    .Sh NAME
    .Nm kdump
    .Nd display kernel trace data
    .Sh SYNOPSIS
    .Nm kdump
    .Op Fl dHlnRTXx
    .Op Fl f Ar file
    .Op Fl m Ar maxdata
    .Op Fl p Ar pid
    .Op Fl t Ar trstr
    .Sh DESCRIPTION
    .Nm
    displays the kernel trace files produced with
    .Xr ktrace 1
    in human-readable format.
    By default, the file
    .Pa ktrace.out
    in the current directory is displayed, unless overridden by the
    .Fl f
    option.
    .Pp
    The options are as follows:
    .Bl -tag -width Ds
    .It Fl d
    Display all numbers in decimal.
    By default, values are printed out in hexadecimal.
    .It Fl f Ar file
    Display the specified file instead of
    .Pa ktrace.out .
    Specifying
    .Sq -
    will read from standard input.
    .It Fl H
    Display thread identifiers.
    .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 I/O.
    .It Fl n
    Suppress ad hoc translations.
    Normally
    .Nm
    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 p Ar pid
    Show output only for the
    .Ar pid
    specified.
    .It Fl R
    Display relative timestamps (time since previous entry).
    .It Fl T
    Display absolute timestamps for each entry (seconds since the Epoch).
    .It Fl TR
    If both options are specified, display timestamps relative to trace start.
    .It Fl t Ar trstr
    Select which tracepoints to display.
    The argument can contain one or more of the letters
    .Cm cinpstuxX+ .
    See the
    .Fl t
    option of
    .Xr ktrace 1
    for the meaning of the letters.
    .It Fl X
    Display I/O data with hexadecimal data and printable ASCII characters
    side by side.
    .It Fl x
    Display I/O data in hexadecimal.
    .El
    .Sh FILES
    .Bl -tag -width ktrace.out -compact
    .It Pa ktrace.out
    default ktrace dump file
    .El
    .Sh SEE ALSO
    .Xr ktrace 1
    .Sh HISTORY
    The
    .Nm
    command appeared in
    .Bx 4.4 .