xref: /original-bsd/lib/libc/gen/getdiskbyname.3 (revision 4092c5cc)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)getdiskbyname.3	8.1 (Berkeley) 06/04/93
7.\"
8.Dd
9.Dt GETDISKBYNAME 3
10.Os BSD 4.2
11.Sh NAME
12.Nm getdiskbyname
13.Nd get generic disk description by its name
14.Sh SYNOPSIS
15.Fd #include <sys/disklabel.h>
16.Ft struct disklabel *
17.Fn getdiskbyname "const char *name"
18.Sh DESCRIPTION
19The
20.Fn getdiskbyname
21function
22takes a disk name (e.g.
23.Ql rm03 )
24and returns a prototype disk label
25describing its geometry information and the standard
26disk partition tables.  All information is obtained from
27the
28.Xr disktab 5
29file.
30.Sh SEE ALSO
31.Xr disklabel 5 ,
32.Xr disktab 5 ,
33.Xr disklabel 8
34.Sh HISTORY
35The
36.Fn getdiskbyname
37function appeared in
38.Bx 4.3 .
39