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.370
1 files changed, 42 insertions, 28 deletions
diff --git a/src/lib/libc/string/strmode.3 b/src/lib/libc/string/strmode.3
index 1907e7ab03..bf311f1f99 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.8 2000/04/21 15:24:20 aaron 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
@@ -29,10 +31,9 @@
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE. 32.\" SUCH DAMAGE.
31.\" 33.\"
32.\" from: @(#)strmode.3 5.4 (Berkeley) 7/31/91 34.\" @(#)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.\" 35.\"
35.Dd July 31, 1991 36.Dd July 28, 1994
36.Dt STRMODE 3 37.Dt STRMODE 3
37.Os 38.Os
38.Sh NAME 39.Sh NAME
@@ -45,15 +46,13 @@
45.Sh DESCRIPTION 46.Sh DESCRIPTION
46The 47The
47.Fn strmode 48.Fn strmode
48function 49function converts a file
49converts a file
50.Fa mode 50.Fa mode
51(the type and permission information associated with an inode, see 51(the type and permission information associated with an inode, see
52.Xr stat 2 ) 52.Xr stat 2 )
53into a symbolic string which is stored in the location referenced by 53into a symbolic string which is stored in the location referenced by
54.Fa bp . 54.Fa bp .
55This stored string is eleven characters in length plus a trailing 55This stored string is eleven characters in length plus a trailing null byte.
56.Dv NULL .
57.Pp 56.Pp
58The first character is the inode type, and will be one of the following: 57The first character is the inode type, and will be one of the following:
59.Pp 58.Pp
@@ -72,6 +71,8 @@ symbolic link
72fifo 71fifo
73.It s 72.It s
74socket 73socket
74.It w
75whiteout
75.It ? 76.It ?
76unknown inode type 77unknown inode type
77.El 78.El
@@ -80,46 +81,58 @@ The next nine characters encode three sets of permissions, in three
80characters each. 81characters each.
81The first three characters are the permissions for the owner of the 82The first three characters are the permissions for the owner of the
82file, the second three for the group the file belongs to, and the 83file, the second three for the group the file belongs to, and the
83third for the ``other'', or default, set of users. 84third for the
85.Dq other ,
86or default, set of users.
84.Pp 87.Pp
85Permission checking is done as specifically as possible. 88Permission checking is done as specifically as possible.
86If read permission is denied to the owner of a file in the first set 89If 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. 90of 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 91This is true even if the owner is in the file's group and the group
89permissions allow reading or the ``other'' permissions allow reading. 92permissions allow reading or the
93.Dq other
94permissions allow reading.
90.Pp 95.Pp
91If the first character of the three character set is an ``r'', the file is 96If the first character of the three character set is an
92readable for that set of users; if a dash ``\-'', it is not readable. 97.Sq r ,
98the file is readable for that set of users; if a dash
99.Pq Ql - ,
100it is not readable.
93.Pp 101.Pp
94If the second character of the three character set is a ``w'', the file is 102If the second character of the three character set is a
95writable for that set of users; if a dash ``\-'', it is not writable. 103.Sq w ,
104the file is writable for that set of users; if a dash
105.Pq Ql - ,
106it is not writable.
96.Pp 107.Pp
97The third character is the first of the following characters that apply: 108The third character is the first of the following characters that apply:
98.Bl -tag -width xxxx 109.Bl -tag -width xxxx
99.It S 110.It S
100If the character is part of the owner permissions and the file is not 111If 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 112executable or the directory is not searchable by the owner, and the
102set-user-id bit is set. 113set-user-ID bit is set.
103.It S 114.It S
104If the character is part of the group permissions and the file is not 115If 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 116executable or the directory is not searchable by the group, and the
106set-group-id bit is set. 117set-group-ID bit is set.
107.It T 118.It T
108If the character is part of the other permissions and the file is not 119If 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'' 120executable or the directory is not searchable by others, and the
121.Dq sticky
110.Pq Dv S_ISVTX 122.Pq Dv S_ISVTX
111bit is set. 123bit is set.
112.It s 124.It s
113If the character is part of the owner permissions and the file is 125If 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 126executable or the directory searchable by the owner, and the set-user-ID
115bit is set. 127bit is set.
116.It s 128.It s
117If the character is part of the group permissions and the file is 129If 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 130executable or the directory searchable by the group, and the set-group-ID
119bit is set. 131bit is set.
120.It t 132.It t
121If the character is part of the other permissions and the file is 133If the character is part of the other permissions and the file is
122executable or the directory searchable, by others, and the ``sticky'' 134executable or the directory searchable by others, and the
135.Dq sticky
123.Pq Dv S_ISVTX 136.Pq Dv S_ISVTX
124bit is set. 137bit is set.
125.It x 138.It x
@@ -128,14 +141,15 @@ The file is executable or the directory is searchable.
128None of the above apply. 141None of the above apply.
129.El 142.El
130.Pp 143.Pp
131The last character is a plus sign ``+'' if any there are any alternate 144The last character is a plus sign
145.Pq Ql +
146if there are any alternate
132or additional access control methods associated with the inode, otherwise 147or additional access control methods associated with the inode, otherwise
133it will be a space. 148it will be a space.
134.Sh RETURN VALUES 149.Sh RETURN VALUES
135The 150The
136.Fn strmode 151.Fn strmode
137function 152function always returns 0.
138always returns 0.
139.Sh SEE ALSO 153.Sh SEE ALSO
140.Xr chmod 1 , 154.Xr chmod 1 ,
141.Xr find 1 , 155.Xr find 1 ,
@@ -145,5 +159,5 @@ always returns 0.
145.Sh HISTORY 159.Sh HISTORY
146The 160The
147.Fn strmode 161.Fn strmode
148function 162function first appeared in
149.Ud . 163.Bx 4.4 .