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