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