128 lines
3.5 KiB
Groff
128 lines
3.5 KiB
Groff
.\" $NetBSD: devname.3,v 1.17 2017/09/10 10:12:43 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c) 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" 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.
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
|
|
.\"
|
|
.\" @(#)devname.3 8.2 (Berkeley) 4/29/95
|
|
.\"
|
|
.Dd September 9, 2017
|
|
.Dt DEVNAME 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm devname ,
|
|
.Nm devname_r
|
|
.Nd get device name
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In stdlib.h
|
|
.In sys/stat.h
|
|
.Ft char *
|
|
.Fn devname "dev_t dev" "mode_t type"
|
|
.Ft int
|
|
.Fn devname_r "dev_t dev" "mode_t type" "char *path" "size_t len"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn devname
|
|
function returns a pointer to the static buffer with the name of the
|
|
block or character device in
|
|
.Dq Pa /dev
|
|
with a device number of
|
|
.Fa dev ,
|
|
and a file type matching the one encoded in
|
|
.Fa type
|
|
which must be one of S_IFBLK or S_IFCHR.
|
|
If no device matches the specified values, or no information is
|
|
available,
|
|
.Dv NULL
|
|
is returned.
|
|
.Pp
|
|
The
|
|
.Fn devname_r
|
|
function is a reentrant and thread-safe version of
|
|
.Fn devname .
|
|
This function returns the device name by copying it into the
|
|
.Fa path
|
|
argument with up to
|
|
.Fa len
|
|
characters.
|
|
The
|
|
.Fa path
|
|
argument is always nul-terminated.
|
|
.Pp
|
|
The traditional display for applications when no device is
|
|
found is the string
|
|
.Dq ?? .
|
|
.Sh RETURN VALUES
|
|
If successful,
|
|
.Fn devname
|
|
returns a pointer to a nul-terminated string containing the name of the device.
|
|
If an error occurs
|
|
.Fa devname
|
|
will return
|
|
.Dv NULL .
|
|
.Pp
|
|
If successful,
|
|
.Fn devname_r
|
|
places a nul-terminated string containing the name of the device in
|
|
the buffer pointed to by
|
|
.Ar path
|
|
and returns 0.
|
|
If an error occurs
|
|
.Fn devname_r
|
|
will return an error number from
|
|
.In sys/errno.h
|
|
indicating what went wrong.
|
|
.Sh FILES
|
|
.Bl -tag -width /var/run/dev.cdb -compact
|
|
.It Pa /var/run/dev.cdb
|
|
Device database file.
|
|
.El
|
|
.Sh ERRORS
|
|
The
|
|
.Fn devname_r
|
|
function may fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er ENOENT
|
|
The corresponding device does not exist.
|
|
.It Bq Er ERANGE
|
|
The passed buffer length is too short.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr stat 2 ,
|
|
.Xr dev_mkdb 8
|
|
.Sh HISTORY
|
|
The
|
|
.Nm devname
|
|
function call appeared in
|
|
.Bx 4.4 .
|
|
.Pp
|
|
The
|
|
.Fn devname_r
|
|
function first appeared in
|
|
.Nx 6.0 .
|