Move everything from /var/adm to /var/log
[unleashed.git] / share / man / man8 / kadb.8
blob0d38474e38f9d51f98c151e94437f2f82408ecb2
1 '\" te
2 .\"  Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH KADB 8 "Dec 9, 2017"
7 .SH NAME
8 kadb \- a kernel debugger
9 .SH SYNOPSIS
10 .SS "SPARC"
11 .LP
12 .nf
13 \fBok\fR boot \fIdevice_specifier\fR kadb [\fB-d\fR] [\fIboot-flags\fR]
14 .fi
16 .SS "x86"
17 .LP
18 .nf
19 \fBselect\fR (b)oot or (i)nterpreter: b kadb [\fB-d\fR] [\fIboot-flags\fR]
20 .fi
22 .SH DESCRIPTION
23 .LP
24 \fBkadb\fR, an interactive kernel debugger, has been replaced by \fBkmdb\fR(1).
25 For backwards compatibility, the methods used to load \fBkadb\fR will be
26 interpreted as requests to load \fBkmdb\fR(1). Unlike with the compatibility
27 link from \fBadb\fR(1) to \fBmdb\fR(1), \fBkmdb\fR(1) will always load in its
28 native user interface mode, regardless of the name used to load it.
29 .sp
30 .LP
31 \fBkmdb\fR(1) is based on \fBmdb\fR(1), and thus shares \fBmdb\fR's user
32 interface style and feature set. The \fBmdb\fR(1) man page describes the
33 features and operation of \fBmdb\fR. The \fBkmdb\fR(1) man page describes the
34 differences between \fBmdb\fR and \fBkmdb\fR. This man page describes the major
35 changes and incompatibilities between \fBkadb\fR and \fBkmdb\fR.
36 .sp
37 .LP
38 Consult the \fIModular Debugger Guide\fR for a detailed description of
39 both \fBmdb\fR and \fBkmdb\fR.
40 .SS "Major changes"
41 .LP
42 This section briefly lists the major differences between \fBkadb\fR and
43 \fBkmdb\fR. It is not intended to be exhaustive.
44 .sp
45 .ne 2
46 .na
47 \fBDebugger Loading and Unloading\fR
48 .ad
49 .sp .6
50 .RS 4n
51 \fBkmdb\fR(1) may be loaded at boot, as with \fBkadb\fR. It may also be loaded
52 after boot, thus allowing for kernel debugging and execution control without
53 requiring a system reboot. If \fBkmdb\fR(1) is loaded after boot, it may be
54 unloaded.
55 .RE
57 .sp
58 .ne 2
59 .na
60 \fBmdb Feature Set\fR
61 .ad
62 .sp .6
63 .RS 4n
64 The features introduced by \fBmdb\fR(1), including access to kernel type data,
65 debugger commands (dcmds), debugger modules (dmods), and enhanced execution
66 control facilities, are available under \fBkmdb\fR(1). Support for changing the
67 representative CPU (:x) is available for both SPARC and x86. Furthermore, full
68 execution-control facilities are available after the representative CPU has
69 been changed.
70 .RE
72 .SS "Significant Incompatibilities"
73 .LP
74 This section lists the significant features that have changed incompatibly
75 between \fBkadb\fR and \fBkmdb\fR(1). It is not intended to be exhaustive. All
76 \fBkmdb\fR(1) commands referenced here are fully described in the \fBkmdb\fR(1)
77 man page. A description as well as examples can be found in the \fIModular
78 Debugger Guide\fR.
79 .sp
80 .ne 2
81 .na
82 \fBDeferred Breakpoints\fR
83 .ad
84 .sp .6
85 .RS 4n
86 The kadb-style "module#symbol:b" syntax is not supported under \fBkmdb\fR(1).
87 Instead, use "::bp module`symbol".
88 .RE
90 .sp
91 .ne 2
92 .na
93 \fBWatchpoints\fR
94 .ad
95 .sp .6
96 .RS 4n
97 The ::wp dcmd is the preferred way to set watchpoint with \fBkmdb\fR. Various
98 options are available to control the type of watchpoint set, including \fB-p\fR
99 for physical watchpoints (SPARC only), and \fB-i\fR for I/O port watchpoints
100 (x86 only). $l is not supported, therefore, the watchpoint size must be
101 specified for each watchpoint created.
105 .ne 2
107 \fBAccess to I/O Ports (x86 only)\fR
109 .sp .6
110 .RS 4n
111 The commands used to access I/O ports under \fBkadb\fR have been replaced with
112 the ::in and ::out dcmds. These two dcmds allow both read and write of all I/O
113 port sizes supported by \fBkadb\fR.
116 .SH SEE ALSO
118 \fBadb\fR(1), \fBmdb\fR(1), \fBkmdb\fR(1), \fBattributes\fR(5)
121 \fIModular Debugger Guide\fR:
124 https://illumos.org/books/mdb/