NetBSD/lib/libutil/getdiskrawname.3

72 lines
2.5 KiB
Groff

.\" $NetBSD: getdiskrawname.3,v 1.2 2012/04/08 16:06:23 wiz Exp $
.\"
.\" Copyright (c) 2012 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Christos Zoulas.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd March 7, 2012
.Dt GETDISKRAWNAME 3
.Os
.Sh NAME
.Nm getdiskrawname
.Nd get the the block/character device name for a disk
.Sh LIBRARY
.Lb libutil
.Sh SYNOPSIS
.In util.h
.Ft const char *
.Fn getdiskrawname "char *buf" "size_t buflen" "const char *name"
.Ft const char *
.Fn getdiskcookedname "char *buf" "size_t buflen" "const char *name"
.Sh DESCRIPTION
The
.Fn getdiskrawname
function converts the
.Fa name
argument thar contains a path to a disk block device node to the
path that contains the corresponding character device node.
The
.Fn getdiskcookedname
function converts the
.Fa name
argument thar contains a path to a disk character device node to the
path that contains the corresponding block device node.
.Sh RETURN VALUES
On success the absolute pathname of the underlying device node is returned.
On failure
.Dv NULL
is returned and
.Va errno
contains the reason for the error.
.Sh HISTORY
The
.Fn getdiskrawname
and
.Fn getdiskcookedname
functions appeared in
.Nx 7.0 .