d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
968c0b406d
freebsd-skq/lib/libc/gen/devname.3

116 lines
3.2 KiB
Groff
Raw Normal View History

BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\" 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.
.\" 4. 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.
.\"
Merge from Lite2: man page updates
1997-03-11 11:47:52 +00:00
.\" @(#)devname.3 8.2 (Berkeley) 4/29/95
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\"
Add an EXAMPLES section[1], quote Nd, and bump doc date. PR: 53621 [1] Submitted by: Faried Nawaz <fn@hungry.com> [1]
2005-02-23 02:02:38 +00:00
.Dd February 22, 2005
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Dt DEVNAME 3
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 13:41:46 +00:00
.Os
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh NAME
.Nm devname
Add an EXAMPLES section[1], quote Nd, and bump doc date. PR: 53621 [1] Submitted by: Faried Nawaz <fn@hungry.com> [1]
2005-02-23 02:02:38 +00:00
.Nd "get device name"
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/stat.h
.In stdlib.h
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Ft char *
.Fn devname "dev_t dev" "mode_t type"
Add devname_r(3) which takes a buffer as argument.
2003-06-20 09:52:27 +00:00
.Ft char *
.Fn devname_r "dev_t dev" "mode_t type" "char *buf" "int len"
Add two new routines: fdevname() and fdevname_r(). A more elegant way of obtaining a name of a character device by its file descriptor on FreeBSD, is to use the FIODGNAME ioctl. Because a valid file descriptor implies a file descriptor is visible in /dev, it will always resolve a valid device name. I'm adding a more friendly wrapper for this ioctl, called fdevname(). It is a lot easier to use than devname() and also has better error handling. When a device name cannot be resolved, it will just return NULL instead of a generated device name that makes no sense. Discussed with: kib
2009-02-11 20:24:59 +00:00
.Ft char *
.Fn fdevname "int fd"
.Ft char *
.Fn fdevname_r "int fd" "char *buf" "int len"
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh DESCRIPTION
The
.Fn devname
function returns a pointer to the name of the block or character
device in
mdoc(7) police: bump document date to the date of the last interface change (revision 1.2 of devname.c on 1999/07/18), don't put quotes around a path, and use .Dv where appropriate.
2002-03-18 02:36:43 +00:00
.Pa /dev
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
with a device number of
.Fa dev ,
and a file type matching the one encoded in
.Fa type
mdoc(7) police: bump document date to the date of the last interface change (revision 1.2 of devname.c on 1999/07/18), don't put quotes around a path, and use .Dv where appropriate.
2002-03-18 02:36:43 +00:00
which must be one of
.Dv S_IFBLK
or
.Dv S_IFCHR .
Update to reflect reality; devname(3) hasn't returned NULL on failure since revision 1.2 of devname.c (1999/07/18). While I'm here, note, in the BUGS section, that the returned pointer is to a static buffer.
2002-03-18 02:32:53 +00:00
To find the right name,
.Fn devname
Add devname_r(3) which takes a buffer as argument.
2003-06-20 09:52:27 +00:00
asks the kernel via the
Update to reflect reality; devname(3) hasn't returned NULL on failure since revision 1.2 of devname.c (1999/07/18). While I'm here, note, in the BUGS section, that the returned pointer is to a static buffer.
2002-03-18 02:32:53 +00:00
.Va kern.devname
sysctl.
Add devname_r(3) which takes a buffer as argument.
2003-06-20 09:52:27 +00:00
If it is unable to come up with a suitable name,
Update to reflect reality; devname(3) hasn't returned NULL on failure since revision 1.2 of devname.c (1999/07/18). While I'm here, note, in the BUGS section, that the returned pointer is to a static buffer.
2002-03-18 02:32:53 +00:00
it will format the information encapsulated in
.Fa dev
and
.Fa type
in a human-readable format.
Add devname_r(3) which takes a buffer as argument.
2003-06-20 09:52:27 +00:00
.Pp
Add two new routines: fdevname() and fdevname_r(). A more elegant way of obtaining a name of a character device by its file descriptor on FreeBSD, is to use the FIODGNAME ioctl. Because a valid file descriptor implies a file descriptor is visible in /dev, it will always resolve a valid device name. I'm adding a more friendly wrapper for this ioctl, called fdevname(). It is a lot easier to use than devname() and also has better error handling. When a device name cannot be resolved, it will just return NULL instead of a generated device name that makes no sense. Discussed with: kib
2009-02-11 20:24:59 +00:00
The
.Fn fdevname
and
.Fn fdevname_r
function obtains the device name directly from a file descriptor
pointing to a character device.
If it is unable to come up with a suitable name, these functions will
return a NULL pointer.
.Pp
Add devname_r(3) which takes a buffer as argument.
2003-06-20 09:52:27 +00:00
.Fn devname
Add two new routines: fdevname() and fdevname_r(). A more elegant way of obtaining a name of a character device by its file descriptor on FreeBSD, is to use the FIODGNAME ioctl. Because a valid file descriptor implies a file descriptor is visible in /dev, it will always resolve a valid device name. I'm adding a more friendly wrapper for this ioctl, called fdevname(). It is a lot easier to use than devname() and also has better error handling. When a device name cannot be resolved, it will just return NULL instead of a generated device name that makes no sense. Discussed with: kib
2009-02-11 20:24:59 +00:00
and
.Fn fdevname
return the name stored in a static buffer which will be overwritten
Add devname_r(3) which takes a buffer as argument.
2003-06-20 09:52:27 +00:00
on subsequent calls.
.Fn devname_r
Add two new routines: fdevname() and fdevname_r(). A more elegant way of obtaining a name of a character device by its file descriptor on FreeBSD, is to use the FIODGNAME ioctl. Because a valid file descriptor implies a file descriptor is visible in /dev, it will always resolve a valid device name. I'm adding a more friendly wrapper for this ioctl, called fdevname(). It is a lot easier to use than devname() and also has better error handling. When a device name cannot be resolved, it will just return NULL instead of a generated device name that makes no sense. Discussed with: kib
2009-02-11 20:24:59 +00:00
and
.Fn fdevname_r
take a buffer and length as argument to avoid this problem.
Add an EXAMPLES section[1], quote Nd, and bump doc date. PR: 53621 [1] Submitted by: Faried Nawaz <fn@hungry.com> [1]
2005-02-23 02:02:38 +00:00
.Sh EXAMPLES
.Bd -literal -compact
int fd;
struct stat buf;
char *name;
fd = open("/dev/tun");
fstat(fd, &buf);
printf("devname is /dev/%s\en", devname(buf.st_rdev, S_IFCHR));
Add two new routines: fdevname() and fdevname_r(). A more elegant way of obtaining a name of a character device by its file descriptor on FreeBSD, is to use the FIODGNAME ioctl. Because a valid file descriptor implies a file descriptor is visible in /dev, it will always resolve a valid device name. I'm adding a more friendly wrapper for this ioctl, called fdevname(). It is a lot easier to use than devname() and also has better error handling. When a device name cannot be resolved, it will just return NULL instead of a generated device name that makes no sense. Discussed with: kib
2009-02-11 20:24:59 +00:00
printf("fdevname is /dev/%s\en", fdevname(fd));
Add an EXAMPLES section[1], quote Nd, and bump doc date. PR: 53621 [1] Submitted by: Faried Nawaz <fn@hungry.com> [1]
2005-02-23 02:02:38 +00:00
.Ed
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh SEE ALSO
mdoc(7): Fix common mistakes made in the SEE ALSO section.
2003-09-12 21:54:11 +00:00
.Xr stat 2
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh HISTORY
The
Update a bunch of man pages to use .Fn instead of .Nm when referencing funciton names.
1996-08-22 22:05:59 +00:00
.Fn devname
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
function appeared in
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Bx 4.4 .
Add two new routines: fdevname() and fdevname_r(). A more elegant way of obtaining a name of a character device by its file descriptor on FreeBSD, is to use the FIODGNAME ioctl. Because a valid file descriptor implies a file descriptor is visible in /dev, it will always resolve a valid device name. I'm adding a more friendly wrapper for this ioctl, called fdevname(). It is a lot easier to use than devname() and also has better error handling. When a device name cannot be resolved, it will just return NULL instead of a generated device name that makes no sense. Discussed with: kib
2009-02-11 20:24:59 +00:00
The
.Fn fdevname
function appeared in
.Fx 8.0 .
Reference in New Issue Copy Permalink