lib/libutil/getrawpartition.3

   1 .\"     $NetBSD: getrawpartition.3,v 1.9 2006/05/25 10:56:08 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Jason R. Thorpe.
   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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd May 24, 2006
  31 .Dt GETRAWPARTITION 3
  32 .Os
  33 .Sh NAME
  34 .Nm getrawpartition
  35 .Nd get the system
  36 .Dq raw
  37 partition
  38 .Sh LIBRARY
  39 .Lb libutil
  40 .Sh SYNOPSIS
  41 .In util.h
  42 .Ft int
  43 .Fn getrawpartition void
  44 .Sh DESCRIPTION
  45 .Fn getrawpartition
  46 returns the partition number (
  47 .Sq a
  48 == 0,
  49 .Sq b
  50 == 1, ...) of the
  51 .Dq raw
  52 partition of the system's disks,
  53 or \-1 in case of an error, setting the global
  54 .Va errno
  55 variable.
  56 The possible values for
  57 .Va errno
  58 are the same as in
  59 .Xr sysctl 3 .
  60 The
  61 .Dq raw
  62 partition is defined as the partition which provides access to the entire
  63 disk, regardless of the disk's partition map.
  64 .Sh SEE ALSO
  65 .Xr getmaxpartitions 3 ,
  66 .Xr sysctl 3
  67 .Sh HISTORY
  68 The
  69 .Nm
  70 function call appeared in
  71 .Nx 1.2 .