summaryrefslogtreecommitdiff
path: root/lib/libkvm/kvm_dump.3
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>2000-03-04 15:29:58 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>2000-03-04 15:29:58 +0000
commitecc71a2af2e2ea3a4b9b2bd464faf43faf9dd1ce (patch)
tree1374e1c20ea944d5552742ab21d7b5200506a8ad /lib/libkvm/kvm_dump.3
parent0b4e482da737df64291fac8d4d49b211a41eb3b5 (diff)
Various cleanups and mdoc'ing.
Diffstat (limited to 'lib/libkvm/kvm_dump.3')
-rw-r--r--lib/libkvm/kvm_dump.334
1 files changed, 19 insertions, 15 deletions
diff --git a/lib/libkvm/kvm_dump.3 b/lib/libkvm/kvm_dump.3
index fa51b1bc1c8..52e73f2d4d3 100644
--- a/lib/libkvm/kvm_dump.3
+++ b/lib/libkvm/kvm_dump.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: kvm_dump.3,v 1.3 1999/07/09 13:35:25 aaron Exp $
+.\" $OpenBSD: kvm_dump.3,v 1.4 2000/03/04 15:29:56 aaron Exp $
.\" $NetBSD: kvm_dump.3,v 1.1 1996/03/18 21:11:12 leo Exp $
.\"
.\" Copyright (c) 1996 Leo Weppelman
@@ -41,7 +41,6 @@
.Nd crash-dump support functions
.Sh SYNOPSIS
.Fd #include <kvm.h>
-.br
.Ft int
.Fn kvm_dump_mkheader "kvm_t *kd" "off_t dump_off"
.Ft int
@@ -56,30 +55,36 @@ The function
.Fn kvm_dump_mkheader
checks if the physical memory file associated with
.Fa kd
-contains a valid crash-dump header as generated by a dumping kernel. When a
-valid header is found,
+contains a valid crash-dump header as generated by a dumping kernel.
+When a valid header is found,
.Fn kvm_dump_mkheader
initializes the internal kvm data structures as if a crash-dump generated by
the
.Xr savecore 8
-program was opened. This has the intentional side effect of enabling the
+program was opened.
+This has the intentional side effect of enabling the
address translation machinery.
.Pp
A call to
.Fn kvm_dump_mkheader
will most likely be followed by a call to
.Fn kvm_dump_wrtheader .
-This function takes care of generating the generic header, the CORE_CPU
-section and the section header of the CORE_DATA section. The data is written
-to the file pointed at by
+This function takes care of generating the generic header, the
+.Dv CORE_CPU
+section and the section header of the
+.Dv CORE_DATA
+section.
+The data is written to the file pointed at by
.Fa fp .
The
.Fa dumpsize
-argument is only used to properly the set the segment size of the CORE_DATA
-section. Note that this function assumes that
+argument is only used to properly the set the segment size of the
+.Dv CORE_DATA
+section.
+Note that this function assumes that
.Fa fp
-is positioned at file location 0. This function will not seek and therefore
-allows
+is positioned at file location 0.
+This function will not seek and therefore allows
.Fa fp
to be a file pointer obtained by
.Fn zopen .
@@ -93,12 +98,11 @@ that
.Fn kvm_dum_mkheader
was called earlier in the sequence).
.Sh RETURN VALUES
-All functions return 0 on success, \-1 on failure. In the case of failure,
+All functions return 0 on success, \-1 on failure.
+In the case of failure,
.Xr kvm_geterr 3
can be used to retrieve the cause of the error.
.Sh HISTORY
These functions first appeared in NetBSD 1.1A.
-.Sh BUGS
-There probably are...
.Sh SEE ALSO
.Xr kvm 3