lib/libutil/getlabelsector.3

   1 .\"     $NetBSD: getlabelsector.3,v 1.8 2011/09/14 11:43:29 njoly 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 August 25, 2011
  38 .Dt GETLABELSECTOR 3
  39 .Os
  40 .Sh NAME
  41 .Nm getlabelsector ,
  42 .Nm getlabeloffset ,
  43 .Nm getlabelusesmbr
  44 .Nd get disklabel location informations
  45 .Sh LIBRARY
  46 .Lb libutil
  47 .Sh SYNOPSIS
  48 .In util.h
  49 .Ft daddr_t
  50 .Fn getlabelsector void
  51 .Ft off_t
  52 .Fn getlabeloffset void
  53 .Ft int
  54 .Fn getlabelusesmbr void
  55 .Sh DESCRIPTION
  56 The
  57 .Fn getlabelsector
  58 and
  59 .Fn getlabeloffset
  60 functions return values which describe the exact on-disk location of the
  61 .Xr disklabel 5
  62 on the current system, or \-1 on error.
  63 These functions supersede the hardcoded
  64 .Dv LABELSECTOR
  65 and
  66 .Dv LABELOFFSET
  67 definitions previously used to derive the location of the
  68 .Xr disklabel 5 .
  69 .Pp
  70 The
  71 .Fn getlabelusesmbr
  72 returns 1 if the disklabel is located inside a MBR partition, 0 if it's stored
  73 relative to the start of the disk, or \-1 on error.
  74 .Sh SEE ALSO
  75 .Xr sysctl 3 ,
  76 .Xr disklabel 5
  77 .Sh HISTORY
  78 The
  79 .Fn getlabelsector
  80 and
  81 .Fn getlabeloffset
  82 functions appeared in
  83 .Nx 2.0 .