lib/libc/gen/devname.3

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)devname.3   8.2 (Berkeley) 4/29/95
  33 .\" $FreeBSD: src/lib/libc/gen/devname.3,v 1.7.2.7 2003/03/15 15:11:05 trhodes Exp $
  34 .\" $DragonFly: src/lib/libc/gen/devname.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd July 18, 1999
  37 .Dt DEVNAME 3
  38 .Os
  39 .Sh NAME
  40 .Nm devname
  41 .Nd get device name
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/stat.h
  46 .In stdlib.h
  47 .Ft char *
  48 .Fn devname "dev_t dev" "mode_t type"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn devname
  52 function returns a pointer to the name of the block or character
  53 device in
  54 .Pa /dev
  55 with a device number of
  56 .Fa dev ,
  57 and a file type matching the one encoded in
  58 .Fa type
  59 which must be one of
  60 .Dv S_IFBLK
  61 or
  62 .Dv S_IFCHR .
  63 To find the right name,
  64 .Fn devname
  65 first searches the device database created by
  66 .Xr dev_mkdb 8 ;
  67 if that fails, it asks the kernel via the
  68 .Va kern.devname
  69 sysctl.
  70 If it was still unable to come up with a suitable name,
  71 it will format the information encapsulated in
  72 .Fa dev
  73 and
  74 .Fa type
  75 in a human-readable format.
  76 .Sh SEE ALSO
  77 .Xr stat 2 ,
  78 .Xr dev_mkdb 8
  79 .Sh HISTORY
  80 The
  81 .Fn devname
  82 function appeared in
  83 .Bx 4.4 .
  84 .Sh BUGS
  85 The
  86 .Fn devname
  87 function returns a pointer to an internal static object;
  88 thus, subsequent calls will modify the same buffer.