xref: /freebsd/lib/libc/gen/getdiskbyname.3 (revision d82e286489da73321a47e329d98a98817b0438b6)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)getdiskbyname.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd June 4, 1993
35.Dt GETDISKBYNAME 3
36.Os BSD 4.2
37.Sh NAME
38.Nm getdiskbyname
39.Nd get generic disk description by its name
40.Sh SYNOPSIS
41.Fd #include <sys/disklabel.h>
42.Ft struct disklabel *
43.Fn getdiskbyname "const char *name"
44.Sh DESCRIPTION
45The
46.Fn getdiskbyname
47function
48takes a disk name (e.g.
49.Ql rm03 )
50and returns a prototype disk label
51describing its geometry information and the standard
52disk partition tables.  All information is obtained from
53the
54.Xr disktab 5
55file.
56.Sh SEE ALSO
57.Xr disklabel 5 ,
58.Xr disktab 5 ,
59.Xr disklabel 8
60.Sh HISTORY
61The
62.Fn getdiskbyname
63function appeared in
64.Bx 4.3 .
65