lib/libc/gen/getdiskbyname.3

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