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