xref: /openbsd/usr.sbin/kvm_mkdb/kvm_mkdb.8 (revision 73471bf0)
1.\"	$OpenBSD: kvm_mkdb.8,v 1.11 2007/05/31 19:20:25 jmc Exp $
2.\" Copyright (c) 1989, 1991, 1993
3.\"	The Regents of the University of California.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. Neither the name of the University nor the names of its contributors
14.\"    may be used to endorse or promote products derived from this software
15.\"    without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\"     from: @(#)kvm_mkdb.8	8.1 (Berkeley) 6/9/93
30.\"
31.Dd $Mdocdate: May 31 2007 $
32.Dt KVM_MKDB 8
33.Os
34.Sh NAME
35.Nm kvm_mkdb
36.Nd create kernel database
37.Sh SYNOPSIS
38.Nm kvm_mkdb
39.Op Fl v
40.Op Fl o Ar directory
41.Op Ar file
42.Sh DESCRIPTION
43.Nm kvm_mkdb
44creates a database in
45.Pa /var/db
46containing information about the specified file.
47If no file is specified,
48.Pa /bsd
49is used by default.
50The file is named
51.Pa kvm_filename.db ,
52where
53.Ar filename
54is the name of the file read.
55Various library routines consult this database.
56The only information currently stored is the kernel namelist, which is
57used by the
58.Xr kvm_nlist 3
59function.
60However, in the future the database may contain other static
61information about the current system.
62.Pp
63The options are as follows:
64.Bl -tag -width "-o directory"
65.It Fl o Ar directory
66Allows the specification of a
67.Ar directory
68other than
69.Pa /var/db
70for the database to be created in.
71.It Fl v
72Yields slightly more verbose operation.
73.El
74.Sh FILES
75.Bl -tag -width /var/db/kvm_bsd.db -compact
76.It Pa /bsd
77.It Pa /var/db/kvm_bsd.db
78.El
79.Sh SEE ALSO
80.Xr kvm_nlist 3
81.Sh HISTORY
82The
83.Nm kvm_mkdb
84utility first appeared in
85.Bx 4.4 .
86