lib/libc/string/strmode.3

   1 .\" Copyright (c) 1990, 1991, 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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)strmode.3   8.3 (Berkeley) 7/28/94
  29 .\" $FreeBSD: src/lib/libc/string/strmode.3,v 1.10 2007/01/09 00:28:12 imp Exp $
  30 .\" $DragonFly: src/lib/libc/string/strmode.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  31 .\"
  32 .Dd July 28, 1994
  33 .Dt STRMODE 3
  34 .Os
  35 .Sh NAME
  36 .Nm strmode
  37 .Nd convert inode status information into a symbolic string
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In string.h
  42 .Ft void
  43 .Fn strmode "mode_t mode" "char *bp"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn strmode
  47 function
  48 converts a file
  49 .Fa mode
  50 (the type and permission information associated with an inode, see
  51 .Xr stat 2 )
  52 into a symbolic string which is stored in the location referenced by
  53 .Fa bp .
  54 This stored string is eleven characters in length plus a trailing
  55 .Dv NUL .
  56 .Pp
  57 The first character is the inode type, and will be one of the following:
  58 .Pp
  59 .Bl -tag -width flag -offset indent -compact
  60 .It \-
  61 regular file
  62 .It b
  63 block special
  64 .It c
  65 character special
  66 .It d
  67 directory
  68 .It l
  69 symbolic link
  70 .It p
  71 fifo
  72 .It s
  73 socket
  74 .It w
  75 whiteout
  76 .It ?
  77 unknown inode type
  78 .El
  79 .Pp
  80 The next nine characters encode three sets of permissions, in three
  81 characters each.
  82 The first three characters are the permissions for the owner of the
  83 file, the second three for the group the file belongs to, and the
  84 third for the ``other'', or default, set of users.
  85 .Pp
  86 Permission checking is done as specifically as possible.
  87 If read permission is denied to the owner of a file in the first set
  88 of permissions, the owner of the file will not be able to read the file.
  89 This is true even if the owner is in the file's group and the group
  90 permissions allow reading or the ``other'' permissions allow reading.
  91 .Pp
  92 If the first character of the three character set is an ``r'', the file is
  93 readable for that set of users; if a dash ``\-'', it is not readable.
  94 .Pp
  95 If the second character of the three character set is a ``w'', the file is
  96 writable for that set of users; if a dash ``\-'', it is not writable.
  97 .Pp
  98 The third character is the first of the following characters that apply:
  99 .Bl -tag -width xxxx
 100 .It S
 101 If the character is part of the owner permissions and the file is not
 102 executable or the directory is not searchable by the owner, and the
 103 set-user-id bit is set.
 104 .It S
 105 If the character is part of the group permissions and the file is not
 106 executable or the directory is not searchable by the group, and the
 107 set-group-id bit is set.
 108 .It T
 109 If the character is part of the other permissions and the file is not
 110 executable or the directory is not searchable by others, and the ``sticky''
 111 .Pq Dv S_ISVTX
 112 bit is set.
 113 .It s
 114 If the character is part of the owner permissions and the file is
 115 executable or the directory searchable by the owner, and the set-user-id
 116 bit is set.
 117 .It s
 118 If the character is part of the group permissions and the file is
 119 executable or the directory searchable by the group, and the set-group-id
 120 bit is set.
 121 .It t
 122 If the character is part of the other permissions and the file is
 123 executable or the directory searchable by others, and the ``sticky''
 124 .Pq Dv S_ISVTX
 125 bit is set.
 126 .It x
 127 The file is executable or the directory is searchable.
 128 .It \-
 129 None of the above apply.
 130 .El
 131 .Pp
 132 The last character is a plus sign ``+'' if any there are any alternate
 133 or additional access control methods associated with the inode, otherwise
 134 it will be a space.
 135 .Sh SEE ALSO
 136 .Xr chmod 1 ,
 137 .Xr find 1 ,
 138 .Xr stat 2 ,
 139 .Xr getmode 3 ,
 140 .Xr setmode 3
 141 .Sh HISTORY
 142 The
 143 .Fn strmode
 144 function first appeared in
 145 .Bx 4.4 .