pps_fetch: introduce a helper to handle timeouts
[dragonfly.git] / usr.bin / kdump / kdump.1
blobc436458c85cfe4b6747ceca134544cbd4df7bae7
1 .\" Copyright (c) 1990, 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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)kdump.1     8.1 (Berkeley) 6/6/93
29 .\" $FreeBSD: src/usr.bin/kdump/kdump.1,v 1.5.2.2 2001/08/16 13:16:51 ru Exp $
30 .\"
31 .Dd April 4, 2023
32 .Dt KDUMP 1
33 .Os
34 .Sh NAME
35 .Nm kdump
36 .Nd display kernel trace data
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl acdjnlRT
40 .Op Fl f Ar file
41 .Op Fl m Ar maxdata
42 .Op Fl t Op cnisuwy
43 .Op Fl p Ar pid
44 .Sh DESCRIPTION
45 The
46 .Nm
47 command displays the kernel trace files produced with
48 .Xr ktrace 1
49 in human readable format.
50 By default, the file
51 .Pa ktrace.out
52 in the current directory is displayed, which may be overridden by the
53 .Fl f
54 option.
55 .Pp
56 The options are as follows:
57 .Bl -tag -width Fl
58 .It Fl a
59 Display full human readable output.
60 This option turns on
61 .Fl c
62 and
63 .Fl R .
64 .It Fl c
65 Display the cpu the thread is executing on.
66 .It Fl d
67 Display all numbers in decimal.
68 .It Fl j
69 Use a fixed format output, otherwise a more human readable output is used.
70 .It Fl f Ar file
71 Display the specified file instead of
72 .Pa ktrace.out .
73 .It Fl l
74 Loop reading the trace file, once the end-of-file is reached, waiting for
75 more data.
76 .It Fl m Ar maxdata
77 Display at most
78 .Ar maxdata
79 bytes when decoding I/O; set to
80 .Cm 0
81 to disable the size limit.
82 .It Fl p Ar pid
83 Display only records for process
84 .Ar pid .
85 .It Fl n
86 Suppress ad hoc translations.
87 Normally
88 .Nm
89 tries to decode many system calls into a more human readable format.
90 For example,
91 .Xr ioctl 2
92 values are replaced with the macro name and
93 .Va errno
94 values are replaced with the
95 .Xr strerror 3
96 string.
97 Suppressing this feature yields a more consistent output format and is
98 easily amenable to further processing.
99 .It Fl R
100 Display relative timestamps (time since previous entry).
101 .It Fl T
102 Display absolute timestamps for each entry (seconds since epoch).
103 .It Fl t Ar cnisuwy
104 See the
105 .Fl t
106 option of
107 .Xr ktrace 1 .
109 .Sh FILES
110 .Bl -tag -width ktrace.out -compact
111 .It Pa ktrace.out
112 default ktrace dump file
114 .Sh SEE ALSO
115 .Xr ktrace 1
116 .Sh HISTORY
119 command appeared in
120 .Bx 4.4 .