.\"	$NetBSD: getdiskbyname.3,v 1.13 2009/08/19 15:47:39 joerg Exp $
.\"
.\" Copyright (c) 1983, 1991, 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. 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.
.\"
.\"     @(#)getdiskbyname.3	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt GETDISKBYNAME 3
.Os
.Sh NAME
.Nm getdiskbyname ,
.Nm setdisktab
.Nd get generic disk description by its name
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/types.h
.In sys/disklabel.h
.In disktab.h
.Ft int
.Fn setdisktab "char *name"
.Ft struct disklabel *
.Fn getdiskbyname "const char *name"
.Sh DESCRIPTION
The
.Fn getdiskbyname
function
takes a disk name (e.g.
.Ql rm03 )
and returns a prototype disk label
describing its geometry information and the standard
disk partition tables.
All information is obtained from the
.Xr disktab 5
file.
.Pp
The
.Fn setdisktab
function changes the default
.Sy disktab
file name from
.Pa /etc/disktab
.Pq aka Dv _PATH_DISKTAB
to
.Fa name .
.Sh RETURN VALUES
.Fn getdiskbyname
returns a null pointer if the entry is not found in the current
.Pa disktab
file.
.Pp
.Fn setdisktab
returns 0 on success and \-1 if
.Fa name
is a null pointer or points to an empty string.
.Sh FILES
.Bl -tag -width /etc/disktab -compact
.It Pa /etc/disktab
the default database of disk types.
.El
.Sh SEE ALSO
.Xr disklabel 5 ,
.Xr disktab 5 ,
.Xr disklabel 8
.Sh HISTORY
The
.Fn getdiskbyname
function appeared in
.Bx 4.3 .
.Pp
The
.Fn setdisktab
function appeared in
.Nx 1.4 .
.Sh BUGS
The
.Fn getdiskbyname
function leaves its results in an internal static object and returns a
pointer to that object.
Subsequent calls will modify the same object.