From b3fd39940129e837e0c9726907a8de0df54ecbbf Mon Sep 17 00:00:00 2001
From: rwatson <rwatson@FreeBSD.org>
Date: Tue, 25 Dec 2007 23:25:04 +0000
Subject: Document DDB capture facility.

MFC after:	3 months
---
 share/man/man4/ddb.4 | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

(limited to 'share/man')

diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4
index 488c75d..6475ce5 100644
--- a/share/man/man4/ddb.4
+++ b/share/man/man4/ddb.4
@@ -59,7 +59,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd August 6, 2007
+.Dd December 25, 2007
 .Dt DDB 4
 .Os
 .Sh NAME
@@ -593,6 +593,39 @@ Hard reset the system.
 .It Ic help
 Print a short summary of the available commands and command
 abbreviations.
+.Pp
+.It Ic capture on
+.It Ic capture off
+.It Ic capture reset
+.It Ic capture status
+.Nm
+supports a basic output capture facility, which can be used to retrieve the
+results of debugging commands from userpsace using
+.Xr sysctl 2 .
+.Ic capture on
+enables output capture;
+.Ic capture off
+disables capture.
+.Ic capture reset
+will clear the capture buffer and disable capture.
+.Ic capture status
+will report current buffer use, buffer size, and disposition of output
+capture.
+.Pp
+Userspace processes may inspect and manage
+.Nm
+capture state using
+.Xr sysctl 8 :
+.Pp
+.Dv debug.ddb.capture.bufsize
+may be used to query or set the current capture buffer size.
+.Pp
+.Dv debug.ddb.capture.maxbufsize
+may be used to query the compile-time limit on the capture buffer size.
+.Pp
+.Dv debug.ddb.capture.bytes
+may be used to query the number of bytes of output currently in the capture
+buffer.
 .El
 .Sh VARIABLES
 The debugger accesses registers and variables as
-- 
cgit v1.1