1.\" $OpenBSD: strmode.3,v 1.10 2003/06/02 20:18:38 millert 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 July 28, 1994 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.Fd #include <string.h> 40.Ft void 41.Fn strmode "mode_t mode" "char *bp" 42.Sh DESCRIPTION 43The 44.Fn strmode 45function converts a file 46.Fa mode 47(the type and permission information associated with an inode, see 48.Xr stat 2 ) 49into a symbolic string which is stored in the location referenced by 50.Fa bp . 51This stored string is eleven characters in length plus a trailing null byte. 52.Pp 53The 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 \- 57regular file 58.It b 59block special 60.It c 61character special 62.It d 63directory 64.It l 65symbolic link 66.It p 67FIFO 68.It s 69socket 70.It w 71whiteout 72.It ? 73unknown inode type 74.El 75.Pp 76The next nine characters encode three sets of permissions, in three 77characters each. 78The first three characters are the permissions for the owner of the 79file, the second three for the group the file belongs to, and the 80third for the 81.Dq other , 82or default, set of users. 83.Pp 84Permission checking is done as specifically as possible. 85If read permission is denied to the owner of a file in the first set 86of permissions, the owner of the file will not be able to read the file. 87This is true even if the owner is in the file's group and the group 88permissions allow reading or the 89.Dq other 90permissions allow reading. 91.Pp 92If the first character of the three character set is an 93.Sq r , 94the file is readable for that set of users; if a dash 95.Pq Ql - , 96it is not readable. 97.Pp 98If the second character of the three character set is a 99.Sq w , 100the file is writable for that set of users; if a dash 101.Pq Ql - , 102it is not writable. 103.Pp 104The third character is the first of the following characters that apply: 105.Bl -tag -width xxxx 106.It S 107If the character is part of the owner permissions and the file is not 108executable or the directory is not searchable by the owner, and the 109set-user-ID bit is set. 110.It S 111If the character is part of the group permissions and the file is not 112executable or the directory is not searchable by the group, and the 113set-group-ID bit is set. 114.It T 115If the character is part of the other permissions and the file is not 116executable or the directory is not searchable by others, and the 117.Dq sticky 118.Pq Dv S_ISVTX 119bit is set. 120.It s 121If the character is part of the owner permissions and the file is 122executable or the directory searchable by the owner, and the set-user-ID 123bit is set. 124.It s 125If the character is part of the group permissions and the file is 126executable or the directory searchable by the group, and the set-group-ID 127bit is set. 128.It t 129If the character is part of the other permissions and the file is 130executable or the directory searchable by others, and the 131.Dq sticky 132.Pq Dv S_ISVTX 133bit is set. 134.It x 135The file is executable or the directory is searchable. 136.It \- 137None of the above apply. 138.El 139.Pp 140The last character is a plus sign 141.Pq Ql + 142if there are any alternate 143or additional access control methods associated with the inode, otherwise 144it will be a space. 145.Sh RETURN VALUES 146The 147.Fn strmode 148function always returns 0. 149.Sh SEE ALSO 150.Xr chmod 1 , 151.Xr find 1 , 152.Xr stat 2 , 153.Xr getmode 3 , 154.Xr setmode 3 155.Sh HISTORY 156The 157.Fn strmode 158function first appeared in 159.Bx 4.4 . 160