1.\" Copyright (c) 1990, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" %sccs.include.redist.man% 5.\" 6.\" @(#)strmode.3 8.3 (Berkeley) 07/28/94 7.\" 8.Dd 9.Dt STRMODE 3 10.Os 11.Sh NAME 12.Nm strmode 13.Nd convert inode status information into a symbolic string 14.Sh SYNOPSIS 15.Fd #include <string.h> 16.Ft void 17.Fn strmode "mode_t mode" "char *bp" 18.Sh DESCRIPTION 19The 20.Fn strmode 21function 22converts a file 23.Fa mode 24(the type and permission information associated with an inode, see 25.Xr stat 2 ) 26into a symbolic string which is stored in the location referenced by 27.Fa bp . 28This stored string is eleven characters in length plus a trailing 29.Dv NULL . 30.Pp 31The first character is the inode type, and will be one of the following: 32.Pp 33.Bl -tag -width flag -offset indent -compact 34.It \- 35regular file 36.It b 37block special 38.It c 39character special 40.It d 41directory 42.It l 43symbolic link 44.It p 45fifo 46.It s 47socket 48.It w 49whiteout 50.It ? 51unknown inode type 52.El 53.Pp 54The next nine characters encode three sets of permissions, in three 55characters each. 56The first three characters are the permissions for the owner of the 57file, the second three for the group the file belongs to, and the 58third for the ``other'', or default, set of users. 59.Pp 60Permission checking is done as specifically as possible. 61If read permission is denied to the owner of a file in the first set 62of permissions, the owner of the file will not be able to read the file. 63This is true even if the owner is in the file's group and the group 64permissions allow reading or the ``other'' permissions allow reading. 65.Pp 66If the first character of the three character set is an ``r'', the file is 67readable for that set of users; if a dash ``\-'', it is not readable. 68.Pp 69If the second character of the three character set is a ``w'', the file is 70writable for that set of users; if a dash ``\-'', it is not writable. 71.Pp 72The third character is the first of the following characters that apply: 73.Bl -tag -width xxxx 74.It S 75If the character is part of the owner permissions and the file is not 76executable or the directory is not searchable by the owner, and the 77set-user-id bit is set. 78.It S 79If the character is part of the group permissions and the file is not 80executable or the directory is not searchable by the group, and the 81set-group-id bit is set. 82.It T 83If the character is part of the other permissions and the file is not 84executable or the directory is not searchable by others, and the ``sticky'' 85.Pq Dv S_ISVTX 86bit is set. 87.It s 88If the character is part of the owner permissions and the file is 89executable or the directory searchable by the owner, and the set-user-id 90bit is set. 91.It s 92If the character is part of the group permissions and the file is 93executable or the directory searchable by the group, and the set-group-id 94bit is set. 95.It t 96If the character is part of the other permissions and the file is 97executable or the directory searchable by others, and the ``sticky'' 98.Pq Dv S_ISVTX 99bit is set. 100.It x 101The file is executable or the directory is searchable. 102.It \- 103None of the above apply. 104.El 105.Pp 106The last character is a plus sign ``+'' if any there are any alternate 107or additional access control methods associated with the inode, otherwise 108it will be a space. 109.Sh RETURN VALUES 110The 111.Fn strmode 112function 113always returns 0. 114.Sh SEE ALSO 115.Xr chmod 1 , 116.Xr find 1 , 117.Xr stat 2 , 118.Xr getmode 3 , 119.Xr setmode 3 120.Sh HISTORY 121The 122.Fn strmode 123function first appeared in 4.4BSD. 124