| blob | 6334da17b547d7faf186c945a16a53d66c50275c |
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 .\" from: @(#)strmode.3 8.3 (Berkeley) 7/28/94
29 .\" $NetBSD: strmode.3,v 1.16 2003/08/07 16:43:51 agc 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 unistd.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 nul byte.
54 .Pp
55 The first character is the inode type, and will be one of the following:
56 .Pp
57 .Bl -tag -width flag -offset indent -compact
58 .It \-
59 regular file
60 .It a
61 regular file in archive state 1
62 .It A
63 regular file in archive state 2
64 .It b
65 block special
66 .It c
67 character special
68 .It d
69 directory
70 .It l
71 symbolic link
72 .It p
73 fifo
74 .It s
75 socket
76 .It w
77 whiteout
78 .It ?
79 unknown inode type
80 .El
81 .Pp
82 The next nine characters encode three sets of permissions, in three
83 characters each.
84 The first three characters are the permissions for the owner of the
85 file, the second three for the group the file belongs to, and the
86 third for the ``other'', or default, set of users.
87 .Pp
88 Permission checking is done as specifically as possible.
89 If read permission is denied to the owner of a file in the first set
90 of permissions, the owner of the file will not be able to read the file.
91 This is true even if the owner is in the file's group and the group
92 permissions allow reading or the ``other'' permissions allow reading.
93 .Pp
94 If the first character of the three character set is an ``r'', the file is
95 readable for that set of users; if a dash ``\-'', it is not readable.
96 .Pp
97 If the second character of the three character set is a ``w'', the file is
98 writable for that set of users; if a dash ``\-'', it is not writable.
99 .Pp
100 The third character is the first of the following characters that apply:
101 .Bl -tag -width xxxx
102 .It S
103 If the character is part of the owner permissions and the file is not
104 executable or the directory is not searchable by the owner, and the
105 set-user-id bit is set.
106 .It S
107 If the character is part of the group permissions and the file is not
108 executable or the directory is not searchable by the group, and the
109 set-group-id bit is set.
110 .It T
111 If the character is part of the other permissions and the file is not
112 executable or the directory is not searchable by others, and the ``sticky''
113 .Pq Dv S_ISVTX
114 bit is set.
115 .It s
116 If the character is part of the owner permissions and the file is
117 executable or the directory searchable by the owner, and the set-user-id
118 bit is set.
119 .It s
120 If the character is part of the group permissions and the file is
121 executable or the directory searchable by the group, and the set-group-id
122 bit is set.
123 .It t
124 If the character is part of the other permissions and the file is
125 executable or the directory searchable by others, and the ``sticky''
126 .Pq Dv S_ISVTX
127 bit is set.
128 .It x
129 The file is executable or the directory is searchable.
130 .It \-
131 None of the above apply.
132 .El
133 .Pp
134 The last character is a plus sign ``+'' if there are any alternative
135 or additional access control methods associated with the inode, otherwise
136 it will be a space.
137 .Pp
138 Archive state 1 and archive state 2 represent file system dependent
139 archive state for a file.
140 Most file systems do not retain file archive
141 state, and so will not report files in either archive state.
142 msdosfs will report a file in archive state 1 if it has been
143 archived more recently than modified.
144 Hierarchical storage systems may have multiple archive states for a
145 file and may define archive states 1 and 2 as appropriate.
146 .Sh SEE ALSO
147 .Xr chmod 1 ,
148 .Xr find 1 ,
149 .Xr stat 2 ,
150 .Xr getmode 3 ,
151 .Xr setmode 3
152 .Sh HISTORY
153 The
154 .Fn strmode
155 function first appeared in
156 .Bx 4.4 .