1.\" $NetBSD: getdiskbyname.3,v 1.10 2002/10/01 16:59:46 wiz 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. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)getdiskbyname.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd June 4, 1993 37.Dt GETDISKBYNAME 3 38.Os 39.Sh NAME 40.Nm getdiskbyname , 41.Nm setdisktab 42.Nd get generic disk description by its name 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.Fd #include \*[Lt]sys/types.h\*[Gt] 47.Fd #include \*[Lt]sys/disklabel.h\*[Gt] 48.Fd #include \*[Lt]disktab.h\*[Gt] 49.Ft int 50.Fn setdisktab "char *name" 51.Ft struct disklabel * 52.Fn getdiskbyname "const char *name" 53.Sh DESCRIPTION 54The 55.Fn getdiskbyname 56function 57takes a disk name (e.g. 58.Ql rm03 ) 59and returns a prototype disk label 60describing its geometry information and the standard 61disk partition tables. 62All information is obtained from the 63.Xr disktab 5 64file. 65.Pp 66The 67.Fn setdisktab 68function changes the default 69.Pn disktab 70file name from 71.Pa /etc/disktab 72.Pq aka Dv _PATH_DISKTAB 73to 74.Fa name . 75.Sh RETURN VALUES 76.Fn getdiskbyname 77returns a null pointer if the entry is not found in the current 78.Pa disktab 79file. 80.Pp 81.Fn setdisktab 82returns 0 on success and \-1 if 83.Fa name 84is a null pointer or points to an empty string. 85.Sh FILES 86.Bl -tag -width /etc/disktab -compact 87.It Pa /etc/disktab 88the default database of disk types. 89.El 90.Sh SEE ALSO 91.Xr disklabel 5 , 92.Xr disktab 5 , 93.Xr disklabel 8 94.Sh HISTORY 95The 96.Fn getdiskbyname 97function appeared in 98.Bx 4.3 . 99.Pp 100The 101.Fn setdisktab 102function appeared in 103.Nx 1.4 . 104.Sh BUGS 105The 106.Fn getdiskbyname 107function leaves its results in an internal static object and returns a 108pointer to that object. 109Subsequent calls will modify the same object. 110