summaryrefslogtreecommitdiff
path: root/src/lib/libc/string/strmode.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libc/string/strmode.3')
-rw-r--r--src/lib/libc/string/strmode.378
1 files changed, 43 insertions, 35 deletions
diff --git a/src/lib/libc/string/strmode.3 b/src/lib/libc/string/strmode.3
index 1907e7ab03..5d371b38c8 100644
--- a/src/lib/libc/string/strmode.3
+++ b/src/lib/libc/string/strmode.3
@@ -1,5 +1,7 @@
1.\" Copyright (c) 1990, 1991 The Regents of the University of California. 1.\" $OpenBSD: strmode.3,v 1.15 2011/07/25 00:38:53 schwarze Exp $
2.\" All rights reserved. 2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\" The Regents of the University of California. All rights reserved.
3.\" 5.\"
4.\" Redistribution and use in source and binary forms, with or without 6.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions 7.\" modification, are permitted provided that the following conditions
@@ -9,11 +11,7 @@
9.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the 12.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution. 13.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software 14.\" 3. Neither the name of the University nor the names of its contributors
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 15.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission. 16.\" without specific prior written permission.
19.\" 17.\"
@@ -29,10 +27,9 @@
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE. 28.\" SUCH DAMAGE.
31.\" 29.\"
32.\" from: @(#)strmode.3 5.4 (Berkeley) 7/31/91 30.\" @(#)strmode.3 8.3 (Berkeley) 7/28/94
33.\" $Id: strmode.3,v 1.1.1.1 1995/10/18 08:42:22 deraadt Exp $
34.\" 31.\"
35.Dd July 31, 1991 32.Dd $Mdocdate: July 25 2011 $
36.Dt STRMODE 3 33.Dt STRMODE 3
37.Os 34.Os
38.Sh NAME 35.Sh NAME
@@ -45,15 +42,13 @@
45.Sh DESCRIPTION 42.Sh DESCRIPTION
46The 43The
47.Fn strmode 44.Fn strmode
48function 45function converts a file
49converts a file
50.Fa mode 46.Fa mode
51(the type and permission information associated with an inode, see 47(the type and permission information associated with an inode, see
52.Xr stat 2 ) 48.Xr stat 2 )
53into a symbolic string which is stored in the location referenced by 49into a symbolic string which is stored in the location referenced by
54.Fa bp . 50.Fa bp .
55This stored string is eleven characters in length plus a trailing 51This stored string is eleven characters in length plus a trailing NUL byte.
56.Dv NULL .
57.Pp 52.Pp
58The first character is the inode type, and will be one of the following: 53The first character is the inode type, and will be one of the following:
59.Pp 54.Pp
@@ -69,10 +64,10 @@ directory
69.It l 64.It l
70symbolic link 65symbolic link
71.It p 66.It p
72fifo 67FIFO
73.It s 68.It s
74socket 69socket
75.It ? 70.It \&?
76unknown inode type 71unknown inode type
77.El 72.El
78.Pp 73.Pp
@@ -80,46 +75,58 @@ The next nine characters encode three sets of permissions, in three
80characters each. 75characters each.
81The first three characters are the permissions for the owner of the 76The first three characters are the permissions for the owner of the
82file, the second three for the group the file belongs to, and the 77file, the second three for the group the file belongs to, and the
83third for the ``other'', or default, set of users. 78third for the
79.Dq other ,
80or default, set of users.
84.Pp 81.Pp
85Permission checking is done as specifically as possible. 82Permission checking is done as specifically as possible.
86If read permission is denied to the owner of a file in the first set 83If read permission is denied to the owner of a file in the first set
87of permissions, the owner of the file will not be able to read the file. 84of permissions, the owner of the file will not be able to read the file.
88This is true even if the owner is in the file's group and the group 85This is true even if the owner is in the file's group and the group
89permissions allow reading or the ``other'' permissions allow reading. 86permissions allow reading or the
87.Dq other
88permissions allow reading.
90.Pp 89.Pp
91If the first character of the three character set is an ``r'', the file is 90If the first character of the three character set is an
92readable for that set of users; if a dash ``\-'', it is not readable. 91.Sq r ,
92the file is readable for that set of users; if a dash
93.Pq Ql - ,
94it is not readable.
93.Pp 95.Pp
94If the second character of the three character set is a ``w'', the file is 96If the second character of the three character set is a
95writable for that set of users; if a dash ``\-'', it is not writable. 97.Sq w ,
98the file is writable for that set of users; if a dash
99.Pq Ql - ,
100it is not writable.
96.Pp 101.Pp
97The third character is the first of the following characters that apply: 102The third character is the first of the following characters that apply:
98.Bl -tag -width xxxx 103.Bl -tag -width xxxx
99.It S 104.It S
100If the character is part of the owner permissions and the file is not 105If the character is part of the owner permissions and the file is not
101executable or the directory is not searchable, by the owner, and the 106executable or the directory is not searchable by the owner, and the
102set-user-id bit is set. 107set-user-ID bit is set.
103.It S 108.It S
104If the character is part of the group permissions and the file is not 109If the character is part of the group permissions and the file is not
105executable or the directory is not searchable, by the group, and the 110executable or the directory is not searchable by the group, and the
106set-group-id bit is set. 111set-group-ID bit is set.
107.It T 112.It T
108If the character is part of the other permissions and the file is not 113If the character is part of the other permissions and the file is not
109executable or the directory is not searchable, by others, and the ``sticky'' 114executable or the directory is not searchable by others, and the
115.Dq sticky
110.Pq Dv S_ISVTX 116.Pq Dv S_ISVTX
111bit is set. 117bit is set.
112.It s 118.It s
113If the character is part of the owner permissions and the file is 119If the character is part of the owner permissions and the file is
114executable or the directory searchable, by the owner, and the set-user-id 120executable or the directory searchable by the owner, and the set-user-ID
115bit is set. 121bit is set.
116.It s 122.It s
117If the character is part of the group permissions and the file is 123If the character is part of the group permissions and the file is
118executable or the directory searchable, by the group, and the set-group-id 124executable or the directory searchable by the group, and the set-group-ID
119bit is set. 125bit is set.
120.It t 126.It t
121If the character is part of the other permissions and the file is 127If the character is part of the other permissions and the file is
122executable or the directory searchable, by others, and the ``sticky'' 128executable or the directory searchable by others, and the
129.Dq sticky
123.Pq Dv S_ISVTX 130.Pq Dv S_ISVTX
124bit is set. 131bit is set.
125.It x 132.It x
@@ -128,14 +135,15 @@ The file is executable or the directory is searchable.
128None of the above apply. 135None of the above apply.
129.El 136.El
130.Pp 137.Pp
131The last character is a plus sign ``+'' if any there are any alternate 138The last character is a plus sign
139.Pq Ql +
140if there are any alternate
132or additional access control methods associated with the inode, otherwise 141or additional access control methods associated with the inode, otherwise
133it will be a space. 142it will be a space.
134.Sh RETURN VALUES 143.Sh RETURN VALUES
135The 144The
136.Fn strmode 145.Fn strmode
137function 146function always returns 0.
138always returns 0.
139.Sh SEE ALSO 147.Sh SEE ALSO
140.Xr chmod 1 , 148.Xr chmod 1 ,
141.Xr find 1 , 149.Xr find 1 ,
@@ -145,5 +153,5 @@ always returns 0.
145.Sh HISTORY 153.Sh HISTORY
146The 154The
147.Fn strmode 155.Fn strmode
148function 156function first appeared in
149.Ud . 157.Bx 4.3 Reno .