lib/libutil/getdiskrawname.3

   1 .\"     $NetBSD: getdiskrawname.3,v 1.2 2012/04/08 16:06:23 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2012 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Christos Zoulas.
   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 .\"
  31 .Dd March 7, 2012
  32 .Dt GETDISKRAWNAME 3
  33 .Os
  34 .Sh NAME
  35 .Nm getdiskrawname
  36 .Nd get the the block/character device name for a disk
  37 .Sh LIBRARY
  38 .Lb libutil
  39 .Sh SYNOPSIS
  40 .In util.h
  41 .Ft const char *
  42 .Fn getdiskrawname "char *buf" "size_t buflen" "const char *name"
  43 .Ft const char *
  44 .Fn getdiskcookedname "char *buf" "size_t buflen" "const char *name"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn getdiskrawname
  48 function converts the
  49 .Fa name
  50 argument thar contains a path to a disk block device node to the
  51 path that contains the corresponding character device node.
  52 The
  53 .Fn getdiskcookedname
  54 function converts the
  55 .Fa name
  56 argument thar contains a path to a disk character device node to the
  57 path that contains the corresponding block device node.
  58 .Sh RETURN VALUES
  59 On success the absolute pathname of the underlying device node is returned.
  60 On failure
  61 .Dv NULL
  62 is returned and
  63 .Va errno
  64 contains the reason for the error.
  65 .Sh HISTORY
  66 The
  67 .Fn getdiskrawname
  68 and
  69 .Fn getdiskcookedname
  70 functions appeared in
  71 .Nx 7.0 .