lib/libutil/getlabelsector.3

   1 .\"     $NetBSD: getlabelsector.3,v 1.4 2003/04/16 13:35:14 wiz Exp $
   2 .\"
   3 .\"
   4 .\" Copyright 2002 Wasabi Systems, Inc.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Written by Steve C. Woodford for Wasabi Systems, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"      This product includes software developed for the NetBSD Project by
  20 .\"      Wasabi Systems, Inc.
  21 .\" 4. The name of Wasabi Systems, Inc. may not be used to endorse
  22 .\"    or promote products derived from this software without specific prior
  23 .\"    written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .Dd December 11, 2002
  38 .Dt GETLABELSECTOR 3
  39 .Os
  40 .Sh NAME
  41 .Nm getlabelsector ,
  42 .Nm getlabeloffset
  43 .Nd get the sector number and offset of the disklabel
  44 .Sh LIBRARY
  45 .Lb libutil
  46 .Sh SYNOPSIS
  47 .In util.h
  48 .Ft daddr_t
  49 .Fn getlabelsector void
  50 .Ft off_t
  51 .Fn getlabeloffset void
  52 .Sh DESCRIPTION
  53 The
  54 .Fn getlabelsector
  55 and
  56 .Fn getlabeloffset
  57 functions return values which describe the exact on-disk location of the
  58 .Xr disklabel 5
  59 on the current system, or \-1 on error.
  60 These functions supersede the hardcoded
  61 .Dv LABELSECTOR
  62 and
  63 .Dv LABELOFFSET
  64 definitions previously used to derive the location of the
  65 .Xr disklabel 5 .
  66 .Sh SEE ALSO
  67 .Xr sysctl 3 ,
  68 .Xr disklabel 5
  69 .Sh HISTORY
  70 The
  71 .Fn getlabelsector
  72 and
  73 .Fn getlabeloffset
  74 functions appeared in
  75 .Nx 2.0 .