xref: /freebsd/lib/libc/gen/getdiskbyname.3 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)getdiskbyname.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD$
30.\"
31.Dd June 4, 1993
32.Dt GETDISKBYNAME 3
33.Os
34.Sh NAME
35.Nm getdiskbyname
36.Nd get generic disk description by its name
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In sys/disklabel.h
41.Ft struct disklabel *
42.Fn getdiskbyname "const char *name"
43.Sh DESCRIPTION
44The
45.Fn getdiskbyname
46function
47takes a disk name (e.g.\&
48.Ql rm03 )
49and returns a prototype disk label
50describing its geometry information and the standard
51disk partition tables.
52All information is obtained from
53the
54.Xr disktab 5
55file.
56.Sh SEE ALSO
57.Xr disktab 5 ,
58.Xr disklabel 8
59.Sh HISTORY
60The
61.Fn getdiskbyname
62function appeared in
63.Bx 4.3 .
64