From 35386a8afbbf5746a3ef4c972a6a98979ffa9542 Mon Sep 17 00:00:00 2001 From: Greg Lehey Date: Fri, 2 Jan 2004 05:07:57 +0000 Subject: [PATCH] Submit to police inspection. No content changes. Submitted bu: ru --- share/man/man4/vinumdebug.4 | 111 +++++++++++++++++++++++------------- 1 file changed, 72 insertions(+), 39 deletions(-) diff --git a/share/man/man4/vinumdebug.4 b/share/man/man4/vinumdebug.4 index 6109f5b28695..a157ae080aff 100644 --- a/share/man/man4/vinumdebug.4 +++ b/share/man/man4/vinumdebug.4 @@ -1,67 +1,100 @@ +.\" Copyright (c) 2003 Greg Lehey +.\" 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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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. +.\" .\" $FreeBSD$ +.\" .Dd December 30, 2003 .Dt VINUMDEBUG 4 .Os .Sh NAME .Nm vinumdebug -.Nd debug macros for Vinum. +.Nd debug macros for +.Xr vinum 4 .Sh DESCRIPTION -This man page describes -.Nm gdb +This man page describes +.Xr gdb 4 macros for debugging the -.Nm vinum -kernel module. +.Xr vinum 4 +kernel module. See .Xr gdb 4 for the description of the kernel debugging environment. No further action is required to access the -.Nm vinum +.Xr vinum 4 debug macros. They are loaded automatically along with the other macros. .Sh COMMANDS -.Bl -ohang -offset 3m -.It Cm finfo -Show recently freed Vinum memory blocks. -.It Cm meminfo -Equivalent of -.Nm vinum Ar info Fl v +.Bl -tag -width ".Ic rrqe Ar rqe" +.It Ic finfo +Show recently freed +.Xr vinum 4 +memory blocks. +.It Ic meminfo +Equivalent of the +.Nm vinum Ic info Fl v command. -.It Cm rq -Show information about the request pointed to by the variable -.Va rq +.It Ic rq +Show information about the request pointed to by the variable +.Va rq in the current frame. -.It Cm rqe -Show information about the request element pointed to by the variable -.Va rqe +.It Ic rqe +Show information about the request element pointed to by the variable +.Va rqe in the current frame. -.It Cm rqi +.It Ic rqi Print out a simplified version of the same information as the -.Nm vinum Ar info Fl V +.Nm vinum Ic info Fl V command. -.It Cm rqinfo -Show the Vinum request log buffer like the -.Nm vinum Ar info Fl V +.It Ic rqinfo +Show the +.Xr vinum 4 +request log buffer like the +.Nm vinum Ic info Fl V command. -.It Cm rqq Ar rq -Show information about the request -.Vt ( struct rq ) +.It Ic rqq Ar rq +Show information about the request +.Pq Vt "struct rq" pointed at by -.Va rq . -.It Cm rqq0 -Print information on some Vinum request structures. -.It Cm rqq1 -Print information on some Vinum request structures. -.It Cm rrqe Ar rqe -Show information about the request element -.Vt ( struct rqe ) +.Ar rq . +.It Ic rqq0 +Print information on some +.Xr vinum 4 +request structures. +.It Ic rqq1 +Print information on some +.Xr vinum 4 +request structures. +.It Ic rrqe Ar rqe +Show information about the request element +.Pq Vt "struct rqe" pointed at by the parameter -.Va rqe . +.Ar rqe . .El .Sh AUTHORS -This man page was written by -.An "Greg Lehey" Aq grog@FreeBSD.org +This man page was written by +.An "Greg Lehey" Aq grog@FreeBSD.org . .Sh SEE ALSO .Xr gdb 4 , .Xr vinum 4 , -.Xr vinum 8 . -.\" .Sh HISTORY +.Xr vinum 8