summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>2000-07-09 20:56:30 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>2000-07-09 20:56:30 +0000
commit7e58b310cb906184851f845c09cfa939e864da99 (patch)
tree0eb11aaf48c74f0114108437481540dcaaa8de4f
parent0b7298c4cf022750d3de63226e89f90aa5919786 (diff)
Many formatting fixes.
-rw-r--r--share/man/man4/ddb.4110
1 files changed, 69 insertions, 41 deletions
diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4
index fdc15533668..7e54b0ea463 100644
--- a/share/man/man4/ddb.4
+++ b/share/man/man4/ddb.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ddb.4,v 1.22 2000/07/02 02:44:04 ericj Exp $
+.\" $OpenBSD: ddb.4,v 1.23 2000/07/09 20:56:29 aaron Exp $
.\" $NetBSD: ddb.4,v 1.5 1994/11/30 16:22:09 jtc Exp $
.\"
.\" Mach Operating System
@@ -34,8 +34,8 @@
.Sh DESCRIPTION
The kernel debugger has most of the features of the old kdb,
but with a more rational
-.No ( Xr gdb 1
-\&- like) syntax.
+.Pf ( Xr gdb 1 No Ns \&-like )
+syntax.
.Pp
.Nm ddb
prompts for commands on the console with:
@@ -67,7 +67,7 @@ the current location is called
.\" a hexadecimal format at a prompt.
The
.Ic examine ,
-.Ic search
+.Ic search ,
and
.Ic write
commands update
@@ -113,14 +113,17 @@ of 1, and no modifiers.
.Nm ddb
has a feature like
.Xr more 1
-for the output. If the number of lines output in response to
-one command exceeds the number set in the
+for the output.
+If the number of lines output in response to one command exceeds the number
+set in the
.Va \&$lines
variable, it displays the message
.Ql "--db_more--"
and waits for a response.
+.Pp
The valid responses are:
-.Bl -tag -width 10n -compact -offset indent
+.Pp
+.Bl -tag -width 10n -offset indent -compact
.It <space>
One more page.
.It <return>
@@ -130,7 +133,8 @@ Abort the current command, and return to the command input mode.
.El
.Pp
The following command line editing keys are provided:
-.Bl -tag -width 10n -compact -offset indent
+.Pp
+.Bl -tag -width 10n -offset indent -compact
.It Ic \&^b
back up one character
.It Ic \&^f
@@ -174,9 +178,10 @@ is only available if the kernel was configured with the DDB option.
.Sh COMMANDS
The following commands may be typed at the
.Ql ddb>
-prompt. Some commands consist of more than one word, and if
-only the first word or words are entered, the possible alternatives
-to complete the command are displayed and no other action is performed.
+prompt.
+Some commands consist of more than one word, and if only the first word
+or words are entered, the possible alternatives to complete the command
+are displayed and no other action is performed.
.Bl -tag -width 10n
.\" --------------------
.It Ic help
@@ -197,6 +202,7 @@ If no format is specified, the last formats specified for this command
is used.
.Pp
The format characters are:
+.Pp
.Bl -tag -width 4n -compact
.It Cm /b
look at by bytes (8 bits)
@@ -222,7 +228,7 @@ display in unsigned decimal
display in current radix, signed
.It Cm /c
display low 8 bits as a character.
-Non-printing characters are displayed as an octal escape code (e.g. '\\000').
+Non-printing characters are displayed as an octal escape code (e.g., '\\000').
.It Cm /s
display the null-terminated string at the location.
Non-printing characters are displayed as octal escapes.
@@ -234,6 +240,7 @@ display as an instruction
.It Cm /I
display as an alternate format instruction depending on the
machine:
+.Pp
.Bl -tag -width powerpc_ -compact
.It vax
Don't assume that each external label is a procedure entry mask.
@@ -283,10 +290,13 @@ is used.
The
.Ar addr
argument
-can be a string, and it is printed as a literal. For example,
+can be a string, and it is printed as a literal.
+.Pp
+For example,
.Bd -literal -offset indent
print/x "eax = " $eax "\enecx = " $ecx "\en"
.Ed
+.Pp
will print something like this:
.Bd -literal -offset indent
eax = xxxxxx
@@ -308,7 +318,8 @@ Write the value of each
expression at succeeding locations start at
.Ar addr .
The write unit size can be specified using one of the modifiers:
-.Bl -tag -width 4n -compact -offset indent
+.Pp
+.Bl -tag -width 4n -offset indent -compact
.It Cm /b
byte (8 bits)
.It Cm /h
@@ -375,17 +386,19 @@ When the
.Cm /u
modifier is specified,
.Ar addr
-is taken as a user space address. Without it,
-the address is considered in the kernel space. Wrong space addresses
-are rejected with an error message. The
+is taken as a user space address.
+Without it, the address is considered in the kernel space.
+Wrong space addresses are rejected with an error message.
+The
.Cm /u
modifier can be used only if it is supported by machine dependent
routines.
.Pp
.Sy Warning:
if a user text is shadowed by a normal user space debugger,
-user space break points may not work correctly. Setting a break
-point at the low-level code paths may also cause strange behavior.
+user space break points may not work correctly.
+Setting a breakpoint at the low-level code paths may also cause strange
+behavior.
.\" --------------------
.\" .It Xo Ic d
.\" .Op Ar addr | Ic # Ns Ar number
@@ -487,7 +500,8 @@ command.
This is tiny and handy tool for random kernel hangs analysis, of which its
depth is controlled by the optional argument of the default value of five.
It uses some sophisticated heuristics to spot the global symbol that
-caused the hang. Since the discovering algorithm is a probabilistic one
+caused the hang.
+Since the discovering algorithm is a probabilistic one
you may spend substantial time to figure the exact symbol name.
This smart thing requires a little of your attention, the input it accepts
is mostly of the same format as that of the famous
@@ -511,8 +525,8 @@ If
modifier is specified,
.Nm ddb
prints the call nesting depth and the
-cumulative instruction count at each call or return. Otherwise,
-it stays silent until the matching return is hit.
+cumulative instruction count at each call or return.
+Otherwise, it stays silent until the matching return is hit.
.\" --------------------
.It Ic match Op Cm /p
Stop at the next matching return instruction.
@@ -521,8 +535,8 @@ If the
modifier is specified,
.Nm ddb
prints the call nesting depth and the
-cumulative instruction count at each call or return. Otherwise, it remains
-mostly quiet.
+cumulative instruction count at each call or return.
+Otherwise, it remains mostly quiet.
.\" --------------------
.It Ic next Op Cm /p
The
@@ -536,7 +550,8 @@ command is a synonym for
.Op Ar frameaddr Ns
.Op Ic \&, Ns Ar count
.Xc
-Show the stack trace. The
+Show the stack trace.
+The
.Cm /u
modifier shows the stack trace of user space;
If omitted, the kernel stack is traced instead.
@@ -562,11 +577,14 @@ only if the machine dependent code supports it.
Search memory for a value beginning at
.Ar addr .
This command might fail in interesting
-ways if it doesn't find the searched-for value. This is because
+ways if it doesn't find the searched-for value.
+This is because
.Nm ddb
-doesn't always recover from touching bad memory. The optional
+doesn't always recover from touching bad memory.
+The optional
.Ar count
-argument limits the search. The modifiers are the same as those of the
+argument limits the search.
+The modifiers are the same as those of the
.Ic write
command.
.Pp
@@ -577,12 +595,12 @@ address is set to the address where
is found, or just after where the search area finishes.
.\" --------------------
.It Ic show Ar what
-The show command displays different things, depending on
+Displays various things, depending on
.Ar what :
-.Bl -tag -width 4n -compact
+.Bl -tag -width 4n
.\" --------------------
.It Ic show breaks
-Prints a list of all the breakpoints that have been set with the
+Prints a list of all breakpoints that have been set with the
.Ic break
command.
.\" --------------------
@@ -594,12 +612,13 @@ Prints a detailed list of all extents.
.Op Cm /f
.Ar addr
.Xc
-Prints the vm_map at
+Prints the
+.Li vm_map
+at
.Ar addr .
If the
.Cm /f
-modifieris specified the
-complete map is printed.
+modifier is specified the complete map is printed.
.\" --------------------
.It Xo
.Ic show malloc
@@ -614,8 +633,13 @@ is printed.
.Op Cm /f
.Ar addr
.Xc
-Prints the vm_object at 'addr'. If the 'f' option is specified the
-complete object is printed.
+Prints the
+.Li vm_object
+at
+.Ar addr .
+If the
+.Cm /f
+modifier is specified the complete object is printed.
.\" --------------------
.It Xo
.Ic show registers
@@ -641,17 +665,21 @@ command.
.Op Cm /anw
.Xc
Display information on all processes.
+.Pp
.Bl -tag -width foo -compact
.It Cm /n
(Default) Show process information in a
-.Xr ps 1 Ns
-\&-like format. Information printed includes process ID, parent
+.Xr ps 1 No Ns \&-like
+format.
+Information printed includes process ID, parent
process ID, process group, UID, process status, process flags, process
command name, and process wait channel message.
.It Cm /a
Shows the kernel virtual addesses of each process'
-proc structure, u-area, and vmspace structure. The vmspace
-address is also the address of the process' vm_map structure
+proc structure, u-area, and vmspace structure.
+The vmspace address is also the address of the process'
+.Li vm_map
+structure
and can be used in the
.Ic show map
command.
@@ -689,7 +717,7 @@ following a colon immediately after the variable name.
For example, register variables can have the
.Ql :u
modifier to indicate a
-user register (e.g.
+user register (e.g.,
.Ql \&$eax:u ) .
.Pp
Built-in debugger variables currently supported are: