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