diff options
Diffstat (limited to 'src/lib/libc/string/strmode.3')
-rw-r--r-- | src/lib/libc/string/strmode.3 | 153 |
1 files changed, 0 insertions, 153 deletions
diff --git a/src/lib/libc/string/strmode.3 b/src/lib/libc/string/strmode.3 deleted file mode 100644 index 8135d30ba1..0000000000 --- a/src/lib/libc/string/strmode.3 +++ /dev/null | |||
@@ -1,153 +0,0 @@ | |||
1 | .\" $OpenBSD: strmode.3,v 1.17 2017/07/05 11:44:35 tb Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 1990, 1991, 1993 | ||
4 | .\" The Regents of the University of California. All rights reserved. | ||
5 | .\" | ||
6 | .\" Redistribution and use in source and binary forms, with or without | ||
7 | .\" modification, are permitted provided that the following conditions | ||
8 | .\" are met: | ||
9 | .\" 1. Redistributions of source code must retain the above copyright | ||
10 | .\" notice, this list of conditions and the following disclaimer. | ||
11 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
12 | .\" notice, this list of conditions and the following disclaimer in the | ||
13 | .\" documentation and/or other materials provided with the distribution. | ||
14 | .\" 3. Neither the name of the University nor the names of its contributors | ||
15 | .\" may be used to endorse or promote products derived from this software | ||
16 | .\" without specific prior written permission. | ||
17 | .\" | ||
18 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
19 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
20 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
21 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
22 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
23 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
24 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
25 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
26 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
27 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
28 | .\" SUCH DAMAGE. | ||
29 | .\" | ||
30 | .\" @(#)strmode.3 8.3 (Berkeley) 7/28/94 | ||
31 | .\" | ||
32 | .Dd $Mdocdate: July 5 2017 $ | ||
33 | .Dt STRMODE 3 | ||
34 | .Os | ||
35 | .Sh NAME | ||
36 | .Nm strmode | ||
37 | .Nd convert inode status information into a symbolic string | ||
38 | .Sh SYNOPSIS | ||
39 | .In string.h | ||
40 | .Ft void | ||
41 | .Fn strmode "mode_t mode" "char *bp" | ||
42 | .Sh DESCRIPTION | ||
43 | The | ||
44 | .Fn strmode | ||
45 | function converts a file | ||
46 | .Fa mode | ||
47 | (the type and permission information associated with an inode, see | ||
48 | .Xr stat 2 ) | ||
49 | into a symbolic string which is stored in the location referenced by | ||
50 | .Fa bp . | ||
51 | This stored string is eleven characters in length plus a trailing NUL byte. | ||
52 | .Pp | ||
53 | The first character is the inode type, and will be one of the following: | ||
54 | .Pp | ||
55 | .Bl -tag -width flag -offset indent -compact | ||
56 | .It \- | ||
57 | regular file | ||
58 | .It b | ||
59 | block special | ||
60 | .It c | ||
61 | character special | ||
62 | .It d | ||
63 | directory | ||
64 | .It l | ||
65 | symbolic link | ||
66 | .It p | ||
67 | FIFO | ||
68 | .It s | ||
69 | socket | ||
70 | .It \&? | ||
71 | unknown inode type | ||
72 | .El | ||
73 | .Pp | ||
74 | The next nine characters encode three sets of permissions, in three | ||
75 | characters each. | ||
76 | The first three characters are the permissions for the owner of the | ||
77 | file, the second three for the group the file belongs to, and the | ||
78 | third for the | ||
79 | .Dq other , | ||
80 | or default, set of users. | ||
81 | .Pp | ||
82 | Permission checking is done as specifically as possible. | ||
83 | If read permission is denied to the owner of a file in the first set | ||
84 | of permissions, the owner of the file will not be able to read the file. | ||
85 | This is true even if the owner is in the file's group and the group | ||
86 | permissions allow reading or the | ||
87 | .Dq other | ||
88 | permissions allow reading. | ||
89 | .Pp | ||
90 | If the first character of the three character set is an | ||
91 | .Sq r , | ||
92 | the file is readable for that set of users; if a dash | ||
93 | .Pq Ql - , | ||
94 | it is not readable. | ||
95 | .Pp | ||
96 | If the second character of the three character set is a | ||
97 | .Sq w , | ||
98 | the file is writable for that set of users; if a dash | ||
99 | .Pq Ql - , | ||
100 | it is not writable. | ||
101 | .Pp | ||
102 | The third character is the first of the following characters that apply: | ||
103 | .Bl -tag -width xxxx | ||
104 | .It S | ||
105 | If the character is part of the owner permissions and the file is not | ||
106 | executable or the directory is not searchable by the owner, and the | ||
107 | set-user-ID bit is set. | ||
108 | .It S | ||
109 | If the character is part of the group permissions and the file is not | ||
110 | executable or the directory is not searchable by the group, and the | ||
111 | set-group-ID bit is set. | ||
112 | .It T | ||
113 | If the character is part of the other permissions and the file is not | ||
114 | executable or the directory is not searchable by others, and the | ||
115 | .Dq sticky | ||
116 | .Pq Dv S_ISVTX | ||
117 | bit is set. | ||
118 | .It s | ||
119 | If the character is part of the owner permissions and the file is | ||
120 | executable or the directory searchable by the owner, and the set-user-ID | ||
121 | bit is set. | ||
122 | .It s | ||
123 | If the character is part of the group permissions and the file is | ||
124 | executable or the directory searchable by the group, and the set-group-ID | ||
125 | bit is set. | ||
126 | .It t | ||
127 | If the character is part of the other permissions and the file is | ||
128 | executable or the directory searchable by others, and the | ||
129 | .Dq 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 | ||
139 | .Pq Ql + | ||
140 | if there are any alternate | ||
141 | or additional access control methods associated with the inode, otherwise | ||
142 | it will be a space. | ||
143 | .Sh SEE ALSO | ||
144 | .Xr chmod 1 , | ||
145 | .Xr find 1 , | ||
146 | .Xr stat 2 , | ||
147 | .Xr getmode 3 , | ||
148 | .Xr setmode 3 | ||
149 | .Sh HISTORY | ||
150 | The | ||
151 | .Fn strmode | ||
152 | function first appeared in | ||
153 | .Bx 4.3 Reno . | ||