xref: /freebsd/lib/libc/gen/getdiskbyname.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.\"
30.Dd June 4, 1993
31.Dt GETDISKBYNAME 3
32.Os
33.Sh NAME
34.Nm getdiskbyname
35.Nd get generic disk description by its name
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/disklabel.h
40.Ft struct disklabel *
41.Fn getdiskbyname "const char *name"
42.Sh DESCRIPTION
43The
44.Fn getdiskbyname
45function
46takes a disk name (e.g.\&
47.Ql rm03 )
48and returns a prototype disk label
49describing its geometry information and the standard
50disk partition tables.
51All information is obtained from
52the
53.Xr disktab 5
54file.
55.Sh SEE ALSO
56.Xr disktab 5 ,
57.Xr disklabel 8
58.Sh HISTORY
59The
60.Fn getdiskbyname
61function appeared in
62.Bx 4.3 .
63