1.\" $NetBSD: getdiskbyname.3,v 1.13 2009/08/19 15:47:39 joerg Exp $ 2.\" 3.\" Copyright (c) 1983, 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.\" @(#)getdiskbyname.3 8.1 (Berkeley) 6/4/93 31.\" 32.Dd June 4, 1993 33.Dt GETDISKBYNAME 3 34.Os 35.Sh NAME 36.Nm getdiskbyname , 37.Nm setdisktab 38.Nd get generic disk description by its name 39.Sh LIBRARY 40.Lb libc 41.Sh SYNOPSIS 42.In sys/types.h 43.In sys/disklabel.h 44.In disktab.h 45.Ft int 46.Fn setdisktab "char *name" 47.Ft struct disklabel * 48.Fn getdiskbyname "const char *name" 49.Sh DESCRIPTION 50The 51.Fn getdiskbyname 52function 53takes a disk name (e.g. 54.Ql rm03 ) 55and returns a prototype disk label 56describing its geometry information and the standard 57disk partition tables. 58All information is obtained from the 59.Xr disktab 5 60file. 61.Pp 62The 63.Fn setdisktab 64function changes the default 65.Sy disktab 66file name from 67.Pa /etc/disktab 68.Pq aka Dv _PATH_DISKTAB 69to 70.Fa name . 71.Sh RETURN VALUES 72.Fn getdiskbyname 73returns a null pointer if the entry is not found in the current 74.Pa disktab 75file. 76.Pp 77.Fn setdisktab 78returns 0 on success and \-1 if 79.Fa name 80is a null pointer or points to an empty string. 81.Sh FILES 82.Bl -tag -width /etc/disktab -compact 83.It Pa /etc/disktab 84the default database of disk types. 85.El 86.Sh SEE ALSO 87.Xr disklabel 5 , 88.Xr disktab 5 , 89.Xr disklabel 8 90.Sh HISTORY 91The 92.Fn getdiskbyname 93function appeared in 94.Bx 4.3 . 95.Pp 96The 97.Fn setdisktab 98function appeared in 99.Nx 1.4 . 100.Sh BUGS 101The 102.Fn getdiskbyname 103function leaves its results in an internal static object and returns a 104pointer to that object. 105Subsequent calls will modify the same object. 106