[apple/libc.git] / string / FreeBSD / strmode.3

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