freebsd-dev/usr.sbin/dev_mkdb/dev_mkdb.8

.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
.\"
.\"	@(#)dev_mkdb.8	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd November 18, 2001
.Os
.Dt DEV_MKDB 8
.Sh NAME
.Nm dev_mkdb
.Nd create
.Pa /dev
database
.Sh SYNOPSIS
.Nm
.Op Fl f Ar file
.Op Ar directory
.Sh DESCRIPTION
The
.Nm
command creates a
.Xr db 3
hash access method database in
.Ar file
.Pa ( /var/run/dev.db
by default)
which contains the names of all of the character and block special
files in
.Ar directory
.Pa ( /dev
by default), using the file type and the
.Fa st_rdev
field as the key.
.Pp
Keys are a structure containing a
.Vt mode_t
followed by a
.Vt dev_t ,
with any padding zero'd out.
The former is the type of the file
.Va ( st_mode Li & Dv S_IFMT ) ,
the latter is the
.Va st_rdev
field.
.Sh FILES
.Bl -tag -width ".Pa /var/run/dev.db" -compact
.It Pa /dev
Default device directory.
.It Pa /var/run/dev.db
Default database file.
.El
.Sh SEE ALSO
.Xr ps 1 ,
.Xr stat 2 ,
.Xr db 3 ,
.Xr devname 3 ,
.Xr ttyname 3
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.4 .
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" Copyright (c) 1990, 1993`
			`.\" The Regents of the University of California. 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.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.`
			`.\"`
			`.\" @(#)dev_mkdb.8 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\"`
mdoc(7) police: bump document date, fix markup. 2001-11-20 15:57:00 +00:00			`.Dd November 18, 2001`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Os`
			`.Dt DEV_MKDB 8`
			`.Sh NAME`
			`.Nm dev_mkdb`
			`.Nd create`
			`.Pa /dev`
			`database`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Allow the path for /dev and the location of the database file to be overridden on the command line. This is useful for setting up chroot/jail environments. PR: bin/23509 Submitted by: Seth Kingsley <sethk@pike.osd.bsdi.com> MFC after: 1 week 2001-11-18 17:24:28 +00:00			`.Op Fl f Ar file`
			`.Op Ar directory`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh DESCRIPTION`
			`The`
Use err(3) instead of local redefinition. 1997-09-17 06:26:06 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`command creates a`
			`.Xr db 3`
			`hash access method database in`
Allow the path for /dev and the location of the database file to be overridden on the command line. This is useful for setting up chroot/jail environments. PR: bin/23509 Submitted by: Seth Kingsley <sethk@pike.osd.bsdi.com> MFC after: 1 week 2001-11-18 17:24:28 +00:00			`.Ar file`
mdoc(7) police: bump document date, fix markup. 2001-11-20 15:57:00 +00:00			`.Pa ( /var/run/dev.db`
Allow the path for /dev and the location of the database file to be overridden on the command line. This is useful for setting up chroot/jail environments. PR: bin/23509 Submitted by: Seth Kingsley <sethk@pike.osd.bsdi.com> MFC after: 1 week 2001-11-18 17:24:28 +00:00			`by default)`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`which contains the names of all of the character and block special`
Allow the path for /dev and the location of the database file to be overridden on the command line. This is useful for setting up chroot/jail environments. PR: bin/23509 Submitted by: Seth Kingsley <sethk@pike.osd.bsdi.com> MFC after: 1 week 2001-11-18 17:24:28 +00:00			`files in`
			`.Ar directory`
mdoc(7) police: bump document date, fix markup. 2001-11-20 15:57:00 +00:00			`.Pa ( /dev`
Allow the path for /dev and the location of the database file to be overridden on the command line. This is useful for setting up chroot/jail environments. PR: bin/23509 Submitted by: Seth Kingsley <sethk@pike.osd.bsdi.com> MFC after: 1 week 2001-11-18 17:24:28 +00:00			`by default), using the file type and the`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Fa st_rdev`
			`field as the key.`
			`.Pp`
mdoc(7) police: bump document date, fix markup. 2001-11-20 15:57:00 +00:00			`Keys are a structure containing a`
			`.Vt mode_t`
			`followed by a`
			`.Vt dev_t ,`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`with any padding zero'd out.`
mdoc(7) police: bump document date, fix markup. 2001-11-20 15:57:00 +00:00			`The former is the type of the file`
			`.Va ( st_mode Li & Dv S_IFMT ) ,`
			`the latter is the`
			`.Va st_rdev`
			`field.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh FILES`
mdoc(7) police: bump document date, fix markup. 2001-11-20 15:57:00 +00:00			`.Bl -tag -width ".Pa /var/run/dev.db" -compact`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Pa /dev`
Allow the path for /dev and the location of the database file to be overridden on the command line. This is useful for setting up chroot/jail environments. PR: bin/23509 Submitted by: Seth Kingsley <sethk@pike.osd.bsdi.com> MFC after: 1 week 2001-11-18 17:24:28 +00:00			`Default device directory.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Pa /var/run/dev.db`
Allow the path for /dev and the location of the database file to be overridden on the command line. This is useful for setting up chroot/jail environments. PR: bin/23509 Submitted by: Seth Kingsley <sethk@pike.osd.bsdi.com> MFC after: 1 week 2001-11-18 17:24:28 +00:00			`Default database file.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr ps 1 ,`
			`.Xr stat 2 ,`
			`.Xr db 3 ,`
			`.Xr devname 3 ,`
kvm_mkdb(8) no longer exists (in .Xr) and kvm_nlist(8) has even less to do with dev_mkdb(8) than it did before. 1999-12-27 08:01:11 +00:00			`.Xr ttyname 3`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh HISTORY`
			`The`
Use err(3) instead of local redefinition. 1997-09-17 06:26:06 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`command appeared in`
			`.Bx 4.4 .`