lib/libcr/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 .\"
  35 .Dd July 18, 1999
  36 .Dt DEVNAME 3
  37 .Os
  38 .Sh NAME
  39 .Nm devname
  40 .Nd get device name
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/stat.h
  45 .In stdlib.h
  46 .Ft char *
  47 .Fn devname "dev_t dev" "mode_t type"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn devname
  51 function returns a pointer to the name of the block or character
  52 device in
  53 .Pa /dev
  54 with a device number of
  55 .Fa dev ,
  56 and a file type matching the one encoded in
  57 .Fa type
  58 which must be one of
  59 .Dv S_IFBLK
  60 or
  61 .Dv S_IFCHR .
  62 To find the right name,
  63 .Fn devname
  64 first searches the device database created by
  65 .Xr dev_mkdb 8 ;
  66 if that fails, it asks the kernel via the
  67 .Va kern.devname
  68 sysctl.
  69 If it was still unable to come up with a suitable name,
  70 it will format the information encapsulated in
  71 .Fa dev
  72 and
  73 .Fa type
  74 in a human-readable format.
  75 .Sh SEE ALSO
  76 .Xr stat 2 ,
  77 .Xr dev_mkdb 8
  78 .Sh HISTORY
  79 The
  80 .Fn devname
  81 function appeared in
  82 .Bx 4.4 .
  83 .Sh BUGS
  84 The
  85 .Fn devname
  86 function returns a pointer to an internal static object;
  87 thus, subsequent calls will modify the same buffer.