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. 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 .\"     @(#)strmode.3   8.3 (Berkeley) 7/28/94
  33 .\" $FreeBSD: src/lib/libc/string/strmode.3,v 1.6.2.2 2001/12/14 18:33:59 ru Exp $
  34 .\" $DragonFly: src/lib/libc/string/strmode.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  35 .\"
  36 .Dd July 28, 1994
  37 .Dt STRMODE 3
  38 .Os
  39 .Sh NAME
  40 .Nm strmode
  41 .Nd convert inode status information into a symbolic string
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In string.h
  46 .Ft void
  47 .Fn strmode "mode_t mode" "char *bp"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn strmode
  51 function
  52 converts a file
  53 .Fa mode
  54 (the type and permission information associated with an inode, see
  55 .Xr stat 2 )
  56 into a symbolic string which is stored in the location referenced by
  57 .Fa bp .
  58 This stored string is eleven characters in length plus a trailing
  59 .Dv NUL .
  60 .Pp
  61 The first character is the inode type, and will be one of the following:
  62 .Pp
  63 .Bl -tag -width flag -offset indent -compact
  64 .It \-
  65 regular file
  66 .It b
  67 block special
  68 .It c
  69 character special
  70 .It d
  71 directory
  72 .It l
  73 symbolic link
  74 .It p
  75 fifo
  76 .It s
  77 socket
  78 .It w
  79 whiteout
  80 .It ?
  81 unknown inode type
  82 .El
  83 .Pp
  84 The next nine characters encode three sets of permissions, in three
  85 characters each.
  86 The first three characters are the permissions for the owner of the
  87 file, the second three for the group the file belongs to, and the
  88 third for the ``other'', or default, set of users.
  89 .Pp
  90 Permission checking is done as specifically as possible.
  91 If read permission is denied to the owner of a file in the first set
  92 of permissions, the owner of the file will not be able to read the file.
  93 This is true even if the owner is in the file's group and the group
  94 permissions allow reading or the ``other'' permissions allow reading.
  95 .Pp
  96 If the first character of the three character set is an ``r'', the file is
  97 readable for that set of users; if a dash ``\-'', it is not readable.
  98 .Pp
  99 If the second character of the three character set is a ``w'', the file is
 100 writable for that set of users; if a dash ``\-'', it is not writable.
 101 .Pp
 102 The third character is the first of the following characters that apply:
 103 .Bl -tag -width xxxx
 104 .It S
 105 If the character is part of the owner permissions and the file is not
 106 executable or the directory is not searchable by the owner, and the
 107 set-user-id bit is set.
 108 .It S
 109 If the character is part of the group permissions and the file is not
 110 executable or the directory is not searchable by the group, and the
 111 set-group-id bit is set.
 112 .It T
 113 If the character is part of the other permissions and the file is not
 114 executable or the directory is not searchable by others, and the ``sticky''
 115 .Pq Dv S_ISVTX
 116 bit is set.
 117 .It s
 118 If the character is part of the owner permissions and the file is
 119 executable or the directory searchable by the owner, and the set-user-id
 120 bit is set.
 121 .It s
 122 If the character is part of the group permissions and the file is
 123 executable or the directory searchable by the group, and the set-group-id
 124 bit is set.
 125 .It t
 126 If the character is part of the other permissions and the file is
 127 executable or the directory searchable by others, and the ``sticky''
 128 .Pq Dv S_ISVTX
 129 bit is set.
 130 .It x
 131 The file is executable or the directory is searchable.
 132 .It \-
 133 None of the above apply.
 134 .El
 135 .Pp
 136 The last character is a plus sign ``+'' if any there are any alternate
 137 or additional access control methods associated with the inode, otherwise
 138 it will be a space.
 139 .Sh RETURN VALUES
 140 The
 141 .Fn strmode
 142 function
 143 always returns 0.
 144 .Sh SEE ALSO
 145 .Xr chmod 1 ,
 146 .Xr find 1 ,
 147 .Xr stat 2 ,
 148 .Xr getmode 3 ,
 149 .Xr setmode 3
 150 .Sh HISTORY
 151 The
 152 .Fn strmode
 153 function first appeared in
 154 .Bx 4.4 .